Microsoft.DevTestLab labs/users 2016-05-15

Template format

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

{
  "name": "string",
  "type": "Microsoft.DevTestLab/labs/users",
  "apiVersion": "2016-05-15",
  "location": "string",
  "tags": {},
  "properties": {
    "identity": {
      "principalName": "string",
      "principalId": "string",
      "tenantId": "string",
      "objectId": "string",
      "appId": "string"
    },
    "secretStore": {
      "keyVaultUri": "string",
      "keyVaultId": "string"
    }
  },
  "resources": []
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.DevTestLab/labs/users object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes The name of the user profile.
type enum Yes For JSON -users
-or-
Microsoft.DevTestLab/labs/users

See Set name and type for child resources.
apiVersion enum Yes For JSON - 2016-05-15
location string No The location of the resource.
tags object No The tags of the resource.
properties object Yes The properties of the resource. - UserProperties object
resources array No secrets environments disks

UserProperties object

Name Type Required Value
identity object No The identity of the user. - UserIdentity object
secretStore object No The secret store of the user. - UserSecretStore object

UserIdentity object

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

UserSecretStore object

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