az disk-pool

  • Reference

Note

This reference is part of the diskpool extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az disk-pool command. Learn more about extensions.

Manage Azure disk pool.

Commands

Name Description Type Status
az disk-pool create

Create Disk pool. This Create operation can take 15 minutes to complete. This is expected service behavior.

 Extension GA
az disk-pool delete

Delete a Disk pool; attached disks are not affected. This delete operation can take 10 minutes to complete. This is expected service behavior.

 Extension GA
az disk-pool iscsi-target

Manage iSCSI target with a Disk Pool.

 Extension GA
az disk-pool iscsi-target create

Create an iSCSI Target.

 Extension GA
az disk-pool iscsi-target delete

Delete an iSCSI Target.

 Extension GA
az disk-pool iscsi-target list

Get iSCSI Targets in a Disk pool.

 Extension GA
az disk-pool iscsi-target show

Get an iSCSI Target.

 Extension GA
az disk-pool iscsi-target update

Update an iSCSI Target.

 Extension GA
az disk-pool iscsi-target wait

Place the CLI in a waiting state until a condition of the disk-pool iscsi-target is met.

 Extension GA
az disk-pool list

Gets a list of DiskPools in a resource group. And Gets a list of Disk Pools in a subscription.

 Extension GA
az disk-pool list-outbound-network-dependency-endpoint

Gets the network endpoints of all outbound dependencies of a Disk Pool.

 Extension GA
az disk-pool list-skus

Lists available StoragePool resources and skus in an Azure location.

 Extension GA
az disk-pool list-zones

Lists available Disk Pool Skus in an Azure location.

 Extension GA
az disk-pool redeploy

Redeploy replaces the underlying virtual machine hosts one at a time. This operation can take 10-15 minutes to complete. This is expected service behavior.

 Extension GA
az disk-pool show

Get a Disk pool.

 Extension GA
az disk-pool start

The operation to start a Disk Pool. This start operation can take 10 minutes to complete. This is expected service behavior.

 Extension GA
az disk-pool stop

Shuts down the Disk Pool and releases the compute resources. You are not billed for the compute resources that this Disk Pool uses. This operation can take 10 minutes to complete. This is expected service behavior.

 Extension GA
az disk-pool update

Update a Disk pool.

 Extension GA
az disk-pool wait

Place the CLI in a waiting state until a condition of the disk-pool is met.

 Extension GA

az disk-pool create

Create Disk pool. This Create operation can take 15 minutes to complete. This is expected service behavior.

az disk-pool create --disk-pool-name
                    --resource-group
                    --sku
                    --subnet-id
                    [--additional-capabilities]
                    [--availability-zones]
                    [--disks]
                    [--location]
                    [--managed-by]
                    [--managed-by-extended]
                    [--no-wait]
                    [--tags]

Examples

Create or Update Disk pool

az disk-pool create --location "westus" --availability-zones "1" --disks "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm-name_DataDisk_0" --disks "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm-name_DataDisk_1" --subnet-id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet" --sku name="Basic_V1" tier="Basic" --tags key="value" --name "myDiskPool" --resource-group "myResourceGroup"

Required Parameters

--disk-pool-name --name -n

The name of the Disk Pool.

--resource-group -g

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

--sku

Determines the SKU of the Disk Pool.

Usage: --sku name=XX tier=XX

name: Required. Sku name tier: Sku tier.

--subnet-id

Azure Resource ID of a Subnet for the Disk Pool.

Optional Parameters

--additional-capabilities -a

List of additional capabilities for a Disk Pool.

--availability-zones

Logical zone for Disk Pool resource; example: ["1"].

--disks

List of Azure Managed Disks to attach to a Disk Pool.

The order of this parameter is specific customized. Usage: --disks id-value

id: Required. Unique Azure Resource ID of the Managed Disk.

Multiple actions can be specified by using more than one --disks argument.

--location -l

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

--managed-by

Azure resource id. Indicates if this resource is managed by another Azure resource.

--managed-by-extended

List of Azure resource ids that manage this resource.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 disk-pool delete

Delete a Disk pool; attached disks are not affected. This delete operation can take 10 minutes to complete. This is expected service behavior.

az disk-pool delete [--disk-pool-name]
                    [--ids]
                    [--no-wait]
                    [--resource-group]
                    [--subscription]
                    [--yes]

Examples

Delete Disk pool

az disk-pool delete --name "myDiskPool" --resource-group "myResourceGroup"

Optional Parameters

--disk-pool-name --name -n

The name of the Disk Pool.

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

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--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 disk-pool list

Gets a list of DiskPools in a resource group. And Gets a list of Disk Pools in a subscription.

az disk-pool list [--resource-group]

Examples

List Disk Pools

az disk-pool list --resource-group "myResourceGroup"

List Disk Pools by subscription

az disk-pool list

Optional Parameters

--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 disk-pool list-outbound-network-dependency-endpoint

Gets the network endpoints of all outbound dependencies of a Disk Pool.

