Module msi

@pulumi/azure > msi

class UserAssignedIdentity

extends CustomResource

Manages a user assigned identity.

Example Usage

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

const test = new azure.core.ResourceGroup("test", {
    location: "eastus",
    name: "acceptanceTestResourceGroup1",
});
const testIdentity = new azure.msi.UserAssignedIdentity("testIdentity", {
    location: test.location,
    name: "search-api",
    resourceGroupName: test.name,
});

constructor

new UserAssignedIdentity(name: string, args: UserAssignedIdentityArgs, opts?: pulumi.CustomResourceOptions)

Create a UserAssignedIdentity resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UserAssignedIdentityState, opts?: pulumi.CustomResourceOptions): UserAssignedIdentity

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property clientId

public clientId: pulumi.Output<string>;

Client ID associated with the user assigned identity.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

The location/region where the user assigned identity is created.

property name

public name: pulumi.Output<string>;

The name of the user assigned identity. Changing this forces a new identity to be created.

property principalId

public principalId: pulumi.Output<string>;

Service Principal ID associated with the user assigned identity.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the user assigned identity.

property tags

public tags: pulumi.Output<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

interface UserAssignedIdentityArgs

The set of arguments for constructing a UserAssignedIdentity resource.

property location

location?: pulumi.Input<string>;

The location/region where the user assigned identity is created.

property name

name?: pulumi.Input<string>;

The name of the user assigned identity. Changing this forces a new identity to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the user assigned identity.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

interface UserAssignedIdentityState

Input properties used for looking up and filtering UserAssignedIdentity resources.

property clientId

clientId?: pulumi.Input<string>;

Client ID associated with the user assigned identity.

property location

location?: pulumi.Input<string>;

The location/region where the user assigned identity is created.

property name

name?: pulumi.Input<string>;

The name of the user assigned identity. Changing this forces a new identity to be created.

property principalId

principalId?: pulumi.Input<string>;

Service Principal ID associated with the user assigned identity.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the user assigned identity.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.