Users - Create Or Update

Service:

Dev Test Labs

API Version:

2018-09-15

Create or replace an existing user profile. This operation can take a while to complete.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}?api-version=2018-09-15

URI Parameters

Name	In	Required	Type	Description
labName	path	True	string	The name of the lab.
name	path	True	string	The name of the user profile.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	The subscription ID.
api-version	query	True	string	Client API version.

Request Body

Name	Type	Description
location	string	The location of the resource.
properties.identity	UserIdentity	The identity of the user.
properties.secretStore	UserSecretStore	The secret store of the user.
tags	object	The tags of the resource.

Responses

Name	Type	Description
200 OK	User	OK
201 Created	User	Created
Other Status Codes	CloudError	BadRequest

Security

azure_auth

OAuth2 Implicit Grant

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Access Microsoft Azure

Examples

Users_CreateOrUpdate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{devtestlabName}/users/{userName}?api-version=2018-09-15

{
  "location": "{location}",
  "tags": {
    "tagName1": "tagValue1"
  },
  "properties": {
    "identity": {
      "principalName": "{principalName}",
      "principalId": "{principalId}",
      "tenantId": "{tenantId}",
      "objectId": "{objectId}",
      "appId": "{appId}"
    },
    "secretStore": {
      "keyVaultUri": "{keyVaultUri}",
      "keyVaultId": "{keyVaultId}"
    }
  }
}

Java

import com.azure.resourcemanager.devtestlabs.models.UserIdentity;
import com.azure.resourcemanager.devtestlabs.models.UserSecretStore;
import java.util.HashMap;
import java.util.Map;

/** Samples for Users CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Users_CreateOrUpdate.json
     */
    /**
     * Sample code: Users_CreateOrUpdate.
     *
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void usersCreateOrUpdate(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager
            .users()
            .define("{userName}")
            .withRegion("{location}")
            .withExistingLab("resourceGroupName", "{devtestlabName}")
            .withTags(mapOf("tagName1", "tagValue1"))
            .withIdentity(
                new UserIdentity()
                    .withPrincipalName("{principalName}")
                    .withPrincipalId("{principalId}")
                    .withTenantId("{tenantId}")
                    .withObjectId("{objectId}")
                    .withAppId("{appId}"))
            .withSecretStore(
                new UserSecretStore().withKeyVaultUri("fakeTokenPlaceholder").withKeyVaultId("fakeTokenPlaceholder"))
            .create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.devtestlabs import DevTestLabsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devtestlabs
# USAGE
    python users_create_or_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DevTestLabsClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscriptionId}",
    )

    response = client.users.begin_create_or_update(
        resource_group_name="resourceGroupName",
        lab_name="{devtestlabName}",
        name="{userName}",
        user={
            "location": "{location}",
            "properties": {
                "identity": {
                    "appId": "{appId}",
                    "objectId": "{objectId}",
                    "principalId": "{principalId}",
                    "principalName": "{principalName}",
                    "tenantId": "{tenantId}",
                },
                "secretStore": {"keyVaultId": "{keyVaultId}", "keyVaultUri": "{keyVaultUri}"},
            },
            "tags": {"tagName1": "tagValue1"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Users_CreateOrUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdevtestlabs_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/devtestlabs/armdevtestlabs"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Users_CreateOrUpdate.json
func ExampleUsersClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdevtestlabs.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewUsersClient().BeginCreateOrUpdate(ctx, "resourceGroupName", "{devtestlabName}", "{userName}", armdevtestlabs.User{
		Location: to.Ptr("{location}"),
		Tags: map[string]*string{
			"tagName1": to.Ptr("tagValue1"),
		},
		Properties: &armdevtestlabs.UserProperties{
			Identity: &armdevtestlabs.UserIdentity{
				AppID:         to.Ptr("{appId}"),
				ObjectID:      to.Ptr("{objectId}"),
				PrincipalID:   to.Ptr("{principalId}"),
				PrincipalName: to.Ptr("{principalName}"),
				TenantID:      to.Ptr("{tenantId}"),
			},
			SecretStore: &armdevtestlabs.UserSecretStore{
				KeyVaultID:  to.Ptr("{keyVaultId}"),
				KeyVaultURI: to.Ptr("{keyVaultUri}"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.User = armdevtestlabs.User{
	// 	Properties: &armdevtestlabs.UserProperties{
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-02T01:40:48.173Z"); return t}()),
	// 		Identity: &armdevtestlabs.UserIdentity{
	// 			AppID: to.Ptr("{appId}"),
	// 			ObjectID: to.Ptr("{objectId}"),
	// 			PrincipalID: to.Ptr("{principalId}"),
	// 			PrincipalName: to.Ptr("{principalName}"),
	// 			TenantID: to.Ptr("{tenantId}"),
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		SecretStore: &armdevtestlabs.UserSecretStore{
	// 			KeyVaultID: to.Ptr("{keyVaultId}"),
	// 			KeyVaultURI: to.Ptr("{keyVaultUri}"),
	// 		},
	// 		UniqueIdentifier: to.Ptr("{uniqueIdentifier}"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DevTestLabsClient } = require("@azure/arm-devtestlabs");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create or replace an existing user profile. This operation can take a while to complete.
 *
 * @summary Create or replace an existing user profile. This operation can take a while to complete.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Users_CreateOrUpdate.json
 */
