Credential Sets - Update

Service:

Container Registry

API Version:

2025-11-01

Updates a credential set for a container registry with the specified parameters.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/credentialSets/{credentialSetName}?api-version=2025-11-01

URI Parameters

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

Request Body

Name	Type	Description
identity	IdentityProperties	Identities associated with the resource. This is used to access the KeyVault secrets.
properties.authCredentials	AuthCredential[]	List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential.

Responses

Name	Type	Description
200 OK	CredentialSet	Azure operation completed successfully.
201 Created	CredentialSet	Resource 'CredentialSet' create operation succeeded Headers Azure-AsyncOperation: string Retry-After: integer
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

CredentialSetUpdate

Sample request

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet?api-version=2025-11-01

{
  "properties": {
    "authCredentials": [
      {
        "name": "Credential1",
        "usernameSecretIdentifier": "https://myvault.vault.azure.net/secrets/username2",
        "passwordSecretIdentifier": "https://myvault.vault.azure.net/secrets/password2"
      }
    ]
  }
}

Java

import com.azure.resourcemanager.containerregistry.models.AuthCredential;
import com.azure.resourcemanager.containerregistry.models.CredentialName;
import com.azure.resourcemanager.containerregistry.models.CredentialSetUpdateParameters;
import java.util.Arrays;

