az vmware private-cloud

Reference

Note

This reference is part of the vmware extension for the Azure CLI (version 2.11.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

az vmware private-cloud add-availability-zone	Add an Availability Zone to a private cloud.
az vmware private-cloud add-cmk-encryption	Add a Customer Managed Keys Encryption to a private cloud.
az vmware private-cloud addidentitysource	Add a vCenter Single Sign On Identity Source to a private cloud.
az vmware private-cloud add-identity-source	Add a vCenter Single Sign On Identity Source to a private cloud.
az vmware private-cloud create	Create a private cloud.
az vmware private-cloud delete	Delete a private cloud.
az vmware private-cloud delete-availability-zone	Delete an Availability Zone from a private cloud.
az vmware private-cloud delete-cmk-encryption	Delete a Customer Managed Keys Encryption from a private cloud.
az vmware private-cloud deleteidentitysource	Delete a vCenter Single Sign On Identity Source for a private cloud.
az vmware private-cloud delete-identity-source	Delete a vCenter Single Sign On Identity Source for a private cloud.
az vmware private-cloud identity	Commands for Managed Identity in a private cloud.
az vmware private-cloud identity assign	Assign a Managed Identity in a private cloud.
az vmware private-cloud identity remove	Remove a Managed Identity in a private cloud.
az vmware private-cloud identity show	Show Managed Identities in a private cloud.
az vmware private-cloud list	List the private clouds.
az vmware private-cloud listadmincredentials	List the admin credentials for the private cloud.
az vmware private-cloud list-admin-credentials	List the admin credentials for the private cloud.
az vmware private-cloud rotate-nsxt-password	Rotate the NSX-T Manager password.
az vmware private-cloud rotate-vcenter-password	Rotate the vCenter password.
az vmware private-cloud show	Show details of a private cloud.
az vmware private-cloud update	Update a private cloud.

az vmware private-cloud add-availability-zone

Add an Availability Zone to a private cloud.

az vmware private-cloud add-availability-zone --private-cloud
                                              --resource-group
                                              [--secondary-zone]
                                              [--strategy]
                                              [--zone]

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

--secondary-zone

The secondary availability zone for the private cloud.

--strategy

The availability strategy for the private cloud.

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

--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-cmk-encryption

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]
                                           [--enc-status]

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.

--enc-status

Status of customer managed encryption key.

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.

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

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.

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

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.

--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 --cluster-size
                               --name
                               --network-block
                               --resource-group
                               --sku
                               [--accept-eula]
                               [--internet]
                               [--location]
                               [--mi-system-assigned]
                               [--nsxt-password]
                               [--tags]
                               [--vcenter-password]
                               [--yes]

Required Parameters

--cluster-size

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

--name -n

Name of the private cloud.

--network-block

A subnet at least of size /22. 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.

--resource-group -g

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

--sku

The product SKU.

Optional Parameters

--accept-eula

Accept the end-user license agreement without prompting.

--internet

Connectivity to internet. Specify "Enabled" or "Disabled".

--location -l

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

--mi-system-assigned

Enable a system assigned identity.

--nsxt-password

NSX-T Manager password.

--tags

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

--vcenter-password

VCenter admin password.

--yes

Delete without confirmation.

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.

--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 --name
                               --resource-group
                               [--yes]

Required Parameters

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

Optional Parameters

--yes

Delete without confirmation.

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.

--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-availability-zone

Delete an Availability Zone from a private cloud.

az vmware private-cloud delete-availability-zone --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.

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.

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

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.

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.

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

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.

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.

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

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.

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.

--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 [--resource-group]

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.

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

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.

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

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

Examples

Rotate the NSX-T Manager password.

az vmware private-cloud rotate-nsxt-password

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.

--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 --private-cloud
                                                --resource-group
                                                [--yes]

Examples

Rotate the vCenter password.

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

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.

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.

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

Show details of a private cloud.

az vmware private-cloud show --name
                             --resource-group

Required Parameters

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

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.

--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 --name
                               --resource-group
                               [--cluster-size]
                               [--internet]
                               [--tags]

Required Parameters

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

Optional Parameters

--cluster-size

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

--internet

Connectivity to internet. Specify "Enabled" or "Disabled".

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

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

Is this page helpful?

Commands

az vmware private-cloud add-availability-zone

Required Parameters

Optional Parameters

az vmware private-cloud add-cmk-encryption

Required Parameters

Optional Parameters

az vmware private-cloud addidentitysource

Required Parameters

Optional Parameters

az vmware private-cloud add-identity-source

Required Parameters

Optional Parameters

az vmware private-cloud create

Required Parameters

Optional Parameters

az vmware private-cloud delete

Required Parameters

Optional Parameters

az vmware private-cloud delete-availability-zone

Required Parameters

Optional Parameters

az vmware private-cloud delete-cmk-encryption

Required Parameters

Optional Parameters

az vmware private-cloud deleteidentitysource

Required Parameters

Optional Parameters

az vmware private-cloud delete-identity-source

Required Parameters

Optional Parameters

az vmware private-cloud list

Optional Parameters

az vmware private-cloud listadmincredentials

Required Parameters

az vmware private-cloud list-admin-credentials

Required Parameters

az vmware private-cloud rotate-nsxt-password

Examples

az vmware private-cloud rotate-vcenter-password

Examples

Required Parameters

Optional Parameters

az vmware private-cloud show

Required Parameters

az vmware private-cloud update

Required Parameters

Optional Parameters

الملاحظات