async function usersCreateOrUpdate() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{devtestlabName}";
  const name = "{userName}";
  const user = {
    identity: {
      appId: "{appId}",
      objectId: "{objectId}",
      principalId: "{principalId}",
      principalName: "{principalName}",
      tenantId: "{tenantId}",
    },
    location: "{location}",
    secretStore: { keyVaultId: "{keyVaultId}", keyVaultUri: "{keyVaultUri}" },
    tags: { tagName1: "tagValue1" },
  };
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.users.beginCreateOrUpdateAndWait(
    resourceGroupName,
    labName,
    name,
    user
  );
  console.log(result);
}

usersCreateOrUpdate().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DevTestLabs;
using Azure.ResourceManager.DevTestLabs.Models;

// Generated from example definition: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Users_CreateOrUpdate.json
// this example is just showing the usage of "Users_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DevTestLabResource created on azure
// for more information of creating DevTestLabResource, please refer to the document of DevTestLabResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "resourceGroupName";
string labName = "{devtestlabName}";
ResourceIdentifier devTestLabResourceId = DevTestLabResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, labName);
DevTestLabResource devTestLab = client.GetDevTestLabResource(devTestLabResourceId);

// get the collection of this DevTestLabUserResource
DevTestLabUserCollection collection = devTestLab.GetDevTestLabUsers();

// invoke the operation
string name = "{userName}";
DevTestLabUserData data = new DevTestLabUserData(new AzureLocation("{location}"))
{
    Identity = new DevTestLabUserIdentity()
    {
        PrincipalName = "{principalName}",
        PrincipalId = "{principalId}",
        TenantId = Guid.Parse("{tenantId}"),
        ObjectId = "{objectId}",
        AppId = "{appId}",
    },
    SecretStore = new DevTestLabUserSecretStore()
    {
        KeyVaultUri = new Uri("{keyVaultUri}"),
        KeyVaultId = new ResourceIdentifier("{keyVaultId}"),
    },
    Tags =
    {
    ["tagName1"] = "tagValue1",
    },
};
ArmOperation<DevTestLabUserResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, name, data);
DevTestLabUserResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DevTestLabUserData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "properties": {
    "identity": {
      "principalName": "{principalName}",
      "principalId": "{principalId}",
      "tenantId": "{tenantId}",
      "objectId": "{objectId}",
      "appId": "{appId}"
    },
    "secretStore": {
      "keyVaultUri": "{keyVaultUri}",
      "keyVaultId": "{keyVaultId}"
    },
    "createdDate": "2018-10-01T18:40:48.1739018-07:00",
    "provisioningState": "Succeeded",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "id": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}",
  "name": "{userName}",
  "type": "Microsoft.DevTestLab/labs/users",
  "location": "{location}",
  "tags": {
    "tagName1": "tagValue1"
  }
}

Status code:

201

{
  "properties": {
    "identity": {
      "principalName": "{principalName}",
      "principalId": "{principalId}",
      "tenantId": "{tenantId}",
      "objectId": "{objectId}",
      "appId": "{appId}"
    },
    "secretStore": {
      "keyVaultUri": "{keyVaultUri}",
      "keyVaultId": "{keyVaultId}"
    },
    "createdDate": "2018-10-01T18:40:48.1739018-07:00",
    "provisioningState": "Succeeded",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "id": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}",
  "name": "{userName}",
  "type": "Microsoft.DevTestLab/labs/users",
  "location": "{location}",
  "tags": {
    "tagName1": "tagValue1"
  }
}

Definitions

Name	Description
CloudError	Error from a REST request.
CloudErrorBody	Body of an error from a REST request.
User	Profile of a lab user.
UserIdentity	Identity attributes of a lab user.
UserSecretStore	Properties of a user's secret store.

CloudError

Error from a REST request.

Name	Type	Description
error	CloudErrorBody	The cloud error that occurred

CloudErrorBody

Body of an error from a REST request.

Name	Type	Description
code	string	The error code.
details	CloudErrorBody[]	Inner errors.
message	string	The error message.
target	string	The error target.

User

Profile of a lab user.

Name	Type	Description
id	string	The identifier of the resource.
location	string	The location of the resource.
name	string	The name of the resource.
properties.createdDate	string	The creation date of the user profile.
properties.identity	UserIdentity	The identity of the user.
properties.provisioningState	string	The provisioning status of the resource.
properties.secretStore	UserSecretStore	The secret store of the user.
properties.uniqueIdentifier	string	The unique immutable identifier of a resource (Guid).
tags	object	The tags of the resource.
type	string	The type of the resource.

UserIdentity

Identity attributes of a lab user.

Name	Type	Description
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

Properties of a user's secret store.

Name	Type	Description
keyVaultId	string	The ID of the user's Key vault.
keyVaultUri	string	The URI of the user's Key vault.