Package-level declarations

Types

Link copied to clipboard
data class ApplicableScheduleResponse(val id: String, val labVmsShutdown: ScheduleResponse? = null, val labVmsStartup: ScheduleResponse? = null, val location: String? = null, val name: String, val tags: Map<String, String>? = null, val type: String)

Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.

Link copied to clipboard
data class ArmTemplateParameterPropertiesResponse(val name: String? = null, val value: String? = null)

Properties of an Azure Resource Manager template parameter.

data class ArtifactDeploymentStatusPropertiesResponse(val artifactsApplied: Int? = null, val deploymentStatus: String? = null, val totalArtifacts: Int? = null)

Properties of an artifact deployment.

Link copied to clipboard
data class ArtifactInstallPropertiesResponse(val artifactId: String? = null, val artifactTitle: String? = null, val deploymentStatusMessage: String? = null, val installTime: String? = null, val parameters: List<ArtifactParameterPropertiesResponse>? = null, val status: String? = null, val vmExtensionStatusMessage: String? = null)

Properties of an artifact.

Link copied to clipboard
data class ArtifactParameterPropertiesResponse(val name: String? = null, val value: String? = null)

Properties of an artifact parameter.

Link copied to clipboard
data class AttachNewDataDiskOptionsResponse(val diskName: String? = null, val diskSizeGiB: Int? = null, val diskType: String? = null)

Properties to attach new disk to the Virtual Machine.

Link copied to clipboard
data class BulkCreationParametersResponse(val instanceCount: Int? = null)

Parameters for creating multiple virtual machines as a single action.

Link copied to clipboard
data class ComputeDataDiskResponse(val diskSizeGiB: Int? = null, val diskUri: String? = null, val managedDiskId: String? = null, val name: String? = null)

A data disks attached to a virtual machine.

Link copied to clipboard
data class ComputeVmInstanceViewStatusResponse(val code: String? = null, val displayStatus: String? = null, val message: String? = null)

Status information about a virtual machine.

Link copied to clipboard
data class ComputeVmPropertiesResponse(val dataDiskIds: List<String>? = null, val dataDisks: List<ComputeDataDiskResponse>? = null, val networkInterfaceId: String? = null, val osDiskId: String? = null, val osType: String? = null, val statuses: List<ComputeVmInstanceViewStatusResponse>? = null, val vmSize: String? = null)

Properties of a virtual machine returned by the Microsoft.Compute API.

Link copied to clipboard
data class CustomImagePropertiesCustomResponse(val imageName: String? = null, val osType: String, val sysPrep: Boolean? = null)

Properties for creating a custom image from a VHD.

Link copied to clipboard
data class CustomImagePropertiesFromPlanResponse(val id: String? = null, val offer: String? = null, val publisher: String? = null)

Properties for plan on a custom image.

Link copied to clipboard
data class CustomImagePropertiesFromVmResponse(val linuxOsInfo: LinuxOsInfoResponse? = null, val sourceVmId: String? = null, val windowsOsInfo: WindowsOsInfoResponse? = null)

Properties for creating a custom image from a virtual machine.

Link copied to clipboard
data class DataDiskPropertiesResponse(val attachNewDataDiskOptions: AttachNewDataDiskOptionsResponse? = null, val existingLabDiskId: String? = null, val hostCaching: String? = null)

Request body for adding a new or existing data disk to a virtual machine.

Link copied to clipboard
data class DataDiskStorageTypeInfoResponse(val lun: String? = null, val storageType: String? = null)

Storage information about the data disks present in the custom image

Link copied to clipboard
data class DayDetailsResponse(val time: String? = null)

Properties of a daily schedule.

Link copied to clipboard
data class EnvironmentDeploymentPropertiesResponse(val armTemplateId: String? = null, val parameters: List<ArmTemplateParameterPropertiesResponse>? = null)

Properties of an environment deployment.

Link copied to clipboard
data class EventResponse(val eventName: String? = null)

An event to be notified for.

Link copied to clipboard
data class ExternalSubnetResponse(val id: String? = null, val name: String? = null)

Subnet information as returned by the Microsoft.Network API.

Link copied to clipboard
data class FormulaPropertiesFromVmResponse(val labVmId: String? = null)

Information about a VM from which a formula is to be created.

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 GetArtifactSourceResult(val armTemplateFolderPath: String? = null, val azureApiVersion: String, val branchRef: String? = null, val createdDate: String, val displayName: String? = null, val folderPath: String? = null, val id: String, val location: String? = null, val name: String, val provisioningState: String, val securityToken: String? = null, val sourceType: String? = null, val status: String? = null, val tags: Map<String, String>? = null, val type: String, val uniqueIdentifier: String, val uri: String? = null)

Properties of an artifact source.

Link copied to clipboard
data class GetCustomImageResult(val author: String? = null, val azureApiVersion: String, val creationDate: String, val customImagePlan: CustomImagePropertiesFromPlanResponse? = null, val dataDiskStorageInfo: List<DataDiskStorageTypeInfoResponse>? = null, val description: String? = null, val id: String, val isPlanAuthorized: Boolean? = null, val location: String? = null, val managedImageId: String? = null, val managedSnapshotId: String? = null, val name: String, val provisioningState: String, val tags: Map<String, String>? = null, val type: String, val uniqueIdentifier: String, val vhd: CustomImagePropertiesCustomResponse? = null, val vm: CustomImagePropertiesFromVmResponse? = null)

A custom image.

Link copied to clipboard
data class GetDiskResult(val azureApiVersion: String, val createdDate: String, val diskBlobName: String? = null, val diskSizeGiB: Int? = null, val diskType: String? = null, val diskUri: String? = null, val hostCaching: String? = null, val id: String, val leasedByLabVmId: String? = null, val location: String? = null, val managedDiskId: String? = null, val name: String, val provisioningState: String, val storageAccountId: String? = null, val tags: Map<String, String>? = null, val type: String, val uniqueIdentifier: String)

A Disk.

Link copied to clipboard
data class GetEnvironmentResult(val armTemplateDisplayName: String? = null, val azureApiVersion: String, val createdByUser: String, val deploymentProperties: EnvironmentDeploymentPropertiesResponse? = null, val id: String, val location: String? = null, val name: String, val provisioningState: String, val resourceGroupId: String, val tags: Map<String, String>? = null, val type: String, val uniqueIdentifier: String)

An environment, which is essentially an ARM template deployment.

Link copied to clipboard
data class GetFormulaResult(val author: String, val azureApiVersion: String, val creationDate: String, val description: String? = null, val formulaContent: LabVirtualMachineCreationParameterResponse? = null, val id: String, val location: String? = null, val name: String, val osType: String? = null, val provisioningState: String, val tags: Map<String, String>? = null, val type: String, val uniqueIdentifier: String, val vm: FormulaPropertiesFromVmResponse? = null)

A formula for creating a VM, specifying an image base and other parameters

Link copied to clipboard
data class GetGlobalScheduleResult(val azureApiVersion: String, val createdDate: String, val dailyRecurrence: DayDetailsResponse? = null, val hourlyRecurrence: HourDetailsResponse? = null, val id: String, val location: String? = null, val name: String, val notificationSettings: NotificationSettingsResponse? = null, val provisioningState: String, val status: String? = null, val tags: Map<String, String>? = null, val targetResourceId: String? = null, val taskType: String? = null, val timeZoneId: String? = null, val type: String, val uniqueIdentifier: String, val weeklyRecurrence: WeekDetailsResponse? = null)

A schedule.

Link copied to clipboard
data class GetLabResult(val announcement: LabAnnouncementPropertiesResponse? = null, val artifactsStorageAccount: String, val azureApiVersion: String, val createdDate: String, val defaultPremiumStorageAccount: String, val defaultStorageAccount: String, val environmentPermission: String? = null, val extendedProperties: Map<String, String>? = null, val id: String, val labStorageType: String? = null, val loadBalancerId: String, val location: String? = null, val mandatoryArtifactsResourceIdsLinux: List<String>? = null, val mandatoryArtifactsResourceIdsWindows: List<String>? = null, val name: String, val networkSecurityGroupId: String, val premiumDataDiskStorageAccount: String, val premiumDataDisks: String? = null, val provisioningState: String, val publicIpId: String, val support: LabSupportPropertiesResponse? = null, val tags: Map<String, String>? = null, val type: String, val uniqueIdentifier: String, val vaultName: String, val vmCreationResourceGroup: String)

