federated_identity_credentials

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

Overview

Name	federated_identity_credentials
Type	Resource
Id	azure.managed_identity.federated_identity_credentials

Fields

The following fields are returned by SELECT queries:

get

OK. The requested federated identity credential.

Name	Datatype	Description
properties	object	The properties associated with the federated identity credential. (title: Federated identity credential properties.)

list

OK. The list of federated identity credentials for the specified user assigned identity was retrieved and returned successfully.

Name	Datatype	Description
properties	object	The properties associated with the federated identity credential. (title: Federated identity credential properties.)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName, federatedIdentityCredentialResourceName		Gets the federated identity credential.
list	select	subscriptionId, resourceGroupName, resourceName	$top, $skiptoken	Lists all the federated identity credentials under the specified user assigned identity.
create_or_update	insert	subscriptionId, resourceGroupName, resourceName, federatedIdentityCredentialResourceName		Create or update a federated identity credential under the specified user assigned identity.
delete	delete	subscriptionId, resourceGroupName, resourceName, federatedIdentityCredentialResourceName		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
federatedIdentityCredentialResourceName	string	The name of the federated identity credential resource.
resourceGroupName	string	The name of the Resource Group to which the identity belongs.
resourceName	string	The name of the identity resource.
subscriptionId	string	The Id of the Subscription to which the identity belongs.
$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.
$top	integer (int32)	Number of records to return.

SELECT examples

get

Gets the federated identity credential.

SELECT
properties
FROM azure.managed_identity.federated_identity_credentials
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND federatedIdentityCredentialResourceName = '{{ federatedIdentityCredentialResourceName }}' -- required
;

list

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

SELECT
properties
FROM azure.managed_identity.federated_identity_credentials
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- 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.managed_identity.federated_identity_credentials (
data__properties,
subscriptionId,
resourceGroupName,
resourceName,
federatedIdentityCredentialResourceName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ federatedIdentityCredentialResourceName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: federated_identity_credentials
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the federated_identity_credentials resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the federated_identity_credentials resource.
    - name: resourceName
      value: string
      description: Required parameter for the federated_identity_credentials resource.
    - name: federatedIdentityCredentialResourceName
      value: string
      description: Required parameter for the federated_identity_credentials resource.
    - name: properties
      value: object
      description: |
        The properties associated with the federated identity credential.

DELETE examples

delete

Deletes the federated identity credential.

DELETE FROM azure.managed_identity.federated_identity_credentials
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND federatedIdentityCredentialResourceName = '{{ federatedIdentityCredentialResourceName }}' --required
;