Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep 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 Bicep to your template.
resource symbolicname 'Microsoft.ContainerRegistry/registries/credentialSets@2023-07-01' = {
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
name: 'string'
properties: {
authCredentials: [
{
name: 'string'
passwordSecretIdentifier: 'string'
usernameSecretIdentifier: 'string'
}
]
loginServer: 'string'
}
}
Property Values
Microsoft.ContainerRegistry/registries/credentialSets
| Name | Description | Value |
|---|---|---|
| identity | Identities associated with the resource. This is used to access the KeyVault secrets. | IdentityProperties |
| name | The resource name | string Constraints: Min length = 5 Max length = 50 Pattern = ^[a-zA-Z0-9-]*$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: registries |
| properties | The properties of the credential set. | CredentialSetProperties |
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 |
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 |
IdentityProperties
| Name | Description | Value |
|---|---|---|
| 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}'. |
IdentityPropertiesUserAssignedIdentities |
IdentityPropertiesUserAssignedIdentities
| Name | Description | Value |
|---|
UserIdentityProperties
| Name | Description | Value |
|---|
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-07-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"properties": {
"authCredentials": [
{
"name": "string",
"passwordSecretIdentifier": "string",
"usernameSecretIdentifier": "string"
}
],
"loginServer": "string"
}
}
Property Values
Microsoft.ContainerRegistry/registries/credentialSets
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-07-01' |
| identity | Identities associated with the resource. This is used to access the KeyVault secrets. | IdentityProperties |
| name | The resource name | string Constraints: Min length = 5 Max length = 50 Pattern = ^[a-zA-Z0-9-]*$ (required) |
| properties | The properties of the credential set. | CredentialSetProperties |
| type | The resource type | 'Microsoft.ContainerRegistry/registries/credentialSets' |
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 |
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 |
IdentityProperties
| Name | Description | Value |
|---|---|---|
| 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}'. |
IdentityPropertiesUserAssignedIdentities |
IdentityPropertiesUserAssignedIdentities
| Name | Description | Value |
|---|
UserIdentityProperties
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The registries/credentialSets resource type can be deployed with operations that target:
- Resource groups
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 Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ContainerRegistry/registries/credentialSets@2023-07-01"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
body = {
properties = {
authCredentials = [
{
name = "string"
passwordSecretIdentifier = "string"
usernameSecretIdentifier = "string"
}
]
loginServer = "string"
}
}
}
Property Values
Microsoft.ContainerRegistry/registries/credentialSets
| Name | Description | Value |
|---|---|---|
| identity | Identities associated with the resource. This is used to access the KeyVault secrets. | IdentityProperties |
| name | The resource name | string Constraints: Min length = 5 Max length = 50 Pattern = ^[a-zA-Z0-9-]*$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: registries |
| properties | The properties of the credential set. | CredentialSetProperties |
| type | The resource type | "Microsoft.ContainerRegistry/registries/credentialSets@2023-07-01" |
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 |
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 |
IdentityProperties
| Name | Description | Value |
|---|---|---|
| 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}'. |
IdentityPropertiesUserAssignedIdentities |
IdentityPropertiesUserAssignedIdentities
| Name | Description | Value |
|---|
UserIdentityProperties
| Name | Description | Value |
|---|