Microsoft.NetApp (preview:2025-07-01)

2025/10/15 • 74 updated methods

Operations_List (updated)
Description :  List the operations for the provider
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "Description": {
    "new": "List the operations for the provider",
    "old": "Lists all of the available Microsoft.NetApp Rest API operations"
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.",
        "old": "Result of the request to list Cloud Volume operations. It contains a list of operations and a URL link to get the next set of results."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Operation items on this page",
            "old": "List of Storage operations supported by the Storage resource provider."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of operation list results (if there are any)."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.NetApp/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Operation items on this page ,
Required: True ,
}
[
{
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 ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Check if a file path is available.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NetAppResource_CheckFilePathAvailability",
  "$parameters": [
    {
      "#name": "body",
      "Description": {
        "new": "The request body",
        "old": "File path availability request."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkFilePathAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
body:
{
Description: The request body ,
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 ,
}
,
}

⚐ 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_CheckNameAvailability (updated)
Description :  Check if a resource name is available.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NetAppResource_CheckNameAvailability",
  "$parameters": [
    {
      "#name": "body",
      "Description": {
        "new": "The request body",
        "old": "Name availability request."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
body:
{
Description: The request body ,
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 ,
}
,
}

⚐ 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 (updated)
Description :  Check if a quota is available.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NetAppResource_CheckQuotaAvailability",
  "$parameters": [
    {
      "#name": "body",
      "Description": {
        "new": "The request body",
        "old": "Quota availability request."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkQuotaAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
body:
{
Description: The request body ,
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 ,
}
,
}

⚐ 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_QueryNetworkSiblingSet (updated)
Description :  Get details of the specified network sibling set.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NetAppResource_QueryNetworkSiblingSet",
  "$parameters": [
    {
      "#name": "body",
      "Description": {
        "new": "The request body",
        "old": "Network sibling set to query."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/queryNetworkSiblingSet
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
body:
{
Description: The request body ,
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 ,
}
,
}

⚐ 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:
{
Description: ipAddress ,
Required: False ,
}
string ,
volumeResourceIds:
{
Description: Volume resource Ids ,
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 (updated)
Description :  Get the default and current limits for quotas
Reference :  Link ¶

⚶ Changes

{
  "#id": "NetAppResourceQuotaLimits_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The QuotaItem items on this page",
            "old": "A list of QuotaItems"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The QuotaItem items on this page ,
Required: True ,
}
[
{
properties:
{
Description: QuotaItem 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 ,
usage:
{
Description: The usage quota value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_Get (updated)
Description :  Get the default and current quota limit
Reference :  Link ¶

⚶ Changes

{
  "#id": "NetAppResourceQuotaLimits_Get",
  "Description": {
    "new": "Get the default and current quota limit",
    "old": "Get the default and current subscription quota limit"
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits/{quotaLimitName}
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
quotaLimitName:
{
Description: The name of the Quota Limit ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: QuotaItem 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 ,
usage:
{
Description: The usage 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 ,
}
,
]
,
}
,
}
NetAppResourceRegionInfos_List (updated)
Description :  Provides region specific information.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NetAppResourceRegionInfos_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The RegionInfoResource items on this page",
            "old": "A list of regionInfo resources"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The RegionInfoResource items on this page ,
Required: True ,
}
[
{
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: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Update the network features of the specified network sibling set.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NetAppResource_UpdateNetworkSiblingSet",
  "$parameters": [
    {
      "#name": "body",
      "Description": {
        "new": "The request body",
        "old": "Update for the specified network sibling set."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "@added_56e7b99cbea54c50a36eb6446697f906": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/updateNetworkSiblingSet
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
body:
{
Description: The request body ,
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 ,
}
,
}

⚐ 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:
{
Description: ipAddress ,
Required: False ,
}
string ,
volumeResourceIds:
{
Description: Volume resource Ids ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
NetAppResourceUsages_List (updated)
Description :  Get current subscription usages
Reference :  Link ¶

⚶ Changes

{
  "#id": "NetAppResourceUsages_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The UsageResult items on this page",
            "old": "A list of usages"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/usages
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The UsageResult items on this page ,
Required: True ,
}
[
{
id:
{
Description: The id of the usage. ,
Required: False ,
}
string ,
name:
{
Description: The name of the usage. ,
Required: False ,
}
{
value:
{
Description: The name of the usage. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized name of the usage. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Usage properties ,
Required: False ,
}
{
currentValue:
{
Description: The current usage value for the subscription. ,
Format: int32 ,
Required: False ,
}
integer ,
limit:
{
Description: The limit of the usage. ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The unit of the usage. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_ListBySubscription (updated)
Description :  List and describe all NetApp accounts in the subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Accounts_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The NetAppAccount items on this page",
            "old": "Multiple NetApp accounts"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": [
              {
                "properties": [
                  {
                    "activeDirectories": {
                      "$properties": [
                        {
                          "#name": "status",
                          "Enum": {
                            "new": [
                              [
                                "Created",
                                "Active Directory created but not in use"
                              ],
                              [
                                "InUse",
                                "Active Directory in use by SMB Volume"
                              ],
                              [
                                "Deleted",
                                "Active Directory Deleted"
                              ],
                              [
                                "Error",
                                "Error with the Active Directory"
                              ],
                              [
                                "Updating",
                                "Active Directory Updating"
                              ]
                            ],
                            "old": [
                              [
                                "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"
                              ]
                            ]
                          }
                        },
                        {
                          "#name": "allowLocalNfsUsersWithLdap",
                          "Description": {
                            "new": "If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes.",
                            "old": " If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes."
                          }
                        }
                      ]
                    }
                  },
                  {
                    "encryption": [
                      {
                        "keyVaultProperties": [
                          {
                            "#name": "status",
                            "Enum": {
                              "new": [
                                [
                                  "Created",
                                  "KeyVault connection created but not in use"
                                ],
                                [
                                  "InUse",
                                  "KeyVault connection in use by SMB Volume"
                                ],
                                [
                                  "Deleted",
                                  "KeyVault connection Deleted"
                                ],
                                [
                                  "Error",
                                  "Error with the KeyVault connection"
                                ],
                                [
                                  "Updating",
                                  "KeyVault connection Updating"
                                ]
                              ],
                              "old": [
                                [
                                  "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"
                                ]
                              ]
                            }
                          }
                        ]
                      },
                      {
                        "identity": [
                          {
                            "#name": "federatedClientId",
                            "Description": {
                              "new": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant keyvaults.",
                              "old": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults."
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              },
              {
                "#name": "etag",
                "Description": {
                  "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
                  "old": "A unique read-only string that changes whenever the resource is updated."
                }
              },
              {
                "#name": "identity",
                "Description": {
                  "new": "The managed service identities assigned to this resource.",
                  "old": "The identity used for the resource."
                }
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The NetAppAccount items on this page ,
Required: True ,
}
[
{
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 ,
Format: password ,
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 ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
Updating: Active Directory Updating ,
}
,
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. ,
Format: password ,
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. ,
Format: uri ,
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 ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
Updating: KeyVault connection Updating ,
}
,
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 ,
multiAdStatus:
{
Description: MultiAD Status for the account ,
Enum:
{
Disabled: Account is MultiAD disabled, Means its a SharedAD or SingleAD account. ,
Enabled: Account is MultiAD enabled ,
}
,
Required: False ,
}
enum ,
ldapConfiguration:
{
Description: LDAP Configuration for the account. ,
Required: False ,
}
{
domain:
{
Description: Name of the LDAP configuration domain ,
Required: False ,
}
string ,
ldapServers:
{
Description: List of LDAP server IP addresses (IPv4 only) for the LDAP domain. ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
serverCACertificate:
{
Description: When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate. ,
Format: password ,
Required: False ,
}
string ,
certificateCNHost:
{
Description: The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry. ,
Required: False ,
}
string ,
}
,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this 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: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  List and describe all NetApp accounts in the resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Accounts_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The NetAppAccount items on this page",
            "old": "Multiple NetApp accounts"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": [
              {
                "properties": [
                  {
                    "activeDirectories": {
                      "$properties": [
                        {
                          "#name": "status",
                          "Enum": {
                            "new": [
                              [
                                "Created",
                                "Active Directory created but not in use"
                              ],
                              [
                                "InUse",
                                "Active Directory in use by SMB Volume"
                              ],
                              [
                                "Deleted",
                                "Active Directory Deleted"
                              ],
                              [
                                "Error",
                                "Error with the Active Directory"
                              ],
                              [
                                "Updating",
                                "Active Directory Updating"
                              ]
                            ],
                            "old": [
                              [
                                "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"
                              ]
                            ]
                          }
                        },
                        {
                          "#name": "allowLocalNfsUsersWithLdap",
                          "Description": {
                            "new": "If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes.",
                            "old": " If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes."
                          }
                        }
                      ]
                    }
                  },
                  {
                    "encryption": [
                      {
                        "keyVaultProperties": [
                          {
                            "#name": "status",
                            "Enum": {
                              "new": [
                                [
                                  "Created",
                                  "KeyVault connection created but not in use"
                                ],
                                [
                                  "InUse",
                                  "KeyVault connection in use by SMB Volume"
                                ],
                                [
                                  "Deleted",
                                  "KeyVault connection Deleted"
                                ],
                                [
                                  "Error",
                                  "Error with the KeyVault connection"
                                ],
                                [
                                  "Updating",
                                  "KeyVault connection Updating"
                                ]
                              ],
                              "old": [
                                [
                                  "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"
                                ]
                              ]
                            }
                          }
                        ]
                      },
                      {
                        "identity": [
                          {
                            "#name": "federatedClientId",
                            "Description": {
                              "new": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant keyvaults.",
                              "old": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults."
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              },
              {
                "#name": "etag",
                "Description": {
                  "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
                  "old": "A unique read-only string that changes whenever the resource is updated."
                }
              },
              {
                "#name": "identity",
                "Description": {
                  "new": "The managed service identities assigned to this resource.",
                  "old": "The identity used for the resource."
                }
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The NetAppAccount items on this page ,
Required: True ,
}
[
{
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 ,
Format: password ,
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 ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
Updating: Active Directory Updating ,
}
,
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. ,
Format: password ,
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. ,
Format: uri ,
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 ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
Updating: KeyVault connection Updating ,
}
,
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 ,
multiAdStatus:
{
Description: MultiAD Status for the account ,
Enum:
{
Disabled: Account is MultiAD disabled, Means its a SharedAD or SingleAD account. ,
Enabled: Account is MultiAD enabled ,
}
,
Required: False ,
}
enum ,
ldapConfiguration:
{
Description: LDAP Configuration for the account. ,
Required: False ,
}
{
domain:
{
Description: Name of the LDAP configuration domain ,
Required: False ,
}
string ,
ldapServers:
{
Description: List of LDAP server IP addresses (IPv4 only) for the LDAP domain. ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
serverCACertificate:
{
Description: When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate. ,
Format: password ,
Required: False ,
}
string ,
certificateCNHost:
{
Description: The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry. ,
Required: False ,
}
string ,
}
,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this 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: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get the NetApp account
Reference :  Link ¶

⚶ Changes

{
  "#id": "Accounts_Get",
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "activeDirectories": {
                "$properties": [
                  {
                    "#name": "status",
                    "Enum": {
                      "new": [
                        [
                          "Created",
                          "Active Directory created but not in use"
                        ],
                        [
                          "InUse",
                          "Active Directory in use by SMB Volume"
                        ],
                        [
                          "Deleted",
                          "Active Directory Deleted"
                        ],
                        [
                          "Error",
                          "Error with the Active Directory"
                        ],
                        [
                          "Updating",
                          "Active Directory Updating"
                        ]
                      ],
                      "old": [
                        [
                          "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"
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "allowLocalNfsUsersWithLdap",
                    "Description": {
                      "new": "If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes.",
                      "old": " If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes."
                    }
                  }
                ]
              }
            },
            {
              "encryption": [
                {
                  "keyVaultProperties": [
                    {
                      "#name": "status",
                      "Enum": {
                        "new": [
                          [
                            "Created",
                            "KeyVault connection created but not in use"
                          ],
                          [
                            "InUse",
                            "KeyVault connection in use by SMB Volume"
                          ],
                          [
                            "Deleted",
                            "KeyVault connection Deleted"
                          ],
                          [
                            "Error",
                            "Error with the KeyVault connection"
                          ],
                          [
                            "Updating",
                            "KeyVault connection Updating"
                          ]
                        ],
                        "old": [
                          [
                            "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"
                          ]
                        ]
                      }
                    }
                  ]
                },
                {
                  "identity": [
                    {
                      "#name": "federatedClientId",
                      "Description": {
                        "new": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant keyvaults.",
                        "old": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults."
                      }
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        },
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "The identity used for the resource."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (200)

{
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 ,
Format: password ,
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 ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
Updating: Active Directory Updating ,
}
,
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. ,
Format: password ,
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. ,
Format: uri ,
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 ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
Updating: KeyVault connection Updating ,
}
,
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 ,
multiAdStatus:
{
Description: MultiAD Status for the account ,
Enum:
{
Disabled: Account is MultiAD disabled, Means its a SharedAD or SingleAD account. ,
Enabled: Account is MultiAD enabled ,
}
,
Required: False ,
}
enum ,
ldapConfiguration:
{
Description: LDAP Configuration for the account. ,
Required: False ,
}
{
domain:
{
Description: Name of the LDAP configuration domain ,
Required: False ,
}
string ,
ldapServers:
{
Description: List of LDAP server IP addresses (IPv4 only) for the LDAP domain. ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
serverCACertificate:
{
Description: When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate. ,
Format: password ,
Required: False ,
}
string ,
certificateCNHost:
{
Description: The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry. ,
Required: False ,
}
string ,
}
,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this 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 (updated)
Description :  Create or update the specified NetApp account within the resource group
Reference :  Link ¶

⚶ Changes

{
  "#id": "Accounts_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": [
        {
          "properties": [
            {
              "activeDirectories": {
                "$properties": [
                  {
                    "#name": "status",
                    "Enum": {
                      "new": [
                        [
                          "Created",
                          "Active Directory created but not in use"
                        ],
                        [
                          "InUse",
                          "Active Directory in use by SMB Volume"
                        ],
                        [
                          "Deleted",
                          "Active Directory Deleted"
                        ],
                        [
                          "Error",
                          "Error with the Active Directory"
                        ],
                        [
                          "Updating",
                          "Active Directory Updating"
                        ]
                      ],
                      "old": [
                        [
                          "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"
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "allowLocalNfsUsersWithLdap",
                    "Description": {
                      "new": "If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes.",
                      "old": " If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes."
                    }
                  }
                ]
              }
            },
            {
              "encryption": [
                {
                  "keyVaultProperties": [
                    {
                      "#name": "status",
                      "Enum": {
                        "new": [
                          [
                            "Created",
                            "KeyVault connection created but not in use"
                          ],
                          [
                            "InUse",
                            "KeyVault connection in use by SMB Volume"
                          ],
                          [
                            "Deleted",
                            "KeyVault connection Deleted"
                          ],
                          [
                            "Error",
                            "Error with the KeyVault connection"
                          ],
                          [
                            "Updating",
                            "KeyVault connection Updating"
                          ]
                        ],
                        "old": [
                          [
                            "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"
                          ]
                        ]
                      }
                    }
                  ]
                },
                {
                  "identity": [
                    {
                      "#name": "federatedClientId",
                      "Description": {
                        "new": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant keyvaults.",
                        "old": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults."
                      }
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        },
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "The identity used for the resource."
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "activeDirectories": {
                "$properties": [
                  {
                    "#name": "status",
                    "Enum": {
                      "new": [
                        [
                          "Created",
                          "Active Directory created but not in use"
                        ],
                        [
                          "InUse",
                          "Active Directory in use by SMB Volume"
                        ],
                        [
                          "Deleted",
                          "Active Directory Deleted"
                        ],
                        [
                          "Error",
                          "Error with the Active Directory"
                        ],
                        [
                          "Updating",
                          "Active Directory Updating"
                        ]
                      ],
                      "old": [
                        [
                          "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"
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "allowLocalNfsUsersWithLdap",
                    "Description": {
                      "new": "If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes.",
                      "old": " If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes."
                    }
                  }
                ]
              }
            },
            {
              "encryption": [
                {
                  "keyVaultProperties": [
                    {
                      "#name": "status",
                      "Enum": {
                        "new": [
                          [
                            "Created",
                            "KeyVault connection created but not in use"
                          ],
                          [
                            "InUse",
                            "KeyVault connection in use by SMB Volume"
                          ],
                          [
                            "Deleted",
                            "KeyVault connection Deleted"
                          ],
                          [
                            "Error",
                            "Error with the KeyVault connection"
                          ],
                          [
                            "Updating",
                            "KeyVault connection Updating"
                          ]
                        ],
                        "old": [
                          [
                            "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"
                          ]
                        ]
                      }
                    }
                  ]
                },
                {
                  "identity": [
                    {
                      "#name": "federatedClientId",
                      "Description": {
                        "new": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant keyvaults.",
                        "old": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults."
                      }
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        },
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "The identity used for the resource."
          }
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "properties": [
            {
              "activeDirectories": {
                "$properties": [
                  {
                    "#name": "status",
                    "Enum": {
                      "new": [
                        [
                          "Created",
                          "Active Directory created but not in use"
                        ],
                        [
                          "InUse",
                          "Active Directory in use by SMB Volume"
                        ],
                        [
                          "Deleted",
                          "Active Directory Deleted"
                        ],
                        [
                          "Error",
                          "Error with the Active Directory"
                        ],
                        [
                          "Updating",
                          "Active Directory Updating"
                        ]
                      ],
                      "old": [
                        [
                          "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"
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "allowLocalNfsUsersWithLdap",
                    "Description": {
                      "new": "If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes.",
                      "old": " If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes."
                    }
                  }
                ]
              }
            },
            {
              "encryption": [
                {
                  "keyVaultProperties": [
                    {
                      "#name": "status",
                      "Enum": {
                        "new": [
                          [
                            "Created",
                            "KeyVault connection created but not in use"
                          ],
                          [
                            "InUse",
                            "KeyVault connection in use by SMB Volume"
                          ],
                          [
                            "Deleted",
                            "KeyVault connection Deleted"
                          ],
                          [
                            "Error",
                            "Error with the KeyVault connection"
                          ],
                          [
                            "Updating",
                            "KeyVault connection Updating"
                          ]
                        ],
                        "old": [
                          [
                            "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"
                          ]
                        ]
                      }
                    }
                  ]
                },
                {
                  "identity": [
                    {
                      "#name": "federatedClientId",
                      "Description": {
                        "new": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant keyvaults.",
                        "old": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults."
                      }
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        },
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "The identity used for the resource."
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
body:
{
Description: NetApp Account object supplied in the body of the operation. ,
Required: True ,
}
{
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 ,
Format: password ,
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 ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
Updating: Active Directory Updating ,
}
,
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. ,
Format: password ,
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. ,
Format: uri ,
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 ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
Updating: KeyVault connection Updating ,
}
,
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 ,
multiAdStatus:
{
Description: MultiAD Status for the account ,
Enum:
{
Disabled: Account is MultiAD disabled, Means its a SharedAD or SingleAD account. ,
Enabled: Account is MultiAD enabled ,
}
,
Required: False ,
}
enum ,
ldapConfiguration:
{
Description: LDAP Configuration for the account. ,
Required: False ,
}
{
domain:
{
Description: Name of the LDAP configuration domain ,
Required: False ,
}
string ,
ldapServers:
{
Description: List of LDAP server IP addresses (IPv4 only) for the LDAP domain. ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
serverCACertificate:
{
Description: When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate. ,
Format: password ,
Required: False ,
}
string ,
certificateCNHost:
{
Description: The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry. ,
Required: False ,
}
string ,
}
,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this 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 (200)

{
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 ,
Format: password ,
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 ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
Updating: Active Directory Updating ,
}
,
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. ,
Format: password ,
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. ,
Format: uri ,
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 ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
Updating: KeyVault connection Updating ,
}
,
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 ,
multiAdStatus:
{
Description: MultiAD Status for the account ,
Enum:
{
Disabled: Account is MultiAD disabled, Means its a SharedAD or SingleAD account. ,
Enabled: Account is MultiAD enabled ,
}
,
Required: False ,
}
enum ,
ldapConfiguration:
{
Description: LDAP Configuration for the account. ,
Required: False ,
}
{
domain:
{
Description: Name of the LDAP configuration domain ,
Required: False ,
}
string ,
ldapServers:
{
Description: List of LDAP server IP addresses (IPv4 only) for the LDAP domain. ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
serverCACertificate:
{
Description: When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate. ,
Format: password ,
Required: False ,
}
string ,
certificateCNHost:
{
Description: The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry. ,
Required: False ,
}
string ,
}
,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this 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)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: NetApp account resource ,
}
{
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 ,
Format: password ,
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 ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
Updating: Active Directory Updating ,
}
,
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. ,
Format: password ,
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. ,
Format: uri ,
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 ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
Updating: KeyVault connection Updating ,
}
,
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 ,
multiAdStatus:
{
Description: MultiAD Status for the account ,
Enum:
{
Disabled: Account is MultiAD disabled, Means its a SharedAD or SingleAD account. ,
Enabled: Account is MultiAD enabled ,
}
,
Required: False ,
}
enum ,
ldapConfiguration:
{
Description: LDAP Configuration for the account. ,
Required: False ,
}
{
domain:
{
Description: Name of the LDAP configuration domain ,
Required: False ,
}
string ,
ldapServers:
{
Description: List of LDAP server IP addresses (IPv4 only) for the LDAP domain. ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
serverCACertificate:
{
Description: When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate. ,
Format: password ,
Required: False ,
}
string ,
certificateCNHost:
{
Description: The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry. ,
Required: False ,
}
string ,
}
,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this 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_Update (updated)
Description :  Patch the specified NetApp account
Reference :  Link ¶

⚶ Changes

{
  "#id": "Accounts_Update",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "activeDirectories": {
              "$properties": [
                {
                  "#name": "status",
                  "Enum": {
                    "new": [
                      [
                        "Created",
                        "Active Directory created but not in use"
                      ],
                      [
                        "InUse",
                        "Active Directory in use by SMB Volume"
                      ],
                      [
                        "Deleted",
                        "Active Directory Deleted"
                      ],
                      [
                        "Error",
                        "Error with the Active Directory"
                      ],
                      [
                        "Updating",
                        "Active Directory Updating"
                      ]
                    ],
                    "old": [
                      [
                        "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"
                      ]
                    ]
                  }
                },
                {
                  "#name": "allowLocalNfsUsersWithLdap",
                  "Description": {
                    "new": "If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes.",
                    "old": " If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes."
                  }
                }
              ]
            }
          },
          {
            "encryption": [
              {
                "keyVaultProperties": [
                  {
                    "#name": "status",
                    "Enum": {
                      "new": [
                        [
                          "Created",
                          "KeyVault connection created but not in use"
                        ],
                        [
                          "InUse",
                          "KeyVault connection in use by SMB Volume"
                        ],
                        [
                          "Deleted",
                          "KeyVault connection Deleted"
                        ],
                        [
                          "Error",
                          "Error with the KeyVault connection"
                        ],
                        [
                          "Updating",
                          "KeyVault connection Updating"
                        ]
                      ],
                      "old": [
                        [
                          "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"
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "identity": [
                  {
                    "#name": "federatedClientId",
                    "Description": {
                      "new": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant keyvaults.",
                      "old": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults."
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "activeDirectories": {
                "$properties": [
                  {
                    "#name": "status",
                    "Enum": {
                      "new": [
                        [
                          "Created",
                          "Active Directory created but not in use"
                        ],
                        [
                          "InUse",
                          "Active Directory in use by SMB Volume"
                        ],
                        [
                          "Deleted",
                          "Active Directory Deleted"
                        ],
                        [
                          "Error",
                          "Error with the Active Directory"
                        ],
                        [
                          "Updating",
                          "Active Directory Updating"
                        ]
                      ],
                      "old": [
                        [
                          "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"
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "allowLocalNfsUsersWithLdap",
                    "Description": {
                      "new": "If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes.",
                      "old": " If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes."
                    }
                  }
                ]
              }
            },
            {
              "encryption": [
                {
                  "keyVaultProperties": [
                    {
                      "#name": "status",
                      "Enum": {
                        "new": [
                          [
                            "Created",
                            "KeyVault connection created but not in use"
                          ],
                          [
                            "InUse",
                            "KeyVault connection in use by SMB Volume"
                          ],
                          [
                            "Deleted",
                            "KeyVault connection Deleted"
                          ],
                          [
                            "Error",
                            "Error with the KeyVault connection"
                          ],
                          [
                            "Updating",
                            "KeyVault connection Updating"
                          ]
                        ],
                        "old": [
                          [
                            "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"
                          ]
                        ]
                      }
                    }
                  ]
                },
                {
                  "identity": [
                    {
                      "#name": "federatedClientId",
                      "Description": {
                        "new": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant keyvaults.",
                        "old": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults."
                      }
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        },
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "The identity used for the resource."
          }
        }
      ]
    },
    "202": {
      "$properties": [
        {
          "properties": [
            {
              "activeDirectories": {
                "$properties": [
                  {
                    "#name": "status",
                    "Enum": {
                      "new": [
                        [
                          "Created",
                          "Active Directory created but not in use"
                        ],
                        [
                          "InUse",
                          "Active Directory in use by SMB Volume"
                        ],
                        [
                          "Deleted",
                          "Active Directory Deleted"
                        ],
                        [
                          "Error",
                          "Error with the Active Directory"
                        ],
                        [
                          "Updating",
                          "Active Directory Updating"
                        ]
                      ],
                      "old": [
                        [
                          "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"
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "allowLocalNfsUsersWithLdap",
                    "Description": {
                      "new": "If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes.",
                      "old": " If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes."
                    }
                  }
                ]
              }
            },
            {
              "encryption": [
                {
                  "keyVaultProperties": [
                    {
                      "#name": "status",
                      "Enum": {
                        "new": [
                          [
                            "Created",
                            "KeyVault connection created but not in use"
                          ],
                          [
                            "InUse",
                            "KeyVault connection in use by SMB Volume"
                          ],
                          [
                            "Deleted",
                            "KeyVault connection Deleted"
                          ],
                          [
                            "Error",
                            "Error with the KeyVault connection"
                          ],
                          [
                            "Updating",
                            "KeyVault connection Updating"
                          ]
                        ],
                        "old": [
                          [
                            "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"
                          ]
                        ]
                      }
                    }
                  ]
                },
                {
                  "identity": [
                    {
                      "#name": "federatedClientId",
                      "Description": {
                        "new": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant keyvaults.",
                        "old": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults."
                      }
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        },
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "The identity used for the resource."
          }
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
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 ,
Format: password ,
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 ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
Updating: Active Directory Updating ,
}
,
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. ,
Format: password ,
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. ,
Format: uri ,
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 ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
Updating: KeyVault connection Updating ,
}
,
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 ,
multiAdStatus:
{
Description: MultiAD Status for the account ,
Enum:
{
Disabled: Account is MultiAD disabled, Means its a SharedAD or SingleAD account. ,
Enabled: Account is MultiAD enabled ,
}
,
Required: False ,
}
enum ,
ldapConfiguration:
{
Description: LDAP Configuration for the account. ,
Required: False ,
}
{
domain:
{
Description: Name of the LDAP configuration domain ,
Required: False ,
}
string ,
ldapServers:
{
Description: List of LDAP server IP addresses (IPv4 only) for the LDAP domain. ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
serverCACertificate:
{
Description: When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate. ,
Format: password ,
Required: False ,
}
string ,
certificateCNHost:
{
Description: The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry. ,
Required: False ,
}
string ,
}
,
}
,
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 (200)

{
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 ,
Format: password ,
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 ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
Updating: Active Directory Updating ,
}
,
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. ,
Format: password ,
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. ,
Format: uri ,
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 ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
Updating: KeyVault connection Updating ,
}
,
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 ,
multiAdStatus:
{
Description: MultiAD Status for the account ,
Enum:
{
Disabled: Account is MultiAD disabled, Means its a SharedAD or SingleAD account. ,
Enabled: Account is MultiAD enabled ,
}
,
Required: False ,
}
enum ,
ldapConfiguration:
{
Description: LDAP Configuration for the account. ,
Required: False ,
}
{
domain:
{
Description: Name of the LDAP configuration domain ,
Required: False ,
}
string ,
ldapServers:
{
Description: List of LDAP server IP addresses (IPv4 only) for the LDAP domain. ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
serverCACertificate:
{
Description: When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate. ,
Format: password ,
Required: False ,
}
string ,
certificateCNHost:
{
Description: The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry. ,
Required: False ,
}
string ,
}
,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this 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)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: NetApp account resource ,
}
{
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 ,
Format: password ,
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 ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
Updating: Active Directory Updating ,
}
,
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. ,
Format: password ,
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. ,
Format: uri ,
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 ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
Updating: KeyVault connection Updating ,
}
,
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 ,
multiAdStatus:
{
Description: MultiAD Status for the account ,
Enum:
{
Disabled: Account is MultiAD disabled, Means its a SharedAD or SingleAD account. ,
Enabled: Account is MultiAD enabled ,
}
,
Required: False ,
}
enum ,
ldapConfiguration:
{
Description: LDAP Configuration for the account. ,
Required: False ,
}
{
domain:
{
Description: Name of the LDAP configuration domain ,
Required: False ,
}
string ,
ldapServers:
{
Description: List of LDAP server IP addresses (IPv4 only) for the LDAP domain. ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
serverCACertificate:
{
Description: When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate. ,
Format: password ,
Required: False ,
}
string ,
certificateCNHost:
{
Description: The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry. ,
Required: False ,
}
string ,
}
,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this 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 ,
}
,
]
,
}
,
}
BackupPolicies_List (updated)
Description :  List backup policies for Netapp Account
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupPolicies_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The BackupPolicy items on this page",
            "old": "A list of backup policies"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": [
              {
                "#name": "etag",
                "Description": {
                  "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
                  "old": "A unique read-only string that changes whenever the resource is updated."
                }
              }
            ]
          }
        },
        {
          "@added_b5fad43c8bda40c4a5ba5560d173f2c8": {
            "#name": "nextLink",
            "Description": "The link to the next page of items",
            "Format": "uri",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The BackupPolicy items on this page ,
Required: True ,
}
[
{
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 ,
}
,
]
,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
BackupPolicies_Get (updated)
Description :  Get a particular backup Policy
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupPolicies_Get",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
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 ,
}
,
]
,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
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 ,
}
,
]
,
}
,
}
BackupPolicies_Create (updated)
Description :  Create a backup policy for Netapp Account
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupPolicies_Create",
  "$parameters": {
    "body": {
      "$properties": [
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies/{backupPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
backupPolicyName:
{
Description: Backup policy Name which uniquely identify backup policy. ,
Required: True ,
}
string ,
body:
{
Description: Backup policy object supplied in the body of the operation. ,
Required: True ,
}
{
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 ,
}
,
]
,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
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 ,
}
,
]
,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Backup policy information ,
}
{
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 ,
}
,
]
,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
BackupPolicies_Update (updated)
Description :  Patch a backup policy for Netapp Account
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupPolicies_Update",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        }
      ]
    },
    "202": {
      "$properties": [
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        }
      ]
    }
  }
}

⚼ Request

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

{
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 ,
}
,
]
,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Backup policy information ,
}
{
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 ,
}
,
]
,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
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_ListByNetAppAccount (updated)
Description :  List and describe all Backup Vaults in the NetApp account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupVaults_ListByNetAppAccount",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The BackupVault items on this page",
            "old": "A list of Backup Vaults"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The BackupVault items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Backup Vault Properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Patch the specified NetApp Backup Vault
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupVaults_Update",
  "$responses": {
    "202": [
      {
        "@added_334b8d923b1043629cb3eff4c9ce9685": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
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:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$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 (updated)
Description :  Delete the specified Backup Vault
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupVaults_Delete",
  "$responses": {
    "202": [
      {
        "@added_fd3a8c24d73144289c11ba0b95ee0267": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

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

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Backups_ListByVault (updated)
Description :  List all backups Under a Backup Vault
Reference :  Link ¶

⚶ Changes

{
  "#id": "Backups_ListByVault",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Backup items on this page",
            "old": "A list of Backups"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The Backup items on this page ,
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 ,
snapshotCreationDate:
{
Description: The snapshot creation date of the backup ,
Format: date-time ,
Required: False ,
}
string ,
completionDate:
{
Description: The completion 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: The link to the next page of items ,
Format: uri ,
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_Update (updated)
Description :  Patch a Backup under the Backup Vault
Reference :  Link ¶

⚶ Changes

{
  "#id": "Backups_Update",
  "$responses": {
    "202": [
      {
        "@added_91e9d64b607e4b8e9262a220cf054215": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
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 ,
snapshotCreationDate:
{
Description: The snapshot creation date of the backup ,
Format: date-time ,
Required: False ,
}
string ,
completionDate:
{
Description: The completion 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:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$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 ,
snapshotCreationDate:
{
Description: The snapshot creation date of the backup ,
Format: date-time ,
Required: False ,
}
string ,
completionDate:
{
Description: The completion 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 (updated)
Description :  Delete a Backup under the Backup Vault
Reference :  Link ¶

⚶ Changes

{
  "#id": "Backups_Delete",
  "$responses": {
    "202": [
      {
        "@added_25bd94e6088044a88f7a838309190d2e": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

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

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

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

⚶ Changes

{
  "#id": "BackupsUnderBackupVault_RestoreFiles",
  "$responses": {
    "202": [
      {
        "@added_0b57bb4f05424c3691a3d13833513540": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}/restoreFiles
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
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 ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
Pools_List (updated)
Description :  List all capacity pools in the NetApp Account
Reference :  Link ¶

⚶ Changes

{
  "#id": "Pools_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The CapacityPool items on this page",
            "old": "List of Capacity pools"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": [
              {
                "properties": [
                  {
                    "#name": "customThroughputMibps",
                    "Type": {
                      "new": "integer",
                      "old": "number"
                    }
                  }
                ]
              },
              {
                "#name": "etag",
                "Description": {
                  "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
                  "old": "A unique read-only string that changes whenever the resource is updated."
                }
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The CapacityPool items on this page ,
Required: True ,
}
[
{
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. This will be deprecated soon. ,
Flexible: Flexible service level ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
totalThroughputMibps:
{
Description: Total throughput of pool in MiB/s ,
Format: float ,
Required: False ,
}
number ,
utilizedThroughputMibps:
{
Description: Utilized throughput of pool in MiB/s ,
Format: float ,
Required: False ,
}
number ,
customThroughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this pool and this will be accepted as input only for manual qosType pool with Flexible service level ,
Format: int32 ,
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 ,
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get details of the specified capacity pool
Reference :  Link ¶

⚶ Changes

{
  "#id": "Pools_Get",
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "#name": "customThroughputMibps",
              "Type": {
                "new": "integer",
                "old": "number"
              }
            }
          ]
        },
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (200)

{
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. This will be deprecated soon. ,
Flexible: Flexible service level ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
totalThroughputMibps:
{
Description: Total throughput of pool in MiB/s ,
Format: float ,
Required: False ,
}
number ,
utilizedThroughputMibps:
{
Description: Utilized throughput of pool in MiB/s ,
Format: float ,
Required: False ,
}
number ,
customThroughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this pool and this will be accepted as input only for manual qosType pool with Flexible service level ,
Format: int32 ,
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 ,
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
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_CreateOrUpdate (updated)
Description :  Create or Update a capacity pool
Reference :  Link ¶

⚶ Changes

{
  "#id": "Pools_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": [
        {
          "properties": [
            {
              "#name": "customThroughputMibps",
              "Type": {
                "new": "integer",
                "old": "number"
              }
            }
          ]
        },
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "#name": "customThroughputMibps",
              "Type": {
                "new": "integer",
                "old": "number"
              }
            }
          ]
        },
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "properties": [
            {
              "#name": "customThroughputMibps",
              "Type": {
                "new": "integer",
                "old": "number"
              }
            }
          ]
        },
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
body:
{
Description: Capacity pool object supplied in the body of the operation. ,
Required: True ,
}
{
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. This will be deprecated soon. ,
Flexible: Flexible service level ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
totalThroughputMibps:
{
Description: Total throughput of pool in MiB/s ,
Format: float ,
Required: False ,
}
number ,
utilizedThroughputMibps:
{
Description: Utilized throughput of pool in MiB/s ,
Format: float ,
Required: False ,
}
number ,
customThroughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this pool and this will be accepted as input only for manual qosType pool with Flexible service level ,
Format: int32 ,
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 ,
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
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. This will be deprecated soon. ,
Flexible: Flexible service level ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
totalThroughputMibps:
{
Description: Total throughput of pool in MiB/s ,
Format: float ,
Required: False ,
}
number ,
utilizedThroughputMibps:
{
Description: Utilized throughput of pool in MiB/s ,
Format: float ,
Required: False ,
}
number ,
customThroughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this pool and this will be accepted as input only for manual qosType pool with Flexible service level ,
Format: int32 ,
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 ,
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Capacity pool resource ,
}
{
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. This will be deprecated soon. ,
Flexible: Flexible service level ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
totalThroughputMibps:
{
Description: Total throughput of pool in MiB/s ,
Format: float ,
Required: False ,
}
number ,
utilizedThroughputMibps:
{
Description: Utilized throughput of pool in MiB/s ,
Format: float ,
Required: False ,
}
number ,
customThroughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this pool and this will be accepted as input only for manual qosType pool with Flexible service level ,
Format: int32 ,
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 ,
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
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_Update (updated)
Description :  Patch the specified capacity pool
Reference :  Link ¶

⚶ Changes

{
  "#id": "Pools_Update",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "#name": "customThroughputMibps",
            "Type": {
              "new": "integer",
              "old": "number"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "#name": "customThroughputMibps",
              "Type": {
                "new": "integer",
                "old": "number"
              }
            }
          ]
        },
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
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:
{
Description: Maximum throughput in MiB/s that can be achieved by this pool and this will be accepted as input only for manual qosType pool with Flexible service level ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
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. This will be deprecated soon. ,
Flexible: Flexible service level ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
totalThroughputMibps:
{
Description: Total throughput of pool in MiB/s ,
Format: float ,
Required: False ,
}
number ,
utilizedThroughputMibps:
{
Description: Utilized throughput of pool in MiB/s ,
Format: float ,
Required: False ,
}
number ,
customThroughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this pool and this will be accepted as input only for manual qosType pool with Flexible service level ,
Format: int32 ,
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 ,
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
Volumes_List (updated)
Description :  List all volumes within the capacity pool
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Volume items on this page",
            "old": "List of volumes"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": [
              {
                "properties": [
                  {
                    "dataProtection": [
                      {
                        "replication": [
                          {
                            "#name": "mirrorState",
                            "Enum": {
                              "new": [
                                [
                                  "Uninitialized",
                                  ""
                                ],
                                [
                                  "Mirrored",
                                  ""
                                ],
                                [
                                  "Broken",
                                  ""
                                ]
                              ],
                              "old": [
                                [
                                  "Uninitialized",
                                  "The mirror state is still uninitialized"
                                ],
                                [
                                  "Mirrored",
                                  "The mirror state is mirrored"
                                ],
                                [
                                  "Broken",
                                  "The mirror state is broken"
                                ]
                              ]
                            }
                          },
                          {
                            "#name": "relationshipStatus",
                            "Enum": {
                              "new": [
                                [
                                  "Idle",
                                  ""
                                ],
                                [
                                  "Transferring",
                                  ""
                                ]
                              ],
                              "old": [
                                [
                                  "Idle",
                                  "No data is currently being transferred between volumes"
                                ],
                                [
                                  "Transferring",
                                  "Data is being transferred between volumes"
                                ]
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "#name": "coolAccessRetrievalPolicy",
                    "Description": {
                      "new": "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:\nDefault - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\nOnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\nNever - No client-driven data is pulled from cool tier to standard storage.",
                      "old": "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: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage."
                    }
                  },
                  {
                    "#name": "unixPermissions",
                    "Description": {
                      "new": "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.",
                      "old": "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."
                    }
                  }
                ]
              },
              {
                "#name": "etag",
                "Description": {
                  "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
                  "old": "A unique read-only string that changes whenever the resource is updated."
                }
              },
              {
                "#name": "zones",
                "Description": {
                  "new": "The availability zones.",
                  "old": "Availability Zone"
                }
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The Volume items on this page ,
Required: True ,
}
[
{
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. This will be deprecated soon. ,
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 500TiB, 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 ,
}
,
]
,
externalReplicationSetupStatus:
{
Description: Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup. ,
Enum:
{
ClusterPeerRequired: Your cluster needs to be peered by using the 'peerExternalCluster' action ,
ClusterPeerPending: The peering needs to be accepted on your cluster before the setup can proceed ,
VServerPeerRequired: Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication ,
ReplicationCreateRequired: Need to call 'authorizeExternalReplication' to finish setting up the external replication ,
NoActionRequired: External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication ,
}
,
Required: False ,
}
enum ,
externalReplicationSetupInfo:
{
Description: Contains human-readable instructions on what the next step is to finish the external replication setup. ,
Required: False ,
}
string ,
mirrorState:
{
Description: The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized. ,
Enum:
{
Uninitialized: No description available. ,
Mirrored: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipStatus:
{
Description: The status of the Volume Replication ,
Enum:
{
Idle: No description available. ,
Transferring: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
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 ,
ldapServerType:
{
Description: Specifies the type of LDAP server for a given NFS volume. ,
Enum:
{
ActiveDirectory: The volume should use Active Directory for LDAP connections. ,
OpenLDAP: The volume should use OpenLDAP for LDAP connections. ,
}
,
Required: False ,
}
enum ,
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. ,
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get the details of the specified volume
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_Get",
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "dataProtection": [
                {
                  "replication": [
                    {
                      "#name": "mirrorState",
                      "Enum": {
                        "new": [
                          [
                            "Uninitialized",
                            ""
                          ],
                          [
                            "Mirrored",
                            ""
                          ],
                          [
                            "Broken",
                            ""
                          ]
                        ],
                        "old": [
                          [
                            "Uninitialized",
                            "The mirror state is still uninitialized"
                          ],
                          [
                            "Mirrored",
                            "The mirror state is mirrored"
                          ],
                          [
                            "Broken",
                            "The mirror state is broken"
                          ]
                        ]
                      }
                    },
                    {
                      "#name": "relationshipStatus",
                      "Enum": {
                        "new": [
                          [
                            "Idle",
                            ""
                          ],
                          [
                            "Transferring",
                            ""
                          ]
                        ],
                        "old": [
                          [
                            "Idle",
                            "No data is currently being transferred between volumes"
                          ],
                          [
                            "Transferring",
                            "Data is being transferred between volumes"
                          ]
                        ]
                      }
                    }
                  ]
                }
              ]
            },
            {
              "#name": "coolAccessRetrievalPolicy",
              "Description": {
                "new": "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:\nDefault - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\nOnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\nNever - No client-driven data is pulled from cool tier to standard storage.",
                "old": "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: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage."
              }
            },
            {
              "#name": "unixPermissions",
              "Description": {
                "new": "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.",
                "old": "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."
              }
            }
          ]
        },
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        },
        {
          "#name": "zones",
          "Description": {
            "new": "The availability zones.",
            "old": "Availability Zone"
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
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. This will be deprecated soon. ,
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 500TiB, 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 ,
}
,
]
,
externalReplicationSetupStatus:
{
Description: Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup. ,
Enum:
{
ClusterPeerRequired: Your cluster needs to be peered by using the 'peerExternalCluster' action ,
ClusterPeerPending: The peering needs to be accepted on your cluster before the setup can proceed ,
VServerPeerRequired: Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication ,
ReplicationCreateRequired: Need to call 'authorizeExternalReplication' to finish setting up the external replication ,
NoActionRequired: External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication ,
}
,
Required: False ,
}
enum ,
externalReplicationSetupInfo:
{
Description: Contains human-readable instructions on what the next step is to finish the external replication setup. ,
Required: False ,
}
string ,
mirrorState:
{
Description: The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized. ,
Enum:
{
Uninitialized: No description available. ,
Mirrored: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipStatus:
{
Description: The status of the Volume Replication ,
Enum:
{
Idle: No description available. ,
Transferring: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
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 ,
ldapServerType:
{
Description: Specifies the type of LDAP server for a given NFS volume. ,
Enum:
{
ActiveDirectory: The volume should use Active Directory for LDAP connections. ,
OpenLDAP: The volume should use OpenLDAP for LDAP connections. ,
}
,
Required: False ,
}
enum ,
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. ,
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
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_CreateOrUpdate (updated)
Description :  Create or update the specified volume within the capacity pool
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": [
        {
          "properties": [
            {
              "dataProtection": [
                {
                  "replication": [
                    {
                      "#name": "mirrorState",
                      "Enum": {
                        "new": [
                          [
                            "Uninitialized",
                            ""
                          ],
                          [
                            "Mirrored",
                            ""
                          ],
                          [
                            "Broken",
                            ""
                          ]
                        ],
                        "old": [
                          [
                            "Uninitialized",
                            "The mirror state is still uninitialized"
                          ],
                          [
                            "Mirrored",
                            "The mirror state is mirrored"
                          ],
                          [
                            "Broken",
                            "The mirror state is broken"
                          ]
                        ]
                      }
                    },
                    {
                      "#name": "relationshipStatus",
                      "Enum": {
                        "new": [
                          [
                            "Idle",
                            ""
                          ],
                          [
                            "Transferring",
                            ""
                          ]
                        ],
                        "old": [
                          [
                            "Idle",
                            "No data is currently being transferred between volumes"
                          ],
                          [
                            "Transferring",
                            "Data is being transferred between volumes"
                          ]
                        ]
                      }
                    }
                  ]
                }
              ]
            },
            {
              "#name": "coolAccessRetrievalPolicy",
              "Description": {
                "new": "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:\nDefault - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\nOnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\nNever - No client-driven data is pulled from cool tier to standard storage.",
                "old": "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: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage."
              }
            },
            {
              "#name": "unixPermissions",
              "Description": {
                "new": "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.",
                "old": "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."
              }
            }
          ]
        },
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        },
        {
          "#name": "zones",
          "Description": {
            "new": "The availability zones.",
            "old": "Availability Zone"
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "dataProtection": [
                {
                  "replication": [
                    {
                      "#name": "mirrorState",
                      "Enum": {
                        "new": [
                          [
                            "Uninitialized",
                            ""
                          ],
                          [
                            "Mirrored",
                            ""
                          ],
                          [
                            "Broken",
                            ""
                          ]
                        ],
                        "old": [
                          [
                            "Uninitialized",
                            "The mirror state is still uninitialized"
                          ],
                          [
                            "Mirrored",
                            "The mirror state is mirrored"
                          ],
                          [
                            "Broken",
                            "The mirror state is broken"
                          ]
                        ]
                      }
                    },
                    {
                      "#name": "relationshipStatus",
                      "Enum": {
                        "new": [
                          [
                            "Idle",
                            ""
                          ],
                          [
                            "Transferring",
                            ""
                          ]
                        ],
                        "old": [
                          [
                            "Idle",
                            "No data is currently being transferred between volumes"
                          ],
                          [
                            "Transferring",
                            "Data is being transferred between volumes"
                          ]
                        ]
                      }
                    }
                  ]
                }
              ]
            },
            {
              "#name": "coolAccessRetrievalPolicy",
              "Description": {
                "new": "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:\nDefault - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\nOnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\nNever - No client-driven data is pulled from cool tier to standard storage.",
                "old": "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: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage."
              }
            },
            {
              "#name": "unixPermissions",
              "Description": {
                "new": "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.",
                "old": "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."
              }
            }
          ]
        },
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        },
        {
          "#name": "zones",
          "Description": {
            "new": "The availability zones.",
            "old": "Availability Zone"
          }
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "properties": [
            {
              "dataProtection": [
                {
                  "replication": [
                    {
                      "#name": "mirrorState",
                      "Enum": {
                        "new": [
                          [
                            "Uninitialized",
                            ""
                          ],
                          [
                            "Mirrored",
                            ""
                          ],
                          [
                            "Broken",
                            ""
                          ]
                        ],
                        "old": [
                          [
                            "Uninitialized",
                            "The mirror state is still uninitialized"
                          ],
                          [
                            "Mirrored",
                            "The mirror state is mirrored"
                          ],
                          [
                            "Broken",
                            "The mirror state is broken"
                          ]
                        ]
                      }
                    },
                    {
                      "#name": "relationshipStatus",
                      "Enum": {
                        "new": [
                          [
                            "Idle",
                            ""
                          ],
                          [
                            "Transferring",
                            ""
                          ]
                        ],
                        "old": [
                          [
                            "Idle",
                            "No data is currently being transferred between volumes"
                          ],
                          [
                            "Transferring",
                            "Data is being transferred between volumes"
                          ]
                        ]
                      }
                    }
                  ]
                }
              ]
            },
            {
              "#name": "coolAccessRetrievalPolicy",
              "Description": {
                "new": "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:\nDefault - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\nOnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\nNever - No client-driven data is pulled from cool tier to standard storage.",
                "old": "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: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage."
              }
            },
            {
              "#name": "unixPermissions",
              "Description": {
                "new": "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.",
                "old": "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."
              }
            }
          ]
        },
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        },
        {
          "#name": "zones",
          "Description": {
            "new": "The availability zones.",
            "old": "Availability Zone"
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
body:
{
Description: Volume object supplied in the body of the operation. ,
Required: True ,
}
{
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. This will be deprecated soon. ,
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 500TiB, 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 ,
}
,
]
,
externalReplicationSetupStatus:
{
Description: Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup. ,
Enum:
{
ClusterPeerRequired: Your cluster needs to be peered by using the 'peerExternalCluster' action ,
ClusterPeerPending: The peering needs to be accepted on your cluster before the setup can proceed ,
VServerPeerRequired: Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication ,
ReplicationCreateRequired: Need to call 'authorizeExternalReplication' to finish setting up the external replication ,
NoActionRequired: External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication ,
}
,
Required: False ,
}
enum ,
externalReplicationSetupInfo:
{
Description: Contains human-readable instructions on what the next step is to finish the external replication setup. ,
Required: False ,
}
string ,
mirrorState:
{
Description: The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized. ,
Enum:
{
Uninitialized: No description available. ,
Mirrored: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipStatus:
{
Description: The status of the Volume Replication ,
Enum:
{
Idle: No description available. ,
Transferring: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
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 ,
ldapServerType:
{
Description: Specifies the type of LDAP server for a given NFS volume. ,
Enum:
{
ActiveDirectory: The volume should use Active Directory for LDAP connections. ,
OpenLDAP: The volume should use OpenLDAP for LDAP connections. ,
}
,
Required: False ,
}
enum ,
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. ,
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
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. This will be deprecated soon. ,
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 500TiB, 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 ,
}
,
]
,
externalReplicationSetupStatus:
{
Description: Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup. ,
Enum:
{
ClusterPeerRequired: Your cluster needs to be peered by using the 'peerExternalCluster' action ,
ClusterPeerPending: The peering needs to be accepted on your cluster before the setup can proceed ,
VServerPeerRequired: Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication ,
ReplicationCreateRequired: Need to call 'authorizeExternalReplication' to finish setting up the external replication ,
NoActionRequired: External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication ,
}
,
Required: False ,
}
enum ,
externalReplicationSetupInfo:
{
Description: Contains human-readable instructions on what the next step is to finish the external replication setup. ,
Required: False ,
}
string ,
mirrorState:
{
Description: The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized. ,
Enum:
{
Uninitialized: No description available. ,
Mirrored: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipStatus:
{
Description: The status of the Volume Replication ,
Enum:
{
Idle: No description available. ,
Transferring: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
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 ,
ldapServerType:
{
Description: Specifies the type of LDAP server for a given NFS volume. ,
Enum:
{
ActiveDirectory: The volume should use Active Directory for LDAP connections. ,
OpenLDAP: The volume should use OpenLDAP for LDAP connections. ,
}
,
Required: False ,
}
enum ,
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. ,
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Volume resource ,
}
{
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. This will be deprecated soon. ,
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 500TiB, 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 ,
}
,
]
,
externalReplicationSetupStatus:
{
Description: Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup. ,
Enum:
{
ClusterPeerRequired: Your cluster needs to be peered by using the 'peerExternalCluster' action ,
ClusterPeerPending: The peering needs to be accepted on your cluster before the setup can proceed ,
VServerPeerRequired: Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication ,
ReplicationCreateRequired: Need to call 'authorizeExternalReplication' to finish setting up the external replication ,
NoActionRequired: External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication ,
}
,
Required: False ,
}
enum ,
externalReplicationSetupInfo:
{
Description: Contains human-readable instructions on what the next step is to finish the external replication setup. ,
Required: False ,
}
string ,
mirrorState:
{
Description: The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized. ,
Enum:
{
Uninitialized: No description available. ,
Mirrored: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipStatus:
{
Description: The status of the Volume Replication ,
Enum:
{
Idle: No description available. ,
Transferring: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
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 ,
ldapServerType:
{
Description: Specifies the type of LDAP server for a given NFS volume. ,
Enum:
{
ActiveDirectory: The volume should use Active Directory for LDAP connections. ,
OpenLDAP: The volume should use OpenLDAP for LDAP connections. ,
}
,
Required: False ,
}
enum ,
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. ,
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
Volumes_Update (updated)
Description :  Patch the specified volume
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_Update",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "#name": "coolAccessRetrievalPolicy",
            "Description": {
              "new": "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:\nDefault - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\nOnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\nNever - No client-driven data is pulled from cool tier to standard storage.",
              "old": "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: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "dataProtection": [
                {
                  "replication": [
                    {
                      "#name": "mirrorState",
                      "Enum": {
                        "new": [
                          [
                            "Uninitialized",
                            ""
                          ],
                          [
                            "Mirrored",
                            ""
                          ],
                          [
                            "Broken",
                            ""
                          ]
                        ],
                        "old": [
                          [
                            "Uninitialized",
                            "The mirror state is still uninitialized"
                          ],
                          [
                            "Mirrored",
                            "The mirror state is mirrored"
                          ],
                          [
                            "Broken",
                            "The mirror state is broken"
                          ]
                        ]
                      }
                    },
                    {
                      "#name": "relationshipStatus",
                      "Enum": {
                        "new": [
                          [
                            "Idle",
                            ""
                          ],
                          [
                            "Transferring",
                            ""
                          ]
                        ],
                        "old": [
                          [
                            "Idle",
                            "No data is currently being transferred between volumes"
                          ],
                          [
                            "Transferring",
                            "Data is being transferred between volumes"
                          ]
                        ]
                      }
                    }
                  ]
                }
              ]
            },
            {
              "#name": "coolAccessRetrievalPolicy",
              "Description": {
                "new": "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:\nDefault - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\nOnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\nNever - No client-driven data is pulled from cool tier to standard storage.",
                "old": "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: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage."
              }
            },
            {
              "#name": "unixPermissions",
              "Description": {
                "new": "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.",
                "old": "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."
              }
            }
          ]
        },
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        },
        {
          "#name": "zones",
          "Description": {
            "new": "The availability zones.",
            "old": "Availability Zone"
          }
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
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. This will be deprecated soon. ,
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 500TiB, 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:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
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. This will be deprecated soon. ,
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 500TiB, 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 ,
}
,
]
,
externalReplicationSetupStatus:
{
Description: Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup. ,
Enum:
{
ClusterPeerRequired: Your cluster needs to be peered by using the 'peerExternalCluster' action ,
ClusterPeerPending: The peering needs to be accepted on your cluster before the setup can proceed ,
VServerPeerRequired: Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication ,
ReplicationCreateRequired: Need to call 'authorizeExternalReplication' to finish setting up the external replication ,
NoActionRequired: External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication ,
}
,
Required: False ,
}
enum ,
externalReplicationSetupInfo:
{
Description: Contains human-readable instructions on what the next step is to finish the external replication setup. ,
Required: False ,
}
string ,
mirrorState:
{
Description: The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized. ,
Enum:
{
Uninitialized: No description available. ,
Mirrored: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipStatus:
{
Description: The status of the Volume Replication ,
Enum:
{
Idle: No description available. ,
Transferring: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
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 ,
ldapServerType:
{
Description: Specifies the type of LDAP server for a given NFS volume. ,
Enum:
{
ActiveDirectory: The volume should use Active Directory for LDAP connections. ,
OpenLDAP: The volume should use OpenLDAP for LDAP connections. ,
}
,
Required: False ,
}
enum ,
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. ,
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
Volumes_AuthorizeExternalReplication (updated)
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 ¶

⚶ Changes

{
  "#id": "Volumes_AuthorizeExternalReplication",
  "$responses": {
    "202": [
      {
        "@added_58fd93b0e8614f4ab5caba7bd5abec32": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

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

⚐ 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:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
Volumes_BreakFileLocks (updated)
Description :  Break all the file locks on a volume
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_BreakFileLocks",
  "$responses": {
    "202": [
      {
        "@added_bdc0288c53454c34a4fdd36a44d597f6": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakFileLocks
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
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:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
Buckets_List (updated)
Description :  Describes all buckets belonging to a volume. Buckets allow additional services, such as AI services, connect to the volume data contained in those buckets.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Buckets_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Bucket items on this page",
            "old": "List of volume buckets"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "provisioningState",
                  "Enum": {
                    "new": [
                      [
                        "Accepted",
                        "Accepted"
                      ],
                      [
                        "Creating",
                        "Creating"
                      ],
                      [
                        "Patching",
                        "Patching"
                      ],
                      [
                        "Deleting",
                        "Deleting"
                      ],
                      [
                        "Moving",
                        "Moving"
                      ],
                      [
                        "Failed",
                        "Failed"
                      ],
                      [
                        "Succeeded",
                        "Succeeded"
                      ]
                    ],
                    "old": [
                      [
                        "Succeeded",
                        "Resource has been created."
                      ],
                      [
                        "Failed",
                        "Resource creation failed."
                      ],
                      [
                        "Canceled",
                        "Resource creation was canceled."
                      ],
                      [
                        "Provisioning",
                        "Resource is getting provisioned"
                      ],
                      [
                        "Moving",
                        "Resource is getting moved"
                      ],
                      [
                        "Updating",
                        "Resource is updating"
                      ],
                      [
                        "Deleting",
                        "Resource is getting deleted"
                      ],
                      [
                        "Accepted",
                        "Resource has been accepted"
                      ]
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The Bucket items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Bucket properties ,
Required: False ,
}
{
path:
{
Description: The volume path mounted inside the bucket. The default is the root path '/' if no value is provided when the bucket is created. ,
Required: False ,
}
string ,
fileSystemUser:
{
Description: File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both. ,
Required: False ,
}
{
nfsUser:
{
Description: The effective NFS User ID and Group ID when accessing the volume data. ,
Required: False ,
}
{
userId:
{
Description: The NFS user's UID ,
Format: int64 ,
Required: False ,
}
integer ,
groupId:
{
Description: The NFS user's GID ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
cifsUser:
{
Description: The effective CIFS username when accessing the volume data. ,
Required: False ,
}
{
username:
{
Description: The CIFS user's username ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Accepted: Accepted ,
Creating: Creating ,
Patching: Patching ,
Deleting: Deleting ,
Moving: Moving ,
Failed: Failed ,
Succeeded: Succeeded ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The bucket credentials status. There states: "NoCredentialsSet": Access and Secret key pair have not been generated. "CredentialsExpired": Access and Secret key pair have expired. "Active": The certificate has been installed and credentials are unexpired. ,
Enum:
{
NoCredentialsSet: Access and Secret key pair have not been generated. ,
CredentialsExpired: Access and Secret key pair have expired. ,
Active: The certificate has been installed on the bucket server and the bucket credentials are unexpired. ,
}
,
Required: False ,
}
enum ,
server:
{
Description: Properties of the server managing the lifecycle of volume buckets ,
Required: False ,
}
{
fqdn:
{
Description: The host part of the bucket URL, resolving to the bucket IP address and allowed by the server certificate. ,
Required: False ,
}
string ,
certificateCommonName:
{
Description: Certificate Common Name taken from the certificate installed on the bucket server ,
Required: False ,
}
string ,
certificateExpiryDate:
{
Description: The bucket server's certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The bucket server's IPv4 address ,
Required: False ,
}
string ,
certificateObject:
{
Description: A base64-encoded PEM file, which includes both the bucket server's certificate and private key. It is used to authenticate the user and allows access to volume data in a read-only manner. ,
Required: False ,
}
string ,
}
,
permissions:
{
Description: Access permissions for the bucket. Either ReadOnly or ReadWrite. The default is ReadOnly if no value is provided during bucket creation. ,
Enum:
{
ReadOnly: Read-only access to bucket. ,
ReadWrite: Read-write access to bucket. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
Buckets_Get (updated)
Description :  Get the details of the specified volume's bucket. A bucket allows additional services, such as AI services, connect to the volume data contained in those buckets.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Buckets_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Accepted",
                  "Accepted"
                ],
                [
                  "Creating",
                  "Creating"
                ],
                [
                  "Patching",
                  "Patching"
                ],
                [
                  "Deleting",
                  "Deleting"
                ],
                [
                  "Moving",
                  "Moving"
                ],
                [
                  "Failed",
                  "Failed"
                ],
                [
                  "Succeeded",
                  "Succeeded"
                ]
              ],
              "old": [
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "Provisioning",
                  "Resource is getting provisioned"
                ],
                [
                  "Moving",
                  "Resource is getting moved"
                ],
                [
                  "Updating",
                  "Resource is updating"
                ],
                [
                  "Deleting",
                  "Resource is getting deleted"
                ],
                [
                  "Accepted",
                  "Resource has been accepted"
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Bucket properties ,
Required: False ,
}
{
path:
{
Description: The volume path mounted inside the bucket. The default is the root path '/' if no value is provided when the bucket is created. ,
Required: False ,
}
string ,
fileSystemUser:
{
Description: File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both. ,
Required: False ,
}
{
nfsUser:
{
Description: The effective NFS User ID and Group ID when accessing the volume data. ,
Required: False ,
}
{
userId:
{
Description: The NFS user's UID ,
Format: int64 ,
Required: False ,
}
integer ,
groupId:
{
Description: The NFS user's GID ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
cifsUser:
{
Description: The effective CIFS username when accessing the volume data. ,
Required: False ,
}
{
username:
{
Description: The CIFS user's username ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Accepted: Accepted ,
Creating: Creating ,
Patching: Patching ,
Deleting: Deleting ,
Moving: Moving ,
Failed: Failed ,
Succeeded: Succeeded ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The bucket credentials status. There states: "NoCredentialsSet": Access and Secret key pair have not been generated. "CredentialsExpired": Access and Secret key pair have expired. "Active": The certificate has been installed and credentials are unexpired. ,
Enum:
{
NoCredentialsSet: Access and Secret key pair have not been generated. ,
CredentialsExpired: Access and Secret key pair have expired. ,
Active: The certificate has been installed on the bucket server and the bucket credentials are unexpired. ,
}
,
Required: False ,
}
enum ,
server:
{
Description: Properties of the server managing the lifecycle of volume buckets ,
Required: False ,
}
{
fqdn:
{
Description: The host part of the bucket URL, resolving to the bucket IP address and allowed by the server certificate. ,
Required: False ,
}
string ,
certificateCommonName:
{
Description: Certificate Common Name taken from the certificate installed on the bucket server ,
Required: False ,
}
string ,
certificateExpiryDate:
{
Description: The bucket server's certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The bucket server's IPv4 address ,
Required: False ,
}
string ,
certificateObject:
{
Description: A base64-encoded PEM file, which includes both the bucket server's certificate and private key. It is used to authenticate the user and allows access to volume data in a read-only manner. ,
Required: False ,
}
string ,
}
,
permissions:
{
Description: Access permissions for the bucket. Either ReadOnly or ReadWrite. The default is ReadOnly if no value is provided during bucket creation. ,
Enum:
{
ReadOnly: Read-only access to bucket. ,
ReadWrite: Read-write access to bucket. ,
}
,
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 ,
}
,
]
,
}
,
}
Buckets_CreateOrUpdate (updated)
Description :  Creates or updates a bucket for a volume. A bucket allows additional services, such as AI services, connect to the volume data contained in those buckets.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Buckets_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Accepted",
                  "Accepted"
                ],
                [
                  "Creating",
                  "Creating"
                ],
                [
                  "Patching",
                  "Patching"
                ],
                [
                  "Deleting",
                  "Deleting"
                ],
                [
                  "Moving",
                  "Moving"
                ],
                [
                  "Failed",
                  "Failed"
                ],
                [
                  "Succeeded",
                  "Succeeded"
                ]
              ],
              "old": [
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "Provisioning",
                  "Resource is getting provisioned"
                ],
                [
                  "Moving",
                  "Resource is getting moved"
                ],
                [
                  "Updating",
                  "Resource is updating"
                ],
                [
                  "Deleting",
                  "Resource is getting deleted"
                ],
                [
                  "Accepted",
                  "Resource has been accepted"
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": [
    {
      "200": {
        "$properties": {
          "properties": [
            {
              "#name": "provisioningState",
              "Enum": {
                "new": [
                  [
                    "Accepted",
                    "Accepted"
                  ],
                  [
                    "Creating",
                    "Creating"
                  ],
                  [
                    "Patching",
                    "Patching"
                  ],
                  [
                    "Deleting",
                    "Deleting"
                  ],
                  [
                    "Moving",
                    "Moving"
                  ],
                  [
                    "Failed",
                    "Failed"
                  ],
                  [
                    "Succeeded",
                    "Succeeded"
                  ]
                ],
                "old": [
                  [
                    "Succeeded",
                    "Resource has been created."
                  ],
                  [
                    "Failed",
                    "Resource creation failed."
                  ],
                  [
                    "Canceled",
                    "Resource creation was canceled."
                  ],
                  [
                    "Provisioning",
                    "Resource is getting provisioned"
                  ],
                  [
                    "Moving",
                    "Resource is getting moved"
                  ],
                  [
                    "Updating",
                    "Resource is updating"
                  ],
                  [
                    "Deleting",
                    "Resource is getting deleted"
                  ],
                  [
                    "Accepted",
                    "Resource has been accepted"
                  ]
                ]
              }
            }
          ]
        }
      }
    },
    {
      "#status": "201",
      "$headers": [
        {
          "#name": "azure-asyncoperation",
          "Description": {
            "new": "A link to the status monitor",
            "old": "URL that can be used to check the status of the asynchronous operation"
          }
        },
        {
          "@added_4b9abd61b0d1430b8fd985b6f2442f25": {
            "#name": "retry-after",
            "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
            "Type": "integer"
          }
        },
        {
          "@removed_1eb25778324f41dbb0bc849bf206a07b": {
            "#name": "location",
            "Description": "URL that can be used to check the status of the asynchronous operation",
            "Type": "string"
          }
        }
      ],
      "$schema": {
        "$properties": {
          "properties": [
            {
              "#name": "provisioningState",
              "Enum": {
                "new": [
                  [
                    "Accepted",
                    "Accepted"
                  ],
                  [
                    "Creating",
                    "Creating"
                  ],
                  [
                    "Patching",
                    "Patching"
                  ],
                  [
                    "Deleting",
                    "Deleting"
                  ],
                  [
                    "Moving",
                    "Moving"
                  ],
                  [
                    "Failed",
                    "Failed"
                  ],
                  [
                    "Succeeded",
                    "Succeeded"
                  ]
                ],
                "old": [
                  [
                    "Succeeded",
                    "Resource has been created."
                  ],
                  [
                    "Failed",
                    "Resource creation failed."
                  ],
                  [
                    "Canceled",
                    "Resource creation was canceled."
                  ],
                  [
                    "Provisioning",
                    "Resource is getting provisioned"
                  ],
                  [
                    "Moving",
                    "Resource is getting moved"
                  ],
                  [
                    "Updating",
                    "Resource is updating"
                  ],
                  [
                    "Deleting",
                    "Resource is getting deleted"
                  ],
                  [
                    "Accepted",
                    "Resource has been accepted"
                  ]
                ]
              }
            }
          ]
        }
      }
    }
  ]
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/buckets/{bucketName}
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
bucketName:
{
Description: The name of the bucket ,
Required: True ,
}
string ,
body:
{
Description: The bucket details including user details, and the volume path that should be mounted inside the bucket. ,
Required: True ,
}
{
properties:
{
Description: Bucket properties ,
Required: False ,
}
{
path:
{
Description: The volume path mounted inside the bucket. The default is the root path '/' if no value is provided when the bucket is created. ,
Required: False ,
}
string ,
fileSystemUser:
{
Description: File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both. ,
Required: False ,
}
{
nfsUser:
{
Description: The effective NFS User ID and Group ID when accessing the volume data. ,
Required: False ,
}
{
userId:
{
Description: The NFS user's UID ,
Format: int64 ,
Required: False ,
}
integer ,
groupId:
{
Description: The NFS user's GID ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
cifsUser:
{
Description: The effective CIFS username when accessing the volume data. ,
Required: False ,
}
{
username:
{
Description: The CIFS user's username ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Accepted: Accepted ,
Creating: Creating ,
Patching: Patching ,
Deleting: Deleting ,
Moving: Moving ,
Failed: Failed ,
Succeeded: Succeeded ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The bucket credentials status. There states: "NoCredentialsSet": Access and Secret key pair have not been generated. "CredentialsExpired": Access and Secret key pair have expired. "Active": The certificate has been installed and credentials are unexpired. ,
Enum:
{
NoCredentialsSet: Access and Secret key pair have not been generated. ,
CredentialsExpired: Access and Secret key pair have expired. ,
Active: The certificate has been installed on the bucket server and the bucket credentials are unexpired. ,
}
,
Required: False ,
}
enum ,
server:
{
Description: Properties of the server managing the lifecycle of volume buckets ,
Required: False ,
}
{
fqdn:
{
Description: The host part of the bucket URL, resolving to the bucket IP address and allowed by the server certificate. ,
Required: False ,
}
string ,
certificateCommonName:
{
Description: Certificate Common Name taken from the certificate installed on the bucket server ,
Required: False ,
}
string ,
certificateExpiryDate:
{
Description: The bucket server's certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The bucket server's IPv4 address ,
Required: False ,
}
string ,
certificateObject:
{
Description: A base64-encoded PEM file, which includes both the bucket server's certificate and private key. It is used to authenticate the user and allows access to volume data in a read-only manner. ,
Required: False ,
}
string ,
}
,
permissions:
{
Description: Access permissions for the bucket. Either ReadOnly or ReadWrite. The default is ReadOnly if no value is provided during bucket creation. ,
Enum:
{
ReadOnly: Read-only access to bucket. ,
ReadWrite: Read-write access to bucket. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Bucket properties ,
Required: False ,
}
{
path:
{
Description: The volume path mounted inside the bucket. The default is the root path '/' if no value is provided when the bucket is created. ,
Required: False ,
}
string ,
fileSystemUser:
{
Description: File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both. ,
Required: False ,
}
{
nfsUser:
{
Description: The effective NFS User ID and Group ID when accessing the volume data. ,
Required: False ,
}
{
userId:
{
Description: The NFS user's UID ,
Format: int64 ,
Required: False ,
}
integer ,
groupId:
{
Description: The NFS user's GID ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
cifsUser:
{
Description: The effective CIFS username when accessing the volume data. ,
Required: False ,
}
{
username:
{
Description: The CIFS user's username ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Accepted: Accepted ,
Creating: Creating ,
Patching: Patching ,
Deleting: Deleting ,
Moving: Moving ,
Failed: Failed ,
Succeeded: Succeeded ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The bucket credentials status. There states: "NoCredentialsSet": Access and Secret key pair have not been generated. "CredentialsExpired": Access and Secret key pair have expired. "Active": The certificate has been installed and credentials are unexpired. ,
Enum:
{
NoCredentialsSet: Access and Secret key pair have not been generated. ,
CredentialsExpired: Access and Secret key pair have expired. ,
Active: The certificate has been installed on the bucket server and the bucket credentials are unexpired. ,
}
,
Required: False ,
}
enum ,
server:
{
Description: Properties of the server managing the lifecycle of volume buckets ,
Required: False ,
}
{
fqdn:
{
Description: The host part of the bucket URL, resolving to the bucket IP address and allowed by the server certificate. ,
Required: False ,
}
string ,
certificateCommonName:
{
Description: Certificate Common Name taken from the certificate installed on the bucket server ,
Required: False ,
}
string ,
certificateExpiryDate:
{
Description: The bucket server's certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The bucket server's IPv4 address ,
Required: False ,
}
string ,
certificateObject:
{
Description: A base64-encoded PEM file, which includes both the bucket server's certificate and private key. It is used to authenticate the user and allows access to volume data in a read-only manner. ,
Required: False ,
}
string ,
}
,
permissions:
{
Description: Access permissions for the bucket. Either ReadOnly or ReadWrite. The default is ReadOnly if no value is provided during bucket creation. ,
Enum:
{
ReadOnly: Read-only access to bucket. ,
ReadWrite: Read-write access to bucket. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Bucket resource ,
}
{
properties:
{
Description: Bucket properties ,
Required: False ,
}
{
path:
{
Description: The volume path mounted inside the bucket. The default is the root path '/' if no value is provided when the bucket is created. ,
Required: False ,
}
string ,
fileSystemUser:
{
Description: File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both. ,
Required: False ,
}
{
nfsUser:
{
Description: The effective NFS User ID and Group ID when accessing the volume data. ,
Required: False ,
}
{
userId:
{
Description: The NFS user's UID ,
Format: int64 ,
Required: False ,
}
integer ,
groupId:
{
Description: The NFS user's GID ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
cifsUser:
{
Description: The effective CIFS username when accessing the volume data. ,
Required: False ,
}
{
username:
{
Description: The CIFS user's username ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Accepted: Accepted ,
Creating: Creating ,
Patching: Patching ,
Deleting: Deleting ,
Moving: Moving ,
Failed: Failed ,
Succeeded: Succeeded ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The bucket credentials status. There states: "NoCredentialsSet": Access and Secret key pair have not been generated. "CredentialsExpired": Access and Secret key pair have expired. "Active": The certificate has been installed and credentials are unexpired. ,
Enum:
{
NoCredentialsSet: Access and Secret key pair have not been generated. ,
CredentialsExpired: Access and Secret key pair have expired. ,
Active: The certificate has been installed on the bucket server and the bucket credentials are unexpired. ,
}
,
Required: False ,
}
enum ,
server:
{
Description: Properties of the server managing the lifecycle of volume buckets ,
Required: False ,
}
{
fqdn:
{
Description: The host part of the bucket URL, resolving to the bucket IP address and allowed by the server certificate. ,
Required: False ,
}
string ,
certificateCommonName:
{
Description: Certificate Common Name taken from the certificate installed on the bucket server ,
Required: False ,
}
string ,
certificateExpiryDate:
{
Description: The bucket server's certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The bucket server's IPv4 address ,
Required: False ,
}
string ,
certificateObject:
{
Description: A base64-encoded PEM file, which includes both the bucket server's certificate and private key. It is used to authenticate the user and allows access to volume data in a read-only manner. ,
Required: False ,
}
string ,
}
,
permissions:
{
Description: Access permissions for the bucket. Either ReadOnly or ReadWrite. The default is ReadOnly if no value is provided during bucket creation. ,
Enum:
{
ReadOnly: Read-only access to bucket. ,
ReadWrite: Read-write access to bucket. ,
}
,
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 ,
}
,
]
,
}
,
}
Buckets_Update (updated)
Description :  Updates the details of a volume bucket.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Buckets_Update",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Accepted",
                  "Accepted"
                ],
                [
                  "Creating",
                  "Creating"
                ],
                [
                  "Patching",
                  "Patching"
                ],
                [
                  "Deleting",
                  "Deleting"
                ],
                [
                  "Moving",
                  "Moving"
                ],
                [
                  "Failed",
                  "Failed"
                ],
                [
                  "Succeeded",
                  "Succeeded"
                ]
              ],
              "old": [
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "Provisioning",
                  "Resource is getting provisioned"
                ],
                [
                  "Moving",
                  "Resource is getting moved"
                ],
                [
                  "Updating",
                  "Resource is updating"
                ],
                [
                  "Deleting",
                  "Resource is getting deleted"
                ],
                [
                  "Accepted",
                  "Resource has been accepted"
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Accepted",
                  "Accepted"
                ],
                [
                  "Creating",
                  "Creating"
                ],
                [
                  "Patching",
                  "Patching"
                ],
                [
                  "Deleting",
                  "Deleting"
                ],
                [
                  "Moving",
                  "Moving"
                ],
                [
                  "Failed",
                  "Failed"
                ],
                [
                  "Succeeded",
                  "Succeeded"
                ]
              ],
              "old": [
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "Provisioning",
                  "Resource is getting provisioned"
                ],
                [
                  "Moving",
                  "Resource is getting moved"
                ],
                [
                  "Updating",
                  "Resource is updating"
                ],
                [
                  "Deleting",
                  "Resource is getting deleted"
                ],
                [
                  "Accepted",
                  "Resource has been accepted"
                ]
              ]
            }
          }
        ]
      }
    },
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "URL that can be used to check the status of the asynchronous operation"
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "URI to poll the status of the operation"
        }
      },
      {
        "@added_9c07ff964c044a9d85c9b7ceab1754d9": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/buckets/{bucketName}
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
bucketName:
{
Description: The name of the bucket ,
Required: True ,
}
string ,
body:
{
Description: The bucket details including user details, and the volume path that should be mounted inside the bucket. ,
Required: True ,
}
{
properties:
{
Description: Bucket properties ,
Required: False ,
}
{
path:
{
Description: The volume path mounted inside the bucket. ,
Required: False ,
}
string ,
fileSystemUser:
{
Description: File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both. ,
Required: False ,
}
{
nfsUser:
{
Description: The effective NFS User ID and Group ID when accessing the volume data. ,
Required: False ,
}
{
userId:
{
Description: The NFS user's UID ,
Format: int64 ,
Required: False ,
}
integer ,
groupId:
{
Description: The NFS user's GID ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
cifsUser:
{
Description: The effective CIFS username when accessing the volume data. ,
Required: False ,
}
{
username:
{
Description: The CIFS user's username ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Accepted: Accepted ,
Creating: Creating ,
Patching: Patching ,
Deleting: Deleting ,
Moving: Moving ,
Failed: Failed ,
Succeeded: Succeeded ,
}
,
Required: False ,
}
enum ,
server:
{
Description: Properties of the server managing the lifecycle of volume buckets ,
Required: False ,
}
{
fqdn:
{
Description: The host part of the bucket URL, resolving to the bucket IP address and allowed by the server certificate. ,
Required: False ,
}
string ,
certificateObject:
{
Description: A base64-encoded PEM file, which includes both the bucket server's certificate and private key. It is used to authenticate the user and allows access to volume data in a read-only manner. ,
Required: False ,
}
string ,
}
,
permissions:
{
Description: Access permissions for the bucket. Either ReadOnly or ReadWrite. ,
Enum:
{
ReadOnly: Read-only access to bucket. ,
ReadWrite: Read-write access to bucket. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Bucket properties ,
Required: False ,
}
{
path:
{
Description: The volume path mounted inside the bucket. The default is the root path '/' if no value is provided when the bucket is created. ,
Required: False ,
}
string ,
fileSystemUser:
{
Description: File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both. ,
Required: False ,
}
{
nfsUser:
{
Description: The effective NFS User ID and Group ID when accessing the volume data. ,
Required: False ,
}
{
userId:
{
Description: The NFS user's UID ,
Format: int64 ,
Required: False ,
}
integer ,
groupId:
{
Description: The NFS user's GID ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
cifsUser:
{
Description: The effective CIFS username when accessing the volume data. ,
Required: False ,
}
{
username:
{
Description: The CIFS user's username ,
Required: False ,
}
string ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Enum:
{
Accepted: Accepted ,
Creating: Creating ,
Patching: Patching ,
Deleting: Deleting ,
Moving: Moving ,
Failed: Failed ,
Succeeded: Succeeded ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The bucket credentials status. There states: "NoCredentialsSet": Access and Secret key pair have not been generated. "CredentialsExpired": Access and Secret key pair have expired. "Active": The certificate has been installed and credentials are unexpired. ,
Enum:
{
NoCredentialsSet: Access and Secret key pair have not been generated. ,
CredentialsExpired: Access and Secret key pair have expired. ,
Active: The certificate has been installed on the bucket server and the bucket credentials are unexpired. ,
}
,
Required: False ,
}
enum ,
server:
{
Description: Properties of the server managing the lifecycle of volume buckets ,
Required: False ,
}
{
fqdn:
{
Description: The host part of the bucket URL, resolving to the bucket IP address and allowed by the server certificate. ,
Required: False ,
}
string ,
certificateCommonName:
{
Description: Certificate Common Name taken from the certificate installed on the bucket server ,
Required: False ,
}
string ,
certificateExpiryDate:
{
Description: The bucket server's certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
ipAddress:
{
Description: The bucket server's IPv4 address ,
Required: False ,
}
string ,
certificateObject:
{
Description: A base64-encoded PEM file, which includes both the bucket server's certificate and private key. It is used to authenticate the user and allows access to volume data in a read-only manner. ,
Required: False ,
}
string ,
}
,
permissions:
{
Description: Access permissions for the bucket. Either ReadOnly or ReadWrite. The default is ReadOnly if no value is provided during bucket creation. ,
Enum:
{
ReadOnly: Read-only access to bucket. ,
ReadWrite: Read-write access to bucket. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
Buckets_Delete (updated)
Description :  Delete a volume's bucket.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Buckets_Delete",
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "URL that can be used to check the status of the asynchronous operation"
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "URI to poll the status of the operation"
        }
      },
      {
        "@added_6110baadab364d50a55aff13d07315f0": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

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

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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_FinalizeExternalReplication (updated)
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 ¶

⚶ Changes

{
  "#id": "Volumes_FinalizeExternalReplication",
  "$responses": {
    "202": [
      {
        "@added_6c3e786add7540b79ee4ee95a619f642": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

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

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
Volumes_ListGetGroupIdListForLdapUser (updated)
Description :  Returns the list of group Ids for a specific LDAP User
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_ListGetGroupIdListForLdapUser",
  "$responses": {
    "202": [
      {
        "@added_e986c4fb2eed405a88712110f277574f": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/getGroupIdListForLdapUser
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
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:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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_GetLatestStatus (updated)
Description :  Get the latest status of the backup for a volume
Reference :  Link ¶

⚶ Changes

{
  "#id": "Backups_GetLatestStatus",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "mirrorState",
          "Description": {
            "new": "The status of the backup",
            "old": "The mirror state property describes the current status of data replication for a backup. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized."
          },
          "Enum": {
            "new": [
              [
                "Uninitialized",
                ""
              ],
              [
                "Mirrored",
                ""
              ],
              [
                "Broken",
                ""
              ]
            ],
            "old": [
              [
                "Uninitialized",
                "The mirror state is still uninitialized"
              ],
              [
                "Mirrored",
                "The mirror state is mirrored"
              ],
              [
                "Broken",
                "The mirror state is broken"
              ]
            ]
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ 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 (updated)
Description :  Get the latest status of the restore for a volume
Reference :  Link ¶

⚶ Changes

{
  "#id": "Backups_GetVolumeLatestRestoreStatus",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "mirrorState",
          "Description": {
            "new": "The status of the restore",
            "old": "The mirror state property describes the current status of data replication for a restore. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized."
          },
          "Enum": {
            "new": [
              [
                "Uninitialized",
                ""
              ],
              [
                "Mirrored",
                ""
              ],
              [
                "Broken",
                ""
              ]
            ],
            "old": [
              [
                "Uninitialized",
                "The mirror state is still uninitialized"
              ],
              [
                "Mirrored",
                "The mirror state is mirrored"
              ],
              [
                "Broken",
                "The mirror state is broken"
              ]
            ]
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ 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 ,
}
,
]
,
}
,
}
Volumes_ListQuotaReport (updated)
Description :  A long-running resource action.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_ListQuotaReport",
  "Description": {
    "new": "A long-running resource action.",
    "old": "Returns report of quotas for the volume"
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "List of quota reports",
            "old": "List of volume quota report records"
          }
        }
      ]
    },
    "202": [
      {
        "@added_40546e948aa54777a105935d8855e7ba": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of quota reports ,
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. ,
Format: float ,
Required: False ,
}
number ,
isDerivedQuota:
{
Description: Flag to indicate whether the quota is derived from default quota. ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
Volumes_ListReplications (updated)
Description :  List all replications for a specified volume
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_ListReplications",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Replication items on this page",
            "old": "A list of replications"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "@added_04268746c6e0470795630c0676ee89a8": {
            "#name": "nextLink",
            "Description": "The link to the next page of items",
            "Format": "uri",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The Replication items on this page ,
Required: True ,
}
[
{
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 ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
BackupsUnderVolume_MigrateBackups (updated)
Description :  Migrate the backups under volume to backup vault
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupsUnderVolume_MigrateBackups",
  "$responses": {
    "202": [
      {
        "@added_ef10cf28852745b681112a6b08c6f2ed": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

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

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
Volumes_PeerExternalCluster (updated)
Description :  Starts peering the external cluster for this migration volume
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_PeerExternalCluster",
  "$responses": {
    "202": [
      {
        "@added_ee1a6c8e5f0f4d5ca57fce8a2fc450b7": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/peerExternalCluster
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
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:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
Volumes_PerformReplicationTransfer (updated)
Description :  Performs an adhoc replication transfer on a volume with volumeType Migration
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_PerformReplicationTransfer",
  "$responses": {
    "202": [
      {
        "@added_3b807fb28011472284fbc1c13931485a": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

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

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
Volumes_PopulateAvailabilityZone (updated)
Description :  This operation will populate availability zone information for a volume
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_PopulateAvailabilityZone",
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "dataProtection": [
                {
                  "replication": [
                    {
                      "#name": "mirrorState",
                      "Enum": {
                        "new": [
                          [
                            "Uninitialized",
                            ""
                          ],
                          [
                            "Mirrored",
                            ""
                          ],
                          [
                            "Broken",
                            ""
                          ]
                        ],
                        "old": [
                          [
                            "Uninitialized",
                            "The mirror state is still uninitialized"
                          ],
                          [
                            "Mirrored",
                            "The mirror state is mirrored"
                          ],
                          [
                            "Broken",
                            "The mirror state is broken"
                          ]
                        ]
                      }
                    },
                    {
                      "#name": "relationshipStatus",
                      "Enum": {
                        "new": [
                          [
                            "Idle",
                            ""
                          ],
                          [
                            "Transferring",
                            ""
                          ]
                        ],
                        "old": [
                          [
                            "Idle",
                            "No data is currently being transferred between volumes"
                          ],
                          [
                            "Transferring",
                            "Data is being transferred between volumes"
                          ]
                        ]
                      }
                    }
                  ]
                }
              ]
            },
            {
              "#name": "coolAccessRetrievalPolicy",
              "Description": {
                "new": "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:\nDefault - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\nOnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\nNever - No client-driven data is pulled from cool tier to standard storage.",
                "old": "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: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage."
              }
            },
            {
              "#name": "unixPermissions",
              "Description": {
                "new": "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.",
                "old": "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."
              }
            }
          ]
        },
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        },
        {
          "#name": "zones",
          "Description": {
            "new": "The availability zones.",
            "old": "Availability Zone"
          }
        }
      ]
    },
    "202": [
      {
        "@added_295e2cf26258414686800cb779dc2bc1": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

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

⚐ Response (200)

{
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. This will be deprecated soon. ,
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 500TiB, 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 ,
}
,
]
,
externalReplicationSetupStatus:
{
Description: Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup. ,
Enum:
{
ClusterPeerRequired: Your cluster needs to be peered by using the 'peerExternalCluster' action ,
ClusterPeerPending: The peering needs to be accepted on your cluster before the setup can proceed ,
VServerPeerRequired: Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication ,
ReplicationCreateRequired: Need to call 'authorizeExternalReplication' to finish setting up the external replication ,
NoActionRequired: External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication ,
}
,
Required: False ,
}
enum ,
externalReplicationSetupInfo:
{
Description: Contains human-readable instructions on what the next step is to finish the external replication setup. ,
Required: False ,
}
string ,
mirrorState:
{
Description: The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized. ,
Enum:
{
Uninitialized: No description available. ,
Mirrored: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipStatus:
{
Description: The status of the Volume Replication ,
Enum:
{
Idle: No description available. ,
Transferring: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
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 ,
ldapServerType:
{
Description: Specifies the type of LDAP server for a given NFS volume. ,
Enum:
{
ActiveDirectory: The volume should use Active Directory for LDAP connections. ,
OpenLDAP: The volume should use OpenLDAP for LDAP connections. ,
}
,
Required: False ,
}
enum ,
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. ,
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
Volumes_ReplicationStatus (updated)
Description :  Get the status of the replication
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_ReplicationStatus",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "mirrorState",
          "Description": {
            "new": "The status of the replication",
            "old": "The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized."
          },
          "Enum": {
            "new": [
              [
                "Uninitialized",
                ""
              ],
              [
                "Mirrored",
                ""
              ],
              [
                "Broken",
                ""
              ]
            ],
            "old": [
              [
                "Uninitialized",
                "The mirror state is still uninitialized"
              ],
              [
                "Mirrored",
                "The mirror state is mirrored"
              ],
              [
                "Broken",
                "The mirror state is broken"
              ]
            ]
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ 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_ResetCifsPassword (updated)
Description :  Reset cifs password from volume
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_ResetCifsPassword",
  "$responses": {
    "202": [
      {
        "@added_ccd6869c20c140ce9e0c9f8fbcd650ce": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

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

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
Snapshots_List (updated)
Description :  List all snapshots associated with the volume
Reference :  Link ¶

⚶ Changes

{
  "#id": "Snapshots_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Snapshot items on this page",
            "old": "A list of Snapshots"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "@added_bccafd416b9d42a1896ded24688ce995": {
            "#name": "nextLink",
            "Description": "The link to the next page of items",
            "Format": "uri",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The Snapshot items on this page ,
Required: True ,
}
[
{
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 ,
}
,
location:
{
Description: Resource location ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_Update (updated)
Description :  Patch a snapshot
Reference :  Link ¶

⚶ Changes

{
  "#id": "Snapshots_Update",
  "$parameters": {
    "body": {
      "Description": {
        "new": "Snapshot of a Volume",
        "old": "Snapshot patch"
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
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 ,
}
,
location:
{
Description: Resource location ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
Volumes_SplitCloneFromParent (updated)
Description :  Split operation to convert clone volume to an independent volume.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_SplitCloneFromParent",
  "Description": {
    "new": "Split operation to convert clone volume to an independent volume.",
    "old": " Split operation to convert clone volume to an independent volume."
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "properties": [
            {
              "dataProtection": [
                {
                  "replication": [
                    {
                      "#name": "mirrorState",
                      "Enum": {
                        "new": [
                          [
                            "Uninitialized",
                            ""
                          ],
                          [
                            "Mirrored",
                            ""
                          ],
                          [
                            "Broken",
                            ""
                          ]
                        ],
                        "old": [
                          [
                            "Uninitialized",
                            "The mirror state is still uninitialized"
                          ],
                          [
                            "Mirrored",
                            "The mirror state is mirrored"
                          ],
                          [
                            "Broken",
                            "The mirror state is broken"
                          ]
                        ]
                      }
                    },
                    {
                      "#name": "relationshipStatus",
                      "Enum": {
                        "new": [
                          [
                            "Idle",
                            ""
                          ],
                          [
                            "Transferring",
                            ""
                          ]
                        ],
                        "old": [
                          [
                            "Idle",
                            "No data is currently being transferred between volumes"
                          ],
                          [
                            "Transferring",
                            "Data is being transferred between volumes"
                          ]
                        ]
                      }
                    }
                  ]
                }
              ]
            },
            {
              "#name": "coolAccessRetrievalPolicy",
              "Description": {
                "new": "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:\nDefault - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\nOnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\nNever - No client-driven data is pulled from cool tier to standard storage.",
                "old": "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: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage."
              }
            },
            {
              "#name": "unixPermissions",
              "Description": {
                "new": "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.",
                "old": "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."
              }
            }
          ]
        },
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        },
        {
          "#name": "zones",
          "Description": {
            "new": "The availability zones.",
            "old": "Availability Zone"
          }
        }
      ]
    },
    "202": [
      {
        "@added_9bd640faf9f04581a51fcb133641429b": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

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

⚐ Response (200)

{
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. This will be deprecated soon. ,
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 500TiB, 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 ,
}
,
]
,
externalReplicationSetupStatus:
{
Description: Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup. ,
Enum:
{
ClusterPeerRequired: Your cluster needs to be peered by using the 'peerExternalCluster' action ,
ClusterPeerPending: The peering needs to be accepted on your cluster before the setup can proceed ,
VServerPeerRequired: Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication ,
ReplicationCreateRequired: Need to call 'authorizeExternalReplication' to finish setting up the external replication ,
NoActionRequired: External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication ,
}
,
Required: False ,
}
enum ,
externalReplicationSetupInfo:
{
Description: Contains human-readable instructions on what the next step is to finish the external replication setup. ,
Required: False ,
}
string ,
mirrorState:
{
Description: The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized. ,
Enum:
{
Uninitialized: No description available. ,
Mirrored: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipStatus:
{
Description: The status of the Volume Replication ,
Enum:
{
Idle: No description available. ,
Transferring: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
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 ,
ldapServerType:
{
Description: Specifies the type of LDAP server for a given NFS volume. ,
Enum:
{
ActiveDirectory: The volume should use Active Directory for LDAP connections. ,
OpenLDAP: The volume should use OpenLDAP for LDAP connections. ,
}
,
Required: False ,
}
enum ,
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. ,
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
Subvolumes_ListByVolume (updated)
Description :  Returns a list of the subvolumes in the volume
Reference :  Link ¶

⚶ Changes

{
  "#id": "Subvolumes_ListByVolume",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SubvolumeInfo items on this page",
            "old": "A list of Subvolumes"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The SubvolumeInfo items on this page ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_ListByVolume (updated)
Description :  List all quota rules associated with the volume
Reference :  Link ¶

⚶ Changes

{
  "#id": "VolumeQuotaRules_ListByVolume",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The VolumeQuotaRule items on this page",
            "old": "A list of Volume Quota Rules"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "provisioningState",
                  "Description": {
                    "new": "Gets the status of the VolumeQuotaRule at the time the operation was called.",
                    "old": "Provisioning state of the resource"
                  },
                  "Enum": {
                    "new": [
                      [
                        "Accepted",
                        "Accepted"
                      ],
                      [
                        "Creating",
                        "Creating"
                      ],
                      [
                        "Patching",
                        "Patching"
                      ],
                      [
                        "Deleting",
                        "Deleting"
                      ],
                      [
                        "Moving",
                        "Moving"
                      ],
                      [
                        "Failed",
                        "Failed"
                      ],
                      [
                        "Succeeded",
                        "Succeeded"
                      ]
                    ],
                    "old": [
                      [
                        "Succeeded",
                        "Resource has been created."
                      ],
                      [
                        "Failed",
                        "Resource creation failed."
                      ],
                      [
                        "Canceled",
                        "Resource creation was canceled."
                      ],
                      [
                        "Provisioning",
                        "Resource is getting provisioned"
                      ],
                      [
                        "Moving",
                        "Resource is getting moved"
                      ],
                      [
                        "Updating",
                        "Resource is updating"
                      ],
                      [
                        "Deleting",
                        "Resource is getting deleted"
                      ],
                      [
                        "Accepted",
                        "Resource has been accepted"
                      ]
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "@added_35f35cf2a3674dd9838bea6605437d65": {
            "#name": "nextLink",
            "Description": "The link to the next page of items",
            "Format": "uri",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The VolumeQuotaRule items on this page ,
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: Accepted ,
Creating: Creating ,
Patching: Patching ,
Deleting: Deleting ,
Moving: Moving ,
Failed: Failed ,
Succeeded: Succeeded ,
}
,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get details of the specified quota rule
Reference :  Link ¶

⚶ Changes

{
  "#id": "VolumeQuotaRules_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Description": {
              "new": "Gets the status of the VolumeQuotaRule at the time the operation was called.",
              "old": "Provisioning state of the resource"
            },
            "Enum": {
              "new": [
                [
                  "Accepted",
                  "Accepted"
                ],
                [
                  "Creating",
                  "Creating"
                ],
                [
                  "Patching",
                  "Patching"
                ],
                [
                  "Deleting",
                  "Deleting"
                ],
                [
                  "Moving",
                  "Moving"
                ],
                [
                  "Failed",
                  "Failed"
                ],
                [
                  "Succeeded",
                  "Succeeded"
                ]
              ],
              "old": [
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "Provisioning",
                  "Resource is getting provisioned"
                ],
                [
                  "Moving",
                  "Resource is getting moved"
                ],
                [
                  "Updating",
                  "Resource is updating"
                ],
                [
                  "Deleting",
                  "Resource is getting deleted"
                ],
                [
                  "Accepted",
                  "Resource has been accepted"
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
volumeQuotaRuleName:
{
Description: The name of volume quota rule ,
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: Accepted ,
Creating: Creating ,
Patching: Patching ,
Deleting: Deleting ,
Moving: Moving ,
Failed: Failed ,
Succeeded: Succeeded ,
}
,
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 (updated)
Description :  Create the specified quota rule within the given volume
Reference :  Link ¶

⚶ Changes

{
  "#id": "VolumeQuotaRules_Create",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Description": {
              "new": "Gets the status of the VolumeQuotaRule at the time the operation was called.",
              "old": "Provisioning state of the resource"
            },
            "Enum": {
              "new": [
                [
                  "Accepted",
                  "Accepted"
                ],
                [
                  "Creating",
                  "Creating"
                ],
                [
                  "Patching",
                  "Patching"
                ],
                [
                  "Deleting",
                  "Deleting"
                ],
                [
                  "Moving",
                  "Moving"
                ],
                [
                  "Failed",
                  "Failed"
                ],
                [
                  "Succeeded",
                  "Succeeded"
                ]
              ],
              "old": [
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "Provisioning",
                  "Resource is getting provisioned"
                ],
                [
                  "Moving",
                  "Resource is getting moved"
                ],
                [
                  "Updating",
                  "Resource is updating"
                ],
                [
                  "Deleting",
                  "Resource is getting deleted"
                ],
                [
                  "Accepted",
                  "Resource has been accepted"
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Description": {
              "new": "Gets the status of the VolumeQuotaRule at the time the operation was called.",
              "old": "Provisioning state of the resource"
            },
            "Enum": {
              "new": [
                [
                  "Accepted",
                  "Accepted"
                ],
                [
                  "Creating",
                  "Creating"
                ],
                [
                  "Patching",
                  "Patching"
                ],
                [
                  "Deleting",
                  "Deleting"
                ],
                [
                  "Moving",
                  "Moving"
                ],
                [
                  "Failed",
                  "Failed"
                ],
                [
                  "Succeeded",
                  "Succeeded"
                ]
              ],
              "old": [
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "Provisioning",
                  "Resource is getting provisioned"
                ],
                [
                  "Moving",
                  "Resource is getting moved"
                ],
                [
                  "Updating",
                  "Resource is updating"
                ],
                [
                  "Deleting",
                  "Resource is getting deleted"
                ],
                [
                  "Accepted",
                  "Resource has been accepted"
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Description": {
              "new": "Gets the status of the VolumeQuotaRule at the time the operation was called.",
              "old": "Provisioning state of the resource"
            },
            "Enum": {
              "new": [
                [
                  "Accepted",
                  "Accepted"
                ],
                [
                  "Creating",
                  "Creating"
                ],
                [
                  "Patching",
                  "Patching"
                ],
                [
                  "Deleting",
                  "Deleting"
                ],
                [
                  "Moving",
                  "Moving"
                ],
                [
                  "Failed",
                  "Failed"
                ],
                [
                  "Succeeded",
                  "Succeeded"
                ]
              ],
              "old": [
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "Provisioning",
                  "Resource is getting provisioned"
                ],
                [
                  "Moving",
                  "Resource is getting moved"
                ],
                [
                  "Updating",
                  "Resource is updating"
                ],
                [
                  "Deleting",
                  "Resource is getting deleted"
                ],
                [
                  "Accepted",
                  "Resource has been accepted"
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
volumeQuotaRuleName:
{
Description: The name of volume quota rule ,
Required: True ,
}
string ,
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: Accepted ,
Creating: Creating ,
Patching: Patching ,
Deleting: Deleting ,
Moving: Moving ,
Failed: Failed ,
Succeeded: Succeeded ,
}
,
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 (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: Accepted ,
Creating: Creating ,
Patching: Patching ,
Deleting: Deleting ,
Moving: Moving ,
Failed: Failed ,
Succeeded: Succeeded ,
}
,
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)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Quota Rule of a Volume ,
}
{
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: Accepted ,
Creating: Creating ,
Patching: Patching ,
Deleting: Deleting ,
Moving: Moving ,
Failed: Failed ,
Succeeded: Succeeded ,
}
,
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 (updated)
Description :  Patch a quota rule
Reference :  Link ¶

⚶ Changes

{
  "#id": "VolumeQuotaRules_Update",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Description": {
              "new": "Gets the status of the VolumeQuotaRule at the time the operation was called.",
              "old": "Provisioning state of the resource"
            },
            "Enum": {
              "new": [
                [
                  "Accepted",
                  "Accepted"
                ],
                [
                  "Creating",
                  "Creating"
                ],
                [
                  "Patching",
                  "Patching"
                ],
                [
                  "Deleting",
                  "Deleting"
                ],
                [
                  "Moving",
                  "Moving"
                ],
                [
                  "Failed",
                  "Failed"
                ],
                [
                  "Succeeded",
                  "Succeeded"
                ]
              ],
              "old": [
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "Provisioning",
                  "Resource is getting provisioned"
                ],
                [
                  "Moving",
                  "Resource is getting moved"
                ],
                [
                  "Updating",
                  "Resource is updating"
                ],
                [
                  "Deleting",
                  "Resource is getting deleted"
                ],
                [
                  "Accepted",
                  "Resource has been accepted"
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Description": {
              "new": "Gets the status of the VolumeQuotaRule at the time the operation was called.",
              "old": "Provisioning state of the resource"
            },
            "Enum": {
              "new": [
                [
                  "Accepted",
                  "Accepted"
                ],
                [
                  "Creating",
                  "Creating"
                ],
                [
                  "Patching",
                  "Patching"
                ],
                [
                  "Deleting",
                  "Deleting"
                ],
                [
                  "Moving",
                  "Moving"
                ],
                [
                  "Failed",
                  "Failed"
                ],
                [
                  "Succeeded",
                  "Succeeded"
                ]
              ],
              "old": [
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "Provisioning",
                  "Resource is getting provisioned"
                ],
                [
                  "Moving",
                  "Resource is getting moved"
                ],
                [
                  "Updating",
                  "Resource is updating"
                ],
                [
                  "Deleting",
                  "Resource is getting deleted"
                ],
                [
                  "Accepted",
                  "Resource has been accepted"
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
volumeQuotaRuleName:
{
Description: The name of volume quota rule ,
Required: True ,
}
string ,
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: Accepted ,
Creating: Creating ,
Patching: Patching ,
Deleting: Deleting ,
Moving: Moving ,
Failed: Failed ,
Succeeded: Succeeded ,
}
,
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 (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: Accepted ,
Creating: Creating ,
Patching: Patching ,
Deleting: Deleting ,
Moving: Moving ,
Failed: Failed ,
Succeeded: Succeeded ,
}
,
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)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
Accounts_ChangeKeyVault (updated)
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 ¶

⚶ Changes

{
  "#id": "Accounts_ChangeKeyVault",
  "$responses": {
    "202": [
      {
        "@added_d58ffb84397940cb874b43189fbccf6c": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/changeKeyVault
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
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. ,
Format: uri ,
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:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
Accounts_GetChangeKeyVaultInformation (updated)
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 ¶

⚶ Changes

{
  "#id": "Accounts_GetChangeKeyVaultInformation",
  "$responses": {
    "202": [
      {
        "@added_1149afe966ba4a1681d5459a9257ee89": {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        }
      },
      {
        "@added_f120540b2c7d4cb0a56bf09726767097": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/getKeyVaultStatus
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (200)

{
properties:
{
Description: Represents the properties of the getKeyVaultStatus. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The URI of the key vault/managed HSM that should be used for encryption. ,
Format: uri ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key that should be used for encryption. ,
Required: False ,
}
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: False ,
}
[
{
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)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
BackupsUnderAccount_MigrateBackups (updated)
Description :  Migrate the backups under a NetApp account to backup vault
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupsUnderAccount_MigrateBackups",
  "$responses": {
    "202": [
      {
        "@added_edf1eab4e30f4f9eb74e2632a23fd067": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/migrateBackups
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
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 ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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 ,
}
,
]
,
}
,
}
NetAppResourceQuotaLimitsAccount_List (updated)
Description :  Gets a list of quota limits for all quotas that are under account. Currently PoolsPerAccount is the only one.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NetAppResourceQuotaLimitsAccount_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The QuotaItem items on this page",
            "old": "A list of QuotaItems"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "URL to get the next set of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/quotaLimits
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The QuotaItem items on this page ,
Required: True ,
}
[
{
properties:
{
Description: QuotaItem 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 ,
usage:
{
Description: The usage quota value. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_List (updated)
Description :  List snapshot policy
Reference :  Link ¶

⚶ Changes

{
  "#id": "SnapshotPolicies_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SnapshotPolicy items on this page",
            "old": "A list of snapshot policies"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": [
              {
                "#name": "etag",
                "Description": {
                  "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
                  "old": "A unique read-only string that changes whenever the resource is updated."
                }
              }
            ]
          }
        },
        {
          "@added_fb42e45542384d0d8580e1ef16772614": {
            "#name": "nextLink",
            "Description": "The link to the next page of items",
            "Format": "uri",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The SnapshotPolicy items on this page ,
Required: True ,
}
[
{
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 (updated)
Description :  Get a snapshot Policy
Reference :  Link ¶

⚶ Changes

{
  "#id": "SnapshotPolicies_Get",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
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 (updated)
Description :  Create a snapshot policy
Reference :  Link ¶

⚶ Changes

{
  "#id": "SnapshotPolicies_Create",
  "$parameters": {
    "body": {
      "$properties": [
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
snapshotPolicyName:
{
Description: The name of the snapshot policy ,
Required: True ,
}
string ,
body:
{
Description: Snapshot policy object supplied in the body of the operation. ,
Required: True ,
}
{
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
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 (updated)
Description :  Patch a snapshot policy
Reference :  Link ¶

⚶ Changes

{
  "#id": "SnapshotPolicies_Update",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        }
      ]
    },
    "202": {
      "$properties": [
        {
          "#name": "etag",
          "Description": {
            "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
            "old": "A unique read-only string that changes whenever the resource is updated."
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Snapshot policy information ,
}
{
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
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_ListVolumes (updated)
Description :  Get volumes associated with snapshot policy
Reference :  Link ¶

⚶ Changes

{
  "#id": "SnapshotPolicies_ListVolumes",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Volume items on this page",
            "old": "List of volumes"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": [
              {
                "properties": [
                  {
                    "dataProtection": [
                      {
                        "replication": [
                          {
                            "#name": "mirrorState",
                            "Enum": {
                              "new": [
                                [
                                  "Uninitialized",
                                  ""
                                ],
                                [
                                  "Mirrored",
                                  ""
                                ],
                                [
                                  "Broken",
                                  ""
                                ]
                              ],
                              "old": [
                                [
                                  "Uninitialized",
                                  "The mirror state is still uninitialized"
                                ],
                                [
                                  "Mirrored",
                                  "The mirror state is mirrored"
                                ],
                                [
                                  "Broken",
                                  "The mirror state is broken"
                                ]
                              ]
                            }
                          },
                          {
                            "#name": "relationshipStatus",
                            "Enum": {
                              "new": [
                                [
                                  "Idle",
                                  ""
                                ],
                                [
                                  "Transferring",
                                  ""
                                ]
                              ],
                              "old": [
                                [
                                  "Idle",
                                  "No data is currently being transferred between volumes"
                                ],
                                [
                                  "Transferring",
                                  "Data is being transferred between volumes"
                                ]
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "#name": "coolAccessRetrievalPolicy",
                    "Description": {
                      "new": "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:\nDefault - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\nOnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\nNever - No client-driven data is pulled from cool tier to standard storage.",
                      "old": "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: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage."
                    }
                  },
                  {
                    "#name": "unixPermissions",
                    "Description": {
                      "new": "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.",
                      "old": "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."
                    }
                  }
                ]
              },
              {
                "#name": "etag",
                "Description": {
                  "new": "\"If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\")",
                  "old": "A unique read-only string that changes whenever the resource is updated."
                }
              },
              {
                "#name": "zones",
                "Description": {
                  "new": "The availability zones.",
                  "old": "Availability Zone"
                }
              }
            ]
          }
        },
        {
          "@added_34b1c7383dc148b7a0352a49ce1b6818": {
            "#name": "nextLink",
            "Description": "The link to the next page of items",
            "Format": "uri",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The Volume items on this page ,
Required: True ,
}
[
{
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. This will be deprecated soon. ,
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 500TiB, 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 ,
}
,
]
,
externalReplicationSetupStatus:
{
Description: Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup. ,
Enum:
{
ClusterPeerRequired: Your cluster needs to be peered by using the 'peerExternalCluster' action ,
ClusterPeerPending: The peering needs to be accepted on your cluster before the setup can proceed ,
VServerPeerRequired: Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication ,
ReplicationCreateRequired: Need to call 'authorizeExternalReplication' to finish setting up the external replication ,
NoActionRequired: External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication ,
}
,
Required: False ,
}
enum ,
externalReplicationSetupInfo:
{
Description: Contains human-readable instructions on what the next step is to finish the external replication setup. ,
Required: False ,
}
string ,
mirrorState:
{
Description: The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized. ,
Enum:
{
Uninitialized: No description available. ,
Mirrored: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipStatus:
{
Description: The status of the Volume Replication ,
Enum:
{
Idle: No description available. ,
Transferring: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
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 ,
ldapServerType:
{
Description: Specifies the type of LDAP server for a given NFS volume. ,
Enum:
{
ActiveDirectory: The volume should use Active Directory for LDAP connections. ,
OpenLDAP: The volume should use OpenLDAP for LDAP connections. ,
}
,
Required: False ,
}
enum ,
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. ,
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 ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_TransitionToCmk (updated)
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 ¶

⚶ Changes

{
  "#id": "Accounts_TransitionToCmk",
  "$responses": {
    "202": [
      {
        "@added_efdb50ec915e494da488178d61fc1749": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/transitiontocmk
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
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:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
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_ListByNetAppAccount (updated)
Description :  List all volume groups for given account
Reference :  Link ¶

⚶ Changes

{
  "#id": "VolumeGroups_ListByNetAppAccount",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The VolumeGroup items on this page",
            "old": "List of volume Groups"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "@added_356d034ff9cb4842b1a446749108033d": {
            "#name": "nextLink",
            "Description": "The link to the next page of items",
            "Format": "uri",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The VolumeGroup items on this page ,
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 ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
VolumeGroups_Get (updated)
Description :  Get details of the specified volume group
Reference :  Link ¶

⚶ Changes

{
  "#id": "VolumeGroups_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "volumes": {
              "$properties": {
                "properties": [
                  {
                    "dataProtection": [
                      {
                        "replication": [
                          {
                            "#name": "mirrorState",
                            "Enum": {
                              "new": [
                                [
                                  "Uninitialized",
                                  ""
                                ],
                                [
                                  "Mirrored",
                                  ""
                                ],
                                [
                                  "Broken",
                                  ""
                                ]
                              ],
                              "old": [
                                [
                                  "Uninitialized",
                                  "The mirror state is still uninitialized"
                                ],
                                [
                                  "Mirrored",
                                  "The mirror state is mirrored"
                                ],
                                [
                                  "Broken",
                                  "The mirror state is broken"
                                ]
                              ]
                            }
                          },
                          {
                            "#name": "relationshipStatus",
                            "Enum": {
                              "new": [
                                [
                                  "Idle",
                                  ""
                                ],
                                [
                                  "Transferring",
                                  ""
                                ]
                              ],
                              "old": [
                                [
                                  "Idle",
                                  "No data is currently being transferred between volumes"
                                ],
                                [
                                  "Transferring",
                                  "Data is being transferred between volumes"
                                ]
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "#name": "coolAccessRetrievalPolicy",
                    "Description": {
                      "new": "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:\nDefault - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\nOnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\nNever - No client-driven data is pulled from cool tier to standard storage.",
                      "old": "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: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage."
                    }
                  },
                  {
                    "#name": "unixPermissions",
                    "Description": {
                      "new": "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.",
                      "old": "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."
                    }
                  }
                ]
              }
            }
          }
        ],
        "@removed_c9868ae7de4148b49c85081da0e46487": {
          "#name": "id",
          "Description": "Resource Id",
          "Required": false,
          "Type": "string"
        },
        "@removed_b6ac32beaf0d436d9cb98893d2566fe3": {
          "#name": "name",
          "Description": "Resource name",
          "Required": false,
          "Type": "string"
        },
        "@removed_6b5047de563c4fac8a2ccd71b9763e5c": {
          "#name": "type",
          "Description": "Resource type",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
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. This will be deprecated soon. ,
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 500TiB, 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 ,
}
,
]
,
externalReplicationSetupStatus:
{
Description: Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup. ,
Enum:
{
ClusterPeerRequired: Your cluster needs to be peered by using the 'peerExternalCluster' action ,
ClusterPeerPending: The peering needs to be accepted on your cluster before the setup can proceed ,
VServerPeerRequired: Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication ,
ReplicationCreateRequired: Need to call 'authorizeExternalReplication' to finish setting up the external replication ,
NoActionRequired: External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication ,
}
,
Required: False ,
}
enum ,
externalReplicationSetupInfo:
{
Description: Contains human-readable instructions on what the next step is to finish the external replication setup. ,
Required: False ,
}
string ,
mirrorState:
{
Description: The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized. ,
Enum:
{
Uninitialized: No description available. ,
Mirrored: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipStatus:
{
Description: The status of the Volume Replication ,
Enum:
{
Idle: No description available. ,
Transferring: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
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 ,
ldapServerType:
{
Description: Specifies the type of LDAP server for a given NFS volume. ,
Enum:
{
ActiveDirectory: The volume should use Active Directory for LDAP connections. ,
OpenLDAP: The volume should use OpenLDAP for LDAP connections. ,
}
,
Required: False ,
}
enum ,
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. ,
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 ,
}
,
}
,
]
,
}
,
location:
{
Description: Resource location ,
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 ,
}
,
]
,
}
,
}
VolumeGroups_Create (updated)
Description :  Create a volume group along with specified volumes
Reference :  Link ¶

⚶ Changes

{
  "#id": "VolumeGroups_Create",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "volumes": {
              "$properties": {
                "properties": [
                  {
                    "dataProtection": [
                      {
                        "replication": [
                          {
                            "#name": "mirrorState",
                            "Enum": {
                              "new": [
                                [
                                  "Uninitialized",
                                  ""
                                ],
                                [
                                  "Mirrored",
                                  ""
                                ],
                                [
                                  "Broken",
                                  ""
                                ]
                              ],
                              "old": [
                                [
                                  "Uninitialized",
                                  "The mirror state is still uninitialized"
                                ],
                                [
                                  "Mirrored",
                                  "The mirror state is mirrored"
                                ],
                                [
                                  "Broken",
                                  "The mirror state is broken"
                                ]
                              ]
                            }
                          },
                          {
                            "#name": "relationshipStatus",
                            "Enum": {
                              "new": [
                                [
                                  "Idle",
                                  ""
                                ],
                                [
                                  "Transferring",
                                  ""
                                ]
                              ],
                              "old": [
                                [
                                  "Idle",
                                  "No data is currently being transferred between volumes"
                                ],
                                [
                                  "Transferring",
                                  "Data is being transferred between volumes"
                                ]
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "#name": "coolAccessRetrievalPolicy",
                    "Description": {
                      "new": "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:\nDefault - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\nOnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\nNever - No client-driven data is pulled from cool tier to standard storage.",
                      "old": "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: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage."
                    }
                  },
                  {
                    "#name": "unixPermissions",
                    "Description": {
                      "new": "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.",
                      "old": "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."
                    }
                  }
                ]
              }
            }
          }
        ],
        "@removed_ab22532737d949ed84bc60b755cc230b": {
          "#name": "id",
          "Description": "Resource Id",
          "Required": false,
          "Type": "string"
        },
        "@removed_75f4fe53101c4221b64ad7747f08decd": {
          "#name": "name",
          "Description": "Resource name",
          "Required": false,
          "Type": "string"
        },
        "@removed_9d39d21f2f794f39b07feeeee81d6ecd": {
          "#name": "type",
          "Description": "Resource type",
          "Required": false,
          "Type": "string"
        }
      }
    }
  },
  "$responses": {
    "201": {
      "$properties": {
        "properties": [
          {
            "volumes": {
              "$properties": {
                "properties": [
                  {
                    "dataProtection": [
                      {
                        "replication": [
                          {
                            "#name": "mirrorState",
                            "Enum": {
                              "new": [
                                [
                                  "Uninitialized",
                                  ""
                                ],
                                [
                                  "Mirrored",
                                  ""
                                ],
                                [
                                  "Broken",
                                  ""
                                ]
                              ],
                              "old": [
                                [
                                  "Uninitialized",
                                  "The mirror state is still uninitialized"
                                ],
                                [
                                  "Mirrored",
                                  "The mirror state is mirrored"
                                ],
                                [
                                  "Broken",
                                  "The mirror state is broken"
                                ]
                              ]
                            }
                          },
                          {
                            "#name": "relationshipStatus",
                            "Enum": {
                              "new": [
                                [
                                  "Idle",
                                  ""
                                ],
                                [
                                  "Transferring",
                                  ""
                                ]
                              ],
                              "old": [
                                [
                                  "Idle",
                                  "No data is currently being transferred between volumes"
                                ],
                                [
                                  "Transferring",
                                  "Data is being transferred between volumes"
                                ]
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "#name": "coolAccessRetrievalPolicy",
                    "Description": {
                      "new": "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:\nDefault - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\nOnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\nNever - No client-driven data is pulled from cool tier to standard storage.",
                      "old": "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: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage."
                    }
                  },
                  {
                    "#name": "unixPermissions",
                    "Description": {
                      "new": "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.",
                      "old": "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."
                    }
                  }
                ]
              }
            }
          }
        ],
        "@removed_0277e9d25baa40b589395c5c5d1ed47d": {
          "#name": "id",
          "Description": "Resource Id",
          "Required": false,
          "Type": "string"
        },
        "@removed_4d576bad85b744a2b57f89328ce300e6": {
          "#name": "name",
          "Description": "Resource name",
          "Required": false,
          "Type": "string"
        },
        "@removed_badd90e59f6a44288204c7f5e7b93c8b": {
          "#name": "type",
          "Description": "Resource type",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups/{volumeGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
volumeGroupName:
{
Description: The name of the volumeGroup ,
Required: True ,
}
string ,
body:
{
Description: Volume Group object supplied in the body of the operation. ,
Required: True ,
}
{
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. This will be deprecated soon. ,
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 500TiB, 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 ,
}
,
]
,
externalReplicationSetupStatus:
{
Description: Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup. ,
Enum:
{
ClusterPeerRequired: Your cluster needs to be peered by using the 'peerExternalCluster' action ,
ClusterPeerPending: The peering needs to be accepted on your cluster before the setup can proceed ,
VServerPeerRequired: Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication ,
ReplicationCreateRequired: Need to call 'authorizeExternalReplication' to finish setting up the external replication ,
NoActionRequired: External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication ,
}
,
Required: False ,
}
enum ,
externalReplicationSetupInfo:
{
Description: Contains human-readable instructions on what the next step is to finish the external replication setup. ,
Required: False ,
}
string ,
mirrorState:
{
Description: The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized. ,
Enum:
{
Uninitialized: No description available. ,
Mirrored: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipStatus:
{
Description: The status of the Volume Replication ,
Enum:
{
Idle: No description available. ,
Transferring: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
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 ,
ldapServerType:
{
Description: Specifies the type of LDAP server for a given NFS volume. ,
Enum:
{
ActiveDirectory: The volume should use Active Directory for LDAP connections. ,
OpenLDAP: The volume should use OpenLDAP for LDAP connections. ,
}
,
Required: False ,
}
enum ,
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. ,
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 ,
}
,
}
,
]
,
}
,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Volume group resource for create ,
}
{
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. This will be deprecated soon. ,
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 500TiB, 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 ,
}
,
]
,
externalReplicationSetupStatus:
{
Description: Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup. ,
Enum:
{
ClusterPeerRequired: Your cluster needs to be peered by using the 'peerExternalCluster' action ,
ClusterPeerPending: The peering needs to be accepted on your cluster before the setup can proceed ,
VServerPeerRequired: Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication ,
ReplicationCreateRequired: Need to call 'authorizeExternalReplication' to finish setting up the external replication ,
NoActionRequired: External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication ,
}
,
Required: False ,
}
enum ,
externalReplicationSetupInfo:
{
Description: Contains human-readable instructions on what the next step is to finish the external replication setup. ,
Required: False ,
}
string ,
mirrorState:
{
Description: The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized. ,
Enum:
{
Uninitialized: No description available. ,
Mirrored: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
relationshipStatus:
{
Description: The status of the Volume Replication ,
Enum:
{
Idle: No description available. ,
Transferring: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
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 ,
ldapServerType:
{
Description: Specifies the type of LDAP server for a given NFS volume. ,
Enum:
{
ActiveDirectory: The volume should use Active Directory for LDAP connections. ,
OpenLDAP: The volume should use OpenLDAP for LDAP connections. ,
}
,
Required: False ,
}
enum ,
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. ,
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 ,
}
,
}
,
]
,
}
,
location:
{
Description: Resource location ,
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 ,
}
,
]
,
}
,
}