ARM template resource definition

The registries/credentialSets resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ContainerRegistry/registries/credentialSets resource, add the following JSON to your template.

{
  "type": "Microsoft.ContainerRegistry/registries/credentialSets",
  "apiVersion": "2023-01-01-preview",
  "name": "string",
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "authCredentials": [
      {
        "name": "Credential1",
        "passwordSecretIdentifier": "string",
        "usernameSecretIdentifier": "string"
      }
    ],
    "loginServer": "string"
  }
}

Property values

registries/credentialSets

Name	Description	Value
type	The resource type	'Microsoft.ContainerRegistry/registries/credentialSets'
apiVersion	The resource api version	'2023-01-01-preview'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required)
identity	Identities associated with the resource. This is used to access the KeyVault secrets.	IdentityProperties
properties	The properties of the credential set.	CredentialSetProperties

IdentityProperties

Name	Description	Value
principalId	The principal ID of resource identity.	string
tenantId	The tenant ID of resource.	string
type	The identity type.	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	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}'.	object

CredentialSetProperties

Name	Description	Value
authCredentials	List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential.	AuthCredential[]
loginServer	The credentials are stored for this upstream or login server.	string

AuthCredential

Name	Description	Value
name	The name of the credential.	'Credential1'
passwordSecretIdentifier	KeyVault Secret URI for accessing the password.	string
usernameSecretIdentifier	KeyVault Secret URI for accessing the username.	string