azure.azcollection.azure_rm_federatedidentitycredential module – Manage a federated identity credential on a user-assigned managed identity
Note
This module is part of the azure.azcollection collection (version 4.2.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install azure.azcollection.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: azure.azcollection.azure_rm_federatedidentitycredential.
New in azure.azcollection 4.1.0
Synopsis
Create, update and delete a federated identity credential (Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials).
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection
Parameters
Parameter |
Comments |
|---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: |
|
The list of audiences that can appear in the issued token. Required when state=present. |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: |
|
Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. Set via credential file profile or the Choices:
|
|
The name of the parent user-assigned identity. |
|
The URL of the issuer to be trusted. Required when state=present. |
|
Parent argument. |
|
Parent argument. |
|
The name of the federated identity credential. |
|
Direct OpenID Connect (OIDC) token (JWT) used for workload identity authentication. This token is exchanged with Azure AD using OIDC federated identity. Useful in CI systems (for example GitHub Actions, Azure DevOps) where an OIDC token is provided directly by the platform. Can also be set via the |
|
Path to a file containing an OpenID Connect (OIDC) token (JWT) used for workload identity authentication. The file must contain only raw token. This method is commonly used in platforms that materialize OIDC tokens as files Can also be set via the |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
Name of resource group. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Assert the state of the federated identity credential. Use Choices:
|
|
The identifier of the external identity. Required when state=present. |
|
Your Azure subscription Id. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined. |
|
Path to the X509 certificate used to create the service principal in PEM format. The certificate must be appended to the private key. Use when authenticating with a Service Principal. |
Notes
Note
For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with
az login.Authentication is also possible using a service principal or Active Directory user.
To authenticate via OIDC, pass client_id, tenant and oidc_token or oidc_token_file_path, or set environment variables AZURE_CLIENT_ID, AZURE_TENANT and AZURE_FEDERATED_TOKEN or AZURE_FEDERATED_TOKEN_FILE.
To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.
See Also
See also
- Sign in with Azure CLI
How to authenticate using the
az logincommand.
Examples
- name: Create a federated identity credential
azure_rm_federatedidentitycredential:
resource_group: myResourceGroup
identity_name: myIdentity
name: myCredential
issuer: https://token.actions.githubusercontent.com
subject: "repo:myOrg/myRepo:environment:production"
audiences:
- api://AzureADTokenExchange
state: present
- name: Update a federated identity credential's subject
azure_rm_federatedidentitycredential:
resource_group: myResourceGroup
identity_name: myIdentity
name: myCredential
issuer: https://token.actions.githubusercontent.com
subject: "repo:myOrg/myRepo:environment:staging"
audiences:
- api://AzureADTokenExchange
state: present
- name: Delete a federated identity credential
azure_rm_federatedidentitycredential:
resource_group: myResourceGroup
identity_name: myIdentity
name: myCredential
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Current state of the federated identity credential. Returned: always |
|
The list of audiences that can appear in the issued token. Returned: always Sample: |
|
The federated identity credential resource ID. Returned: always Sample: |
|
The URL of the issuer to be trusted. Returned: always Sample: |
|
The federated identity credential name. Returned: always Sample: |
|
The identifier of the external identity. Returned: always Sample: |
|
Metadata pertaining to creation and last modification of the resource. Not always populated immediately after creation. Returned: success Sample: |
|
The type of the resource. Returned: always Sample: |