Share via

az vmware private-cloud identity-source

Note

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

Property Value
Parameter group: PrivateCloud.properties.identitySources[] Arguments
--base-group-dn

The base distinguished name for groups.

Property Value
Parameter group: PrivateCloud.properties.identitySources[] Arguments
--base-user-dn

The base distinguished name for users.

Property Value
Parameter group: PrivateCloud.properties.identitySources[] Arguments
--___domain

The ___domain's dns name.

Property Value
Parameter group: PrivateCloud.properties.identitySources[] Arguments
--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.

Property Value
Parameter group: PrivateCloud.properties.identitySources[] Arguments
--primary-server

Primary server URL.

Property Value
Parameter group: PrivateCloud.properties.identitySources[] Arguments
--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.

Property Value
Parameter group: PrivateCloud.properties.identitySources[] Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

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

Secondary server URL.

Property Value
Parameter group: PrivateCloud.properties.identitySources[] Arguments
--ssl

Protect LDAP communication using SSL certificate (LDAPS).

Property Value
Parameter group: PrivateCloud.properties.identitySources[] Arguments
Default value: Disabled
Accepted values: Disabled, Enabled
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

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

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

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.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

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.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Generic Update Arguments
--alias

The ___domain's NetBIOS name.

Property Value
Parameter group: PrivateCloud.properties.identitySources[] Arguments
--base-group-dn

The base distinguished name for groups.

Property Value
Parameter group: PrivateCloud.properties.identitySources[] Arguments
--base-user-dn

The base distinguished name for users.

Property Value
Parameter group: PrivateCloud.properties.identitySources[] Arguments
--___domain

The ___domain's dns name.

Property Value
Parameter group: PrivateCloud.properties.identitySources[] Arguments
--force-string

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

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--no-wait

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

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

Property Value
Parameter group: PrivateCloud.properties.identitySources[] Arguments
--primary-server

Primary server URL.

Property Value
Parameter group: PrivateCloud.properties.identitySources[] Arguments
--remove

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

Property Value
Parameter group: Generic Update Arguments
--secondary-server

Secondary server URL.

Property Value
Parameter group: PrivateCloud.properties.identitySources[] Arguments
--set

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

Property Value
Parameter group: Generic Update Arguments
--ssl

Protect LDAP communication using SSL certificate (LDAPS).

Property Value
Parameter group: PrivateCloud.properties.identitySources[] Arguments
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.

Property Value
Parameter group: PrivateCloud.properties.identitySources[] Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--private-cloud -c

Name of the private cloud.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False