Package-level declarations

Types

Link copied to clipboard
data class CheckpointResponse(val checkpointID: String? = null, val description: String? = null, val name: String? = null, val parentCheckpointID: String? = null)

Defines the resource properties.

Link copied to clipboard
data class CloudCapacityResponse(val cpuCount: Double? = null, val memoryMB: Double? = null, val vmCount: Double? = null)

Cloud Capacity model

Link copied to clipboard
data class ErrorAdditionalInfoResponse(val info: Any, val type: String)

The resource management error additional info.

Link copied to clipboard
data class ErrorDetailResponse(val additionalInfo: List<ErrorAdditionalInfoResponse>, val code: String, val details: List<ErrorDetailResponse>, val message: String, val target: String)

The error detail.

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

The extended location.

Link copied to clipboard
data class GetAvailabilitySetResult(val availabilitySetName: String? = null, val extendedLocation: ExtendedLocationResponse? = null, val id: String, val location: String? = null, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val vmmServerId: String? = null)

The AvailabilitySets resource definition.

Link copied to clipboard
data class GetCloudResult(val cloudCapacity: CloudCapacityResponse, val cloudName: String, val extendedLocation: ExtendedLocationResponse, val id: String, val inventoryItemId: String? = null, val location: String, val name: String, val provisioningState: String, val storageQoSPolicies: List<StorageQoSPolicyResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val uuid: String? = null, val vmmServerId: String? = null)

The Clouds resource definition.

Link copied to clipboard
data class GetGuestAgentResult(val credentials: GuestCredentialResponse? = null, val customResourceName: String, val httpProxyConfig: HttpProxyConfigurationResponse? = null, val id: String, val name: String, val provisioningAction: String? = null, val provisioningState: String, val status: String, val systemData: SystemDataResponse, val type: String, val uuid: String)

Defines the GuestAgent.

Link copied to clipboard
data class GetHybridIdentityMetadataResult(val id: String, val identity: IdentityResponse, val name: String, val provisioningState: String, val publicKey: String? = null, val resourceUid: String? = null, val systemData: SystemDataResponse, val type: String)

Defines the HybridIdentityMetadata.

Link copied to clipboard
data class GetInventoryItemResult(val id: String, val inventoryItemName: String, val inventoryType: String, val kind: String? = null, val managedResourceId: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val type: String, val uuid: String)

Defines the inventory item.

Link copied to clipboard
data class GetMachineExtensionResult(val autoUpgradeMinorVersion: Boolean? = null, val enableAutomaticUpgrade: Boolean? = null, val forceUpdateTag: String? = null, val id: String, val instanceView: MachineExtensionPropertiesResponseInstanceView? = null, val location: String, val name: String, val protectedSettings: Any? = null, val provisioningState: String, val publisher: String? = null, val settings: Any? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val typeHandlerVersion: String? = null)

Describes a Machine Extension.

Link copied to clipboard
data class GetVirtualMachineInstanceResult(val availabilitySets: List<VirtualMachineInstancePropertiesResponseAvailabilitySets>? = null, val extendedLocation: ExtendedLocationResponse, val hardwareProfile: HardwareProfileResponse? = null, val id: String, val infrastructureProfile: InfrastructureProfileResponse? = null, val name: String, val networkProfile: NetworkProfileResponse? = null, val osProfile: OsProfileForVMInstanceResponse? = null, val powerState: String, val provisioningState: String, val storageProfile: StorageProfileResponse? = null, val systemData: SystemDataResponse, val type: String)

Define the virtualMachineInstance.

Link copied to clipboard
data class GetVirtualMachineResult(val availabilitySets: List<VirtualMachinePropertiesResponseAvailabilitySets>? = null, val checkpointType: String? = null, val checkpoints: List<CheckpointResponse>? = null, val cloudId: String? = null, val extendedLocation: ExtendedLocationResponse, val generation: Int? = null, val guestAgentProfile: GuestAgentProfileResponse? = null, val hardwareProfile: HardwareProfileResponse? = null, val id: String, val identity: IdentityResponse? = null, val inventoryItemId: String? = null, val lastRestoredVMCheckpoint: CheckpointResponse, val location: String, val name: String, val networkProfile: NetworkProfileResponse? = null, val osProfile: OsProfileResponse? = null, val powerState: String, val provisioningState: String, val storageProfile: StorageProfileResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val templateId: String? = null, val type: String, val uuid: String? = null, val vmName: String? = null, val vmmServerId: String? = null)

The VirtualMachines resource definition.

Link copied to clipboard
data class GetVirtualMachineTemplateResult(val computerName: String, val cpuCount: Int, val disks: List<VirtualDiskResponse>, val dynamicMemoryEnabled: String, val dynamicMemoryMaxMB: Int, val dynamicMemoryMinMB: Int, val extendedLocation: ExtendedLocationResponse, val generation: Int, val id: String, val inventoryItemId: String? = null, val isCustomizable: String, val isHighlyAvailable: String, val limitCpuForMigration: String, val location: String, val memoryMB: Int, val name: String, val networkInterfaces: List<NetworkInterfacesResponse>, val osName: String, val osType: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val uuid: String? = null, val vmmServerId: String? = null)

