Share via

Microsoft.ContainerRegistry registries/tokens 2022-12-01

Bicep resource definition

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

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@2022-12-01' = {
  parent: resourceSymbolicName
  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

Microsoft.ContainerRegistry/registries/tokens

Name Description Value
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 token. TokenProperties

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

TokenCredentialsProperties

Name Description Value
certificates TokenCertificate[]
passwords TokenPassword[]

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'

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'

ARM template resource definition

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

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": "2022-12-01",
  "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

Microsoft.ContainerRegistry/registries/tokens

Name Description Value
apiVersion The api version '2022-12-01'
name The resource name string

Constraints:
Min length = 5
Max length = 50
Pattern = ^[a-zA-Z0-9-]*$ (required)
properties The properties of the token. TokenProperties
type The resource type 'Microsoft.ContainerRegistry/registries/tokens'

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

TokenCredentialsProperties

Name Description Value
certificates TokenCertificate[]
passwords TokenPassword[]

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'

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'

Usage Examples

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@2022-12-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      credentials = {
        certificates = [
          {
            encodedPemCertificate = "string"
            expiry = "string"
            name = "string"
            thumbprint = "string"
          }
        ]
        passwords = [
          {
            creationTime = "string"
            expiry = "string"
            name = "string"
          }
        ]
      }
      scopeMapId = "string"
      status = "string"
    }
  }
}

Property Values

Microsoft.ContainerRegistry/registries/tokens

Name Description Value
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 token. TokenProperties
type The resource type "Microsoft.ContainerRegistry/registries/tokens@2022-12-01"

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

TokenCredentialsProperties

Name Description Value
certificates TokenCertificate[]
passwords TokenPassword[]

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'

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'