az vmware private-cloud

Reference

Note

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

Commands to manage private clouds.

Commands

Name	Description	Type	Status
az vmware private-cloud add-cmk-encryption	Add a Customer Managed Keys Encryption to a private cloud.	Extension	Deprecated
az vmware private-cloud add-identity-source	Add a vCenter Single Sign On Identity Source to a private cloud.	Extension	Deprecated
az vmware private-cloud addidentitysource	Add a vCenter Single Sign On Identity Source to a private cloud.	Extension	Deprecated
az vmware private-cloud create	Create a private cloud.	Extension	GA
az vmware private-cloud delete	Delete a private cloud.	Extension	GA
az vmware private-cloud delete-cmk-encryption	Delete a Customer Managed Keys Encryption from a private cloud.	Extension	Deprecated
az vmware private-cloud delete-identity-source	Delete a vCenter Single Sign On Identity Source for a private cloud.	Extension	Deprecated
az vmware private-cloud deleteidentitysource	Delete a vCenter Single Sign On Identity Source for a private cloud.	Extension	Deprecated
az vmware private-cloud disable-cmk-encryption	Disable a Customer Managed Keys Encryption from a private cloud.	Extension	GA
az vmware private-cloud enable-cmk-encryption	Enable a Customer Managed Keys Encryption to a private cloud.	Extension	GA
az vmware private-cloud identity	Commands for Managed Identity in a private cloud.	Extension	GA
az vmware private-cloud identity-source	Manage a vCenter Single Sign On Identity Source of a private cloud.	Extension	GA
az vmware private-cloud identity-source create	Create a vCenter Single Sign On Identity Source to a private cloud.	Extension	GA
az vmware private-cloud identity-source delete	Delete a vCenter Single Sign On Identity Source of a private cloud.	Extension	GA
az vmware private-cloud identity-source list	List vCenter Single Sign On Identity Sources of a private cloud.	Extension	GA
az vmware private-cloud identity-source show	Show a vCenter Single Sign On Identity Source of a private cloud.	Extension	GA
az vmware private-cloud identity-source update	Update a vCenter Single Sign On Identity Source of a private cloud.	Extension	GA
az vmware private-cloud identity-source wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az vmware private-cloud identity assign	Assign a Managed Identity in a private cloud.	Extension	GA
az vmware private-cloud identity remove	Remove a Managed Identity in a private cloud.	Extension	GA
az vmware private-cloud identity show	Show Managed Identities in a private cloud.	Extension	GA
az vmware private-cloud list	List the private clouds.	Extension	GA
az vmware private-cloud list-admin-credentials	List the admin credentials for the private cloud.	Extension	GA
az vmware private-cloud listadmincredentials	List the admin credentials for the private cloud.	Extension	Deprecated
az vmware private-cloud rotate-nsxt-password	Rotate the NSX-T Manager password.	Extension	GA
az vmware private-cloud rotate-vcenter-password	Rotate the vCenter password.	Extension	GA
az vmware private-cloud show	Get a private cloud.	Extension	GA
az vmware private-cloud update	Update a private cloud.	Extension	GA
az vmware private-cloud wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az vmware private-cloud add-cmk-encryption

Deprecated

This command has been deprecated and will be removed in a future release. Use 'az vmware private-cloud enable-cmk-encryption' instead.

Add a Customer Managed Keys Encryption to a private cloud.

az vmware private-cloud add-cmk-encryption --private-cloud
                                           --resource-group
                                           [--enc-kv-key-name]
                                           [--enc-kv-key-version]
                                           [--enc-kv-url]

Required Parameters

--private-cloud -c

Name of the private cloud.

--resource-group -g

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

Optional Parameters

--enc-kv-key-name

The name of the encryption key vault key.

--enc-kv-key-version

The version of the encryption key vault key.

--enc-kv-url

The URL of the encryption key vault.

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 vmware private-cloud add-identity-source

Deprecated

This command has been deprecated and will be removed in a future release. Use 'az vmware private-cloud identity-source create' instead.

