accounts

Creates, updates, deletes, gets or lists an accounts resource.

Overview

Name	accounts
Type	Resource
Id	azure.netapp.accounts

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
activeDirectories	array	Active Directories.
disableShowmount	boolean	Shows the status of disableShowmount for all volumes under the subscription, null equals false.
encryption	object	Encryption settings.
entraIdConfig	object	Entra ID configuration for the account.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
identity	object	The managed service identities assigned to this resource.
ldapConfiguration	object	LDAP Configuration for the account.
location	string	The geo-location where the resource lives. Required.
multiAdStatus	string	MultiAD Status for the account. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
nfsV4IDDomain	string	Domain for NFSv4 user ID mapping. This property will be set for all NetApp accounts in the subscription and region and only affect non ldap NFSv4 volumes.
provisioningState	string	Azure lifecycle management.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
activeDirectories	array	Active Directories.
disableShowmount	boolean	Shows the status of disableShowmount for all volumes under the subscription, null equals false.
encryption	object	Encryption settings.
entraIdConfig	object	Entra ID configuration for the account.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
identity	object	The managed service identities assigned to this resource.
ldapConfiguration	object	LDAP Configuration for the account.
location	string	The geo-location where the resource lives. Required.
multiAdStatus	string	MultiAD Status for the account. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
nfsV4IDDomain	string	Domain for NFSv4 user ID mapping. This property will be set for all NetApp accounts in the subscription and region and only affect non ldap NFSv4 volumes.
provisioningState	string	Azure lifecycle management.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
activeDirectories	array	Active Directories.
disableShowmount	boolean	Shows the status of disableShowmount for all volumes under the subscription, null equals false.
encryption	object	Encryption settings.
entraIdConfig	object	Entra ID configuration for the account.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
identity	object	The managed service identities assigned to this resource.
ldapConfiguration	object	LDAP Configuration for the account.
location	string	The geo-location where the resource lives. Required.
multiAdStatus	string	MultiAD Status for the account. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
nfsV4IDDomain	string	Domain for NFSv4 user ID mapping. This property will be set for all NetApp accounts in the subscription and region and only affect non ldap NFSv4 volumes.
provisioningState	string	Azure lifecycle management.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, subscription_id		Get the NetApp account.
list	select	resource_group_name, subscription_id		List and describe all NetApp accounts in the resource group.
list_by_subscription	select	subscription_id		List and describe all NetApp accounts in the subscription.
create_or_update	insert	resource_group_name, account_name, subscription_id, location		Create or update the specified NetApp account within the resource group.
update	update	resource_group_name, account_name, subscription_id		Patch the specified NetApp account.
create_or_update	replace	resource_group_name, account_name, subscription_id, location		Create or update the specified NetApp account within the resource group.
delete	delete	resource_group_name, account_name, subscription_id		Delete the specified NetApp account.
get_change_key_vault_information	exec	resource_group_name, account_name, subscription_id		Contains data from encryption.keyVaultProperties as well as information about which private endpoint is used by each encryption sibling set. Response from this endpoint can be modified and used as request body for POST request.
renew_credentials	exec	resource_group_name, account_name, subscription_id		Renew identity credentials that are used to authenticate to key vault, for customer-managed key encryption. If encryption.identity.principalId does not match identity.principalId, running this operation will fix it.
transition_to_cmk	exec	resource_group_name, account_name, subscription_id, virtualNetworkId, privateEndpointId		Transitions all volumes in a VNet to a different encryption key source (Microsoft-managed key or Azure Key Vault). Operation fails if targeted volumes share encryption sibling set with volumes from another account.
change_key_vault	exec	resource_group_name, account_name, subscription_id, keyVaultUri, keyName, keyVaultPrivateEndpoints		Affects existing volumes that are encrypted with Key Vault/Managed HSM, and new volumes. Supports HSM to Key Vault, Key Vault to HSM, HSM to HSM and Key Vault to Key Vault.
refresh_ldap_bind_password	exec	resource_group_name, account_name, subscription_id		Refresh LDAP Bind DN password by fetching the latest password from Azure Key Vault.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_name	string	The name of the NetApp account. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get the NetApp account.

SELECT
id,
name,
activeDirectories,
disableShowmount,
encryption,
entraIdConfig,
etag,
identity,
ldapConfiguration,
location,
multiAdStatus,
nfsV4IDDomain,
provisioningState,
systemData,
tags,
type
FROM azure.netapp.accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List and describe all NetApp accounts in the resource group.

SELECT
id,
name,
activeDirectories,
disableShowmount,
encryption,
entraIdConfig,
etag,
identity,
ldapConfiguration,
location,
multiAdStatus,
nfsV4IDDomain,
provisioningState,
systemData,
tags,
type
FROM azure.netapp.accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List and describe all NetApp accounts in the subscription.

SELECT
id,
name,
activeDirectories,
disableShowmount,
encryption,
entraIdConfig,
etag,
identity,
ldapConfiguration,
location,
multiAdStatus,
nfsV4IDDomain,
provisioningState,
systemData,
tags,
type
FROM azure.netapp.accounts
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update the specified NetApp account within the resource group.

