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

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.
authCredentials	array	List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential.
creationDate	string (date-time)	The creation date of credential store resource.
identity	object	Identities associated with the resource. This is used to access the KeyVault secrets.
loginServer	string	The credentials are stored for this upstream or login server.
provisioningState	string	Provisioning state of the resource. 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.
authCredentials	array	List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential.
creationDate	string (date-time)	The creation date of credential store resource.
identity	object	Identities associated with the resource. This is used to access the KeyVault secrets.
loginServer	string	The credentials are stored for this upstream or login server.
provisioningState	string	Provisioning state of the resource. 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, credential_set_name, subscription_id		Gets the properties of the specified credential set resource.
list	select	resource_group_name, registry_name, subscription_id		Lists all credential set resources for the specified container registry.
create	insert	resource_group_name, registry_name, credential_set_name, subscription_id		Creates a credential set for a container registry with the specified parameters.
update	update	resource_group_name, registry_name, credential_set_name, subscription_id		Updates a credential set for a container registry with the specified parameters.
delete	delete	resource_group_name, registry_name, credential_set_name, subscription_id		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
credential_set_name	string	The name of the credential set. 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 specified credential set resource.

SELECT
id,
name,
authCredentials,
creationDate,
identity,
loginServer,
provisioningState,
systemData,
type
FROM azure.container_registry.credential_sets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND registry_name = '{{ registry_name }}' -- required
AND credential_set_name = '{{ credential_set_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all credential set resources for the specified container registry.

SELECT
id,
name,
authCredentials,
creationDate,
identity,
loginServer,
provisioningState,
systemData,
type
FROM azure.container_registry.credential_sets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND registry_name = '{{ registry_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

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

INSERT INTO azure.container_registry.credential_sets (
properties,
identity,
resource_group_name,
registry_name,
credential_set_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ registry_name }}',
'{{ credential_set_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: credential_sets
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the credential_sets resource.
  - name: registry_name
    value: "{{ registry_name }}"
    description: Required parameter for the credential_sets resource.
  - name: credential_set_name
    value: "{{ credential_set_name }}"
    description: Required parameter for the credential_sets resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the credential_sets resource.
  - name: properties
    description: |
      The properties of the credential set.
    value:
      loginServer: "{{ loginServer }}"
      authCredentials:
        - name: "{{ name }}"
          usernameSecretIdentifier: "{{ usernameSecretIdentifier }}"
          passwordSecretIdentifier: "{{ passwordSecretIdentifier }}"
          credentialHealth:
            status: "{{ status }}"
            errorCode: "{{ errorCode }}"
            errorMessage: "{{ errorMessage }}"
      creationDate: "{{ creationDate }}"
      provisioningState: "{{ provisioningState }}"
  - name: identity
    description: |
      Identities associated with the resource. This is used to access the KeyVault secrets.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

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

UPDATE azure.container_registry.credential_sets
SET 
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND registry_name = '{{ registry_name }}' --required
AND credential_set_name = '{{ credential_set_name }}' --required
AND subscription_id = '{{ subscription_id }}' --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 resource_group_name = '{{ resource_group_name }}' --required
AND registry_name = '{{ registry_name }}' --required
AND credential_set_name = '{{ credential_set_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;