az connectedvmware vm disk

Note

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

Vm disk.

Commands

Name	Description	Type	Status
az connectedvmware vm disk add	Add virtual disk to a virtual machine.	Extension	GA
az connectedvmware vm disk delete	Delete virtual disks to a virtual machine.	Extension	GA
az connectedvmware vm disk list	Retrieve a list of vm disk from given resource group name and vm name.	Extension	GA
az connectedvmware vm disk show	Get details of a vm disk by it's name, resource-group and vm name.	Extension	GA
az connectedvmware vm disk update	Update virtual disk to a virtual machine.	Extension	GA

az connectedvmware vm disk add

Add virtual disk to a virtual machine.

az connectedvmware vm disk add --controller-key
                               --disk-size
                               --name
                               --resource-group
                               --vm-name
                               [--disk-mode]
                               [--no-wait]
                               [--unit-number]

Examples

Add virtual disk to a virtual machine

az connectedvmware vm disk add --controller-key "The controller key of the disk"                --disk-size "The disk size in GBs" --name "Name of the Disk" --resource-group                "resource group name" --vm-name "Name of the virtual machine"

Required Parameters

--controller-key

The controller key of the disk.

--disk-size

The disk size in GBs.

--name -n

Name of the Disk.

--resource-group -g

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

--vm-name

Name of the virtual machine.

Optional Parameters

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

--disk-mode

The mode of the disk.

Property	Value
Default value:	PERSISTENT

--no-wait

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

Property	Value
Default value:	False

--unit-number

The unit number of the disk.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az connectedvmware vm disk delete

Delete virtual disks to a virtual machine.

az connectedvmware vm disk delete --disks
                                  --resource-group
                                  --vm-name
                                  [--no-wait]
                                  [--yes]

Examples

Delete virtual disks to a virtual machine

az connectedvmware vm disk delete --disk "Names of the Disks" --resource-group                "resource group name" --vm-name "Name of the virtual machine"

Required Parameters

--disks

Names of the Disks.

--resource-group -g

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

--vm-name

Name of the virtual machine.

Optional Parameters

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

--no-wait

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

Property	Value
Default value:	False

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az connectedvmware vm disk list

Retrieve a list of vm disk from given resource group name and vm name.

az connectedvmware vm disk list --resource-group
                                --vm-name

Examples

Retrieve a list of vm disk

az connectedvmware vm disk list --resource-group "resource group name" --vm-name                "Name of the virtual machine"

Required Parameters

--resource-group -g

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

--vm-name

Name of the virtual machine.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az connectedvmware vm disk show

Get details of a vm disk by it's name, resource-group and vm name.

az connectedvmware vm disk show --name
                                --resource-group
                                --vm-name

Examples

Get details of vm disk

az connectedvmware vm disk show --name "Name of the Disk" --resource-group                "resource group name" --vm-name "Name of the virtual machine"

Required Parameters

--name -n

Name of the Disk.

--resource-group -g

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

--vm-name

Name of the virtual machine.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az connectedvmware vm disk update

Update virtual disk to a virtual machine.

az connectedvmware vm disk update --resource-group
                                  --vm-name
                                  [--controller-key]
                                  [--device-key]
                                  [--disk-mode]
                                  [--disk-size]
                                  [--name]
                                  [--no-wait]
                                  [--unit-number]

Examples

Update virtual disk to a virtual machine

az connectedvmware vm disk update --controller-key "The controller key of the disk"                --disk-size "The disk size in GBs" --name "Name of the Disk" --resource-group                "resource group name" --vm-name "Name of the virtual machine"

Required Parameters

--resource-group -g

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

--vm-name

Name of the virtual machine.

Optional Parameters

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

--controller-key

The controller key of the disk.

--device-key

The device key for the disk.

--disk-mode

The mode of the disk.

--disk-size

The disk size in GBs.

--name -n

Name of the Disk.

--no-wait

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

Property	Value
Default value:	False

--unit-number

The unit number of the disk.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False