Microsoft.NetApp (preview:2024-09-01)

2025/01/30 • 101 new methods

Operations_List (new)
Description Lists all of the available Microsoft.NetApp Rest API operations
Reference Link ¶

⚼ Request

GET:  /providers/Microsoft.NetApp/operations
{
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
name: string ,
display:
{
provider: string ,
resource: string ,
operation: string ,
description: string ,
}
,
origin: string ,
properties:
{
serviceSpecification:
{
metricSpecifications:
[
{
name: string ,
displayName: string ,
displayDescription: string ,
unit: string ,
supportedAggregationTypes:
[
string ,
]
,
supportedTimeGrainTypes:
[
string ,
]
,
internalMetricName: string ,
enableRegionalMdmAccount: boolean ,
sourceMdmAccount: string ,
sourceMdmNamespace: string ,
dimensions:
[
{
name: string ,
displayName: string ,
}
,
]
,
aggregationType: string ,
fillGapWithZero: boolean ,
category: string ,
resourceIdDimensionNameOverride: string ,
isInternal: boolean ,
}
,
]
,
logSpecifications:
[
{
name: string ,
displayName: string ,
}
,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
NetAppResource_CheckNameAvailability (new)
Description Check if a resource name is available.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkNameAvailability
{
body:
{
name: string ,
type: enum ,
resourceGroup: string ,
}
,
subscriptionId: string ,
location: string ,
api-version: string ,
}

⚐ Response (200)

{
isAvailable: boolean ,
reason: enum ,
message: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
NetAppResource_CheckFilePathAvailability (new)
Description Check if a file path is available.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkFilePathAvailability
{
body:
{
name: string ,
subnetId: string ,
availabilityZone: string ,
}
,
subscriptionId: string ,
location: string ,
api-version: string ,
}

⚐ Response (200)

{
isAvailable: boolean ,
reason: enum ,
message: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
NetAppResource_CheckQuotaAvailability (new)
Description Check if a quota is available.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkQuotaAvailability
{
body:
{
name: string ,
type: enum ,
resourceGroup: string ,
}
,
subscriptionId: string ,
location: string ,
api-version: string ,
}

⚐ Response (200)

{
isAvailable: boolean ,
reason: enum ,
message: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
NetAppResourceQuotaLimits_List (new)
Description Get the default and current limits for quotas
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits
{
subscriptionId: string ,
location: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
current: integer ,
default: integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
NetAppResourceQuotaLimits_Get (new)
Description Get the default and current subscription quota limit
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits/{quotaLimitName}
{
subscriptionId: string ,
location: string ,
quotaLimitName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
current: integer ,
default: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
NetAppResource_QueryRegionInfo (new)
Description Provides storage to network proximity and logical zone mapping information.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfo
{
subscriptionId: string ,
location: string ,
api-version: string ,
}

⚐ Response (200)

{
storageToNetworkProximity: enum ,
availabilityZoneMappings:
[
{
availabilityZone: string ,
isAvailable: boolean ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
NetAppResourceRegionInfos_List (new)
Description Provides region specific information.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos
{
subscriptionId: string ,
location: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
storageToNetworkProximity: enum ,
availabilityZoneMappings:
[
{
availabilityZone: string ,
isAvailable: boolean ,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
NetAppResourceRegionInfos_Get (new)
Description Provides storage to network proximity and logical zone mapping information.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos/default
{
subscriptionId: string ,
location: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
storageToNetworkProximity: enum ,
availabilityZoneMappings:
[
{
availabilityZone: string ,
isAvailable: boolean ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
NetAppResource_QueryNetworkSiblingSet (new)
Description Get details of the specified network sibling set.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/queryNetworkSiblingSet
{
body:
{
networkSiblingSetId: string ,
subnetId: string ,
}
,
subscriptionId: string ,
location: string ,
api-version: string ,
}

⚐ Response (200)

{
networkSiblingSetId: string ,
subnetId: string ,
networkSiblingSetStateId: string ,
networkFeatures: enum ,
provisioningState: enum ,
nicInfoList:
[
{
ipAddress: string ,
volumeResourceIds:
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
NetAppResource_UpdateNetworkSiblingSet (new)
Description Update the network features of the specified network sibling set.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/updateNetworkSiblingSet
{
body:
{
networkSiblingSetId: string ,
subnetId: string ,
networkSiblingSetStateId: string ,
networkFeatures: enum ,
}
,
subscriptionId: string ,
location: string ,
api-version: string ,
}

⚐ Response (200)

{
networkSiblingSetId: string ,
subnetId: string ,
networkSiblingSetStateId: string ,
networkFeatures: enum ,
provisioningState: enum ,
nicInfoList:
[
{
ipAddress: string ,
volumeResourceIds:
[
string ,
]
,
}
,
]
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Accounts_ListBySubscription (new)
Description List and describe all NetApp accounts in the subscription.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/netAppAccounts
{
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
etag: string ,
properties:
{
provisioningState: string ,
activeDirectories:
[
{
activeDirectoryId: string ,
username: string ,
password: string ,
domain: string ,
dns: string ,
status: enum ,
statusDetails: string ,
smbServerName: string ,
organizationalUnit: string ,
site: string ,
backupOperators:
[
string ,
]
,
administrators:
[
string ,
]
,
kdcIP: string ,
adName: string ,
serverRootCACertificate: string ,
aesEncryption: boolean ,
ldapSigning: boolean ,
securityOperators:
[
string ,
]
,
ldapOverTLS: boolean ,
allowLocalNfsUsersWithLdap: boolean ,
encryptDCConnections: boolean ,
ldapSearchScope:
{
userDN: string ,
groupDN: string ,
groupMembershipFilter: string ,
}
,
preferredServersForLdapClient: string ,
}
,
]
,
encryption:
{
keySource: enum ,
keyVaultProperties:
{
keyVaultId: string ,
keyVaultUri: string ,
keyName: string ,
keyVaultResourceId: string ,
status: enum ,
}
,
identity:
{
principalId: string ,
userAssignedIdentity: string ,
federatedClientId: string ,
}
,
}
,
disableShowmount: boolean ,
nfsV4IDDomain: string ,
isMultiAdEnabled: boolean ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Accounts_List (new)
Description List and describe all NetApp accounts in the resource group.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
etag: string ,
properties:
{
provisioningState: string ,
activeDirectories:
[
{
activeDirectoryId: string ,
username: string ,
password: string ,
domain: string ,
dns: string ,
status: enum ,
statusDetails: string ,
smbServerName: string ,
organizationalUnit: string ,
site: string ,
backupOperators:
[
string ,
]
,
administrators:
[
string ,
]
,
kdcIP: string ,
adName: string ,
serverRootCACertificate: string ,
aesEncryption: boolean ,
ldapSigning: boolean ,
securityOperators:
[
string ,
]
,
ldapOverTLS: boolean ,
allowLocalNfsUsersWithLdap: boolean ,
encryptDCConnections: boolean ,
ldapSearchScope:
{
userDN: string ,
groupDN: string ,
groupMembershipFilter: string ,
}
,
preferredServersForLdapClient: string ,
}
,
]
,
encryption:
{
keySource: enum ,
keyVaultProperties:
{
keyVaultId: string ,
keyVaultUri: string ,
keyName: string ,
keyVaultResourceId: string ,
status: enum ,
}
,
identity:
{
principalId: string ,
userAssignedIdentity: string ,
federatedClientId: string ,
}
,
}
,
disableShowmount: boolean ,
nfsV4IDDomain: string ,
isMultiAdEnabled: boolean ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Accounts_Get (new)
Description Get the NetApp account
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
etag: string ,
properties:
{
provisioningState: string ,
activeDirectories:
[
{
activeDirectoryId: string ,
username: string ,
password: string ,
domain: string ,
dns: string ,
status: enum ,
statusDetails: string ,
smbServerName: string ,
organizationalUnit: string ,
site: string ,
backupOperators:
[
string ,
]
,
administrators:
[
string ,
]
,
kdcIP: string ,
adName: string ,
serverRootCACertificate: string ,
aesEncryption: boolean ,
ldapSigning: boolean ,
securityOperators:
[
string ,
]
,
ldapOverTLS: boolean ,
allowLocalNfsUsersWithLdap: boolean ,
encryptDCConnections: boolean ,
ldapSearchScope:
{
userDN: string ,
groupDN: string ,
groupMembershipFilter: string ,
}
,
preferredServersForLdapClient: string ,
}
,
]
,
encryption:
{
keySource: enum ,
keyVaultProperties:
{
keyVaultId: string ,
keyVaultUri: string ,
keyName: string ,
keyVaultResourceId: string ,
status: enum ,
}
,
identity:
{
principalId: string ,
userAssignedIdentity: string ,
federatedClientId: string ,
}
,
}
,
disableShowmount: boolean ,
nfsV4IDDomain: string ,
isMultiAdEnabled: boolean ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Accounts_CreateOrUpdate (new)
Description Create or update the specified NetApp account within the resource group
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{
body:
{
etag: string ,
properties:
{
provisioningState: string ,
activeDirectories:
[
{
activeDirectoryId: string ,
username: string ,
password: string ,
domain: string ,
dns: string ,
status: enum ,
statusDetails: string ,
smbServerName: string ,
organizationalUnit: string ,
site: string ,
backupOperators:
[
string ,
]
,
administrators:
[
string ,
]
,
kdcIP: string ,
adName: string ,
serverRootCACertificate: string ,
aesEncryption: boolean ,
ldapSigning: boolean ,
securityOperators:
[
string ,
]
,
ldapOverTLS: boolean ,
allowLocalNfsUsersWithLdap: boolean ,
encryptDCConnections: boolean ,
ldapSearchScope:
{
userDN: string ,
groupDN: string ,
groupMembershipFilter: string ,
}
,
preferredServersForLdapClient: string ,
}
,
]
,
encryption:
{
keySource: enum ,
keyVaultProperties:
{
keyVaultId: string ,
keyVaultUri: string ,
keyName: string ,
keyVaultResourceId: string ,
status: enum ,
}
,
identity:
{
principalId: string ,
userAssignedIdentity: string ,
federatedClientId: string ,
}
,
}
,
disableShowmount: boolean ,
nfsV4IDDomain: string ,
isMultiAdEnabled: boolean ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
etag: string ,
properties:
{
provisioningState: string ,
activeDirectories:
[
{
activeDirectoryId: string ,
username: string ,
password: string ,
domain: string ,
dns: string ,
status: enum ,
statusDetails: string ,
smbServerName: string ,
organizationalUnit: string ,
site: string ,
backupOperators:
[
string ,
]
,
administrators:
[
string ,
]
,
kdcIP: string ,
adName: string ,
serverRootCACertificate: string ,
aesEncryption: boolean ,
ldapSigning: boolean ,
securityOperators:
[
string ,
]
,
ldapOverTLS: boolean ,
allowLocalNfsUsersWithLdap: boolean ,
encryptDCConnections: boolean ,
ldapSearchScope:
{
userDN: string ,
groupDN: string ,
groupMembershipFilter: string ,
}
,
preferredServersForLdapClient: string ,
}
,
]
,
encryption:
{
keySource: enum ,
keyVaultProperties:
{
keyVaultId: string ,
keyVaultUri: string ,
keyName: string ,
keyVaultResourceId: string ,
status: enum ,
}
,
identity:
{
principalId: string ,
userAssignedIdentity: string ,
federatedClientId: string ,
}
,
}
,
disableShowmount: boolean ,
nfsV4IDDomain: string ,
isMultiAdEnabled: boolean ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}

⚐ Response (201)

{
etag: string ,
properties:
{
provisioningState: string ,
activeDirectories:
[
{
activeDirectoryId: string ,
username: string ,
password: string ,
domain: string ,
dns: string ,
status: enum ,
statusDetails: string ,
smbServerName: string ,
organizationalUnit: string ,
site: string ,
backupOperators:
[
string ,
]
,
administrators:
[
string ,
]
,
kdcIP: string ,
adName: string ,
serverRootCACertificate: string ,
aesEncryption: boolean ,
ldapSigning: boolean ,
securityOperators:
[
string ,
]
,
ldapOverTLS: boolean ,
allowLocalNfsUsersWithLdap: boolean ,
encryptDCConnections: boolean ,
ldapSearchScope:
{
userDN: string ,
groupDN: string ,
groupMembershipFilter: string ,
}
,
preferredServersForLdapClient: string ,
}
,
]
,
encryption:
{
keySource: enum ,
keyVaultProperties:
{
keyVaultId: string ,
keyVaultUri: string ,
keyName: string ,
keyVaultResourceId: string ,
status: enum ,
}
,
identity:
{
principalId: string ,
userAssignedIdentity: string ,
federatedClientId: string ,
}
,
}
,
disableShowmount: boolean ,
nfsV4IDDomain: string ,
isMultiAdEnabled: boolean ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Accounts_Delete (new)
Description Delete the specified NetApp account
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Accounts_Update (new)
Description Patch the specified NetApp account
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{
body:
{
location: string ,
id: string ,
name: string ,
type: string ,
tags: object ,
properties:
{
provisioningState: string ,
activeDirectories:
[
{
activeDirectoryId: string ,
username: string ,
password: string ,
domain: string ,
dns: string ,
status: enum ,
statusDetails: string ,
smbServerName: string ,
organizationalUnit: string ,
site: string ,
backupOperators:
[
string ,
]
,
administrators:
[
string ,
]
,
kdcIP: string ,
adName: string ,
serverRootCACertificate: string ,
aesEncryption: boolean ,
ldapSigning: boolean ,
securityOperators:
[
string ,
]
,
ldapOverTLS: boolean ,
allowLocalNfsUsersWithLdap: boolean ,
encryptDCConnections: boolean ,
ldapSearchScope:
{
userDN: string ,
groupDN: string ,
groupMembershipFilter: string ,
}
,
preferredServersForLdapClient: string ,
}
,
]
,
encryption:
{
keySource: enum ,
keyVaultProperties:
{
keyVaultId: string ,
keyVaultUri: string ,
keyName: string ,
keyVaultResourceId: string ,
status: enum ,
}
,
identity:
{
principalId: string ,
userAssignedIdentity: string ,
federatedClientId: string ,
}
,
}
,
disableShowmount: boolean ,
nfsV4IDDomain: string ,
isMultiAdEnabled: boolean ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
etag: string ,
properties:
{
provisioningState: string ,
activeDirectories:
[
{
activeDirectoryId: string ,
username: string ,
password: string ,
domain: string ,
dns: string ,
status: enum ,
statusDetails: string ,
smbServerName: string ,
organizationalUnit: string ,
site: string ,
backupOperators:
[
string ,
]
,
administrators:
[
string ,
]
,
kdcIP: string ,
adName: string ,
serverRootCACertificate: string ,
aesEncryption: boolean ,
ldapSigning: boolean ,
securityOperators:
[
string ,
]
,
ldapOverTLS: boolean ,
allowLocalNfsUsersWithLdap: boolean ,
encryptDCConnections: boolean ,
ldapSearchScope:
{
userDN: string ,
groupDN: string ,
groupMembershipFilter: string ,
}
,
preferredServersForLdapClient: string ,
}
,
]
,
encryption:
{
keySource: enum ,
keyVaultProperties:
{
keyVaultId: string ,
keyVaultUri: string ,
keyName: string ,
keyVaultResourceId: string ,
status: enum ,
}
,
identity:
{
principalId: string ,
userAssignedIdentity: string ,
federatedClientId: string ,
}
,
}
,
disableShowmount: boolean ,
nfsV4IDDomain: string ,
isMultiAdEnabled: boolean ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}

⚐ Response (202)

{
etag: string ,
properties:
{
provisioningState: string ,
activeDirectories:
[
{
activeDirectoryId: string ,
username: string ,
password: string ,
domain: string ,
dns: string ,
status: enum ,
statusDetails: string ,
smbServerName: string ,
organizationalUnit: string ,
site: string ,
backupOperators:
[
string ,
]
,
administrators:
[
string ,
]
,
kdcIP: string ,
adName: string ,
serverRootCACertificate: string ,
aesEncryption: boolean ,
ldapSigning: boolean ,
securityOperators:
[
string ,
]
,
ldapOverTLS: boolean ,
allowLocalNfsUsersWithLdap: boolean ,
encryptDCConnections: boolean ,
ldapSearchScope:
{
userDN: string ,
groupDN: string ,
groupMembershipFilter: string ,
}
,
preferredServersForLdapClient: string ,
}
,
]
,
encryption:
{
keySource: enum ,
keyVaultProperties:
{
keyVaultId: string ,
keyVaultUri: string ,
keyName: string ,
keyVaultResourceId: string ,
status: enum ,
}
,
identity:
{
principalId: string ,
userAssignedIdentity: string ,
federatedClientId: string ,
}
,
}
,
disableShowmount: boolean ,
nfsV4IDDomain: string ,
isMultiAdEnabled: boolean ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Accounts_RenewCredentials (new)
Description 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.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/renewCredentials
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Accounts_TransitionToCmk (new)
Description 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.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/transitiontocmk
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
body:
{
virtualNetworkId: string ,
privateEndpointId: string ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Accounts_GetKeyVaultStatus (new)
Description 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.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/getKeyVaultStatus
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Accounts_ChangeKeyVault (new)
Description 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.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/changeKeyVault
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
body:
{
keyVaultUri: string ,
keyName: string ,
keyVaultResourceId: string ,
keyVaultPrivateEndpoints:
[
{
virtualNetworkId: string ,
privateEndpointId: string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Pools_List (new)
Description List all capacity pools in the NetApp Account
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
etag: string ,
properties:
{
poolId: string ,
size: integer ,
serviceLevel: enum ,
provisioningState: string ,
totalThroughputMibps: number ,
utilizedThroughputMibps: number ,
customThroughputMibps: number ,
qosType: enum ,
coolAccess: boolean ,
encryptionType: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Pools_Get (new)
Description Get details of the specified capacity pool
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
poolName: string ,
api-version: string ,
}

⚐ Response (200)

{
etag: string ,
properties:
{
poolId: string ,
size: integer ,
serviceLevel: enum ,
provisioningState: string ,
totalThroughputMibps: number ,
utilizedThroughputMibps: number ,
customThroughputMibps: number ,
qosType: enum ,
coolAccess: boolean ,
encryptionType: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Pools_CreateOrUpdate (new)
Description Create or Update a capacity pool
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}
{
body:
{
etag: string ,
properties:
{
poolId: string ,
size: integer ,
serviceLevel: enum ,
provisioningState: string ,
totalThroughputMibps: number ,
utilizedThroughputMibps: number ,
customThroughputMibps: number ,
qosType: enum ,
coolAccess: boolean ,
encryptionType: enum ,
}
,
}
,
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
poolName: string ,
api-version: string ,
}

⚐ Response (200)

{
etag: string ,
properties:
{
poolId: string ,
size: integer ,
serviceLevel: enum ,
provisioningState: string ,
totalThroughputMibps: number ,
utilizedThroughputMibps: number ,
customThroughputMibps: number ,
qosType: enum ,
coolAccess: boolean ,
encryptionType: enum ,
}
,
}

⚐ Response (201)

{
etag: string ,
properties:
{
poolId: string ,
size: integer ,
serviceLevel: enum ,
provisioningState: string ,
totalThroughputMibps: number ,
utilizedThroughputMibps: number ,
customThroughputMibps: number ,
qosType: enum ,
coolAccess: boolean ,
encryptionType: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Pools_Update (new)
Description Patch the specified capacity pool
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}
{
body:
{
location: string ,
id: string ,
name: string ,
type: string ,
tags: object ,
properties:
{
size: integer ,
qosType: enum ,
coolAccess: boolean ,
customThroughputMibps: number ,
}
,
}
,
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
poolName: string ,
api-version: string ,
}

⚐ Response (200)

{
etag: string ,
properties:
{
poolId: string ,
size: integer ,
serviceLevel: enum ,
provisioningState: string ,
totalThroughputMibps: number ,
utilizedThroughputMibps: number ,
customThroughputMibps: number ,
qosType: enum ,
coolAccess: boolean ,
encryptionType: enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Pools_Delete (new)
Description Delete the specified capacity pool
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
poolName: string ,
api-version: string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Volumes_List (new)
Description List all volumes within the capacity pool
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes
{
subscriptionId: string ,
resourceGroupName: string ,
accountName: string ,
poolName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
etag: string ,
zones:
[
string ,
]
,
properties:
{
fileSystemId: string ,
creationToken: string ,
serviceLevel: enum ,
usageThreshold: integer ,
exportPolicy:
{
rules:
[
{
ruleIndex: integer ,
unixReadOnly: boolean ,
unixReadWrite: boolean ,
kerberos5ReadOnly: boolean ,
kerberos5ReadWrite: boolean ,
kerberos5iReadOnly: