container_registries

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

Overview

Name	container_registries
Type	Resource
Id	azure_extras.app_platform.container_registries

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
credentials	object	The credentials of the container registry resource. Required.
provisioningState	string	State of the Container Registry. Known values are: "Creating", "Updating", "Succeeded", "Failed", "Deleting", and "Canceled".
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

list

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
credentials	object	The credentials of the container registry resource. Required.
provisioningState	string	State of the Container Registry. Known values are: "Creating", "Updating", "Succeeded", "Failed", "Deleting", and "Canceled".
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	resource_group_name, service_name, container_registry_name, subscription_id		Get the container registries resource.
list	select	resource_group_name, service_name, subscription_id		List container registries resource.
create_or_update	insert	resource_group_name, service_name, container_registry_name, subscription_id		Create or update container registry resource.
create_or_update	replace	resource_group_name, service_name, container_registry_name, subscription_id		Create or update container registry resource.
delete	delete	resource_group_name, service_name, container_registry_name, subscription_id		Delete a container registry resource.
validate	exec	resource_group_name, service_name, container_registry_name, subscription_id, credentials		Check if the container registry properties are valid.

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
container_registry_name	string	The name of the container registry. Required.
resource_group_name	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
service_name	string	The name of the Service resource. Required.
subscription_id	string

SELECT examples

get

Get the container registries resource.

SELECT
id,
name,
credentials,
provisioningState,
systemData,
type
FROM azure_extras.app_platform.container_registries
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND container_registry_name = '{{ container_registry_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List container registries resource.

SELECT
id,
name,
credentials,
provisioningState,
systemData,
type
FROM azure_extras.app_platform.container_registries
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update container registry resource.

INSERT INTO azure_extras.app_platform.container_registries (
properties,
resource_group_name,
service_name,
container_registry_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ container_registry_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: container_registries
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the container_registries resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the container_registries resource.
  - name: container_registry_name
    value: "{{ container_registry_name }}"
    description: Required parameter for the container_registries resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the container_registries resource.
  - name: properties
    description: |
      Properties of the container registry resource payload.
    value:
      credentials:
        type: "{{ type }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Create or update container registry resource.

REPLACE azure_extras.app_platform.container_registries
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND container_registry_name = '{{ container_registry_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a container registry resource.

DELETE FROM azure_extras.app_platform.container_registries
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND container_registry_name = '{{ container_registry_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

validate

Check if the container registry properties are valid.

EXEC azure_extras.app_platform.container_registries.validate 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@container_registry_name='{{ container_registry_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"credentials": "{{ credentials }}"
}'
;