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

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
properties	object	The properties of the connected registry.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

list

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
properties	object	The properties of the connected registry.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, registryName, connectedRegistryName		Gets the properties of the connected registry.
list	select	subscriptionId, resourceGroupName, registryName	$filter	Lists all connected registries for the specified container registry.
create	insert	subscriptionId, resourceGroupName, registryName, connectedRegistryName		Creates a connected registry for a container registry with the specified parameters.
update	update	subscriptionId, resourceGroupName, registryName, connectedRegistryName		Updates a connected registry with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, registryName, connectedRegistryName		Deletes a connected registry from a container registry.
deactivate	exec	subscriptionId, resourceGroupName, registryName, connectedRegistryName		Deactivates 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
connectedRegistryName	string	The name of the connected registry.
registryName	string	The name of the container registry.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$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.

SELECT examples

get

Gets the properties of the connected registry.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.container_registry.connected_registries
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND registryName = '{{ registryName }}' -- required
AND connectedRegistryName = '{{ connectedRegistryName }}' -- required
;

list

Lists all connected registries for the specified container registry.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.container_registry.connected_registries
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND registryName = '{{ registryName }}' -- 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 (
data__properties,
subscriptionId,
resourceGroupName,
registryName,
connectedRegistryName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ registryName }}',
'{{ connectedRegistryName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: connected_registries
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the connected_registries resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the connected_registries resource.
    - name: registryName
      value: string
      description: Required parameter for the connected_registries resource.
    - name: connectedRegistryName
      value: string
      description: Required parameter for the connected_registries resource.
    - name: properties
      value: object
      description: |
        The properties of the connected registry.

UPDATE examples

update

Updates a connected registry with the specified parameters.

UPDATE azure.container_registry.connected_registries
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND registryName = '{{ registryName }}' --required
AND connectedRegistryName = '{{ connectedRegistryName }}' --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 subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND registryName = '{{ registryName }}' --required
AND connectedRegistryName = '{{ connectedRegistryName }}' --required
;

Lifecycle Methods

deactivate

Deactivates the connected registry instance.

EXEC azure.container_registry.connected_registries.deactivate 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@registryName='{{ registryName }}' --required, 
@connectedRegistryName='{{ connectedRegistryName }}' --required
;