LabPlan Class

Definition

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.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.LabPlanTypeConverter))]
public class LabPlan : Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.ILabPlan, Microsoft.Azure.PowerShell.Cmdlets.LabServices.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.LabPlanTypeConverter))>]
type LabPlan = class
    interface ILabPlan
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource
    interface IValidates
Public Class LabPlan
Implements ILabPlan, IValidates
Inheritance
LabPlan
Attributes
Implements

Constructors

LabPlan()

Creates an new LabPlan instance.

Properties

AllowedRegion

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

DefaultAutoShutdownProfileDisconnectDelay

The amount of time a VM will stay running after a user disconnects if this behavior is enabled.

DefaultAutoShutdownProfileIdleDelay

The amount of time a VM will idle before it is shutdown if this behavior is enabled.

DefaultAutoShutdownProfileNoConnectDelay

The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled.

DefaultAutoShutdownProfileShutdownOnDisconnect

Whether shutdown on disconnect is enabled

DefaultAutoShutdownProfileShutdownOnIdle

Whether a VM will get shutdown when it has idled for a period of time.

DefaultAutoShutdownProfileShutdownWhenNotConnected

Whether a VM will get shutdown when it hasn't been connected to after a period of time.

DefaultConnectionProfileClientRdpAccess

The enabled access level for Client Access over RDP.

DefaultConnectionProfileClientSshAccess

The enabled access level for Client Access over SSH.

DefaultConnectionProfileWebRdpAccess

The enabled access level for Web Access over RDP.

DefaultConnectionProfileWebSshAccess

The enabled access level for Web Access over SSH.

DefaultNetworkProfileSubnetId

The external subnet resource id

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

LinkedLmsInstance

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

Location

The geo-location where the resource lives

Name

The name of the resource

ProvisioningState

Current provisioning state of the lab plan.

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.

SupportInfoEmail

Support contact email address.

SupportInfoInstruction

Support instructions.

SupportInfoPhone

Support contact phone number.

SupportInfoUrl

Support web address.

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Tag

Resource tags.

Type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

BindResourceParameters(Hashtable)
DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of LabPlan.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of LabPlan.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.ILabPlan.

FromJsonString(String)

Creates a new instance of LabPlan, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of LabPlan into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to