Share via

az csvmware vm disk

  • Preview
  • Reference

Note

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

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

Manage VMware virtual machine's disks.

Commands

Name Description Type Status
az csvmware vm disk add

Add disk to a VMware virtual machine.

 Extension Preview
az csvmware vm disk delete

Delete disks from a VM.

 Extension Preview
az csvmware vm disk list

List details of disks available on a VMware virtual machine.

 Extension Preview
az csvmware vm disk show

Get the details of a VMware virtual machine's disk.

 Extension Preview

az csvmware vm disk add

Preview

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

Add disk to a VMware virtual machine.

az csvmware vm disk add --resource-group
                        --vm-name
                        [--controller]
                        [--mode {independent_nonpersistent, independent_persistent, persistent}]
                        [--size]

Examples

Add a disk with default parameters in a VM.

az csvmware vm disk add --vm-name MyVm -g MyResourceGroup

Add a disk with SATA controller 0 and 64 GB memory in a VM.

az csvmware vm disk add --vm-name MyVm -g MyResourceGroup --controller 15000 --size 67108864

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

--controller

Id of the controller. Input 1000 for SCSI controller 0, and 15000 for SATA controller 0.

Default value: 1000
--mode

The disk independence mode.

Accepted values: independent_nonpersistent, independent_persistent, persistent
Default value: persistent
--size

The amount of disk size in KB.

Default value: 16777216
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 csvmware vm disk delete

Preview

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

Delete disks from a VM.

az csvmware vm disk delete --disks
                           --resource-group
                           --vm-name

Examples

Delete two disks from a VM.

az csvmware vm disk delete --vm-name MyVm -g MyResourceGroup --disks "My Disk Name 1" "My Disk Name 2"

Required Parameters

--disks

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

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 csvmware vm disk list

Preview

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

List details of disks available on a VMware virtual machine.

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

Examples

List details of disks in a VM.

az csvmware vm disk list --vm-name MyVm -g MyResourceGroup

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.

--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 csvmware vm disk show

Preview

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

Get the details of a VMware virtual machine's disk.

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

Examples

Get the details of a disk in a VM.

az csvmware vm disk show --vm-name MyVm -g MyResourceGroup -n "My Disk Name"

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.

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