federated_identity_credentials

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

Overview

Name	federated_identity_credentials
Type	Resource
Id	azure.msi.federated_identity_credentials

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 resource.
audiences	array	The list of audiences that can appear in the issued token. Required.
claimsMatchingExpression	object	Object for defining the allowed identifiers of external identities. Either 'subject' or 'claimsMatchingExpression' must be defined, but not both. Introduced in 2025-01-31-preview.
issuer	string	The URL of the issuer to be trusted. Required.
subject	string	The identifier of the external identity.
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 resource.
audiences	array	The list of audiences that can appear in the issued token. Required.
claimsMatchingExpression	object	Object for defining the allowed identifiers of external identities. Either 'subject' or 'claimsMatchingExpression' must be defined, but not both. Introduced in 2025-01-31-preview.
issuer	string	The URL of the issuer to be trusted. Required.
subject	string	The identifier of the external identity.
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, resource_name, federated_identity_credential_resource_name, subscription_id		Gets the federated identity credential.
list	select	resource_group_name, resource_name, subscription_id	$top, $skiptoken	Lists all the federated identity credentials under the specified user assigned identity.
create_or_update	insert	resource_group_name, resource_name, federated_identity_credential_resource_name, subscription_id		Create or update a federated identity credential under the specified user assigned identity.
create_or_update	replace	resource_group_name, resource_name, federated_identity_credential_resource_name, subscription_id		Create or update a federated identity credential under the specified user assigned identity.
delete	delete	resource_group_name, resource_name, federated_identity_credential_resource_name, subscription_id		Deletes the federated identity credential.

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
federated_identity_credential_resource_name	string	The name of the federated identity credential resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the identity resource. Required.
subscription_id	string
$skiptoken	string	A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. Default value is None.
$top	integer	Number of records to return. Default value is None.

SELECT examples

get

Gets the federated identity credential.

SELECT
id,
name,
audiences,
claimsMatchingExpression,
issuer,
subject,
systemData,
type
FROM azure.msi.federated_identity_credentials
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND federated_identity_credential_resource_name = '{{ federated_identity_credential_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all the federated identity credentials under the specified user assigned identity.

SELECT
id,
name,
audiences,
claimsMatchingExpression,
issuer,
subject,
systemData,
type
FROM azure.msi.federated_identity_credentials
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skiptoken = '{{ $skiptoken }}'
;

INSERT examples

create_or_update

Create or update a federated identity credential under the specified user assigned identity.

INSERT INTO azure.msi.federated_identity_credentials (
properties,
resource_group_name,
resource_name,
federated_identity_credential_resource_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ federated_identity_credential_resource_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: federated_identity_credentials
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the federated_identity_credentials resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the federated_identity_credentials resource.
  - name: federated_identity_credential_resource_name
    value: "{{ federated_identity_credential_resource_name }}"
    description: Required parameter for the federated_identity_credentials resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the federated_identity_credentials resource.
  - name: properties
    description: |
      The properties associated with the federated identity credential.
    value:
      issuer: "{{ issuer }}"
      subject: "{{ subject }}"
      audiences:
        - "{{ audiences }}"
      claimsMatchingExpression:
        value: "{{ value }}"
        languageVersion: {{ languageVersion }}

REPLACE examples

create_or_update

Create or update a federated identity credential under the specified user assigned identity.

REPLACE azure.msi.federated_identity_credentials
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND federated_identity_credential_resource_name = '{{ federated_identity_credential_resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the federated identity credential.

DELETE FROM azure.msi.federated_identity_credentials
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND federated_identity_credential_resource_name = '{{ federated_identity_credential_resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;