Add a vCenter Single Sign On Identity Source to a private cloud.

az vmware private-cloud add-identity-source --alias
                                            --base-group-dn
                                            --base-user-dn
                                            --domain
                                            --name
                                            --password
                                            --primary-server
                                            --private-cloud
                                            --resource-group
                                            --username
                                            [--secondary-server]
                                            [--ssl]

Required Parameters

--alias

The domain's NetBIOS name.

--base-group-dn

The base distinguished name for groups.

--base-user-dn

The base distinguished name for users.

--domain

The domain's dns name.

--name -n

The name of the identity source.

--password

The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups.

--primary-server

Primary server URL.

--private-cloud -c

Name of the private cloud.

--resource-group -g

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

--username

The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group.

Optional Parameters

--secondary-server

Secondary server URL.

--ssl

Protect LDAP communication using SSL certificate (LDAPS). Specify "Enabled" or "Disabled".

Default value: Disabled

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 vmware private-cloud addidentitysource

Deprecated

This command has been deprecated and will be removed in a future release. Use 'az vmware private-cloud identity-source create' instead.

Add a vCenter Single Sign On Identity Source to a private cloud.

az vmware private-cloud addidentitysource --alias
                                          --base-group-dn
                                          --base-user-dn
                                          --domain
                                          --name
                                          --password
                                          --primary-server
                                          --private-cloud
                                          --resource-group
                                          --username
                                          [--secondary-server]
                                          [--ssl]

Required Parameters

--alias

The domain's NetBIOS name.

--base-group-dn

The base distinguished name for groups.

--base-user-dn

The base distinguished name for users.

--domain

The domain's dns name.

--name -n

The name of the identity source.

--password

The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups.

--primary-server

Primary server URL.

--private-cloud -c

Name of the private cloud.

--resource-group -g

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

--username

The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group.

Optional Parameters

--secondary-server

Secondary server URL.

--ssl

Protect LDAP communication using SSL certificate (LDAPS). Specify "Enabled" or "Disabled".

Default value: Disabled

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 vmware private-cloud create

Create a private cloud.

az vmware private-cloud create --name
                               --resource-group
                               --sku
                               [--accept-eula]
                               [--cluster-size]
                               [--ext-nw-blocks]
                               [--internet {Disabled, Enabled}]
                               [--location]
                               [--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
                               [--network-block]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--nsxt-password]
                               [--secondary-zone]
                               [--strategy {DualZone, SingleZone}]
                               [--tags]
                               [--vcenter-password]
                               [--virtual-network-id]
                               [--zone]

Required Parameters

--name --private-cloud-name -n

Name of the private cloud.

--resource-group -g

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

--sku

The name of the SKU. E.g. P3. It is typically a letter+number code.

Optional Parameters

--accept-eula --yes -y

Accept the end-user license agreement without prompting.

Default value: False

--cluster-size

Number of hosts for the default management cluster. Minimum of 3 and maximum of 16.

--ext-nw-blocks --extended-network-blocks

Array of additional networks noncontiguous with networkBlock. Networks must be unique and non-overlapping across VNet in your subscription, on-premise, and this privateCloud networkBlock attribute. Make sure the CIDR format conforms to (A.B.C.D/X). Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--internet

Connectivity to internet is enabled or disabled.

Accepted values: Disabled, Enabled

Default value: Disabled

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--mi-system-assigned

Enable a system assigned identity.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--network-block

The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--nsxt-password

Optionally, set the NSX-T Manager password when the private cloud is created If value is blank it's asked from the tty.

--secondary-zone

The secondary availability zone for the private cloud.

--strategy

The availability strategy for the private cloud.

Accepted values: DualZone, SingleZone

--tags

Resource tags Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--vcenter-password

Optionally, set the vCenter admin password when the private cloud is created If value is blank it's asked from the tty.

--virtual-network-id

Azure resource ID of the virtual network.

--zone

The primary availability zone for the private cloud.

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 vmware private-cloud delete

