file
Creates, updates, deletes, gets or lists a file resource.
Overview​
| Name | file |
| Type | Resource |
| Id | azure.storage_file_share.file |
Fields​
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_properties | exec | x-ms-version, account | sharesnapshot, timeout, x-ms-lease-id, x-ms-allow-trailing-dot, x-ms-file-request-intent | Returns all user-defined metadata, standard HTTP properties, and system properties for the file. It does not return the content of the 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 |
|---|---|---|
account | string | Storage account name. (default: ) |
x-ms-version | string | |
sharesnapshot | string | The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. Default value is None. |
timeout | integer | The timeout parameter is expressed in seconds. For more information, see |
x-ms-allow-trailing-dot | boolean | |
x-ms-file-request-intent | string | |
x-ms-lease-id | string |
Lifecycle Methods​
- get_properties
Returns all user-defined metadata, standard HTTP properties, and system properties for the file. It does not return the content of the file.
EXEC azure.storage_file_share.file.get_properties
@x-ms-version='{{ x-ms-version }}' --required,
@account='{{ account }}' --required,
@sharesnapshot='{{ sharesnapshot }}',
@timeout='{{ timeout }}',
@x-ms-lease-id='{{ x-ms-lease-id }}',
@x-ms-allow-trailing-dot={{ x-ms-allow-trailing-dot }},
@x-ms-file-request-intent='{{ x-ms-file-request-intent }}'
@@json=
'{
"leaseId": "{{ leaseId }}"
}'
;