archives

Creates, updates, deletes, gets or lists an archives resource.

Overview

Name	archives
Type	Resource
Id	azure.container_registry.archives

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.
packageSource	object	The package source of the archive.
provisioningState	string	The provisioning state of the archive at the time the operation was called. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
publishedVersion	string	The published version of the archive.
repositoryEndpoint	string	:vartype repository_endpoint: str
repositoryEndpointPrefix	string	:vartype repository_endpoint_prefix: str
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
packageSource	object	The package source of the archive.
provisioningState	string	The provisioning state of the archive at the time the operation was called. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
publishedVersion	string	The published version of the archive.
repositoryEndpoint	string	:vartype repository_endpoint: str
repositoryEndpointPrefix	string	:vartype repository_endpoint_prefix: str
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, registry_name, package_type, archive_name, subscription_id		Gets the properties of the archive.
list	select	resource_group_name, registry_name, package_type, subscription_id		Lists all archives for the specified container registry and package type.
create	insert	resource_group_name, registry_name, package_type, archive_name, subscription_id		Creates a archive for a container registry with the specified parameters.
update	update	resource_group_name, registry_name, package_type, archive_name, subscription_id		Updates a archive for a container registry with the specified parameters.
delete	delete	resource_group_name, registry_name, package_type, archive_name, subscription_id		Deletes a archive 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
archive_name	string	The name of the archive resource. Required.
package_type	string	The package type. Required.
registry_name	string	The name of the container registry. 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 archive.

SELECT
id,
name,
packageSource,
provisioningState,
publishedVersion,
repositoryEndpoint,
repositoryEndpointPrefix,
systemData,
type
FROM azure.container_registry.archives
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND registry_name = '{{ registry_name }}' -- required
AND package_type = '{{ package_type }}' -- required
AND archive_name = '{{ archive_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all archives for the specified container registry and package type.

SELECT
id,
name,
packageSource,
provisioningState,
publishedVersion,
repositoryEndpoint,
repositoryEndpointPrefix,
systemData,
type
FROM azure.container_registry.archives
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND registry_name = '{{ registry_name }}' -- required
AND package_type = '{{ package_type }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

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

INSERT INTO azure.container_registry.archives (
properties,
resource_group_name,
registry_name,
package_type,
archive_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ registry_name }}',
'{{ package_type }}',
'{{ archive_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: archives
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the archives resource.
  - name: registry_name
    value: "{{ registry_name }}"
    description: Required parameter for the archives resource.
  - name: package_type
    value: "{{ package_type }}"
    description: Required parameter for the archives resource.
  - name: archive_name
    value: "{{ archive_name }}"
    description: Required parameter for the archives resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the archives resource.
  - name: properties
    description: |
      The properties of the archive.
    value:
      packageSource:
        type: "{{ type }}"
        url: "{{ url }}"
      publishedVersion: "{{ publishedVersion }}"
      repositoryEndpointPrefix: "{{ repositoryEndpointPrefix }}"
      repositoryEndpoint: "{{ repositoryEndpoint }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

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

UPDATE azure.container_registry.archives
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND registry_name = '{{ registry_name }}' --required
AND package_type = '{{ package_type }}' --required
AND archive_name = '{{ archive_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a archive from a container registry.

DELETE FROM azure.container_registry.archives
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND registry_name = '{{ registry_name }}' --required
AND package_type = '{{ package_type }}' --required
AND archive_name = '{{ archive_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;