Share via

az mesh volume

  • Preview
  • Reference

Note

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

Command group 'az mesh' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage volumes.

Commands

Name Description Type Status
az mesh volume create

Create a volume.

 Extension Preview
az mesh volume delete

Delete a volume.

 Extension Preview
az mesh volume list

List volumes.

 Extension Preview
az mesh volume show

Get the details of a volume.

 Extension Preview

az mesh volume create

Preview

Command group 'az mesh' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a volume.

az mesh volume create --location
                      --name
                      --resource-group
                      [--template-file]
                      [--template-uri]

Examples

Create a volume with a template file on a remote URL.

az mesh volume create --location westus --name myvolume --resource-group mygroup --template-uri https://mystorage.blob.core.windows.net/templates/volumeDescription.json

Create a volume with a template file on local disk.

az mesh volume create --location westus --name myvolume --resource-group mygroup --template-file ./volumeDescription.json

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name -n

The name of the volume.

--resource-group -g

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

Optional Parameters

--template-file

The full file path of creation template.

--template-uri

The full file path of creation template on a http or https link.

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 mesh volume delete

Preview

Command group 'az mesh' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a volume.

az mesh volume delete [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]
                      [--yes]

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

The name of the volume.

--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False
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 mesh volume list

Preview

Command group 'az mesh' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List volumes.

az mesh volume list [--max-items]
                    [--next-token]
                    [--resource-group]

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

--resource-group -g

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

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 mesh volume show

Preview

Command group 'az mesh' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the details of a volume.

az mesh volume show [--ids]
                    [--name]
                    [--resource-group]
                    [--subscription]

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

The name of the volume.

--resource-group -g

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

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