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

2025/12/11 • 2 new, 4 updated methods

Buckets_GenerateAkvCredentials (new)
Description :  Generate the access key and secret key used for accessing the specified volume bucket and store in Azure Key Vault.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/buckets/{bucketName}/generateAkvCredentials
{
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 content of the action request ,
Required: True ,
}
{
keyPairExpiryDays:
{
Description: The number of days from now until the newly generated Access and Secret key pair will expire. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Buckets_RefreshCertificate (new)
Description :  This operation will fetch the certificate from Azure Key Vault and install it on the bucket server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/buckets/{bucketName}/refreshCertificate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
poolName:
{
Description: The name of the capacity pool ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
bucketName:
{
Description: The name of the bucket ,
Required: True ,
}
string ,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Buckets_List (updated)
Description :  Describes all buckets belonging to a volume. Buckets allow additional services, such as AI services, connect to the volume data contained in those buckets.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Buckets_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "server": [
                  {
                    "#name": "certificateObject",
                    "Description": {
                      "new": "The base64-encoded contents of a PEM file, which includes both the bucket server's certificate and private key. It is generated by the end user and allows the user to access volume data in a read-only manner.\nNote: This is only used when Azure Key Vault is not configured. This property is mutually exclusive with the Azure Key Vault 'akv' properties.",
                      "old": "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."
                    }
                  },
                  {
                    "@added_00b083a56b0b49b587d5714cbf29ffda": {
                      "#name": "onCertificateConflictAction",
                      "Description": "Action to take when there is a certificate conflict.\nPossible values include: 'Update', 'Fail'",
                      "Enum": [
                        [
                          "Update",
                          "Update the existing certificate regardless of whether there is a conflict or not. This means all buckets on the server will now use the new certificate."
                        ],
                        [
                          "Fail",
                          "Fail the operation if a conflict occurs, meaning the bucket operation will fail, and the existing certificate will continue to be in use."
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              },
              {
                "@added_b5103f0d9ba94c758c1efabb41b70f3c": {
                  "#name": "akvDetails",
                  "Description": "Specifies the Azure Key Vault settings. These are used when\na) retrieving the bucket server certificate, and\nb) storing the bucket credentials\n\nNotes:\n\n1. If a bucket certificate was previously provided directly using the certificateObject property, it is possible to subsequently use the Azure Key Vault for certificate management by using these 'akvDetails' properties. However, once Azure Key Vault is configured, it is no longer possible to provide the certificate directly via the certificateObject property.\n2. These properties are mutually exclusive with the server.certificateObject property.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "certificateAkvDetails",
                      "Description": "Specifies the Azure Key Vault settings for retrieving the bucket server certificate.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "certificateKeyVaultUri",
                          "Description": "The base URI of the Azure Key Vault that is used when retrieving the bucket certificate.",
                          "Format": "uri",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "certificateName",
                          "Description": "The name of the bucket server certificate stored in the Azure Key Vault.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    },
                    {
                      "#name": "credentialsAkvDetails",
                      "Description": "Specifies the Azure Key Vault settings for storing the bucket credentials.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "credentialsKeyVaultUri",
                          "Description": "The base URI of the Azure Key Vault that is used when storing the bucket credentials.",
                          "Format": "uri",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "secretName",
                          "Description": "The name of the secret stored in Azure Key Vault. The associated key pair has the following structure:\n\n{\n\"access_key_id\": \"\",\n\"secret_access_key\": \"\"\n}",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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 ,
Updating: Resource is updating ,
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: The base64-encoded contents of a PEM file, which includes both the bucket server's certificate and private key. It is generated by the end user and allows the user to access volume data in a read-only manner. Note: This is only used when Azure Key Vault is not configured. This property is mutually exclusive with the Azure Key Vault 'akv' properties. ,
Format: password ,
Required: False ,
}
string ,
onCertificateConflictAction:
{
Description: Action to take when there is a certificate conflict. Possible values include: 'Update', 'Fail' ,
Enum:
{
Update: Update the existing certificate regardless of whether there is a conflict or not. This means all buckets on the server will now use the new certificate. ,
Fail: Fail the operation if a conflict occurs, meaning the bucket operation will fail, and the existing certificate will continue to be in use. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
akvDetails:
{
Description: Specifies the Azure Key Vault settings. These are used when a) retrieving the bucket server certificate, and b) storing the bucket credentials Notes: 1. If a bucket certificate was previously provided directly using the certificateObject property, it is possible to subsequently use the Azure Key Vault for certificate management by using these 'akvDetails' properties. However, once Azure Key Vault is configured, it is no longer possible to provide the certificate directly via the certificateObject property. 2. These properties are mutually exclusive with the server.certificateObject property. ,
Required: False ,
}
{
certificateAkvDetails:
{
Description: Specifies the Azure Key Vault settings for retrieving the bucket server certificate. ,
Required: False ,
}
{
certificateKeyVaultUri:
{
Description: The base URI of the Azure Key Vault that is used when retrieving the bucket certificate. ,
Format: uri ,
Required: False ,
}
string ,
certificateName:
{
Description: The name of the bucket server certificate stored in the Azure Key Vault. ,
Required: False ,
}
string ,
}
,
credentialsAkvDetails:
{
Description: Specifies the Azure Key Vault settings for storing the bucket credentials. ,
Required: False ,
}
{
credentialsKeyVaultUri:
{
Description: The base URI of the Azure Key Vault that is used when storing the bucket credentials. ,
Format: uri ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret stored in Azure Key Vault. The associated key pair has the following structure: { "access_key_id": "", "secret_access_key": "" } ,
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 ,
}
,
]
,
}
,
}
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": [
          {
            "server": [
              {
                "#name": "certificateObject",
                "Description": {
                  "new": "The base64-encoded contents of a PEM file, which includes both the bucket server's certificate and private key. It is generated by the end user and allows the user to access volume data in a read-only manner.\nNote: This is only used when Azure Key Vault is not configured. This property is mutually exclusive with the Azure Key Vault 'akv' properties.",
                  "old": "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."
                }
              },
              {
                "@added_3539a6ca6b984ca583ce15bae0def044": {
                  "#name": "onCertificateConflictAction",
                  "Description": "Action to take when there is a certificate conflict.\nPossible values include: 'Update', 'Fail'",
                  "Enum": [
                    [
                      "Update",
                      "Update the existing certificate regardless of whether there is a conflict or not. This means all buckets on the server will now use the new certificate."
                    ],
                    [
                      "Fail",
                      "Fail the operation if a conflict occurs, meaning the bucket operation will fail, and the existing certificate will continue to be in use."
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              }
            ]
          },
          {
            "@added_d34cc0ae8cee49a58da94daea2666649": {
              "#name": "akvDetails",
              "Description": "Specifies the Azure Key Vault settings. These are used when\na) retrieving the bucket server certificate, and\nb) storing the bucket credentials\n\nNotes:\n\n1. If a bucket certificate was previously provided directly using the certificateObject property, it is possible to subsequently use the Azure Key Vault for certificate management by using these 'akvDetails' properties. However, once Azure Key Vault is configured, it is no longer possible to provide the certificate directly via the certificateObject property.\n2. These properties are mutually exclusive with the server.certificateObject property.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "certificateAkvDetails",
                  "Description": "Specifies the Azure Key Vault settings for retrieving the bucket server certificate.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "certificateKeyVaultUri",
                      "Description": "The base URI of the Azure Key Vault that is used when retrieving the bucket certificate.",
                      "Format": "uri",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "certificateName",
                      "Description": "The name of the bucket server certificate stored in the Azure Key Vault.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                },
                {
                  "#name": "credentialsAkvDetails",
                  "Description": "Specifies the Azure Key Vault settings for storing the bucket credentials.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "credentialsKeyVaultUri",
                      "Description": "The base URI of the Azure Key Vault that is used when storing the bucket credentials.",
                      "Format": "uri",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "secretName",
                      "Description": "The name of the secret stored in Azure Key Vault. The associated key pair has the following structure:\n\n{\n\"access_key_id\": \"\",\n\"secret_access_key\": \"\"\n}",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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 ,
Updating: Resource is updating ,
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: The base64-encoded contents of a PEM file, which includes both the bucket server's certificate and private key. It is generated by the end user and allows the user to access volume data in a read-only manner. Note: This is only used when Azure Key Vault is not configured. This property is mutually exclusive with the Azure Key Vault 'akv' properties. ,
Format: password ,
Required: False ,
}
string ,
onCertificateConflictAction:
{
Description: Action to take when there is a certificate conflict. Possible values include: 'Update', 'Fail' ,
Enum:
{
Update: Update the existing certificate regardless of whether there is a conflict or not. This means all buckets on the server will now use the new certificate. ,
Fail: Fail the operation if a conflict occurs, meaning the bucket operation will fail, and the existing certificate will continue to be in use. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
akvDetails:
{
Description: Specifies the Azure Key Vault settings. These are used when a) retrieving the bucket server certificate, and b) storing the bucket credentials Notes: 1. If a bucket certificate was previously provided directly using the certificateObject property, it is possible to subsequently use the Azure Key Vault for certificate management by using these 'akvDetails' properties. However, once Azure Key Vault is configured, it is no longer possible to provide the certificate directly via the certificateObject property. 2. These properties are mutually exclusive with the server.certificateObject property. ,
Required: False ,
}
{
certificateAkvDetails:
{
Description: Specifies the Azure Key Vault settings for retrieving the bucket server certificate. ,
Required: False ,
}
{
certificateKeyVaultUri:
{
Description: The base URI of the Azure Key Vault that is used when retrieving the bucket certificate. ,
Format: uri ,
Required: False ,
}
string ,
certificateName:
{
Description: The name of the bucket server certificate stored in the Azure Key Vault. ,
Required: False ,
}
string ,
}
,
credentialsAkvDetails:
{
Description: Specifies the Azure Key Vault settings for storing the bucket credentials. ,
Required: False ,
}
{
credentialsKeyVaultUri:
{
Description: The base URI of the Azure Key Vault that is used when storing the bucket credentials. ,
Format: uri ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret stored in Azure Key Vault. The associated key pair has the following structure: { "access_key_id": "", "secret_access_key": "" } ,
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_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": [
          {
            "server": [
              {
                "#name": "certificateObject",
                "Description": {
                  "new": "The base64-encoded contents of a PEM file, which includes both the bucket server's certificate and private key. It is generated by the end user and allows the user to access volume data in a read-only manner.\nNote: This is only used when Azure Key Vault is not configured. This property is mutually exclusive with the Azure Key Vault 'akv' properties.",
                  "old": "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."
                }
              },
              {
                "@added_69d81c58a64846259567b1350184f8c9": {
                  "#name": "onCertificateConflictAction",
                  "Description": "Action to take when there is a certificate conflict.\nPossible values include: 'Update', 'Fail'",
                  "Enum": [
                    [
                      "Update",
                      "Update the existing certificate regardless of whether there is a conflict or not. This means all buckets on the server will now use the new certificate."
                    ],
                    [
                      "Fail",
                      "Fail the operation if a conflict occurs, meaning the bucket operation will fail, and the existing certificate will continue to be in use."
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              }
            ]
          },
          {
            "@added_431d6f3d1a1349a6b13b21bced912c74": {
              "#name": "akvDetails",
              "Description": "Specifies the Azure Key Vault settings. These are used when\na) retrieving the bucket server certificate, and\nb) storing the bucket credentials\n\nNotes:\n\n1. If a bucket certificate was previously provided directly using the certificateObject property, it is possible to subsequently use the Azure Key Vault for certificate management by using these 'akvDetails' properties. However, once Azure Key Vault is configured, it is no longer possible to provide the certificate directly via the certificateObject property.\n2. These properties are mutually exclusive with the server.certificateObject property.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "certificateAkvDetails",
                  "Description": "Specifies the Azure Key Vault settings for retrieving the bucket server certificate.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "certificateKeyVaultUri",
                      "Description": "The base URI of the Azure Key Vault that is used when retrieving the bucket certificate.",
                      "Format": "uri",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "certificateName",
                      "Description": "The name of the bucket server certificate stored in the Azure Key Vault.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                },
                {
                  "#name": "credentialsAkvDetails",
                  "Description": "Specifies the Azure Key Vault settings for storing the bucket credentials.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "credentialsKeyVaultUri",
                      "Description": "The base URI of the Azure Key Vault that is used when storing the bucket credentials.",
                      "Format": "uri",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "secretName",
                      "Description": "The name of the secret stored in Azure Key Vault. The associated key pair has the following structure:\n\n{\n\"access_key_id\": \"\",\n\"secret_access_key\": \"\"\n}",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "server": [
              {
                "#name": "certificateObject",
                "Description": {
                  "new": "The base64-encoded contents of a PEM file, which includes both the bucket server's certificate and private key. It is generated by the end user and allows the user to access volume data in a read-only manner.\nNote: This is only used when Azure Key Vault is not configured. This property is mutually exclusive with the Azure Key Vault 'akv' properties.",
                  "old": "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."
                }
              },
              {
                "@added_1845b51f42854395847c00e02278571d": {
                  "#name": "onCertificateConflictAction",
                  "Description": "Action to take when there is a certificate conflict.\nPossible values include: 'Update', 'Fail'",
                  "Enum": [
                    [
                      "Update",
                      "Update the existing certificate regardless of whether there is a conflict or not. This means all buckets on the server will now use the new certificate."
                    ],
                    [
                      "Fail",
                      "Fail the operation if a conflict occurs, meaning the bucket operation will fail, and the existing certificate will continue to be in use."
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              }
            ]
          },
          {
            "@added_b900a9412b3240848ba348ff1ab2c40a": {
              "#name": "akvDetails",
              "Description": "Specifies the Azure Key Vault settings. These are used when\na) retrieving the bucket server certificate, and\nb) storing the bucket credentials\n\nNotes:\n\n1. If a bucket certificate was previously provided directly using the certificateObject property, it is possible to subsequently use the Azure Key Vault for certificate management by using these 'akvDetails' properties. However, once Azure Key Vault is configured, it is no longer possible to provide the certificate directly via the certificateObject property.\n2. These properties are mutually exclusive with the server.certificateObject property.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "certificateAkvDetails",
                  "Description": "Specifies the Azure Key Vault settings for retrieving the bucket server certificate.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "certificateKeyVaultUri",
                      "Description": "The base URI of the Azure Key Vault that is used when retrieving the bucket certificate.",
                      "Format": "uri",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "certificateName",
                      "Description": "The name of the bucket server certificate stored in the Azure Key Vault.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                },
                {
                  "#name": "credentialsAkvDetails",
                  "Description": "Specifies the Azure Key Vault settings for storing the bucket credentials.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "credentialsKeyVaultUri",
                      "Description": "The base URI of the Azure Key Vault that is used when storing the bucket credentials.",
                      "Format": "uri",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "secretName",
                      "Description": "The name of the secret stored in Azure Key Vault. The associated key pair has the following structure:\n\n{\n\"access_key_id\": \"\",\n\"secret_access_key\": \"\"\n}",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "server": [
              {
                "#name": "certificateObject",
                "Description": {
                  "new": "The base64-encoded contents of a PEM file, which includes both the bucket server's certificate and private key. It is generated by the end user and allows the user to access volume data in a read-only manner.\nNote: This is only used when Azure Key Vault is not configured. This property is mutually exclusive with the Azure Key Vault 'akv' properties.",
                  "old": "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."
                }
              },
              {
                "@added_67f4b82a983343369a2753cf1fa4cef9": {
                  "#name": "onCertificateConflictAction",
                  "Description": "Action to take when there is a certificate conflict.\nPossible values include: 'Update', 'Fail'",
                  "Enum": [
                    [
                      "Update",
                      "Update the existing certificate regardless of whether there is a conflict or not. This means all buckets on the server will now use the new certificate."
                    ],
                    [
                      "Fail",
                      "Fail the operation if a conflict occurs, meaning the bucket operation will fail, and the existing certificate will continue to be in use."
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              }
            ]
          },
          {
            "@added_7cfe8d158f254be7972dc0b4614641a0": {
              "#name": "akvDetails",
              "Description": "Specifies the Azure Key Vault settings. These are used when\na) retrieving the bucket server certificate, and\nb) storing the bucket credentials\n\nNotes:\n\n1. If a bucket certificate was previously provided directly using the certificateObject property, it is possible to subsequently use the Azure Key Vault for certificate management by using these 'akvDetails' properties. However, once Azure Key Vault is configured, it is no longer possible to provide the certificate directly via the certificateObject property.\n2. These properties are mutually exclusive with the server.certificateObject property.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "certificateAkvDetails",
                  "Description": "Specifies the Azure Key Vault settings for retrieving the bucket server certificate.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "certificateKeyVaultUri",
                      "Description": "The base URI of the Azure Key Vault that is used when retrieving the bucket certificate.",
                      "Format": "uri",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "certificateName",
                      "Description": "The name of the bucket server certificate stored in the Azure Key Vault.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                },
                {
                  "#name": "credentialsAkvDetails",
                  "Description": "Specifies the Azure Key Vault settings for storing the bucket credentials.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "credentialsKeyVaultUri",
                      "Description": "The base URI of the Azure Key Vault that is used when storing the bucket credentials.",
                      "Format": "uri",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "secretName",
                      "Description": "The name of the secret stored in Azure Key Vault. The associated key pair has the following structure:\n\n{\n\"access_key_id\": \"\",\n\"secret_access_key\": \"\"\n}",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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 ,
Updating: Resource is updating ,
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: The base64-encoded contents of a PEM file, which includes both the bucket server's certificate and private key. It is generated by the end user and allows the user to access volume data in a read-only manner. Note: This is only used when Azure Key Vault is not configured. This property is mutually exclusive with the Azure Key Vault 'akv' properties. ,
Format: password ,
Required: False ,
}
string ,
onCertificateConflictAction:
{
Description: Action to take when there is a certificate conflict. Possible values include: 'Update', 'Fail' ,
Enum:
{
Update: Update the existing certificate regardless of whether there is a conflict or not. This means all buckets on the server will now use the new certificate. ,
Fail: Fail the operation if a conflict occurs, meaning the bucket operation will fail, and the existing certificate will continue to be in use. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
akvDetails:
{
Description: Specifies the Azure Key Vault settings. These are used when a) retrieving the bucket server certificate, and b) storing the bucket credentials Notes: 1. If a bucket certificate was previously provided directly using the certificateObject property, it is possible to subsequently use the Azure Key Vault for certificate management by using these 'akvDetails' properties. However, once Azure Key Vault is configured, it is no longer possible to provide the certificate directly via the certificateObject property. 2. These properties are mutually exclusive with the server.certificateObject property. ,
Required: False ,
}
{
certificateAkvDetails:
{
Description: Specifies the Azure Key Vault settings for retrieving the bucket server certificate. ,
Required: False ,
}
{
certificateKeyVaultUri:
{
Description: The base URI of the Azure Key Vault that is used when retrieving the bucket certificate. ,
Format: uri ,
Required: False ,
}
string ,
certificateName:
{
Description: The name of the bucket server certificate stored in the Azure Key Vault. ,
Required: False ,
}
string ,
}
,
credentialsAkvDetails:
{
Description: Specifies the Azure Key Vault settings for storing the bucket credentials. ,
Required: False ,
}
{
credentialsKeyVaultUri:
{
Description: The base URI of the Azure Key Vault that is used when storing the bucket credentials. ,
Format: uri ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret stored in Azure Key Vault. The associated key pair has the following structure: { "access_key_id": "", "secret_access_key": "" } ,
Required: False ,
}
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 ,
Updating: Resource is updating ,
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: The base64-encoded contents of a PEM file, which includes both the bucket server's certificate and private key. It is generated by the end user and allows the user to access volume data in a read-only manner. Note: This is only used when Azure Key Vault is not configured. This property is mutually exclusive with the Azure Key Vault 'akv' properties. ,
Format: password ,
Required: False ,
}
string ,
onCertificateConflictAction:
{
Description: Action to take when there is a certificate conflict. Possible values include: 'Update', 'Fail' ,
Enum:
{
Update: Update the existing certificate regardless of whether there is a conflict or not. This means all buckets on the server will now use the new certificate. ,
Fail: Fail the operation if a conflict occurs, meaning the bucket operation will fail, and the existing certificate will continue to be in use. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
akvDetails:
{
Description: Specifies the Azure Key Vault settings. These are used when a) retrieving the bucket server certificate, and b) storing the bucket credentials Notes: 1. If a bucket certificate was previously provided directly using the certificateObject property, it is possible to subsequently use the Azure Key Vault for certificate management by using these 'akvDetails' properties. However, once Azure Key Vault is configured, it is no longer possible to provide the certificate directly via the certificateObject property. 2. These properties are mutually exclusive with the server.certificateObject property. ,
Required: False ,
}
{
certificateAkvDetails:
{
Description: Specifies the Azure Key Vault settings for retrieving the bucket server certificate. ,
Required: False ,
}
{
certificateKeyVaultUri:
{
Description: The base URI of the Azure Key Vault that is used when retrieving the bucket certificate. ,
Format: uri ,
Required: False ,
}
string ,
certificateName:
{
Description: The name of the bucket server certificate stored in the Azure Key Vault. ,
Required: False ,
}
string ,
}
,
credentialsAkvDetails:
{
Description: Specifies the Azure Key Vault settings for storing the bucket credentials. ,
Required: False ,
}
{
credentialsKeyVaultUri:
{
Description: The base URI of the Azure Key Vault that is used when storing the bucket credentials. ,
Format: uri ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret stored in Azure Key Vault. The associated key pair has the following structure: { "access_key_id": "", "secret_access_key": "" } ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: 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 ,
Updating: Resource is updating ,
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: The base64-encoded contents of a PEM file, which includes both the bucket server's certificate and private key. It is generated by the end user and allows the user to access volume data in a read-only manner. Note: This is only used when Azure Key Vault is not configured. This property is mutually exclusive with the Azure Key Vault 'akv' properties. ,
Format: password ,
Required: False ,
}
string ,
onCertificateConflictAction:
{
Description: Action to take when there is a certificate conflict. Possible values include: 'Update', 'Fail' ,
Enum:
{
Update: Update the existing certificate regardless of whether there is a conflict or not. This means all buckets on the server will now use the new certificate. ,
Fail: Fail the operation if a conflict occurs, meaning the bucket operation will fail, and the existing certificate will continue to be in use. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
akvDetails:
{
Description: Specifies the Azure Key Vault settings. These are used when a) retrieving the bucket server certificate, and b) storing the bucket credentials Notes: 1. If a bucket certificate was previously provided directly using the certificateObject property, it is possible to subsequently use the Azure Key Vault for certificate management by using these 'akvDetails' properties. However, once Azure Key Vault is configured, it is no longer possible to provide the certificate directly via the certificateObject property. 2. These properties are mutually exclusive with the server.certificateObject property. ,
Required: False ,
}
{
certificateAkvDetails:
{
Description: Specifies the Azure Key Vault settings for retrieving the bucket server certificate. ,
Required: False ,
}
{
certificateKeyVaultUri:
{
Description: The base URI of the Azure Key Vault that is used when retrieving the bucket certificate. ,
Format: uri ,
Required: False ,
}
string ,
certificateName:
{
Description: The name of the bucket server certificate stored in the Azure Key Vault. ,
Required: False ,
}
string ,
}
,
credentialsAkvDetails:
{
Description: Specifies the Azure Key Vault settings for storing the bucket credentials. ,
Required: False ,
}
{
credentialsKeyVaultUri:
{
Description: The base URI of the Azure Key Vault that is used when storing the bucket credentials. ,
Format: uri ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret stored in Azure Key Vault. The associated key pair has the following structure: { "access_key_id": "", "secret_access_key": "" } ,
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_Update (updated)
Description :  Updates the details of a volume bucket.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Buckets_Update",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "server": [
              {
                "#name": "certificateObject",
                "Description": {
                  "new": "The base64-encoded contents of a PEM file, which includes both the bucket server's certificate and private key. It is generated by the end user and allows the user to access volume data in a read-only manner.\nNote: This is only used when Azure Key Vault is not configured. This property is mutually exclusive with the Azure Key Vault 'akv' properties.",
                  "old": "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."
                }
              },
              {
                "@added_ec72d97f5f9c4063bedaef82c40e5f03": {
                  "#name": "onCertificateConflictAction",
                  "Description": "Action to take when there is a certificate conflict.\nPossible values include: 'Update', 'Fail'",
                  "Enum": [
                    [
                      "Update",
                      "Update the existing certificate regardless of whether there is a conflict or not. This means all buckets on the server will now use the new certificate."
                    ],
                    [
                      "Fail",
                      "Fail the operation if a conflict occurs, meaning the bucket operation will fail, and the existing certificate will continue to be in use."
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              }
            ]
          },
          {
            "@added_9454c8aea6174648bdc1ffe8d6da1c18": {
              "#name": "akvDetails",
              "Description": "Specifies the Azure Key Vault settings. These are used when\na) retrieving the bucket server certificate, and\nb) storing the bucket credentials\n\nNotes:\n\n1. If a bucket certificate was previously provided directly using the certificateObject property, it is possible to subsequently use the Azure Key Vault for certificate management by using these 'akvDetails' properties. However, once Azure Key Vault is configured, it is no longer possible to provide the certificate directly via the certificateObject property.\n2. These properties are mutually exclusive with the server.certificateObject property.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "certificateAkvDetails",
                  "Description": "Specifies the Azure Key Vault settings for retrieving the bucket server certificate.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "certificateKeyVaultUri",
                      "Description": "The base URI of the Azure Key Vault that is used when retrieving the bucket certificate.",
                      "Format": "uri",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "certificateName",
                      "Description": "The name of the bucket server certificate stored in the Azure Key Vault.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                },
                {
                  "#name": "credentialsAkvDetails",
                  "Description": "Specifies the Azure Key Vault settings for storing the bucket credentials.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "credentialsKeyVaultUri",
                      "Description": "The base URI of the Azure Key Vault that is used when storing the bucket credentials.",
                      "Format": "uri",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "secretName",
                      "Description": "The name of the secret stored in Azure Key Vault. The associated key pair has the following structure:\n\n{\n\"access_key_id\": \"\",\n\"secret_access_key\": \"\"\n}",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "server": [
              {
                "#name": "certificateObject",
                "Description": {
                  "new": "The base64-encoded contents of a PEM file, which includes both the bucket server's certificate and private key. It is generated by the end user and allows the user to access volume data in a read-only manner.\nNote: This is only used when Azure Key Vault is not configured. This property is mutually exclusive with the Azure Key Vault 'akv' properties.",
                  "old": "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."
                }
              },
              {
                "@added_6a828e78a8da4e2cb6a4adf079b39a7e": {
                  "#name": "onCertificateConflictAction",
                  "Description": "Action to take when there is a certificate conflict.\nPossible values include: 'Update', 'Fail'",
                  "Enum": [
                    [
                      "Update",
                      "Update the existing certificate regardless of whether there is a conflict or not. This means all buckets on the server will now use the new certificate."
                    ],
                    [
                      "Fail",
                      "Fail the operation if a conflict occurs, meaning the bucket operation will fail, and the existing certificate will continue to be in use."
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              }
            ]
          },
          {
            "@added_0f08455bc8fd4ef48c20a956ed70a73b": {
              "#name": "akvDetails",
              "Description": "Specifies the Azure Key Vault settings. These are used when\na) retrieving the bucket server certificate, and\nb) storing the bucket credentials\n\nNotes:\n\n1. If a bucket certificate was previously provided directly using the certificateObject property, it is possible to subsequently use the Azure Key Vault for certificate management by using these 'akvDetails' properties. However, once Azure Key Vault is configured, it is no longer possible to provide the certificate directly via the certificateObject property.\n2. These properties are mutually exclusive with the server.certificateObject property.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "certificateAkvDetails",
                  "Description": "Specifies the Azure Key Vault settings for retrieving the bucket server certificate.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "certificateKeyVaultUri",
                      "Description": "The base URI of the Azure Key Vault that is used when retrieving the bucket certificate.",
                      "Format": "uri",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "certificateName",
                      "Description": "The name of the bucket server certificate stored in the Azure Key Vault.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                },
                {
                  "#name": "credentialsAkvDetails",
                  "Description": "Specifies the Azure Key Vault settings for storing the bucket credentials.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "credentialsKeyVaultUri",
                      "Description": "The base URI of the Azure Key Vault that is used when storing the bucket credentials.",
                      "Format": "uri",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "secretName",
                      "Description": "The name of the secret stored in Azure Key Vault. The associated key pair has the following structure:\n\n{\n\"access_key_id\": \"\",\n\"secret_access_key\": \"\"\n}",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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 ,
Updating: Resource is updating ,
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: The base64-encoded contents of a PEM file, which includes both the bucket server's certificate and private key. It is generated by the end user and allows the user to access volume data in a read-only manner. Note: This is only used when Azure Key Vault is not configured. This property is mutually exclusive with the Azure Key Vault 'akv' properties. ,
Format: password ,
Required: False ,
}
string ,
onCertificateConflictAction:
{
Description: Action to take when there is a certificate conflict. Possible values include: 'Update', 'Fail' ,
Enum:
{
Update: Update the existing certificate regardless of whether there is a conflict or not. This means all buckets on the server will now use the new certificate. ,
Fail: Fail the operation if a conflict occurs, meaning the bucket operation will fail, and the existing certificate will continue to be in use. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
akvDetails:
{
Description: Specifies the Azure Key Vault settings. These are used when a) retrieving the bucket server certificate, and b) storing the bucket credentials Notes: 1. If a bucket certificate was previously provided directly using the certificateObject property, it is possible to subsequently use the Azure Key Vault for certificate management by using these 'akvDetails' properties. However, once Azure Key Vault is configured, it is no longer possible to provide the certificate directly via the certificateObject property. 2. These properties are mutually exclusive with the server.certificateObject property. ,
Required: False ,
}
{
certificateAkvDetails:
{
Description: Specifies the Azure Key Vault settings for retrieving the bucket server certificate. ,
Required: False ,
}
{
certificateKeyVaultUri:
{
Description: The base URI of the Azure Key Vault that is used when retrieving the bucket certificate. ,
Format: uri ,
Required: False ,
}
string ,
certificateName:
{
Description: The name of the bucket server certificate stored in the Azure Key Vault. ,
Required: False ,
}
string ,
}
,
credentialsAkvDetails:
{
Description: Specifies the Azure Key Vault settings for storing the bucket credentials. ,
Required: False ,
}
{
credentialsKeyVaultUri:
{
Description: The base URI of the Azure Key Vault that is used when storing the bucket credentials. ,
Format: uri ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret stored in Azure Key Vault. The associated key pair has the following structure: { "access_key_id": "", "secret_access_key": "" } ,
Required: False ,
}
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 ,
Updating: Resource is updating ,
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: The base64-encoded contents of a PEM file, which includes both the bucket server's certificate and private key. It is generated by the end user and allows the user to access volume data in a read-only manner. Note: This is only used when Azure Key Vault is not configured. This property is mutually exclusive with the Azure Key Vault 'akv' properties. ,
Format: password ,
Required: False ,
}
string ,
onCertificateConflictAction:
{
Description: Action to take when there is a certificate conflict. Possible values include: 'Update', 'Fail' ,
Enum:
{
Update: Update the existing certificate regardless of whether there is a conflict or not. This means all buckets on the server will now use the new certificate. ,
Fail: Fail the operation if a conflict occurs, meaning the bucket operation will fail, and the existing certificate will continue to be in use. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
akvDetails:
{
Description: Specifies the Azure Key Vault settings. These are used when a) retrieving the bucket server certificate, and b) storing the bucket credentials Notes: 1. If a bucket certificate was previously provided directly using the certificateObject property, it is possible to subsequently use the Azure Key Vault for certificate management by using these 'akvDetails' properties. However, once Azure Key Vault is configured, it is no longer possible to provide the certificate directly via the certificateObject property. 2. These properties are mutually exclusive with the server.certificateObject property. ,
Required: False ,
}
{
certificateAkvDetails:
{
Description: Specifies the Azure Key Vault settings for retrieving the bucket server certificate. ,
Required: False ,
}
{
certificateKeyVaultUri:
{
Description: The base URI of the Azure Key Vault that is used when retrieving the bucket certificate. ,
Format: uri ,
Required: False ,
}
string ,
certificateName:
{
Description: The name of the bucket server certificate stored in the Azure Key Vault. ,
Required: False ,
}
string ,
}
,
credentialsAkvDetails:
{
Description: Specifies the Azure Key Vault settings for storing the bucket credentials. ,
Required: False ,
}
{
credentialsKeyVaultUri:
{
Description: The base URI of the Azure Key Vault that is used when storing the bucket credentials. ,
Format: uri ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret stored in Azure Key Vault. The associated key pair has the following structure: { "access_key_id": "", "secret_access_key": "" } ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}