Microsoft.NetApp (stable:2025-06-01)

2025/11/10 • 4 updated methods

VolumeQuotaRules_ListByVolume (updated)
Description :  List all quota rules associated with the volume
Reference :  Link ¶

⚶ Changes

{
  "#id": "VolumeQuotaRules_ListByVolume",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "provisioningState",
                "Enum": {
                  "new": [
                    [
                      "Accepted",
                      "Resource has been Accepted"
                    ],
                    [
                      "Creating",
                      "Resource is being Created"
                    ],
                    [
                      "Patching",
                      "Resource is being Patched"
                    ],
                    [
                      "Deleting",
                      "Resource is being Deleted"
                    ],
                    [
                      "Moving",
                      "Resource is being Moved"
                    ],
                    [
                      "Failed",
                      "Resource has Failed"
                    ],
                    [
                      "Succeeded",
                      "Resource has Succeeded"
                    ]
                  ],
                  "old": [
                    [
                      "Accepted",
                      "Accepted"
                    ],
                    [
                      "Creating",
                      "Creating"
                    ],
                    [
                      "Patching",
                      "Patching"
                    ],
                    [
                      "Deleting",
                      "Deleting"
                    ],
                    [
                      "Moving",
                      "Moving"
                    ],
                    [
                      "Failed",
                      "Failed"
                    ],
                    [
                      "Succeeded",
                      "Succeeded"
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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: Resource has been Accepted ,
Creating: Resource is being Created ,
Patching: Resource is being Patched ,
Deleting: Resource is being Deleted ,
Moving: Resource is being Moved ,
Failed: Resource has Failed ,
Succeeded: Resource has 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",
            "Enum": {
              "new": [
                [
                  "Accepted",
                  "Resource has been Accepted"
                ],
                [
                  "Creating",
                  "Resource is being Created"
                ],
                [
                  "Patching",
                  "Resource is being Patched"
                ],
                [
                  "Deleting",
                  "Resource is being Deleted"
                ],
                [
                  "Moving",
                  "Resource is being Moved"
                ],
                [
                  "Failed",
                  "Resource has Failed"
                ],
                [
                  "Succeeded",
                  "Resource has Succeeded"
                ]
              ],
              "old": [
                [
                  "Accepted",
                  "Accepted"
                ],
                [
                  "Creating",
                  "Creating"
                ],
                [
                  "Patching",
                  "Patching"
                ],
                [
                  "Deleting",
                  "Deleting"
                ],
                [
                  "Moving",
                  "Moving"
                ],
                [
                  "Failed",
                  "Failed"
                ],
                [
                  "Succeeded",
                  "Succeeded"
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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: Resource has been Accepted ,
Creating: Resource is being Created ,
Patching: Resource is being Patched ,
Deleting: Resource is being Deleted ,
Moving: Resource is being Moved ,
Failed: Resource has Failed ,
Succeeded: Resource has 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",
            "Enum": {
              "new": [
                [
                  "Accepted",
                  "Resource has been Accepted"
                ],
                [
                  "Creating",
                  "Resource is being Created"
                ],
                [
                  "Patching",
                  "Resource is being Patched"
                ],
                [
                  "Deleting",
                  "Resource is being Deleted"
                ],
                [
                  "Moving",
                  "Resource is being Moved"
                ],
                [
                  "Failed",
                  "Resource has Failed"
                ],
                [
                  "Succeeded",
                  "Resource has Succeeded"
                ]
              ],
              "old": [
                [
                  "Accepted",
                  "Accepted"
                ],
                [
                  "Creating",
                  "Creating"
                ],
                [
                  "Patching",
                  "Patching"
                ],
                [
                  "Deleting",
                  "Deleting"
                ],
                [
                  "Moving",
                  "Moving"
                ],
                [
                  "Failed",
                  "Failed"
                ],
                [
                  "Succeeded",
                  "Succeeded"
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Accepted",
                  "Resource has been Accepted"
                ],
                [
                  "Creating",
                  "Resource is being Created"
                ],
                [
                  "Patching",
                  "Resource is being Patched"
                ],
                [
                  "Deleting",
                  "Resource is being Deleted"
                ],
                [
                  "Moving",
                  "Resource is being Moved"
                ],
                [
                  "Failed",
                  "Resource has Failed"
                ],
                [
                  "Succeeded",
                  "Resource has Succeeded"
                ]
              ],
              "old": [
                [
                  "Accepted",
                  "Accepted"
                ],
                [
                  "Creating",
                  "Creating"
                ],
                [
                  "Patching",
                  "Patching"
                ],
                [
                  "Deleting",
                  "Deleting"
                ],
                [
                  "Moving",
                  "Moving"
                ],
                [
                  "Failed",
                  "Failed"
                ],
                [
                  "Succeeded",
                  "Succeeded"
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Accepted",
                  "Resource has been Accepted"
                ],
                [
                  "Creating",
                  "Resource is being Created"
                ],
                [
                  "Patching",
                  "Resource is being Patched"
                ],
                [
                  "Deleting",
                  "Resource is being Deleted"
                ],
                [
                  "Moving",
                  "Resource is being Moved"
                ],
                [
                  "Failed",
                  "Resource has Failed"
                ],
                [
                  "Succeeded",
                  "Resource has Succeeded"
                ]
              ],
              "old": [
                [
                  "Accepted",
                  "Accepted"
                ],
                [
                  "Creating",
                  "Creating"
                ],
                [
                  "Patching",
                  "Patching"
                ],
                [
                  "Deleting",
                  "Deleting"
                ],
                [
                  "Moving",
                  "Moving"
                ],
                [
                  "Failed",
                  "Failed"
                ],
                [
                  "Succeeded",
                  "Succeeded"
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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: Resource has been Accepted ,
Creating: Resource is being Created ,
Patching: Resource is being Patched ,
Deleting: Resource is being Deleted ,
Moving: Resource is being Moved ,
Failed: Resource has Failed ,
Succeeded: Resource has 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: Resource has been Accepted ,
Creating: Resource is being Created ,
Patching: Resource is being Patched ,
Deleting: Resource is being Deleted ,
Moving: Resource is being Moved ,
Failed: Resource has Failed ,
Succeeded: Resource has 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: Resource has been Accepted ,
Creating: Resource is being Created ,
Patching: Resource is being Patched ,
Deleting: Resource is being Deleted ,
Moving: Resource is being Moved ,
Failed: Resource has Failed ,
Succeeded: Resource has 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",
            "Enum": {
              "new": [
                [
                  "Accepted",
                  "Resource has been Accepted"
                ],
                [
                  "Creating",
                  "Resource is being Created"
                ],
                [
                  "Patching",
                  "Resource is being Patched"
                ],
                [
                  "Deleting",
                  "Resource is being Deleted"
                ],
                [
                  "Moving",
                  "Resource is being Moved"
                ],
                [
                  "Failed",
                  "Resource has Failed"
                ],
                [
                  "Succeeded",
                  "Resource has Succeeded"
                ]
              ],
              "old": [
                [
                  "Accepted",
                  "Accepted"
                ],
                [
                  "Creating",
                  "Creating"
                ],
                [
                  "Patching",
                  "Patching"
                ],
                [
                  "Deleting",
                  "Deleting"
                ],
                [
                  "Moving",
                  "Moving"
                ],
                [
                  "Failed",
                  "Failed"
                ],
                [
                  "Succeeded",
                  "Succeeded"
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Accepted",
                  "Resource has been Accepted"
                ],
                [
                  "Creating",
                  "Resource is being Created"
                ],
                [
                  "Patching",
                  "Resource is being Patched"
                ],
                [
                  "Deleting",
                  "Resource is being Deleted"
                ],
                [
                  "Moving",
                  "Resource is being Moved"
                ],
                [
                  "Failed",
                  "Resource has Failed"
                ],
                [
                  "Succeeded",
                  "Resource has Succeeded"
                ]
              ],
              "old": [
                [
                  "Accepted",
                  "Accepted"
                ],
                [
                  "Creating",
                  "Creating"
                ],
                [
                  "Patching",
                  "Patching"
                ],
                [
                  "Deleting",
                  "Deleting"
                ],
                [
                  "Moving",
                  "Moving"
                ],
                [
                  "Failed",
                  "Failed"
                ],
                [
                  "Succeeded",
                  "Succeeded"
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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: Resource has been Accepted ,
Creating: Resource is being Created ,
Patching: Resource is being Patched ,
Deleting: Resource is being Deleted ,
Moving: Resource is being Moved ,
Failed: Resource has Failed ,
Succeeded: Resource has 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: Resource has been Accepted ,
Creating: Resource is being Created ,
Patching: Resource is being Patched ,
Deleting: Resource is being Deleted ,
Moving: Resource is being Moved ,
Failed: Resource has Failed ,
Succeeded: Resource has 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 ,
}
,
]
,
}
,
}