Package-level declarations

Types

Link copied to clipboard
data class AutoShutdownProfileResponse(val disconnectDelay: String? = null, val idleDelay: String? = null, val noConnectDelay: String? = null, val shutdownOnDisconnect: String? = null, val shutdownOnIdle: String? = null, val shutdownWhenNotConnected: String? = null)

Profile for how to handle shutting down virtual machines.

Link copied to clipboard
data class ConnectionProfileResponse(val clientRdpAccess: String? = null, val clientSshAccess: String? = null, val webRdpAccess: String? = null, val webSshAccess: String? = null)

Connection profile for how users connect to lab virtual machines.

Link copied to clipboard
data class CredentialsResponse(val username: String)

Credentials for a user on a lab VM.

Link copied to clipboard
data class GetLabPlanResult(val allowedRegions: List<String>? = null, val azureApiVersion: String, val defaultAutoShutdownProfile: AutoShutdownProfileResponse? = null, val defaultConnectionProfile: ConnectionProfileResponse? = null, val defaultNetworkProfile: LabPlanNetworkProfileResponse? = null, val id: String, val identity: IdentityResponse? = null, val linkedLmsInstance: String? = null, val location: String, val name: String, val provisioningState: String, val resourceOperationError: ResourceOperationErrorResponse, val sharedGalleryId: String? = null, val supportInfo: SupportInfoResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

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.

Link copied to clipboard
data class GetLabResult(val autoShutdownProfile: AutoShutdownProfileResponse, val azureApiVersion: String, val connectionProfile: ConnectionProfileResponse, val description: String? = null, val id: String, val labPlanId: String? = null, val location: String, val name: String, val networkProfile: LabNetworkProfileResponse? = null, val provisioningState: String, val resourceOperationError: ResourceOperationErrorResponse, val rosterProfile: RosterProfileResponse? = null, val securityProfile: SecurityProfileResponse, val state: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val title: String? = null, val type: String, val virtualMachineProfile: VirtualMachineProfileResponse)

The lab resource.

Link copied to clipboard
data class GetScheduleResult(val azureApiVersion: String, val id: String, val name: String, val notes: String? = null, val provisioningState: String, val recurrencePattern: RecurrencePatternResponse? = null, val resourceOperationError: ResourceOperationErrorResponse, val startAt: String? = null, val stopAt: String, val systemData: SystemDataResponse, val timeZoneId: String, val type: String)

Schedule for automatically turning virtual machines in a lab on and off at specified times.

Link copied to clipboard
data class GetUserResult(val additionalUsageQuota: String? = null, val azureApiVersion: String, val displayName: String, val email: String, val id: String, val invitationSent: String, val invitationState: String, val name: String, val provisioningState: String, val registrationState: String, val resourceOperationError: ResourceOperationErrorResponse, val systemData: SystemDataResponse, val totalUsage: String, val type: String)

User of a lab that can register for and use virtual machines within the lab.

Link copied to clipboard
data class IdentityResponse(val principalId: String, val tenantId: String, val type: String? = null)

Identity for the resource.

Link copied to clipboard
data class ImageReferenceResponse(val exactVersion: String, val id: String? = null, val offer: String? = null, val publisher: String? = null, val sku: String? = null, val version: String? = null)

Image reference information. Used in the virtual machine profile.

Link copied to clipboard
data class LabNetworkProfileResponse(val loadBalancerId: String? = null, val publicIpId: String? = null, val subnetId: String? = null)

Profile for how to handle networking for Labs.

Link copied to clipboard
data class LabPlanNetworkProfileResponse(val subnetId: String? = null)

Profile for how to handle networking for Lab Plans.

Link copied to clipboard
data class RecurrencePatternResponse(val expirationDate: String, val frequency: String, val interval: Int? = null, val weekDays: List<String>? = null)

Recurrence pattern of a lab schedule.

Link copied to clipboard
data class ResourceOperationErrorResponse(val action: String? = null, val code: String? = null, val message: String? = null, val timestamp: String? = null)

Error details of the latest operation failure on this resource

Link copied to clipboard
data class RosterProfileResponse(val activeDirectoryGroupId: String? = null, val lmsInstance: String? = null, val ltiClientId: String? = null, val ltiContextId: String? = null, val ltiRosterEndpoint: String? = null)

The lab user list management profile.

Link copied to clipboard
data class SecurityProfileResponse(val openAccess: String? = null, val registrationCode: String)

The lab security profile.

Link copied to clipboard
data class SkuResponse(val capacity: Int? = null, val family: String? = null, val name: String, val size: String? = null, val tier: String? = null)

The resource model definition representing SKU

Link copied to clipboard
data class SupportInfoResponse(val email: String? = null, val instructions: String? = null, val phone: String? = null, val url: String? = null)

Support contact information and instructions.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

data class VirtualMachineAdditionalCapabilitiesResponse(val installGpuDrivers: String? = null)

The additional capabilities for a lab VM.

Link copied to clipboard
data class VirtualMachineProfileResponse(val additionalCapabilities: VirtualMachineAdditionalCapabilitiesResponse? = null, val adminUser: CredentialsResponse, val createOption: String, val imageReference: ImageReferenceResponse, val nonAdminUser: CredentialsResponse? = null, val osType: String, val sku: SkuResponse, val usageQuota: String, val useSharedPassword: String? = null)

The base virtual machine configuration for a lab.