Delete a private cloud.

az vmware private-cloud delete [--ids]
                               [--name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--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 --private-cloud-name -n

Name of the private cloud.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--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 vmware private-cloud delete-cmk-encryption

Deprecated

This command has been deprecated and will be removed in a future release. Use 'az vmware private-cloud disable-cmk-encryption' instead.

Delete a Customer Managed Keys Encryption from a private cloud.

az vmware private-cloud delete-cmk-encryption --private-cloud
                                              --resource-group
                                              [--yes]

Required Parameters

--private-cloud -c

Name of the private cloud.

--resource-group -g

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

Optional Parameters

--yes

Delete without 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 vmware private-cloud delete-identity-source

Deprecated

This command has been deprecated and will be removed in a future release. Use 'az vmware private-cloud identity-source delete' instead.

Delete a vCenter Single Sign On Identity Source for a private cloud.

az vmware private-cloud delete-identity-source --alias
                                               --domain
                                               --name
                                               --private-cloud
                                               --resource-group
                                               [--yes]

Required Parameters

--alias

The domain's NetBIOS name.

--domain

The domain's dns name.

--name -n

The name of the identity source.

--private-cloud -c

Name of the private cloud.

--resource-group -g

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

Optional Parameters

--yes

Delete without 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 vmware private-cloud deleteidentitysource

Deprecated

This command has been deprecated and will be removed in a future release. Use 'az vmware private-cloud identity-source delete' instead.

Delete a vCenter Single Sign On Identity Source for a private cloud.

az vmware private-cloud deleteidentitysource --alias
                                             --domain
                                             --name
                                             --private-cloud
                                             --resource-group
                                             [--yes]

Required Parameters

--alias

The domain's NetBIOS name.

--domain

The domain's dns name.

--name -n

The name of the identity source.

--private-cloud -c

Name of the private cloud.

--resource-group -g

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

Optional Parameters

--yes

Delete without 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 vmware private-cloud disable-cmk-encryption

Disable a Customer Managed Keys Encryption from a private cloud.

az vmware private-cloud disable-cmk-encryption --private-cloud
                                               --resource-group
                                               [--yes]

Required Parameters

--private-cloud -c

Name of the private cloud.

--resource-group -g

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

Optional Parameters

--yes

Delete without 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 vmware private-cloud enable-cmk-encryption

Enable a Customer Managed Keys Encryption to a private cloud.

az vmware private-cloud enable-cmk-encryption --private-cloud
                                              --resource-group
                                              [--enc-kv-key-name]
                                              [--enc-kv-key-version]
                                              [--enc-kv-url]

Required Parameters

--private-cloud -c

Name of the private cloud.

--resource-group -g

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

Optional Parameters

--enc-kv-key-name

The name of the encryption key vault key.

--enc-kv-key-version

The version of the encryption key vault key.

--enc-kv-url

The URL of the encryption key vault.

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 vmware private-cloud list

List the private clouds.

az vmware private-cloud 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 vmware private-cloud list-admin-credentials

List the admin credentials for the private cloud.

az vmware private-cloud list-admin-credentials [--ids]
                                               [--private-cloud]
                                               [--resource-group]
                                               [--subscription]

Optional Parameters

--ids

--private-cloud -c

Name of the private cloud.

--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 vmware private-cloud listadmincredentials

Deprecated

This command has been deprecated and will be removed in a future release. Use 'az vmware private-cloud list-admin-credentials' instead.

List the admin credentials for the private cloud.

az vmware private-cloud listadmincredentials --private-cloud
                                             --resource-group

Required Parameters

--private-cloud -c

Name of the private cloud.

--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 vmware private-cloud rotate-nsxt-password

Rotate the NSX-T Manager password.

az vmware private-cloud rotate-nsxt-password [--ids]
                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--private-cloud]
                                             [--resource-group]
                                             [--subscription]
                                             [--yes]

Examples

Rotate the NSX-T password

