Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. containerservice
  5. ConnectedRegistry

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.containerservice.ConnectedRegistry

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Container Connected Registry.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-rg",
    location: "West Europe",
});
const exampleRegistry = new azure.containerservice.Registry("example", {
    name: "exampleacr",
    resourceGroupName: example.name,
    location: example.location,
    sku: "Premium",
    dataEndpointEnabled: true,
});
const exampleRegistryScopeMap = new azure.containerservice.RegistryScopeMap("example", {
    name: "examplescopemap",
    containerRegistryName: exampleRegistry.name,
    resourceGroupName: exampleRegistry.resourceGroupName,
    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/examplecr/config/read",
        "gateway/examplecr/config/write",
        "gateway/examplecr/message/read",
        "gateway/examplecr/message/write",
    ],
});
const exampleRegistryToken = new azure.containerservice.RegistryToken("example", {
    name: "exampletoken",
    containerRegistryName: exampleRegistry.name,
    resourceGroupName: exampleRegistry.resourceGroupName,
    scopeMapId: exampleRegistryScopeMap.id,
});
const exampleConnectedRegistry = new azure.containerservice.ConnectedRegistry("example", {
    name: "examplecr",
    containerRegistryId: exampleRegistry.id,
    syncTokenId: exampleRegistryToken.id,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-rg",
    location="West Europe")
example_registry = azure.containerservice.Registry("example",
    name="exampleacr",
    resource_group_name=example.name,
    location=example.location,
    sku="Premium",
    data_endpoint_enabled=True)
example_registry_scope_map = azure.containerservice.RegistryScopeMap("example",
    name="examplescopemap",
    container_registry_name=example_registry.name,
    resource_group_name=example_registry.resource_group_name,
    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/examplecr/config/read",
        "gateway/examplecr/config/write",
        "gateway/examplecr/message/read",
        "gateway/examplecr/message/write",
    ])
example_registry_token = azure.containerservice.RegistryToken("example",
    name="exampletoken",
    container_registry_name=example_registry.name,
    resource_group_name=example_registry.resource_group_name,
    scope_map_id=example_registry_scope_map.id)
