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:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Storage operations supported by the Storage resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: Display metadata associated with the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft NetApp. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed etc. ,
Required: False ,
}
string ,
operation:
{
Description: Type of operation: get, read, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Operation description. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The origin of operations. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of operation, include metric specifications. ,
Required: False ,
}
{
serviceSpecification:
{
Description: One property of operation, include metric specifications. ,
Required: False ,
}
{
metricSpecifications:
{
Description: Metric specifications of operation. ,
Required: False ,
}
[
{
name:
{
Description: Name of metric specification. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of metric specification. ,
Required: False ,
}
string ,
displayDescription:
{
Description: Display description of metric specification. ,
Required: False ,
}
string ,
unit:
{
Description: Unit could be Bytes or Count. ,
Required: False ,
}
string ,
supportedAggregationTypes:
{
Description: Support metric aggregation type. ,
Required: False ,
}
[
string ,
]
,
supportedTimeGrainTypes:
{
Description: The supported time grain types for the metrics. ,
Required: False ,
}
[
string ,
]
,
internalMetricName:
{
Description: The internal metric name. ,
Required: False ,
}
string ,
enableRegionalMdmAccount:
{
Description: Whether or not the service is using regional MDM accounts. ,
Required: False ,
}
boolean ,
sourceMdmAccount:
{
Description: The source MDM account. ,
Required: False ,
}
string ,
sourceMdmNamespace:
{
Description: The source MDM namespace. ,
Required: False ,
}
string ,
dimensions:
{
Description: Dimensions of blobs, including blob type and access tier. ,
Required: False ,
}
[
{
name:
{
Description: Display name of dimension. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of dimension. ,
Required: False ,
}
string ,
}
,
]
,
aggregationType:
{
Description: Aggregation type could be Average. ,
Required: False ,
}
string ,
fillGapWithZero:
{
Description: The property to decide fill gap with zero or not. ,
Required: False ,
}
boolean ,
category:
{
Description: The category this metric specification belong to, could be Capacity. ,
Required: False ,
}
string ,
resourceIdDimensionNameOverride:
{
Description: Account Resource Id. ,
Required: False ,
}
string ,
isInternal:
{
Description: Whether the metric is internal. ,
Required: False ,
}
boolean ,
}
,
]
,
logSpecifications:
{
Description: Log specification of operation. ,
Required: False ,
}
[
{
name:
{
Description: Name of log specification. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of log specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: Name availability request. ,
Required: True ,
}
{
name:
{
Description: Resource name to verify. ,
Required: True ,
}
string ,
type:
{
Description: Resource type used for verification. ,
Enum:
{
Microsoft.NetApp/netAppAccounts: No description available. ,
Microsoft.NetApp/netAppAccounts/capacityPools: No description available. ,
Microsoft.NetApp/netAppAccounts/capacityPools/volumes: No description available. ,
Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroup:
{
Description: Resource group name. ,
Required: True ,
}
string ,
}
,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
isAvailable:
{
Description: true indicates name is valid and available. false indicates the name is invalid, unavailable, or both. ,
Required: False ,
}
boolean ,
reason:
{
Description: Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: File path availability request. ,
Required: True ,
}
{
name:
{
Description: File path to verify. ,
Required: True ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
availabilityZone:
{
Description: The Azure Resource logical availability zone which is used within zone mapping lookup for the subscription and region. The lookup will retrieve the physical zone where volume is placed. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
isAvailable:
{
Description: true indicates name is valid and available. false indicates the name is invalid, unavailable, or both. ,
Required: False ,
}
boolean ,
reason:
{
Description: Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkQuotaAvailability
{
body:
{
Description: Quota availability request. ,
Required: True ,
}
{
name:
{
Description: Name of the resource to verify. ,
Required: True ,
}
string ,
type:
{
Description: Resource type used for verification. ,
Enum:
{
Microsoft.NetApp/netAppAccounts: No description available. ,
Microsoft.NetApp/netAppAccounts/capacityPools: No description available. ,
Microsoft.NetApp/netAppAccounts/capacityPools/volumes: No description available. ,
Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroup:
{
Description: Resource group name. ,
Required: True ,
}
string ,
}
,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
isAvailable:
{
Description: true indicates name is valid and available. false indicates the name is invalid, unavailable, or both. ,
Required: False ,
}
boolean ,
reason:
{
Description: Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of SubscriptionQuotaItems ,
Required: False ,
}
[
{
properties:
{
Description: SubscriptionQuotaItem properties ,
Required: False ,
}
{
current:
{
Description: The current quota value. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: The default quota value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
quotaLimitName:
{
Description: The name of the Quota Limit ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SubscriptionQuotaItem properties ,
Required: False ,
}
{
current:
{
Description: The current quota value. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: The default quota value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
storageToNetworkProximity:
{
Description: Provides storage to network proximity information in the region. ,
Enum:
{
Default: Basic network connectivity. ,
T1: Standard T1 network connectivity. ,
T2: Standard T2 network connectivity. ,
AcrossT2: Standard AcrossT2 network connectivity. ,
T1AndT2: Standard T1 and T2 network connectivity. ,
T1AndAcrossT2: Standard T1 and AcrossT2 network connectivity. ,
T2AndAcrossT2: Standard T2 and AcrossT2 network connectivity. ,
T1AndT2AndAcrossT2: Standard T1, T2 and AcrossT2 network connectivity. ,
}
,
Required: False ,
}
enum ,
availabilityZoneMappings:
{
Description: Provides logical availability zone mappings for the subscription for a region. ,
Required: False ,
}
[
{
availabilityZone:
{
Description: Logical availability zone. ,
Required: False ,
}
string ,
isAvailable:
{
Description: Available availability zone ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of regionInfo resources ,
Required: False ,
}
[
{
properties:
{
Description: regionInfo properties ,
Required: False ,
}
{
storageToNetworkProximity:
{
Description: Provides storage to network proximity information in the region. ,
Enum:
{
Default: Basic network connectivity. ,
T1: Standard T1 network connectivity. ,
T2: Standard T2 network connectivity. ,
AcrossT2: Standard AcrossT2 network connectivity. ,
T1AndT2: Standard T1 and T2 network connectivity. ,
T1AndAcrossT2: Standard T1 and AcrossT2 network connectivity. ,
T2AndAcrossT2: Standard T2 and AcrossT2 network connectivity. ,
T1AndT2AndAcrossT2: Standard T1, T2 and AcrossT2 network connectivity. ,
}
,
Required: False ,
}
enum ,
availabilityZoneMappings:
{
Description: Provides logical availability zone mappings for the subscription for a region. ,
Required: False ,
}
[
{
availabilityZone:
{
Description: Logical availability zone. ,
Required: False ,
}
string ,
isAvailable:
{
Description: Available availability zone ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: regionInfo properties ,
Required: False ,
}
{
storageToNetworkProximity:
{
Description: Provides storage to network proximity information in the region. ,
Enum:
{
Default: Basic network connectivity. ,
T1: Standard T1 network connectivity. ,
T2: Standard T2 network connectivity. ,
AcrossT2: Standard AcrossT2 network connectivity. ,
T1AndT2: Standard T1 and T2 network connectivity. ,
T1AndAcrossT2: Standard T1 and AcrossT2 network connectivity. ,
T2AndAcrossT2: Standard T2 and AcrossT2 network connectivity. ,
T1AndT2AndAcrossT2: Standard T1, T2 and AcrossT2 network connectivity. ,
}
,
Required: False ,
}
enum ,
availabilityZoneMappings:
{
Description: Provides logical availability zone mappings for the subscription for a region. ,
Required: False ,
}
[
{
availabilityZone:
{
Description: Logical availability zone. ,
Required: False ,
}
string ,
isAvailable:
{
Description: Available availability zone ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: Network sibling set to query. ,
Required: True ,
}
{
networkSiblingSetId:
{
Description: Network Sibling Set ID for a group of volumes sharing networking resources in a subnet. ,
Required: True ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes. Example /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/{mySubnet} ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
networkSiblingSetId:
{
Description: Network Sibling Set ID for a group of volumes sharing networking resources in a subnet. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes. Example /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/{mySubnet} ,
Format: arm-id ,
Required: False ,
}
string ,
networkSiblingSetStateId:
{
Description: Network sibling set state Id identifying the current state of the sibling set. ,
Required: False ,
}
string ,
networkFeatures:
{
Description: Network features available to the volume, or current state of update. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Gets the status of the NetworkSiblingSet at the time the operation was called. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
nicInfoList:
{
Description: List of NIC information ,
Required: False ,
}
[
{
ipAddress:
{
Required: False ,
}
string ,
volumeResourceIds:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: Update for the specified network sibling set. ,
Required: True ,
}
{
networkSiblingSetId:
{
Description: Network Sibling Set ID for a group of volumes sharing networking resources in a subnet. ,
Required: True ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes. Example /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/{mySubnet} ,
Format: arm-id ,
Required: True ,
}
string ,
networkSiblingSetStateId:
{
Description: Network sibling set state Id identifying the current state of the sibling set. ,
Required: True ,
}
string ,
networkFeatures:
{
Description: Network features available to the volume. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: True ,
}
enum ,
}
,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
networkSiblingSetId:
{
Description: Network Sibling Set ID for a group of volumes sharing networking resources in a subnet. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes. Example /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/{mySubnet} ,
Format: arm-id ,
Required: False ,
}
string ,
networkSiblingSetStateId:
{
Description: Network sibling set state Id identifying the current state of the sibling set. ,
Required: False ,
}
string ,
networkFeatures:
{
Description: Network features available to the volume, or current state of update. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Gets the status of the NetworkSiblingSet at the time the operation was called. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
nicInfoList:
{
Description: List of NIC information ,
Required: False ,
}
[
{
ipAddress:
{
Required: False ,
}
string ,
volumeResourceIds:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Multiple NetApp accounts ,
Required: False ,
}
[
{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator, value is masked in the response ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dns:
{
Description: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of the Active Directory ,
Enum:
{
Created: Active Directory created but not in use ,
Updating: Active Directory Updating ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Any details in regards to the Status of the Active Directory ,
Required: False ,
}
string ,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
kdcIP:
{
Description: kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. ,
Required: False ,
}
string ,
adName:
{
Description: Name of the active directory machine. This optional parameter is used only while creating kerberos volume ,
Required: False ,
}
string ,
serverRootCACertificate:
{
Description: 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. ,
Required: False ,
}
string ,
aesEncryption:
{
Description: If enabled, AES encryption will be enabled for SMB communication. ,
Required: False ,
}
boolean ,
ldapSigning:
{
Description: Specifies whether or not the LDAP traffic needs to be signed. ,
Required: False ,
}
boolean ,
securityOperators:
{
Description: 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 ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
allowLocalNfsUsersWithLdap:
{
Description: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. ,
Required: False ,
}
boolean ,
encryptDCConnections:
{
Description: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. ,
Required: False ,
}
boolean ,
ldapSearchScope:
{
Description: LDAP Search scope options ,
Required: False ,
}
{
userDN:
{
Description: This specifies the user DN, which overrides the base DN for user lookups. ,
Required: False ,
}
string ,
groupDN:
{
Description: This specifies the group DN, which overrides the base DN for group lookups. ,
Required: False ,
}
string ,
groupMembershipFilter:
{
Description: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. ,
Required: False ,
}
string ,
}
,
preferredServersForLdapClient:
{
Description: Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. ,
Required: False ,
}
string ,
}
,
]
,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyVaultId:
{
Description: UUID v4 used to identify the Azure Key Vault configuration ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVaultResourceId:
{
Description: The resource ID of KeyVault. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Status of the KeyVault connection. ,
Enum:
{
Created: KeyVault connection created but not in use ,
Updating: KeyVault connection Updating ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: 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. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults. ,
Required: False ,
}
string ,
}
,
}
,
disableShowmount:
{
Description: Shows the status of disableShowmount for all volumes under the subscription, null equals false ,
Required: False ,
}
boolean ,
nfsV4IDDomain:
{
Description: 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. ,
Required: False ,
}
string ,
isMultiAdEnabled:
{
Description: This will have true value only if account is Multiple AD enabled. ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: The identity used for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Multiple NetApp accounts ,
Required: False ,
}
[
{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator, value is masked in the response ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dns:
{
Description: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of the Active Directory ,
Enum:
{
Created: Active Directory created but not in use ,
Updating: Active Directory Updating ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Any details in regards to the Status of the Active Directory ,
Required: False ,
}
string ,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
kdcIP:
{
Description: kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. ,
Required: False ,
}
string ,
adName:
{
Description: Name of the active directory machine. This optional parameter is used only while creating kerberos volume ,
Required: False ,
}
string ,
serverRootCACertificate:
{
Description: 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. ,
Required: False ,
}
string ,
aesEncryption:
{
Description: If enabled, AES encryption will be enabled for SMB communication. ,
Required: False ,
}
boolean ,
ldapSigning:
{
Description: Specifies whether or not the LDAP traffic needs to be signed. ,
Required: False ,
}
boolean ,
securityOperators:
{
Description: 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 ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
allowLocalNfsUsersWithLdap:
{
Description: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. ,
Required: False ,
}
boolean ,
encryptDCConnections:
{
Description: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. ,
Required: False ,
}
boolean ,
ldapSearchScope:
{
Description: LDAP Search scope options ,
Required: False ,
}
{
userDN:
{
Description: This specifies the user DN, which overrides the base DN for user lookups. ,
Required: False ,
}
string ,
groupDN:
{
Description: This specifies the group DN, which overrides the base DN for group lookups. ,
Required: False ,
}
string ,
groupMembershipFilter:
{
Description: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. ,
Required: False ,
}
string ,
}
,
preferredServersForLdapClient:
{
Description: Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. ,
Required: False ,
}
string ,
}
,
]
,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyVaultId:
{
Description: UUID v4 used to identify the Azure Key Vault configuration ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVaultResourceId:
{
Description: The resource ID of KeyVault. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Status of the KeyVault connection. ,
Enum:
{
Created: KeyVault connection created but not in use ,
Updating: KeyVault connection Updating ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: 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. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults. ,
Required: False ,
}
string ,
}
,
}
,
disableShowmount:
{
Description: Shows the status of disableShowmount for all volumes under the subscription, null equals false ,
Required: False ,
}
boolean ,
nfsV4IDDomain:
{
Description: 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. ,
Required: False ,
}
string ,
isMultiAdEnabled:
{
Description: This will have true value only if account is Multiple AD enabled. ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: The identity used for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator, value is masked in the response ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dns:
{
Description: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of the Active Directory ,
Enum:
{
Created: Active Directory created but not in use ,
Updating: Active Directory Updating ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Any details in regards to the Status of the Active Directory ,
Required: False ,
}
string ,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
kdcIP:
{
Description: kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. ,
Required: False ,
}
string ,
adName:
{
Description: Name of the active directory machine. This optional parameter is used only while creating kerberos volume ,
Required: False ,
}
string ,
serverRootCACertificate:
{
Description: 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. ,
Required: False ,
}
string ,
aesEncryption:
{
Description: If enabled, AES encryption will be enabled for SMB communication. ,
Required: False ,
}
boolean ,
ldapSigning:
{
Description: Specifies whether or not the LDAP traffic needs to be signed. ,
Required: False ,
}
boolean ,
securityOperators:
{
Description: 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 ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
allowLocalNfsUsersWithLdap:
{
Description: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. ,
Required: False ,
}
boolean ,
encryptDCConnections:
{
Description: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. ,
Required: False ,
}
boolean ,
ldapSearchScope:
{
Description: LDAP Search scope options ,
Required: False ,
}
{
userDN:
{
Description: This specifies the user DN, which overrides the base DN for user lookups. ,
Required: False ,
}
string ,
groupDN:
{
Description: This specifies the group DN, which overrides the base DN for group lookups. ,
Required: False ,
}
string ,
groupMembershipFilter:
{
Description: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. ,
Required: False ,
}
string ,
}
,
preferredServersForLdapClient:
{
Description: Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. ,
Required: False ,
}
string ,
}
,
]
,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyVaultId:
{
Description: UUID v4 used to identify the Azure Key Vault configuration ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVaultResourceId:
{
Description: The resource ID of KeyVault. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Status of the KeyVault connection. ,
Enum:
{
Created: KeyVault connection created but not in use ,
Updating: KeyVault connection Updating ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: 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. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults. ,
Required: False ,
}
string ,
}
,
}
,
disableShowmount:
{
Description: Shows the status of disableShowmount for all volumes under the subscription, null equals false ,
Required: False ,
}
boolean ,
nfsV4IDDomain:
{
Description: 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. ,
Required: False ,
}
string ,
isMultiAdEnabled:
{
Description: This will have true value only if account is Multiple AD enabled. ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: The identity used for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: NetApp Account object supplied in the body of the operation. ,
Required: True ,
}
{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator, value is masked in the response ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dns:
{
Description: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of the Active Directory ,
Enum:
{
Created: Active Directory created but not in use ,
Updating: Active Directory Updating ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Any details in regards to the Status of the Active Directory ,
Required: False ,
}
string ,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
kdcIP:
{
Description: kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. ,
Required: False ,
}
string ,
adName:
{
Description: Name of the active directory machine. This optional parameter is used only while creating kerberos volume ,
Required: False ,
}
string ,
serverRootCACertificate:
{
Description: 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. ,
Required: False ,
}
string ,
aesEncryption:
{
Description: If enabled, AES encryption will be enabled for SMB communication. ,
Required: False ,
}
boolean ,
ldapSigning:
{
Description: Specifies whether or not the LDAP traffic needs to be signed. ,
Required: False ,
}
boolean ,
securityOperators:
{
Description: 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 ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
allowLocalNfsUsersWithLdap:
{
Description: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. ,
Required: False ,
}
boolean ,
encryptDCConnections:
{
Description: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. ,
Required: False ,
}
boolean ,
ldapSearchScope:
{
Description: LDAP Search scope options ,
Required: False ,
}
{
userDN:
{
Description: This specifies the user DN, which overrides the base DN for user lookups. ,
Required: False ,
}
string ,
groupDN:
{
Description: This specifies the group DN, which overrides the base DN for group lookups. ,
Required: False ,
}
string ,
groupMembershipFilter:
{
Description: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. ,
Required: False ,
}
string ,
}
,
preferredServersForLdapClient:
{
Description: Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. ,
Required: False ,
}
string ,
}
,
]
,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyVaultId:
{
Description: UUID v4 used to identify the Azure Key Vault configuration ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVaultResourceId:
{
Description: The resource ID of KeyVault. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Status of the KeyVault connection. ,
Enum:
{
Created: KeyVault connection created but not in use ,
Updating: KeyVault connection Updating ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: 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. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults. ,
Required: False ,
}
string ,
}
,
}
,
disableShowmount:
{
Description: Shows the status of disableShowmount for all volumes under the subscription, null equals false ,
Required: False ,
}
boolean ,
nfsV4IDDomain:
{
Description: 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. ,
Required: False ,
}
string ,
isMultiAdEnabled:
{
Description: This will have true value only if account is Multiple AD enabled. ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: The identity used for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator, value is masked in the response ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dns:
{
Description: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of the Active Directory ,
Enum:
{
Created: Active Directory created but not in use ,
Updating: Active Directory Updating ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Any details in regards to the Status of the Active Directory ,
Required: False ,
}
string ,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
kdcIP:
{
Description: kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. ,
Required: False ,
}
string ,
adName:
{
Description: Name of the active directory machine. This optional parameter is used only while creating kerberos volume ,
Required: False ,
}
string ,
serverRootCACertificate:
{
Description: 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. ,
Required: False ,
}
string ,
aesEncryption:
{
Description: If enabled, AES encryption will be enabled for SMB communication. ,
Required: False ,
}
boolean ,
ldapSigning:
{
Description: Specifies whether or not the LDAP traffic needs to be signed. ,
Required: False ,
}
boolean ,
securityOperators:
{
Description: 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 ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
allowLocalNfsUsersWithLdap:
{
Description: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. ,
Required: False ,
}
boolean ,
encryptDCConnections:
{
Description: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. ,
Required: False ,
}
boolean ,
ldapSearchScope:
{
Description: LDAP Search scope options ,
Required: False ,
}
{
userDN:
{
Description: This specifies the user DN, which overrides the base DN for user lookups. ,
Required: False ,
}
string ,
groupDN:
{
Description: This specifies the group DN, which overrides the base DN for group lookups. ,
Required: False ,
}
string ,
groupMembershipFilter:
{
Description: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. ,
Required: False ,
}
string ,
}
,
preferredServersForLdapClient:
{
Description: Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. ,
Required: False ,
}
string ,
}
,
]
,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyVaultId:
{
Description: UUID v4 used to identify the Azure Key Vault configuration ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVaultResourceId:
{
Description: The resource ID of KeyVault. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Status of the KeyVault connection. ,
Enum:
{
Created: KeyVault connection created but not in use ,
Updating: KeyVault connection Updating ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: 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. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults. ,
Required: False ,
}
string ,
}
,
}
,
disableShowmount:
{
Description: Shows the status of disableShowmount for all volumes under the subscription, null equals false ,
Required: False ,
}
boolean ,
nfsV4IDDomain:
{
Description: 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. ,
Required: False ,
}
string ,
isMultiAdEnabled:
{
Description: This will have true value only if account is Multiple AD enabled. ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: The identity used for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator, value is masked in the response ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dns:
{
Description: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of the Active Directory ,
Enum:
{
Created: Active Directory created but not in use ,
Updating: Active Directory Updating ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Any details in regards to the Status of the Active Directory ,
Required: False ,
}
string ,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
kdcIP:
{
Description: kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. ,
Required: False ,
}
string ,
adName:
{
Description: Name of the active directory machine. This optional parameter is used only while creating kerberos volume ,
Required: False ,
}
string ,
serverRootCACertificate:
{
Description: 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. ,
Required: False ,
}
string ,
aesEncryption:
{
Description: If enabled, AES encryption will be enabled for SMB communication. ,
Required: False ,
}
boolean ,
ldapSigning:
{
Description: Specifies whether or not the LDAP traffic needs to be signed. ,
Required: False ,
}
boolean ,
securityOperators:
{
Description: 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 ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
allowLocalNfsUsersWithLdap:
{
Description: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. ,
Required: False ,
}
boolean ,
encryptDCConnections:
{
Description: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. ,
Required: False ,
}
boolean ,
ldapSearchScope:
{
Description: LDAP Search scope options ,
Required: False ,
}
{
userDN:
{
Description: This specifies the user DN, which overrides the base DN for user lookups. ,
Required: False ,
}
string ,
groupDN:
{
Description: This specifies the group DN, which overrides the base DN for group lookups. ,
Required: False ,
}
string ,
groupMembershipFilter:
{
Description: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. ,
Required: False ,
}
string ,
}
,
preferredServersForLdapClient:
{
Description: Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. ,
Required: False ,
}
string ,
}
,
]
,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyVaultId:
{
Description: UUID v4 used to identify the Azure Key Vault configuration ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVaultResourceId:
{
Description: The resource ID of KeyVault. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Status of the KeyVault connection. ,
Enum:
{
Created: KeyVault connection created but not in use ,
Updating: KeyVault connection Updating ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: 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. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults. ,
Required: False ,
}
string ,
}
,
}
,
disableShowmount:
{
Description: Shows the status of disableShowmount for all volumes under the subscription, null equals false ,
Required: False ,
}
boolean ,
nfsV4IDDomain:
{
Description: 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. ,
Required: False ,
}
string ,
isMultiAdEnabled:
{
Description: This will have true value only if account is Multiple AD enabled. ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: The identity used for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{
body:
{
Description: NetApp Account object supplied in the body of the operation. ,
Required: True ,
}
{
location:
{
Description: Resource location ,
Required: False ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator, value is masked in the response ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dns:
{
Description: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of the Active Directory ,
Enum:
{
Created: Active Directory created but not in use ,
Updating: Active Directory Updating ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Any details in regards to the Status of the Active Directory ,
Required: False ,
}
string ,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
kdcIP:
{
Description: kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. ,
Required: False ,
}
string ,
adName:
{
Description: Name of the active directory machine. This optional parameter is used only while creating kerberos volume ,
Required: False ,
}
string ,
serverRootCACertificate:
{
Description: 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. ,
Required: False ,
}
string ,
aesEncryption:
{
Description: If enabled, AES encryption will be enabled for SMB communication. ,
Required: False ,
}
boolean ,
ldapSigning:
{
Description: Specifies whether or not the LDAP traffic needs to be signed. ,
Required: False ,
}
boolean ,
securityOperators:
{
Description: 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 ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
allowLocalNfsUsersWithLdap:
{
Description: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. ,
Required: False ,
}
boolean ,
encryptDCConnections:
{
Description: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. ,
Required: False ,
}
boolean ,
ldapSearchScope:
{
Description: LDAP Search scope options ,
Required: False ,
}
{
userDN:
{
Description: This specifies the user DN, which overrides the base DN for user lookups. ,
Required: False ,
}
string ,
groupDN:
{
Description: This specifies the group DN, which overrides the base DN for group lookups. ,
Required: False ,
}
string ,
groupMembershipFilter:
{
Description: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. ,
Required: False ,
}
string ,
}
,
preferredServersForLdapClient:
{
Description: Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. ,
Required: False ,
}
string ,
}
,
]
,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyVaultId:
{
Description: UUID v4 used to identify the Azure Key Vault configuration ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVaultResourceId:
{
Description: The resource ID of KeyVault. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Status of the KeyVault connection. ,
Enum:
{
Created: KeyVault connection created but not in use ,
Updating: KeyVault connection Updating ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: 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. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults. ,
Required: False ,
}
string ,
}
,
}
,
disableShowmount:
{
Description: Shows the status of disableShowmount for all volumes under the subscription, null equals false ,
Required: False ,
}
boolean ,
nfsV4IDDomain:
{
Description: 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. ,
Required: False ,
}
string ,
isMultiAdEnabled:
{
Description: This will have true value only if account is Multiple AD enabled. ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: The identity used for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator, value is masked in the response ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dns:
{
Description: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of the Active Directory ,
Enum:
{
Created: Active Directory created but not in use ,
Updating: Active Directory Updating ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Any details in regards to the Status of the Active Directory ,
Required: False ,
}
string ,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
kdcIP:
{
Description: kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. ,
Required: False ,
}
string ,
adName:
{
Description: Name of the active directory machine. This optional parameter is used only while creating kerberos volume ,
Required: False ,
}
string ,
serverRootCACertificate:
{
Description: 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. ,
Required: False ,
}
string ,
aesEncryption:
{
Description: If enabled, AES encryption will be enabled for SMB communication. ,
Required: False ,
}
boolean ,
ldapSigning:
{
Description: Specifies whether or not the LDAP traffic needs to be signed. ,
Required: False ,
}
boolean ,
securityOperators:
{
Description: 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 ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
allowLocalNfsUsersWithLdap:
{
Description: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. ,
Required: False ,
}
boolean ,
encryptDCConnections:
{
Description: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. ,
Required: False ,
}
boolean ,
ldapSearchScope:
{
Description: LDAP Search scope options ,
Required: False ,
}
{
userDN:
{
Description: This specifies the user DN, which overrides the base DN for user lookups. ,
Required: False ,
}
string ,
groupDN:
{
Description: This specifies the group DN, which overrides the base DN for group lookups. ,
Required: False ,
}
string ,
groupMembershipFilter:
{
Description: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. ,
Required: False ,
}
string ,
}
,
preferredServersForLdapClient:
{
Description: Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. ,
Required: False ,
}
string ,
}
,
]
,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyVaultId:
{
Description: UUID v4 used to identify the Azure Key Vault configuration ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVaultResourceId:
{
Description: The resource ID of KeyVault. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Status of the KeyVault connection. ,
Enum:
{
Created: KeyVault connection created but not in use ,
Updating: KeyVault connection Updating ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: 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. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults. ,
Required: False ,
}
string ,
}
,
}
,
disableShowmount:
{
Description: Shows the status of disableShowmount for all volumes under the subscription, null equals false ,
Required: False ,
}
boolean ,
nfsV4IDDomain:
{
Description: 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. ,
Required: False ,
}
string ,
isMultiAdEnabled:
{
Description: This will have true value only if account is Multiple AD enabled. ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: The identity used for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator, value is masked in the response ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dns:
{
Description: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of the Active Directory ,
Enum:
{
Created: Active Directory created but not in use ,
Updating: Active Directory Updating ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Any details in regards to the Status of the Active Directory ,
Required: False ,
}
string ,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
kdcIP:
{
Description: kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. ,
Required: False ,
}
string ,
adName:
{
Description: Name of the active directory machine. This optional parameter is used only while creating kerberos volume ,
Required: False ,
}
string ,
serverRootCACertificate:
{
Description: 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. ,
Required: False ,
}
string ,
aesEncryption:
{
Description: If enabled, AES encryption will be enabled for SMB communication. ,
Required: False ,
}
boolean ,
ldapSigning:
{
Description: Specifies whether or not the LDAP traffic needs to be signed. ,
Required: False ,
}
boolean ,
securityOperators:
{
Description: 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 ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
allowLocalNfsUsersWithLdap:
{
Description: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. ,
Required: False ,
}
boolean ,
encryptDCConnections:
{
Description: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. ,
Required: False ,
}
boolean ,
ldapSearchScope:
{
Description: LDAP Search scope options ,
Required: False ,
}
{
userDN:
{
Description: This specifies the user DN, which overrides the base DN for user lookups. ,
Required: False ,
}
string ,
groupDN:
{
Description: This specifies the group DN, which overrides the base DN for group lookups. ,
Required: False ,
}
string ,
groupMembershipFilter:
{
Description: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. ,
Required: False ,
}
string ,
}
,
preferredServersForLdapClient:
{
Description: Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. ,
Required: False ,
}
string ,
}
,
]
,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyVaultId:
{
Description: UUID v4 used to identify the Azure Key Vault configuration ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVaultResourceId:
{
Description: The resource ID of KeyVault. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Status of the KeyVault connection. ,
Enum:
{
Created: KeyVault connection created but not in use ,
Updating: KeyVault connection Updating ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
Description: 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. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults. ,
Required: False ,
}
string ,
}
,
}
,
disableShowmount:
{
Description: Shows the status of disableShowmount for all volumes under the subscription, null equals false ,
Required: False ,
}
boolean ,
nfsV4IDDomain:
{
Description: 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. ,
Required: False ,
}
string ,
isMultiAdEnabled:
{
Description: This will have true value only if account is Multiple AD enabled. ,
Required: False ,
}
boolean ,
}
,
identity:
{
Description: The identity used for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The required parameters to perform encryption transition. ,
Required: False ,
}
{
virtualNetworkId:
{
Description: Identifier for the virtual network ,
Format: arm-id ,
Required: True ,
}
string ,
privateEndpointId:
{
Description: Identifier of the private endpoint to reach the Azure Key Vault ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The required parameters to perform encryption migration. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The URI of the key vault/managed HSM that should be used for encryption. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the key that should be used for encryption. ,
Required: True ,
}
string ,
keyVaultResourceId:
{
Description: Azure resource ID of the key vault/managed HSM that should be used for encryption. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultPrivateEndpoints:
{
Description: Pairs of virtual network ID and private endpoint ID. Every virtual network that has volumes encrypted with customer-managed keys needs its own key vault private endpoint. ,
Required: True ,
}
[
{
virtualNetworkId:
{
Description: Identifier for the virtual network id ,
Format: arm-id ,
Required: False ,
}
string ,
privateEndpointId:
{
Description: Identifier of the private endpoint to reach the Azure Key Vault ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Capacity pools ,
Required: False ,
}
[
{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: Capacity pool properties ,
Required: True ,
}
{
poolId:
{
Description: UUID v4 used to identify the Pool ,
Required: False ,
}
string ,
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776). ,
Format: int64 ,
Required: True ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level ,
Flexible: Flexible service level ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
totalThroughputMibps:
{
Description: Total throughput of pool in MiB/s ,
Required: False ,
}
number ,
utilizedThroughputMibps:
{
Description: Utilized throughput of pool in MiB/s ,
Required: False ,
}
number ,
customThroughputMibps:
{
Required: False ,
}
number ,
qosType:
{
Description: The qos type of the pool ,
Enum:
{
Auto: qos type Auto ,
Manual: qos type Manual ,
}
,
Required: False ,
}
enum ,
coolAccess:
{
Description: If enabled (true) the pool can contain cool Access enabled volumes. ,
Required: False ,
}
boolean ,
encryptionType:
{
Description: Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool. ,
Enum:
{
Single: EncryptionType Single, volumes will use single encryption at rest ,
Double: EncryptionType Double, volumes will use double encryption at rest ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
poolName:
{
Description: The name of the capacity pool ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: Capacity pool properties ,
Required: True ,
}
{
poolId:
{
Description: UUID v4 used to identify the Pool ,
Required: False ,
}
string ,
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776). ,
Format: int64 ,
Required: True ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level ,
Flexible: Flexible service level ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
totalThroughputMibps:
{
Description: Total throughput of pool in MiB/s ,
Required: False ,
}
number ,
utilizedThroughputMibps:
{
Description: Utilized throughput of pool in MiB/s ,
Required: False ,
}
number ,
customThroughputMibps:
{
Required: False ,
}
number ,
qosType:
{
Description: The qos type of the pool ,
Enum:
{
Auto: qos type Auto ,
Manual: qos type Manual ,
}
,
Required: False ,
}
enum ,
coolAccess:
{
Description: If enabled (true) the pool can contain cool Access enabled volumes. ,
Required: False ,
}
boolean ,
encryptionType:
{
Description: Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool. ,
Enum:
{
Single: EncryptionType Single, volumes will use single encryption at rest ,
Double: EncryptionType Double, volumes will use double encryption at rest ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: Capacity pool object supplied in the body of the operation. ,
Required: True ,
}
{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: Capacity pool properties ,
Required: True ,
}
{
poolId:
{
Description: UUID v4 used to identify the Pool ,
Required: False ,
}
string ,
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776). ,
Format: int64 ,
Required: True ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level ,
Flexible: Flexible service level ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
totalThroughputMibps:
{
Description: Total throughput of pool in MiB/s ,
Required: False ,
}
number ,
utilizedThroughputMibps:
{
Description: Utilized throughput of pool in MiB/s ,
Required: False ,
}
number ,
customThroughputMibps:
{
Required: False ,
}
number ,
qosType:
{
Description: The qos type of the pool ,
Enum:
{
Auto: qos type Auto ,
Manual: qos type Manual ,
}
,
Required: False ,
}
enum ,
coolAccess:
{
Description: If enabled (true) the pool can contain cool Access enabled volumes. ,
Required: False ,
}
boolean ,
encryptionType:
{
Description: Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool. ,
Enum:
{
Single: EncryptionType Single, volumes will use single encryption at rest ,
Double: EncryptionType Double, volumes will use double encryption at rest ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
poolName:
{
Description: The name of the capacity pool ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: Capacity pool properties ,
Required: True ,
}
{
poolId:
{
Description: UUID v4 used to identify the Pool ,
Required: False ,
}
string ,
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776). ,
Format: int64 ,
Required: True ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level ,
Flexible: Flexible service level ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
totalThroughputMibps:
{
Description: Total throughput of pool in MiB/s ,
Required: False ,
}
number ,
utilizedThroughputMibps:
{
Description: Utilized throughput of pool in MiB/s ,
Required: False ,
}
number ,
customThroughputMibps:
{
Required: False ,
}
number ,
qosType:
{
Description: The qos type of the pool ,
Enum:
{
Auto: qos type Auto ,
Manual: qos type Manual ,
}
,
Required: False ,
}
enum ,
coolAccess:
{
Description: If enabled (true) the pool can contain cool Access enabled volumes. ,
Required: False ,
}
boolean ,
encryptionType:
{
Description: Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool. ,
Enum:
{
Single: EncryptionType Single, volumes will use single encryption at rest ,
Double: EncryptionType Double, volumes will use double encryption at rest ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: Capacity pool properties ,
Required: True ,
}
{
poolId:
{
Description: UUID v4 used to identify the Pool ,
Required: False ,
}
string ,
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776). ,
Format: int64 ,
Required: True ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level ,
Flexible: Flexible service level ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
totalThroughputMibps:
{
Description: Total throughput of pool in MiB/s ,
Required: False ,
}
number ,
utilizedThroughputMibps:
{
Description: Utilized throughput of pool in MiB/s ,
Required: False ,
}
number ,
customThroughputMibps:
{
Required: False ,
}
number ,
qosType:
{
Description: The qos type of the pool ,
Enum:
{
Auto: qos type Auto ,
Manual: qos type Manual ,
}
,
Required: False ,
}
enum ,
coolAccess:
{
Description: If enabled (true) the pool can contain cool Access enabled volumes. ,
Required: False ,
}
boolean ,
encryptionType:
{
Description: Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool. ,
Enum:
{
Single: EncryptionType Single, volumes will use single encryption at rest ,
Double: EncryptionType Double, volumes will use double encryption at rest ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: Capacity pool object supplied in the body of the operation. ,
Required: True ,
}
{
location:
{
Description: Resource location ,
Required: False ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Capacity pool properties ,
Required: False ,
}
{
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776). ,
Format: int64 ,
Required: False ,
}
integer ,
qosType:
{
Description: The qos type of the pool ,
Enum:
{
Auto: qos type Auto ,
Manual: qos type Manual ,
}
,
Required: False ,
}
enum ,
coolAccess:
{
Description: If enabled (true) the pool can contain cool Access enabled volumes. ,
Required: False ,
}
boolean ,
customThroughputMibps:
{
Required: False ,
}
number ,
}
,
}
,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
poolName:
{
Description: The name of the capacity pool ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: Capacity pool properties ,
Required: True ,
}
{
poolId:
{
Description: UUID v4 used to identify the Pool ,
Required: False ,
}
string ,
size:
{
Description: Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776). ,
Format: int64 ,
Required: True ,
}
integer ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level ,
Flexible: Flexible service level ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
totalThroughputMibps:
{
Description: Total throughput of pool in MiB/s ,
Required: False ,
}
number ,
utilizedThroughputMibps:
{
Description: Utilized throughput of pool in MiB/s ,
Required: False ,
}
number ,
customThroughputMibps:
{
Required: False ,
}
number ,
qosType:
{
Description: The qos type of the pool ,
Enum:
{
Auto: qos type Auto ,
Manual: qos type Manual ,
}
,
Required: False ,
}
enum ,
coolAccess:
{
Description: If enabled (true) the pool can contain cool Access enabled volumes. ,
Required: False ,
}
boolean ,
encryptionType:
{
Description: Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool. ,
Enum:
{
Single: EncryptionType Single, volumes will use single encryption at rest ,
Double: EncryptionType Double, volumes will use double encryption at rest ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
poolName:
{
Description: The name of the capacity pool ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
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:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
poolName:
{
Description: The name of the capacity pool ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of volumes ,
Required: False ,
}
[
{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
zones:
{
Description: Availability Zone ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level ,
Flexible: Flexible service level ,
}
,
Required: False ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 1PiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,