files

Creates, updates, deletes, gets or lists a files resource.

Overview

Name	files
Type	Resource
Id	azure.data_migration.files

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
etag	string	HTTP strong entity tag value. This is ignored if submitted.
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.
lastModified	string (date-time)	Modification DateTime.
mediaType	string	File content type. This property can be modified to reflect the file content type.
size	integer	File size.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
etag	string	HTTP strong entity tag value. This is ignored if submitted.
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.
lastModified	string (date-time)	Modification DateTime.
mediaType	string	File content type. This property can be modified to reflect the file content type.
size	integer	File size.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	group_name, service_name, project_name, file_name, subscription_id		Get file information. The files resource is a nested, proxy-only resource representing a file stored under the project resource. This method retrieves information about a file.
list	select	group_name, service_name, project_name, subscription_id		Get files in a project. The project resource is a nested resource representing a stored migration project. This method returns a list of files owned by a project resource.
create_or_update	insert	group_name, service_name, project_name, file_name, subscription_id		Create a file resource. The PUT method creates a new file or updates an existing one.
update	update	group_name, service_name, project_name, file_name, subscription_id		Update a file. This method updates an existing file.
create_or_update	replace	group_name, service_name, project_name, file_name, subscription_id		Create a file resource. The PUT method creates a new file or updates an existing one.
delete	delete	group_name, service_name, project_name, file_name, subscription_id		Delete file. This method deletes a file.
read	exec	group_name, service_name, project_name, file_name, subscription_id		Request storage information for downloading the file content. This method is used for requesting storage information using which contents of the file can be downloaded.
read_write	exec	group_name, service_name, project_name, file_name, subscription_id		Request information for reading and writing file content. This method is used for requesting information for reading and writing the file content.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
file_name	string	Name of the File. Required.
group_name	string	Name of the resource group. Required.
project_name	string	Name of the project. Required.
service_name	string	Name of the service. Required.
subscription_id	string

SELECT examples

get

Get file information. The files resource is a nested, proxy-only resource representing a file stored under the project resource. This method retrieves information about a file.

SELECT
id,
name,
etag,
extension,
filePath,
lastModified,
mediaType,
size,
systemData,
type
FROM azure.data_migration.files
WHERE group_name = '{{ group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND file_name = '{{ file_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get files in a project. The project resource is a nested resource representing a stored migration project. This method returns a list of files owned by a project resource.

SELECT
id,
name,
etag,
extension,
filePath,
lastModified,
mediaType,
size,
systemData,
type
FROM azure.data_migration.files
WHERE group_name = '{{ group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a file resource. The PUT method creates a new file or updates an existing one.

INSERT INTO azure.data_migration.files (
properties,
etag,
group_name,
service_name,
project_name,
file_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ etag }}',
'{{ group_name }}',
'{{ service_name }}',
'{{ project_name }}',
'{{ file_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: files
props:
  - name: group_name
    value: "{{ group_name }}"
    description: Required parameter for the files resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the files resource.
  - name: project_name
    value: "{{ project_name }}"
    description: Required parameter for the files resource.
  - name: file_name
    value: "{{ file_name }}"
    description: Required parameter for the files resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the files resource.
  - name: properties
    description: |
      Custom file properties.
    value:
      extension: "{{ extension }}"
      filePath: "{{ filePath }}"
      lastModified: "{{ lastModified }}"
      mediaType: "{{ mediaType }}"
      size: {{ size }}
  - name: etag
    value: "{{ etag }}"
    description: |
      HTTP strong entity tag value. This is ignored if submitted.

UPDATE examples

update

Update a file. This method updates an existing file.

UPDATE azure.data_migration.files
SET 
properties = '{{ properties }}',
etag = '{{ etag }}'
WHERE 
group_name = '{{ group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND project_name = '{{ project_name }}' --required
AND file_name = '{{ file_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create a file resource. The PUT method creates a new file or updates an existing one.

REPLACE azure.data_migration.files
SET 
properties = '{{ properties }}',
etag = '{{ etag }}'
WHERE 
group_name = '{{ group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND project_name = '{{ project_name }}' --required
AND file_name = '{{ file_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

Delete file. This method deletes a file.

DELETE FROM azure.data_migration.files
WHERE group_name = '{{ group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND project_name = '{{ project_name }}' --required
AND file_name = '{{ file_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

read

Request storage information for downloading the file content. This method is used for requesting storage information using which contents of the file can be downloaded.

EXEC azure.data_migration.files.read 
@group_name='{{ group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@project_name='{{ project_name }}' --required, 
@file_name='{{ file_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

read_write

Request information for reading and writing file content. This method is used for requesting information for reading and writing the file content.

EXEC azure.data_migration.files.read_write 
@group_name='{{ group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@project_name='{{ project_name }}' --required, 
@file_name='{{ file_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;