Buckets - Generate Credentials

Service:

Azure NetApp Files

API Version:

2026-01-01

Generate the access key and secret key used for accessing the specified volume bucket. Also return expiry date and time of key pair (in UTC).

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/buckets/{bucketName}/generateCredentials?api-version=2026-01-01

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$	The name of the NetApp account
bucketName	path	True	string minLength: 3 maxLength: 63 pattern: ^([a-z]|(\d(?!\d{0,2}\.\d{1,3}\.\d{1,3}\.\d{1,3})))([a-z\d]|(\.(?!(\.|-)))|(-(?!\.))){1,61}[a-z\d]$	The name of the bucket
poolName	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$	The name of the capacity pool
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
volumeName	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$	The name of the volume
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
keyPairExpiryDays	integer (int32) minimum: 1	The number of days from now until the newly generated Access and Secret key pair will expire.

Responses

Name	Type	Description
200 OK	BucketGenerateCredentials	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Buckets_GenerateCredentials

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/buckets/bucket1/generateCredentials?api-version=2026-01-01

{
  "keyPairExpiryDays": 3
}

Java

import com.azure.resourcemanager.netapp.models.BucketCredentialsExpiry;

/**
 * Samples for Buckets GenerateCredentials.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-01-01/Buckets_GenerateCredentials.json
     */
    /**
     * Sample code: Buckets_GenerateCredentials.
     * 
     * @param manager Entry point to NetAppFilesManager.
     */
    public static void bucketsGenerateCredentials(com.azure.resourcemanager.netapp.NetAppFilesManager manager) {
        manager.buckets().generateCredentialsWithResponse("myRG", "account1", "pool1", "volume1", "bucket1",
            new BucketCredentialsExpiry().withKeyPairExpiryDays(3), com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.netapp import NetAppManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-netapp
# USAGE
    python buckets_generate_credentials.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetAppManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.buckets.generate_credentials(
        resource_group_name="myRG",
        account_name="account1",
        pool_name="pool1",
        volume_name="volume1",
        bucket_name="bucket1",
        body={"keyPairExpiryDays": 3},
    )
    print(response)


# x-ms-original-file: 2026-01-01/Buckets_GenerateCredentials.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetapp_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/netapp/armnetapp/v10"
)

// Generated from example definition: 2026-01-01/Buckets_GenerateCredentials.json
func ExampleBucketsClient_GenerateCredentials() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetapp.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewBucketsClient().GenerateCredentials(ctx, "myRG", "account1", "pool1", "volume1", "bucket1", armnetapp.BucketCredentialsExpiry{
		KeyPairExpiryDays: to.Ptr[int32](3),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armnetapp.BucketsClientGenerateCredentialsResponse{
	// 	BucketGenerateCredentials: &armnetapp.BucketGenerateCredentials{
	// 		AccessKey: to.Ptr("<REDACTED>"),
	// 		KeyPairExpiry: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2027-08-15T13:23:33Z"); return t}()),
	// 		SecretKey: to.Ptr("<REDACTED>"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetAppManagementClient } = require("@azure/arm-netapp");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to generate the access key and secret key used for accessing the specified volume bucket. Also return expiry date and time of key pair (in UTC).
 *
 * @summary generate the access key and secret key used for accessing the specified volume bucket. Also return expiry date and time of key pair (in UTC).
 * x-ms-original-file: 2026-01-01/Buckets_GenerateCredentials.json
 */
async function bucketsGenerateCredentials() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new NetAppManagementClient(credential, subscriptionId);
  const result = await client.buckets.generateCredentials(
    "myRG",
    "account1",
    "pool1",
    "volume1",
    "bucket1",
    { keyPairExpiryDays: 3 },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.NetApp.Models;
using Azure.ResourceManager.NetApp;

// Generated from example definition: specification/netapp/resource-manager/Microsoft.NetApp/NetApp/stable/2026-01-01/examples/Buckets_GenerateCredentials.json
// this example is just showing the usage of "Buckets_GenerateCredentials" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this NetAppBucketResource created on azure
// for more information of creating NetAppBucketResource, please refer to the document of NetAppBucketResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "myRG";
string accountName = "account1";
string poolName = "pool1";
string volumeName = "volume1";
string bucketName = "bucket1";
ResourceIdentifier netAppBucketResourceId = NetAppBucketResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, poolName, volumeName, bucketName);
NetAppBucketResource netAppBucket = client.GetNetAppBucketResource(netAppBucketResourceId);

// invoke the operation
NetAppBucketCredentialsExpiry body = new NetAppBucketCredentialsExpiry
{
    KeyPairExpiryDays = 3,
};
NetAppBucketGenerateCredentials result = await netAppBucket.GenerateCredentialsAsync(body);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "accessKey": "<REDACTED>",
  "keyPairExpiry": "2027-08-15T13:23:33Z",
  "secretKey": "<REDACTED>"
}

Definitions

Name	Description
BucketCredentialsExpiry	The bucket's Access and Secret key pair Expiry Time expressed as the number of days from now.
BucketGenerateCredentials	Bucket Access Key, Secret Key, and Expiry date and time of the key pair
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

BucketCredentialsExpiry

Object

The bucket's Access and Secret key pair Expiry Time expressed as the number of days from now.

Name	Type	Description
keyPairExpiryDays	integer (int32) minimum: 1	The number of days from now until the newly generated Access and Secret key pair will expire.

BucketGenerateCredentials

Object

Bucket Access Key, Secret Key, and Expiry date and time of the key pair

Name	Type	Description
accessKey	string (password)	The Access Key that is required along with the Secret Key to access the bucket.
keyPairExpiry	string (date-time)	The bucket's Access and Secret key pair expiry date and time (in UTC).
secretKey	string (password)	The Secret Key that is required along with the Access Key to access the bucket.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.