az vmware private-cloud
Note
This reference is part of the vmware extension for the Azure CLI (version 2.51.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
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
Name of the private cloud.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The name of the encryption key vault key.
The version of the encryption key vault key.
The URL of the encryption key vault.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az vmware private-cloud add-identity-source
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
The domain's NetBIOS name.
The base distinguished name for groups.
The base distinguished name for users.
The domain's dns name.
The name of the identity source.
The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups.
Primary server URL.
Name of the private cloud.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
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 URL.
Protect LDAP communication using SSL certificate (LDAPS). Specify "Enabled" or "Disabled".
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az vmware private-cloud addidentitysource
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
The domain's NetBIOS name.
The base distinguished name for groups.
The base distinguished name for users.
The domain's dns name.
The name of the identity source.
The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups.
Primary server URL.
Name of the private cloud.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
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 URL.
Protect LDAP communication using SSL certificate (LDAPS). Specify "Enabled" or "Disabled".
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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]
[--ext-nw-blocks]
[--internet {Disabled, Enabled}]
[--location]
[--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--nsxt-password]
[--secondary-zone]
[--strategy {DualZone, SingleZone}]
[--tags]
[--vcenter-password]
[--zone]Required Parameters
Number of hosts for the default management cluster. Minimum of 3 and maximum of 16.
Name of the private cloud.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the SKU.
Optional Parameters
Accept the end-user license agreement without prompting.
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.
Connectivity to internet is enabled or disabled.
Resource location When not specified, the location of the resource group will be used.
Enable a system assigned identity.
Do not wait for the long-running operation to finish.
NSX-T Manager password when the private cloud is created If value is blank it's asked from the tty.
The secondary availability zone for the private cloud.
The availability strategy for the private cloud.
Resource tags Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
VCenter admin password when the private cloud is created If value is blank it's asked from the tty.
The primary availability zone for the private cloud.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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
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 of the private cloud.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az vmware private-cloud delete-cmk-encryption
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
Name of the private cloud.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Delete without confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az vmware private-cloud delete-identity-source
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
The domain's NetBIOS name.
The domain's dns name.
The name of the identity source.
Name of the private cloud.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Delete without confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az vmware private-cloud deleteidentitysource
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
The domain's NetBIOS name.
The domain's dns name.
The name of the identity source.
Name of the private cloud.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Delete without confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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
Name of the private cloud.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Delete without confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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
Name of the private cloud.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The name of the encryption key vault key.
The version of the encryption key vault key.
The URL of the encryption key vault.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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
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 of the private cloud.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az vmware private-cloud listadmincredentials
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-groupRequired Parameters
Name of the private cloud.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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-passwordExamples
Rotate the NSX-T Manager password.
az vmware private-cloud rotate-nsxt-passwordGlobal Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 MyPrivateCloudOptional Parameters
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.
Do not wait for the long-running operation to finish.
Name of the private cloud.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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
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 of the private cloud.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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]
[--ext-nw-blocks]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--internet {Disabled, Enabled}]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--nsxt-password]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--tags]
[--vcenter-password]Optional Parameters
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>.
The cluster size.
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.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
Connectivity to internet is enabled or disabled.
Name of the private cloud.
Do not wait for the long-running operation to finish.
Optionally, set the NSX-T Manager password when the private cloud is created If value is blank it's asked from the tty.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Resource tags Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Optionally, set the vCenter admin password when the private cloud is created If value is blank it's asked from the tty.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
Name of the private cloud.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for