replications

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

Overview

Name	replications
Type	Resource
Id	azure.container_registry.replications

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.
location	string	The location of the resource. This cannot be changed after the resource is created.
properties	object	The properties of the replication.
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.
location	string	The location of the resource. This cannot be changed after the resource is created.
properties	object	The properties of the replication.
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, replicationName		Gets the properties of the specified replication.
list	select	subscriptionId, resourceGroupName, registryName		Lists all the replications for the specified container registry.
create	insert	subscriptionId, resourceGroupName, registryName, replicationName		Creates a replication for a container registry with the specified parameters.
update	update	subscriptionId, resourceGroupName, registryName, replicationName		Updates a replication for a container registry with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, registryName, replicationName		Deletes a replication from a 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.
replicationName	string	The name of the replication.
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 replication.

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

list

Lists all the replications for the specified container registry.

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

INSERT examples

create

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

INSERT INTO azure.container_registry.replications (
data__location,
data__tags,
data__properties,
subscriptionId,
resourceGroupName,
registryName,
replicationName
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ registryName }}',
'{{ replicationName }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: replications
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the replications resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the replications resource.
    - name: registryName
      value: string
      description: Required parameter for the replications resource.
    - name: replicationName
      value: string
      description: Required parameter for the replications 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: properties
      value: object
      description: |
        The properties of the replication.

UPDATE examples

update

Updates a replication for a container registry with the specified parameters.

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

DELETE examples

delete

Deletes a replication from a container registry.

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