This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

msi

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.msi.UserAssignedIdentity(resource_name, opts=None, location=None, name=None, resource_group_name=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages a user assigned identity.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="eastus")
example_user_assigned_identity = azure.authorization.UserAssignedIdentity("exampleUserAssignedIdentity",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location)
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • location (pulumi.Input[str]) – The location/region where the user assigned identity is created.

  • name (pulumi.Input[str]) – The name of the user assigned identity. Changing this forces a new identity to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the user assigned identity.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

client_id: pulumi.Output[str] = None

Client ID associated with the user assigned identity.

location: pulumi.Output[str] = None

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

name: pulumi.Output[str] = None

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

principal_id: pulumi.Output[str] = None

Service Principal ID associated with the user assigned identity.

resource_group_name: pulumi.Output[str] = None

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

tags: pulumi.Output[dict] = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, client_id=None, location=None, name=None, principal_id=None, resource_group_name=None, tags=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • client_id (pulumi.Input[str]) – Client ID associated with the user assigned identity.

  • location (pulumi.Input[str]) – The location/region where the user assigned identity is created.

  • name (pulumi.Input[str]) – The name of the user assigned identity. Changing this forces a new identity to be created.

  • principal_id (pulumi.Input[str]) – Service Principal ID associated with the user assigned identity.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the user assigned identity.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str