A lab.

Link copied to clipboard
data class GetNotificationChannelResult(val azureApiVersion: String, val createdDate: String, val description: String? = null, val emailRecipient: String? = null, val events: List<EventResponse>? = null, val id: String, val location: String? = null, val name: String, val notificationLocale: String? = null, val provisioningState: String, val tags: Map<String, String>? = null, val type: String, val uniqueIdentifier: String, val webHookUrl: String? = null)

A notification.

Link copied to clipboard
data class GetPolicyResult(val azureApiVersion: String, val createdDate: String, val description: String? = null, val evaluatorType: String? = null, val factData: String? = null, val factName: String? = null, val id: String, val location: String? = null, val name: String, val provisioningState: String, val status: String? = null, val tags: Map<String, String>? = null, val threshold: String? = null, val type: String, val uniqueIdentifier: String)

A Policy.

Link copied to clipboard
data class GetScheduleResult(val azureApiVersion: String, val createdDate: String, val dailyRecurrence: DayDetailsResponse? = null, val hourlyRecurrence: HourDetailsResponse? = null, val id: String, val location: String? = null, val name: String, val notificationSettings: NotificationSettingsResponse? = null, val provisioningState: String, val status: String? = null, val tags: Map<String, String>? = null, val targetResourceId: String? = null, val taskType: String? = null, val timeZoneId: String? = null, val type: String, val uniqueIdentifier: String, val weeklyRecurrence: WeekDetailsResponse? = null)

A schedule.

Link copied to clipboard
data class GetSecretResult(val azureApiVersion: String, val id: String, val location: String? = null, val name: String, val provisioningState: String, val tags: Map<String, String>? = null, val type: String, val uniqueIdentifier: String, val value: String? = null)

A secret.

Link copied to clipboard
data class GetServiceFabricResult(val applicableSchedule: ApplicableScheduleResponse, val azureApiVersion: String, val environmentId: String? = null, val externalServiceFabricId: String? = null, val id: String, val location: String? = null, val name: String, val provisioningState: String, val tags: Map<String, String>? = null, val type: String, val uniqueIdentifier: String)

A Service Fabric.

Link copied to clipboard
data class GetServiceFabricScheduleResult(val azureApiVersion: String, val createdDate: String, val dailyRecurrence: DayDetailsResponse? = null, val hourlyRecurrence: HourDetailsResponse? = null, val id: String, val location: String? = null, val name: String, val notificationSettings: NotificationSettingsResponse? = null, val provisioningState: String, val status: String? = null, val tags: Map<String, String>? = null, val targetResourceId: String? = null, val taskType: String? = null, val timeZoneId: String? = null, val type: String, val uniqueIdentifier: String, val weeklyRecurrence: WeekDetailsResponse? = null)

A schedule.

Link copied to clipboard
data class GetServiceRunnerResult(val azureApiVersion: String, val id: String, val identity: IdentityPropertiesResponse? = null, val location: String? = null, val name: String, val tags: Map<String, String>? = null, val type: String)

A container for a managed identity to execute DevTest lab services.

Link copied to clipboard
data class GetUserResult(val azureApiVersion: String, val createdDate: String, val id: String, val identity: UserIdentityResponse? = null, val location: String? = null, val name: String, val provisioningState: String, val secretStore: UserSecretStoreResponse? = null, val tags: Map<String, String>? = null, val type: String, val uniqueIdentifier: String)

Profile of a lab user.

Link copied to clipboard
data class GetVirtualMachineRdpFileContentsResult(val contents: String? = null)

Represents a .rdp file

