az storage share policy

Manage shared access policies of a storage file share.

Commands

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 policy create

Create a stored access policy on the containing object.

az storage share policy create --name
                               --share-name
                               [--account-key]
                               [--account-name]
                               [--connection-string]
                               [--expiry]
                               [--permissions]
                               [--sas-token]
                               [--start]
                               [--subscription]

Required Parameters

--name -n

The stored access policy name.

--share-name -s

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. Related environment variable: AZURE_STORAGE_ACCOUNT. Must be used in conjunction with either storage account key or a SAS token. If neither are present, the command will try to query the storage account key using the authenticated Azure account. If a large number of storage commands are executed the API quota may be hit.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--expiry

Expiration UTC datetime in (Y-m-d'T'H:M:S'Z').

--permissions

Allowed values: (d)elete (l)ist (r)ead (w)rite. Can be combined.

--sas-token

A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.

--start

Start UTC datetime (Y-m-d'T'H:M:S'Z'). Defaults to time of request.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az storage share policy delete

Delete a stored access policy on a containing object.

az storage share policy delete --name
                               --share-name
                               [--account-key]
                               [--account-name]
                               [--connection-string]
                               [--sas-token]
                               [--subscription]

Required Parameters

--name -n

The stored access policy name.

--share-name -s

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. Related environment variable: AZURE_STORAGE_ACCOUNT. Must be used in conjunction with either storage account key or a SAS token. If neither are present, the command will try to query the storage account key using the authenticated Azure account. If a large number of storage commands are executed the API quota may be hit.

--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.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az storage share policy list

List stored access policies on a containing object.

az storage share policy list --share-name
                             [--account-key]
                             [--account-name]
                             [--connection-string]
                             [--query-examples]
                             [--sas-token]
                             [--subscription]

Required Parameters

--share-name -s

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. Related environment variable: AZURE_STORAGE_ACCOUNT. Must be used in conjunction with either storage account key or a SAS token. If neither are present, the command will try to query the storage account key using the authenticated Azure account. If a large number of storage commands are executed the API quota may be hit.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--sas-token

A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az storage share policy show

Show a stored access policy on a containing object.

az storage share policy show --name
                             --share-name
                             [--account-key]
                             [--account-name]
                             [--connection-string]
                             [--query-examples]
                             [--sas-token]
                             [--subscription]

Required Parameters

--name -n

The stored access policy name.

--share-name -s

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. Related environment variable: AZURE_STORAGE_ACCOUNT. Must be used in conjunction with either storage account key or a SAS token. If neither are present, the command will try to query the storage account key using the authenticated Azure account. If a large number of storage commands are executed the API quota may be hit.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--sas-token

A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az storage share policy update

Set a stored access policy on a containing object.

az storage share policy update --name
                               --share-name
                               [--account-key]
                               [--account-name]
                               [--connection-string]
                               [--expiry]
                               [--permissions]
                               [--sas-token]
                               [--start]
                               [--subscription]

Required Parameters

--name -n

The stored access policy name.

--share-name -s

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. Related environment variable: AZURE_STORAGE_ACCOUNT. Must be used in conjunction with either storage account key or a SAS token. If neither are present, the command will try to query the storage account key using the authenticated Azure account. If a large number of storage commands are executed the API quota may be hit.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--expiry

Expiration UTC datetime in (Y-m-d'T'H:M:S'Z').

--permissions

Allowed values: (d)elete (l)ist (r)ead (w)rite. Can be combined.

--sas-token

A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.

--start

Start UTC datetime (Y-m-d'T'H:M:S'Z'). Defaults to time of request.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.