Microsoft.DevTestLab labs/users

ARM template resource definition

The labs/users resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DevTestLab/labs/users resource, add the following JSON to your template.

{
  "type": "Microsoft.DevTestLab/labs/users",
  "apiVersion": "2018-09-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "identity": {
      "appId": "string",
      "objectId": "string",
      "principalId": "string",
      "principalName": "string",
      "tenantId": "string"
    },
    "secretStore": {
      "keyVaultId": "string",
      "keyVaultUri": "string"
    }
  }
}

Property values

labs/users

Name Description Value
type The resource type 'Microsoft.DevTestLab/labs/users'
apiVersion The resource api version '2018-09-15'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
location The location of the resource. string
tags The tags of the resource. Dictionary of tag names and values. See Tags in templates
properties The properties of the resource. UserProperties

UserProperties

Name Description Value
identity The identity of the user. UserIdentity
secretStore The secret store of the user. UserSecretStore

UserIdentity

Name Description Value
appId Set to the app Id of the client JWT making the request. string
objectId 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. string
principalId Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id. string
principalName Set to the principal name / UPN of the client JWT making the request. string
tenantId Set to the tenant ID of the client JWT making the request. string

UserSecretStore

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