/**
 * Samples for CredentialSets Update.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-11-01/CredentialSetUpdate.json
     */
    /**
     * Sample code: CredentialSetUpdate.
     * 
     * @param manager Entry point to ContainerRegistryManager.
     */
    public static void
        credentialSetUpdate(com.azure.resourcemanager.containerregistry.ContainerRegistryManager manager) {
        manager.serviceClient().getCredentialSets().update("myResourceGroup", "myRegistry", "myCredentialSet",
            new CredentialSetUpdateParameters().withAuthCredentials(Arrays.asList(new AuthCredential()
                .withName(CredentialName.CREDENTIAL1).withUsernameSecretIdentifier("fakeTokenPlaceholder")
                .withPasswordSecretIdentifier("fakeTokenPlaceholder"))),
            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.containerregistry import ContainerRegistryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-containerregistry
# USAGE
    python credential_set_update.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 = ContainerRegistryManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.credential_sets.begin_update(
        resource_group_name="myResourceGroup",
        registry_name="myRegistry",
        credential_set_name="myCredentialSet",
        credential_set_update_parameters={
            "properties": {
                "authCredentials": [
                    {
                        "name": "Credential1",
                        "passwordSecretIdentifier": "https://myvault.vault.azure.net/secrets/password2",
                        "usernameSecretIdentifier": "https://myvault.vault.azure.net/secrets/username2",
                    }
                ]
            }
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-11-01/CredentialSetUpdate.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 armcontainerregistry_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/containerregistry/armcontainerregistry/v3"
)

// Generated from example definition: 2025-11-01/CredentialSetUpdate.json
func ExampleCredentialSetsClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerregistry.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewCredentialSetsClient().BeginUpdate(ctx, "myResourceGroup", "myRegistry", "myCredentialSet", armcontainerregistry.CredentialSetUpdateParameters{
		Properties: &armcontainerregistry.CredentialSetUpdateProperties{
			AuthCredentials: []*armcontainerregistry.AuthCredential{
				{
					Name:                     to.Ptr(armcontainerregistry.CredentialNameCredential1),
					UsernameSecretIdentifier: to.Ptr("https://myvault.vault.azure.net/secrets/username2"),
					PasswordSecretIdentifier: to.Ptr("https://myvault.vault.azure.net/secrets/password2"),
				},
			},
		},
	}, 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 = armcontainerregistry.CredentialSetsClientUpdateResponse{
	// 	CredentialSet: &armcontainerregistry.CredentialSet{
	// 		Type: to.Ptr("Microsoft.ContainerRegistry/registries/credentialSets"),
	// 		Identity: &armcontainerregistry.IdentityProperties{
	// 			PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 			TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 			Type: to.Ptr(armcontainerregistry.ResourceIdentityTypeSystemAssigned),
	// 		},
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet"),
	// 		Name: to.Ptr("myCredentialSet"),
	// 		Properties: &armcontainerregistry.CredentialSetProperties{
	// 			LoginServer: to.Ptr("docker.io"),
	// 			AuthCredentials: []*armcontainerregistry.AuthCredential{
	// 				{
	// 					Name: to.Ptr(armcontainerregistry.CredentialNameCredential1),
	// 					UsernameSecretIdentifier: to.Ptr("https://myvault.vault.azure.net/secrets/username2"),
	// 					PasswordSecretIdentifier: to.Ptr("https://myvault.vault.azure.net/secrets/password2"),
	// 					CredentialHealth: &armcontainerregistry.CredentialHealth{
	// 						Status: to.Ptr(armcontainerregistry.CredentialHealthStatusHealthy),
	// 					},
	// 				},
	// 			},
	// 			CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-07T18:20:08.012276+00:00"); return t}()),
	// 			ProvisioningState: to.Ptr(armcontainerregistry.ProvisioningStateSucceeded),
	// 		},
	// 	},
	// }
}

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 updates a credential set for a container registry with the specified parameters.
 *
 * @summary updates a credential set for a container registry with the specified parameters.
 * x-ms-original-file: 2025-11-01/CredentialSetUpdate.json
 */
async function credentialSetUpdate() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new ContainerRegistryManagementClient(credential, subscriptionId);
  const result = await client.credentialSets.update(
    "myResourceGroup",
    "myRegistry",
    "myCredentialSet",
    {
      authCredentials: [
        {
          name: "Credential1",
          usernameSecretIdentifier: "https://myvault.vault.azure.net/secrets/username2",
          passwordSecretIdentifier: "https://myvault.vault.azure.net/secrets/password2",
        },
      ],
    },
  );
  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.ContainerRegistry.Models;
using Azure.ResourceManager.ContainerRegistry;

// Generated from example definition: specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/stable/2025-11-01/examples/CredentialSetUpdate.json
// this example is just showing the usage of "CredentialSets_Update" 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 ContainerRegistryCredentialSetResource created on azure
// for more information of creating ContainerRegistryCredentialSetResource, please refer to the document of ContainerRegistryCredentialSetResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "myResourceGroup";
string registryName = "myRegistry";
string credentialSetName = "myCredentialSet";
ResourceIdentifier containerRegistryCredentialSetResourceId = ContainerRegistryCredentialSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, registryName, credentialSetName);
ContainerRegistryCredentialSetResource containerRegistryCredentialSet = client.GetContainerRegistryCredentialSetResource(containerRegistryCredentialSetResourceId);

// invoke the operation
ContainerRegistryCredentialSetPatch patch = new ContainerRegistryCredentialSetPatch
{
    AuthCredentials = {new ContainerRegistryAuthCredential
    {
    Name = ContainerRegistryCredentialName.Credential1,
    UsernameSecretIdentifier = "https://myvault.vault.azure.net/secrets/username2",
    PasswordSecretIdentifier = "https://myvault.vault.azure.net/secrets/password2",
    }},
};
ArmOperation<ContainerRegistryCredentialSetResource> lro = await containerRegistryCredentialSet.UpdateAsync(WaitUntil.Completed, patch);
ContainerRegistryCredentialSetResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ContainerRegistryCredentialSetData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "type": "Microsoft.ContainerRegistry/registries/credentialSets",
  "identity": {
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "type": "SystemAssigned"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet",
  "name": "myCredentialSet",
  "properties": {
    "loginServer": "docker.io",
    "authCredentials": [
      {
        "name": "Credential1",
        "usernameSecretIdentifier": "https://myvault.vault.azure.net/secrets/username2",
        "passwordSecretIdentifier": "https://myvault.vault.azure.net/secrets/password2",
        "credentialHealth": {
          "status": "Healthy"
        }
      }
    ],
    "creationDate": "2022-11-07T18:20:08.012276+00:00",
    "provisioningState": "Succeeded"
  }
}

Status code:

201

Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet/operationStatuses/credentialsets-00000000-0000-0000-0000-000000000000?api-version=2025-11-01

{
  "type": "Microsoft.ContainerRegistry/registries/credentialSets",
  "identity": {
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "type": "SystemAssigned"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet",
  "name": "myCredentialSet",
  "properties": {
    "loginServer": "docker.io",
    "authCredentials": [
      {
        "name": "Credential1",
        "usernameSecretIdentifier": "https://myvault.vault.azure.net/secrets/username2",
        "passwordSecretIdentifier": "https://myvault.vault.azure.net/secrets/password2",
        "credentialHealth": {
          "status": "Healthy"
        }
      }
    ],
    "creationDate": "2022-11-07T18:20:08.012276+00:00",
    "provisioningState": "Updating"
  }
}

Definitions

Name	Description
AuthCredential	Authentication credential stored for an upstream.
createdByType	The type of identity that created the resource.
CredentialHealth	The health of the auth credential.
CredentialHealthStatus	The health status of credential.
CredentialName	The name of the credential.
CredentialSet	An object that represents a credential set resource for a container registry.
CredentialSetUpdateParameters	The parameters for updating a credential set
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
IdentityProperties	Managed identity for the resource.
ProvisioningState	The provisioning state of the archive at the time the operation was called.
ResourceIdentityType	The identity type.
systemData	Metadata pertaining to creation and last modification of the resource.
UserIdentityProperties

AuthCredential

Object

Authentication credential stored for an upstream.

Name	Type	Description
credentialHealth	CredentialHealth	This provides data pertaining to the health of the auth credential.
name	CredentialName	The name of the credential.
passwordSecretIdentifier	string	KeyVault Secret URI for accessing the password.
usernameSecretIdentifier	string	KeyVault Secret URI for accessing the username.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

CredentialHealth

Object

The health of the auth credential.

Name	Type	Description
errorCode	string	Error code representing the health check error.
errorMessage	string	Descriptive message representing the health check error.
status	CredentialHealthStatus	The health status of credential.

CredentialHealthStatus

Enumeration

The health status of credential.

Value	Description
Healthy
Unhealthy

CredentialName

Enumeration

The name of the credential.

Value	Description
Credential1

CredentialSet

Object

An object that represents a credential set resource for a container registry.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	IdentityProperties	Identities associated with the resource. This is used to access the KeyVault secrets.
name	string	The name of the resource
properties.authCredentials	AuthCredential[]	List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential.
properties.creationDate	string (date-time)	The creation date of credential store resource.
properties.loginServer	string	The credentials are stored for this upstream or login server.
properties.provisioningState	ProvisioningState	Provisioning state of the resource.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

CredentialSetUpdateParameters

Object

The parameters for updating a credential set

Name	Type	Description
identity	IdentityProperties	Identities associated with the resource. This is used to access the KeyVault secrets.
properties.authCredentials	AuthCredential[]	List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential.

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.

IdentityProperties

Object

Managed identity for the resource.

Name	Type	Description
principalId	string	The principal ID of resource identity.
tenantId	string	The tenant ID of resource.
type	ResourceIdentityType	The identity type.
userAssignedIdentities	<string,  UserIdentityProperties>	The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ProvisioningState

Enumeration

The provisioning state of the archive at the time the operation was called.

Value	Description
Creating
Updating
Deleting
Succeeded
Failed
Canceled

ResourceIdentityType

Enumeration

The identity type.

Value	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserIdentityProperties

Object

Name	Type	Description
clientId	string	The client id of user assigned identity.
principalId	string	The principal id of user assigned identity.