az netappfiles account ldap-configuration

Manage Ldap Configuration.

Commands

Name Description Type Status
az netappfiles account ldap-configuration create

Create LDAP configuration.

Core GA
az netappfiles account ldap-configuration delete

Delete LDAP configuration.

Core GA
az netappfiles account ldap-configuration show

Show LDAP configuration.

Core GA
az netappfiles account ldap-configuration update

Update LDAP configuration.

Core GA
az netappfiles account ldap-configuration wait

Place the CLI in a waiting state until a condition is met.

Core GA

az netappfiles account ldap-configuration create

Create LDAP configuration.

az netappfiles account ldap-configuration create --account-name
                                                 --resource-group
                                                 [--acquire-policy-token]
                                                 [--bind-auth-level --bind-authentication-level {Anonymous, Simple}]
                                                 [--bind-dn]
                                                 [--bind-password-azure-key-vault-uri --bp-akv-uri]
                                                 [--bind-password-secret-name --bp-secret-name]
                                                 [--bind-password-user-assigned-identity --bp-user-assigned-mi]
                                                 [--certificate-cn-host]
                                                 [--change-reference]
                                                 [--dns-servers]
                                                 [--domain]
                                                 [--group-dn]
                                                 [--ldap-port]
                                                 [--ldap-servers]
                                                 [--net-group-dn]
                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--secure-ldap-type {LdapOverTLS, None}]
                                                 [--server-ca-certificate]
                                                 [--user-dn]

Examples

Accounts_CreateOrUpdate

az netappfiles account ldap-configuration create --resource-group myRG --account-name account1

Required Parameters

--account-name

The name of the NetApp account.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--bind-auth-level --bind-authentication-level

The authentication level to use when binding to the LDAP server, defaults to Anonymous.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
Default value: Anonymous
Accepted values: Anonymous, Simple
--bind-dn

The distinguished name (DN) to bind as when performing LDAP operations.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
--bind-password-azure-key-vault-uri --bp-akv-uri

The Azure Key Vault URI where the Bind DN user password is stored.

Property Value
Parameter group: BindPasswordAkvConfig Arguments
--bind-password-secret-name --bp-secret-name

The name of the secret in Azure Key Vault that contains the Bind DN user password.

Property Value
Parameter group: BindPasswordAkvConfig Arguments
--bind-password-user-assigned-identity --bp-user-assigned-mi

The ARM resource identifier of the user assigned identity used to authenticate with key vault.

Property Value
Parameter group: BindPasswordAkvConfig Arguments
--certificate-cn-host

The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--dns-servers

List of DNS server IPv4 addresses for resolving the CN host certificate. This parameter is used when LDAP over TLS is enabled. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
--domain

Name of the LDAP configuration domain.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
--group-dn

This specifies the group DN (Distinguished Name), which overrides the base DN for group lookups.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
--ldap-port

Port number for LDAP communication. Default is 389 for LDAP.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
--ldap-servers

List of LDAP server IP addresses (IPv4 only) for the LDAP domain. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
--net-group-dn

This specifies the netgroup DN (Distinguished Name), which overrides the base DN for netgroup lookups.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
--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
--secure-ldap-type

Indicates the secure LDAP mode for encrypting communication between ANF storage and customer LDAP servers.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
Default value: None
Accepted values: LdapOverTLS, None
--server-ca-certificate

When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate. If value is blank it's asked from the tty.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
--user-dn

This specifies the user DN (Distinguished Name), which overrides the base DN for user lookups.

Property Value
Parameter group: Body.properties.ldapConfiguration 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 netappfiles account ldap-configuration delete

Delete LDAP configuration.

az netappfiles account ldap-configuration delete --account-name
                                                 --resource-group
                                                 [--acquire-policy-token]
                                                 [--change-reference]
                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--yes]

Examples

Accounts_CreateOrUpdate

az netappfiles account ldap-configuration delete --resource-group myRG --account-name account1

Required Parameters

--account-name

The name of the NetApp account.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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 netappfiles account ldap-configuration show

