Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. devtestlab
  5. User
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.devtestlab.User

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Profile of a lab user. Azure REST API version: 2018-09-15. Prior API version in Azure Native 1.x: 2018-09-15.

Example Usage

Users_CreateOrUpdate

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

return await Deployment.RunAsync(() => 
{
    var user = new AzureNative.DevTestLab.User("user", new()
    {
        Identity = new AzureNative.DevTestLab.Inputs.UserIdentityArgs
        {
            AppId = "{appId}",
            ObjectId = "{objectId}",
            PrincipalId = "{principalId}",
            PrincipalName = "{principalName}",
            TenantId = "{tenantId}",
        },
        LabName = "{devtestlabName}",
        Location = "{location}",
        Name = "{userName}",
        ResourceGroupName = "resourceGroupName",
        SecretStore = new AzureNative.DevTestLab.Inputs.UserSecretStoreArgs
        {
            KeyVaultId = "{keyVaultId}",
            KeyVaultUri = "{keyVaultUri}",
        },
        Tags = 
        {
            { "tagName1", "tagValue1" },
        },
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := devtestlab.NewUser(ctx, "user", &devtestlab.UserArgs{
			Identity: &devtestlab.UserIdentityArgs{
				AppId:         pulumi.String("{appId}"),
				ObjectId:      pulumi.String("{objectId}"),
				PrincipalId:   pulumi.String("{principalId}"),
				PrincipalName: pulumi.String("{principalName}"),
				TenantId:      pulumi.String("{tenantId}"),
			},
			LabName:           pulumi.String("{devtestlabName}"),
			Location:          pulumi.String("{location}"),
			Name:              pulumi.String("{userName}"),
			ResourceGroupName: pulumi.String("resourceGroupName"),
			SecretStore: &devtestlab.UserSecretStoreArgs{
				KeyVaultId:  pulumi.String("{keyVaultId}"),
				KeyVaultUri: pulumi.String("{keyVaultUri}"),
			},
			Tags: pulumi.StringMap{
				"tagName1": pulumi.String("tagValue1"),
			},
		})
		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.devtestlab.User;
import com.pulumi.azurenative.devtestlab.UserArgs;
import com.pulumi.azurenative.devtestlab.inputs.UserIdentityArgs;
import com.pulumi.azurenative.devtestlab.inputs.UserSecretStoreArgs;
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 user = new User("user", UserArgs.builder()
            .identity(UserIdentityArgs.builder()
                .appId("{appId}")
                .objectId("{objectId}")
                .principalId("{principalId}")
                .principalName("{principalName}")
                .tenantId("{tenantId}")
                .build())
            .labName("{devtestlabName}")
            .location("{location}")
            .name("{userName}")
            .resourceGroupName("resourceGroupName")
            .secretStore(UserSecretStoreArgs.builder()
                .keyVaultId("{keyVaultId}")
                .keyVaultUri("{keyVaultUri}")
                .build())
            .tags(Map.of("tagName1", "tagValue1"))
            .build());

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

const user = new azure_native.devtestlab.User("user", {
    identity: {
        appId: "{appId}",
        objectId: "{objectId}",
        principalId: "{principalId}",
        principalName: "{principalName}",
        tenantId: "{tenantId}",
    },
    labName: "{devtestlabName}",
    location: "{location}",
    name: "{userName}",
    resourceGroupName: "resourceGroupName",
    secretStore: {
        keyVaultId: "{keyVaultId}",
        keyVaultUri: "{keyVaultUri}",
    },
    tags: {
        tagName1: "tagValue1",
    },
});
Copy
import pulumi
import pulumi_azure_native as azure_native

user = azure_native.devtestlab.User("user",
    identity={
        "app_id": "{appId}",
        "object_id": "{objectId}",
        "principal_id": "{principalId}",
        "principal_name": "{principalName}",
        "tenant_id": "{tenantId}",
    },
    lab_name="{devtestlabName}",
    location="{location}",
    name="{userName}",
    resource_group_name="resourceGroupName",
    secret_store={
        "key_vault_id": "{keyVaultId}",
        "key_vault_uri": "{keyVaultUri}",
    },
    tags={
        "tagName1": "tagValue1",
    })
Copy
resources:
  user:
    type: azure-native:devtestlab:User
    properties:
      identity:
        appId: '{appId}'
        objectId: '{objectId}'
        principalId: '{principalId}'
        principalName: '{principalName}'
        tenantId: '{tenantId}'
      labName: '{devtestlabName}'
      location: '{location}'
      name: '{userName}'
      resourceGroupName: resourceGroupName
      secretStore:
        keyVaultId: '{keyVaultId}'
        keyVaultUri: '{keyVaultUri}'
      tags:
        tagName1: tagValue1
Copy

Create User Resource

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

Constructor syntax

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

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         lab_name: Optional[str] = None,
         resource_group_name: Optional[str] = None,
         identity: Optional[UserIdentityArgs] = None,
         location: Optional[str] = None,
         name: Optional[str] = None,
         secret_store: Optional[UserSecretStoreArgs] = None,
         tags: Optional[Mapping[str, str]] = None)
func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
public User(string name, UserArgs args, CustomResourceOptions? opts = null)
public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

type: azure-native:devtestlab:User
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. UserArgs
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. UserArgs
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. UserArgs
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. UserArgs
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. UserArgs
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 exampleuserResourceResourceFromDevtestlab = new AzureNative.Devtestlab.User("exampleuserResourceResourceFromDevtestlab", new()
{
    LabName = "string",
    ResourceGroupName = "string",
    Identity = 
    {
        { "appId", "string" },
        { "objectId", "string" },
        { "principalId", "string" },
        { "principalName", "string" },
        { "tenantId", "string" },
    },
    Location = "string",
    Name = "string",
    SecretStore = 
    {
        { "keyVaultId", "string" },
        { "keyVaultUri", "string" },
    },
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := devtestlab.NewUser(ctx, "exampleuserResourceResourceFromDevtestlab", &devtestlab.UserArgs{
	LabName:           "string",
	ResourceGroupName: "string",
	Identity: map[string]interface{}{
		"appId":         "string",
		"objectId":      "string",
		"principalId":   "string",
		"principalName": "string",
		"tenantId":      "string",
	},
	Location: "string",
	Name:     "string",
	SecretStore: map[string]interface{}{
		"keyVaultId":  "string",
		"keyVaultUri": "string",
	},
	Tags: map[string]interface{}{
		"string": "string",
	},
})
Copy
var exampleuserResourceResourceFromDevtestlab = new com.pulumi.azurenative.devtestlab.User("exampleuserResourceResourceFromDevtestlab", com.pulumi.azurenative.devtestlab.UserArgs.builder()
    .labName("string")
    .resourceGroupName("string")
    .identity(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .location("string")
    .name("string")
    .secretStore(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());
Copy
exampleuser_resource_resource_from_devtestlab = azure_native.devtestlab.User("exampleuserResourceResourceFromDevtestlab",
    lab_name=string,
    resource_group_name=string,
    identity={
        appId: string,
        objectId: string,
        principalId: string,
        principalName: string,
        tenantId: string,
    },
    location=string,
    name=string,
    secret_store={
        keyVaultId: string,
        keyVaultUri: string,
    },
    tags={
        string: string,
    })
Copy
const exampleuserResourceResourceFromDevtestlab = new azure_native.devtestlab.User("exampleuserResourceResourceFromDevtestlab", {
    labName: "string",
    resourceGroupName: "string",
    identity: {
        appId: "string",
        objectId: "string",
        principalId: "string",
        principalName: "string",
        tenantId: "string",
    },
    location: "string",
    name: "string",
    secretStore: {
        keyVaultId: "string",
        keyVaultUri: "string",
    },
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:devtestlab:User
properties:
    identity:
        appId: string
        objectId: string
        principalId: string
        principalName: string
        tenantId: string
    labName: string
    location: string
    name: string
    resourceGroupName: string
    secretStore:
        keyVaultId: string
        keyVaultUri: string
    tags:
        string: string
Copy

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

LabName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Identity Pulumi.AzureNative.DevTestLab.Inputs.UserIdentity
The identity of the user.
Location string
The location of the resource.
Name Changes to this property will trigger replacement. string
The name of the user profile.
SecretStore Pulumi.AzureNative.DevTestLab.Inputs.UserSecretStore
The secret store of the user.
Tags Dictionary<string, string>
The tags of the resource.
LabName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Identity UserIdentityArgs
The identity of the user.
Location string
The location of the resource.
Name Changes to this property will trigger replacement. string
The name of the user profile.
SecretStore UserSecretStoreArgs
The secret store of the user.
Tags map[string]string
The tags of the resource.
labName
This property is required.
Changes to this property will trigger replacement.
String
The name of the lab.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
identity UserIdentity
The identity of the user.
location String
The location of the resource.
name Changes to this property will trigger replacement. String
The name of the user profile.
secretStore UserSecretStore
The secret store of the user.
tags Map<String,String>
The tags of the resource.
labName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
identity UserIdentity
The identity of the user.
location string
The location of the resource.
name Changes to this property will trigger replacement. string
The name of the user profile.
secretStore UserSecretStore
The secret store of the user.
tags {[key: string]: string}
The tags of the resource.
lab_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the lab.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
identity UserIdentityArgs
The identity of the user.
location str
The location of the resource.
name Changes to this property will trigger replacement. str
The name of the user profile.
secret_store UserSecretStoreArgs
The secret store of the user.
tags Mapping[str, str]
The tags of the resource.
labName
This property is required.
Changes to this property will trigger replacement.
String
The name of the lab.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
identity Property Map
The identity of the user.
location String
The location of the resource.
name Changes to this property will trigger replacement. String
The name of the user profile.
secretStore Property Map
The secret store of the user.
tags Map<String>
The tags of the resource.

Outputs

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

CreatedDate string
The creation date of the user profile.
Id string
The provider-assigned unique ID for this managed resource.
ProvisioningState string
The provisioning status of the resource.
Type string
The type of the resource.
UniqueIdentifier string
The unique immutable identifier of a resource (Guid).
CreatedDate string
The creation date of the user profile.
Id string
The provider-assigned unique ID for this managed resource.
ProvisioningState string
The provisioning status of the resource.
Type string
The type of the resource.
UniqueIdentifier string
The unique immutable identifier of a resource (Guid).
createdDate String
The creation date of the user profile.
id String
The provider-assigned unique ID for this managed resource.
provisioningState String
The provisioning status of the resource.
type String
The type of the resource.
uniqueIdentifier String
The unique immutable identifier of a resource (Guid).
createdDate string
The creation date of the user profile.
id string
The provider-assigned unique ID for this managed resource.
provisioningState string
The provisioning status of the resource.
type string
The type of the resource.
uniqueIdentifier string
The unique immutable identifier of a resource (Guid).
created_date str
The creation date of the user profile.
id str
The provider-assigned unique ID for this managed resource.
provisioning_state str
The provisioning status of the resource.
type str
The type of the resource.
unique_identifier str
The unique immutable identifier of a resource (Guid).
createdDate String
The creation date of the user profile.
id String
The provider-assigned unique ID for this managed resource.
provisioningState String
The provisioning status of the resource.
type String
The type of the resource.
uniqueIdentifier String
The unique immutable identifier of a resource (Guid).

Supporting Types

UserIdentity
, UserIdentityArgs

AppId string
Set to the app Id of the client JWT making the request.
ObjectId string
Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
PrincipalId string
Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
PrincipalName string
Set to the principal name / UPN of the client JWT making the request.
TenantId string
Set to the tenant ID of the client JWT making the request.
AppId string
Set to the app Id of the client JWT making the request.
ObjectId string
Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
PrincipalId string
Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
PrincipalName string
Set to the principal name / UPN of the client JWT making the request.
TenantId string
Set to the tenant ID of the client JWT making the request.
appId String
Set to the app Id of the client JWT making the request.
objectId String
Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
principalId String
Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
principalName String
Set to the principal name / UPN of the client JWT making the request.
tenantId String
Set to the tenant ID of the client JWT making the request.
appId string
Set to the app Id of the client JWT making the request.
objectId string
Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
principalId string
Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
principalName string
Set to the principal name / UPN of the client JWT making the request.
tenantId string
Set to the tenant ID of the client JWT making the request.
app_id str
Set to the app Id of the client JWT making the request.
object_id str
Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
principal_id str
Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
principal_name str
Set to the principal name / UPN of the client JWT making the request.
tenant_id str
Set to the tenant ID of the client JWT making the request.
appId String
Set to the app Id of the client JWT making the request.
objectId String
Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
principalId String
Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
principalName String
Set to the principal name / UPN of the client JWT making the request.
tenantId String
Set to the tenant ID of the client JWT making the request.

UserIdentityResponse
, UserIdentityResponseArgs

AppId string
Set to the app Id of the client JWT making the request.
ObjectId string
Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
PrincipalId string
Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
PrincipalName string
Set to the principal name / UPN of the client JWT making the request.
TenantId string
Set to the tenant ID of the client JWT making the request.
AppId string
Set to the app Id of the client JWT making the request.
ObjectId string
Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
PrincipalId string
Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
PrincipalName string
Set to the principal name / UPN of the client JWT making the request.
TenantId string
Set to the tenant ID of the client JWT making the request.
appId String
Set to the app Id of the client JWT making the request.
objectId String
Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
principalId String
Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
principalName String
Set to the principal name / UPN of the client JWT making the request.
tenantId String
Set to the tenant ID of the client JWT making the request.
appId string
Set to the app Id of the client JWT making the request.
objectId string
Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
principalId string
Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
principalName string
Set to the principal name / UPN of the client JWT making the request.
tenantId string
Set to the tenant ID of the client JWT making the request.
app_id str
Set to the app Id of the client JWT making the request.
object_id str
Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
principal_id str
Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
principal_name str
Set to the principal name / UPN of the client JWT making the request.
tenant_id str
Set to the tenant ID of the client JWT making the request.
appId String
Set to the app Id of the client JWT making the request.
objectId String
Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
principalId String
Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
principalName String
Set to the principal name / UPN of the client JWT making the request.
tenantId String
Set to the tenant ID of the client JWT making the request.

UserSecretStore
, UserSecretStoreArgs

KeyVaultId string
The ID of the user's Key vault.
KeyVaultUri string
The URI of the user's Key vault.
KeyVaultId string
The ID of the user's Key vault.
KeyVaultUri string
The URI of the user's Key vault.
keyVaultId String
The ID of the user's Key vault.
keyVaultUri String
The URI of the user's Key vault.
keyVaultId string
The ID of the user's Key vault.
keyVaultUri string
The URI of the user's Key vault.
key_vault_id str
The ID of the user's Key vault.
key_vault_uri str
The URI of the user's Key vault.
keyVaultId String
The ID of the user's Key vault.
keyVaultUri String
The URI of the user's Key vault.

UserSecretStoreResponse
, UserSecretStoreResponseArgs

KeyVaultId string
The ID of the user's Key vault.
KeyVaultUri string
The URI of the user's Key vault.
KeyVaultId string
The ID of the user's Key vault.
KeyVaultUri string
The URI of the user's Key vault.
keyVaultId String
The ID of the user's Key vault.
keyVaultUri String
The URI of the user's Key vault.
keyVaultId string
The ID of the user's Key vault.
keyVaultUri string
The URI of the user's Key vault.
key_vault_id str
The ID of the user's Key vault.
key_vault_uri str
The URI of the user's Key vault.
keyVaultId String
The ID of the user's Key vault.
keyVaultUri String
The URI of the user's Key vault.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:devtestlab:User {userName} /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}
Copy

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

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native