example_connected_registry = azure.containerservice.ConnectedRegistry("example",
    name="examplecr",
    container_registry_id=example_registry.id,
    sync_token_id=example_registry_token.id)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/containerservice"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-rg"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleRegistry, err := containerservice.NewRegistry(ctx, "example", &containerservice.RegistryArgs{
			Name:                pulumi.String("exampleacr"),
			ResourceGroupName:   example.Name,
			Location:            example.Location,
			Sku:                 pulumi.String("Premium"),
			DataEndpointEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		exampleRegistryScopeMap, err := containerservice.NewRegistryScopeMap(ctx, "example", &containerservice.RegistryScopeMapArgs{
			Name:                  pulumi.String("examplescopemap"),
			ContainerRegistryName: exampleRegistry.Name,
			ResourceGroupName:     exampleRegistry.ResourceGroupName,
			Actions: pulumi.StringArray{
				pulumi.String("repositories/hello-world/content/delete"),
				pulumi.String("repositories/hello-world/content/read"),
				pulumi.String("repositories/hello-world/content/write"),
				pulumi.String("repositories/hello-world/metadata/read"),
				pulumi.String("repositories/hello-world/metadata/write"),
				pulumi.String("gateway/examplecr/config/read"),
				pulumi.String("gateway/examplecr/config/write"),
				pulumi.String("gateway/examplecr/message/read"),
				pulumi.String("gateway/examplecr/message/write"),
			},
		})
		if err != nil {
			return err
		}
		exampleRegistryToken, err := containerservice.NewRegistryToken(ctx, "example", &containerservice.RegistryTokenArgs{
			Name:                  pulumi.String("exampletoken"),
			ContainerRegistryName: exampleRegistry.Name,
			ResourceGroupName:     exampleRegistry.ResourceGroupName,
			ScopeMapId:            exampleRegistryScopeMap.ID(),
		})
		if err != nil {
			return err
		}
		_, err = containerservice.NewConnectedRegistry(ctx, "example", &containerservice.ConnectedRegistryArgs{
			Name:                pulumi.String("examplecr"),
			ContainerRegistryId: exampleRegistry.ID(),
			SyncTokenId:         exampleRegistryToken.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-rg",
        Location = "West Europe",
    });

    var exampleRegistry = new Azure.ContainerService.Registry("example", new()
    {
        Name = "exampleacr",
        ResourceGroupName = example.Name,
        Location = example.Location,
        Sku = "Premium",
        DataEndpointEnabled = true,
    });

    var exampleRegistryScopeMap = new Azure.ContainerService.RegistryScopeMap("example", new()
    {
        Name = "examplescopemap",
        ContainerRegistryName = exampleRegistry.Name,
        ResourceGroupName = exampleRegistry.ResourceGroupName,
        Actions = new[]
        {
            "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/examplecr/config/read",
            "gateway/examplecr/config/write",
            "gateway/examplecr/message/read",
            "gateway/examplecr/message/write",
        },
    });

    var exampleRegistryToken = new Azure.ContainerService.RegistryToken("example", new()
    {
        Name = "exampletoken",
        ContainerRegistryName = exampleRegistry.Name,
        ResourceGroupName = exampleRegistry.ResourceGroupName,
        ScopeMapId = exampleRegistryScopeMap.Id,
    });

    var exampleConnectedRegistry = new Azure.ContainerService.ConnectedRegistry("example", new()
    {
        Name = "examplecr",
        ContainerRegistryId = exampleRegistry.Id,
        SyncTokenId = exampleRegistryToken.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.containerservice.Registry;
import com.pulumi.azure.containerservice.RegistryArgs;
import com.pulumi.azure.containerservice.RegistryScopeMap;
import com.pulumi.azure.containerservice.RegistryScopeMapArgs;
import com.pulumi.azure.containerservice.RegistryToken;
import com.pulumi.azure.containerservice.RegistryTokenArgs;
import com.pulumi.azure.containerservice.ConnectedRegistry;
import com.pulumi.azure.containerservice.ConnectedRegistryArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-rg")
            .location("West Europe")
            .build());

        var exampleRegistry = new Registry("exampleRegistry", RegistryArgs.builder()
            .name("exampleacr")
            .resourceGroupName(example.name())
            .location(example.location())
            .sku("Premium")
            .dataEndpointEnabled(true)
            .build());

        var exampleRegistryScopeMap = new RegistryScopeMap("exampleRegistryScopeMap", RegistryScopeMapArgs.builder()
            .name("examplescopemap")
            .containerRegistryName(exampleRegistry.name())
            .resourceGroupName(exampleRegistry.resourceGroupName())
            .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/examplecr/config/read",
                "gateway/examplecr/config/write",
                "gateway/examplecr/message/read",
                "gateway/examplecr/message/write")
            .build());

        var exampleRegistryToken = new RegistryToken("exampleRegistryToken", RegistryTokenArgs.builder()
            .name("exampletoken")
            .containerRegistryName(exampleRegistry.name())
            .resourceGroupName(exampleRegistry.resourceGroupName())
            .scopeMapId(exampleRegistryScopeMap.id())
            .build());

        var exampleConnectedRegistry = new ConnectedRegistry("exampleConnectedRegistry", ConnectedRegistryArgs.builder()
            .name("examplecr")
            .containerRegistryId(exampleRegistry.id())
            .syncTokenId(exampleRegistryToken.id())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-rg
      location: West Europe
  exampleRegistry:
    type: azure:containerservice:Registry
    name: example
    properties:
      name: exampleacr
      resourceGroupName: ${example.name}
      location: ${example.location}
      sku: Premium
      dataEndpointEnabled: true
  exampleRegistryScopeMap:
    type: azure:containerservice:RegistryScopeMap
    name: example
    properties:
      name: examplescopemap
      containerRegistryName: ${exampleRegistry.name}
      resourceGroupName: ${exampleRegistry.resourceGroupName}
      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/examplecr/config/read
        - gateway/examplecr/config/write
        - gateway/examplecr/message/read
        - gateway/examplecr/message/write
  exampleRegistryToken:
    type: azure:containerservice:RegistryToken
    name: example
    properties:
      name: exampletoken
      containerRegistryName: ${exampleRegistry.name}
      resourceGroupName: ${exampleRegistry.resourceGroupName}
      scopeMapId: ${exampleRegistryScopeMap.id}
  exampleConnectedRegistry:
    type: azure:containerservice:ConnectedRegistry
    name: example
    properties:
      name: examplecr
      containerRegistryId: ${exampleRegistry.id}
      syncTokenId: ${exampleRegistryToken.id}
Copy

Create ConnectedRegistry Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ConnectedRegistry(name: string, args: ConnectedRegistryArgs, opts?: CustomResourceOptions);
@overload
def ConnectedRegistry(resource_name: str,
                      args: ConnectedRegistryArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def ConnectedRegistry(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      container_registry_id: Optional[str] = None,
                      sync_token_id: Optional[str] = None,
                      audit_log_enabled: Optional[bool] = None,
                      client_token_ids: Optional[Sequence[str]] = None,
                      log_level: Optional[str] = None,
                      mode: Optional[str] = None,
                      name: Optional[str] = None,
                      notifications: Optional[Sequence[ConnectedRegistryNotificationArgs]] = None,
                      parent_registry_id: Optional[str] = None,
                      sync_message_ttl: Optional[str] = None,
                      sync_schedule: Optional[str] = None,
                      sync_window: Optional[str] = None)
func NewConnectedRegistry(ctx *Context, name string, args ConnectedRegistryArgs, opts ...ResourceOption) (*ConnectedRegistry, error)
public ConnectedRegistry(string name, ConnectedRegistryArgs args, CustomResourceOptions? opts = null)
public ConnectedRegistry(String name, ConnectedRegistryArgs args)
public ConnectedRegistry(String name, ConnectedRegistryArgs args, CustomResourceOptions options)

type: azure:containerservice:ConnectedRegistry
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ConnectedRegistryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ConnectedRegistryArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ConnectedRegistryArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ConnectedRegistryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ConnectedRegistryArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var connectedRegistryResource = new Azure.ContainerService.ConnectedRegistry("connectedRegistryResource", new()
{
    ContainerRegistryId = "string",
    SyncTokenId = "string",
    AuditLogEnabled = false,
    ClientTokenIds = new[]
    {
        "string",
    },
    LogLevel = "string",
    Mode = "string",
    Name = "string",
    Notifications = new[]
    {
        new Azure.ContainerService.Inputs.ConnectedRegistryNotificationArgs
        {
            Action = "string",
            Name = "string",
            Digest = "string",
            Tag = "string",
        },
    },
    ParentRegistryId = "string",
    SyncMessageTtl = "string",
    SyncSchedule = "string",
    SyncWindow = "string",
});
Copy
example, err := containerservice.NewConnectedRegistry(ctx, "connectedRegistryResource", &containerservice.ConnectedRegistryArgs{
	ContainerRegistryId: pulumi.String("string"),
	SyncTokenId:         pulumi.String("string"),
	AuditLogEnabled:     pulumi.Bool(false),
	ClientTokenIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	LogLevel: pulumi.String("string"),
	Mode:     pulumi.String("string"),
	Name:     pulumi.String("string"),
	Notifications: containerservice.ConnectedRegistryNotificationArray{
		&containerservice.ConnectedRegistryNotificationArgs{
			Action: pulumi.String("string"),
			Name:   pulumi.String("string"),
			Digest: pulumi.String("string"),
			Tag:    pulumi.String("string"),
		},
	},
	ParentRegistryId: pulumi.String("string"),
	SyncMessageTtl:   pulumi.String("string"),
	SyncSchedule:     pulumi.String("string"),
	SyncWindow:       pulumi.String("string"),
})
Copy
var connectedRegistryResource = new ConnectedRegistry("connectedRegistryResource", ConnectedRegistryArgs.builder()
    .containerRegistryId("string")
    .syncTokenId("string")
    .auditLogEnabled(false)
    .clientTokenIds("string")
    .logLevel("string")
    .mode("string")
    .name("string")
    .notifications(ConnectedRegistryNotificationArgs.builder()
        .action("string")
        .name("string")
        .digest("string")
        .tag("string")
        .build())
    .parentRegistryId("string")
    .syncMessageTtl("string")
    .syncSchedule("string")
    .syncWindow("string")
    .build());
Copy
connected_registry_resource = azure.containerservice.ConnectedRegistry("connectedRegistryResource",
    container_registry_id="string",
    sync_token_id="string",
    audit_log_enabled=False,
    client_token_ids=["string"],
    log_level="string",
    mode="string",
    name="string",
    notifications=[{
        "action": "string",
        "name": "string",
        "digest": "string",
        "tag": "string",
    }],
    parent_registry_id="string",
    sync_message_ttl="string",
    sync_schedule="string",
    sync_window="string")
Copy
const connectedRegistryResource = new azure.containerservice.ConnectedRegistry("connectedRegistryResource", {
    containerRegistryId: "string",
    syncTokenId: "string",
    auditLogEnabled: false,
    clientTokenIds: ["string"],
    logLevel: "string",
    mode: "string",
    name: "string",
    notifications: [{
        action: "string",
        name: "string",
        digest: "string",
        tag: "string",
    }],
    parentRegistryId: "string",
    syncMessageTtl: "string",
    syncSchedule: "string",
    syncWindow: "string",
});
Copy
type: azure:containerservice:ConnectedRegistry
properties:
    auditLogEnabled: false
    clientTokenIds:
        - string
    containerRegistryId: string
    logLevel: string
    mode: string
    name: string
    notifications:
        - action: string
          digest: string
          name: string
          tag: string
    parentRegistryId: string
    syncMessageTtl: string
    syncSchedule: string
    syncTokenId: string
    syncWindow: string
Copy

ConnectedRegistry Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ConnectedRegistry resource accepts the following input properties:

ContainerRegistryId
This property is required.
Changes to this property will trigger replacement.
string

The ID of the Container Registry that this Connected Registry will reside in. Changing this forces a new Container Connected Registry to be created.

If parent_registry_id is not specified, the Connected Registry will be connected to the Container Registry identified by container_registry_id.

SyncTokenId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Container Registry Token which is used for synchronizing the Connected Registry. Changing this forces a new Container Connected Registry to be created.
AuditLogEnabled bool
Should the log auditing be enabled?
ClientTokenIds List<string>
Specifies a list of IDs of Container Registry Tokens, which are meant to be used by the clients to connect to the Connected Registry.
LogLevel string
The verbosity of the logs. Possible values are None, Debug, Information, Warning and Error. Defaults to None.
Mode Changes to this property will trigger replacement. string
The mode of the Connected Registry. Possible values are Mirror, ReadOnly, ReadWrite and Registry. Changing this forces a new Container Connected Registry to be created. Defaults to ReadWrite.
Name Changes to this property will trigger replacement. string
The name which should be used for this Container Connected Registry. Changing this forces a new Container Connected Registry to be created.
Notifications List<ConnectedRegistryNotification>
One or more notification blocks as defined below.
ParentRegistryId Changes to this property will trigger replacement. string
The ID of the parent registry. This can be either a Container Registry ID or a Connected Registry ID. Changing this forces a new Container Connected Registry to be created.
SyncMessageTtl string
The period of time (in form of ISO8601) for which a message is available to sync before it is expired. Allowed range is from P1D to P90D. Defaults to P1D.
SyncSchedule string
The cron expression indicating the schedule that the Connected Registry will sync with its parent. Defaults to * * * * *.
SyncWindow string
The time window (in form of ISO8601) during which sync is enabled for each schedule occurrence. Allowed range is from PT3H to P7D.
ContainerRegistryId
This property is required.
Changes to this property will trigger replacement.
string

The ID of the Container Registry that this Connected Registry will reside in. Changing this forces a new Container Connected Registry to be created.

If parent_registry_id is not specified, the Connected Registry will be connected to the Container Registry identified by container_registry_id.

SyncTokenId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Container Registry Token which is used for synchronizing the Connected Registry. Changing this forces a new Container Connected Registry to be created.
AuditLogEnabled bool
Should the log auditing be enabled?
ClientTokenIds []string
Specifies a list of IDs of Container Registry Tokens, which are meant to be used by the clients to connect to the Connected Registry.
LogLevel string
The verbosity of the logs. Possible values are None, Debug, Information, Warning and Error. Defaults to None.
Mode Changes to this property will trigger replacement. string
The mode of the Connected Registry. Possible values are Mirror, ReadOnly, ReadWrite and Registry. Changing this forces a new Container Connected Registry to be created. Defaults to ReadWrite.
Name Changes to this property will trigger replacement. string
The name which should be used for this Container Connected Registry. Changing this forces a new Container Connected Registry to be created.
Notifications []ConnectedRegistryNotificationArgs
One or more notification blocks as defined below.
ParentRegistryId Changes to this property will trigger replacement. string
The ID of the parent registry. This can be either a Container Registry ID or a Connected Registry ID. Changing this forces a new Container Connected Registry to be created.
SyncMessageTtl string
The period of time (in form of ISO8601) for which a message is available to sync before it is expired. Allowed range is from P1D to P90D. Defaults to P1D.
SyncSchedule string
The cron expression indicating the schedule that the Connected Registry will sync with its parent. Defaults to * * * * *.
SyncWindow string
The time window (in form of ISO8601) during which sync is enabled for each schedule occurrence. Allowed range is from PT3H to P7D.
containerRegistryId
This property is required.
Changes to this property will trigger replacement.
String

The ID of the Container Registry that this Connected Registry will reside in. Changing this forces a new Container Connected Registry to be created.

If parent_registry_id is not specified, the Connected Registry will be connected to the Container Registry identified by container_registry_id.

syncTokenId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Container Registry Token which is used for synchronizing the Connected Registry. Changing this forces a new Container Connected Registry to be created.
auditLogEnabled Boolean
Should the log auditing be enabled?
clientTokenIds List<String>
Specifies a list of IDs of Container Registry Tokens, which are meant to be used by the clients to connect to the Connected Registry.
logLevel String
The verbosity of the logs. Possible values are None, Debug, Information, Warning and Error. Defaults to None.
mode Changes to this property will trigger replacement. String
The mode of the Connected Registry. Possible values are Mirror, ReadOnly, ReadWrite and Registry. Changing this forces a new Container Connected Registry to be created. Defaults to ReadWrite.
name Changes to this property will trigger replacement. String
The name which should be used for this Container Connected Registry. Changing this forces a new Container Connected Registry to be created.
notifications List<ConnectedRegistryNotification>
One or more notification blocks as defined below.
parentRegistryId Changes to this property will trigger replacement. String
The ID of the parent registry. This can be either a Container Registry ID or a Connected Registry ID. Changing this forces a new Container Connected Registry to be created.
syncMessageTtl String
The period of time (in form of ISO8601) for which a message is available to sync before it is expired. Allowed range is from P1D to P90D. Defaults to P1D.
syncSchedule String
The cron expression indicating the schedule that the Connected Registry will sync with its parent. Defaults to * * * * *.
syncWindow String
The time window (in form of ISO8601) during which sync is enabled for each schedule occurrence. Allowed range is from PT3H to P7D.
containerRegistryId
This property is required.
Changes to this property will trigger replacement.
string

The ID of the Container Registry that this Connected Registry will reside in. Changing this forces a new Container Connected Registry to be created.

If parent_registry_id is not specified, the Connected Registry will be connected to the Container Registry identified by container_registry_id.

syncTokenId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Container Registry Token which is used for synchronizing the Connected Registry. Changing this forces a new Container Connected Registry to be created.
auditLogEnabled boolean
Should the log auditing be enabled?
clientTokenIds string[]
Specifies a list of IDs of Container Registry Tokens, which are meant to be used by the clients to connect to the Connected Registry.
logLevel string
The verbosity of the logs. Possible values are None, Debug, Information, Warning and Error. Defaults to None.
mode Changes to this property will trigger replacement. string
The mode of the Connected Registry. Possible values are Mirror, ReadOnly, ReadWrite and Registry. Changing this forces a new Container Connected Registry to be created. Defaults to ReadWrite.
name Changes to this property will trigger replacement. string
The name which should be used for this Container Connected Registry. Changing this forces a new Container Connected Registry to be created.
notifications ConnectedRegistryNotification[]
One or more notification blocks as defined below.
parentRegistryId Changes to this property will trigger replacement. string
The ID of the parent registry. This can be either a Container Registry ID or a Connected Registry ID. Changing this forces a new Container Connected Registry to be created.
syncMessageTtl string
The period of time (in form of ISO8601) for which a message is available to sync before it is expired. Allowed range is from P1D to P90D. Defaults to P1D.
syncSchedule string
The cron expression indicating the schedule that the Connected Registry will sync with its parent. Defaults to * * * * *.
syncWindow string
The time window (in form of ISO8601) during which sync is enabled for each schedule occurrence. Allowed range is from PT3H to P7D.
container_registry_id
This property is required.
Changes to this property will trigger replacement.
str

The ID of the Container Registry that this Connected Registry will reside in. Changing this forces a new Container Connected Registry to be created.

If parent_registry_id is not specified, the Connected Registry will be connected to the Container Registry identified by container_registry_id.

sync_token_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Container Registry Token which is used for synchronizing the Connected Registry. Changing this forces a new Container Connected Registry to be created.
audit_log_enabled bool
Should the log auditing be enabled?
client_token_ids Sequence[str]
Specifies a list of IDs of Container Registry Tokens, which are meant to be used by the clients to connect to the Connected Registry.
log_level str
The verbosity of the logs. Possible values are None, Debug, Information, Warning and Error. Defaults to None.
mode Changes to this property will trigger replacement. str
The mode of the Connected Registry. Possible values are Mirror, ReadOnly, ReadWrite and Registry. Changing this forces a new Container Connected Registry to be created. Defaults to ReadWrite.
name Changes to this property will trigger replacement. str
The name which should be used for this Container Connected Registry. Changing this forces a new Container Connected Registry to be created.
notifications Sequence[ConnectedRegistryNotificationArgs]
One or more notification blocks as defined below.
parent_registry_id Changes to this property will trigger replacement. str
The ID of the parent registry. This can be either a Container Registry ID or a Connected Registry ID. Changing this forces a new Container Connected Registry to be created.
sync_message_ttl str
The period of time (in form of ISO8601) for which a message is available to sync before it is expired. Allowed range is from P1D to P90D. Defaults to P1D.
sync_schedule str
The cron expression indicating the schedule that the Connected Registry will sync with its parent. Defaults to * * * * *.
sync_window str
The time window (in form of ISO8601) during which sync is enabled for each schedule occurrence. Allowed range is from PT3H to P7D.
containerRegistryId
This property is required.
Changes to this property will trigger replacement.
String

The ID of the Container Registry that this Connected Registry will reside in. Changing this forces a new Container Connected Registry to be created.

If parent_registry_id is not specified, the Connected Registry will be connected to the Container Registry identified by container_registry_id.

syncTokenId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Container Registry Token which is used for synchronizing the Connected Registry. Changing this forces a new Container Connected Registry to be created.
auditLogEnabled Boolean
Should the log auditing be enabled?
clientTokenIds List<String>
Specifies a list of IDs of Container Registry Tokens, which are meant to be used by the clients to connect to the Connected Registry.
logLevel String
The verbosity of the logs. Possible values are None, Debug, Information, Warning and Error. Defaults to None.
mode Changes to this property will trigger replacement. String
The mode of the Connected Registry. Possible values are Mirror, ReadOnly, ReadWrite and Registry. Changing this forces a new Container Connected Registry to be created. Defaults to ReadWrite.
name Changes to this property will trigger replacement. String
The name which should be used for this Container Connected Registry. Changing this forces a new Container Connected Registry to be created.
notifications List<Property Map>
One or more notification blocks as defined below.
parentRegistryId Changes to this property will trigger replacement. String
The ID of the parent registry. This can be either a Container Registry ID or a Connected Registry ID. Changing this forces a new Container Connected Registry to be created.
syncMessageTtl String
The period of time (in form of ISO8601) for which a message is available to sync before it is expired. Allowed range is from P1D to P90D. Defaults to P1D.
syncSchedule String
The cron expression indicating the schedule that the Connected Registry will sync with its parent. Defaults to * * * * *.
syncWindow String
The time window (in form of ISO8601) during which sync is enabled for each schedule occurrence. Allowed range is from PT3H to P7D.

Outputs

All input properties are implicitly available as output properties. Additionally, the ConnectedRegistry resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ConnectedRegistry Resource

Get an existing ConnectedRegistry resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ConnectedRegistryState, opts?: CustomResourceOptions): ConnectedRegistry
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        audit_log_enabled: Optional[bool] = None,
        client_token_ids: Optional[Sequence[str]] = None,
        container_registry_id: Optional[str] = None,
        log_level: Optional[str] = None,
        mode: Optional[str] = None,
        name: Optional[str] = None,
        notifications: Optional[Sequence[ConnectedRegistryNotificationArgs]] = None,
        parent_registry_id: Optional[str] = None,
        sync_message_ttl: Optional[str] = None,
        sync_schedule: Optional[str] = None,
        sync_token_id: Optional[str] = None,
        sync_window: Optional[str] = None) -> ConnectedRegistry
func GetConnectedRegistry(ctx *Context, name string, id IDInput, state *ConnectedRegistryState, opts ...ResourceOption) (*ConnectedRegistry, error)
public static ConnectedRegistry Get(string name, Input<string> id, ConnectedRegistryState? state, CustomResourceOptions? opts = null)
public static ConnectedRegistry get(String name, Output<String> id, ConnectedRegistryState state, CustomResourceOptions options)
resources:  _:    type: azure:containerservice:ConnectedRegistry    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AuditLogEnabled bool
Should the log auditing be enabled?
ClientTokenIds List<string>
Specifies a list of IDs of Container Registry Tokens, which are meant to be used by the clients to connect to the Connected Registry.
ContainerRegistryId Changes to this property will trigger replacement. string

The ID of the Container Registry that this Connected Registry will reside in. Changing this forces a new Container Connected Registry to be created.

If parent_registry_id is not specified, the Connected Registry will be connected to the Container Registry identified by container_registry_id.

LogLevel string
The verbosity of the logs. Possible values are None, Debug, Information, Warning and Error. Defaults to None.
Mode Changes to this property will trigger replacement. string
The mode of the Connected Registry. Possible values are Mirror, ReadOnly, ReadWrite and Registry. Changing this forces a new Container Connected Registry to be created. Defaults to ReadWrite.
Name Changes to this property will trigger replacement. string
The name which should be used for this Container Connected Registry. Changing this forces a new Container Connected Registry to be created.
Notifications List<ConnectedRegistryNotification>
One or more notification blocks as defined below.
ParentRegistryId Changes to this property will trigger replacement. string
The ID of the parent registry. This can be either a Container Registry ID or a Connected Registry ID. Changing this forces a new Container Connected Registry to be created.
SyncMessageTtl string
The period of time (in form of ISO8601) for which a message is available to sync before it is expired. Allowed range is from P1D to P90D. Defaults to P1D.
SyncSchedule string
The cron expression indicating the schedule that the Connected Registry will sync with its parent. Defaults to * * * * *.
SyncTokenId Changes to this property will trigger replacement. string
The ID of the Container Registry Token which is used for synchronizing the Connected Registry. Changing this forces a new Container Connected Registry to be created.
SyncWindow string
The time window (in form of ISO8601) during which sync is enabled for each schedule occurrence. Allowed range is from PT3H to P7D.
AuditLogEnabled bool
Should the log auditing be enabled?
ClientTokenIds []string
Specifies a list of IDs of Container Registry Tokens, which are meant to be used by the clients to connect to the Connected Registry.
ContainerRegistryId Changes to this property will trigger replacement. string

The ID of the Container Registry that this Connected Registry will reside in. Changing this forces a new Container Connected Registry to be created.

If parent_registry_id is not specified, the Connected Registry will be connected to the Container Registry identified by container_registry_id.

LogLevel string
The verbosity of the logs. Possible values are None, Debug, Information, Warning and Error. Defaults to None.
Mode Changes to this property will trigger replacement. string
The mode of the Connected Registry. Possible values are Mirror, ReadOnly, ReadWrite and Registry. Changing this forces a new Container Connected Registry to be created. Defaults to ReadWrite.
Name Changes to this property will trigger replacement. string
The name which should be used for this Container Connected Registry. Changing this forces a new Container Connected Registry to be created.
Notifications []ConnectedRegistryNotificationArgs
One or more notification blocks as defined below.
ParentRegistryId Changes to this property will trigger replacement. string
The ID of the parent registry. This can be either a Container Registry ID or a Connected Registry ID. Changing this forces a new Container Connected Registry to be created.
SyncMessageTtl string
The period of time (in form of ISO8601) for which a message is available to sync before it is expired. Allowed range is from P1D to P90D. Defaults to P1D.
SyncSchedule string
The cron expression indicating the schedule that the Connected Registry will sync with its parent. Defaults to * * * * *.
SyncTokenId Changes to this property will trigger replacement. string
The ID of the Container Registry Token which is used for synchronizing the Connected Registry. Changing this forces a new Container Connected Registry to be created.
SyncWindow string
The time window (in form of ISO8601) during which sync is enabled for each schedule occurrence. Allowed range is from PT3H to P7D.
auditLogEnabled Boolean
Should the log auditing be enabled?
clientTokenIds List<String>
Specifies a list of IDs of Container Registry Tokens, which are meant to be used by the clients to connect to the Connected Registry.
containerRegistryId Changes to this property will trigger replacement. String

The ID of the Container Registry that this Connected Registry will reside in. Changing this forces a new Container Connected Registry to be created.

If parent_registry_id is not specified, the Connected Registry will be connected to the Container Registry identified by container_registry_id.

logLevel String
The verbosity of the logs. Possible values are None, Debug, Information, Warning and Error. Defaults to None.
mode Changes to this property will trigger replacement. String
The mode of the Connected Registry. Possible values are Mirror, ReadOnly, ReadWrite and Registry. Changing this forces a new Container Connected Registry to be created. Defaults to ReadWrite.
name Changes to this property will trigger replacement. String
The name which should be used for this Container Connected Registry. Changing this forces a new Container Connected Registry to be created.
notifications List<ConnectedRegistryNotification>
One or more notification blocks as defined below.
parentRegistryId Changes to this property will trigger replacement. String
The ID of the parent registry. This can be either a Container Registry ID or a Connected Registry ID. Changing this forces a new Container Connected Registry to be created.
syncMessageTtl String
The period of time (in form of ISO8601) for which a message is available to sync before it is expired. Allowed range is from P1D to P90D. Defaults to P1D.
syncSchedule String
The cron expression indicating the schedule that the Connected Registry will sync with its parent. Defaults to * * * * *.
syncTokenId Changes to this property will trigger replacement. String
The ID of the Container Registry Token which is used for synchronizing the Connected Registry. Changing this forces a new Container Connected Registry to be created.
syncWindow String
The time window (in form of ISO8601) during which sync is enabled for each schedule occurrence. Allowed range is from PT3H to P7D.
auditLogEnabled boolean
Should the log auditing be enabled?
clientTokenIds string[]
Specifies a list of IDs of Container Registry Tokens, which are meant to be used by the clients to connect to the Connected Registry.
containerRegistryId Changes to this property will trigger replacement. string

The ID of the Container Registry that this Connected Registry will reside in. Changing this forces a new Container Connected Registry to be created.

If parent_registry_id is not specified, the Connected Registry will be connected to the Container Registry identified by container_registry_id.

logLevel string
The verbosity of the logs. Possible values are None, Debug, Information, Warning and Error. Defaults to None.
mode Changes to this property will trigger replacement. string
The mode of the Connected Registry. Possible values are Mirror, ReadOnly, ReadWrite and Registry. Changing this forces a new Container Connected Registry to be created. Defaults to ReadWrite.
name Changes to this property will trigger replacement. string
The name which should be used for this Container Connected Registry. Changing this forces a new Container Connected Registry to be created.
notifications ConnectedRegistryNotification[]
One or more notification blocks as defined below.
parentRegistryId Changes to this property will trigger replacement. string
The ID of the parent registry. This can be either a Container Registry ID or a Connected Registry ID. Changing this forces a new Container Connected Registry to be created.
syncMessageTtl string
The period of time (in form of ISO8601) for which a message is available to sync before it is expired. Allowed range is from P1D to P90D. Defaults to P1D.
syncSchedule string
The cron expression indicating the schedule that the Connected Registry will sync with its parent. Defaults to * * * * *.
syncTokenId Changes to this property will trigger replacement. string
The ID of the Container Registry Token which is used for synchronizing the Connected Registry. Changing this forces a new Container Connected Registry to be created.
syncWindow string
The time window (in form of ISO8601) during which sync is enabled for each schedule occurrence. Allowed range is from PT3H to P7D.
audit_log_enabled bool
Should the log auditing be enabled?
client_token_ids Sequence[str]
Specifies a list of IDs of Container Registry Tokens, which are meant to be used by the clients to connect to the Connected Registry.
container_registry_id Changes to this property will trigger replacement. str

The ID of the Container Registry that this Connected Registry will reside in. Changing this forces a new Container Connected Registry to be created.

If parent_registry_id is not specified, the Connected Registry will be connected to the Container Registry identified by container_registry_id.

log_level str
The verbosity of the logs. Possible values are None, Debug, Information, Warning and Error. Defaults to None.
mode Changes to this property will trigger replacement. str
The mode of the Connected Registry. Possible values are Mirror, ReadOnly, ReadWrite and Registry. Changing this forces a new Container Connected Registry to be created. Defaults to ReadWrite.
name Changes to this property will trigger replacement. str
The name which should be used for this Container Connected Registry. Changing this forces a new Container Connected Registry to be created.
notifications Sequence[ConnectedRegistryNotificationArgs]
One or more notification blocks as defined below.
parent_registry_id Changes to this property will trigger replacement. str
The ID of the parent registry. This can be either a Container Registry ID or a Connected Registry ID. Changing this forces a new Container Connected Registry to be created.
sync_message_ttl str
The period of time (in form of ISO8601) for which a message is available to sync before it is expired. Allowed range is from P1D to P90D. Defaults to P1D.
sync_schedule str
The cron expression indicating the schedule that the Connected Registry will sync with its parent. Defaults to * * * * *.
sync_token_id Changes to this property will trigger replacement. str
The ID of the Container Registry Token which is used for synchronizing the Connected Registry. Changing this forces a new Container Connected Registry to be created.
sync_window str
The time window (in form of ISO8601) during which sync is enabled for each schedule occurrence. Allowed range is from PT3H to P7D.
auditLogEnabled Boolean
Should the log auditing be enabled?
clientTokenIds List<String>
Specifies a list of IDs of Container Registry Tokens, which are meant to be used by the clients to connect to the Connected Registry.
containerRegistryId Changes to this property will trigger replacement. String

The ID of the Container Registry that this Connected Registry will reside in. Changing this forces a new Container Connected Registry to be created.

If parent_registry_id is not specified, the Connected Registry will be connected to the Container Registry identified by container_registry_id.

logLevel String
The verbosity of the logs. Possible values are None, Debug, Information, Warning and Error. Defaults to None.
mode Changes to this property will trigger replacement. String
The mode of the Connected Registry. Possible values are Mirror, ReadOnly, ReadWrite and Registry. Changing this forces a new Container Connected Registry to be created. Defaults to ReadWrite.
name Changes to this property will trigger replacement. String
The name which should be used for this Container Connected Registry. Changing this forces a new Container Connected Registry to be created.
notifications List<Property Map>
One or more notification blocks as defined below.
parentRegistryId Changes to this property will trigger replacement. String
The ID of the parent registry. This can be either a Container Registry ID or a Connected Registry ID. Changing this forces a new Container Connected Registry to be created.
syncMessageTtl String
The period of time (in form of ISO8601) for which a message is available to sync before it is expired. Allowed range is from P1D to P90D. Defaults to P1D.
syncSchedule String
The cron expression indicating the schedule that the Connected Registry will sync with its parent. Defaults to * * * * *.
syncTokenId Changes to this property will trigger replacement. String
The ID of the Container Registry Token which is used for synchronizing the Connected Registry. Changing this forces a new Container Connected Registry to be created.
syncWindow String
The time window (in form of ISO8601) during which sync is enabled for each schedule occurrence. Allowed range is from PT3H to P7D.

Supporting Types

ConnectedRegistryNotification
, ConnectedRegistryNotificationArgs

Action This property is required. string
The action of the artifact that wants to be subscribed for the Connected Registry. Possible values are push, delete and * (i.e. any).
Name This property is required. string
The name of the artifact that wants to be subscribed for the Connected Registry.
Digest string

The digest of the artifact that wants to be subscribed for the Connected Registry.

NOTE: One of either tag or digest can be specified.

Tag string
The tag of the artifact that wants to be subscribed for the Connected Registry.
Action This property is required. string
The action of the artifact that wants to be subscribed for the Connected Registry. Possible values are push, delete and * (i.e. any).
Name This property is required. string
The name of the artifact that wants to be subscribed for the Connected Registry.
Digest string

The digest of the artifact that wants to be subscribed for the Connected Registry.

NOTE: One of either tag or digest can be specified.

Tag string
The tag of the artifact that wants to be subscribed for the Connected Registry.
action This property is required. String
The action of the artifact that wants to be subscribed for the Connected Registry. Possible values are push, delete and * (i.e. any).
name This property is required. String
The name of the artifact that wants to be subscribed for the Connected Registry.
digest String

The digest of the artifact that wants to be subscribed for the Connected Registry.

NOTE: One of either tag or digest can be specified.

tag String
The tag of the artifact that wants to be subscribed for the Connected Registry.
action This property is required. string
The action of the artifact that wants to be subscribed for the Connected Registry. Possible values are push, delete and * (i.e. any).
name This property is required. string
The name of the artifact that wants to be subscribed for the Connected Registry.
digest string

The digest of the artifact that wants to be subscribed for the Connected Registry.

NOTE: One of either tag or digest can be specified.

tag string
The tag of the artifact that wants to be subscribed for the Connected Registry.
action This property is required. str
The action of the artifact that wants to be subscribed for the Connected Registry. Possible values are push, delete and * (i.e. any).
name This property is required. str
The name of the artifact that wants to be subscribed for the Connected Registry.
digest str

The digest of the artifact that wants to be subscribed for the Connected Registry.

NOTE: One of either tag or digest can be specified.

tag str
The tag of the artifact that wants to be subscribed for the Connected Registry.
action This property is required. String
The action of the artifact that wants to be subscribed for the Connected Registry. Possible values are push, delete and * (i.e. any).
name This property is required. String
The name of the artifact that wants to be subscribed for the Connected Registry.
digest String

The digest of the artifact that wants to be subscribed for the Connected Registry.

NOTE: One of either tag or digest can be specified.

tag String
The tag of the artifact that wants to be subscribed for the Connected Registry.

Import

Container Connected Registries can be imported using the resource id, e.g.

$ pulumi import azure:containerservice/connectedRegistry:ConnectedRegistry example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/group1/providers/Microsoft.ContainerRegistry/registries/registry1/connectedRegistries/registry1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure