Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. managedidentity
  5. UserAssignedIdentity
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.managedidentity.UserAssignedIdentity

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Describes an identity resource.

Uses Azure REST API version 2023-01-31. In version 2.x of the Azure Native provider, it used API version 2023-01-31.

Other available API versions: 2022-01-31-preview, 2023-07-31-preview, 2024-11-30, 2025-01-31-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native managedidentity [ApiVersion]. See the version guide for details.

Example Usage

IdentityCreate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var userAssignedIdentity = new AzureNative.ManagedIdentity.UserAssignedIdentity("userAssignedIdentity", new()
    {
        Location = "eastus",
        ResourceGroupName = "rgName",
        ResourceName = "resourceName",
        Tags = 
        {
            { "key1", "value1" },
            { "key2", "value2" },
        },
    });

});
Copy
package main

import (
	managedidentity "github.com/pulumi/pulumi-azure-native-sdk/managedidentity/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := managedidentity.NewUserAssignedIdentity(ctx, "userAssignedIdentity", &managedidentity.UserAssignedIdentityArgs{
			Location:          pulumi.String("eastus"),
			ResourceGroupName: pulumi.String("rgName"),
			ResourceName:      pulumi.String("resourceName"),
			Tags: pulumi.StringMap{
				"key1": pulumi.String("value1"),
				"key2": pulumi.String("value2"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.managedidentity.UserAssignedIdentity;
import com.pulumi.azurenative.managedidentity.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 userAssignedIdentity = new UserAssignedIdentity("userAssignedIdentity", UserAssignedIdentityArgs.builder()
            .location("eastus")
            .resourceGroupName("rgName")
            .resourceName("resourceName")
            .tags(Map.ofEntries(
                Map.entry("key1", "value1"),
                Map.entry("key2", "value2")
            ))
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const userAssignedIdentity = new azure_native.managedidentity.UserAssignedIdentity("userAssignedIdentity", {
    location: "eastus",
    resourceGroupName: "rgName",
    resourceName: "resourceName",
    tags: {
        key1: "value1",
        key2: "value2",
    },
});
Copy
import pulumi
import pulumi_azure_native as azure_native

user_assigned_identity = azure_native.managedidentity.UserAssignedIdentity("userAssignedIdentity",
    location="eastus",
    resource_group_name="rgName",
    resource_name_="resourceName",
    tags={
        "key1": "value1",
        "key2": "value2",
    })
Copy
resources:
  userAssignedIdentity:
    type: azure-native:managedidentity:UserAssignedIdentity
    properties:
      location: eastus
      resourceGroupName: rgName
      resourceName: resourceName
      tags:
        key1: value1
        key2: value2
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,
                         resource_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-native:managedidentity: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 AzureNative.ManagedIdentity.UserAssignedIdentity("userAssignedIdentityResource", new()
{
    ResourceGroupName = "string",
    Location = "string",
    ResourceName = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := managedidentity.NewUserAssignedIdentity(ctx, "userAssignedIdentityResource", &managedidentity.UserAssignedIdentityArgs{
	ResourceGroupName: pulumi.String("string"),
	Location:          pulumi.String("string"),
	ResourceName:      pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var userAssignedIdentityResource = new UserAssignedIdentity("userAssignedIdentityResource", UserAssignedIdentityArgs.builder()
    .resourceGroupName("string")
    .location("string")
    .resourceName("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
user_assigned_identity_resource = azure_native.managedidentity.UserAssignedIdentity("userAssignedIdentityResource",
    resource_group_name="string",
    location="string",
    resource_name_="string",
    tags={
        "string": "string",
    })
Copy
const userAssignedIdentityResource = new azure_native.managedidentity.UserAssignedIdentity("userAssignedIdentityResource", {
    resourceGroupName: "string",
    location: "string",
    resourceName: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:managedidentity:UserAssignedIdentity
properties:
    location: string
    resourceGroupName: string
    resourceName: 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
The name of the Resource Group to which the identity belongs.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
ResourceName Changes to this property will trigger replacement. string
The name of the identity resource.
Tags Dictionary<string, string>
Resource tags.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group to which the identity belongs.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
ResourceName Changes to this property will trigger replacement. string
The name of the identity resource.
Tags map[string]string
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group to which the identity belongs.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
resourceName Changes to this property will trigger replacement. String
The name of the identity resource.
tags Map<String,String>
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group to which the identity belongs.
location Changes to this property will trigger replacement. string
The geo-location where the resource lives
resourceName Changes to this property will trigger replacement. string
The name of the identity resource.
tags {[key: string]: string}
Resource tags.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Resource Group to which the identity belongs.
location Changes to this property will trigger replacement. str
The geo-location where the resource lives
resource_name Changes to this property will trigger replacement. str
The name of the identity resource.
tags Mapping[str, str]
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group to which the identity belongs.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
resourceName Changes to this property will trigger replacement. String
The name of the identity resource.
tags Map<String>
Resource tags.

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
ClientId string
The id of the app associated with the identity. This is a random generated UUID by MSI.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
PrincipalId string
The id of the service principal object associated with the created identity.
SystemData Pulumi.AzureNative.ManagedIdentity.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TenantId string
The id of the tenant which the identity belongs to.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
ClientId string
The id of the app associated with the identity. This is a random generated UUID by MSI.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
PrincipalId string
The id of the service principal object associated with the created identity.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TenantId string
The id of the tenant which the identity belongs to.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
clientId String
The id of the app associated with the identity. This is a random generated UUID by MSI.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
principalId String
The id of the service principal object associated with the created identity.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId String
The id of the tenant which the identity belongs to.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
clientId string
The id of the app associated with the identity. This is a random generated UUID by MSI.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
principalId string
The id of the service principal object associated with the created identity.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId string
The id of the tenant which the identity belongs to.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
client_id str
The id of the app associated with the identity. This is a random generated UUID by MSI.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
principal_id str
The id of the service principal object associated with the created identity.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenant_id str
The id of the tenant which the identity belongs to.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
clientId String
The id of the app associated with the identity. This is a random generated UUID by MSI.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
principalId String
The id of the service principal object associated with the created identity.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId String
The id of the tenant which the identity belongs to.
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:UserAssignedIdentity identityName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native