azure-native.managedidentity.FederatedIdentityCredential
Explore with Pulumi AI
Describes a federated identity credential. Azure REST API version: 2023-01-31. Prior API version in Azure Native 1.x: 2022-01-31-preview.
Other available API versions: 2023-07-31-preview, 2024-11-30.
Example Usage
FederatedIdentityCredentialCreate
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var federatedIdentityCredential = new AzureNative.ManagedIdentity.FederatedIdentityCredential("federatedIdentityCredential", new()
    {
        Audiences = new[]
        {
            "api://AzureADTokenExchange",
        },
        FederatedIdentityCredentialResourceName = "ficResourceName",
        Issuer = "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID",
        ResourceGroupName = "rgName",
        ResourceName = "resourceName",
        Subject = "system:serviceaccount:ns:svcaccount",
    });
});
package main
import (
	managedidentity "github.com/pulumi/pulumi-azure-native-sdk/managedidentity/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := managedidentity.NewFederatedIdentityCredential(ctx, "federatedIdentityCredential", &managedidentity.FederatedIdentityCredentialArgs{
			Audiences: pulumi.StringArray{
				pulumi.String("api://AzureADTokenExchange"),
			},
			FederatedIdentityCredentialResourceName: pulumi.String("ficResourceName"),
			Issuer:                                  pulumi.String("https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID"),
			ResourceGroupName:                       pulumi.String("rgName"),
			ResourceName:                            pulumi.String("resourceName"),
			Subject:                                 pulumi.String("system:serviceaccount:ns:svcaccount"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.managedidentity.FederatedIdentityCredential;
import com.pulumi.azurenative.managedidentity.FederatedIdentityCredentialArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var federatedIdentityCredential = new FederatedIdentityCredential("federatedIdentityCredential", FederatedIdentityCredentialArgs.builder()
            .audiences("api://AzureADTokenExchange")
            .federatedIdentityCredentialResourceName("ficResourceName")
            .issuer("https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID")
            .resourceGroupName("rgName")
            .resourceName("resourceName")
            .subject("system:serviceaccount:ns:svcaccount")
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const federatedIdentityCredential = new azure_native.managedidentity.FederatedIdentityCredential("federatedIdentityCredential", {
    audiences: ["api://AzureADTokenExchange"],
    federatedIdentityCredentialResourceName: "ficResourceName",
    issuer: "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID",
    resourceGroupName: "rgName",
    resourceName: "resourceName",
    subject: "system:serviceaccount:ns:svcaccount",
});
import pulumi
import pulumi_azure_native as azure_native
federated_identity_credential = azure_native.managedidentity.FederatedIdentityCredential("federatedIdentityCredential",
    audiences=["api://AzureADTokenExchange"],
    federated_identity_credential_resource_name="ficResourceName",
    issuer="https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID",
    resource_group_name="rgName",
    resource_name_="resourceName",
    subject="system:serviceaccount:ns:svcaccount")
resources:
  federatedIdentityCredential:
    type: azure-native:managedidentity:FederatedIdentityCredential
    properties:
      audiences:
        - api://AzureADTokenExchange
      federatedIdentityCredentialResourceName: ficResourceName
      issuer: https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID
      resourceGroupName: rgName
      resourceName: resourceName
      subject: system:serviceaccount:ns:svcaccount
Create FederatedIdentityCredential Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FederatedIdentityCredential(name: string, args: FederatedIdentityCredentialArgs, opts?: CustomResourceOptions);@overload
def FederatedIdentityCredential(resource_name: str,
                                args: FederatedIdentityCredentialArgs,
                                opts: Optional[ResourceOptions] = None)
@overload
def FederatedIdentityCredential(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                audiences: Optional[Sequence[str]] = None,
                                issuer: Optional[str] = None,
                                resource_group_name: Optional[str] = None,
                                resource_name_: Optional[str] = None,
                                subject: Optional[str] = None,
                                federated_identity_credential_resource_name: Optional[str] = None)func NewFederatedIdentityCredential(ctx *Context, name string, args FederatedIdentityCredentialArgs, opts ...ResourceOption) (*FederatedIdentityCredential, error)public FederatedIdentityCredential(string name, FederatedIdentityCredentialArgs args, CustomResourceOptions? opts = null)
public FederatedIdentityCredential(String name, FederatedIdentityCredentialArgs args)
public FederatedIdentityCredential(String name, FederatedIdentityCredentialArgs args, CustomResourceOptions options)
type: azure-native:managedidentity:FederatedIdentityCredential
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args FederatedIdentityCredentialArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FederatedIdentityCredentialArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FederatedIdentityCredentialArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FederatedIdentityCredentialArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FederatedIdentityCredentialArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var federatedIdentityCredentialResource = new AzureNative.ManagedIdentity.FederatedIdentityCredential("federatedIdentityCredentialResource", new()
{
    Audiences = new[]
    {
        "string",
    },
    Issuer = "string",
    ResourceGroupName = "string",
    ResourceName = "string",
    Subject = "string",
    FederatedIdentityCredentialResourceName = "string",
});
example, err := managedidentity.NewFederatedIdentityCredential(ctx, "federatedIdentityCredentialResource", &managedidentity.FederatedIdentityCredentialArgs{
	Audiences: pulumi.StringArray{
		pulumi.String("string"),
	},
	Issuer:                                  pulumi.String("string"),
	ResourceGroupName:                       pulumi.String("string"),
	ResourceName:                            pulumi.String("string"),
	Subject:                                 pulumi.String("string"),
	FederatedIdentityCredentialResourceName: pulumi.String("string"),
})
var federatedIdentityCredentialResource = new FederatedIdentityCredential("federatedIdentityCredentialResource", FederatedIdentityCredentialArgs.builder()
    .audiences("string")
    .issuer("string")
    .resourceGroupName("string")
    .resourceName("string")
    .subject("string")
    .federatedIdentityCredentialResourceName("string")
    .build());
federated_identity_credential_resource = azure_native.managedidentity.FederatedIdentityCredential("federatedIdentityCredentialResource",
    audiences=["string"],
    issuer="string",
    resource_group_name="string",
    resource_name_="string",
    subject="string",
    federated_identity_credential_resource_name="string")
const federatedIdentityCredentialResource = new azure_native.managedidentity.FederatedIdentityCredential("federatedIdentityCredentialResource", {
    audiences: ["string"],
    issuer: "string",
    resourceGroupName: "string",
    resourceName: "string",
    subject: "string",
    federatedIdentityCredentialResourceName: "string",
});
type: azure-native:managedidentity:FederatedIdentityCredential
properties:
    audiences:
        - string
    federatedIdentityCredentialResourceName: string
    issuer: string
    resourceGroupName: string
    resourceName: string
    subject: string
FederatedIdentityCredential Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The FederatedIdentityCredential resource accepts the following input properties:
- Audiences List<string>
- The list of audiences that can appear in the issued token.
- Issuer string
- The URL of the issuer to be trusted.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- ResourceName string
- The name of the identity resource.
- Subject string
- The identifier of the external identity.
- FederatedIdentity stringCredential Resource Name 
- The name of the federated identity credential resource.
- Audiences []string
- The list of audiences that can appear in the issued token.
- Issuer string
- The URL of the issuer to be trusted.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- ResourceName string
- The name of the identity resource.
- Subject string
- The identifier of the external identity.
- FederatedIdentity stringCredential Resource Name 
- The name of the federated identity credential resource.
- audiences List<String>
- The list of audiences that can appear in the issued token.
- issuer String
- The URL of the issuer to be trusted.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- resourceName String
- The name of the identity resource.
- subject String
- The identifier of the external identity.
- federatedIdentity StringCredential Resource Name 
- The name of the federated identity credential resource.
- audiences string[]
- The list of audiences that can appear in the issued token.
- issuer string
- The URL of the issuer to be trusted.
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- resourceName string
- The name of the identity resource.
- subject string
- The identifier of the external identity.
- federatedIdentity stringCredential Resource Name 
- The name of the federated identity credential resource.
- audiences Sequence[str]
- The list of audiences that can appear in the issued token.
- issuer str
- The URL of the issuer to be trusted.
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- resource_name str
- The name of the identity resource.
- subject str
- The identifier of the external identity.
- federated_identity_ strcredential_ resource_ name 
- The name of the federated identity credential resource.
- audiences List<String>
- The list of audiences that can appear in the issued token.
- issuer String
- The URL of the issuer to be trusted.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- resourceName String
- The name of the identity resource.
- subject String
- The identifier of the external identity.
- federatedIdentity StringCredential Resource Name 
- The name of the federated identity credential resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the FederatedIdentityCredential resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- SystemData Pulumi.Azure Native. Managed Identity. Outputs. System Data Response 
- 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"
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- SystemData SystemData Response 
- 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"
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- systemData SystemData Response 
- 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"
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- systemData SystemData Response 
- 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"
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- system_data SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- systemData Property Map
- 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"
Supporting Types
SystemDataResponse, SystemDataResponseArgs      
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
- createdAt string
- The timestamp of resource creation (UTC).
- createdBy string
- The identity that created the resource.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- The type of identity that last modified the resource.
- created_at str
- The timestamp of resource creation (UTC).
- created_by str
- The identity that created the resource.
- created_by_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- The type of identity that last modified the resource.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:managedidentity:FederatedIdentityCredential ficResourceName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}/federatedIdentityCredentials/{federatedIdentityCredentialResourceName} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0