container_registry

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

Overview

Name	container_registry
Type	Resource
Id	azure.container_registry_dataplane.container_registry

Fields

The following fields are returned by SELECT queries:

get_manifest

Name	Datatype	Description
name	string	(V1) Image name.
annotations	object	(OCI, OCIIndex) Additional metadata.
architecture	string	(V1) CPU architecture.
config	object	(V2, OCI) Image config descriptor.
fsLayers	array	(V1) List of layer information.
history	array	(V1) Image history.
layers	array	(V2, OCI) List of V2 image layer information.
manifests	array	(ManifestList, OCIIndex) List of V2 image layer information.
mediaType	string	Media type for this Manifest.
schemaVersion	integer	Schema version.
signatures	array	(V1) Image signature.
tag	string	(V1) Image tag.

get_manifest_properties

Name	Datatype	Description
imageName	string	Repository name.
manifest	object	Manifest details.
registry	string	Registry login server name. This is likely to be similar to {registry-name}.azurecr.io.

get_properties

Name	Datatype	Description
changeableAttributes	object	Writeable properties of the resource. Required.
createdTime	string (date-time)	Image created time. Required.
imageName	string	Image name. Required.
lastUpdateTime	string (date-time)	Image last update time. Required.
manifestCount	integer	Number of the manifests. Required.
registry	string	Registry login server name. This is likely to be similar to {registry-name}.azurecr.io. Required.
tagCount	integer	Number of the tags. Required.

get_repositories

Name	Datatype	Description
value	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_manifest	select	name, reference, endpoint		Get the manifest identified by name and reference where reference can be a tag or digest.
get_manifest_properties	select	name, digest, endpoint		Get manifest attributes.
get_properties	select	name, endpoint		Get repository attributes.
get_repositories	select	endpoint	last, n	List repositories.
create_manifest	exec	name, reference, endpoint		Put the manifest identified by name and reference where reference can be a tag or digest.
delete_manifest	exec	name, reference, endpoint		Delete the manifest identified by name and reference. Note that a manifest can only be deleted by digest.
delete_repository	exec	name, endpoint		Delete the repository identified by name.
update_properties	exec	name, endpoint		Update the attribute identified by name where reference is the name of the repository.
get_tags	exec	name, endpoint	last, n, orderby, digest	List tags of a repository.
get_tag_properties	exec	name, reference, endpoint		Get tag attributes by tag.
update_tag_attributes	exec	name, reference, endpoint		Update tag attributes.
delete_tag	exec	name, reference, endpoint		Delete tag.
get_manifests	exec	name, endpoint	last, n, orderby	List manifests of a repository.
update_manifest_properties	exec	name, digest, endpoint		Update properties of a manifest.
check_docker_v2_support	exec	endpoint		Tells whether this Docker Registry instance supports Docker Registry HTTP API v2.

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
digest	string	Digest of a BLOB. Required.
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
name	string	Name of the image (including the namespace). Required.
reference	string	Tag name. Required.
digest	string	filter by digest. Default value is None.
last	string	Query parameter for the last item in previous query. Result set will include values lexically after last. Default value is None.
n	integer	query parameter for max number of items. Default value is None.
orderby	string	orderby query parameter. Known values are: "none", "timedesc", and "timeasc". Default value is None.

SELECT examples

get_manifest

Get the manifest identified by name and reference where reference can be a tag or digest.

SELECT
name,
annotations,
architecture,
config,
fsLayers,
history,
layers,
manifests,
mediaType,
schemaVersion,
signatures,
tag
FROM azure.container_registry_dataplane.container_registry
WHERE name = '{{ name }}' -- required
AND reference = '{{ reference }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

get_manifest_properties

Get manifest attributes.

SELECT
imageName,
manifest,
registry
FROM azure.container_registry_dataplane.container_registry
WHERE name = '{{ name }}' -- required
AND digest = '{{ digest }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

get_properties

Get repository attributes.

SELECT
changeableAttributes,
createdTime,
imageName,
lastUpdateTime,
manifestCount,
registry,
tagCount
FROM azure.container_registry_dataplane.container_registry
WHERE name = '{{ name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

get_repositories

List repositories.

SELECT
value
FROM azure.container_registry_dataplane.container_registry
WHERE endpoint = '{{ endpoint }}' -- required
AND last = '{{ last }}'
AND n = '{{ n }}'
;

Lifecycle Methods

create_manifest

Put the manifest identified by name and reference where reference can be a tag or digest.

EXEC azure.container_registry_dataplane.container_registry.create_manifest 
@name='{{ name }}' --required, 
@reference='{{ reference }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"schemaVersion": {{ schemaVersion }}
}'
;

delete_manifest

Delete the manifest identified by name and reference. Note that a manifest can only be deleted by digest.

EXEC azure.container_registry_dataplane.container_registry.delete_manifest 
@name='{{ name }}' --required, 
@reference='{{ reference }}' --required, 
@endpoint='{{ endpoint }}' --required
;

delete_repository

Delete the repository identified by name.

EXEC azure.container_registry_dataplane.container_registry.delete_repository 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

update_properties

Update the attribute identified by name where reference is the name of the repository.

EXEC azure.container_registry_dataplane.container_registry.update_properties 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"deleteEnabled": {{ deleteEnabled }}, 
"writeEnabled": {{ writeEnabled }}, 
"listEnabled": {{ listEnabled }}, 
"readEnabled": {{ readEnabled }}
}'
;

get_tags

List tags of a repository.

EXEC azure.container_registry_dataplane.container_registry.get_tags 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@last='{{ last }}', 
@n='{{ n }}', 
@orderby='{{ orderby }}', 
@digest='{{ digest }}'
;

get_tag_properties

Get tag attributes by tag.

EXEC azure.container_registry_dataplane.container_registry.get_tag_properties 
@name='{{ name }}' --required, 
@reference='{{ reference }}' --required, 
@endpoint='{{ endpoint }}' --required
;

update_tag_attributes

Update tag attributes.

EXEC azure.container_registry_dataplane.container_registry.update_tag_attributes 
@name='{{ name }}' --required, 
@reference='{{ reference }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"deleteEnabled": {{ deleteEnabled }}, 
"writeEnabled": {{ writeEnabled }}, 
"listEnabled": {{ listEnabled }}, 
"readEnabled": {{ readEnabled }}
}'
;

delete_tag

Delete tag.

EXEC azure.container_registry_dataplane.container_registry.delete_tag 
@name='{{ name }}' --required, 
@reference='{{ reference }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_manifests

List manifests of a repository.

EXEC azure.container_registry_dataplane.container_registry.get_manifests 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@last='{{ last }}', 
@n='{{ n }}', 
@orderby='{{ orderby }}'
;

update_manifest_properties

Update properties of a manifest.

EXEC azure.container_registry_dataplane.container_registry.update_manifest_properties 
@name='{{ name }}' --required, 
@digest='{{ digest }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"deleteEnabled": {{ deleteEnabled }}, 
"writeEnabled": {{ writeEnabled }}, 
"listEnabled": {{ listEnabled }}, 
"readEnabled": {{ readEnabled }}
}'
;

check_docker_v2_support

Tells whether this Docker Registry instance supports Docker Registry HTTP API v2.

EXEC azure.container_registry_dataplane.container_registry.check_docker_v2_support 
@endpoint='{{ endpoint }}' --required
;