INSERT INTO azure.netapp.accounts (
tags,
location,
properties,
identity,
resource_group_name,
account_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: accounts
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the accounts resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the accounts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the accounts resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      NetApp Account properties.
    value:
      provisioningState: "{{ provisioningState }}"
      activeDirectories:
        - activeDirectoryId: "{{ activeDirectoryId }}"
          username: "{{ username }}"
          password: "{{ password }}"
          domain: "{{ domain }}"
          dns: "{{ dns }}"
          status: "{{ status }}"
          statusDetails: "{{ statusDetails }}"
          smbServerName: "{{ smbServerName }}"
          organizationalUnit: "{{ organizationalUnit }}"
          site: "{{ site }}"
          backupOperators: "{{ backupOperators }}"
          administrators: "{{ administrators }}"
          kdcIP: "{{ kdcIP }}"
          adName: "{{ adName }}"
          serverRootCACertificate: "{{ serverRootCACertificate }}"
          aesEncryption: {{ aesEncryption }}
          ldapSigning: {{ ldapSigning }}
          securityOperators: "{{ securityOperators }}"
          ldapOverTLS: {{ ldapOverTLS }}
          allowLocalNfsUsersWithLdap: {{ allowLocalNfsUsersWithLdap }}
          encryptDCConnections: {{ encryptDCConnections }}
          ldapSearchScope:
            userDN: "{{ userDN }}"
            groupDN: "{{ groupDN }}"
            groupMembershipFilter: "{{ groupMembershipFilter }}"
          preferredServersForLdapClient: "{{ preferredServersForLdapClient }}"
      entraIdConfig:
        applicationId: "{{ applicationId }}"
        domain: "{{ domain }}"
        serverNamePrefix: "{{ serverNamePrefix }}"
        entraIdAkvConfig:
          azureKeyVaultUri: "{{ azureKeyVaultUri }}"
          certificateName: "{{ certificateName }}"
          userAssignedIdentity: "{{ userAssignedIdentity }}"
      encryption:
        keySource: "{{ keySource }}"
        keyVaultProperties:
          keyVaultId: "{{ keyVaultId }}"
          keyVaultUri: "{{ keyVaultUri }}"
          keyName: "{{ keyName }}"
          keyVaultResourceId: "{{ keyVaultResourceId }}"
          status: "{{ status }}"
        identity:
          principalId: "{{ principalId }}"
          userAssignedIdentity: "{{ userAssignedIdentity }}"
          federatedClientId: "{{ federatedClientId }}"
      disableShowmount: {{ disableShowmount }}
      nfsV4IDDomain: "{{ nfsV4IDDomain }}"
      multiAdStatus: "{{ multiAdStatus }}"
      ldapConfiguration:
        domain: "{{ domain }}"
        ldapServers:
          - "{{ ldapServers }}"
        ldapOverTLS: {{ ldapOverTLS }}
        serverCACertificate: "{{ serverCACertificate }}"
        certificateCNHost: "{{ certificateCNHost }}"
        bindAuthenticationLevel: "{{ bindAuthenticationLevel }}"
        bindDN: "{{ bindDN }}"
        bindPasswordAkvConfig:
          azureKeyVaultUri: "{{ azureKeyVaultUri }}"
          secretName: "{{ secretName }}"
          userAssignedIdentity: "{{ userAssignedIdentity }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Patch the specified NetApp account.

UPDATE azure.netapp.accounts
SET 
identity = '{{ identity }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update the specified NetApp account within the resource group.

REPLACE azure.netapp.accounts
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete the specified NetApp account.

DELETE FROM azure.netapp.accounts
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_change_key_vault_information

Contains data from encryption.keyVaultProperties as well as information about which private endpoint is used by each encryption sibling set. Response from this endpoint can be modified and used as request body for POST request.

EXEC azure.netapp.accounts.get_change_key_vault_information 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

renew_credentials

Renew identity credentials that are used to authenticate to key vault, for customer-managed key encryption. If encryption.identity.principalId does not match identity.principalId, running this operation will fix it.

EXEC azure.netapp.accounts.renew_credentials 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

transition_to_cmk

Transitions all volumes in a VNet to a different encryption key source (Microsoft-managed key or Azure Key Vault). Operation fails if targeted volumes share encryption sibling set with volumes from another account.

EXEC azure.netapp.accounts.transition_to_cmk 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"virtualNetworkId": "{{ virtualNetworkId }}", 
"privateEndpointId": "{{ privateEndpointId }}"
}'
;

change_key_vault

Affects existing volumes that are encrypted with Key Vault/Managed HSM, and new volumes. Supports HSM to Key Vault, Key Vault to HSM, HSM to HSM and Key Vault to Key Vault.

EXEC azure.netapp.accounts.change_key_vault 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyVaultUri": "{{ keyVaultUri }}", 
"keyName": "{{ keyName }}", 
"keyVaultResourceId": "{{ keyVaultResourceId }}", 
"keyVaultPrivateEndpoints": "{{ keyVaultPrivateEndpoints }}"
}'
;

refresh_ldap_bind_password

Refresh LDAP Bind DN password by fetching the latest password from Azure Key Vault.

EXEC azure.netapp.accounts.refresh_ldap_bind_password 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;