az storage share

Manage file shares.

Commands

az storage share create Creates a new share under the specified account.
az storage share delete Marks the specified share for deletion.
az storage share exists Check for the existence of a file share.
az storage share generate-sas Generates a shared access signature for the share.
az storage share list List the file shares in a storage account.
az storage share metadata Manage the metadata of a file share.
az storage share metadata show Returns all user-defined metadata for the specified share.
az storage share metadata update Sets one or more user-defined name-value pairs for the specified share.
az storage share policy Manage shared access policies of a storage file share.
az storage share policy create Create a stored access policy on the containing object.
az storage share policy delete Delete a stored access policy on a containing object.
az storage share policy list List stored access policies on a containing object.
az storage share policy show Show a stored access policy on a containing object.
az storage share policy update Set a stored access policy on a containing object.
az storage share show Returns all user-defined metadata and system properties for the specified share.
az storage share snapshot Creates a snapshot of an existing share under the specified account.
az storage share stats Gets the approximate size of the data stored on the share, rounded up to the nearest gigabyte.
az storage share update Sets service-defined properties for the specified share.

az storage share create

Creates a new share under the specified account.

az storage share create --name
[--account-key]
[--account-name]
[--connection-string]
[--fail-on-exist]
[--metadata]
[--quota]
[--sas-token]
[--timeout]

Required Parameters

--name -n
The file share name.

Optional Parameters

--account-key
Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.
--account-name
Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.
--connection-string
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
--fail-on-exist
Specify whether to throw an exception when the share exists. False by default.
--metadata
Metadata in space-separated key=value pairs. This overwrites any existing metadata.
--quota
Specifies the maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120).
--sas-token
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
--timeout
Request timeout in seconds. Applies to each call to the service.

az storage share delete

Marks the specified share for deletion.

az storage share delete --name
[--account-key]
[--account-name]
[--connection-string]
[--delete-snapshots {include, only}]
[--fail-not-exist]
[--sas-token]
[--snapshot]
[--timeout]

Required Parameters

--name -n
The file share name.

Optional Parameters

--account-key
Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.
--account-name
Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.
--connection-string
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
--delete-snapshots
Specify the deletion strategy when the share has snapshots.
accepted values: include, only
--fail-not-exist
Specify whether to throw an exception when the share doesn't exist. False by default.
--sas-token
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
--snapshot
A string that represents the snapshot version, if applicable. Specify this argument to delete a specific snapshot only. delete_snapshots must be None if this is specified.
--timeout
Request timeout in seconds. Applies to each call to the service.

az storage share exists

Check for the existence of a file share.

az storage share exists --name
[--account-key]
[--account-name]
[--connection-string]
[--sas-token]
[--snapshot]
[--timeout]

Required Parameters

--name -n
The file share name.

Optional Parameters

--account-key
Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.
--account-name
Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.
--connection-string
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
--sas-token
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
--snapshot
A string that represents the snapshot version, if applicable.
--timeout
Request timeout in seconds. Applies to each call to the service.

az storage share generate-sas

Generates a shared access signature for the share.

az storage share generate-sas --name
[--account-key]
[--account-name]
[--cache-control]
[--connection-string]
[--content-disposition]
[--content-encoding]
[--content-language]
[--content-type]
[--expiry]
[--https-only]
[--ip]
[--permissions]
[--policy-name]
[--sas-token]
[--start]

Required Parameters

--name -n
The file share name.

Optional Parameters

--account-key
Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.
--account-name
Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.
--cache-control
Response header value for Cache-Control when resource is accessed using this shared access signature.
--connection-string
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
--content-disposition
Response header value for Content-Disposition when resource is accessed using this shared access signature.
--content-encoding
Response header value for Content-Encoding when resource is accessed using this shared access signature.
--content-language
Response header value for Content-Language when resource is accessed using this shared access signature.
--content-type
Response header value for Content-Type when resource is accessed using this shared access signature.
--expiry
Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes invalid. Do not use if a stored access policy is referenced with --id that specifies this value.
--https-only
Only permit requests made with the HTTPS protocol. If omitted, requests from both the HTTP and HTTPS protocol are permitted.
--ip
Specifies the IP address or range of IP addresses from which to accept requests. Supports only IPv4 style addresses.
--permissions
The permissions the SAS grants. Allowed values: (d)elete (l)ist (r)ead (w)rite. Do not use if a stored access policy is referenced with --id that specifies this value. Can be combined.
--policy-name
The name of a stored access policy within the share's ACL.
--sas-token
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
--start
Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes valid. Do not use if a stored access policy is referenced with --id that specifies this value. Defaults to the time of the request.

az storage share list

List the file shares in a storage account.

az storage share list [--account-key]
[--account-name]
[--connection-string]
[--include-metadata]
[--include-snapshots]
[--num-results]
[--prefix]
[--sas-token]
[--timeout]

Optional Parameters

--account-key
Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.
--account-name
Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.
--connection-string
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
--include-metadata
Specifies that share metadata be returned in the response.
--include-snapshots
Specifies that share snapshots be returned in the response.
--num-results
Specifies the maximum number of shares to return.
--prefix
Filters the results to return only shares whose names begin with the specified prefix.
--sas-token
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
--timeout
Request timeout in seconds. Applies to each call to the service.

az storage share show

Returns all user-defined metadata and system properties for the specified share.

az storage share show --name
[--account-key]
[--account-name]
[--connection-string]
[--sas-token]
[--snapshot]
[--timeout]

Required Parameters

--name -n
The file share name.

Optional Parameters

--account-key
Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.
--account-name
Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.
--connection-string
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
--sas-token
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
--snapshot
A string that represents the snapshot version, if applicable.
--timeout
Request timeout in seconds. Applies to each call to the service.

az storage share snapshot

Creates a snapshot of an existing share under the specified account.

az storage share snapshot --name
[--account-key]
[--account-name]
[--connection-string]
[--metadata]
[--quota]
[--sas-token]
[--timeout]

Required Parameters

--name -n
The file share name.

Optional Parameters

--account-key
Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.
--account-name
Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.
--connection-string
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
--metadata
Metadata in space-separated key=value pairs. This overwrites any existing metadata.
--quota
Specifies the maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120).
--sas-token
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
--timeout
Request timeout in seconds. Applies to each call to the service.

az storage share stats

Gets the approximate size of the data stored on the share, rounded up to the nearest gigabyte.

az storage share stats --name
[--account-key]
[--account-name]
[--connection-string]
[--sas-token]
[--timeout]

Required Parameters

--name -n
The file share name.

Optional Parameters

--account-key
Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.
--account-name
Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.
--connection-string
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
--sas-token
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
--timeout
Request timeout in seconds. Applies to each call to the service.

az storage share update

Sets service-defined properties for the specified share.

az storage share update --name
--quota
[--account-key]
[--account-name]
[--connection-string]
[--sas-token]
[--timeout]

Required Parameters

--name -n
The file share name.
--quota
Specifies the maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5 TB (5120 GB).

Optional Parameters

--account-key
Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.
--account-name
Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.
--connection-string
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
--sas-token
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
--timeout
Request timeout in seconds. Applies to each call to the service.