files

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

Overview

Name	files
Type	Resource
Id	azure.support.files

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
chunkSize	integer	Size of each chunk. The size of each chunk should be provided in bytes and must not exceed 2.5 megabytes (MB).
createdOn	string (date-time)	Time in UTC (ISO 8601 format) when file workspace was created.
fileSize	integer	Size of the file to be uploaded. The file size must not exceed 5 MB and should be provided in bytes.
numberOfChunks	integer	Number of chunks to be uploaded. The maximum number of allowed chunks is 2.
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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
chunkSize	integer	Size of each chunk. The size of each chunk should be provided in bytes and must not exceed 2.5 megabytes (MB).
createdOn	string (date-time)	Time in UTC (ISO 8601 format) when file workspace was created.
fileSize	integer	Size of the file to be uploaded. The file size must not exceed 5 MB and should be provided in bytes.
numberOfChunks	integer	Number of chunks to be uploaded. The maximum number of allowed chunks is 2.
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	file_workspace_name, file_name, subscription_id		Returns details of a specific file in a work space.
list	select	file_workspace_name, subscription_id		Lists all the Files information under a workspace for an Azure subscription.
create	insert	file_workspace_name, file_name, subscription_id		Creates a new file under a workspace for the specified subscription.
upload	exec	file_workspace_name, file_name, subscription_id		This API allows you to upload content to a file.

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	File Name. Required.
file_workspace_name	string	File WorkspaceName. Required.
subscription_id	string

SELECT examples

get

Returns details of a specific file in a work space.

SELECT
id,
name,
chunkSize,
createdOn,
fileSize,
numberOfChunks,
systemData,
type
FROM azure.support.files
WHERE file_workspace_name = '{{ file_workspace_name }}' -- required
AND file_name = '{{ file_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all the Files information under a workspace for an Azure subscription.

SELECT
id,
name,
chunkSize,
createdOn,
fileSize,
numberOfChunks,
systemData,
type
FROM azure.support.files
WHERE file_workspace_name = '{{ file_workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a new file under a workspace for the specified subscription.

INSERT INTO azure.support.files (
properties,
file_workspace_name,
file_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ file_workspace_name }}',
'{{ file_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: files
props:
  - name: file_workspace_name
    value: "{{ file_workspace_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
    value:
      chunkSize: {{ chunkSize }}
      fileSize: {{ fileSize }}
      numberOfChunks: {{ numberOfChunks }}

Lifecycle Methods

upload

This API allows you to upload content to a file.

EXEC azure.support.files.upload 
@file_workspace_name='{{ file_workspace_name }}' --required, 
@file_name='{{ file_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"content": "{{ content }}", 
"chunkIndex": {{ chunkIndex }}
}'
;