az vmware private-cloud identity-source
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 identity-source command. Learn more about extensions.
Manage a vCenter Single Sign On Identity Source of a private cloud.
Commands
Name | Description | Type | Status |
---|---|---|---|
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-source create
Create a vCenter Single Sign On Identity Source to a private cloud.
az vmware private-cloud identity-source create --alias
--base-group-dn
--base-user-dn
--domain
--name
--password
--primary-server
--private-cloud
--resource-group
--username
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--secondary-server]
[--ssl {Disabled, Enabled}]
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
Do not wait for the long-running operation to finish.
Secondary server URL.
Protect LDAP communication using SSL certificate (LDAPS).
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 identity-source delete
Delete a vCenter Single Sign On Identity Source of a private cloud.
az vmware private-cloud identity-source delete --name
--private-cloud
--resource-group
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--yes]
Required Parameters
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
Do not wait for the long-running operation to finish.
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 identity-source list
List vCenter Single Sign On Identity Sources of a private cloud.
az vmware private-cloud identity-source list --private-cloud
--resource-group
Required 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 identity-source show
Show a vCenter Single Sign On Identity Source of a private cloud.
az vmware private-cloud identity-source show --name
--private-cloud
--resource-group
Required Parameters
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>
.
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 identity-source update
Update a vCenter Single Sign On Identity Source of a private cloud.
az vmware private-cloud identity-source update --name
--private-cloud
--resource-group
[--add]
[--alias]
[--base-group-dn]
[--base-user-dn]
[--domain]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--password]
[--primary-server]
[--remove]
[--secondary-server]
[--set]
[--ssl {Disabled, Enabled}]
[--username]
Required Parameters
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
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 domain's NetBIOS name.
The base distinguished name for groups.
The base distinguished name for users.
The domain's dns name.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Do not wait for the long-running operation to finish.
The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups.
Primary server URL.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Secondary server URL.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Protect LDAP communication using SSL certificate (LDAPS).
The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group.
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 identity-source wait
Place the CLI in a waiting state until a condition is met.
az vmware private-cloud identity-source wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--private-cloud]
[--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.