Show LDAP configuration.

az netappfiles account ldap-configuration show --account-name
                                               --resource-group

Examples

Accounts_Get

az netappfiles account ldap-configuration show --resource-group myRG --account-name account1

Required Parameters

--account-name

The name of the NetApp account.

--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 netappfiles account ldap-configuration update

Update LDAP configuration.

az netappfiles account ldap-configuration update --account-name
                                                 --resource-group
                                                 [--acquire-policy-token]
                                                 [--add]
                                                 [--bind-auth-level --bind-authentication-level {Anonymous, Simple}]
                                                 [--bind-dn]
                                                 [--bind-password-azure-key-vault-uri --bp-akv-uri]
                                                 [--bind-password-secret-name --bp-secret-name]
                                                 [--bind-password-user-assigned-identity --bp-user-assigned-mi]
                                                 [--certificate-cn-host]
                                                 [--change-reference]
                                                 [--dns-servers]
                                                 [--domain]
                                                 [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--group-dn]
                                                 [--ldap-port]
                                                 [--ldap-servers]
                                                 [--net-group-dn]
                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--remove]
                                                 [--secure-ldap-type {LdapOverTLS, None}]
                                                 [--server-ca-certificate]
                                                 [--set]
                                                 [--user-dn]

Examples

Accounts_CreateOrUpdate

az netappfiles account ldap-configuration update --resource-group myRG --account-name account1

Required Parameters

--account-name

The name of the NetApp account.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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
--bind-auth-level --bind-authentication-level

The authentication level to use when binding to the LDAP server, defaults to Anonymous.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
Accepted values: Anonymous, Simple
--bind-dn

The distinguished name (DN) to bind as when performing LDAP operations.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
--bind-password-azure-key-vault-uri --bp-akv-uri

The Azure Key Vault URI where the Bind DN user password is stored.

Property Value
Parameter group: BindPasswordAkvConfig Arguments
--bind-password-secret-name --bp-secret-name

The name of the secret in Azure Key Vault that contains the Bind DN user password.

Property Value
Parameter group: BindPasswordAkvConfig Arguments
--bind-password-user-assigned-identity --bp-user-assigned-mi

The ARM resource identifier of the user assigned identity used to authenticate with key vault.

Property Value
Parameter group: BindPasswordAkvConfig Arguments
--certificate-cn-host

The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--dns-servers

List of DNS server IPv4 addresses for resolving the CN host certificate. This parameter is used when LDAP over TLS is enabled. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
--domain

Name of the LDAP configuration domain.

Property Value
Parameter group: Body.properties.ldapConfiguration 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
--group-dn

This specifies the group DN (Distinguished Name), which overrides the base DN for group lookups.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
--ldap-port

Port number for LDAP communication. Default is 389 for LDAP.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
--ldap-servers

List of LDAP server IP addresses (IPv4 only) for the LDAP domain. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
--net-group-dn

This specifies the netgroup DN (Distinguished Name), which overrides the base DN for netgroup lookups.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
--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
--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
--secure-ldap-type

Indicates the secure LDAP mode for encrypting communication between ANF storage and customer LDAP servers.

Property Value
Parameter group: Body.properties.ldapConfiguration Arguments
Accepted values: LdapOverTLS, None
--server-ca-certificate

When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate. If value is blank it's asked from the tty.

Property Value
Parameter group: Body.properties.ldapConfiguration 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
--user-dn

This specifies the user DN (Distinguished Name), which overrides the base DN for user lookups.

Property Value
Parameter group: Body.properties.ldapConfiguration 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 netappfiles account ldap-configuration wait

Place the CLI in a waiting state until a condition is met.

az netappfiles account ldap-configuration wait [--account-name]
                                               [--acquire-policy-token]
                                               [--change-reference]
                                               [--created]
                                               [--custom]
                                               [--deleted]
                                               [--exists]
                                               [--ids]
                                               [--interval]
                                               [--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.

--account-name

The name of the NetApp account.

Property Value
Parameter group: Resource Id Arguments
--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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
--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