Share via

Lab interface

Package:
@azure/arm-labservices

The lab resource.

Extends
TrackedResource

Properties

autoShutdownProfile

The resource auto shutdown configuration for the lab. This controls whether actions are taken on resources that are sitting idle.
connectionProfile

The connection profile for the lab. This controls settings such as web access to lab resources or whether RDP or SSH ports are open.
description

The description of the lab.
labPlanId

The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization..
networkProfile

The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created.
provisioningState

Current provisioning state of the lab. NOTE: This property will not be serialized. It can only be populated by the server.
rosterProfile

The lab user list management profile.
securityProfile

The lab security profile.
state

The lab state. NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Metadata pertaining to creation and last modification of the lab. NOTE: This property will not be serialized. It can only be populated by the server.
title

The title of the lab.
virtualMachineProfile

The profile used for creating lab virtual machines.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

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

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

autoShutdownProfile

The resource auto shutdown configuration for the lab. This controls whether actions are taken on resources that are sitting idle.

autoShutdownProfile?: AutoShutdownProfile

Property Value

AutoShutdownProfile

connectionProfile

The connection profile for the lab. This controls settings such as web access to lab resources or whether RDP or SSH ports are open.

connectionProfile?: ConnectionProfile

Property Value

ConnectionProfile

description

The description of the lab.

description?: string

Property Value

string

labPlanId

The ID of the lab plan. Used during resource creation to provide defaults and acts as a permission container when creating a lab via labs.azure.com. Setting a labPlanId on an existing lab provides organization..

labPlanId?: string

Property Value

string

networkProfile

The network profile for the lab, typically applied via a lab plan. This profile cannot be modified once a lab has been created.

networkProfile?: LabNetworkProfile

Property Value

LabNetworkProfile

provisioningState

Current provisioning state of the lab. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: ProvisioningState

Property Value

ProvisioningState

rosterProfile

The lab user list management profile.

rosterProfile?: RosterProfile

Property Value

RosterProfile

securityProfile

The lab security profile.

securityProfile?: SecurityProfile

Property Value

SecurityProfile

state

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

state?: LabState

Property Value

LabState

systemData

Metadata pertaining to creation and last modification of the lab. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

title

The title of the lab.

title?: string

Property Value

string

virtualMachineProfile

The profile used for creating lab virtual machines.

virtualMachineProfile?: VirtualMachineProfile

Property Value

VirtualMachineProfile

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.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 TrackedResource.name

tags

Resource tags.

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

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type