--- title: "PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}" method: PATCH path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}" tags: ["NetAppAccounts"] --- # PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName} `PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}` Patch the specified NetApp account ## Path parameters - `accountName` string, required ## Parameters - `../../../../../../common-types/resource-management/v6/types.json#/components/parameters/ApiVersionParameter` — unresolved $ref - `../../../../../../common-types/resource-management/v6/types.json#/components/parameters/SubscriptionIdParameter` — unresolved $ref - `../../../../../../common-types/resource-management/v6/types.json#/components/parameters/ResourceGroupNameParameter` — unresolved $ref ## Request body - NetAppAccountPatch — NetApp account patch resource - `identity` ManagedServiceIdentity — unresolved $ref - `tags` object — Resource tags. - `properties` AccountPropertiesPatch — NetApp account patch properties - `activeDirectories` ActiveDirectory[] — Active Directories - `activeDirectoryId` string, nullable — Id of the Active Directory - `username` string — A domain user account with permission to create machine accounts - `password` string, password — Plain text password of Active Directory domain administrator, value is masked in the response - `domain` string — Name of the Active Directory domain - `dns` string — Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain - `status` 'Created' | 'InUse' | 'Deleted' | 'Error' | 'Updating' — Status of the Active Directory - `statusDetails` string — Any details in regards to the Status of the Active Directory - `smbServerName` string — NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes - `organizationalUnit` string — The Organizational Unit (OU) within the Windows Active Directory - `site` string — The Active Directory site the service will limit Domain Controller discovery to - `backupOperators` UserName[] — Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier - `administrators` UserName[] — Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier - `kdcIP` string — kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. - `adName` string — Name of the active directory machine. This optional parameter is used only while creating kerberos volume - `serverRootCACertificate` string, password — When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes. - `aesEncryption` boolean — If enabled, AES encryption will be enabled for SMB communication. - `ldapSigning` boolean — Specifies whether or not the LDAP traffic needs to be signed. - `securityOperators` UserName[] — Domain Users in the Active directory to be given SeSecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier - `ldapOverTLS` boolean — Specifies whether or not the LDAP traffic needs to be secured via TLS. - `allowLocalNfsUsersWithLdap` boolean — If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. - `encryptDCConnections` boolean — If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. - `ldapSearchScope` LdapSearchScopeOpt — LDAP search scope - `userDN` string — This specifies the user DN, which overrides the base DN for user lookups. - `groupDN` string — This specifies the group DN, which overrides the base DN for group lookups. - `groupMembershipFilter` string — This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. - `preferredServersForLdapClient` string — Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. - `encryption` AccountEncryption — Encryption settings - `keySource` 'Microsoft.NetApp' | 'Microsoft.KeyVault' — The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault - `keyVaultProperties` KeyVaultProperties — Properties of key vault. - `keyVaultId` string — UUID v4 used to identify the Azure Key Vault configuration - `keyVaultUri` string, uri, required — The Uri of KeyVault. - `keyName` string, required — The name of KeyVault key. - `keyVaultResourceId` string, arm-id — The resource ID of KeyVault. - `status` 'Created' | 'InUse' | 'Deleted' | 'Error' | 'Updating' — Status of the KeyVault connection. - `identity` EncryptionIdentity — Identity used to authenticate with key vault. - `principalId` string — The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. - `userAssignedIdentity` string — The ARM resource identifier of the user assigned identity used to authenticate with key vault. Applicable if identity.type has 'UserAssigned'. It should match key of identity.userAssignedIdentities. - `federatedClientId` string — ClientId of the multi-tenant Entra ID Application. Used to access cross-tenant keyvaults. - `nfsV4IDDomain` string - `entraIdConfig` EntraIdConfigPatch — Entra ID Patch configuration for the account. - `applicationId` string — ApplicationId of the app created by customer to provide authentication and required API permissions for Microsoft Graph endpoint. - `domain` string — Domain of the Active directory synced to Entra ID for hybrid identities. - `serverNamePrefix` string — Using ServerNamePrefix, FQDN (Fully Qualified Domain Name) will be generated for SMB share, using this FQDN, SMB Share will be mounted on Entra Joined VM. - `entraIdAkvConfig` EntraIdAkvConfigPatch — Entra ID Patch configuration for the account. - `azureKeyVaultUri` string, uri — The Azure Key Vault URI where the Entra ID credentials are stored. - `certificateName` string — The name of the certificate in Azure Key Vault. - `userAssignedIdentity` string, arm-id — The ARM resource identifier of the user assigned identity used to authenticate with key vault. - `ldapConfiguration` LdapConfigurationPatch — LDAP configuration for PATCH operations (no default values) - `domain` string — Name of the LDAP configuration domain - `ldapServers` AzureCoreIpV4Address[] — List of LDAP server IP addresses (IPv4 only) for the LDAP domain. - `ldapOverTLS` boolean — Specifies whether or not the LDAP traffic needs to be secured via TLS. - `serverCACertificate` string, password — When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate. - `certificateCNHost` string, nullable — The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry. ## Response `200` Azure operation completed successfully. - NetAppAccount — unresolved $ref ## Other responses - `202` — The request has been accepted for processing, but processing has not yet completed. - `default` — An unexpected error response. ## Changes - **2026-07-13** (2017-08-15) `58798a3b3384` — 2 info - api tag `NetAppAccounts` added - api tag `NetApp Accounts` removed - **2026-07-13** (2017-08-15) `324253b867c6` — 2 warning - deleted the `path` request parameter `resourceGroupName` - deleted the `path` request parameter `subscriptionId` - **2026-07-13** (2017-08-15) `ee6a473a7d0e` — 1 warning - deleted the `query` request parameter `api-version` - **2026-07-13** (2017-08-15) `2b0b495d0928` — 1 warning - deleted the `query` request parameter `api-version` - **2026-07-13** (2017-08-15) `c5b4a2f7fa14` — 1 breaking - added the new required `query` request parameter `api-version` [Full history](https://skmtc.dev/azure/apis/netapp-microsoft-netapp-netapp/changes/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NetApp/netAppAccounts/:accountName/patch.md) --- [API](https://skmtc.dev/azure/apis/netapp-microsoft-netapp-netapp.md) · [All operations](https://skmtc.dev/azure/apis/netapp-microsoft-netapp-netapp/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/netapp-microsoft-netapp-netapp/revisions/24fd9a8ea6bd/schema)