az netappfiles account

Manage Azure NetApp Files (ANF) Account Resources.

Commands

az netappfiles account create

Create a new Azure NetApp Files (ANF) account. Note that active directory can only be applied to an existing account (using set/update).

az netappfiles account delete

Delete the specified ANF account.

az netappfiles account list

List ANF accounts.

az netappfiles account set

Sets the tags or the active directory details for a specified ANF account. Sets the active directory property to exactly what is provided. If none is provided then the active directory is removed, i.e. provide empty [].

az netappfiles account show

Get the specified ANF account.

az netappfiles account update

Set/modify the tags or the active directory details for a specified ANF account. Active directory settings are appended only - if none are present no change is made otherwise the active directory is replaced with that provided.

az netappfiles account create

Create a new Azure NetApp Files (ANF) account. Note that active directory can only be applied to an existing account (using set/update).

az netappfiles account create --account-name
                              --location
                              --resource-group
                              [--active-directories]
                              [--tags]

Examples

Create an ANF account

az netappfiles account create -g group --account-name name -l location

Required Parameters

--account-name -a -n

The name of the ANF account.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--resource-group -g

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

Optional Parameters

--active-directories

Active Directories.

--tags

A list of space separated tags to apply to the account.

az netappfiles account delete

Delete the specified ANF account.

az netappfiles account delete --account-name
                              --resource-group

Examples

Delete an ANF account

az netappfiles account delete -g group --account-name name

Required Parameters

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

az netappfiles account list

List ANF accounts.

az netappfiles account list --resource-group

Examples

List ANF accounts within a resource group

az netappfiles account list -g group

Required Parameters

--resource-group -g

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

az netappfiles account set

Sets the tags or the active directory details for a specified ANF account. Sets the active directory property to exactly what is provided. If none is provided then the active directory is removed, i.e. provide empty [].

az netappfiles account set --account-name
                           --location
                           --resource-group
                           [--active-directories]
                           [--tags]

Examples

Update the tags and active directory of an ANF account

az netappfiles account set -g group --account-name name --tags 'key[=value] key[=value]' --active-directories '[{"username": "aduser", "password": "aduser", "smbservername": "SMBSERVER", "dns": "1.2.3.4", "domain": "westcentralus"}]' -l westus2

Remove the active directory from the ANF account

az netappfiles account set -g group --account-name name --active-directories '[]' -l westus2

Required Parameters

--account-name -a -n

The name of the ANF account.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--resource-group -g

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

Optional Parameters

--active-directories

An array of active directory (AD) settings in json format. Limitation one AD/subscription. Consists of the fields username (Username of Active Directory domain administrator), password (Plain text password of Active Directory domain administrator), domain (Name of the Active Directory domain), dns (Comma separated list of DNS server IP addresses for the Active Directory domain), 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), organizational_unit (The Organizational Unit (OU) within the Windows Active Directory).

--tags

A list of space separated tags to apply to the account.

az netappfiles account show

Get the specified ANF account.

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

Examples

Get an ANF account

az netappfiles account show -g group --account-name name

Required Parameters

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

az netappfiles account update

Set/modify the tags or the active directory details for a specified ANF account. Active directory settings are appended only - if none are present no change is made otherwise the active directory is replaced with that provided.

az netappfiles account update --account-name
                              --location
                              --resource-group
                              [--active-directories]
                              [--add]
                              [--force-string]
                              [--remove]
                              [--set]
                              [--tags]

Examples

Update the tags and active directory of an ANF account

az netappfiles account update -g group --account-name name --tags 'key[=value] key[=value]' --active-directories '[{"username": "aduser", "password": "aduser", "smbservername": "SMBSERVER", "dns": "1.2.3.4", "domain": "westcentralus"}]' -l westus2

Required Parameters

--account-name -a -n

The name of the ANF account.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--resource-group -g

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

Optional Parameters

--active-directories

An array of active directory (AD) settings in json format. Limitation one AD/subscription. Consists of the fields username (Username of Active Directory domain administrator), password (Plain text password of Active Directory domain administrator), domain (Name of the Active Directory domain), dns (Comma separated list of DNS server IP addresses for the Active Directory domain), 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), organizational_unit (The Organizational Unit (OU) within the Windows Active Directory).

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

--remove

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

--set

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

--tags

A list of space separated tags to apply to the account.