Share via

Lab interface

Package:
@azure/arm-devtestlabs

A lab.

Extends
Resource

Properties

announcement

The properties of any lab announcement associated with this lab
artifactsStorageAccount

The lab's artifact storage account. NOTE: This property will not be serialized. It can only be populated by the server.
createdDate

The creation date of the lab. NOTE: This property will not be serialized. It can only be populated by the server.
defaultPremiumStorageAccount

The lab's default premium storage account. NOTE: This property will not be serialized. It can only be populated by the server.
defaultStorageAccount

The lab's default storage account. NOTE: This property will not be serialized. It can only be populated by the server.
environmentPermission

The access rights to be granted to the user when provisioning an environment
extendedProperties

Extended properties of the lab used for experimental features
labStorageType

Type of storage used by the lab. It can be either Premium or Standard. Default is Premium.
loadBalancerId

The load balancer used to for lab VMs that use shared IP address. NOTE: This property will not be serialized. It can only be populated by the server.
mandatoryArtifactsResourceIdsLinux

The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user.
mandatoryArtifactsResourceIdsWindows

The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user.
networkSecurityGroupId

The Network Security Group attached to the lab VMs Network interfaces to restrict open ports. NOTE: This property will not be serialized. It can only be populated by the server.
premiumDataDisks

The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed.
premiumDataDiskStorageAccount

The lab's premium data disk storage account. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
publicIpId

The public IP address for the lab's load balancer. NOTE: This property will not be serialized. It can only be populated by the server.
support

The properties of any lab support message associated with this lab
uniqueIdentifier

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.
vaultName

The lab's Key vault. NOTE: This property will not be serialized. It can only be populated by the server.
vmCreationResourceGroup

The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
location

The location of the resource.
name

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
tags

The tags of the resource.
type

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

announcement

The properties of any lab announcement associated with this lab

announcement?: LabAnnouncementProperties

Property Value

LabAnnouncementProperties

artifactsStorageAccount

The lab's artifact storage account. NOTE: This property will not be serialized. It can only be populated by the server.

artifactsStorageAccount?: string

Property Value

string

createdDate

The creation date of the lab. NOTE: This property will not be serialized. It can only be populated by the server.

createdDate?: Date

Property Value

Date

defaultPremiumStorageAccount

The lab's default premium storage account. NOTE: This property will not be serialized. It can only be populated by the server.

defaultPremiumStorageAccount?: string

Property Value

string

defaultStorageAccount

The lab's default storage account. NOTE: This property will not be serialized. It can only be populated by the server.

defaultStorageAccount?: string

Property Value

string

environmentPermission

The access rights to be granted to the user when provisioning an environment

environmentPermission?: string

Property Value

string

extendedProperties

Extended properties of the lab used for experimental features

extendedProperties?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

labStorageType

Type of storage used by the lab. It can be either Premium or Standard. Default is Premium.

labStorageType?: string

Property Value

string

loadBalancerId

The load balancer used to for lab VMs that use shared IP address. NOTE: This property will not be serialized. It can only be populated by the server.

loadBalancerId?: string

Property Value

string

mandatoryArtifactsResourceIdsLinux

The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user.

mandatoryArtifactsResourceIdsLinux?: string[]

Property Value

string[]

mandatoryArtifactsResourceIdsWindows

The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user.

mandatoryArtifactsResourceIdsWindows?: string[]

Property Value

string[]

networkSecurityGroupId

The Network Security Group attached to the lab VMs Network interfaces to restrict open ports. NOTE: This property will not be serialized. It can only be populated by the server.

networkSecurityGroupId?: string

Property Value

string

premiumDataDisks

The setting to enable usage of premium data disks. When its value is 'Enabled', creation of standard or premium data disks is allowed. When its value is 'Disabled', only creation of standard data disks is allowed.

premiumDataDisks?: string

Property Value

string

premiumDataDiskStorageAccount

The lab's premium data disk storage account. NOTE: This property will not be serialized. It can only be populated by the server.

premiumDataDiskStorageAccount?: string

Property Value

string

provisioningState

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publicIpId

The public IP address for the lab's load balancer. NOTE: This property will not be serialized. It can only be populated by the server.

publicIpId?: string

Property Value

string

support

The properties of any lab support message associated with this lab

support?: LabSupportProperties

Property Value

LabSupportProperties

uniqueIdentifier

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

uniqueIdentifier?: string

Property Value

string

vaultName

The lab's Key vault. NOTE: This property will not be serialized. It can only be populated by the server.

vaultName?: string

Property Value

string

vmCreationResourceGroup

The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null. NOTE: This property will not be serialized. It can only be populated by the server.

vmCreationResourceGroup?: string

Property Value

string

Inherited Property Details

id

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

location

The location of the resource.

location?: string

Property Value

string

Inherited From Resource.location

name

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

The tags of the resource.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type