Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az webapp config storage-account

Manage a web app's Azure storage account configurations.

Commands

Name Description Type Status
az webapp config storage-account add

Add an Azure storage account configuration to a web app.

 Core GA
az webapp config storage-account delete

Delete a web app's Azure storage account configuration.

 Core GA
az webapp config storage-account list

Get a web app's Azure storage account configurations.

 Core GA
az webapp config storage-account update

Update an existing Azure storage account configuration on a web app.

 Core GA

az webapp config storage-account add

Add an Azure storage account configuration to a web app.

Note that storage account access keys are now redacted in the result. Please use the az webapp config storage-account list command to view the keys.

az webapp config storage-account add --access-key
 --account-name
 --custom-id
 --share-name --sn
 --storage-type {AzureBlob, AzureFiles}
 [--acquire-policy-token]
 [--change-reference]
 [--ids]
 [--mount-path]
 [--name]
 [--resource-group]
 [--slot]
 [--slot-setting]
 [--subscription]

Examples

Add a connection to the Azure Files file share called MyShare in the storage account named MyStorageAccount.

az webapp config storage-account add -g MyResourceGroup -n MyUniqueApp \
 --custom-id CustomId \
 --storage-type AzureFiles \
 --account-name MyStorageAccount \
 --share-name MyShare \
 --access-key MyAccessKey \
 --mount-path /path/to/mount

Required Parameters

--access-key -k

Storage account access key.

--account-name -a

Storage account name.

--custom-id -i

Name of the share configured within the web app.

--share-name --sn

Name of the file share as given in the storage account.

--storage-type -t

Storage type.

Property Value
Accepted values: AzureBlob, AzureFiles

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--mount-path -m

The path which the web app uses to read-write data ex: /share1 or /share2.

--name -n

Name of the web app. If left unspecified, a name will be randomly generated. You can configure the default using az configure --defaults web=<name>.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--slot -s

The name of the slot. Default to the productions slot if not specified.

--slot-setting

With slot setting you can decide to make BYOS configuration sticky to a slot, meaning that when that slot is swapped, the storage account stays with that slot.

Property Value
Default value: False
--subscription

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

Property Value
Parameter group: Resource Id Arguments

az webapp config storage-account delete

Delete a web app's Azure storage account configuration.

Note that storage account access keys are now redacted in the result. Please use the az webapp config storage-account list command to view the keys.

az webapp config storage-account delete --custom-id
 [--acquire-policy-token]
 [--change-reference]
 [--ids]
 [--name]
 [--resource-group]
 [--slot]
 [--subscription]

Examples

Delete a web app's Azure storage account configuration.

az webapp config storage-account delete --custom-id CustomId --name MyWebApp --resource-group MyResourceGroup

Required Parameters

--custom-id -i

Name of the share configured within the web app.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

Name of the web app. If left unspecified, a name will be randomly generated. You can configure the default using az configure --defaults web=<name>.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--slot -s

The name of the slot. Default to the productions slot if not specified.

--subscription

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

Property Value
Parameter group: Resource Id Arguments

az webapp config storage-account list

Get a web app's Azure storage account configurations.

az webapp config storage-account list --name
 --resource-group
 [--slot]

Examples

Get a web app's Azure storage account configurations.

az webapp config storage-account list --name MyWebApp --resource-group MyResourceGroup

Required Parameters

--name -n

Name of the web app. If left unspecified, a name will be randomly generated. You can configure the default using az configure --defaults web=<name>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--slot -s

The name of the slot. Default to the productions slot if not specified.

az webapp config storage-account update

Update an existing Azure storage account configuration on a web app.

Note that storage account access keys are now redacted in the result. Please use the az webapp config storage-account list command to view the keys.

az webapp config storage-account update --custom-id
 [--access-key]
 [--account-name]
 [--acquire-policy-token]
 [--change-reference]
 [--ids]
 [--mount-path]
 [--name]
 [--resource-group]
 [--share-name --sn]
 [--slot]
 [--slot-setting]
 [--storage-type {AzureBlob, AzureFiles}]
 [--subscription]

Examples

Update the mount path for a connection to the Azure Files file share with the ID MyId.

az webapp config storage-account update -g MyResourceGroup -n MyUniqueApp \
 --custom-id CustomId \
 --mount-path /path/to/new/mount

Update an existing Azure storage account configuration on a web app.

az webapp config storage-account update --access-key MyAccessKey --account-name MyAccount --custom-id CustomId --mount-path /path/to/new/mount --name MyUniqueApp --resource-group MyResourceGroup --share-name MyShare --storage-type AzureFiles

Required Parameters

--custom-id -i

Name of the share configured within the web app.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--access-key -k

Storage account access key.

--account-name -a

Storage account name.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--mount-path -m

The path which the web app uses to read-write data ex: /share1 or /share2.

--name -n

Name of the web app. If left unspecified, a name will be randomly generated. You can configure the default using az configure --defaults web=<name>.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--share-name --sn

Name of the file share as given in the storage account.

--slot -s

The name of the slot. Default to the productions slot if not specified.

--slot-setting

With slot setting you can decide to make BYOS configuration sticky to a slot, meaning that when that slot is swapped, the storage account stays with that slot.

Property Value
Default value: False
--storage-type -t

Storage type.

Property Value
Accepted values: AzureBlob, AzureFiles
--subscription

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

Property Value
Parameter group: Resource Id Arguments

Feedback

Was this page helpful?