tokens

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

Overview

Name	tokens
Type	Resource
Id	azure.container_registry.tokens

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 token.
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 token.
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, tokenName		Gets the properties of the specified token.
list	select	subscriptionId, resourceGroupName, registryName		Lists all the tokens for the specified container registry.
create	insert	subscriptionId, resourceGroupName, registryName, tokenName		Creates a token for a container registry with the specified parameters.
update	update	subscriptionId, resourceGroupName, registryName, tokenName		Updates a token with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, registryName, tokenName		Deletes a token 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
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.
tokenName	string	The name of the token.

SELECT examples

get

Gets the properties of the specified token.

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

list

Lists all the tokens for the specified container registry.

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

INSERT examples

create

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

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

Manifest

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

UPDATE examples

update

Updates a token with the specified parameters.

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

DELETE examples

delete

Deletes a token from a container registry.

DELETE FROM azure.container_registry.tokens
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND registryName = '{{ registryName }}' --required
AND tokenName = '{{ tokenName }}' --required
;