Microsoft.ContainerRegistry registries/connectedRegistries 2023-11-01-preview

Bicep resource definition

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

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

Usage Examples

Bicep Samples

A basic example of deploying Container Connected Registry.

param resourceName string = 'acctest0001'
param location string = 'westus'

resource registry 'Microsoft.ContainerRegistry/registries@2023-11-01-preview' = {
  name: '${resourceName}registry'
  location: location
  sku: {
    name: 'Premium'
  }
  properties: {
    adminUserEnabled: false
    anonymousPullEnabled: false
    dataEndpointEnabled: true
    networkRuleBypassOptions: 'AzureServices'
    policies: {
      exportPolicy: {
        status: 'enabled'
      }
      quarantinePolicy: {
        status: 'disabled'
      }
      retentionPolicy: {}
      trustPolicy: {}
    }
    publicNetworkAccess: 'Enabled'
    zoneRedundancy: 'Disabled'
  }
}

resource connectedRegistry 'Microsoft.ContainerRegistry/registries/connectedRegistries@2023-11-01-preview' = {
  name: '${resourceName}connectedregistry'
  parent: registry
  properties: {
    logging: {
      auditLogStatus: 'Disabled'
      logLevel: 'None'
    }
    mode: 'ReadWrite'
    parent: {
      syncProperties: {
        messageTtl: 'P1D'
        schedule: '* * * * *'
        syncWindow: ''
        tokenId: token.id
      }
    }
  }
}

resource scopeMap 'Microsoft.ContainerRegistry/registries/scopeMaps@2023-11-01-preview' = {
  name: '${resourceName}scopemap'
  parent: registry
  properties: {
    actions: [
      'repositories/hello-world/content/delete'
      'repositories/hello-world/content/read'
      'repositories/hello-world/content/write'
      'repositories/hello-world/metadata/read'
      'repositories/hello-world/metadata/write'
      'gateway/${resourceName}connectedregistry/config/read'
      'gateway/${resourceName}connectedregistry/config/write'
      'gateway/${resourceName}connectedregistry/message/read'
      'gateway/${resourceName}connectedregistry/message/write'
    ]
    description: ''
  }
}

resource token 'Microsoft.ContainerRegistry/registries/tokens@2023-11-01-preview' = {
  name: '${resourceName}token'
  parent: registry
  properties: {
    scopeMapId: scopeMap.id
    status: 'enabled'
  }
}

Resource format

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

resource symbolicname 'Microsoft.ContainerRegistry/registries/connectedRegistries@2023-11-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    clientTokenIds: [
      'string'
    ]
    logging: {
      auditLogStatus: 'string'
      logLevel: 'string'
    }
    loginServer: {}
    mode: 'string'
    notificationsList: [
      'string'
    ]
    parent: {
      id: 'string'
      syncProperties: {
        messageTtl: 'string'
        schedule: 'string'
        syncWindow: 'string'
        tokenId: 'string'
      }
    }
  }
}

Property Values

Microsoft.ContainerRegistry/registries/connectedRegistries

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 connected registry. ConnectedRegistryProperties

ConnectedRegistryProperties

Name Description Value
clientTokenIds The list of the ACR token resource IDs used to authenticate clients to the connected registry. string[]
logging The logging properties of the connected registry. LoggingProperties
loginServer The login server properties of the connected registry. LoginServerProperties
mode The mode of the connected registry resource that indicates the permissions of the registry. 'Mirror'
'ReadOnly'
'ReadWrite'
'Registry' (required)
notificationsList The list of notifications subscription information for the connected registry. string[]
parent The parent of the connected registry. ParentProperties (required)

LoggingProperties

Name Description Value
auditLogStatus Indicates whether audit logs are enabled on the connected registry. 'Disabled'
'Enabled'
logLevel The verbosity of logs persisted on the connected registry. 'Debug'
'Error'
'Information'
'None'
'Warning'

LoginServerProperties

Name Description Value

ParentProperties

Name Description Value
id The resource ID of the parent to which the connected registry will be associated. string
syncProperties The sync properties of the connected registry with its parent. SyncProperties (required)

SyncProperties

Name Description Value
messageTtl The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. string (required)
schedule The cron expression indicating the schedule that the connected registry will sync with its parent. string
syncWindow The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. string
tokenId The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. string (required)

ARM template resource definition

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

Usage Examples

Resource format

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

{
  "type": "Microsoft.ContainerRegistry/registries/connectedRegistries",
  "apiVersion": "2023-11-01-preview",
  "name": "string",
  "properties": {
    "clientTokenIds": [ "string" ],
    "logging": {
      "auditLogStatus": "string",
      "logLevel": "string"
    },
    "loginServer": {
    },
    "mode": "string",
    "notificationsList": [ "string" ],
    "parent": {
      "id": "string",
      "syncProperties": {
        "messageTtl": "string",
        "schedule": "string",
        "syncWindow": "string",
        "tokenId": "string"
      }
    }
  }
}

Property Values

Microsoft.ContainerRegistry/registries/connectedRegistries

Name Description Value
apiVersion The api version '2023-11-01-preview'
name The resource name string

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

ConnectedRegistryProperties

Name Description Value
clientTokenIds The list of the ACR token resource IDs used to authenticate clients to the connected registry. string[]
logging The logging properties of the connected registry. LoggingProperties
loginServer The login server properties of the connected registry. LoginServerProperties
mode The mode of the connected registry resource that indicates the permissions of the registry. 'Mirror'
'ReadOnly'
'ReadWrite'
'Registry' (required)
notificationsList The list of notifications subscription information for the connected registry. string[]
parent The parent of the connected registry. ParentProperties (required)

