Microsoft.ContainerRegistry registries/tokens
Bicep resource definition
The registries/tokens 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/tokens resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ContainerRegistry/registries/tokens@2023-01-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
credentials: {
certificates: [
{
encodedPemCertificate: 'string'
expiry: 'string'
name: 'string'
thumbprint: 'string'
}
]
passwords: [
{
creationTime: 'string'
expiry: 'string'
name: 'string'
}
]
}
scopeMapId: 'string'
status: 'string'
}
}
Property values
registries/tokens
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Character limit: 5-50 Valid characters: Alphanumerics, hyphens, and underscores. |
| 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 token. | TokenProperties |
TokenProperties
| Name | Description | Value |
|---|---|---|
| credentials | The credentials that can be used for authenticating the token. | TokenCredentialsProperties |
| scopeMapId | The resource ID of the scope map to which the token will be associated with. | string |
| status | The status of the token example enabled or disabled. | 'disabled' 'enabled' |
TokenCredentialsProperties
| Name | Description | Value |
|---|---|---|
| certificates | TokenCertificate[] | |
| passwords | TokenPassword[] |
TokenCertificate
| Name | Description | Value |
|---|---|---|
| encodedPemCertificate | Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. | string |
| expiry | The expiry datetime of the certificate. | string |
| name | 'certificate1' 'certificate2' |
|
| thumbprint | The thumbprint of the certificate. | string |
TokenPassword
| Name | Description | Value |
|---|---|---|
| creationTime | The creation datetime of the password. | string |
| expiry | The expiry datetime of the password. | string |
| name | The password name "password1" or "password2" | 'password1' 'password2' |
ARM template resource definition
The registries/tokens 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/tokens resource, add the following JSON to your template.
{
"type": "Microsoft.ContainerRegistry/registries/tokens",
"apiVersion": "2023-01-01-preview",
"name": "string",
"properties": {
"credentials": {
"certificates": [
{
"encodedPemCertificate": "string",
"expiry": "string",
"name": "string",
"thumbprint": "string"
}
],
"passwords": [
{
"creationTime": "string",
"expiry": "string",
"name": "string"
}
]
},
"scopeMapId": "string",
"status": "string"
}
}
Property values
registries/tokens
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.ContainerRegistry/registries/tokens' |
| 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) Character limit: 5-50 Valid characters: Alphanumerics, hyphens, and underscores. |
| properties | The properties of the token. | TokenProperties |
TokenProperties
| Name | Description | Value |
|---|---|---|
| credentials | The credentials that can be used for authenticating the token. | TokenCredentialsProperties |
| scopeMapId | The resource ID of the scope map to which the token will be associated with. | string |
| status | The status of the token example enabled or disabled. | 'disabled' 'enabled' |
TokenCredentialsProperties
| Name | Description | Value |
|---|---|---|
| certificates | TokenCertificate[] | |
| passwords | TokenPassword[] |
TokenCertificate
| Name | Description | Value |
|---|---|---|
| encodedPemCertificate | Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. | string |
| expiry | The expiry datetime of the certificate. | string |
| name | 'certificate1' 'certificate2' |
|
| thumbprint | The thumbprint of the certificate. | string |
TokenPassword
| Name | Description | Value |
|---|---|---|
| creationTime | The creation datetime of the password. | string |
| expiry | The expiry datetime of the password. | string |
| name | The password name "password1" or "password2" | 'password1' 'password2' |
Terraform (AzAPI provider) resource definition
The registries/tokens 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/tokens resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ContainerRegistry/registries/tokens@2023-01-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
credentials = {
certificates = [
{
encodedPemCertificate = "string"
expiry = "string"
name = "string"
thumbprint = "string"
}
]
passwords = [
{
creationTime = "string"
expiry = "string"
name = "string"
}
]
}
scopeMapId = "string"
status = "string"
}
})
}
Property values
registries/tokens
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.ContainerRegistry/registries/tokens@2023-01-01-preview" |
| name | The resource name | string (required) Character limit: 5-50 Valid characters: Alphanumerics, hyphens, and underscores. |
| 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 token. | TokenProperties |
TokenProperties
| Name | Description | Value |
|---|---|---|
| credentials | The credentials that can be used for authenticating the token. | TokenCredentialsProperties |
| scopeMapId | The resource ID of the scope map to which the token will be associated with. | string |
| status | The status of the token example enabled or disabled. | "disabled" "enabled" |
TokenCredentialsProperties
| Name | Description | Value |
|---|---|---|
| certificates | TokenCertificate[] | |
| passwords | TokenPassword[] |
TokenCertificate
| Name | Description | Value |
|---|---|---|
| encodedPemCertificate | Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. | string |
| expiry | The expiry datetime of the certificate. | string |
| name | "certificate1" "certificate2" |
|
| thumbprint | The thumbprint of the certificate. | string |
TokenPassword
| Name | Description | Value |
|---|---|---|
| creationTime | The creation datetime of the password. | string |
| expiry | The expiry datetime of the password. | string |
| name | The password name "password1" or "password2" | "password1" "password2" |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for