credential_sets

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

Overview

Name	credential_sets
Type	Resource
Id	azure.container_registry.credential_sets

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.
identity	object	Identities associated with the resource. This is used to access the KeyVault secrets.
properties	object	The properties of the credential set.
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.
identity	object	Identities associated with the resource. This is used to access the KeyVault secrets.
properties	object	The properties of the credential set.
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, credentialSetName		Gets the properties of the specified credential set resource.
list	select	subscriptionId, resourceGroupName, registryName		Lists all credential set resources for the specified container registry.
create	insert	subscriptionId, resourceGroupName, registryName, credentialSetName		Creates a credential set for a container registry with the specified parameters.
update	update	subscriptionId, resourceGroupName, registryName, credentialSetName		Updates a credential set for a container registry with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, registryName, credentialSetName		Deletes a credential set 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
credentialSetName	string	The name of the credential set.
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 specified credential set resource.

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

list

Lists all credential set resources for the specified container registry.

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

INSERT examples

create

Creates a credential set for a container registry with the specified parameters.

INSERT INTO azure.container_registry.credential_sets (
data__identity,
data__properties,
subscriptionId,
resourceGroupName,
registryName,
credentialSetName
)
SELECT 
'{{ identity }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ registryName }}',
'{{ credentialSetName }}'
RETURNING
id,
name,
identity,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: credential_sets
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the credential_sets resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the credential_sets resource.
    - name: registryName
      value: string
      description: Required parameter for the credential_sets resource.
    - name: credentialSetName
      value: string
      description: Required parameter for the credential_sets resource.
    - name: identity
      value: object
      description: |
        Identities associated with the resource. This is used to access the KeyVault secrets.
    - name: properties
      value: object
      description: |
        The properties of the credential set.

UPDATE examples

update

Updates a credential set for a container registry with the specified parameters.

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

DELETE examples

delete

Deletes a credential set from a container registry.

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