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 EnvironmentDetailsResponse(val description: String, val environmentState: String, val id: String, val latestOperationResult: LatestOperationResultResponse, val name: String, val passwordLastReset: String, val provisioningState: String, val totalUsage: String, val virtualMachineDetails: VirtualMachineDetailsResponse)

This represents the details about a User's environment and its state.

Link copied to clipboard
data class EnvironmentSizeResponse(val maxPrice: Double, val minMemory: Double, val minNumberOfCores: Int, val name: String? = null, val vmSizes: List<SizeInfoResponse>? = null)

Represents a size category supported by this Lab Account (small, medium or large)

Link copied to clipboard
data class GalleryImageReferenceResponse(val offer: String? = null, val osType: String? = null, val publisher: String? = null, val sku: String? = null, val version: String? = null)

The reference information for an Azure Marketplace image.

Link copied to clipboard
data class GetEnvironmentResult(val claimedByUserName: String, val claimedByUserObjectId: String, val claimedByUserPrincipalId: String, val id: String, val isClaimed: Boolean, val lastKnownPowerState: String, val latestOperationResult: LatestOperationResultResponse, val location: String? = null, val name: String, val networkInterface: NetworkInterfaceResponse, val passwordLastReset: String, val provisioningState: String? = null, val resourceSets: ResourceSetResponse? = null, val tags: Map<String, String>? = null, val totalUsage: String, val type: String, val uniqueIdentifier: String? = null)

Represents an environment instance

Link copied to clipboard
data class GetEnvironmentSettingResult(val configurationState: String? = null, val description: String? = null, val id: String, val lastChanged: String, val lastPublished: String, val latestOperationResult: LatestOperationResultResponse, val location: String? = null, val name: String, val provisioningState: String? = null, val publishingState: String, val resourceSettings: ResourceSettingsResponse, val tags: Map<String, String>? = null, val title: String? = null, val type: String, val uniqueIdentifier: String? = null)

Represents settings of an environment, from which environment instances would be created

Link copied to clipboard
data class GetGalleryImageResult(val author: String, val createdDate: String, val description: String, val icon: String, val id: String, val imageReference: GalleryImageReferenceResponse, val isEnabled: Boolean? = null, val isOverride: Boolean? = null, val isPlanAuthorized: Boolean? = null, val latestOperationResult: LatestOperationResultResponse, val location: String? = null, val name: String, val planId: String, val provisioningState: String? = null, val tags: Map<String, String>? = null, val type: String, val uniqueIdentifier: String? = null)

Represents an image from the Azure Marketplace

Link copied to clipboard

Represents the environments details

Link copied to clipboard

Status Details of the long running operation for an environment

Link copied to clipboard

Status Details of the long running operation for an environment

Link copied to clipboard
data class GetGlobalUserPersonalPreferencesResult(val favoriteLabResourceIds: List<String>? = null, val id: String? = null)

Represents the PersonalPreferences for the user

Link copied to clipboard
data class GetLabAccountRegionalAvailabilityResult(val regionalAvailability: List<RegionalAvailabilityResponse>? = null)

The response model from the GetRegionalAvailability action

Link copied to clipboard
data class GetLabAccountResult(val enabledRegionSelection: Boolean? = null, val id: String, val latestOperationResult: LatestOperationResultResponse, val location: String? = null, val name: String, val provisioningState: String? = null, val sizeConfiguration: SizeConfigurationPropertiesResponse, val tags: Map<String, String>? = null, val type: String, val uniqueIdentifier: String? = null)

Represents a lab account.

Link copied to clipboard
data class GetLabPlanResult(val allowedRegions: List<String>? = null, 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 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 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 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 id: String, val name: String, val notes: String? = null, val provisioningState: String, val recurrencePattern: RecurrencePatternResponse? = null, 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 displayName: String, val email: String, val id: String, val invitationSent: String, val invitationState: String, val name: String, val provisioningState: String, val registrationState: String, 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 LabDetailsResponse(val id: String? = null, val name: String? = null, val provisioningState: String? = null, val usageQuota: String)

This represents the details about a lab that the User is in, and its state.

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 LatestOperationResultResponse(val errorCode: String, val errorMessage: String, val httpMethod: String, val operationUrl: String, val requestUri: String, val status: String)

Details of the status of an operation.

Link copied to clipboard

Represents the list of environments owned by a user

Link copied to clipboard
data class ListGlobalUserLabsResult(val labs: List<LabDetailsResponse>? = null)

Lists the labs owned by a user

Link copied to clipboard
data class NetworkInterfaceResponse(val privateIpAddress: String, val rdpAuthority: String, val sshAuthority: String, val username: String)

Network details of the environment

Link copied to clipboard
data class OperationBatchStatusResponseItemResponse(val operationUrl: String, val status: String)

Represents the status of an operation that used the batch API.

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 ReferenceVmResponse(val password: String? = null, val userName: String, val vmResourceId: String, val vmStateDetails: VmStateDetailsResponse)

Details of a Reference Vm

Link copied to clipboard
data class RegionalAvailabilityResponse(val region: String? = null, val sizeAvailabilities: List<SizeAvailabilityResponse>? = null)

The availability information of sizes across regions

Link copied to clipboard
data class ResourceSetResponse(val resourceSettingId: String? = null, val vmResourceId: String? = null)

Represents a VM and the setting Id it was created for.

Link copied to clipboard
data class ResourceSettingsResponse(val cores: Int, val galleryImageResourceId: String? = null, val id: String, val imageName: String, val referenceVm: ReferenceVmResponse, val size: String? = null)

Represents resource specific settings

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 SizeAvailabilityResponse(val isAvailable: Boolean? = null, val sizeCategory: String? = null)

Represents the size information

Link copied to clipboard
data class SizeConfigurationPropertiesResponse(val environmentSizes: List<EnvironmentSizeResponse>? = null)

Represents the size configuration under the lab account

Link copied to clipboard
data class SizeInfoResponse(val computeSize: String? = null, val memory: Double? = null, val numberOfCores: Int? = null, val price: Double? = null)

Contains detailed information about a size

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 VirtualMachineDetailsResponse(val lastKnownPowerState: String, val privateIpAddress: String, val provisioningState: String, val rdpAuthority: String, val sshAuthority: String, val userName: String)

Details of the backing virtual machine.

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.

Link copied to clipboard
data class VmStateDetailsResponse(val lastKnownPowerState: String, val powerState: String, val rdpAuthority: String, val sshAuthority: String)

Details about the state of the reference virtual machine.