1. Packages
  2. Azure Native v2
  3. API Docs
  4. datamigration
  5. getFile
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.datamigration.getFile

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

The files resource is a nested, proxy-only resource representing a file stored under the project resource. This method retrieves information about a file. Azure REST API version: 2021-06-30.

Other available API versions: 2022-03-30-preview, 2023-07-15-preview.

Using getFile

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFile(args: GetFileArgs, opts?: InvokeOptions): Promise<GetFileResult>
function getFileOutput(args: GetFileOutputArgs, opts?: InvokeOptions): Output<GetFileResult>
Copy
def get_file(file_name: Optional[str] = None,
             group_name: Optional[str] = None,
             project_name: Optional[str] = None,
             service_name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetFileResult
def get_file_output(file_name: Optional[pulumi.Input[str]] = None,
             group_name: Optional[pulumi.Input[str]] = None,
             project_name: Optional[pulumi.Input[str]] = None,
             service_name: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetFileResult]
Copy
func LookupFile(ctx *Context, args *LookupFileArgs, opts ...InvokeOption) (*LookupFileResult, error)
func LookupFileOutput(ctx *Context, args *LookupFileOutputArgs, opts ...InvokeOption) LookupFileResultOutput
Copy

> Note: This function is named LookupFile in the Go SDK.

public static class GetFile 
{
    public static Task<GetFileResult> InvokeAsync(GetFileArgs args, InvokeOptions? opts = null)
    public static Output<GetFileResult> Invoke(GetFileInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFileResult> getFile(GetFileArgs args, InvokeOptions options)
public static Output<GetFileResult> getFile(GetFileArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:datamigration:getFile
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

FileName
This property is required.
Changes to this property will trigger replacement.
string
Name of the File
GroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group
ProjectName
This property is required.
Changes to this property will trigger replacement.
string
Name of the project
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
Name of the service
FileName
This property is required.
Changes to this property will trigger replacement.
string
Name of the File
GroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group
ProjectName
This property is required.
Changes to this property will trigger replacement.
string
Name of the project
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
Name of the service
fileName
This property is required.
Changes to this property will trigger replacement.
String
Name of the File
groupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group
projectName
This property is required.
Changes to this property will trigger replacement.
String
Name of the project
serviceName
This property is required.
Changes to this property will trigger replacement.
String
Name of the service
fileName
This property is required.
Changes to this property will trigger replacement.
string
Name of the File
groupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group
projectName
This property is required.
Changes to this property will trigger replacement.
string
Name of the project
serviceName
This property is required.
Changes to this property will trigger replacement.
string
Name of the service
file_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the File
group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group
project_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the project
service_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the service
fileName
This property is required.
Changes to this property will trigger replacement.
String
Name of the File
groupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group
projectName
This property is required.
Changes to this property will trigger replacement.
String
Name of the project
serviceName
This property is required.
Changes to this property will trigger replacement.
String
Name of the service

getFile Result

The following output properties are available:

Id string
Resource ID.
Name string
Resource name.
Properties Pulumi.AzureNative.DataMigration.Outputs.ProjectFilePropertiesResponse
Custom file properties
SystemData Pulumi.AzureNative.DataMigration.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
Resource type.
Etag string
HTTP strong entity tag value. This is ignored if submitted.
Id string
Resource ID.
Name string
Resource name.
Properties ProjectFilePropertiesResponse
Custom file properties
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
Resource type.
Etag string
HTTP strong entity tag value. This is ignored if submitted.
id String
Resource ID.
name String
Resource name.
properties ProjectFilePropertiesResponse
Custom file properties
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
Resource type.
etag String
HTTP strong entity tag value. This is ignored if submitted.
id string
Resource ID.
name string
Resource name.
properties ProjectFilePropertiesResponse
Custom file properties
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
Resource type.
etag string
HTTP strong entity tag value. This is ignored if submitted.
id str
Resource ID.
name str
Resource name.
properties ProjectFilePropertiesResponse
Custom file properties
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
Resource type.
etag str
HTTP strong entity tag value. This is ignored if submitted.
id String
Resource ID.
name String
Resource name.
properties Property Map
Custom file properties
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
Resource type.
etag String
HTTP strong entity tag value. This is ignored if submitted.

Supporting Types

ProjectFilePropertiesResponse

LastModified This property is required. string
Modification DateTime.
Size This property is required. double
File size.
Extension string
Optional File extension. If submitted it should not have a leading period and must match the extension from filePath.
FilePath string
Relative path of this file resource. This property can be set when creating or updating the file resource.
MediaType string
File content type. This property can be modified to reflect the file content type.
LastModified This property is required. string
Modification DateTime.
Size This property is required. float64
File size.
Extension string
Optional File extension. If submitted it should not have a leading period and must match the extension from filePath.
FilePath string
Relative path of this file resource. This property can be set when creating or updating the file resource.
MediaType string
File content type. This property can be modified to reflect the file content type.
lastModified This property is required. String
Modification DateTime.
size This property is required. Double
File size.
extension String
Optional File extension. If submitted it should not have a leading period and must match the extension from filePath.
filePath String
Relative path of this file resource. This property can be set when creating or updating the file resource.
mediaType String
File content type. This property can be modified to reflect the file content type.
lastModified This property is required. string
Modification DateTime.
size This property is required. number
File size.
extension string
Optional File extension. If submitted it should not have a leading period and must match the extension from filePath.
filePath string
Relative path of this file resource. This property can be set when creating or updating the file resource.
mediaType string
File content type. This property can be modified to reflect the file content type.
last_modified This property is required. str
Modification DateTime.
size This property is required. float
File size.
extension str
Optional File extension. If submitted it should not have a leading period and must match the extension from filePath.
file_path str
Relative path of this file resource. This property can be set when creating or updating the file resource.
media_type str
File content type. This property can be modified to reflect the file content type.
lastModified This property is required. String
Modification DateTime.
size This property is required. Number
File size.
extension String
Optional File extension. If submitted it should not have a leading period and must match the extension from filePath.
filePath String
Relative path of this file resource. This property can be set when creating or updating the file resource.
mediaType String
File content type. This property can be modified to reflect the file content type.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi