ILabProperties Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.LabPropertiesTypeConverter))]
public interface ILabProperties : Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.ILabUpdateProperties[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.Api20211001Preview.LabPropertiesTypeConverter))>]
type ILabProperties = interface
interface IJsonSerializable
interface ILabUpdatePropertiesPublic Interface ILabProperties
Implements ILabUpdateProperties- Derived
- Attributes
- Implements
Properties
| AdditionalCapabilityInstallGpuDriver |
Flag to pre-install dedicated GPU drivers. (Inherited from ILabUpdateProperties) |
| AdminUserPassword |
The password for the user. This is required for the TemplateVM createOption. (Inherited from ILabUpdateProperties) |
| AdminUserUsername |
The username to use when signing in to lab VMs. (Inherited from ILabUpdateProperties) |
| AutoShutdownProfileDisconnectDelay |
The amount of time a VM will stay running after a user disconnects if this behavior is enabled. (Inherited from ILabUpdateProperties) |
| AutoShutdownProfileIdleDelay |
The amount of time a VM will idle before it is shutdown if this behavior is enabled. (Inherited from ILabUpdateProperties) |
| AutoShutdownProfileNoConnectDelay |
The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. (Inherited from ILabUpdateProperties) |
| AutoShutdownProfileShutdownOnDisconnect |
Whether shutdown on disconnect is enabled (Inherited from ILabUpdateProperties) |
| AutoShutdownProfileShutdownOnIdle |
Whether a VM will get shutdown when it has idled for a period of time. (Inherited from ILabUpdateProperties) |
| AutoShutdownProfileShutdownWhenNotConnected |
Whether a VM will get shutdown when it hasn't been connected to after a period of time. (Inherited from ILabUpdateProperties) |
| ConnectionProfileClientRdpAccess |
The enabled access level for Client Access over RDP. (Inherited from ILabUpdateProperties) |
| ConnectionProfileClientSshAccess |
The enabled access level for Client Access over SSH. (Inherited from ILabUpdateProperties) |
| ConnectionProfileWebRdpAccess |
The enabled access level for Web Access over RDP. (Inherited from ILabUpdateProperties) |
| ConnectionProfileWebSshAccess |
The enabled access level for Web Access over SSH. (Inherited from ILabUpdateProperties) |
| Description |
The description of the lab. (Inherited from ILabUpdateProperties) |
| ImageReferenceExactVersion |
The actual version of the image after use. (Inherited from ILabUpdateProperties) |
| ImageReferenceId |
Image resource ID (Inherited from ILabUpdateProperties) |
| ImageReferenceOffer |
The image offer if applicable. (Inherited from ILabUpdateProperties) |
| ImageReferencePublisher |
The image publisher (Inherited from ILabUpdateProperties) |
| ImageReferenceSku |
The image SKU (Inherited from ILabUpdateProperties) |
| ImageReferenceVersion |
The image version specified on creation. (Inherited from ILabUpdateProperties) |
| 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.. (Inherited from ILabUpdateProperties) |
| 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. (Inherited from ILabUpdateProperties) |
| NonAdminUserUsername |
The username to use when signing in to lab VMs. (Inherited from ILabUpdateProperties) |
| 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. (Inherited from ILabUpdateProperties) |
| RosterProfileLmsInstance |
The base URI identifying the lms instance. (Inherited from ILabUpdateProperties) |
| RosterProfileLtiClientId |
The unique id of the azure lab services tool in the lms. (Inherited from ILabUpdateProperties) |
| RosterProfileLtiContextId |
The unique context identifier for the lab in the lms. (Inherited from ILabUpdateProperties) |
| RosterProfileLtiRosterEndpoint |
The uri of the names and roles service endpoint on the lms for the class attached to this lab. (Inherited from ILabUpdateProperties) |
| SecurityProfileOpenAccess |
Whether any user or only specified users can register to a lab. (Inherited from ILabUpdateProperties) |
| SecurityProfileRegistrationCode |
The registration code for the lab. (Inherited from ILabUpdateProperties) |
| 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. (Inherited from ILabUpdateProperties) |
| SkuFamily |
If the service has different generations of hardware, for the same SKU, then that can be captured here. (Inherited from ILabUpdateProperties) |
| SkuName |
The name of the SKU. Ex - P3. It is typically a letter+number code (Inherited from ILabUpdateProperties) |
| SkuSize |
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. (Inherited from ILabUpdateProperties) |
| 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. (Inherited from ILabUpdateProperties) |
| State |
The lab state. |
| Title |
The title of the lab. (Inherited from ILabUpdateProperties) |
| VirtualMachineProfileCreateOption |
Indicates what lab virtual machines are created from. (Inherited from ILabUpdateProperties) |
| VirtualMachineProfileOSType |
The OS type of the image (Inherited from ILabUpdateProperties) |
| VirtualMachineProfileUsageQuota |
The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. (Inherited from ILabUpdateProperties) |
| VirtualMachineProfileUseSharedPassword |
Enabling this option will use the same password for all user VMs. (Inherited from ILabUpdateProperties) |
Methods
| ToJson(JsonObject, SerializationMode) | (Inherited from IJsonSerializable) |