Share via

LabPlan interface

Package:
@azure/arm-labservices

Lab Plans act as a permission container for creating labs via labs.azure.com. Additionally, they can provide a set of default configurations that will apply at the time of creating a lab, but these defaults can still be overwritten.

Extends
TrackedResource

Properties

allowedRegions

The allowed regions for the lab creator to use when creating labs using this lab plan.
defaultAutoShutdownProfile

The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile.
defaultConnectionProfile

The default lab connection profile. This can be changed on a lab resource and only provides a default profile.
defaultNetworkProfile

The lab plan network profile. To enforce lab network policies they must be defined here and cannot be changed when there are existing labs associated with this lab plan.
identity

Managed Identity Information
linkedLmsInstance

Base Url of the lms instance this lab plan can link lab rosters against.
provisioningState

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

Resource ID of the Shared Image Gallery attached to this lab plan. When saving a lab template virtual machine image it will be persisted in this gallery. Shared images from the gallery can be made available to use when creating new labs.
supportInfo

Support contact information and instructions for users of the lab plan. This information is displayed to lab owners and virtual machine users for all labs in the lab plan.
systemData

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

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

allowedRegions

The allowed regions for the lab creator to use when creating labs using this lab plan.

allowedRegions?: string[]

Property Value

string[]

defaultAutoShutdownProfile

The default lab shutdown profile. This can be changed on a lab resource and only provides a default profile.

defaultAutoShutdownProfile?: AutoShutdownProfile

Property Value

AutoShutdownProfile

defaultConnectionProfile

The default lab connection profile. This can be changed on a lab resource and only provides a default profile.

defaultConnectionProfile?: ConnectionProfile

Property Value

ConnectionProfile

defaultNetworkProfile

The lab plan network profile. To enforce lab network policies they must be defined here and cannot be changed when there are existing labs associated with this lab plan.

defaultNetworkProfile?: LabPlanNetworkProfile

Property Value

LabPlanNetworkProfile

identity

Managed Identity Information

identity?: Identity

Property Value

Identity

linkedLmsInstance

Base Url of the lms instance this lab plan can link lab rosters against.

linkedLmsInstance?: string

Property Value

string

provisioningState

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

provisioningState?: ProvisioningState

Property Value

ProvisioningState

sharedGalleryId

Resource ID of the Shared Image Gallery attached to this lab plan. When saving a lab template virtual machine image it will be persisted in this gallery. Shared images from the gallery can be made available to use when creating new labs.

sharedGalleryId?: string

Property Value

string

supportInfo

Support contact information and instructions for users of the lab plan. This information is displayed to lab owners and virtual machine users for all labs in the lab plan.

supportInfo?: SupportInfo

Property Value

SupportInfo

systemData

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

systemData?: SystemData

Property Value

SystemData

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