Registries - Generate Credentials

Service:

Container Registry

API Version:

2023-01-01-preview

Generate keys for a token of a specified container registry.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/generateCredentials?api-version=2023-01-01-preview

URI Parameters

Name	In	Required	Type	Description
registryName	path	True	string	The name of the container registry. Regex pattern: ^[a-zA-Z0-9]*$
resourceGroupName	path	True	string	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.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
expiry	string	The expiry date of the generated credentials after which the credentials become invalid.
name	TokenPasswordName	Specifies name of the password which should be regenerated if any -- password1 or password2.
tokenId	string	The resource ID of the token for which credentials have to be generated.

Responses

Name	Type	Description
200 OK	GenerateCredentialsResult	The request was successful; the request was well-formed and received properly.
202 Accepted		The request was successful; the operation will complete asynchronously. Headers Location: string
Other Status Codes	ErrorResponse	Error response describing why the operation failed. If the resource does not exist, 404 (Not found) is returned.

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

RegistryGenerateCredentials

Sample Request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/generateCredentials?api-version=2023-01-01-preview

{
  "tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken",
  "expiry": "2020-12-31T15:59:59.0707808Z"
}

Go

package armcontainerregistry_test

import (
	"context"
	"log"

	"time"

	"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/containerregistry/armcontainerregistry"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryGenerateCredentials.json
func ExampleRegistriesClient_BeginGenerateCredentials() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerregistry.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewRegistriesClient().BeginGenerateCredentials(ctx, "myResourceGroup", "myRegistry", armcontainerregistry.GenerateCredentialsParameters{
		Expiry:  to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-31T15:59:59.0707808Z"); return t }()),
		TokenID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.GenerateCredentialsResult = armcontainerregistry.GenerateCredentialsResult{
	// 	Passwords: []*armcontainerregistry.TokenPassword{
	// 		{
	// 			Name: to.Ptr(armcontainerregistry.TokenPasswordNamePassword1),
	// 			Expiry: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-31T15:59:59.0707808Z"); return t}()),
	// 			Value: to.Ptr("00000000000000000000000000000000"),
	// 		},
	// 		{
	// 			Name: to.Ptr(armcontainerregistry.TokenPasswordNamePassword2),
	// 			Expiry: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-31T15:59:59.0707808Z"); return t}()),
	// 			Value: to.Ptr("00000000000000000000000000000000"),
	// 	}},
	// 	Username: to.Ptr("myToken"),
	// }
}

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 { ContainerRegistryManagementClient } = require("@azure/arm-containerregistry");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Generate keys for a token of a specified container registry.
 *
 * @summary Generate keys for a token of a specified container registry.
 * x-ms-original-file: specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryGenerateCredentials.json
 */
async function registryGenerateCredentials() {
  const subscriptionId =
    process.env["CONTAINERREGISTRY_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["CONTAINERREGISTRY_RESOURCE_GROUP"] || "myResourceGroup";
  const registryName = "myRegistry";
  const generateCredentialsParameters = {
    expiry: new Date("2020-12-31T15:59:59.0707808Z"),
    tokenId:
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken",
  };
  const credential = new DefaultAzureCredential();
  const client = new ContainerRegistryManagementClient(credential, subscriptionId);
  const result = await client.registries.beginGenerateCredentialsAndWait(
    resourceGroupName,
    registryName,
    generateCredentialsParameters
  );
  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

Sample Response

Status code:

200

{
  "username": "myToken",
  "passwords": [
    {
      "expiry": "2020-12-31T15:59:59.0707808Z",
      "name": "password1",
      "value": "00000000000000000000000000000000"
    },
    {
      "expiry": "2020-12-31T15:59:59.0707808Z",
      "name": "password2",
      "value": "00000000000000000000000000000000"
    }
  ]
}

Status code:

202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/operationStatuses/registries-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview

Definitions

Name	Description
ErrorResponse	An error response from the Azure Container Registry service.
ErrorResponseBody	An error response from the Azure Container Registry service.
GenerateCredentialsParameters	The parameters used to generate credentials for a specified token or user of a container registry.
GenerateCredentialsResult	The response from the GenerateCredentials operation.
InnerErrorDescription	inner error.
TokenPassword	The password that will be used for authenticating the token of a container registry.
TokenPasswordName	The password name "password1" or "password2"

ErrorResponse

An error response from the Azure Container Registry service.

Name	Type	Description
error	ErrorResponseBody	Azure container registry build API error body.

ErrorResponseBody

An error response from the Azure Container Registry service.

Name	Type	Description
code	string	error code.
details	InnerErrorDescription[]	an array of additional nested error response info objects, as described by this contract.
message	string	error message.
target	string	target of the particular error.

GenerateCredentialsParameters

The parameters used to generate credentials for a specified token or user of a container registry.

Name	Type	Description
expiry	string	The expiry date of the generated credentials after which the credentials become invalid.
name	TokenPasswordName	Specifies name of the password which should be regenerated if any -- password1 or password2.
tokenId	string	The resource ID of the token for which credentials have to be generated.

GenerateCredentialsResult

The response from the GenerateCredentials operation.

Name	Type	Description
passwords	TokenPassword[]	The list of passwords for a container registry.
username	string	The username for a container registry.

InnerErrorDescription

inner error.

Name	Type	Description
code	string	error code.
message	string	error message.
target	string	target of the particular error.

TokenPassword

The password that will be used for authenticating the token of a container registry.

Name	Type	Description
creationTime	string	The creation datetime of the password.
expiry	string	The expiry datetime of the password.
name	TokenPasswordName	The password name "password1" or "password2"
value	string	The password value.

TokenPasswordName

The password name "password1" or "password2"

Name	Type	Description
password1	string
password2	string