Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. managedidentity
  5. FederatedIdentityCredential
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.managedidentity.FederatedIdentityCredential

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-azure-native

    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.

    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 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")

    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",
});

    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

    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.
    ResourceGroupName string
    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.
    FederatedIdentityCredentialResourceName string
    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.
    ResourceGroupName string
    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.
    FederatedIdentityCredentialResourceName string
    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.
    resourceGroupName String
    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.
    federatedIdentityCredentialResourceName String
    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.
    resourceGroupName string
    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.
    federatedIdentityCredentialResourceName string
    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_name str
    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_credential_resource_name str
    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.
    resourceGroupName String
    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.
    federatedIdentityCredentialResourceName String
    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.AzureNative.ManagedIdentity.Outputs.SystemDataResponse
    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 SystemDataResponse
    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 SystemDataResponse
    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 SystemDataResponse
    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 SystemDataResponse
    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.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    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.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    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.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    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.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    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_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    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.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
    pulumi/pulumi-azure-native