1. Packages
  2. Azure Classic
  3. API Docs
  4. armmsi
  5. FederatedIdentityCredential

We recommend using Azure Native.

Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi

azure.armmsi.FederatedIdentityCredential

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi

    Manages a Federated Identity Credential.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example",
        location: "West Europe",
    });
    const exampleUserAssignedIdentity = new azure.authorization.UserAssignedIdentity("example", {
        location: example.location,
        name: "example",
        resourceGroupName: example.name,
    });
    const exampleFederatedIdentityCredential = new azure.armmsi.FederatedIdentityCredential("example", {
        name: "example",
        resourceGroupName: example.name,
        audience: "foo",
        issuer: "https://foo",
        parentId: exampleUserAssignedIdentity.id,
        subject: "foo",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example",
        location="West Europe")
    example_user_assigned_identity = azure.authorization.UserAssignedIdentity("example",
        location=example.location,
        name="example",
        resource_group_name=example.name)
    example_federated_identity_credential = azure.armmsi.FederatedIdentityCredential("example",
        name="example",
        resource_group_name=example.name,
        audience="foo",
        issuer="https://foo",
        parent_id=example_user_assigned_identity.id,
        subject="foo")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/armmsi"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/authorization"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleUserAssignedIdentity, err := authorization.NewUserAssignedIdentity(ctx, "example", &authorization.UserAssignedIdentityArgs{
    			Location:          example.Location,
    			Name:              pulumi.String("example"),
    			ResourceGroupName: example.Name,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = armmsi.NewFederatedIdentityCredential(ctx, "example", &armmsi.FederatedIdentityCredentialArgs{
    			Name:              pulumi.String("example"),
    			ResourceGroupName: example.Name,
    			Audience:          pulumi.String("foo"),
    			Issuer:            pulumi.String("https://foo"),
    			ParentId:          exampleUserAssignedIdentity.ID(),
    			Subject:           pulumi.String("foo"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example",
            Location = "West Europe",
        });
    
        var exampleUserAssignedIdentity = new Azure.Authorization.UserAssignedIdentity("example", new()
        {
            Location = example.Location,
            Name = "example",
            ResourceGroupName = example.Name,
        });
    
        var exampleFederatedIdentityCredential = new Azure.ArmMsi.FederatedIdentityCredential("example", new()
        {
            Name = "example",
            ResourceGroupName = example.Name,
            Audience = "foo",
            Issuer = "https://foo",
            ParentId = exampleUserAssignedIdentity.Id,
            Subject = "foo",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.authorization.UserAssignedIdentity;
    import com.pulumi.azure.authorization.UserAssignedIdentityArgs;
    import com.pulumi.azure.armmsi.FederatedIdentityCredential;
    import com.pulumi.azure.armmsi.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 example = new ResourceGroup("example", ResourceGroupArgs.builder()        
                .name("example")
                .location("West Europe")
                .build());
    
            var exampleUserAssignedIdentity = new UserAssignedIdentity("exampleUserAssignedIdentity", UserAssignedIdentityArgs.builder()        
                .location(example.location())
                .name("example")
                .resourceGroupName(example.name())
                .build());
    
            var exampleFederatedIdentityCredential = new FederatedIdentityCredential("exampleFederatedIdentityCredential", FederatedIdentityCredentialArgs.builder()        
                .name("example")
                .resourceGroupName(example.name())
                .audience("foo")
                .issuer("https://foo")
                .parentId(exampleUserAssignedIdentity.id())
                .subject("foo")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example
          location: West Europe
      exampleUserAssignedIdentity:
        type: azure:authorization:UserAssignedIdentity
        name: example
        properties:
          location: ${example.location}
          name: example
          resourceGroupName: ${example.name}
      exampleFederatedIdentityCredential:
        type: azure:armmsi:FederatedIdentityCredential
        name: example
        properties:
          name: example
          resourceGroupName: ${example.name}
          audience: foo
          issuer: https://foo
          parentId: ${exampleUserAssignedIdentity.id}
          subject: foo
    

    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,
                                    audience: Optional[str] = None,
                                    issuer: Optional[str] = None,
                                    parent_id: Optional[str] = None,
                                    resource_group_name: Optional[str] = None,
                                    subject: Optional[str] = None,
                                    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:armmsi: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.

    Example

    The following reference example uses placeholder values for all input properties.

    var federatedIdentityCredentialResource = new Azure.ArmMsi.FederatedIdentityCredential("federatedIdentityCredentialResource", new()
    {
        Audience = "string",
        Issuer = "string",
        ParentId = "string",
        ResourceGroupName = "string",
        Subject = "string",
        Name = "string",
    });
    
    example, err := armmsi.NewFederatedIdentityCredential(ctx, "federatedIdentityCredentialResource", &armmsi.FederatedIdentityCredentialArgs{
    	Audience:          pulumi.String("string"),
    	Issuer:            pulumi.String("string"),
    	ParentId:          pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	Subject:           pulumi.String("string"),
    	Name:              pulumi.String("string"),
    })
    
    var federatedIdentityCredentialResource = new FederatedIdentityCredential("federatedIdentityCredentialResource", FederatedIdentityCredentialArgs.builder()        
        .audience("string")
        .issuer("string")
        .parentId("string")
        .resourceGroupName("string")
        .subject("string")
        .name("string")
        .build());
    
    federated_identity_credential_resource = azure.armmsi.FederatedIdentityCredential("federatedIdentityCredentialResource",
        audience="string",
        issuer="string",
        parent_id="string",
        resource_group_name="string",
        subject="string",
        name="string")
    
    const federatedIdentityCredentialResource = new azure.armmsi.FederatedIdentityCredential("federatedIdentityCredentialResource", {
        audience: "string",
        issuer: "string",
        parentId: "string",
        resourceGroupName: "string",
        subject: "string",
        name: "string",
    });
    
    type: azure:armmsi:FederatedIdentityCredential
    properties:
        audience: string
        issuer: string
        name: string
        parentId: string
        resourceGroupName: 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:

    Audience string
    Specifies the audience for this Federated Identity Credential.
    Issuer string
    Specifies the issuer of this Federated Identity Credential.
    ParentId string
    Specifies parent ID of User Assigned Identity for this Federated Identity Credential. Changing this forces a new Federated Identity Credential to be created.
    ResourceGroupName string
    Specifies the name of the Resource Group within which this Federated Identity Credential should exist. Changing this forces a new Federated Identity Credential to be created.
    Subject string
    Specifies the subject for this Federated Identity Credential.
    Name string
    Specifies the name of this Federated Identity Credential. Changing this forces a new resource to be created.
    Audience string
    Specifies the audience for this Federated Identity Credential.
    Issuer string
    Specifies the issuer of this Federated Identity Credential.
    ParentId string
    Specifies parent ID of User Assigned Identity for this Federated Identity Credential. Changing this forces a new Federated Identity Credential to be created.
    ResourceGroupName string
    Specifies the name of the Resource Group within which this Federated Identity Credential should exist. Changing this forces a new Federated Identity Credential to be created.
    Subject string
    Specifies the subject for this Federated Identity Credential.
    Name string
    Specifies the name of this Federated Identity Credential. Changing this forces a new resource to be created.
    audience String
    Specifies the audience for this Federated Identity Credential.
    issuer String
    Specifies the issuer of this Federated Identity Credential.
    parentId String
    Specifies parent ID of User Assigned Identity for this Federated Identity Credential. Changing this forces a new Federated Identity Credential to be created.
    resourceGroupName String
    Specifies the name of the Resource Group within which this Federated Identity Credential should exist. Changing this forces a new Federated Identity Credential to be created.
    subject String
    Specifies the subject for this Federated Identity Credential.
    name String
    Specifies the name of this Federated Identity Credential. Changing this forces a new resource to be created.
    audience string
    Specifies the audience for this Federated Identity Credential.
    issuer string
    Specifies the issuer of this Federated Identity Credential.
    parentId string
    Specifies parent ID of User Assigned Identity for this Federated Identity Credential. Changing this forces a new Federated Identity Credential to be created.
    resourceGroupName string
    Specifies the name of the Resource Group within which this Federated Identity Credential should exist. Changing this forces a new Federated Identity Credential to be created.
    subject string
    Specifies the subject for this Federated Identity Credential.
    name string
    Specifies the name of this Federated Identity Credential. Changing this forces a new resource to be created.
    audience str
    Specifies the audience for this Federated Identity Credential.
    issuer str
    Specifies the issuer of this Federated Identity Credential.
    parent_id str
    Specifies parent ID of User Assigned Identity for this Federated Identity Credential. Changing this forces a new Federated Identity Credential to be created.
    resource_group_name str
    Specifies the name of the Resource Group within which this Federated Identity Credential should exist. Changing this forces a new Federated Identity Credential to be created.
    subject str
    Specifies the subject for this Federated Identity Credential.
    name str
    Specifies the name of this Federated Identity Credential. Changing this forces a new resource to be created.
    audience String
    Specifies the audience for this Federated Identity Credential.
    issuer String
    Specifies the issuer of this Federated Identity Credential.
    parentId String
    Specifies parent ID of User Assigned Identity for this Federated Identity Credential. Changing this forces a new Federated Identity Credential to be created.
    resourceGroupName String
    Specifies the name of the Resource Group within which this Federated Identity Credential should exist. Changing this forces a new Federated Identity Credential to be created.
    subject String
    Specifies the subject for this Federated Identity Credential.
    name String
    Specifies the name of this Federated Identity Credential. Changing this forces a new resource to be created.

    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing FederatedIdentityCredential Resource

    Get an existing FederatedIdentityCredential resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: FederatedIdentityCredentialState, opts?: CustomResourceOptions): FederatedIdentityCredential
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            audience: Optional[str] = None,
            issuer: Optional[str] = None,
            name: Optional[str] = None,
            parent_id: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            subject: Optional[str] = None) -> FederatedIdentityCredential
    func GetFederatedIdentityCredential(ctx *Context, name string, id IDInput, state *FederatedIdentityCredentialState, opts ...ResourceOption) (*FederatedIdentityCredential, error)
    public static FederatedIdentityCredential Get(string name, Input<string> id, FederatedIdentityCredentialState? state, CustomResourceOptions? opts = null)
    public static FederatedIdentityCredential get(String name, Output<String> id, FederatedIdentityCredentialState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Audience string
    Specifies the audience for this Federated Identity Credential.
    Issuer string
    Specifies the issuer of this Federated Identity Credential.
    Name string
    Specifies the name of this Federated Identity Credential. Changing this forces a new resource to be created.
    ParentId string
    Specifies parent ID of User Assigned Identity for this Federated Identity Credential. Changing this forces a new Federated Identity Credential to be created.
    ResourceGroupName string
    Specifies the name of the Resource Group within which this Federated Identity Credential should exist. Changing this forces a new Federated Identity Credential to be created.
    Subject string
    Specifies the subject for this Federated Identity Credential.
    Audience string
    Specifies the audience for this Federated Identity Credential.
    Issuer string
    Specifies the issuer of this Federated Identity Credential.
    Name string
    Specifies the name of this Federated Identity Credential. Changing this forces a new resource to be created.
    ParentId string
    Specifies parent ID of User Assigned Identity for this Federated Identity Credential. Changing this forces a new Federated Identity Credential to be created.
    ResourceGroupName string
    Specifies the name of the Resource Group within which this Federated Identity Credential should exist. Changing this forces a new Federated Identity Credential to be created.
    Subject string
    Specifies the subject for this Federated Identity Credential.
    audience String
    Specifies the audience for this Federated Identity Credential.
    issuer String
    Specifies the issuer of this Federated Identity Credential.
    name String
    Specifies the name of this Federated Identity Credential. Changing this forces a new resource to be created.
    parentId String
    Specifies parent ID of User Assigned Identity for this Federated Identity Credential. Changing this forces a new Federated Identity Credential to be created.
    resourceGroupName String
    Specifies the name of the Resource Group within which this Federated Identity Credential should exist. Changing this forces a new Federated Identity Credential to be created.
    subject String
    Specifies the subject for this Federated Identity Credential.
    audience string
    Specifies the audience for this Federated Identity Credential.
    issuer string
    Specifies the issuer of this Federated Identity Credential.
    name string
    Specifies the name of this Federated Identity Credential. Changing this forces a new resource to be created.
    parentId string
    Specifies parent ID of User Assigned Identity for this Federated Identity Credential. Changing this forces a new Federated Identity Credential to be created.
    resourceGroupName string
    Specifies the name of the Resource Group within which this Federated Identity Credential should exist. Changing this forces a new Federated Identity Credential to be created.
    subject string
    Specifies the subject for this Federated Identity Credential.
    audience str
    Specifies the audience for this Federated Identity Credential.
    issuer str
    Specifies the issuer of this Federated Identity Credential.
    name str
    Specifies the name of this Federated Identity Credential. Changing this forces a new resource to be created.
    parent_id str
    Specifies parent ID of User Assigned Identity for this Federated Identity Credential. Changing this forces a new Federated Identity Credential to be created.
    resource_group_name str
    Specifies the name of the Resource Group within which this Federated Identity Credential should exist. Changing this forces a new Federated Identity Credential to be created.
    subject str
    Specifies the subject for this Federated Identity Credential.
    audience String
    Specifies the audience for this Federated Identity Credential.
    issuer String
    Specifies the issuer of this Federated Identity Credential.
    name String
    Specifies the name of this Federated Identity Credential. Changing this forces a new resource to be created.
    parentId String
    Specifies parent ID of User Assigned Identity for this Federated Identity Credential. Changing this forces a new Federated Identity Credential to be created.
    resourceGroupName String
    Specifies the name of the Resource Group within which this Federated Identity Credential should exist. Changing this forces a new Federated Identity Credential to be created.
    subject String
    Specifies the subject for this Federated Identity Credential.

    Import

    An existing Federated Identity Credential can be imported into Terraform using the resource id, e.g.

    $ pulumi import azure:armmsi/federatedIdentityCredential:FederatedIdentityCredential example /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{parentIdentityName}/federatedIdentityCredentials/{resourceName}
    

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi