az spring storage

  • Reference

Note

This reference is part of the spring extension for the Azure CLI (version 2.56.0 or higher). The extension will automatically install the first time you run an az spring storage command. Learn more about extensions.

Commands to manage Storages in Azure Spring Apps.

Commands

Name Description Type Status
az spring storage add

Create a new storage in the Azure Spring Apps.

 Extension GA
az spring storage list

List all existing storages in the Azure Spring Apps.

 Extension GA
az spring storage list-persistent-storage

List all the persistent storages related to an existing storage in the Azure Spring Apps.

 Extension GA
az spring storage remove

Remove an existing storage in the Azure Spring Apps.

 Extension GA
az spring storage show

Get an existing storage in the Azure Spring Apps.

 Extension GA
az spring storage update

Update an existing storage in the Azure Spring Apps.

 Extension GA

az spring storage add

Create a new storage in the Azure Spring Apps.

az spring storage add --account-key
                      --account-name
                      --name
                      --resource-group
                      --service
                      --storage-type

Examples

Create a Storage resource with your own storage account.

az spring storage add --storage-type StorageAccount --account-name MyAccountName --account-key MyAccountKey  -g MyResourceGroup -s MyService -n MyStorageName

Required Parameters

--account-key

The account key of the storage account.

--account-name

The name of the storage account.

--name -n

Name of storage.

--resource-group -g

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

--service -s

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=.

--storage-type

The type of the torage. e.g. StorageAccount.

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 spring storage list

List all existing storages in the Azure Spring Apps.

az spring storage list --resource-group
                       --service

Examples

List all Storage resources.

az spring storage list -g MyResourceGroup -s MyService

Required Parameters

--resource-group -g

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

--service -s

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=.

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 spring storage list-persistent-storage

List all the persistent storages related to an existing storage in the Azure Spring Apps.

az spring storage list-persistent-storage --name
                                          --resource-group
                                          --service

Examples

list all the persistent-storage related to an existing storage.

az spring storage list-persistent-storage -g MyResourceGroup -s MyService -n MyStorageName

Required Parameters

--name -n

Name of storage.

--resource-group -g

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

--service -s

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=.

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 spring storage remove

Remove an existing storage in the Azure Spring Apps.

az spring storage remove --name
                         --resource-group
                         --service

Examples

Remove a Storage resource.

az spring storage remove -g MyResourceGroup -s MyService -n MyStorageName

Required Parameters

--name -n

Name of storage.

--resource-group -g

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

--service -s

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=.

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 spring storage show

Get an existing storage in the Azure Spring Apps.

az spring storage show --name
                       --resource-group
                       --service

Examples

Get a Storage resource.

az spring storage show -g MyResourceGroup -s MyService -n MyStorageName

Required Parameters

--name -n

Name of storage.

--resource-group -g

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

--service -s

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=.

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 spring storage update

Update an existing storage in the Azure Spring Apps.

az spring storage update --account-key
                         --account-name
                         --name
                         --resource-group
                         --service
                         --storage-type

Examples

Update a Storage resource with new name or new key.

az spring storage update --storage-type StorageAccount --account-name MyAccountName --account-key MyAccountKey  -g MyResourceGroup -s MyService -n MyStorageName

Required Parameters

--account-key

The account key of the storage account.

--account-name

The name of the storage account.

--name -n

Name of storage.

--resource-group -g

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

--service -s

The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=.

--storage-type

The type of the torage. e.g. StorageAccount.

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.