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

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
properties	object	The properties of the archive.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

list

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
properties	object	The properties of the archive.
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	subscriptionId, resourceGroupName, registryName, packageType, archiveName		Gets the properties of the archive.
list	select	subscriptionId, resourceGroupName, registryName, packageType		Lists all archives for the specified container registry and package type.
create	insert	subscriptionId, resourceGroupName, registryName, packageType, archiveName		Creates a archive for a container registry with the specified parameters.
update	update	subscriptionId, resourceGroupName, registryName, packageType, archiveName		Updates a archive for a container registry with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, registryName, packageType, archiveName		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
archiveName	string	The name of the archive resource.
packageType	string	The type of the package resource.
registryName	string	The name of the container registry.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets the properties of the archive.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.container_registry.archives
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND registryName = '{{ registryName }}' -- required
AND packageType = '{{ packageType }}' -- required
AND archiveName = '{{ archiveName }}' -- required
;

list

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

SELECT
id,
name,
properties,
systemData,
type
FROM azure.container_registry.archives
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND registryName = '{{ registryName }}' -- required
AND packageType = '{{ packageType }}' -- required
;

INSERT examples

create

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

INSERT INTO azure.container_registry.archives (
data__properties,
subscriptionId,
resourceGroupName,
registryName,
packageType,
archiveName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ registryName }}',
'{{ packageType }}',
'{{ archiveName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: archives
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the archives resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the archives resource.
    - name: registryName
      value: string
      description: Required parameter for the archives resource.
    - name: packageType
      value: string
      description: Required parameter for the archives resource.
    - name: archiveName
      value: string
      description: Required parameter for the archives resource.
    - name: properties
      value: object
      description: |
        The properties of the archive.

UPDATE examples

update

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

UPDATE azure.container_registry.archives
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND registryName = '{{ registryName }}' --required
AND packageType = '{{ packageType }}' --required
AND archiveName = '{{ archiveName }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a archive from a container registry.

DELETE FROM azure.container_registry.archives
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND registryName = '{{ registryName }}' --required
AND packageType = '{{ packageType }}' --required
AND archiveName = '{{ archiveName }}' --required
;