az netappfiles account ad

Manage Azure NetApp Files (ANF) Account active directories.

Commands

az netappfiles account ad add

Add an active directory to the account.

az netappfiles account ad list

List the active directories of an account.

az netappfiles account ad remove

Remove an active directory from the account.

az netappfiles account ad add

Add an active directory to the account.

az netappfiles account ad add --dns
                              --domain
                              --password
                              --smb-server-name
                              --username
                              [--account-name]
                              [--add]
                              [--force-string]
                              [--ids]
                              [--organizational-unit]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--subscription]

Examples

Add an active directory to the account

az netappfiles account ad add -g mygroup --name myname --username aduser --password aduser --smb-server-name SMBSERVER --dns 1.2.3.4 --domain westcentralus

Required Parameters

--dns

Comma separated list of DNS server IP addresses for the Active Directory domain.

--domain

Name of the Active Directory domain.

--password

Plain text password of Active Directory domain administrator.

--smb-server-name

NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes. Must be 10 characters or less.

--username

Username of Active Directory domain administrator.

Optional Parameters

--account-name --name -a -n

The name of the ANF account.

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

--force-string

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

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

--organizational-unit

The Organizational Unit (OU) within the Windows Active Directory.

--remove

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

--resource-group -g

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

--set

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

--subscription

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

az netappfiles account ad list

List the active directories of an account.

az netappfiles account ad list --account-name
                               --resource-group
                               [--query-examples]
                               [--subscription]

Examples

Add an active directory to the account

az netappfiles account ad list -g mygroup --name myname

Required Parameters

--account-name --name -a -n

The name of the ANF account.

--resource-group -g

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

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

az netappfiles account ad remove

Remove an active directory from the account.

az netappfiles account ad remove --active-directory
                                 [--account-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

Examples

Remove an active directory from the account

az netappfiles account ad remove -g mygroup --name myname --active-directory 13641da9-c0e9-4b97-84fc-4f8014a93848

Required Parameters

--active-directory

The id of the active directory.

Optional Parameters

--account-name --name -a -n

The name of the ANF account.

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

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