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

2025/11/10 • 8 updated methods

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": {
        "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}/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: 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 ,
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",
                  "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}/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: 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 ,
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",
                  "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}/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: 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 ,
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: 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 ,
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: 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 ,
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",
                  "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}/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: 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 ,
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: 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 ,
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 ,
}
,
]
,
}
,
}
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 ,
}
,
]
,
}
,
}