Share via


ILab Interface

Definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.LabTypeConverter))]
public interface ILab : Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20.ITrackedResource
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.LabTypeConverter))>]
type ILab = interface
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource
Public Interface ILab
Implements ITrackedResource
Derived
Attributes
Implements

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.

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.

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.

Id

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

(Inherited from IResource)
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.

Location

The geo-location where the resource lives

(Inherited from ITrackedResource)
Name

The name of the resource

(Inherited from IResource)
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.

PlanId

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

ProvisioningState

Current provisioning state of the lab.

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.

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.

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.

(Inherited from ITrackedResource)
Title

The title of the lab.

Type

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

(Inherited from IResource)
VirtualMachineProfileCreateOption

Indicates what lab virtual machines are created from.

VirtualMachineProfileOSType

The OS type of the image

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

ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)

Applies to