Share via

az vmware private-cloud identity-source

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

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

--no-wait

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

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

Secondary server URL.

--ssl

Protect LDAP communication using SSL certificate (LDAPS).

Accepted values: Disabled, Enabled
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 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

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

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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 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

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

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

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

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

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

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

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

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--remove

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

--secondary-server

Secondary server URL.

--set

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

--ssl

Protect LDAP communication using SSL certificate (LDAPS).

Accepted values: Disabled, Enabled
--username

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

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

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

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.

--interval

Polling interval in seconds.

Default value: 30
--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.

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