file_shares

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

Overview

Name	file_shares
Type	Resource
Id	azure.storage.file_shares

Fields

The following fields are returned by SELECT queries:

get

OK -- Get Share operation completed successfully.

Name	Datatype	Description
etag	string	Resource Etag.
properties	object	Properties of the file share. (x-ms-client-name: FileShareProperties)

list

OK -- List Shares operation completed successfully.

Name	Datatype	Description
etag	string	Resource Etag.
properties	object	The file share properties be listed out.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, accountName, shareName, subscriptionId	$expand, x-ms-snapshot	Gets properties of a specified share.
list	select	resourceGroupName, accountName, subscriptionId	$maxpagesize, $filter, $expand	Lists all shares.
create	insert	resourceGroupName, accountName, shareName, subscriptionId	$expand	Creates a new share under the specified account as described by request body. The share resource includes metadata and properties for that share. It does not include a list of the files contained by the share.
update	update	resourceGroupName, accountName, shareName, subscriptionId		Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist.
delete	delete	resourceGroupName, accountName, shareName, subscriptionId	x-ms-snapshot, $include	Deletes specified share under its account.
restore	exec	resourceGroupName, accountName, shareName, subscriptionId, deletedShareName, deletedShareVersion		Restore a file share within a valid retention days if share soft delete is enabled
lease	exec	resourceGroupName, accountName, shareName, subscriptionId, action	x-ms-snapshot	The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.

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
accountName	string	The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
resourceGroupName	string	The name of the resource group within the user's subscription. The name is case insensitive.
shareName	string	The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$expand	string	Optional, used to expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ','
$filter	string	Optional. When specified, only share names starting with the filter will be listed.
$include	string	Optional. Valid values are: snapshots, leased-snapshots, none. The default value is snapshots. For 'snapshots', the file share is deleted including all of its file share snapshots. If the file share contains leased-snapshots, the deletion fails. For 'leased-snapshots', the file share is deleted included all of its file share snapshots (leased/unleased). For 'none', the file share is deleted if it has no share snapshots. If the file share contains any snapshots (leased or unleased), the deletion fails.
$maxpagesize	string	Optional. Specified maximum number of shares that can be included in the list.
x-ms-snapshot	string	Optional. Specify the snapshot time to lease a snapshot.

SELECT examples

get

Gets properties of a specified share.

SELECT
etag,
properties
FROM azure.storage.file_shares
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND shareName = '{{ shareName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
AND x-ms-snapshot = '{{ x-ms-snapshot }}'
;

list

Lists all shares.

SELECT
etag,
properties
FROM azure.storage.file_shares
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $maxpagesize = '{{ $maxpagesize }}'
AND $filter = '{{ $filter }}'
AND $expand = '{{ $expand }}'
;

INSERT examples

create

Creates a new share under the specified account as described by request body. The share resource includes metadata and properties for that share. It does not include a list of the files contained by the share.

INSERT INTO azure.storage.file_shares (
data__properties,
resourceGroupName,
accountName,
shareName,
subscriptionId,
$expand
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ shareName }}',
'{{ subscriptionId }}',
'{{ $expand }}'
RETURNING
etag,
properties
;

Manifest

# Description fields are for documentation purposes
- name: file_shares
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the file_shares resource.
    - name: accountName
      value: string
      description: Required parameter for the file_shares resource.
    - name: shareName
      value: string
      description: Required parameter for the file_shares resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the file_shares resource.
    - name: properties
      value: object
      description: |
        Properties of the file share.
    - name: $expand
      value: string
      description: Optional, used to expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ','

UPDATE examples

update

Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist.

UPDATE azure.storage.file_shares
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND shareName = '{{ shareName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
etag,
properties;

DELETE examples

delete

Deletes specified share under its account.

DELETE FROM azure.storage.file_shares
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND shareName = '{{ shareName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND x-ms-snapshot = '{{ x-ms-snapshot }}'
AND $include = '{{ $include }}'
;

Lifecycle Methods

restore

Restore a file share within a valid retention days if share soft delete is enabled

EXEC azure.storage.file_shares.restore 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@shareName='{{ shareName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"deletedShareName": "{{ deletedShareName }}", 
"deletedShareVersion": "{{ deletedShareVersion }}"
}'
;

lease

The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.

EXEC azure.storage.file_shares.lease 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@shareName='{{ shareName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@x-ms-snapshot='{{ x-ms-snapshot }}' 
@@json=
'{
"action": "{{ action }}", 
"leaseId": "{{ leaseId }}", 
"breakPeriod": {{ breakPeriod }}, 
"leaseDuration": {{ leaseDuration }}, 
"proposedLeaseId": "{{ proposedLeaseId }}"
}'
;