Link copied to clipboard
data class GetVirtualMachineResult(val allowClaim: Boolean? = null, val applicableSchedule: ApplicableScheduleResponse, val artifactDeploymentStatus: ArtifactDeploymentStatusPropertiesResponse, val artifacts: List<ArtifactInstallPropertiesResponse>? = null, val azureApiVersion: String, val computeId: String, val computeVm: ComputeVmPropertiesResponse, val createdByUser: String, val createdByUserId: String, val createdDate: String? = null, val customImageId: String? = null, val dataDiskParameters: List<DataDiskPropertiesResponse>? = null, val disallowPublicIpAddress: Boolean? = null, val environmentId: String? = null, val expirationDate: String? = null, val fqdn: String, val galleryImageReference: GalleryImageReferenceResponse? = null, val id: String, val isAuthenticationWithSshKey: Boolean? = null, val labSubnetName: String? = null, val labVirtualNetworkId: String? = null, val lastKnownPowerState: String, val location: String? = null, val name: String, val networkInterface: NetworkInterfacePropertiesResponse? = null, val notes: String? = null, val osType: String, val ownerObjectId: String? = null, val ownerUserPrincipalName: String? = null, val password: String? = null, val planId: String? = null, val provisioningState: String, val scheduleParameters: List<ScheduleCreationParameterResponse>? = null, val size: String? = null, val sshKey: String? = null, val storageType: String? = null, val tags: Map<String, String>? = null, val type: String, val uniqueIdentifier: String, val userName: String? = null, val virtualMachineCreationSource: String)

A virtual machine.

Link copied to clipboard
data class GetVirtualMachineScheduleResult(val azureApiVersion: String, val createdDate: String, val dailyRecurrence: DayDetailsResponse? = null, val hourlyRecurrence: HourDetailsResponse? = null, val id: String, val location: String? = null, val name: String, val notificationSettings: NotificationSettingsResponse? = null, val provisioningState: String, val status: String? = null, val tags: Map<String, String>? = null, val targetResourceId: String? = null, val taskType: String? = null, val timeZoneId: String? = null, val type: String, val uniqueIdentifier: String, val weeklyRecurrence: WeekDetailsResponse? = null)

A schedule.

Link copied to clipboard
data class GetVirtualNetworkResult(val allowedSubnets: List<SubnetResponse>? = null, val azureApiVersion: String, val createdDate: String, val description: String? = null, val externalProviderResourceId: String? = null, val externalSubnets: List<ExternalSubnetResponse>, val id: String, val location: String? = null, val name: String, val provisioningState: String, val subnetOverrides: List<SubnetOverrideResponse>? = null, val tags: Map<String, String>? = null, val type: String, val uniqueIdentifier: String)

A virtual network.

Link copied to clipboard
data class HourDetailsResponse(val minute: Int? = null)

Properties of an hourly schedule.

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

Properties of a managed identity

Link copied to clipboard
data class InboundNatRuleResponse(val backendPort: Int? = null, val frontendPort: Int? = null, val transportProtocol: String? = null)

A rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer.

Link copied to clipboard
data class LabAnnouncementPropertiesResponse(val enabled: String? = null, val expirationDate: String? = null, val expired: Boolean? = null, val markdown: String? = null, val provisioningState: String, val title: String? = null, val uniqueIdentifier: String)

Properties of a lab's announcement banner

Link copied to clipboard
data class LabSupportPropertiesResponse(val enabled: String? = null, val markdown: String? = null)

Properties of a lab's support banner

Link copied to clipboard
data class LabVhdResponse(val id: String? = null)

Properties of a VHD in the lab.

data class LabVirtualMachineCreationParameterResponse(val allowClaim: Boolean? = null, val artifacts: List<ArtifactInstallPropertiesResponse>? = null, val bulkCreationParameters: BulkCreationParametersResponse? = null, val createdDate: String? = null, val customImageId: String? = null, val dataDiskParameters: List<DataDiskPropertiesResponse>? = null, val disallowPublicIpAddress: Boolean? = null, val environmentId: String? = null, val expirationDate: String? = null, val galleryImageReference: GalleryImageReferenceResponse? = null, val isAuthenticationWithSshKey: Boolean? = null, val labSubnetName: String? = null, val labVirtualNetworkId: String? = null, val location: String? = null, val name: String? = null, val networkInterface: NetworkInterfacePropertiesResponse? = null, val notes: String? = null, val ownerObjectId: String? = null, val ownerUserPrincipalName: String? = null, val password: String? = null, val planId: String? = null, val scheduleParameters: List<ScheduleCreationParameterResponse>? = null, val size: String? = null, val sshKey: String? = null, val storageType: String? = null, val tags: Map<String, String>? = null, val userName: String? = null)

Properties for creating a virtual machine.

Link copied to clipboard
data class LinuxOsInfoResponse(val linuxOsState: String? = null)

