Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. authorization
  5. UserAssignedIdentity

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.authorization.UserAssignedIdentity

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a User Assigned Identity.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleUserAssignedIdentity = new azure.authorization.UserAssignedIdentity("example", {
    location: example.location,
    name: "example",
    resourceGroupName: example.name,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_user_assigned_identity = azure.authorization.UserAssignedIdentity("example",
    location=example.location,
    name="example",
    resource_group_name=example.name)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/authorization"
	"github.com/pulumi/pulumi-azure/sdk/v6/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-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = authorization.NewUserAssignedIdentity(ctx, "example", &authorization.UserAssignedIdentityArgs{
			Location:          example.Location,
			Name:              pulumi.String("example"),
			ResourceGroupName: example.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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-resources",
        Location = "West Europe",
    });

    var exampleUserAssignedIdentity = new Azure.Authorization.UserAssignedIdentity("example", new()
    {
        Location = example.Location,
        Name = "example",
        ResourceGroupName = example.Name,
    });

});
Copy
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 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-resources")
            .location("West Europe")
            .build());

        var exampleUserAssignedIdentity = new UserAssignedIdentity("exampleUserAssignedIdentity", UserAssignedIdentityArgs.builder()
            .location(example.location())
            .name("example")
            .resourceGroupName(example.name())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleUserAssignedIdentity:
    type: azure:authorization:UserAssignedIdentity
    name: example
    properties:
      location: ${example.location}
      name: example
      resourceGroupName: ${example.name}
Copy

Create UserAssignedIdentity Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new UserAssignedIdentity(name: string, args: UserAssignedIdentityArgs, opts?: CustomResourceOptions);
@overload
def UserAssignedIdentity(resource_name: str,
                         args: UserAssignedIdentityArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def UserAssignedIdentity(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         resource_group_name: Optional[str] = None,
                         location: Optional[str] = None,
                         name: Optional[str] = None,
                         tags: Optional[Mapping[str, str]] = None)
func NewUserAssignedIdentity(ctx *Context, name string, args UserAssignedIdentityArgs, opts ...ResourceOption) (*UserAssignedIdentity, error)
public UserAssignedIdentity(string name, UserAssignedIdentityArgs args, CustomResourceOptions? opts = null)
public UserAssignedIdentity(String name, UserAssignedIdentityArgs args)
public UserAssignedIdentity(String name, UserAssignedIdentityArgs args, CustomResourceOptions options)

type: azure:authorization:UserAssignedIdentity
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. UserAssignedIdentityArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. UserAssignedIdentityArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. UserAssignedIdentityArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. UserAssignedIdentityArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. UserAssignedIdentityArgs
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 userAssignedIdentityResource = new Azure.Authorization.UserAssignedIdentity("userAssignedIdentityResource", new()
{
    ResourceGroupName = "string",
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := authorization.NewUserAssignedIdentity(ctx, "userAssignedIdentityResource", &authorization.UserAssignedIdentityArgs{
	ResourceGroupName: pulumi.String("string"),
	Location:          pulumi.String("string"),
	Name:              pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var userAssignedIdentityResource = new UserAssignedIdentity("userAssignedIdentityResource", UserAssignedIdentityArgs.builder()
    .resourceGroupName("string")
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
user_assigned_identity_resource = azure.authorization.UserAssignedIdentity("userAssignedIdentityResource",
    resource_group_name="string",
    location="string",
    name="string",
    tags={
        "string": "string",
    })
Copy
const userAssignedIdentityResource = new azure.authorization.UserAssignedIdentity("userAssignedIdentityResource", {
    resourceGroupName: "string",
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure:authorization:UserAssignedIdentity
properties:
    location: string
    name: string
    resourceGroupName: string
    tags:
        string: string
Copy

UserAssignedIdentity 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 UserAssignedIdentity resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the Resource Group within which this User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
Location Changes to this property will trigger replacement. string
The Azure Region where the User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of this User Assigned Identity. Changing this forces a new User Assigned Identity to be created.
Tags Dictionary<string, string>
A mapping of tags which should be assigned to the User Assigned Identity.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the Resource Group within which this User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
Location Changes to this property will trigger replacement. string
The Azure Region where the User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of this User Assigned Identity. Changing this forces a new User Assigned Identity to be created.
Tags map[string]string
A mapping of tags which should be assigned to the User Assigned Identity.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the Resource Group within which this User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
location Changes to this property will trigger replacement. String
The Azure Region where the User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
name Changes to this property will trigger replacement. String
Specifies the name of this User Assigned Identity. Changing this forces a new User Assigned Identity to be created.
tags Map<String,String>
A mapping of tags which should be assigned to the User Assigned Identity.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the Resource Group within which this User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
location Changes to this property will trigger replacement. string
The Azure Region where the User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
name Changes to this property will trigger replacement. string
Specifies the name of this User Assigned Identity. Changing this forces a new User Assigned Identity to be created.
tags {[key: string]: string}
A mapping of tags which should be assigned to the User Assigned Identity.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Specifies the name of the Resource Group within which this User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
location Changes to this property will trigger replacement. str
The Azure Region where the User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
name Changes to this property will trigger replacement. str
Specifies the name of this User Assigned Identity. Changing this forces a new User Assigned Identity to be created.
tags Mapping[str, str]
A mapping of tags which should be assigned to the User Assigned Identity.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the Resource Group within which this User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
location Changes to this property will trigger replacement. String
The Azure Region where the User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
name Changes to this property will trigger replacement. String
Specifies the name of this User Assigned Identity. Changing this forces a new User Assigned Identity to be created.
tags Map<String>
A mapping of tags which should be assigned to the User Assigned Identity.

Outputs

All input properties are implicitly available as output properties. Additionally, the UserAssignedIdentity resource produces the following output properties:

ClientId string
The ID of the app associated with the Identity.
Id string
The provider-assigned unique ID for this managed resource.
PrincipalId string
The ID of the Service Principal object associated with the created Identity.
TenantId string
The ID of the Tenant which the Identity belongs to.
ClientId string
The ID of the app associated with the Identity.
Id string
The provider-assigned unique ID for this managed resource.
PrincipalId string
The ID of the Service Principal object associated with the created Identity.
TenantId string
The ID of the Tenant which the Identity belongs to.
clientId String
The ID of the app associated with the Identity.
id String
The provider-assigned unique ID for this managed resource.
principalId String
The ID of the Service Principal object associated with the created Identity.
tenantId String
The ID of the Tenant which the Identity belongs to.
clientId string
The ID of the app associated with the Identity.
id string
The provider-assigned unique ID for this managed resource.
principalId string
The ID of the Service Principal object associated with the created Identity.
tenantId string
The ID of the Tenant which the Identity belongs to.
client_id str
The ID of the app associated with the Identity.
id str
The provider-assigned unique ID for this managed resource.
principal_id str
The ID of the Service Principal object associated with the created Identity.
tenant_id str
The ID of the Tenant which the Identity belongs to.
clientId String
The ID of the app associated with the Identity.
id String
The provider-assigned unique ID for this managed resource.
principalId String
The ID of the Service Principal object associated with the created Identity.
tenantId String
The ID of the Tenant which the Identity belongs to.

Look up Existing UserAssignedIdentity Resource

Get an existing UserAssignedIdentity 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?: UserAssignedIdentityState, opts?: CustomResourceOptions): UserAssignedIdentity
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        principal_id: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tenant_id: Optional[str] = None) -> UserAssignedIdentity
func GetUserAssignedIdentity(ctx *Context, name string, id IDInput, state *UserAssignedIdentityState, opts ...ResourceOption) (*UserAssignedIdentity, error)
public static UserAssignedIdentity Get(string name, Input<string> id, UserAssignedIdentityState? state, CustomResourceOptions? opts = null)
public static UserAssignedIdentity get(String name, Output<String> id, UserAssignedIdentityState state, CustomResourceOptions options)
resources:  _:    type: azure:authorization:UserAssignedIdentity    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ClientId string
The ID of the app associated with the Identity.
Location Changes to this property will trigger replacement. string
The Azure Region where the User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of this User Assigned Identity. Changing this forces a new User Assigned Identity to be created.
PrincipalId string
The ID of the Service Principal object associated with the created Identity.
ResourceGroupName Changes to this property will trigger replacement. string
Specifies the name of the Resource Group within which this User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
Tags Dictionary<string, string>
A mapping of tags which should be assigned to the User Assigned Identity.
TenantId string
The ID of the Tenant which the Identity belongs to.
ClientId string
The ID of the app associated with the Identity.
Location Changes to this property will trigger replacement. string
The Azure Region where the User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of this User Assigned Identity. Changing this forces a new User Assigned Identity to be created.
PrincipalId string
The ID of the Service Principal object associated with the created Identity.
ResourceGroupName Changes to this property will trigger replacement. string
Specifies the name of the Resource Group within which this User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
Tags map[string]string
A mapping of tags which should be assigned to the User Assigned Identity.
TenantId string
The ID of the Tenant which the Identity belongs to.
clientId String
The ID of the app associated with the Identity.
location Changes to this property will trigger replacement. String
The Azure Region where the User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
name Changes to this property will trigger replacement. String
Specifies the name of this User Assigned Identity. Changing this forces a new User Assigned Identity to be created.
principalId String
The ID of the Service Principal object associated with the created Identity.
resourceGroupName Changes to this property will trigger replacement. String
Specifies the name of the Resource Group within which this User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
tags Map<String,String>
A mapping of tags which should be assigned to the User Assigned Identity.
tenantId String
The ID of the Tenant which the Identity belongs to.
clientId string
The ID of the app associated with the Identity.
location Changes to this property will trigger replacement. string
The Azure Region where the User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
name Changes to this property will trigger replacement. string
Specifies the name of this User Assigned Identity. Changing this forces a new User Assigned Identity to be created.
principalId string
The ID of the Service Principal object associated with the created Identity.
resourceGroupName Changes to this property will trigger replacement. string
Specifies the name of the Resource Group within which this User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
tags {[key: string]: string}
A mapping of tags which should be assigned to the User Assigned Identity.
tenantId string
The ID of the Tenant which the Identity belongs to.
client_id str
The ID of the app associated with the Identity.
location Changes to this property will trigger replacement. str
The Azure Region where the User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
name Changes to this property will trigger replacement. str
Specifies the name of this User Assigned Identity. Changing this forces a new User Assigned Identity to be created.
principal_id str
The ID of the Service Principal object associated with the created Identity.
resource_group_name Changes to this property will trigger replacement. str
Specifies the name of the Resource Group within which this User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
tags Mapping[str, str]
A mapping of tags which should be assigned to the User Assigned Identity.
tenant_id str
The ID of the Tenant which the Identity belongs to.
clientId String
The ID of the app associated with the Identity.
location Changes to this property will trigger replacement. String
The Azure Region where the User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
name Changes to this property will trigger replacement. String
Specifies the name of this User Assigned Identity. Changing this forces a new User Assigned Identity to be created.
principalId String
The ID of the Service Principal object associated with the created Identity.
resourceGroupName Changes to this property will trigger replacement. String
Specifies the name of the Resource Group within which this User Assigned Identity should exist. Changing this forces a new User Assigned Identity to be created.
tags Map<String>
A mapping of tags which should be assigned to the User Assigned Identity.
tenantId String
The ID of the Tenant which the Identity belongs to.

Import

An existing User Assigned Identity can be imported into Pulumi using the resource id, e.g.

$ pulumi import azure:authorization/userAssignedIdentity:UserAssignedIdentity example /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}
Copy

  • Where {subscriptionId} is the ID of the Azure Subscription where the User Assigned Identity exists. For example 12345678-1234-9876-4563-123456789012.

  • Where {resourceGroupName} is the name of Resource Group where this User Assigned Identity exists. For example example-resource-group.

  • Where {userAssignedIdentityName} is the name of the User Assigned Identity. For example userAssignedIdentityValue.

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.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure