Microsoft.DevTestLab labs/users 2016-05-15

Bicep 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 Bicep to your template.

resource symbolicname 'Microsoft.DevTestLab/labs/users@2016-05-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    identity: {
      appId: 'string'
      objectId: 'string'
      principalId: 'string'
      principalName: 'string'
      tenantId: 'string'
    }
    provisioningState: 'string'
    secretStore: {
      keyVaultId: 'string'
      keyVaultUri: 'string'
    }
    uniqueIdentifier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.DevTestLab/labs/users

Name Description Value
location The location of the resource. string
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: labs
properties The properties of the resource. UserProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

ResourceTags

Name Description Value

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

UserProperties

Name Description Value
identity The identity of the user. UserIdentity
provisioningState The provisioning status of the resource. string
secretStore The secret store of the user. UserSecretStore
uniqueIdentifier The unique immutable identifier of a resource (Guid). 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

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": "2016-05-15",
  "name": "string",
  "location": "string",
  "properties": {
    "identity": {
      "appId": "string",
      "objectId": "string",
      "principalId": "string",
      "principalName": "string",
      "tenantId": "string"
    },
    "provisioningState": "string",
    "secretStore": {
      "keyVaultId": "string",
      "keyVaultUri": "string"
    },
    "uniqueIdentifier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.DevTestLab/labs/users

Name Description Value
apiVersion The api version '2016-05-15'
location The location of the resource. string
name The resource name string (required)
properties The properties of the resource. UserProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DevTestLab/labs/users'

ResourceTags

Name Description Value

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

UserProperties

Name Description Value
identity The identity of the user. UserIdentity
provisioningState The provisioning status of the resource. string
secretStore The secret store of the user. UserSecretStore
uniqueIdentifier The unique immutable identifier of a resource (Guid). 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

Usage Examples

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DevTestLab/labs/users@2016-05-15"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      identity = {
        appId = "string"
        objectId = "string"
        principalId = "string"
        principalName = "string"
        tenantId = "string"
      }
      provisioningState = "string"
      secretStore = {
        keyVaultId = "string"
        keyVaultUri = "string"
      }
      uniqueIdentifier = "string"
    }
  }
}

Property Values

Microsoft.DevTestLab/labs/users

Name Description Value
location The location of the resource. string
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: labs
properties The properties of the resource. UserProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DevTestLab/labs/users@2016-05-15"

ResourceTags

Name Description Value

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

UserProperties

Name Description Value
identity The identity of the user. UserIdentity
provisioningState The provisioning status of the resource. string
secretStore The secret store of the user. UserSecretStore
uniqueIdentifier The unique immutable identifier of a resource (Guid). 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
  • Last updated on