az rotate-nsxt-password --resource-group MyResourceGroup --private-cloud MyPrivateCloud

Optional Parameters

--ids

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--private-cloud -c

Name of the private cloud.

--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 vmware private-cloud rotate-vcenter-password

Rotate the vCenter password.

az vmware private-cloud rotate-vcenter-password [--ids]
                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--private-cloud]
                                                [--resource-group]
                                                [--subscription]
                                                [--yes]

Examples

Rotate the vCenter password.

az vmware private-cloud rotate-vcenter-password --resource-group MyResourceGroup --private-cloud MyPrivateCloud

Optional Parameters

--ids

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--private-cloud -c

Name of the private cloud.

--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 vmware private-cloud show

Get a private cloud.

az vmware private-cloud show [--ids]
                             [--name]
                             [--resource-group]
                             [--subscription]

Optional Parameters

--ids

--name --private-cloud-name -n

Name of the private cloud.

--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 vmware private-cloud update

Update a private cloud.

az vmware private-cloud update [--add]
                               [--cluster-size]
                               [--dns-zone-type {Private, Public}]
                               [--ext-nw-blocks]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--hosts]
                               [--ids]
                               [--internet {Disabled, Enabled}]
                               [--name]
                               [--network-block]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--nsxt-password]
                               [--remove]
                               [--resource-group]
                               [--set]
                               [--subscription]
                               [--tags]
                               [--vcenter-password]
                               [--vsan-datastore-name]

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--cluster-size

Number of hosts for the default management cluster. Minimum of 3 and maximum of 16.

--dns-zone-type

The type of DNS zone to use.

Accepted values: Private, Public

--ext-nw-blocks --extended-network-blocks

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--hosts

The hosts Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--ids

--internet

Connectivity to internet is enabled or disabled.

Accepted values: Disabled, Enabled

--name --private-cloud-name -n

Name of the private cloud.

--network-block

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--nsxt-password

Optionally, set the NSX-T Manager password when the private cloud is created If value is blank it's asked from the tty.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--subscription

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

--tags

Resource tags Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--vcenter-password

Optionally, set the vCenter admin password when the private cloud is created If value is blank it's asked from the tty.

--vsan-datastore-name

Name of the vsan datastore associated with the cluster.

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 vmware private-cloud wait

Place the CLI in a waiting state until a condition is met.

az vmware private-cloud wait [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--ids]
                             [--interval]
                             [--name]
                             [--resource-group]
                             [--subscription]
                             [--timeout]
                             [--updated]

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

--exists

Wait until the resource exists.

Default value: False

--ids

--interval

Polling interval in seconds.

Default value: 30

--name --private-cloud-name -n

Name of the private cloud.

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

Share via

az vmware private-cloud

Commands

az vmware private-cloud add-cmk-encryption

Required Parameters

Optional Parameters

az vmware private-cloud add-identity-source

Required Parameters

Optional Parameters

az vmware private-cloud addidentitysource

Required Parameters

Optional Parameters

az vmware private-cloud create

Required Parameters

Optional Parameters

az vmware private-cloud delete

Optional Parameters

az vmware private-cloud delete-cmk-encryption

Required Parameters

Optional Parameters

az vmware private-cloud delete-identity-source

Required Parameters

Optional Parameters

az vmware private-cloud deleteidentitysource

Required Parameters

Optional Parameters

az vmware private-cloud disable-cmk-encryption

Required Parameters

Optional Parameters

az vmware private-cloud enable-cmk-encryption

Required Parameters

Optional Parameters

az vmware private-cloud list

Optional Parameters

az vmware private-cloud list-admin-credentials

Optional Parameters

az vmware private-cloud listadmincredentials

Required Parameters

az vmware private-cloud rotate-nsxt-password

Examples

Optional Parameters

az vmware private-cloud rotate-vcenter-password

Examples

Optional Parameters

az vmware private-cloud show

Optional Parameters

az vmware private-cloud update

Optional Parameters

az vmware private-cloud wait

Optional Parameters

Additional resources