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 ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
Description: If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
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 ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective 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 ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
Description: What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
Description: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
Description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Required: False ,
}
number ,
encryptionKeySource:
{
Description: Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
Description: coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage. ,
Enum:
{
Default: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
Description: UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. Avoid passing null value for unixPermissions in volume update operation, As per the behavior, If Null value is passed then user-visible unixPermissions value will became null, and user will not be able to get unixPermissions value. On safer side, actual unixPermissions value on volume will remain as its last saved value only. ,
Required: False ,
}
string ,
cloneProgress:
{
Description: When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
Description: Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
language:
{
Description: Language supported for volume. ,
Enum:
{
c.utf-8: Posix with UTF-8 ,
utf8mb4: UTF-8 with 4 byte character support ,
ar: Arabic - Deprecated ,
ar.utf-8: Arabic with UTF-8 ,
hr: Croatian - Deprecated ,
hr.utf-8: Croatian with UTF-8 ,
cs: Czech - Deprecated ,
cs.utf-8: Czech with UTF-8 ,
da: Danish - Deprecated ,
da.utf-8: Danish with UTF-8 ,
nl: Dutch - Deprecated ,
nl.utf-8: Dutch with UTF-8 ,
en: English - Deprecated ,
en.utf-8: English with UTF-8 ,
fi: Finnish - Deprecated ,
fi.utf-8: Finnish with UTF-8 ,
fr: French - Deprecated ,
fr.utf-8: French with UTF-8 ,
de: German - Deprecated ,
de.utf-8: German with UTF-8 ,
he: Hebrew - Deprecated ,
he.utf-8: Hebrew with UTF-8 ,
hu: Hungarian - Deprecated ,
hu.utf-8: Hungarian with UTF-8 ,
it: Italian - Deprecated ,
it.utf-8: Italian with UTF-8 ,
ja: Japanese euc-j - Deprecated ,
ja.utf-8: Japanese euc-j with UTF-8 ,
ja-v1: Japanese euc-j - Deprecated ,
ja-v1.utf-8: Japanese euc-j with UTF-8 ,
ja-jp.pck: Japanese pck ,
ja-jp.pck.utf-8: Japanese pck with UTF-8 - Deprecated ,
ja-jp.932: Japanese cp932 ,
ja-jp.932.utf-8: Japanese cp932 with UTF-8 - Deprecated ,
ja-jp.pck-v2: Japanese pck - sjis ,
ja-jp.pck-v2.utf-8: Japanese pck - sjis with UTF-8 - Deprecated ,
ko: Korean - Deprecated ,
ko.utf-8: Korean with UTF-8 ,
no: Norwegian - Deprecated ,
no.utf-8: Norwegian with UTF-8 ,
pl: Polish - Deprecated ,
pl.utf-8: Polish with UTF-8 ,
pt: Portuguese - Deprecated ,
pt.utf-8: Portuguese with UTF-8 ,
c: Posix - Deprecated ,
ro: Romanian - Deprecated ,
ro.utf-8: Romanian with UTF-8 ,
ru: Russian - Deprecated ,
ru.utf-8: Russian with UTF-8 ,
zh: Simplified Chinese - Deprecated ,
zh.utf-8: Simplified Chinese with UTF-8 ,
zh.gbk: Simplified gbk Chinese ,
zh.gbk.utf-8: Simplified gbk Chinese with UTF-8 - Deprecated ,
zh-tw.big5: Traditional Chinese BIG 5 ,
zh-tw.big5.utf-8: Traditional Chinese BIG 5 with UTF-8 - Deprecated ,
zh-tw: Traditional Chinese EUC-TW ,
zh-tw.utf-8: Traditional Chinese EUC-TW with UTF-8 - Deprecated ,
sk: Slovak - Deprecated ,
sk.utf-8: Slovak with UTF-8 ,
sl: Slovenian - Deprecated ,
sl.utf-8: Slovenian with UTF-8 ,
es: Spanish - Deprecated ,
es.utf-8: Spanish with UTF-8 ,
sv: Swedish - Deprecated ,
sv.utf-8: Swedish with UTF-8 ,
tr: Turkish - Deprecated ,
tr.utf-8: Turkish with UTF-8 ,
en-us: US English - Deprecated ,
en-us.utf-8: US English with UTF-8 ,
}
,
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 ,
}
,
]
,
}
,
}
Volumes_Get (new)
Description :  Get the details of the specified volume
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
{
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 ,
volumeName:
{
Description: The name of the volume ,
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 ,
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 ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
Description: If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
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 ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective 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 ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
Description: What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
Description: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
Description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Required: False ,
}
number ,
encryptionKeySource:
{
Description: Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
Description: coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage. ,
Enum:
{
Default: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
Description: UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. Avoid passing null value for unixPermissions in volume update operation, As per the behavior, If Null value is passed then user-visible unixPermissions value will became null, and user will not be able to get unixPermissions value. On safer side, actual unixPermissions value on volume will remain as its last saved value only. ,
Required: False ,
}
string ,
cloneProgress:
{
Description: When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
Description: Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
language:
{
Description: Language supported for volume. ,
Enum:
{
c.utf-8: Posix with UTF-8 ,
utf8mb4: UTF-8 with 4 byte character support ,
ar: Arabic - Deprecated ,
ar.utf-8: Arabic with UTF-8 ,
hr: Croatian - Deprecated ,
hr.utf-8: Croatian with UTF-8 ,
cs: Czech - Deprecated ,
cs.utf-8: Czech with UTF-8 ,
da: Danish - Deprecated ,
da.utf-8: Danish with UTF-8 ,
nl: Dutch - Deprecated ,
nl.utf-8: Dutch with UTF-8 ,
en: English - Deprecated ,
en.utf-8: English with UTF-8 ,
fi: Finnish - Deprecated ,
fi.utf-8: Finnish with UTF-8 ,
fr: French - Deprecated ,
fr.utf-8: French with UTF-8 ,
de: German - Deprecated ,
de.utf-8: German with UTF-8 ,
he: Hebrew - Deprecated ,
he.utf-8: Hebrew with UTF-8 ,
hu: Hungarian - Deprecated ,
hu.utf-8: Hungarian with UTF-8 ,
it: Italian - Deprecated ,
it.utf-8: Italian with UTF-8 ,
ja: Japanese euc-j - Deprecated ,
ja.utf-8: Japanese euc-j with UTF-8 ,
ja-v1: Japanese euc-j - Deprecated ,
ja-v1.utf-8: Japanese euc-j with UTF-8 ,
ja-jp.pck: Japanese pck ,
ja-jp.pck.utf-8: Japanese pck with UTF-8 - Deprecated ,
ja-jp.932: Japanese cp932 ,
ja-jp.932.utf-8: Japanese cp932 with UTF-8 - Deprecated ,
ja-jp.pck-v2: Japanese pck - sjis ,
ja-jp.pck-v2.utf-8: Japanese pck - sjis with UTF-8 - Deprecated ,
ko: Korean - Deprecated ,
ko.utf-8: Korean with UTF-8 ,
no: Norwegian - Deprecated ,
no.utf-8: Norwegian with UTF-8 ,
pl: Polish - Deprecated ,
pl.utf-8: Polish with UTF-8 ,
pt: Portuguese - Deprecated ,
pt.utf-8: Portuguese with UTF-8 ,
c: Posix - Deprecated ,
ro: Romanian - Deprecated ,
ro.utf-8: Romanian with UTF-8 ,
ru: Russian - Deprecated ,
ru.utf-8: Russian with UTF-8 ,
zh: Simplified Chinese - Deprecated ,
zh.utf-8: Simplified Chinese with UTF-8 ,
zh.gbk: Simplified gbk Chinese ,
zh.gbk.utf-8: Simplified gbk Chinese with UTF-8 - Deprecated ,
zh-tw.big5: Traditional Chinese BIG 5 ,
zh-tw.big5.utf-8: Traditional Chinese BIG 5 with UTF-8 - Deprecated ,
zh-tw: Traditional Chinese EUC-TW ,
zh-tw.utf-8: Traditional Chinese EUC-TW with UTF-8 - Deprecated ,
sk: Slovak - Deprecated ,
sk.utf-8: Slovak with UTF-8 ,
sl: Slovenian - Deprecated ,
sl.utf-8: Slovenian with UTF-8 ,
es: Spanish - Deprecated ,
es.utf-8: Spanish with UTF-8 ,
sv: Swedish - Deprecated ,
sv.utf-8: Swedish with UTF-8 ,
tr: Turkish - Deprecated ,
tr.utf-8: Turkish with UTF-8 ,
en-us: US English - Deprecated ,
en-us.utf-8: US English with UTF-8 ,
}
,
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 ,
}
,
]
,
}
,
}
Volumes_CreateOrUpdate (new)
Description :  Create or update the specified volume within the capacity pool
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
{
body:
{
Description: Volume 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 ,
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 ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
Description: If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
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 ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective 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 ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
Description: What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
Description: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
Description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Required: False ,
}
number ,
encryptionKeySource:
{
Description: Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
Description: coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage. ,
Enum:
{
Default: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
Description: UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. Avoid passing null value for unixPermissions in volume update operation, As per the behavior, If Null value is passed then user-visible unixPermissions value will became null, and user will not be able to get unixPermissions value. On safer side, actual unixPermissions value on volume will remain as its last saved value only. ,
Required: False ,
}
string ,
cloneProgress:
{
Description: When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
Description: Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
language:
{
Description: Language supported for volume. ,
Enum:
{
c.utf-8: Posix with UTF-8 ,
utf8mb4: UTF-8 with 4 byte character support ,
ar: Arabic - Deprecated ,
ar.utf-8: Arabic with UTF-8 ,
hr: Croatian - Deprecated ,
hr.utf-8: Croatian with UTF-8 ,
cs: Czech - Deprecated ,
cs.utf-8: Czech with UTF-8 ,
da: Danish - Deprecated ,
da.utf-8: Danish with UTF-8 ,
nl: Dutch - Deprecated ,
nl.utf-8: Dutch with UTF-8 ,
en: English - Deprecated ,
en.utf-8: English with UTF-8 ,
fi: Finnish - Deprecated ,
fi.utf-8: Finnish with UTF-8 ,
fr: French - Deprecated ,
fr.utf-8: French with UTF-8 ,
de: German - Deprecated ,
de.utf-8: German with UTF-8 ,
he: Hebrew - Deprecated ,
he.utf-8: Hebrew with UTF-8 ,
hu: Hungarian - Deprecated ,
hu.utf-8: Hungarian with UTF-8 ,
it: Italian - Deprecated ,
it.utf-8: Italian with UTF-8 ,
ja: Japanese euc-j - Deprecated ,
ja.utf-8: Japanese euc-j with UTF-8 ,
ja-v1: Japanese euc-j - Deprecated ,
ja-v1.utf-8: Japanese euc-j with UTF-8 ,
ja-jp.pck: Japanese pck ,
ja-jp.pck.utf-8: Japanese pck with UTF-8 - Deprecated ,
ja-jp.932: Japanese cp932 ,
ja-jp.932.utf-8: Japanese cp932 with UTF-8 - Deprecated ,
ja-jp.pck-v2: Japanese pck - sjis ,
ja-jp.pck-v2.utf-8: Japanese pck - sjis with UTF-8 - Deprecated ,
ko: Korean - Deprecated ,
ko.utf-8: Korean with UTF-8 ,
no: Norwegian - Deprecated ,
no.utf-8: Norwegian with UTF-8 ,
pl: Polish - Deprecated ,
pl.utf-8: Polish with UTF-8 ,
pt: Portuguese - Deprecated ,
pt.utf-8: Portuguese with UTF-8 ,
c: Posix - Deprecated ,
ro: Romanian - Deprecated ,
ro.utf-8: Romanian with UTF-8 ,
ru: Russian - Deprecated ,
ru.utf-8: Russian with UTF-8 ,
zh: Simplified Chinese - Deprecated ,
zh.utf-8: Simplified Chinese with UTF-8 ,
zh.gbk: Simplified gbk Chinese ,
zh.gbk.utf-8: Simplified gbk Chinese with UTF-8 - Deprecated ,
zh-tw.big5: Traditional Chinese BIG 5 ,
zh-tw.big5.utf-8: Traditional Chinese BIG 5 with UTF-8 - Deprecated ,
zh-tw: Traditional Chinese EUC-TW ,
zh-tw.utf-8: Traditional Chinese EUC-TW with UTF-8 - Deprecated ,
sk: Slovak - Deprecated ,
sk.utf-8: Slovak with UTF-8 ,
sl: Slovenian - Deprecated ,
sl.utf-8: Slovenian with UTF-8 ,
es: Spanish - Deprecated ,
es.utf-8: Spanish with UTF-8 ,
sv: Swedish - Deprecated ,
sv.utf-8: Swedish with UTF-8 ,
tr: Turkish - Deprecated ,
tr.utf-8: Turkish with UTF-8 ,
en-us: US English - Deprecated ,
en-us.utf-8: US English with UTF-8 ,
}
,
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 ,
volumeName:
{
Description: The name of the volume ,
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 ,
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 ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
Description: If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
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 ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective 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 ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
Description: What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
Description: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
Description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Required: False ,
}
number ,
encryptionKeySource:
{
Description: Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
Description: coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage. ,
Enum:
{
Default: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
Description: UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. Avoid passing null value for unixPermissions in volume update operation, As per the behavior, If Null value is passed then user-visible unixPermissions value will became null, and user will not be able to get unixPermissions value. On safer side, actual unixPermissions value on volume will remain as its last saved value only. ,
Required: False ,
}
string ,
cloneProgress:
{
Description: When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
Description: Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
language:
{
Description: Language supported for volume. ,
Enum:
{
c.utf-8: Posix with UTF-8 ,
utf8mb4: UTF-8 with 4 byte character support ,
ar: Arabic - Deprecated ,
ar.utf-8: Arabic with UTF-8 ,
hr: Croatian - Deprecated ,
hr.utf-8: Croatian with UTF-8 ,
cs: Czech - Deprecated ,
cs.utf-8: Czech with UTF-8 ,
da: Danish - Deprecated ,
da.utf-8: Danish with UTF-8 ,
nl: Dutch - Deprecated ,
nl.utf-8: Dutch with UTF-8 ,
en: English - Deprecated ,
en.utf-8: English with UTF-8 ,
fi: Finnish - Deprecated ,
fi.utf-8: Finnish with UTF-8 ,
fr: French - Deprecated ,
fr.utf-8: French with UTF-8 ,
de: German - Deprecated ,
de.utf-8: German with UTF-8 ,
he: Hebrew - Deprecated ,
he.utf-8: Hebrew with UTF-8 ,
hu: Hungarian - Deprecated ,
hu.utf-8: Hungarian with UTF-8 ,
it: Italian - Deprecated ,
it.utf-8: Italian with UTF-8 ,
ja: Japanese euc-j - Deprecated ,
ja.utf-8: Japanese euc-j with UTF-8 ,
ja-v1: Japanese euc-j - Deprecated ,
ja-v1.utf-8: Japanese euc-j with UTF-8 ,
ja-jp.pck: Japanese pck ,
ja-jp.pck.utf-8: Japanese pck with UTF-8 - Deprecated ,
ja-jp.932: Japanese cp932 ,
ja-jp.932.utf-8: Japanese cp932 with UTF-8 - Deprecated ,
ja-jp.pck-v2: Japanese pck - sjis ,
ja-jp.pck-v2.utf-8: Japanese pck - sjis with UTF-8 - Deprecated ,
ko: Korean - Deprecated ,
ko.utf-8: Korean with UTF-8 ,
no: Norwegian - Deprecated ,
no.utf-8: Norwegian with UTF-8 ,
pl: Polish - Deprecated ,
pl.utf-8: Polish with UTF-8 ,
pt: Portuguese - Deprecated ,
pt.utf-8: Portuguese with UTF-8 ,
c: Posix - Deprecated ,
ro: Romanian - Deprecated ,
ro.utf-8: Romanian with UTF-8 ,
ru: Russian - Deprecated ,
ru.utf-8: Russian with UTF-8 ,
zh: Simplified Chinese - Deprecated ,
zh.utf-8: Simplified Chinese with UTF-8 ,
zh.gbk: Simplified gbk Chinese ,
zh.gbk.utf-8: Simplified gbk Chinese with UTF-8 - Deprecated ,
zh-tw.big5: Traditional Chinese BIG 5 ,
zh-tw.big5.utf-8: Traditional Chinese BIG 5 with UTF-8 - Deprecated ,
zh-tw: Traditional Chinese EUC-TW ,
zh-tw.utf-8: Traditional Chinese EUC-TW with UTF-8 - Deprecated ,
sk: Slovak - Deprecated ,
sk.utf-8: Slovak with UTF-8 ,
sl: Slovenian - Deprecated ,
sl.utf-8: Slovenian with UTF-8 ,
es: Spanish - Deprecated ,
es.utf-8: Spanish with UTF-8 ,
sv: Swedish - Deprecated ,
sv.utf-8: Swedish with UTF-8 ,
tr: Turkish - Deprecated ,
tr.utf-8: Turkish with UTF-8 ,
en-us: US English - Deprecated ,
en-us.utf-8: US English with UTF-8 ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
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 ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
Description: If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
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 ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective 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 ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
Description: What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
Description: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
Description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Required: False ,
}
number ,
encryptionKeySource:
{
Description: Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
Description: coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage. ,
Enum:
{
Default: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
Description: UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. Avoid passing null value for unixPermissions in volume update operation, As per the behavior, If Null value is passed then user-visible unixPermissions value will became null, and user will not be able to get unixPermissions value. On safer side, actual unixPermissions value on volume will remain as its last saved value only. ,
Required: False ,
}
string ,
cloneProgress:
{
Description: When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
Description: Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
language:
{
Description: Language supported for volume. ,
Enum:
{
c.utf-8: Posix with UTF-8 ,
utf8mb4: UTF-8 with 4 byte character support ,
ar: Arabic - Deprecated ,
ar.utf-8: Arabic with UTF-8 ,
hr: Croatian - Deprecated ,
hr.utf-8: Croatian with UTF-8 ,
cs: Czech - Deprecated ,
cs.utf-8: Czech with UTF-8 ,
da: Danish - Deprecated ,
da.utf-8: Danish with UTF-8 ,
nl: Dutch - Deprecated ,
nl.utf-8: Dutch with UTF-8 ,
en: English - Deprecated ,
en.utf-8: English with UTF-8 ,
fi: Finnish - Deprecated ,
fi.utf-8: Finnish with UTF-8 ,
fr: French - Deprecated ,
fr.utf-8: French with UTF-8 ,
de: German - Deprecated ,
de.utf-8: German with UTF-8 ,
he: Hebrew - Deprecated ,
he.utf-8: Hebrew with UTF-8 ,
hu: Hungarian - Deprecated ,
hu.utf-8: Hungarian with UTF-8 ,
it: Italian - Deprecated ,
it.utf-8: Italian with UTF-8 ,
ja: Japanese euc-j - Deprecated ,
ja.utf-8: Japanese euc-j with UTF-8 ,
ja-v1: Japanese euc-j - Deprecated ,
ja-v1.utf-8: Japanese euc-j with UTF-8 ,
ja-jp.pck: Japanese pck ,
ja-jp.pck.utf-8: Japanese pck with UTF-8 - Deprecated ,
ja-jp.932: Japanese cp932 ,
ja-jp.932.utf-8: Japanese cp932 with UTF-8 - Deprecated ,
ja-jp.pck-v2: Japanese pck - sjis ,
ja-jp.pck-v2.utf-8: Japanese pck - sjis with UTF-8 - Deprecated ,
ko: Korean - Deprecated ,
ko.utf-8: Korean with UTF-8 ,
no: Norwegian - Deprecated ,
no.utf-8: Norwegian with UTF-8 ,
pl: Polish - Deprecated ,
pl.utf-8: Polish with UTF-8 ,
pt: Portuguese - Deprecated ,
pt.utf-8: Portuguese with UTF-8 ,
c: Posix - Deprecated ,
ro: Romanian - Deprecated ,
ro.utf-8: Romanian with UTF-8 ,
ru: Russian - Deprecated ,
ru.utf-8: Russian with UTF-8 ,
zh: Simplified Chinese - Deprecated ,
zh.utf-8: Simplified Chinese with UTF-8 ,
zh.gbk: Simplified gbk Chinese ,
zh.gbk.utf-8: Simplified gbk Chinese with UTF-8 - Deprecated ,
zh-tw.big5: Traditional Chinese BIG 5 ,
zh-tw.big5.utf-8: Traditional Chinese BIG 5 with UTF-8 - Deprecated ,
zh-tw: Traditional Chinese EUC-TW ,
zh-tw.utf-8: Traditional Chinese EUC-TW with UTF-8 - Deprecated ,
sk: Slovak - Deprecated ,
sk.utf-8: Slovak with UTF-8 ,
sl: Slovenian - Deprecated ,
sl.utf-8: Slovenian with UTF-8 ,
es: Spanish - Deprecated ,
es.utf-8: Spanish with UTF-8 ,
sv: Swedish - Deprecated ,
sv.utf-8: Swedish with UTF-8 ,
tr: Turkish - Deprecated ,
tr.utf-8: Turkish with UTF-8 ,
en-us: US English - Deprecated ,
en-us.utf-8: US English with UTF-8 ,
}
,
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 ,
}
,
]
,
}
,
}
Volumes_Update (new)
Description :  Patch the specified volume
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
{
body:
{
Description: Volume 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: Patchable volume properties ,
Required: False ,
}
{
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: False ,
}
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 ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
throughputMibps:
{
Required: False ,
}
number ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
}
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
unixPermissions:
{
Description: UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. ,
Required: False ,
}
string ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
Description: coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage. ,
Enum:
{
Default: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
snapshotDirectoryVisible:
{
Description: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots. ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
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 ,
volumeName:
{
Description: The name of the volume ,
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 ,
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 ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
Description: If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
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 ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective 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 ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
Description: What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
Description: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
Description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Required: False ,
}
number ,
encryptionKeySource:
{
Description: Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
Description: coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage. ,
Enum:
{
Default: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
Description: UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. Avoid passing null value for unixPermissions in volume update operation, As per the behavior, If Null value is passed then user-visible unixPermissions value will became null, and user will not be able to get unixPermissions value. On safer side, actual unixPermissions value on volume will remain as its last saved value only. ,
Required: False ,
}
string ,
cloneProgress:
{
Description: When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
Description: Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
language:
{
Description: Language supported for volume. ,
Enum:
{
c.utf-8: Posix with UTF-8 ,
utf8mb4: UTF-8 with 4 byte character support ,
ar: Arabic - Deprecated ,
ar.utf-8: Arabic with UTF-8 ,
hr: Croatian - Deprecated ,
hr.utf-8: Croatian with UTF-8 ,
cs: Czech - Deprecated ,
cs.utf-8: Czech with UTF-8 ,
da: Danish - Deprecated ,
da.utf-8: Danish with UTF-8 ,
nl: Dutch - Deprecated ,
nl.utf-8: Dutch with UTF-8 ,
en: English - Deprecated ,
en.utf-8: English with UTF-8 ,
fi: Finnish - Deprecated ,
fi.utf-8: Finnish with UTF-8 ,
fr: French - Deprecated ,
fr.utf-8: French with UTF-8 ,
de: German - Deprecated ,
de.utf-8: German with UTF-8 ,
he: Hebrew - Deprecated ,
he.utf-8: Hebrew with UTF-8 ,
hu: Hungarian - Deprecated ,
hu.utf-8: Hungarian with UTF-8 ,
it: Italian - Deprecated ,
it.utf-8: Italian with UTF-8 ,
ja: Japanese euc-j - Deprecated ,
ja.utf-8: Japanese euc-j with UTF-8 ,
ja-v1: Japanese euc-j - Deprecated ,
ja-v1.utf-8: Japanese euc-j with UTF-8 ,
ja-jp.pck: Japanese pck ,
ja-jp.pck.utf-8: Japanese pck with UTF-8 - Deprecated ,
ja-jp.932: Japanese cp932 ,
ja-jp.932.utf-8: Japanese cp932 with UTF-8 - Deprecated ,
ja-jp.pck-v2: Japanese pck - sjis ,
ja-jp.pck-v2.utf-8: Japanese pck - sjis with UTF-8 - Deprecated ,
ko: Korean - Deprecated ,
ko.utf-8: Korean with UTF-8 ,
no: Norwegian - Deprecated ,
no.utf-8: Norwegian with UTF-8 ,
pl: Polish - Deprecated ,
pl.utf-8: Polish with UTF-8 ,
pt: Portuguese - Deprecated ,
pt.utf-8: Portuguese with UTF-8 ,
c: Posix - Deprecated ,
ro: Romanian - Deprecated ,
ro.utf-8: Romanian with UTF-8 ,
ru: Russian - Deprecated ,
ru.utf-8: Russian with UTF-8 ,
zh: Simplified Chinese - Deprecated ,
zh.utf-8: Simplified Chinese with UTF-8 ,
zh.gbk: Simplified gbk Chinese ,
zh.gbk.utf-8: Simplified gbk Chinese with UTF-8 - Deprecated ,
zh-tw.big5: Traditional Chinese BIG 5 ,
zh-tw.big5.utf-8: Traditional Chinese BIG 5 with UTF-8 - Deprecated ,
zh-tw: Traditional Chinese EUC-TW ,
zh-tw.utf-8: Traditional Chinese EUC-TW with UTF-8 - Deprecated ,
sk: Slovak - Deprecated ,
sk.utf-8: Slovak with UTF-8 ,
sl: Slovenian - Deprecated ,
sl.utf-8: Slovenian with UTF-8 ,
es: Spanish - Deprecated ,
es.utf-8: Spanish with UTF-8 ,
sv: Swedish - Deprecated ,
sv.utf-8: Swedish with UTF-8 ,
tr: Turkish - Deprecated ,
tr.utf-8: Turkish with UTF-8 ,
en-us: US English - Deprecated ,
en-us.utf-8: US English with UTF-8 ,
}
,
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 ,
}
,
]
,
}
,
}
Volumes_Delete (new)
Description :  Delete the specified volume
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
forceDelete:
{
Description: An option to force delete the volume. Will cleanup resources connected to the particular volume ,
Required: False ,
}
boolean ,
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_PopulateAvailabilityZone (new)
Description :  This operation will populate availability zone information for a volume
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/populateAvailabilityZone
{
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 ,
volumeName:
{
Description: The name of the volume ,
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 ,
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 ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
Description: If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
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 ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective 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 ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
Description: What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
Description: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
Description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Required: False ,
}
number ,
encryptionKeySource:
{
Description: Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
Description: coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage. ,
Enum:
{
Default: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
Description: UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. Avoid passing null value for unixPermissions in volume update operation, As per the behavior, If Null value is passed then user-visible unixPermissions value will became null, and user will not be able to get unixPermissions value. On safer side, actual unixPermissions value on volume will remain as its last saved value only. ,
Required: False ,
}
string ,
cloneProgress:
{
Description: When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
Description: Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
language:
{
Description: Language supported for volume. ,
Enum:
{
c.utf-8: Posix with UTF-8 ,
utf8mb4: UTF-8 with 4 byte character support ,
ar: Arabic - Deprecated ,
ar.utf-8: Arabic with UTF-8 ,
hr: Croatian - Deprecated ,
hr.utf-8: Croatian with UTF-8 ,
cs: Czech - Deprecated ,
cs.utf-8: Czech with UTF-8 ,
da: Danish - Deprecated ,
da.utf-8: Danish with UTF-8 ,
nl: Dutch - Deprecated ,
nl.utf-8: Dutch with UTF-8 ,
en: English - Deprecated ,
en.utf-8: English with UTF-8 ,
fi: Finnish - Deprecated ,
fi.utf-8: Finnish with UTF-8 ,
fr: French - Deprecated ,
fr.utf-8: French with UTF-8 ,
de: German - Deprecated ,
de.utf-8: German with UTF-8 ,
he: Hebrew - Deprecated ,
he.utf-8: Hebrew with UTF-8 ,
hu: Hungarian - Deprecated ,
hu.utf-8: Hungarian with UTF-8 ,
it: Italian - Deprecated ,
it.utf-8: Italian with UTF-8 ,
ja: Japanese euc-j - Deprecated ,
ja.utf-8: Japanese euc-j with UTF-8 ,
ja-v1: Japanese euc-j - Deprecated ,
ja-v1.utf-8: Japanese euc-j with UTF-8 ,
ja-jp.pck: Japanese pck ,
ja-jp.pck.utf-8: Japanese pck with UTF-8 - Deprecated ,
ja-jp.932: Japanese cp932 ,
ja-jp.932.utf-8: Japanese cp932 with UTF-8 - Deprecated ,
ja-jp.pck-v2: Japanese pck - sjis ,
ja-jp.pck-v2.utf-8: Japanese pck - sjis with UTF-8 - Deprecated ,
ko: Korean - Deprecated ,
ko.utf-8: Korean with UTF-8 ,
no: Norwegian - Deprecated ,
no.utf-8: Norwegian with UTF-8 ,
pl: Polish - Deprecated ,
pl.utf-8: Polish with UTF-8 ,
pt: Portuguese - Deprecated ,
pt.utf-8: Portuguese with UTF-8 ,
c: Posix - Deprecated ,
ro: Romanian - Deprecated ,
ro.utf-8: Romanian with UTF-8 ,
ru: Russian - Deprecated ,
ru.utf-8: Russian with UTF-8 ,
zh: Simplified Chinese - Deprecated ,
zh.utf-8: Simplified Chinese with UTF-8 ,
zh.gbk: Simplified gbk Chinese ,
zh.gbk.utf-8: Simplified gbk Chinese with UTF-8 - Deprecated ,
zh-tw.big5: Traditional Chinese BIG 5 ,
zh-tw.big5.utf-8: Traditional Chinese BIG 5 with UTF-8 - Deprecated ,
zh-tw: Traditional Chinese EUC-TW ,
zh-tw.utf-8: Traditional Chinese EUC-TW with UTF-8 - Deprecated ,
sk: Slovak - Deprecated ,
sk.utf-8: Slovak with UTF-8 ,
sl: Slovenian - Deprecated ,
sl.utf-8: Slovenian with UTF-8 ,
es: Spanish - Deprecated ,
es.utf-8: Spanish with UTF-8 ,
sv: Swedish - Deprecated ,
sv.utf-8: Swedish with UTF-8 ,
tr: Turkish - Deprecated ,
tr.utf-8: Turkish with UTF-8 ,
en-us: US English - Deprecated ,
en-us.utf-8: US English with UTF-8 ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Volumes_Revert (new)
Description :  Revert a volume to the snapshot specified in the body
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/revert
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Object for snapshot to revert supplied in the body of the operation. ,
Required: True ,
}
{
snapshotId:
{
Description: Resource id of the snapshot ,
Format: arm-id ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
Volumes_ResetCifsPassword (new)
Description :  Reset cifs password from volume
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/resetCifsPassword
{
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 ,
volumeName:
{
Description: The name of the volume ,
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 ,
}
,
]
,
}
,
}
Volumes_SplitCloneFromParent (new)
Description :  Split operation to convert clone volume to an independent volume.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/splitCloneFromParent
{
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 ,
volumeName:
{
Description: The name of the volume ,
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 ,
}
,
]
,
}
,
}
Volumes_BreakFileLocks (new)
Description :  Break all the file locks on a volume
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakFileLocks
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Optional body to provide the ability to clear file locks with selected options ,
Required: False ,
}
{
clientIp:
{
Description: To clear file locks on a volume for a particular client ,
Required: False ,
}
string ,
confirmRunningDisruptiveOperation:
{
Description: Break File locks could be a disruptive operation for application as locks on the volume will be broken, if want to process, set to true. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Volumes_ListGetGroupIdListForLdapUser (new)
Description :  Returns the list of group Ids for a specific LDAP User
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/getGroupIdListForLdapUser
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Returns group Id list for a specific LDAP user ,
Required: True ,
}
{
username:
{
Description: username is required to fetch the group to which user is part of ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
groupIdsForLdapUser:
{
Description: Group Id list ,
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 ,
}
,
]
,
}
,
}
Volumes_ListQuotaReport (new)
Description :  Returns report of quotas for the volume
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/listQuotaReport
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of volume quota report records ,
Required: False ,
}
[
{
quotaType:
{
Description: Type of quota ,
Enum:
{
DefaultUserQuota: Default user quota ,
DefaultGroupQuota: Default group quota ,
IndividualUserQuota: Individual user quota ,
IndividualGroupQuota: Individual group quota ,
}
,
Required: False ,
}
enum ,
quotaTarget:
{
Description: UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running ,
Required: False ,
}
string ,
quotaLimitUsedInKiBs:
{
Description: Specifies the current usage in kibibytes for the user/group quota. ,
Format: int64 ,
Required: False ,
}
integer ,
quotaLimitTotalInKiBs:
{
Description: Specifies the total size limit in kibibytes for the user/group quota. ,
Format: int64 ,
Required: False ,
}
integer ,
percentageUsed:
{
Description: Percentage of used size compared to total size. ,
Required: False ,
}
number ,
isDerivedQuota:
{
Description: Flag to indicate whether the quota is derived from default quota. ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results. ,
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 ,
}
,
]
,
}
,
}
Volumes_BreakReplication (new)
Description :  Break the replication connection on the destination volume
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakReplication
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Optional body to force break the replication. ,
Required: False ,
}
{
forceBreakReplication:
{
Description: If replication is in status transferring and you want to force break the replication, set to true ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Volumes_ReestablishReplication (new)
Description :  Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reestablishReplication
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: body for the id of the source volume. ,
Required: True ,
}
{
sourceVolumeId:
{
Description: Resource id of the source volume for the replication ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Volumes_ReplicationStatus (new)
Description :  Get the status of the replication
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/replicationStatus
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
healthy:
{
Description: Replication health check ,
Required: False ,
}
boolean ,
relationshipStatus:
{
Description: Status of the mirror relationship ,
Enum:
{
Idle: No description available. ,
Transferring: No description available. ,
}
,
Required: False ,
}
enum ,
mirrorState:
{
Description: The status of the replication ,
Enum:
{
Uninitialized: No description available. ,
Mirrored: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
totalProgress:
{
Description: The progress of the replication ,
Required: False ,
}
string ,
errorMessage:
{
Description: Displays error message if the replication is in an error state ,
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 ,
}
,
]
,
}
,
}
Volumes_ListReplications (new)
Description :  List all replications for a specified volume
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/listReplications
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of replications ,
Required: False ,
}
[
{
replicationId:
{
Description: UUID v4 used to identify the replication. ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. ,
Required: True ,
}
string ,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
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 ,
}
,
]
,
}
,
}
Volumes_ResyncReplication (new)
Description :  Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/resyncReplication
{
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 ,
volumeName:
{
Description: The name of the volume ,
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 ,
}
,
]
,
}
,
}
Volumes_DeleteReplication (new)
Description :  Delete the replication connection on the destination volume, and send release to the source replication
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/deleteReplication
{
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 ,
volumeName:
{
Description: The name of the volume ,
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 ,
}
,
]
,
}
,
}
Volumes_AuthorizeReplication (new)
Description :  Authorize the replication connection on the source volume
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/authorizeReplication
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Authorize request object supplied in the body of the operation. ,
Required: True ,
}
{
remoteVolumeResourceId:
{
Description: Resource id of the remote volume ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
Volumes_ReInitializeReplication (new)
Description :  Re-Initializes the replication connection on the destination volume
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reinitializeReplication
{
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 ,
volumeName:
{
Description: The name of the volume ,
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 ,
}
,
]
,
}
,
}
Volumes_PeerExternalCluster (new)
Description :  Starts peering the external cluster for this migration volume
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/peerExternalCluster
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Cluster peer request object supplied in the body of the operation. ,
Required: True ,
}
{
peerIpAddresses:
{
Description: A list of IC-LIF IPs that can be used to connect to the On-prem cluster ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
peerAcceptCommand:
{
Description: A command that needs to be run on the external ONTAP to accept cluster peering. Will only be present if clusterPeeringStatus is pending ,
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 ,
}
,
]
,
}
,
}
Volumes_AuthorizeExternalReplication (new)
Description :  Starts SVM peering and returns a command to be run on the external ONTAP to accept it. Once the SVM have been peered a SnapMirror will be created
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/authorizeExternalReplication
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
svmPeeringCommand:
{
Description: A command that needs to be run on the external ONTAP to accept svm peering. Will only be present if svmPeeringStatus is pending ,
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 ,
}
,
]
,
}
,
}
Volumes_FinalizeExternalReplication (new)
Description :  Finalizes the migration of an external volume by releasing the replication and breaking the external cluster peering if no other migration is active.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/finalizeExternalReplication
{
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 ,
volumeName:
{
Description: The name of the volume ,
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 ,
}
,
]
,
}
,
}
Volumes_PerformReplicationTransfer (new)
Description :  Performs an adhoc replication transfer on a volume with volumeType Migration
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/performReplicationTransfer
{
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 ,
volumeName:
{
Description: The name of the volume ,
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 ,
}
,
]
,
}
,
}
Volumes_PoolChange (new)
Description :  Moves volume to another pool
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/poolChange
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Move volume to the pool supplied in the body of the operation. ,
Required: True ,
}
{
newPoolResourceId:
{
Description: Resource id of the pool to move volume to ,
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 ,
}
,
]
,
}
,
}
Volumes_Relocate (new)
Description :  Relocates volume to a new stamp
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/relocate
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Relocate volume request ,
Required: False ,
}
{
creationToken:
{
Description: New creation token for the volume that controls the mount point name ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
Volumes_FinalizeRelocation (new)
Description :  Finalizes the relocation of the volume and cleans up the old volume.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/finalizeRelocation
{
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 ,
volumeName:
{
Description: The name of the volume ,
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 ,
}
,
]
,
}
,
}
Volumes_RevertRelocation (new)
Description :  Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/revertRelocation
{
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 ,
volumeName:
{
Description: The name of the volume ,
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 ,
}
,
]
,
}
,
}
Snapshots_List (new)
Description :  List all snapshots associated with the volume
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Snapshots ,
Required: False ,
}
[
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
properties:
{
Description: Snapshot Properties ,
Required: False ,
}
{
snapshotId:
{
Description: UUID v4 used to identify the Snapshot ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the snapshot ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
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 ,
}
,
]
,
}
,
}
Snapshots_Get (new)
Description :  Get details of the specified snapshot
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
snapshotName:
{
Description: The name of the snapshot ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
properties:
{
Description: Snapshot Properties ,
Required: False ,
}
{
snapshotId:
{
Description: UUID v4 used to identify the Snapshot ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the snapshot ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
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 ,
}
,
]
,
}
,
}
Snapshots_Create (new)
Description :  Create the specified snapshot within the given volume
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}
{
body:
{
Description: Snapshot object supplied in the body of the operation. ,
Required: True ,
}
{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
properties:
{
Description: Snapshot Properties ,
Required: False ,
}
{
snapshotId:
{
Description: UUID v4 used to identify the Snapshot ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the snapshot ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}
,
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
snapshotName:
{
Description: The name of the snapshot ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
properties:
{
Description: Snapshot Properties ,
Required: False ,
}
{
snapshotId:
{
Description: UUID v4 used to identify the Snapshot ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the snapshot ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Snapshots_Update (new)
Description :  Patch a snapshot
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}
{
body:
{
Description: Snapshot object supplied in the body of the operation. ,
Required: True ,
}
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 ,
poolName:
{
Description: The name of the capacity pool ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
snapshotName:
{
Description: The name of the snapshot ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource location ,
Required: True ,
}
string ,
properties:
{
Description: Snapshot Properties ,
Required: False ,
}
{
snapshotId:
{
Description: UUID v4 used to identify the Snapshot ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the snapshot ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Snapshots_Delete (new)
Description :  Delete snapshot
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
snapshotName:
{
Description: The name of the snapshot ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Snapshots_RestoreFiles (new)
Description :  Restore the specified files from the specified snapshot to the active filesystem
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}/restoreFiles
{
body:
{
Description: Restore payload supplied in the body of the operation. ,
Required: True ,
}
{
filePaths:
{
Description: List of files to be restored ,
Required: True ,
}
[
string ,
]
,
destinationPath:
{
Description: Destination folder where the files will be restored ,
Required: False ,
}
string ,
}
,
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
snapshotName:
{
Description: The name of the snapshot ,
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 ,
}
,
]
,
}
,
}
SnapshotPolicies_List (new)
Description :  List snapshot policy
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies
{
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: A list of snapshot policies ,
Required: False ,
}
[
{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: Snapshot policy Properties ,
Required: True ,
}
{
hourlySchedule:
{
Description: Schedule for hourly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Hourly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
dailySchedule:
{
Description: Schedule for daily snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Daily snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
weeklySchedule:
{
Description: Schedule for weekly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Weekly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
day:
{
Description: Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english ,
Required: False ,
}
string ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
monthlySchedule:
{
Description: Schedule for monthly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Monthly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfMonth:
{
Description: Indicates which days of the month snapshot should be taken. A comma delimited string. ,
Required: False ,
}
string ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
enabled:
{
Description: The property to decide policy is enabled or not ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Azure lifecycle management ,
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 ,
}
,
]
,
}
,
}
SnapshotPolicies_Get (new)
Description :  Get a snapshot Policy
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}
{
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 ,
snapshotPolicyName:
{
Description: The name of the snapshot policy ,
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: Snapshot policy Properties ,
Required: True ,
}
{
hourlySchedule:
{
Description: Schedule for hourly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Hourly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
dailySchedule:
{
Description: Schedule for daily snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Daily snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
weeklySchedule:
{
Description: Schedule for weekly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Weekly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
day:
{
Description: Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english ,
Required: False ,
}
string ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
monthlySchedule:
{
Description: Schedule for monthly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Monthly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfMonth:
{
Description: Indicates which days of the month snapshot should be taken. A comma delimited string. ,
Required: False ,
}
string ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
enabled:
{
Description: The property to decide policy is enabled or not ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Azure lifecycle management ,
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 ,
}
,
]
,
}
,
}
SnapshotPolicies_Create (new)
Description :  Create a snapshot policy
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}
{
body:
{
Description: Snapshot policy 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: Snapshot policy Properties ,
Required: True ,
}
{
hourlySchedule:
{
Description: Schedule for hourly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Hourly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
dailySchedule:
{
Description: Schedule for daily snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Daily snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
weeklySchedule:
{
Description: Schedule for weekly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Weekly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
day:
{
Description: Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english ,
Required: False ,
}
string ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
monthlySchedule:
{
Description: Schedule for monthly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Monthly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfMonth:
{
Description: Indicates which days of the month snapshot should be taken. A comma delimited string. ,
Required: False ,
}
string ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
enabled:
{
Description: The property to decide policy is enabled or not ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}
,
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 ,
snapshotPolicyName:
{
Description: The name of the snapshot policy ,
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: Snapshot policy Properties ,
Required: True ,
}
{
hourlySchedule:
{
Description: Schedule for hourly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Hourly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
dailySchedule:
{
Description: Schedule for daily snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Daily snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
weeklySchedule:
{
Description: Schedule for weekly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Weekly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
day:
{
Description: Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english ,
Required: False ,
}
string ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
monthlySchedule:
{
Description: Schedule for monthly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Monthly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfMonth:
{
Description: Indicates which days of the month snapshot should be taken. A comma delimited string. ,
Required: False ,
}
string ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
enabled:
{
Description: The property to decide policy is enabled or not ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: Snapshot policy Properties ,
Required: True ,
}
{
hourlySchedule:
{
Description: Schedule for hourly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Hourly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
dailySchedule:
{
Description: Schedule for daily snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Daily snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
weeklySchedule:
{
Description: Schedule for weekly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Weekly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
day:
{
Description: Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english ,
Required: False ,
}
string ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
monthlySchedule:
{
Description: Schedule for monthly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Monthly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfMonth:
{
Description: Indicates which days of the month snapshot should be taken. A comma delimited string. ,
Required: False ,
}
string ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
enabled:
{
Description: The property to decide policy is enabled or not ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Azure lifecycle management ,
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 ,
}
,
]
,
}
,
}
SnapshotPolicies_Update (new)
Description :  Patch a snapshot policy
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}
{
body:
{
Description: Snapshot policy 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: Snapshot Policy properties ,
Required: False ,
}
{
hourlySchedule:
{
Description: Schedule for hourly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Hourly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
dailySchedule:
{
Description: Schedule for daily snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Daily snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
weeklySchedule:
{
Description: Schedule for weekly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Weekly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
day:
{
Description: Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english ,
Required: False ,
}
string ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
monthlySchedule:
{
Description: Schedule for monthly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Monthly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfMonth:
{
Description: Indicates which days of the month snapshot should be taken. A comma delimited string. ,
Required: False ,
}
string ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
enabled:
{
Description: The property to decide policy is enabled or not ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}
,
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 ,
snapshotPolicyName:
{
Description: The name of the snapshot policy ,
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: Snapshot policy Properties ,
Required: True ,
}
{
hourlySchedule:
{
Description: Schedule for hourly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Hourly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
dailySchedule:
{
Description: Schedule for daily snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Daily snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
weeklySchedule:
{
Description: Schedule for weekly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Weekly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
day:
{
Description: Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english ,
Required: False ,
}
string ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
monthlySchedule:
{
Description: Schedule for monthly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Monthly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfMonth:
{
Description: Indicates which days of the month snapshot should be taken. A comma delimited string. ,
Required: False ,
}
string ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
enabled:
{
Description: The property to decide policy is enabled or not ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: Snapshot policy Properties ,
Required: True ,
}
{
hourlySchedule:
{
Description: Schedule for hourly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Hourly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
dailySchedule:
{
Description: Schedule for daily snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Daily snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
weeklySchedule:
{
Description: Schedule for weekly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Weekly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
day:
{
Description: Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english ,
Required: False ,
}
string ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
monthlySchedule:
{
Description: Schedule for monthly snapshots ,
Required: False ,
}
{
snapshotsToKeep:
{
Description: Monthly snapshot count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
daysOfMonth:
{
Description: Indicates which days of the month snapshot should be taken. A comma delimited string. ,
Required: False ,
}
string ,
hour:
{
Description: Indicates which hour in UTC timezone a snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
minute:
{
Description: Indicates which minute snapshot should be taken ,
Format: int32 ,
Required: False ,
}
integer ,
usedBytes:
{
Description: Resource size in bytes, current storage usage for the volume in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
enabled:
{
Description: The property to decide policy is enabled or not ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Azure lifecycle management ,
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 ,
}
,
]
,
}
,
}
SnapshotPolicies_Delete (new)
Description :  Delete snapshot policy
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}
{
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 ,
snapshotPolicyName:
{
Description: The name of the snapshot policy ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
SnapshotPolicies_ListVolumes (new)
Description :  Get volumes associated with snapshot policy
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}/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 ,
snapshotPolicyName:
{
Description: The name of the snapshot policy ,
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 ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
Description: If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
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 ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective 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 ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
Description: What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
Description: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
Description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Required: False ,
}
number ,
encryptionKeySource:
{
Description: Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
Description: coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage. ,
Enum:
{
Default: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
Description: UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. Avoid passing null value for unixPermissions in volume update operation, As per the behavior, If Null value is passed then user-visible unixPermissions value will became null, and user will not be able to get unixPermissions value. On safer side, actual unixPermissions value on volume will remain as its last saved value only. ,
Required: False ,
}
string ,
cloneProgress:
{
Description: When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
Description: Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
language:
{
Description: Language supported for volume. ,
Enum:
{
c.utf-8: Posix with UTF-8 ,
utf8mb4: UTF-8 with 4 byte character support ,
ar: Arabic - Deprecated ,
ar.utf-8: Arabic with UTF-8 ,
hr: Croatian - Deprecated ,
hr.utf-8: Croatian with UTF-8 ,
cs: Czech - Deprecated ,
cs.utf-8: Czech with UTF-8 ,
da: Danish - Deprecated ,
da.utf-8: Danish with UTF-8 ,
nl: Dutch - Deprecated ,
nl.utf-8: Dutch with UTF-8 ,
en: English - Deprecated ,
en.utf-8: English with UTF-8 ,
fi: Finnish - Deprecated ,
fi.utf-8: Finnish with UTF-8 ,
fr: French - Deprecated ,
fr.utf-8: French with UTF-8 ,
de: German - Deprecated ,
de.utf-8: German with UTF-8 ,
he: Hebrew - Deprecated ,
he.utf-8: Hebrew with UTF-8 ,
hu: Hungarian - Deprecated ,
hu.utf-8: Hungarian with UTF-8 ,
it: Italian - Deprecated ,
it.utf-8: Italian with UTF-8 ,
ja: Japanese euc-j - Deprecated ,
ja.utf-8: Japanese euc-j with UTF-8 ,
ja-v1: Japanese euc-j - Deprecated ,
ja-v1.utf-8: Japanese euc-j with UTF-8 ,
ja-jp.pck: Japanese pck ,
ja-jp.pck.utf-8: Japanese pck with UTF-8 - Deprecated ,
ja-jp.932: Japanese cp932 ,
ja-jp.932.utf-8: Japanese cp932 with UTF-8 - Deprecated ,
ja-jp.pck-v2: Japanese pck - sjis ,
ja-jp.pck-v2.utf-8: Japanese pck - sjis with UTF-8 - Deprecated ,
ko: Korean - Deprecated ,
ko.utf-8: Korean with UTF-8 ,
no: Norwegian - Deprecated ,
no.utf-8: Norwegian with UTF-8 ,
pl: Polish - Deprecated ,
pl.utf-8: Polish with UTF-8 ,
pt: Portuguese - Deprecated ,
pt.utf-8: Portuguese with UTF-8 ,
c: Posix - Deprecated ,
ro: Romanian - Deprecated ,
ro.utf-8: Romanian with UTF-8 ,
ru: Russian - Deprecated ,
ru.utf-8: Russian with UTF-8 ,
zh: Simplified Chinese - Deprecated ,
zh.utf-8: Simplified Chinese with UTF-8 ,
zh.gbk: Simplified gbk Chinese ,
zh.gbk.utf-8: Simplified gbk Chinese with UTF-8 - Deprecated ,
zh-tw.big5: Traditional Chinese BIG 5 ,
zh-tw.big5.utf-8: Traditional Chinese BIG 5 with UTF-8 - Deprecated ,
zh-tw: Traditional Chinese EUC-TW ,
zh-tw.utf-8: Traditional Chinese EUC-TW with UTF-8 - Deprecated ,
sk: Slovak - Deprecated ,
sk.utf-8: Slovak with UTF-8 ,
sl: Slovenian - Deprecated ,
sl.utf-8: Slovenian with UTF-8 ,
es: Spanish - Deprecated ,
es.utf-8: Spanish with UTF-8 ,
sv: Swedish - Deprecated ,
sv.utf-8: Swedish with UTF-8 ,
tr: Turkish - Deprecated ,
tr.utf-8: Turkish with UTF-8 ,
en-us: US English - Deprecated ,
en-us.utf-8: US English with UTF-8 ,
}
,
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 ,
}
,
]
,
}
,
}
BackupPolicies_List (new)
Description :  List backup policies for Netapp Account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies
{
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: A list of backup policies ,
Required: False ,
}
[
{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: Backup policy Properties ,
Required: True ,
}
{
backupPolicyId:
{
Description: Backup Policy GUID ID ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
dailyBackupsToKeep:
{
Description: Daily backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
weeklyBackupsToKeep:
{
Description: Weekly backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyBackupsToKeep:
{
Description: Monthly backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
volumesAssigned:
{
Description: Volumes using current backup policy ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: The property to decide policy is enabled or not ,
Required: False ,
}
boolean ,
volumeBackups:
{
Description: A list of volumes assigned to this policy ,
Required: False ,
}
[
{
volumeName:
{
Description: Volume name ,
Required: False ,
}
string ,
volumeResourceId:
{
Description: ResourceId used to identify the Volume ,
Format: arm-id ,
Required: False ,
}
string ,
backupsCount:
{
Description: Total count of backups for volume ,
Format: int32 ,
Required: False ,
}
integer ,
policyEnabled:
{
Description: Policy enabled ,
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 ,
}
,
]
,
}
,
}
BackupPolicies_Get (new)
Description :  Get a particular backup Policy
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies/{backupPolicyName}
{
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 ,
backupPolicyName:
{
Description: Backup policy Name which uniquely identify backup policy. ,
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: Backup policy Properties ,
Required: True ,
}
{
backupPolicyId:
{
Description: Backup Policy GUID ID ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
dailyBackupsToKeep:
{
Description: Daily backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
weeklyBackupsToKeep:
{
Description: Weekly backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyBackupsToKeep:
{
Description: Monthly backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
volumesAssigned:
{
Description: Volumes using current backup policy ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: The property to decide policy is enabled or not ,
Required: False ,
}
boolean ,
volumeBackups:
{
Description: A list of volumes assigned to this policy ,
Required: False ,
}
[
{
volumeName:
{
Description: Volume name ,
Required: False ,
}
string ,
volumeResourceId:
{
Description: ResourceId used to identify the Volume ,
Format: arm-id ,
Required: False ,
}
string ,
backupsCount:
{
Description: Total count of backups for volume ,
Format: int32 ,
Required: False ,
}
integer ,
policyEnabled:
{
Description: Policy enabled ,
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 ,
}
,
]
,
}
,
}
BackupPolicies_Create (new)
Description :  Create a backup policy for Netapp Account
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies/{backupPolicyName}
{
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 ,
backupPolicyName:
{
Description: Backup policy Name which uniquely identify backup policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Backup policy 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: Backup policy Properties ,
Required: True ,
}
{
backupPolicyId:
{
Description: Backup Policy GUID ID ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
dailyBackupsToKeep:
{
Description: Daily backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
weeklyBackupsToKeep:
{
Description: Weekly backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyBackupsToKeep:
{
Description: Monthly backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
volumesAssigned:
{
Description: Volumes using current backup policy ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: The property to decide policy is enabled or not ,
Required: False ,
}
boolean ,
volumeBackups:
{
Description: A list of volumes assigned to this policy ,
Required: False ,
}
[
{
volumeName:
{
Description: Volume name ,
Required: False ,
}
string ,
volumeResourceId:
{
Description: ResourceId used to identify the Volume ,
Format: arm-id ,
Required: False ,
}
string ,
backupsCount:
{
Description: Total count of backups for volume ,
Format: int32 ,
Required: False ,
}
integer ,
policyEnabled:
{
Description: Policy enabled ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: Backup policy Properties ,
Required: True ,
}
{
backupPolicyId:
{
Description: Backup Policy GUID ID ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
dailyBackupsToKeep:
{
Description: Daily backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
weeklyBackupsToKeep:
{
Description: Weekly backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyBackupsToKeep:
{
Description: Monthly backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
volumesAssigned:
{
Description: Volumes using current backup policy ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: The property to decide policy is enabled or not ,
Required: False ,
}
boolean ,
volumeBackups:
{
Description: A list of volumes assigned to this policy ,
Required: False ,
}
[
{
volumeName:
{
Description: Volume name ,
Required: False ,
}
string ,
volumeResourceId:
{
Description: ResourceId used to identify the Volume ,
Format: arm-id ,
Required: False ,
}
string ,
backupsCount:
{
Description: Total count of backups for volume ,
Format: int32 ,
Required: False ,
}
integer ,
policyEnabled:
{
Description: Policy enabled ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (201)

{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: Backup policy Properties ,
Required: True ,
}
{
backupPolicyId:
{
Description: Backup Policy GUID ID ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
dailyBackupsToKeep:
{
Description: Daily backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
weeklyBackupsToKeep:
{
Description: Weekly backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyBackupsToKeep:
{
Description: Monthly backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
volumesAssigned:
{
Description: Volumes using current backup policy ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: The property to decide policy is enabled or not ,
Required: False ,
}
boolean ,
volumeBackups:
{
Description: A list of volumes assigned to this policy ,
Required: False ,
}
[
{
volumeName:
{
Description: Volume name ,
Required: False ,
}
string ,
volumeResourceId:
{
Description: ResourceId used to identify the Volume ,
Format: arm-id ,
Required: False ,
}
string ,
backupsCount:
{
Description: Total count of backups for volume ,
Format: int32 ,
Required: False ,
}
integer ,
policyEnabled:
{
Description: Policy enabled ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
BackupPolicies_Update (new)
Description :  Patch a backup policy for Netapp Account
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies/{backupPolicyName}
{
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 ,
backupPolicyName:
{
Description: Backup policy Name which uniquely identify backup policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Backup policy 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: Backup policy Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy GUID ID ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
dailyBackupsToKeep:
{
Description: Daily backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
weeklyBackupsToKeep:
{
Description: Weekly backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyBackupsToKeep:
{
Description: Monthly backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
volumesAssigned:
{
Description: Volumes using current backup policy ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: The property to decide policy is enabled or not ,
Required: False ,
}
boolean ,
volumeBackups:
{
Description: A list of volumes assigned to this policy ,
Required: False ,
}
[
{
volumeName:
{
Description: Volume name ,
Required: False ,
}
string ,
volumeResourceId:
{
Description: ResourceId used to identify the Volume ,
Format: arm-id ,
Required: False ,
}
string ,
backupsCount:
{
Description: Total count of backups for volume ,
Format: int32 ,
Required: False ,
}
integer ,
policyEnabled:
{
Description: Policy enabled ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: Backup policy Properties ,
Required: True ,
}
{
backupPolicyId:
{
Description: Backup Policy GUID ID ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
dailyBackupsToKeep:
{
Description: Daily backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
weeklyBackupsToKeep:
{
Description: Weekly backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyBackupsToKeep:
{
Description: Monthly backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
volumesAssigned:
{
Description: Volumes using current backup policy ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: The property to decide policy is enabled or not ,
Required: False ,
}
boolean ,
volumeBackups:
{
Description: A list of volumes assigned to this policy ,
Required: False ,
}
[
{
volumeName:
{
Description: Volume name ,
Required: False ,
}
string ,
volumeResourceId:
{
Description: ResourceId used to identify the Volume ,
Format: arm-id ,
Required: False ,
}
string ,
backupsCount:
{
Description: Total count of backups for volume ,
Format: int32 ,
Required: False ,
}
integer ,
policyEnabled:
{
Description: Policy enabled ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (202)

{
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
properties:
{
Description: Backup policy Properties ,
Required: True ,
}
{
backupPolicyId:
{
Description: Backup Policy GUID ID ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
dailyBackupsToKeep:
{
Description: Daily backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
weeklyBackupsToKeep:
{
Description: Weekly backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
monthlyBackupsToKeep:
{
Description: Monthly backups count to keep ,
Format: int32 ,
Required: False ,
}
integer ,
volumesAssigned:
{
Description: Volumes using current backup policy ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: The property to decide policy is enabled or not ,
Required: False ,
}
boolean ,
volumeBackups:
{
Description: A list of volumes assigned to this policy ,
Required: False ,
}
[
{
volumeName:
{
Description: Volume name ,
Required: False ,
}
string ,
volumeResourceId:
{
Description: ResourceId used to identify the Volume ,
Format: arm-id ,
Required: False ,
}
string ,
backupsCount:
{
Description: Total count of backups for volume ,
Format: int32 ,
Required: False ,
}
integer ,
policyEnabled:
{
Description: Policy enabled ,
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 ,
}
,
]
,
}
,
}
BackupPolicies_Delete (new)
Description :  Delete backup policy
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies/{backupPolicyName}
{
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 ,
backupPolicyName:
{
Description: Backup policy Name which uniquely identify backup policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
VolumeQuotaRules_ListByVolume (new)
Description :  List all quota rules associated with the volume
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Volume Quota Rules ,
Required: False ,
}
[
{
properties:
{
Description: Volume Quota Rule Properties ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the VolumeQuotaRule at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Patching: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
quotaSizeInKiBs:
{
Description: Size of quota ,
Format: int64 ,
Required: False ,
}
integer ,
quotaType:
{
Description: Type of quota ,
Enum:
{
DefaultUserQuota: Default user quota ,
DefaultGroupQuota: Default group quota ,
IndividualUserQuota: Individual user quota ,
IndividualGroupQuota: Individual group quota ,
}
,
Required: False ,
}
enum ,
quotaTarget:
{
Description: UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running ,
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 ,
}
,
]
,
}
,
}
VolumeQuotaRules_Get (new)
Description :  Get details of the specified quota rule
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
volumeQuotaRuleName:
{
Description: The name of volume quota rule ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Volume Quota Rule Properties ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the VolumeQuotaRule at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Patching: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
quotaSizeInKiBs:
{
Description: Size of quota ,
Format: int64 ,
Required: False ,
}
integer ,
quotaType:
{
Description: Type of quota ,
Enum:
{
DefaultUserQuota: Default user quota ,
DefaultGroupQuota: Default group quota ,
IndividualUserQuota: Individual user quota ,
IndividualGroupQuota: Individual group quota ,
}
,
Required: False ,
}
enum ,
quotaTarget:
{
Description: UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running ,
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 ,
}
,
]
,
}
,
}
VolumeQuotaRules_Create (new)
Description :  Create the specified quota rule within the given volume
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}
{
body:
{
Description: Quota rule object supplied in the body of the operation. ,
Required: True ,
}
{
properties:
{
Description: Volume Quota Rule Properties ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the VolumeQuotaRule at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Patching: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
quotaSizeInKiBs:
{
Description: Size of quota ,
Format: int64 ,
Required: False ,
}
integer ,
quotaType:
{
Description: Type of quota ,
Enum:
{
DefaultUserQuota: Default user quota ,
DefaultGroupQuota: Default group quota ,
IndividualUserQuota: Individual user quota ,
IndividualGroupQuota: Individual group quota ,
}
,
Required: False ,
}
enum ,
quotaTarget:
{
Description: UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running ,
Required: False ,
}
string ,
}
,
}
,
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
volumeQuotaRuleName:
{
Description: The name of volume quota rule ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Volume Quota Rule Properties ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the VolumeQuotaRule at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Patching: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
quotaSizeInKiBs:
{
Description: Size of quota ,
Format: int64 ,
Required: False ,
}
integer ,
quotaType:
{
Description: Type of quota ,
Enum:
{
DefaultUserQuota: Default user quota ,
DefaultGroupQuota: Default group quota ,
IndividualUserQuota: Individual user quota ,
IndividualGroupQuota: Individual group quota ,
}
,
Required: False ,
}
enum ,
quotaTarget:
{
Description: UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Volume Quota Rule Properties ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the VolumeQuotaRule at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Patching: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
quotaSizeInKiBs:
{
Description: Size of quota ,
Format: int64 ,
Required: False ,
}
integer ,
quotaType:
{
Description: Type of quota ,
Enum:
{
DefaultUserQuota: Default user quota ,
DefaultGroupQuota: Default group quota ,
IndividualUserQuota: Individual user quota ,
IndividualGroupQuota: Individual group quota ,
}
,
Required: False ,
}
enum ,
quotaTarget:
{
Description: UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running ,
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 ,
}
,
]
,
}
,
}
VolumeQuotaRules_Update (new)
Description :  Patch a quota rule
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}
{
body:
{
Description: Quota rule object supplied in the body of the operation. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Volume Quota Rule Properties ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the VolumeQuotaRule at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Patching: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
quotaSizeInKiBs:
{
Description: Size of quota ,
Format: int64 ,
Required: False ,
}
integer ,
quotaType:
{
Description: Type of quota ,
Enum:
{
DefaultUserQuota: Default user quota ,
DefaultGroupQuota: Default group quota ,
IndividualUserQuota: Individual user quota ,
IndividualGroupQuota: Individual group quota ,
}
,
Required: False ,
}
enum ,
quotaTarget:
{
Description: UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running ,
Required: False ,
}
string ,
}
,
}
,
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
volumeQuotaRuleName:
{
Description: The name of volume quota rule ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Volume Quota Rule Properties ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the VolumeQuotaRule at the time the operation was called. ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Patching: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
quotaSizeInKiBs:
{
Description: Size of quota ,
Format: int64 ,
Required: False ,
}
integer ,
quotaType:
{
Description: Type of quota ,
Enum:
{
DefaultUserQuota: Default user quota ,
DefaultGroupQuota: Default group quota ,
IndividualUserQuota: Individual user quota ,
IndividualGroupQuota: Individual group quota ,
}
,
Required: False ,
}
enum ,
quotaTarget:
{
Description: UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
VolumeQuotaRules_Delete (new)
Description :  Delete quota rule
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
volumeQuotaRuleName:
{
Description: The name of volume quota rule ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
VolumeGroups_ListByNetAppAccount (new)
Description :  List all volume groups for given account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups
{
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 volume Groups ,
Required: False ,
}
[
{
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 ,
properties:
{
Description: Volume group properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
groupMetaData:
{
Description: Volume group details ,
Required: False ,
}
{
groupDescription:
{
Description: Group Description ,
Required: False ,
}
string ,
applicationType:
{
Description: Application Type ,
Enum:
{
SAP-HANA: No description available. ,
ORACLE: No description available. ,
}
,
Required: False ,
}
enum ,
applicationIdentifier:
{
Description: Application specific identifier ,
Required: False ,
}
string ,
globalPlacementRules:
{
Description: Application specific placement rules for the volume group ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
volumesCount:
{
Description: Number of volumes in volume group ,
Format: int64 ,
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 ,
}
,
]
,
}
,
}
VolumeGroups_Get (new)
Description :  Get details of the specified volume group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups/{volumeGroupName}
{
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 ,
volumeGroupName:
{
Description: The name of the volumeGroup ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
properties:
{
Description: Volume group properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
groupMetaData:
{
Description: Volume group details ,
Required: False ,
}
{
groupDescription:
{
Description: Group Description ,
Required: False ,
}
string ,
applicationType:
{
Description: Application Type ,
Enum:
{
SAP-HANA: No description available. ,
ORACLE: No description available. ,
}
,
Required: False ,
}
enum ,
applicationIdentifier:
{
Description: Application specific identifier ,
Required: False ,
}
string ,
globalPlacementRules:
{
Description: Application specific placement rules for the volume group ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
volumesCount:
{
Description: Number of volumes in volume group ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
volumes:
{
Description: List of volumes from group ,
Required: False ,
}
[
{
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 ,
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 ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
Description: If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
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 ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective 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 ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
Description: What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
Description: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
Description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Required: False ,
}
number ,
encryptionKeySource:
{
Description: Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
Description: coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage. ,
Enum:
{
Default: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
Description: UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. Avoid passing null value for unixPermissions in volume update operation, As per the behavior, If Null value is passed then user-visible unixPermissions value will became null, and user will not be able to get unixPermissions value. On safer side, actual unixPermissions value on volume will remain as its last saved value only. ,
Required: False ,
}
string ,
cloneProgress:
{
Description: When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
Description: Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
language:
{
Description: Language supported for volume. ,
Enum:
{
c.utf-8: Posix with UTF-8 ,
utf8mb4: UTF-8 with 4 byte character support ,
ar: Arabic - Deprecated ,
ar.utf-8: Arabic with UTF-8 ,
hr: Croatian - Deprecated ,
hr.utf-8: Croatian with UTF-8 ,
cs: Czech - Deprecated ,
cs.utf-8: Czech with UTF-8 ,
da: Danish - Deprecated ,
da.utf-8: Danish with UTF-8 ,
nl: Dutch - Deprecated ,
nl.utf-8: Dutch with UTF-8 ,
en: English - Deprecated ,
en.utf-8: English with UTF-8 ,
fi: Finnish - Deprecated ,
fi.utf-8: Finnish with UTF-8 ,
fr: French - Deprecated ,
fr.utf-8: French with UTF-8 ,
de: German - Deprecated ,
de.utf-8: German with UTF-8 ,
he: Hebrew - Deprecated ,
he.utf-8: Hebrew with UTF-8 ,
hu: Hungarian - Deprecated ,
hu.utf-8: Hungarian with UTF-8 ,
it: Italian - Deprecated ,
it.utf-8: Italian with UTF-8 ,
ja: Japanese euc-j - Deprecated ,
ja.utf-8: Japanese euc-j with UTF-8 ,
ja-v1: Japanese euc-j - Deprecated ,
ja-v1.utf-8: Japanese euc-j with UTF-8 ,
ja-jp.pck: Japanese pck ,
ja-jp.pck.utf-8: Japanese pck with UTF-8 - Deprecated ,
ja-jp.932: Japanese cp932 ,
ja-jp.932.utf-8: Japanese cp932 with UTF-8 - Deprecated ,
ja-jp.pck-v2: Japanese pck - sjis ,
ja-jp.pck-v2.utf-8: Japanese pck - sjis with UTF-8 - Deprecated ,
ko: Korean - Deprecated ,
ko.utf-8: Korean with UTF-8 ,
no: Norwegian - Deprecated ,
no.utf-8: Norwegian with UTF-8 ,
pl: Polish - Deprecated ,
pl.utf-8: Polish with UTF-8 ,
pt: Portuguese - Deprecated ,
pt.utf-8: Portuguese with UTF-8 ,
c: Posix - Deprecated ,
ro: Romanian - Deprecated ,
ro.utf-8: Romanian with UTF-8 ,
ru: Russian - Deprecated ,
ru.utf-8: Russian with UTF-8 ,
zh: Simplified Chinese - Deprecated ,
zh.utf-8: Simplified Chinese with UTF-8 ,
zh.gbk: Simplified gbk Chinese ,
zh.gbk.utf-8: Simplified gbk Chinese with UTF-8 - Deprecated ,
zh-tw.big5: Traditional Chinese BIG 5 ,
zh-tw.big5.utf-8: Traditional Chinese BIG 5 with UTF-8 - Deprecated ,
zh-tw: Traditional Chinese EUC-TW ,
zh-tw.utf-8: Traditional Chinese EUC-TW with UTF-8 - Deprecated ,
sk: Slovak - Deprecated ,
sk.utf-8: Slovak with UTF-8 ,
sl: Slovenian - Deprecated ,
sl.utf-8: Slovenian with UTF-8 ,
es: Spanish - Deprecated ,
es.utf-8: Spanish with UTF-8 ,
sv: Swedish - Deprecated ,
sv.utf-8: Swedish with UTF-8 ,
tr: Turkish - Deprecated ,
tr.utf-8: Turkish with UTF-8 ,
en-us: US English - Deprecated ,
en-us.utf-8: US English with UTF-8 ,
}
,
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 ,
}
,
]
,
}
,
}
VolumeGroups_Create (new)
Description :  Create a volume group along with specified volumes
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups/{volumeGroupName}
{
body:
{
Description: Volume Group 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 ,
properties:
{
Description: Volume group properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
groupMetaData:
{
Description: Volume group details ,
Required: False ,
}
{
groupDescription:
{
Description: Group Description ,
Required: False ,
}
string ,
applicationType:
{
Description: Application Type ,
Enum:
{
SAP-HANA: No description available. ,
ORACLE: No description available. ,
}
,
Required: False ,
}
enum ,
applicationIdentifier:
{
Description: Application specific identifier ,
Required: False ,
}
string ,
globalPlacementRules:
{
Description: Application specific placement rules for the volume group ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
volumesCount:
{
Description: Number of volumes in volume group ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
volumes:
{
Description: List of volumes from group ,
Required: False ,
}
[
{
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 ,
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 ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
Description: If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
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 ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective 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 ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
Description: What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
Description: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
Description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Required: False ,
}
number ,
encryptionKeySource:
{
Description: Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
Description: coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage. ,
Enum:
{
Default: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
Description: UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. Avoid passing null value for unixPermissions in volume update operation, As per the behavior, If Null value is passed then user-visible unixPermissions value will became null, and user will not be able to get unixPermissions value. On safer side, actual unixPermissions value on volume will remain as its last saved value only. ,
Required: False ,
}
string ,
cloneProgress:
{
Description: When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
Description: Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
language:
{
Description: Language supported for volume. ,
Enum:
{
c.utf-8: Posix with UTF-8 ,
utf8mb4: UTF-8 with 4 byte character support ,
ar: Arabic - Deprecated ,
ar.utf-8: Arabic with UTF-8 ,
hr: Croatian - Deprecated ,
hr.utf-8: Croatian with UTF-8 ,
cs: Czech - Deprecated ,
cs.utf-8: Czech with UTF-8 ,
da: Danish - Deprecated ,
da.utf-8: Danish with UTF-8 ,
nl: Dutch - Deprecated ,
nl.utf-8: Dutch with UTF-8 ,
en: English - Deprecated ,
en.utf-8: English with UTF-8 ,
fi: Finnish - Deprecated ,
fi.utf-8: Finnish with UTF-8 ,
fr: French - Deprecated ,
fr.utf-8: French with UTF-8 ,
de: German - Deprecated ,
de.utf-8: German with UTF-8 ,
he: Hebrew - Deprecated ,
he.utf-8: Hebrew with UTF-8 ,
hu: Hungarian - Deprecated ,
hu.utf-8: Hungarian with UTF-8 ,
it: Italian - Deprecated ,
it.utf-8: Italian with UTF-8 ,
ja: Japanese euc-j - Deprecated ,
ja.utf-8: Japanese euc-j with UTF-8 ,
ja-v1: Japanese euc-j - Deprecated ,
ja-v1.utf-8: Japanese euc-j with UTF-8 ,
ja-jp.pck: Japanese pck ,
ja-jp.pck.utf-8: Japanese pck with UTF-8 - Deprecated ,
ja-jp.932: Japanese cp932 ,
ja-jp.932.utf-8: Japanese cp932 with UTF-8 - Deprecated ,
ja-jp.pck-v2: Japanese pck - sjis ,
ja-jp.pck-v2.utf-8: Japanese pck - sjis with UTF-8 - Deprecated ,
ko: Korean - Deprecated ,
ko.utf-8: Korean with UTF-8 ,
no: Norwegian - Deprecated ,
no.utf-8: Norwegian with UTF-8 ,
pl: Polish - Deprecated ,
pl.utf-8: Polish with UTF-8 ,
pt: Portuguese - Deprecated ,
pt.utf-8: Portuguese with UTF-8 ,
c: Posix - Deprecated ,
ro: Romanian - Deprecated ,
ro.utf-8: Romanian with UTF-8 ,
ru: Russian - Deprecated ,
ru.utf-8: Russian with UTF-8 ,
zh: Simplified Chinese - Deprecated ,
zh.utf-8: Simplified Chinese with UTF-8 ,
zh.gbk: Simplified gbk Chinese ,
zh.gbk.utf-8: Simplified gbk Chinese with UTF-8 - Deprecated ,
zh-tw.big5: Traditional Chinese BIG 5 ,
zh-tw.big5.utf-8: Traditional Chinese BIG 5 with UTF-8 - Deprecated ,
zh-tw: Traditional Chinese EUC-TW ,
zh-tw.utf-8: Traditional Chinese EUC-TW with UTF-8 - Deprecated ,
sk: Slovak - Deprecated ,
sk.utf-8: Slovak with UTF-8 ,
sl: Slovenian - Deprecated ,
sl.utf-8: Slovenian with UTF-8 ,
es: Spanish - Deprecated ,
es.utf-8: Spanish with UTF-8 ,
sv: Swedish - Deprecated ,
sv.utf-8: Swedish with UTF-8 ,
tr: Turkish - Deprecated ,
tr.utf-8: Turkish with UTF-8 ,
en-us: US English - Deprecated ,
en-us.utf-8: US English with UTF-8 ,
}
,
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 ,
volumeGroupName:
{
Description: The name of the volumeGroup ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
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 ,
properties:
{
Description: Volume group properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
groupMetaData:
{
Description: Volume group details ,
Required: False ,
}
{
groupDescription:
{
Description: Group Description ,
Required: False ,
}
string ,
applicationType:
{
Description: Application Type ,
Enum:
{
SAP-HANA: No description available. ,
ORACLE: No description available. ,
}
,
Required: False ,
}
enum ,
applicationIdentifier:
{
Description: Application specific identifier ,
Required: False ,
}
string ,
globalPlacementRules:
{
Description: Application specific placement rules for the volume group ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
volumesCount:
{
Description: Number of volumes in volume group ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
volumes:
{
Description: List of volumes from group ,
Required: False ,
}
[
{
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 ,
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 ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
Description: This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
Description: If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
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 ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective 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 ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
Description: What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
Description: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
Description: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Required: False ,
}
number ,
encryptionKeySource:
{
Description: Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
Description: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
Description: coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage. ,
Enum:
{
Default: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
Description: UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. Avoid passing null value for unixPermissions in volume update operation, As per the behavior, If Null value is passed then user-visible unixPermissions value will became null, and user will not be able to get unixPermissions value. On safer side, actual unixPermissions value on volume will remain as its last saved value only. ,
Required: False ,
}
string ,
cloneProgress:
{
Description: When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
Description: Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
language:
{
Description: Language supported for volume. ,
Enum:
{
c.utf-8: Posix with UTF-8 ,
utf8mb4: UTF-8 with 4 byte character support ,
ar: Arabic - Deprecated ,
ar.utf-8: Arabic with UTF-8 ,
hr: Croatian - Deprecated ,
hr.utf-8: Croatian with UTF-8 ,
cs: Czech - Deprecated ,
cs.utf-8: Czech with UTF-8 ,
da: Danish - Deprecated ,
da.utf-8: Danish with UTF-8 ,
nl: Dutch - Deprecated ,
nl.utf-8: Dutch with UTF-8 ,
en: English - Deprecated ,
en.utf-8: English with UTF-8 ,
fi: Finnish - Deprecated ,
fi.utf-8: Finnish with UTF-8 ,
fr: French - Deprecated ,
fr.utf-8: French with UTF-8 ,
de: German - Deprecated ,
de.utf-8: German with UTF-8 ,
he: Hebrew - Deprecated ,
he.utf-8: Hebrew with UTF-8 ,
hu: Hungarian - Deprecated ,
hu.utf-8: Hungarian with UTF-8 ,
it: Italian - Deprecated ,
it.utf-8: Italian with UTF-8 ,
ja: Japanese euc-j - Deprecated ,
ja.utf-8: Japanese euc-j with UTF-8 ,
ja-v1: Japanese euc-j - Deprecated ,
ja-v1.utf-8: Japanese euc-j with UTF-8 ,
ja-jp.pck: Japanese pck ,
ja-jp.pck.utf-8: Japanese pck with UTF-8 - Deprecated ,
ja-jp.932: Japanese cp932 ,
ja-jp.932.utf-8: Japanese cp932 with UTF-8 - Deprecated ,
ja-jp.pck-v2: Japanese pck - sjis ,
ja-jp.pck-v2.utf-8: Japanese pck - sjis with UTF-8 - Deprecated ,
ko: Korean - Deprecated ,
ko.utf-8: Korean with UTF-8 ,
no: Norwegian - Deprecated ,
no.utf-8: Norwegian with UTF-8 ,
pl: Polish - Deprecated ,
pl.utf-8: Polish with UTF-8 ,
pt: Portuguese - Deprecated ,
pt.utf-8: Portuguese with UTF-8 ,
c: Posix - Deprecated ,
ro: Romanian - Deprecated ,
ro.utf-8: Romanian with UTF-8 ,
ru: Russian - Deprecated ,
ru.utf-8: Russian with UTF-8 ,
zh: Simplified Chinese - Deprecated ,
zh.utf-8: Simplified Chinese with UTF-8 ,
zh.gbk: Simplified gbk Chinese ,
zh.gbk.utf-8: Simplified gbk Chinese with UTF-8 - Deprecated ,
zh-tw.big5: Traditional Chinese BIG 5 ,
zh-tw.big5.utf-8: Traditional Chinese BIG 5 with UTF-8 - Deprecated ,
zh-tw: Traditional Chinese EUC-TW ,
zh-tw.utf-8: Traditional Chinese EUC-TW with UTF-8 - Deprecated ,
sk: Slovak - Deprecated ,
sk.utf-8: Slovak with UTF-8 ,
sl: Slovenian - Deprecated ,
sl.utf-8: Slovenian with UTF-8 ,
es: Spanish - Deprecated ,
es.utf-8: Spanish with UTF-8 ,
sv: Swedish - Deprecated ,
sv.utf-8: Swedish with UTF-8 ,
tr: Turkish - Deprecated ,
tr.utf-8: Turkish with UTF-8 ,
en-us: US English - Deprecated ,
en-us.utf-8: US English with UTF-8 ,
}
,
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 ,
}
,
]
,
}
,
}
VolumeGroups_Delete (new)
Description :  Delete the specified volume group only if there are no volumes under volume group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups/{volumeGroupName}
{
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 ,
volumeGroupName:
{
Description: The name of the volumeGroup ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Subvolumes_ListByVolume (new)
Description :  Returns a list of the subvolumes in the volume
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Subvolumes ,
Required: False ,
}
[
{
properties:
{
Description: Subvolume Properties ,
Required: False ,
}
{
path:
{
Description: Path to the subvolume ,
Required: False ,
}
string ,
size:
{
Description: Truncate subvolume to the provided size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
parentPath:
{
Description: parent path to the subvolume ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Subvolumes_Get (new)
Description :  Returns the path associated with the subvolumeName provided
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
subvolumeName:
{
Description: The name of the subvolume. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Subvolume Properties ,
Required: False ,
}
{
path:
{
Description: Path to the subvolume ,
Required: False ,
}
string ,
size:
{
Description: Truncate subvolume to the provided size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
parentPath:
{
Description: parent path to the subvolume ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
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 ,
}
,
]
,
}
,
}
Subvolumes_Create (new)
Description :  Creates a subvolume in the path or clones the subvolume mentioned in the parentPath
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}
{
body:
{
Description: Subvolume object supplied in the body of the operation. ,
Required: True ,
}
{
properties:
{
Description: Subvolume Properties ,
Required: False ,
}
{
path:
{
Description: Path to the subvolume ,
Required: False ,
}
string ,
size:
{
Description: Truncate subvolume to the provided size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
parentPath:
{
Description: parent path to the subvolume ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}
,
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
subvolumeName:
{
Description: The name of the subvolume. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Subvolume Properties ,
Required: False ,
}
{
path:
{
Description: Path to the subvolume ,
Required: False ,
}
string ,
size:
{
Description: Truncate subvolume to the provided size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
parentPath:
{
Description: parent path to the subvolume ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Subvolume Properties ,
Required: False ,
}
{
path:
{
Description: Path to the subvolume ,
Required: False ,
}
string ,
size:
{
Description: Truncate subvolume to the provided size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
parentPath:
{
Description: parent path to the subvolume ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Subvolumes_Update (new)
Description :  Patch a subvolume
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}
{
body:
{
Description: Subvolume object supplied in the body of the operation. ,
Required: True ,
}
{
properties:
{
Description: Subvolume Properties ,
Required: False ,
}
{
size:
{
Description: Truncate subvolume to the provided size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
path:
{
Description: path to the subvolume ,
Required: False ,
}
string ,
}
,
}
,
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
subvolumeName:
{
Description: The name of the subvolume. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Subvolume Properties ,
Required: False ,
}
{
path:
{
Description: Path to the subvolume ,
Required: False ,
}
string ,
size:
{
Description: Truncate subvolume to the provided size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
parentPath:
{
Description: parent path to the subvolume ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Subvolumes_Delete (new)
Description :  Delete subvolume
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
subvolumeName:
{
Description: The name of the subvolume. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Subvolumes_GetMetadata (new)
Description :  Get details of the specified subvolume
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}/getMetadata
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
subvolumeName:
{
Description: The name of the subvolume. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: It represents the minimal properties of the subvolume. ,
Required: False ,
}
{
path:
{
Description: Path to the subvolume ,
Required: False ,
}
string ,
parentPath:
{
Description: Path to the parent subvolume ,
Required: False ,
}
string ,
size:
{
Description: Size of subvolume ,
Format: int64 ,
Required: False ,
}
integer ,
bytesUsed:
{
Description: Bytes used ,
Format: int64 ,
Required: False ,
}
integer ,
permissions:
{
Description: Permissions of the subvolume ,
Required: False ,
}
string ,
creationTimeStamp:
{
Description: Creation time and date ,
Format: date-time ,
Required: False ,
}
string ,
accessedTimeStamp:
{
Description: Most recent access time and date ,
Format: date-time ,
Required: False ,
}
string ,
modifiedTimeStamp:
{
Description: Most recent modification time and date ,
Format: date-time ,
Required: False ,
}
string ,
changedTimeStamp:
{
Description: Most recent change time and date ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Backups_GetLatestStatus (new)
Description :  Get the latest status of the backup for a volume
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestBackupStatus/current
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
healthy:
{
Description: Backup health status ,
Required: False ,
}
boolean ,
relationshipStatus:
{
Description: Status of the backup mirror relationship ,
Enum:
{
Idle: No description available. ,
Transferring: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
mirrorState:
{
Description: The status of the backup ,
Enum:
{
Uninitialized: No description available. ,
Mirrored: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
unhealthyReason:
{
Description: Reason for the unhealthy backup relationship ,
Required: False ,
}
string ,
errorMessage:
{
Description: Displays error message if the backup is in an error state ,
Required: False ,
}
string ,
lastTransferSize:
{
Description: Displays the last transfer size ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransferType:
{
Description: Displays the last transfer type ,
Required: False ,
}
string ,
totalTransferBytes:
{
Description: Displays the total bytes transferred ,
Format: int64 ,
Required: False ,
}
integer ,
transferProgressBytes:
{
Description: Displays the total number of bytes transferred for the ongoing operation ,
Format: int64 ,
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 ,
}
,
]
,
}
,
}
Backups_GetVolumeLatestRestoreStatus (new)
Description :  Get the latest status of the restore for a volume
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestRestoreStatus/current
{
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 ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
healthy:
{
Description: Restore health status ,
Required: False ,
}
boolean ,
relationshipStatus:
{
Description: Status of the restore SnapMirror relationship ,
Enum:
{
Idle: No description available. ,
Transferring: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
mirrorState:
{
Description: The status of the restore ,
Enum:
{
Uninitialized: No description available. ,
Mirrored: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
unhealthyReason:
{
Description: Reason for the unhealthy restore relationship ,
Required: False ,
}
string ,
errorMessage:
{
Description: Displays error message if the restore is in an error state ,
Required: False ,
}
string ,
totalTransferBytes:
{
Description: Displays the total bytes transferred ,
Format: int64 ,
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 ,
}
,
]
,
}
,
}
Backups_ListByVault (new)
Description :  List all backups Under a Backup Vault
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups
{
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 ,
backupVaultName:
{
Description: The name of the Backup Vault ,
Required: True ,
}
string ,
$filter:
{
Description: An option to specify the VolumeResourceId. If present, then only returns the backups under the specified volume ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Backups ,
Required: False ,
}
[
{
properties:
{
Description: Backup Properties ,
Required: True ,
}
{
backupId:
{
Description: UUID v4 used to identify the Backup ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the backup ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
size:
{
Description: Size of backup in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
label:
{
Description: Label for backup ,
Required: False ,
}
string ,
backupType:
{
Description: Type of backup Manual or Scheduled ,
Enum:
{
Manual: Manual backup ,
Scheduled: Scheduled backup ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason ,
Required: False ,
}
string ,
volumeResourceId:
{
Description: ResourceId used to identify the Volume ,
Format: arm-id ,
Required: True ,
}
string ,
useExistingSnapshot:
{
Description: Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups ,
Required: False ,
}
boolean ,
snapshotName:
{
Description: The name of the snapshot ,
Required: False ,
}
string ,
backupPolicyResourceId:
{
Description: ResourceId used to identify the backup policy ,
Format: arm-id ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies if the backup is for a large volume. ,
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 ,
}
,
]
,
}
,
}
Backups_Get (new)
Description :  Get the specified Backup under Backup Vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}
{
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 ,
backupVaultName:
{
Description: The name of the Backup Vault ,
Required: True ,
}
string ,
backupName:
{
Description: The name of the backup ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Backup Properties ,
Required: True ,
}
{
backupId:
{
Description: UUID v4 used to identify the Backup ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the backup ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
size:
{
Description: Size of backup in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
label:
{
Description: Label for backup ,
Required: False ,
}
string ,
backupType:
{
Description: Type of backup Manual or Scheduled ,
Enum:
{
Manual: Manual backup ,
Scheduled: Scheduled backup ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason ,
Required: False ,
}
string ,
volumeResourceId:
{
Description: ResourceId used to identify the Volume ,
Format: arm-id ,
Required: True ,
}
string ,
useExistingSnapshot:
{
Description: Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups ,
Required: False ,
}
boolean ,
snapshotName:
{
Description: The name of the snapshot ,
Required: False ,
}
string ,
backupPolicyResourceId:
{
Description: ResourceId used to identify the backup policy ,
Format: arm-id ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies if the backup is for a large volume. ,
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 ,
}
,
]
,
}
,
}
Backups_Create (new)
Description :  Create a backup under the Backup Vault
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}
{
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 ,
backupVaultName:
{
Description: The name of the Backup Vault ,
Required: True ,
}
string ,
backupName:
{
Description: The name of the backup ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Backup object supplied in the body of the operation. ,
Required: True ,
}
{
properties:
{
Description: Backup Properties ,
Required: True ,
}
{
backupId:
{
Description: UUID v4 used to identify the Backup ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the backup ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
size:
{
Description: Size of backup in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
label:
{
Description: Label for backup ,
Required: False ,
}
string ,
backupType:
{
Description: Type of backup Manual or Scheduled ,
Enum:
{
Manual: Manual backup ,
Scheduled: Scheduled backup ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason ,
Required: False ,
}
string ,
volumeResourceId:
{
Description: ResourceId used to identify the Volume ,
Format: arm-id ,
Required: True ,
}
string ,
useExistingSnapshot:
{
Description: Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups ,
Required: False ,
}
boolean ,
snapshotName:
{
Description: The name of the snapshot ,
Required: False ,
}
string ,
backupPolicyResourceId:
{
Description: ResourceId used to identify the backup policy ,
Format: arm-id ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies if the backup is for a large volume. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Backup Properties ,
Required: True ,
}
{
backupId:
{
Description: UUID v4 used to identify the Backup ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the backup ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
size:
{
Description: Size of backup in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
label:
{
Description: Label for backup ,
Required: False ,
}
string ,
backupType:
{
Description: Type of backup Manual or Scheduled ,
Enum:
{
Manual: Manual backup ,
Scheduled: Scheduled backup ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason ,
Required: False ,
}
string ,
volumeResourceId:
{
Description: ResourceId used to identify the Volume ,
Format: arm-id ,
Required: True ,
}
string ,
useExistingSnapshot:
{
Description: Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups ,
Required: False ,
}
boolean ,
snapshotName:
{
Description: The name of the snapshot ,
Required: False ,
}
string ,
backupPolicyResourceId:
{
Description: ResourceId used to identify the backup policy ,
Format: arm-id ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies if the backup is for a large volume. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Backup Properties ,
Required: True ,
}
{
backupId:
{
Description: UUID v4 used to identify the Backup ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the backup ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
size:
{
Description: Size of backup in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
label:
{
Description: Label for backup ,
Required: False ,
}
string ,
backupType:
{
Description: Type of backup Manual or Scheduled ,
Enum:
{
Manual: Manual backup ,
Scheduled: Scheduled backup ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason ,
Required: False ,
}
string ,
volumeResourceId:
{
Description: ResourceId used to identify the Volume ,
Format: arm-id ,
Required: True ,
}
string ,
useExistingSnapshot:
{
Description: Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups ,
Required: False ,
}
boolean ,
snapshotName:
{
Description: The name of the snapshot ,
Required: False ,
}
string ,
backupPolicyResourceId:
{
Description: ResourceId used to identify the backup policy ,
Format: arm-id ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies if the backup is for a large volume. ,
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 ,
}
,
]
,
}
,
}
Backups_Update (new)
Description :  Patch a Backup under the Backup Vault
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}
{
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 ,
backupVaultName:
{
Description: The name of the Backup Vault ,
Required: True ,
}
string ,
backupName:
{
Description: The name of the backup ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Backup object supplied in the body of the operation. ,
Required: False ,
}
{
properties:
{
Description: Backup Patch Properties ,
Required: False ,
}
{
label:
{
Description: Label for backup ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Backup Properties ,
Required: True ,
}
{
backupId:
{
Description: UUID v4 used to identify the Backup ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the backup ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
size:
{
Description: Size of backup in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
label:
{
Description: Label for backup ,
Required: False ,
}
string ,
backupType:
{
Description: Type of backup Manual or Scheduled ,
Enum:
{
Manual: Manual backup ,
Scheduled: Scheduled backup ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason ,
Required: False ,
}
string ,
volumeResourceId:
{
Description: ResourceId used to identify the Volume ,
Format: arm-id ,
Required: True ,
}
string ,
useExistingSnapshot:
{
Description: Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups ,
Required: False ,
}
boolean ,
snapshotName:
{
Description: The name of the snapshot ,
Required: False ,
}
string ,
backupPolicyResourceId:
{
Description: ResourceId used to identify the backup policy ,
Format: arm-id ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies if the backup is for a large volume. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Backup under a Backup Vault ,
}
{
properties:
{
Description: Backup Properties ,
Required: True ,
}
{
backupId:
{
Description: UUID v4 used to identify the Backup ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the backup ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
size:
{
Description: Size of backup in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
label:
{
Description: Label for backup ,
Required: False ,
}
string ,
backupType:
{
Description: Type of backup Manual or Scheduled ,
Enum:
{
Manual: Manual backup ,
Scheduled: Scheduled backup ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason ,
Required: False ,
}
string ,
volumeResourceId:
{
Description: ResourceId used to identify the Volume ,
Format: arm-id ,
Required: True ,
}
string ,
useExistingSnapshot:
{
Description: Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups ,
Required: False ,
}
boolean ,
snapshotName:
{
Description: The name of the snapshot ,
Required: False ,
}
string ,
backupPolicyResourceId:
{
Description: ResourceId used to identify the backup policy ,
Format: arm-id ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies if the backup is for a large volume. ,
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 ,
}
,
]
,
}
,
}
Backups_Delete (new)
Description :  Delete a Backup under the Backup Vault
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}
{
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 ,
backupVaultName:
{
Description: The name of the Backup Vault ,
Required: True ,
}
string ,
backupName:
{
Description: The name of the backup ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
BackupVaults_ListByNetAppAccount (new)
Description :  List and describe all Backup Vaults in the NetApp account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults
{
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: A list of Backup Vaults ,
Required: False ,
}
[
{
properties:
{
Description: Backup Vault Properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
BackupVaults_Get (new)
Description :  Get the Backup Vault
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}
{
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 ,
backupVaultName:
{
Description: The name of the Backup Vault ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Backup Vault Properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
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 ,
}
,
]
,
}
,
}
BackupVaults_CreateOrUpdate (new)
Description :  Create or update the specified Backup Vault in the NetApp account
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}
{
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 ,
backupVaultName:
{
Description: The name of the Backup Vault ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: BackupVault object supplied in the body of the operation. ,
Required: True ,
}
{
properties:
{
Description: Backup Vault Properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Backup Vault Properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Backup Vault Properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
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 ,
}
,
]
,
}
,
}
BackupVaults_Update (new)
Description :  Patch the specified NetApp Backup Vault
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}
{
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 ,
backupVaultName:
{
Description: The name of the Backup Vault ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Backup Vault object supplied in the body of the operation. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Backup Vault Properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Backup Vault information ,
}
{
properties:
{
Description: Backup Vault Properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
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 ,
}
,
]
,
}
,
}
BackupVaults_Delete (new)
Description :  Delete the specified Backup Vault
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}
{
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 ,
backupVaultName:
{
Description: The name of the Backup Vault ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
BackupsUnderBackupVault_RestoreFiles (new)
Description :  Restore the specified files from the specified backup to the active filesystem
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}/restoreFiles
{
body:
{
Description: Restore payload supplied in the body of the operation. ,
Required: True ,
}
{
fileList:
{
Description: List of files to be restored ,
Required: True ,
}
[
string ,
]
,
restoreFilePath:
{
Description: Destination folder where the files will be restored. The path name should start with a forward slash. If it is omitted from request then restore is done at the root folder of the destination volume by default ,
Required: False ,
}
string ,
destinationVolumeId:
{
Description: Resource Id of the destination volume on which the files need to be restored ,
Required: True ,
}
string ,
}
,
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 ,
backupVaultName:
{
Description: The name of the Backup Vault ,
Required: True ,
}
string ,
backupName:
{
Description: The name of the backup ,
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 ,
}
,
]
,
}
,
}
BackupsUnderVolume_MigrateBackups (new)
Description :  Migrate the backups under volume to backup vault
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/migrateBackups
{
body:
{
Description: Migrate backups under volume payload supplied in the body of the operation. ,
Required: True ,
}
{
backupVaultId:
{
Description: The ResourceId of the Backup Vault ,
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 ,
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 ,
volumeName:
{
Description: The name of the volume ,
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 ,
}
,
]
,
}
,
}
BackupsUnderAccount_MigrateBackups (new)
Description :  Migrate the backups under a NetApp account to backup vault
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/migrateBackups
{
body:
{
Description: Migrate backups under an account payload supplied in the body of the operation. ,
Required: True ,
}
{
backupVaultId:
{
Description: The ResourceId of the Backup Vault ,
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 ,
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 ,
}
,
]
,
}
,
}