Share via


LabProperties Class

Definition

Properties of a lab resource.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.LabPropertiesTypeConverter))]
public class LabProperties : Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.ILabProperties, Microsoft.Azure.PowerShell.Cmdlets.LabServices.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.LabPropertiesTypeConverter))>]
type LabProperties = class
    interface ILabProperties
    interface IJsonSerializable
    interface ILabUpdateProperties
    interface IValidates
Public Class LabProperties
Implements ILabProperties, IValidates
Inheritance
LabProperties
Attributes
Implements

Constructors

LabProperties()

Creates an new LabProperties instance.

Properties

AdditionalCapabilityInstallGpuDriver

Flag to pre-install dedicated GPU drivers.

AdminUserPassword

The password for the user. This is required for the TemplateVM createOption.

AdminUserUsername

The username to use when signing in to lab VMs.

AutoShutdownProfile

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

AutoShutdownProfileDisconnectDelay

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

AutoShutdownProfileIdleDelay

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

AutoShutdownProfileNoConnectDelay

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

AutoShutdownProfileShutdownOnDisconnect

Whether shutdown on disconnect is enabled

AutoShutdownProfileShutdownOnIdle

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

AutoShutdownProfileShutdownWhenNotConnected

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

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.

ConnectionProfileClientRdpAccess

The enabled access level for Client Access over RDP.

ConnectionProfileClientSshAccess

The enabled access level for Client Access over SSH.

ConnectionProfileWebRdpAccess

The enabled access level for Web Access over RDP.

ConnectionProfileWebSshAccess

The enabled access level for Web Access over SSH.

Description

The description of the lab.

ImageReferenceExactVersion

The actual version of the image after use.

ImageReferenceId

Image resource ID

ImageReferenceOffer

The image offer if applicable.

ImageReferencePublisher

The image publisher

ImageReferenceSku

The image SKU

ImageReferenceVersion

The image version specified on creation.

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..

NetworkProfileLoadBalancerId

The external load balancer resource id

NetworkProfilePublicIPId

The external public IP resource id

NetworkProfileSubnetId

The external subnet resource id

NonAdminUserPassword

The password for the user. This is required for the TemplateVM createOption.

NonAdminUserUsername

The username to use when signing in to lab VMs.

ProvisioningState

Current provisioning state of the lab.

RosterProfile

The lab user list management profile.

RosterProfileActiveDirectoryGroupId

The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode.

RosterProfileLmsInstance

The base URI identifying the lms instance.

RosterProfileLtiClientId

The unique id of the azure lab services tool in the lms.

RosterProfileLtiContextId

The unique context identifier for the lab in the lms.

RosterProfileLtiRosterEndpoint

The uri of the names and roles service endpoint on the lms for the class attached to this lab.

SecurityProfile

The lab security profile.

SecurityProfileOpenAccess

Whether any user or only specified users can register to a lab.

SecurityProfileRegistrationCode

The registration code for the lab.

SkuCapacity

If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

SkuFamily

If the service has different generations of hardware, for the same SKU, then that can be captured here.

SkuName

The name of the SKU. Ex - P3. It is typically a letter+number code

SkuSize

The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

SkuTier

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

State

The lab state.

Title

The title of the lab.

VirtualMachineProfile

The profile used for creating lab virtual machines.

VirtualMachineProfileAdditionalCapability

Additional VM capabilities.

VirtualMachineProfileAdminUser

Credentials for the admin user on the VM.

VirtualMachineProfileCreateOption

Indicates what lab virtual machines are created from.

VirtualMachineProfileImageReference

The image configuration for lab virtual machines.

VirtualMachineProfileNonAdminUser

Credentials for the non-admin user on the VM, if one exists.

VirtualMachineProfileOSType

The OS type of the image

VirtualMachineProfileSku

The SKU for the lab. Defines the type of virtual machines used in the lab.

VirtualMachineProfileUsageQuota

The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours.

VirtualMachineProfileUseSharedPassword

Enabling this option will use the same password for all user VMs.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of LabProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of LabProperties.

FromJson(JsonNode)

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

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of LabProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to