The VirtualMachineTemplates resource definition.

Link copied to clipboard
data class GetVirtualNetworkResult(val extendedLocation: ExtendedLocationResponse, val id: String, val inventoryItemId: String? = null, val location: String, val name: String, val networkName: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val uuid: String? = null, val vmmServerId: String? = null)

The VirtualNetworks resource definition.

Link copied to clipboard
data class GetVMInstanceGuestAgentResult(val credentials: GuestCredentialResponse? = null, val customResourceName: String, val httpProxyConfig: HttpProxyConfigurationResponse? = null, val id: String, val name: String, val provisioningAction: String? = null, val provisioningState: String, val status: String, val systemData: SystemDataResponse, val type: String, val uuid: String)

Defines the GuestAgent.

Link copied to clipboard
data class GetVmmServerResult(val connectionStatus: String, val credentials: VMMServerPropertiesResponseCredentials? = null, val errorMessage: String, val extendedLocation: ExtendedLocationResponse, val fqdn: String, val id: String, val location: String, val name: String, val port: Int? = null, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val uuid: String, val version: String)

The VmmServers resource definition.

Link copied to clipboard
data class GuestAgentProfileResponse(val agentVersion: String, val clientPublicKey: String? = null, val errorDetails: List<ErrorDetailResponse>, val lastStatusChange: String, val status: String, val vmUuid: String)

Defines the resource properties.

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

Username / Password Credentials to connect to guest.

Link copied to clipboard
data class HardwareProfileResponse(val cpuCount: Int? = null, val dynamicMemoryEnabled: String? = null, val dynamicMemoryMaxMB: Int? = null, val dynamicMemoryMinMB: Int? = null, val isHighlyAvailable: String? = null, val limitCpuForMigration: String? = null, val memoryMB: Int? = null)

Defines the resource properties.

Link copied to clipboard
data class HttpProxyConfigurationResponse(val httpsProxy: String? = null)

HTTP Proxy configuration for the VM.

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

Managed service identity.

Link copied to clipboard
data class InfrastructureProfileResponse(val biosGuid: String? = null, val checkpointType: String? = null, val checkpoints: List<CheckpointResponse>? = null, val cloudId: String? = null, val generation: Int? = null, val inventoryItemId: String? = null, val lastRestoredVMCheckpoint: CheckpointResponse, val templateId: String? = null, val uuid: String? = null, val vmName: String? = null, val vmmServerId: String? = null)

Specifies the vmmServer infrastructure specific settings for the virtual machine instance.

data class MachineExtensionInstanceViewResponseStatus(val code: String, val displayStatus: String, val level: String, val message: String, val time: String)

Instance view status.

data class MachineExtensionPropertiesResponseInstanceView(val name: String, val status: MachineExtensionInstanceViewResponseStatus? = null, val type: String, val typeHandlerVersion: String)

The machine extension instance view.

Link copied to clipboard
data class NetworkInterfacesResponse(val displayName: String, val ipv4AddressType: String? = null, val ipv4Addresses: List<String>, val ipv6AddressType: String? = null, val ipv6Addresses: List<String>, val macAddress: String? = null, val macAddressType: String? = null, val name: String? = null, val networkName: String, val nicId: String? = null, val virtualNetworkId: String? = null)

Network Interface model

Link copied to clipboard
data class NetworkProfileResponse(val networkInterfaces: List<NetworkInterfacesResponse>? = null)

Defines the resource properties.

Link copied to clipboard
data class OsProfileForVMInstanceResponse(val computerName: String? = null, val osSku: String, val osType: String, val osVersion: String)

Defines the resource properties.

Link copied to clipboard
data class OsProfileResponse(val computerName: String? = null, val osName: String, val osType: String)

Defines the resource properties.

Link copied to clipboard
data class StorageProfileResponse(val disks: List<VirtualDiskResponse>? = null)

Defines the resource properties.

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

The StorageQoSPolicyDetails definition.

Link copied to clipboard
data class StorageQoSPolicyResponse(val bandwidthLimit: Double? = null, val id: String? = null, val iopsMaximum: Double? = null, val iopsMinimum: Double? = null, val name: String? = null, val policyId: String? = null)

The StorageQoSPolicy definition.

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.

Link copied to clipboard
data class VirtualDiskResponse(val bus: Int? = null, val busType: String? = null, val createDiffDisk: String? = null, val diskId: String? = null, val diskSizeGB: Int? = null, val displayName: String, val lun: Int? = null, val maxDiskSizeGB: Int, val name: String? = null, val storageQoSPolicy: StorageQoSPolicyDetailsResponse? = null, val templateDiskId: String? = null, val vhdFormatType: String, val vhdType: String? = null, val volumeType: String)

Virtual disk model

data class VirtualMachineInstancePropertiesResponseAvailabilitySets(val id: String? = null, val name: String? = null)

Availability Set model

data class VirtualMachinePropertiesResponseAvailabilitySets(val id: String? = null, val name: String? = null)

Availability Set model

Link copied to clipboard
data class VMMServerPropertiesResponseCredentials(val username: String? = null)

Credentials to connect to VMMServer.