LoggingProperties

Name Description Value
auditLogStatus Indicates whether audit logs are enabled on the connected registry. 'Disabled'
'Enabled'
logLevel The verbosity of logs persisted on the connected registry. 'Debug'
'Error'
'Information'
'None'
'Warning'

LoginServerProperties

Name Description Value

ParentProperties

Name Description Value
id The resource ID of the parent to which the connected registry will be associated. string
syncProperties The sync properties of the connected registry with its parent. SyncProperties (required)

SyncProperties

Name Description Value
messageTtl The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. string (required)
schedule The cron expression indicating the schedule that the connected registry will sync with its parent. string
syncWindow The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. string
tokenId The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. string (required)

Terraform (AzAPI provider) resource definition

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

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

Usage Examples

Terraform Samples

A basic example of deploying Container Connected Registry.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westus"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "registry" {
  type      = "Microsoft.ContainerRegistry/registries@2023-11-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}registry"
  location  = var.location
  body = {
    properties = {
      adminUserEnabled         = false
      anonymousPullEnabled     = false
      dataEndpointEnabled      = true
      networkRuleBypassOptions = "AzureServices"
      policies = {
        exportPolicy = {
          status = "enabled"
        }
        quarantinePolicy = {
          status = "disabled"
        }
        retentionPolicy = {}
        trustPolicy     = {}
      }
      publicNetworkAccess = "Enabled"
      zoneRedundancy      = "Disabled"
    }
    sku = {
      name = "Premium"
    }
  }
}

resource "azapi_resource" "scopeMap" {
  type      = "Microsoft.ContainerRegistry/registries/scopeMaps@2023-11-01-preview"
  parent_id = azapi_resource.registry.id
  name      = "${var.resource_name}scopemap"
  body = {
    properties = {
      actions     = ["repositories/hello-world/content/delete", "repositories/hello-world/content/read", "repositories/hello-world/content/write", "repositories/hello-world/metadata/read", "repositories/hello-world/metadata/write", "gateway/${var.resource_name}connectedregistry/config/read", "gateway/${var.resource_name}connectedregistry/config/write", "gateway/${var.resource_name}connectedregistry/message/read", "gateway/${var.resource_name}connectedregistry/message/write"]
      description = ""
    }
  }
}

resource "azapi_resource" "token" {
  type      = "Microsoft.ContainerRegistry/registries/tokens@2023-11-01-preview"
  parent_id = azapi_resource.registry.id
  name      = "${var.resource_name}token"
  body = {
    properties = {
      scopeMapId = azapi_resource.scopeMap.id
      status     = "enabled"
    }
  }
}

resource "azapi_resource" "connectedRegistry" {
  type      = "Microsoft.ContainerRegistry/registries/connectedRegistries@2023-11-01-preview"
  parent_id = azapi_resource.registry.id
  name      = "${var.resource_name}connectedregistry"
  body = {
    properties = {
      clientTokenIds = null
      logging = {
        auditLogStatus = "Disabled"
        logLevel       = "None"
      }
      mode = "ReadWrite"
      parent = {
        syncProperties = {
          messageTtl = "P1D"
          schedule   = "* * * * *"
          syncWindow = ""
          tokenId    = azapi_resource.token.id
        }
      }
    }
  }
}

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ContainerRegistry/registries/connectedRegistries@2023-11-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      clientTokenIds = [
        "string"
      ]
      logging = {
        auditLogStatus = "string"
        logLevel = "string"
      }
      loginServer = {
      }
      mode = "string"
      notificationsList = [
        "string"
      ]
      parent = {
        id = "string"
        syncProperties = {
          messageTtl = "string"
          schedule = "string"
          syncWindow = "string"
          tokenId = "string"
        }
      }
    }
  }
}

Property Values

Microsoft.ContainerRegistry/registries/connectedRegistries

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 connected registry. ConnectedRegistryProperties
type The resource type "Microsoft.ContainerRegistry/registries/connectedRegistries@2023-11-01-preview"

ConnectedRegistryProperties

Name Description Value
clientTokenIds The list of the ACR token resource IDs used to authenticate clients to the connected registry. string[]
logging The logging properties of the connected registry. LoggingProperties
loginServer The login server properties of the connected registry. LoginServerProperties
mode The mode of the connected registry resource that indicates the permissions of the registry. 'Mirror'
'ReadOnly'
'ReadWrite'
'Registry' (required)
notificationsList The list of notifications subscription information for the connected registry. string[]
parent The parent of the connected registry. ParentProperties (required)

LoggingProperties

Name Description Value
auditLogStatus Indicates whether audit logs are enabled on the connected registry. 'Disabled'
'Enabled'
logLevel The verbosity of logs persisted on the connected registry. 'Debug'
'Error'
'Information'
'None'
'Warning'

LoginServerProperties

Name Description Value

ParentProperties

Name Description Value
id The resource ID of the parent to which the connected registry will be associated. string
syncProperties The sync properties of the connected registry with its parent. SyncProperties (required)

SyncProperties

Name Description Value
messageTtl The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. string (required)
schedule The cron expression indicating the schedule that the connected registry will sync with its parent. string
syncWindow The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. string
tokenId The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. string (required)
  • Last updated on