Information about a Linux OS.

Link copied to clipboard
data class ListLabVhdsResult(val nextLink: String? = null, val value: List<LabVhdResponse>? = null)

The response of a list operation.

Link copied to clipboard
data class ListScheduleApplicableResult(val nextLink: String? = null, val value: List<ScheduleResponse>? = null)

The response of a list operation.

data class ListServiceFabricApplicableSchedulesResult(val id: String, val labVmsShutdown: ScheduleResponse? = null, val labVmsStartup: ScheduleResponse? = null, val location: String? = null, val name: String, val tags: Map<String, String>? = null, val type: String)

Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.

data class ListVirtualMachineApplicableSchedulesResult(val id: String, val labVmsShutdown: ScheduleResponse? = null, val labVmsStartup: ScheduleResponse? = null, val location: String? = null, val name: String, val tags: Map<String, String>? = null, val type: String)

Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.

Link copied to clipboard
data class NetworkInterfacePropertiesResponse(val dnsName: String? = null, val privateIpAddress: String? = null, val publicIpAddress: String? = null, val publicIpAddressId: String? = null, val rdpAuthority: String? = null, val sharedPublicIpAddressConfiguration: SharedPublicIpAddressConfigurationResponse? = null, val sshAuthority: String? = null, val subnetId: String? = null, val virtualNetworkId: String? = null)

Properties of a network interface.

Link copied to clipboard
data class NotificationSettingsResponse(val emailRecipient: String? = null, val notificationLocale: String? = null, val status: String? = null, val timeInMinutes: Int? = null, val webhookUrl: String? = null)

Notification settings for a schedule.

Link copied to clipboard
data class PortResponse(val backendPort: Int? = null, val transportProtocol: String? = null)

Properties of a network port.

Link copied to clipboard
data class ScheduleCreationParameterResponse(val dailyRecurrence: DayDetailsResponse? = null, val hourlyRecurrence: HourDetailsResponse? = null, val location: String, val name: String? = null, val notificationSettings: NotificationSettingsResponse? = null, val status: String? = null, val tags: Map<String, String>? = null, val targetResourceId: String? = null, val taskType: String? = null, val timeZoneId: String? = null, val weeklyRecurrence: WeekDetailsResponse? = null)

Properties for creating a schedule.

Link copied to clipboard
data class ScheduleResponse(val createdDate: String, val dailyRecurrence: DayDetailsResponse? = null, val hourlyRecurrence: HourDetailsResponse? = null, val id: String, val location: String? = null, val name: String, val notificationSettings: NotificationSettingsResponse? = null, val provisioningState: String, val status: String? = null, val tags: Map<String, String>? = null, val targetResourceId: String? = null, val taskType: String? = null, val timeZoneId: String? = null, val type: String, val uniqueIdentifier: String, val weeklyRecurrence: WeekDetailsResponse? = null)

A schedule.

Properties of a virtual machine that determine how it is connected to a load balancer.

Link copied to clipboard
data class SubnetOverrideResponse(val labSubnetName: String? = null, val resourceId: String? = null, val sharedPublicIpAddressConfiguration: SubnetSharedPublicIpAddressConfigurationResponse? = null, val useInVmCreationPermission: String? = null, val usePublicIpAddressPermission: String? = null, val virtualNetworkPoolName: String? = null)

Property overrides on a subnet of a virtual network.

Link copied to clipboard
data class SubnetResponse(val allowPublicIp: String? = null, val labSubnetName: String? = null, val resourceId: String? = null)

Subnet information.

Configuration for public IP address sharing.

Link copied to clipboard
data class UserIdentityResponse(val appId: String? = null, val objectId: String? = null, val principalId: String? = null, val principalName: String? = null, val tenantId: String? = null)

Identity attributes of a lab user.

Link copied to clipboard
data class UserSecretStoreResponse(val keyVaultId: String? = null, val keyVaultUri: String? = null)

Properties of a user's secret store.

Link copied to clipboard
data class WeekDetailsResponse(val time: String? = null, val weekdays: List<String>? = null)

Properties of a weekly schedule.

Link copied to clipboard
data class WindowsOsInfoResponse(val windowsOsState: String? = null)

Information about a Windows OS.