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

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.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the replication at the time the operation was called. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
regionEndpointEnabled	boolean	Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications.
status	object	The status of the replication at the time the operation was called.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zoneRedundancy	string	Whether or not zone redundancy is enabled for this container registry replication. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)

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.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the replication at the time the operation was called. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
regionEndpointEnabled	boolean	Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications.
status	object	The status of the replication at the time the operation was called.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zoneRedundancy	string	Whether or not zone redundancy is enabled for this container registry replication. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, registry_name, replication_name, subscription_id		Gets the properties of the specified replication.
list	select	resource_group_name, registry_name, subscription_id		Lists all the replications for the specified container registry.
create	insert	resource_group_name, registry_name, replication_name, subscription_id, location		Creates a replication for a container registry with the specified parameters.
update	update	resource_group_name, registry_name, replication_name, subscription_id		Updates a replication for a container registry with the specified parameters.
delete	delete	resource_group_name, registry_name, replication_name, subscription_id		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
registry_name	string	The name of the container registry. Required.
replication_name	string	The name of the replication. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the properties of the specified replication.

SELECT
id,
name,
location,
provisioningState,
regionEndpointEnabled,
status,
systemData,
tags,
type,
zoneRedundancy
FROM azure.container_registry.replications
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND registry_name = '{{ registry_name }}' -- required
AND replication_name = '{{ replication_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all the replications for the specified container registry.

SELECT
id,
name,
location,
provisioningState,
regionEndpointEnabled,
status,
systemData,
tags,
type,
zoneRedundancy
FROM azure.container_registry.replications
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND registry_name = '{{ registry_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

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

INSERT INTO azure.container_registry.replications (
tags,
location,
properties,
resource_group_name,
registry_name,
replication_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ registry_name }}',
'{{ replication_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: replications
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the replications resource.
  - name: registry_name
    value: "{{ registry_name }}"
    description: Required parameter for the replications resource.
  - name: replication_name
    value: "{{ replication_name }}"
    description: Required parameter for the replications resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the replications resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The properties of the replication.
    value:
      provisioningState: "{{ provisioningState }}"
      status:
        displayStatus: "{{ displayStatus }}"
        message: "{{ message }}"
        timestamp: "{{ timestamp }}"
      regionEndpointEnabled: {{ regionEndpointEnabled }}
      zoneRedundancy: "{{ zoneRedundancy }}"

UPDATE examples

update

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

UPDATE azure.container_registry.replications
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND registry_name = '{{ registry_name }}' --required
AND replication_name = '{{ replication_name }}' --required
AND subscription_id = '{{ subscription_id }}' --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 resource_group_name = '{{ resource_group_name }}' --required
AND registry_name = '{{ registry_name }}' --required
AND replication_name = '{{ replication_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;