az webapp config storage-account

  • Reference

Manage a web app's Azure storage account configurations. (Linux Web Apps and Windows Containers Web Apps Only).

Commands

Name Description Type Status
az webapp config storage-account add

Add an Azure storage account configuration to a web app. (Linux Web Apps and Windows Containers Web Apps Only).

 Core GA
az webapp config storage-account delete

Delete a web app's Azure storage account configuration. (Linux Web Apps and Windows Containers Web Apps Only).

 Core GA
az webapp config storage-account list

Get a web app's Azure storage account configurations. (Linux Web Apps and Windows Containers Web Apps Only).

 Core GA
az webapp config storage-account update

Update an existing Azure storage account configuration on a web app. (Linux Web Apps and Windows Containers Web Apps Only).

 Core GA

az webapp config storage-account add

Add an Azure storage account configuration to a web app. (Linux Web Apps and Windows Containers Web Apps Only).

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
                                     --storage-type {AzureBlob, AzureFiles}
                                     [--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.

accepted values: AzureBlob, AzureFiles

Optional Parameters

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

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

--resource-group -g

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

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

default value: False
--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az webapp config storage-account delete

Delete a web app's Azure storage account configuration. (Linux Web Apps and Windows Containers Web Apps Only).

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
                                        [--ids]
                                        [--name]
                                        [--resource-group]
                                        [--slot]
                                        [--subscription]

Examples

Delete a web app's Azure storage account configuration. (Linux Web Apps and Windows Containers Web Apps Only) (autogenerated)

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

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

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

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az webapp config storage-account list

Get a web app's Azure storage account configurations. (Linux Web Apps and Windows Containers Web Apps Only).

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

Examples

Get a web app's Azure storage account configurations. (Linux Web Apps and Windows Containers Web Apps Only) (autogenerated)

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

--slot -s

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az webapp config storage-account update

Update an existing Azure storage account configuration on a web app. (Linux Web Apps and Windows Containers Web Apps Only).

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]
                                        [--ids]
                                        [--mount-path]
                                        [--name]
                                        [--resource-group]
                                        [--share-name]
                                        [--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. (Linux Web Apps and Windows Containers Web Apps Only) (autogenerated)

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

--access-key -k

Storage account access key.

--account-name -a

Storage account name.

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

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

--resource-group -g

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

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

default value: False
--storage-type -t

Storage type.

accepted values: AzureBlob, AzureFiles
--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.