connected_registries

Creates, updates, deletes, gets or lists a connected_registries resource.

Overview

Name	connected_registries
Type	Resource
Id	azure.container_registry.connected_registries

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the private link resource.
activation	object	The activation properties of the connected registry.
clientTokenIds	array	The list of the ACR token resource IDs used to authenticate clients to the connected registry.
connectionState	string	The current connection state of the connected registry. Known values are: "Online", "Offline", "Syncing", and "Unhealthy". (Online, Offline, Syncing, Unhealthy)
garbageCollection	object	The garbage collection properties of the connected registry.
lastActivityTime	string (date-time)	The last activity time of the connected registry.
logging	object	The logging properties of the connected registry.
loginServer	object	The login server properties of the connected registry.
mode	string	The mode of the connected registry resource that indicates the permissions of the registry. Required. Known values are: "ReadWrite", "ReadOnly", "Registry", and "Mirror". (ReadWrite, ReadOnly, Registry, Mirror)
notificationsList	array	The list of notifications subscription information for the connected registry.
parent	object	The parent of the connected registry. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
registrySyncResult	object	The result of the connected registry's most recent sync with its parent.
statusDetails	array	The list of current statuses of the connected registry.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	The current version of ACR runtime on the connected registry.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the private link resource.
activation	object	The activation properties of the connected registry.
clientTokenIds	array	The list of the ACR token resource IDs used to authenticate clients to the connected registry.
connectionState	string	The current connection state of the connected registry. Known values are: "Online", "Offline", "Syncing", and "Unhealthy". (Online, Offline, Syncing, Unhealthy)
garbageCollection	object	The garbage collection properties of the connected registry.
lastActivityTime	string (date-time)	The last activity time of the connected registry.
logging	object	The logging properties of the connected registry.
loginServer	object	The login server properties of the connected registry.
mode	string	The mode of the connected registry resource that indicates the permissions of the registry. Required. Known values are: "ReadWrite", "ReadOnly", "Registry", and "Mirror". (ReadWrite, ReadOnly, Registry, Mirror)
notificationsList	array	The list of notifications subscription information for the connected registry.
parent	object	The parent of the connected registry. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
registrySyncResult	object	The result of the connected registry's most recent sync with its parent.
statusDetails	array	The list of current statuses of the connected registry.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	The current version of ACR runtime on the connected registry.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, registry_name, connected_registry_name, subscription_id		Gets the properties of the connected registry.
list	select	resource_group_name, registry_name, subscription_id	$filter	Lists all connected registries for the specified container registry.
create	insert	resource_group_name, registry_name, connected_registry_name, subscription_id		Creates a connected registry for a container registry with the specified parameters.
update	update	resource_group_name, registry_name, connected_registry_name, subscription_id		Updates a connected registry with the specified parameters.
delete	delete	resource_group_name, registry_name, connected_registry_name, subscription_id		Deletes a connected registry from a container registry.
deactivate	exec	resource_group_name, registry_name, connected_registry_name, subscription_id		Deactivates the connected registry instance.
resync	exec	resource_group_name, registry_name, connected_registry_name, subscription_id		Resync the connected registry instance.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
connected_registry_name	string	The name of the connected registry. Required.
registry_name	string	The name of the container registry. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$filter	string	An OData filter expression that describes a subset of connectedRegistries to return. The parameters that can be filtered are parent.id (the resource id of the connectedRegistry parent), mode, and connectionState. The supported operator is eq. Default value is None.

SELECT examples

get

Gets the properties of the connected registry.

SELECT
id,
name,
activation,
clientTokenIds,
connectionState,
garbageCollection,
lastActivityTime,
logging,
loginServer,
mode,
notificationsList,
parent,
provisioningState,
registrySyncResult,
statusDetails,
systemData,
type,
version
FROM azure.container_registry.connected_registries
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND registry_name = '{{ registry_name }}' -- required
AND connected_registry_name = '{{ connected_registry_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all connected registries for the specified container registry.

SELECT
id,
name,
activation,
clientTokenIds,
connectionState,
garbageCollection,
lastActivityTime,
logging,
loginServer,
mode,
notificationsList,
parent,
provisioningState,
registrySyncResult,
statusDetails,
systemData,
type,
version
FROM azure.container_registry.connected_registries
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND registry_name = '{{ registry_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Creates a connected registry for a container registry with the specified parameters.

INSERT INTO azure.container_registry.connected_registries (
properties,
resource_group_name,
registry_name,
connected_registry_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ registry_name }}',
'{{ connected_registry_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: connected_registries
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the connected_registries resource.
  - name: registry_name
    value: "{{ registry_name }}"
    description: Required parameter for the connected_registries resource.
  - name: connected_registry_name
    value: "{{ connected_registry_name }}"
    description: Required parameter for the connected_registries resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the connected_registries resource.
  - name: properties
    description: |
      The properties of the connected registry.
    value:
      provisioningState: "{{ provisioningState }}"
      mode: "{{ mode }}"
      version: "{{ version }}"
      connectionState: "{{ connectionState }}"
      lastActivityTime: "{{ lastActivityTime }}"
      activation:
        status: "{{ status }}"
      parent:
        id: "{{ id }}"
        syncProperties:
          tokenId: "{{ tokenId }}"
          schedule: "{{ schedule }}"
          syncWindow: "{{ syncWindow }}"
          messageTtl: "{{ messageTtl }}"
          lastSyncTime: "{{ lastSyncTime }}"
          gatewayEndpoint: "{{ gatewayEndpoint }}"
      clientTokenIds:
        - "{{ clientTokenIds }}"
      loginServer:
        host: "{{ host }}"
        tls:
          status: "{{ status }}"
          certificate:
            type: "{{ type }}"
            location: "{{ location }}"
      logging:
        logLevel: "{{ logLevel }}"
        auditLogStatus: "{{ auditLogStatus }}"
      statusDetails:
        - type: "{{ type }}"
          code: "{{ code }}"
          description: "{{ description }}"
          timestamp: "{{ timestamp }}"
          correlationId: "{{ correlationId }}"
      notificationsList:
        - "{{ notificationsList }}"
      garbageCollection:
        enabled: {{ enabled }}
        schedule: "{{ schedule }}"
      registrySyncResult:
        syncTrigger: "{{ syncTrigger }}"
        syncState: "{{ syncState }}"
        lastSyncStartTime: "{{ lastSyncStartTime }}"
        lastSyncEndTime: "{{ lastSyncEndTime }}"
        lastSuccessfulSyncEndTime: "{{ lastSuccessfulSyncEndTime }}"

UPDATE examples

update

Updates a connected registry with the specified parameters.

UPDATE azure.container_registry.connected_registries
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND registry_name = '{{ registry_name }}' --required
AND connected_registry_name = '{{ connected_registry_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a connected registry from a container registry.

DELETE FROM azure.container_registry.connected_registries
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND registry_name = '{{ registry_name }}' --required
AND connected_registry_name = '{{ connected_registry_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

deactivate

Deactivates the connected registry instance.

EXEC azure.container_registry.connected_registries.deactivate 
@resource_group_name='{{ resource_group_name }}' --required, 
@registry_name='{{ registry_name }}' --required, 
@connected_registry_name='{{ connected_registry_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

resync

Resync the connected registry instance.

EXEC azure.container_registry.connected_registries.resync 
@resource_group_name='{{ resource_group_name }}' --required, 
@registry_name='{{ registry_name }}' --required, 
@connected_registry_name='{{ connected_registry_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;