az disk-pool list-outbound-network-dependency-endpoint --disk-pool-name
                                                       --resource-group

Examples

Get Disk Pool outbound network dependencies

az disk-pool list-outbound-network-dependency-endpoint --name "SampleAse" --resource-group "Sample-WestUSResourceGroup"

Required Parameters

--disk-pool-name --name -n

The name of the Disk Pool.

--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 disk-pool list-skus

Lists available StoragePool resources and skus in an Azure location.

az disk-pool list-skus --location

Examples

List Disk Pool Skus

az disk-pool list-skus --location "eastus"

Required Parameters

--location -l

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

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 disk-pool list-zones

Lists available Disk Pool Skus in an Azure location.

az disk-pool list-zones --location

Examples

List Disk Pool Zones

az disk-pool list-zones --location "eastus"

Required Parameters

--location -l

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

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 disk-pool redeploy

Redeploy replaces the underlying virtual machine hosts one at a time. This operation can take 10-15 minutes to complete. This is expected service behavior.

az disk-pool redeploy [--disk-pool-name]
                      [--ids]
                      [--no-wait]
                      [--resource-group]
                      [--subscription]

Examples

Redeploy Disk Pool

az disk-pool redeploy --name "myDiskPool" --resource-group "myResourceGroup"

Optional Parameters

--disk-pool-name --name -n

The name of the Disk Pool.

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

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--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.

az disk-pool show

Get a Disk pool.

az disk-pool show [--disk-pool-name]
                  [--ids]
                  [--resource-group]
                  [--subscription]

Examples

Get Disk pool

az disk-pool show --name "myDiskPool" --resource-group "myResourceGroup"

Optional Parameters

--disk-pool-name --name -n

The name of the Disk Pool.

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

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

az disk-pool start

The operation to start a Disk Pool. This start operation can take 10 minutes to complete. This is expected service behavior.

az disk-pool start [--disk-pool-name]
                   [--ids]
                   [--no-wait]
                   [--resource-group]
                   [--subscription]

Examples

Start Disk Pool

az disk-pool start --name "myDiskPool" --resource-group "myResourceGroup"

Optional Parameters

--disk-pool-name --name -n

The name of the Disk Pool.

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

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--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.

az disk-pool stop

Shuts down the Disk Pool and releases the compute resources. You are not billed for the compute resources that this Disk Pool uses. This operation can take 10 minutes to complete. This is expected service behavior.

az disk-pool stop [--disk-pool-name]
                  [--ids]
                  [--no-wait]
                  [--resource-group]
                  [--subscription]

Examples

Deallocate Disk Pool

az disk-pool stop --name "myDiskPool" --resource-group "myResourceGroup"

Optional Parameters

--disk-pool-name --name -n

The name of the Disk Pool.

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

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--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.

az disk-pool update

Update a Disk pool.

az disk-pool update [--disk-pool-name]
                    [--disks]
                    [--ids]
                    [--managed-by]
                    [--managed-by-extended]
                    [--no-wait]
                    [--resource-group]
                    [--sku]
                    [--subscription]
                    [--tags]

Examples

Update Disk pool

az disk-pool update --name "myDiskPool" --disks "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm-name_DataDisk_0" --disks "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm-name_DataDisk_1" --sku name="Basic_B1" tier="Basic" --tags key="value" --resource-group "myResourceGroup"

Optional Parameters

--disk-pool-name --name -n

The name of the Disk Pool.

--disks

List of Azure Managed Disks to attach to a Disk Pool.

The order of this parameter is specific customized. Usage: --disks id-value

id: Required. Unique Azure Resource ID of the Managed Disk.

Multiple actions can be specified by using more than one --disks argument.

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

--managed-by

Azure resource id. Indicates if this resource is managed by another Azure resource.

--managed-by-extended

List of Azure resource ids that manage this resource.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--resource-group -g

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

--sku

Determines the SKU of the Disk Pool.

Usage: --sku name=XX tier=XX

name: Required. Sku name tier: Sku tier.

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 disk-pool wait

Place the CLI in a waiting state until a condition of the disk-pool is met.

az disk-pool wait [--created]
                  [--custom]
                  [--deleted]
                  [--disk-pool-name]
                  [--exists]
                  [--ids]
                  [--interval]
                  [--resource-group]
                  [--subscription]
                  [--timeout]
                  [--updated]

Examples

Pause executing next line of CLI script until the disk-pool is successfully created.

az disk-pool wait --name "myDiskPool" --resource-group "myResourceGroup" --created

Pause executing next line of CLI script until the disk-pool is successfully updated.

az disk-pool wait --name "myDiskPool" --resource-group "myResourceGroup" --updated

Pause executing next line of CLI script until the disk-pool is successfully deleted.

az disk-pool wait --name "myDiskPool" --resource-group "myResourceGroup" --deleted

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False
--disk-pool-name --name -n

The name of the Disk Pool.

--exists

Wait until the resource exists.

default value: False
--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.

--interval

Polling interval in seconds.

default value: 30
--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.

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

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.