registries

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

Overview

Name	registries
Type	Resource
Id	azure.container_registry.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.
identity	object	The identity of the container registry.
location	string	The location of the resource. This cannot be changed after the resource is created.
properties	object	The properties of the container registry.
sku	object	The SKU of a container registry.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	The tags of the resource.
type	string	The type of the resource.

list_by_resource_group

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.
identity	object	The identity of the container registry.
location	string	The location of the resource. This cannot be changed after the resource is created.
properties	object	The properties of the container registry.
sku	object	The SKU of a container registry.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	The tags 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.
identity	object	The identity of the container registry.
location	string	The location of the resource. This cannot be changed after the resource is created.
properties	object	The properties of the container registry.
sku	object	The SKU of a container registry.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	The tags 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		Gets the properties of the specified container registry.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all the container registries under the specified resource group.
list	select	subscriptionId		Lists all the container registries under the specified subscription.
create	insert	subscriptionId, resourceGroupName, registryName, data__sku		Creates a container registry with the specified parameters.
update	update	subscriptionId, resourceGroupName, registryName		Updates a container registry with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, registryName		Deletes a container registry.
schedule_run	exec	subscriptionId, resourceGroupName, registryName, type		Schedules a new run based on the request parameters and add it to the run queue.
import_image	exec	subscriptionId, resourceGroupName, registryName, source		Copies an image to this container registry from the specified container registry.
check_name_availability	exec	subscriptionId, name, type		Checks whether the container registry name is available for use. The name must contain only alphanumeric characters, be globally unique, and between 5 and 50 characters in length.
regenerate_credential	exec	subscriptionId, resourceGroupName, registryName, name		Regenerates one of the login credentials for the specified container registry.
generate_credentials	exec	subscriptionId, resourceGroupName, registryName		Generate keys for a token of a specified container registry.

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
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.

SELECT examples

get

Gets the properties of the specified container registry.

SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.container_registry.registries
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND registryName = '{{ registryName }}' -- required
;

list_by_resource_group

Lists all the container registries under the specified resource group.

SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.container_registry.registries
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

Lists all the container registries under the specified subscription.

SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.container_registry.registries
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates a container registry with the specified parameters.

INSERT INTO azure.container_registry.registries (
data__location,
data__tags,
data__sku,
data__identity,
data__properties,
subscriptionId,
resourceGroupName,
registryName
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ sku }}' /* required */,
'{{ identity }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ registryName }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: registries
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the registries resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the registries resource.
    - name: registryName
      value: string
      description: Required parameter for the registries resource.
    - name: location
      value: string
      description: |
        The location of the resource. This cannot be changed after the resource is created.
    - name: tags
      value: object
      description: |
        The tags of the resource.
    - name: sku
      value: object
      description: |
        The SKU of a container registry.
    - name: identity
      value: object
      description: |
        The identity of the container registry.
    - name: properties
      value: object
      description: |
        The properties of the container registry.

UPDATE examples

update

Updates a container registry with the specified parameters.

UPDATE azure.container_registry.registries
SET 
data__identity = '{{ identity }}',
data__tags = '{{ tags }}',
data__sku = '{{ sku }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND registryName = '{{ registryName }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes a container registry.

DELETE FROM azure.container_registry.registries
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND registryName = '{{ registryName }}' --required
;

Lifecycle Methods

schedule_run

Schedules a new run based on the request parameters and add it to the run queue.

EXEC azure.container_registry.registries.schedule_run 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@registryName='{{ registryName }}' --required 
@@json=
'{
"type": "{{ type }}", 
"isArchiveEnabled": {{ isArchiveEnabled }}, 
"agentPoolName": "{{ agentPoolName }}", 
"logTemplate": "{{ logTemplate }}"
}'
;

import_image

Copies an image to this container registry from the specified container registry.

EXEC azure.container_registry.registries.import_image 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@registryName='{{ registryName }}' --required 
@@json=
'{
"source": "{{ source }}", 
"targetTags": "{{ targetTags }}", 
"untaggedTargetRepositories": "{{ untaggedTargetRepositories }}", 
"mode": "{{ mode }}"
}'
;

check_name_availability

Checks whether the container registry name is available for use. The name must contain only alphanumeric characters, be globally unique, and between 5 and 50 characters in length.

EXEC azure.container_registry.registries.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;

regenerate_credential

Regenerates one of the login credentials for the specified container registry.

EXEC azure.container_registry.registries.regenerate_credential 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@registryName='{{ registryName }}' --required 
@@json=
'{
"name": "{{ name }}"
}'
;

generate_credentials

Generate keys for a token of a specified container registry.

EXEC azure.container_registry.registries.generate_credentials 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@registryName='{{ registryName }}' --required 
@@json=
'{
"tokenId": "{{ tokenId }}", 
"expiry": "{{ expiry }}", 
"name": "{{ name }}"
}'
;