archive_versions

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

Overview

Name	archive_versions
Type	Resource
Id	azure.container_registry.archive_versions

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.
archiveVersionErrorMessage	string	The detailed error message for the archive version in the case of failure.
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)
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.
archiveVersionErrorMessage	string	The detailed error message for the archive version in the case of failure.
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)
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, archive_version_name, subscription_id		Gets the properties of the archive version.
list	select	resource_group_name, registry_name, package_type, archive_name, subscription_id		Lists all archive versions for the specified container registry, repository type and archive name.
create	insert	resource_group_name, registry_name, package_type, archive_name, archive_version_name, subscription_id		Creates a archive version for a container registry with the specified parameters.
delete	delete	resource_group_name, registry_name, package_type, archive_name, archive_version_name, subscription_id		Deletes a archive version 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.
archive_version_name	string	The name of the archive version 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 version.

SELECT
id,
name,
archiveVersionErrorMessage,
provisioningState,
systemData,
type
FROM azure.container_registry.archive_versions
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 archive_version_name = '{{ archive_version_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all archive versions for the specified container registry, repository type and archive name.

SELECT
id,
name,
archiveVersionErrorMessage,
provisioningState,
systemData,
type
FROM azure.container_registry.archive_versions
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
;

INSERT examples

create

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

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

Manifest

# Description fields are for documentation purposes
- name: archive_versions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the archive_versions resource.
  - name: registry_name
    value: "{{ registry_name }}"
    description: Required parameter for the archive_versions resource.
  - name: package_type
    value: "{{ package_type }}"
    description: Required parameter for the archive_versions resource.
  - name: archive_name
    value: "{{ archive_name }}"
    description: Required parameter for the archive_versions resource.
  - name: archive_version_name
    value: "{{ archive_version_name }}"
    description: Required parameter for the archive_versions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the archive_versions resource.

DELETE examples

delete

Deletes a archive version from a container registry.

DELETE FROM azure.container_registry.archive_versions
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 archive_version_name = '{{ archive_version_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;