Docs Packages
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. managedidentity
  5. FederatedIdentityCredential
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.managedidentity.FederatedIdentityCredential

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Describes a federated identity credential. API Version: 2022-01-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/IssuerGUID",
        ResourceGroupName = "rgName",
        ResourceName = "resourceName",
        Subject = "system:serviceaccount:ns:svcaccount",
    });

});

    package main

import (
	managedidentity "github.com/pulumi/pulumi-azure-native-sdk/managedidentity"
	"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/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/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/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/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/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: []string{
		"string",
	},
	Issuer:                                  "string",
	ResourceGroupName:                       "string",
	ResourceName:                            "string",
	Subject:                                 "string",
	FederatedIdentityCredentialResourceName: "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 to which the identity belongs.
    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 to which the identity belongs.
    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 to which the identity belongs.
    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 to which the identity belongs.
    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 to which the identity belongs.
    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 to which the identity belongs.
    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
    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
    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
    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
    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
    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
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:managedidentity:FederatedIdentityCredential ficResourceName /subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native