Package-level declarations

Types

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 GetClusterResult(val customResourceName: String, val datastoreIds: List<String>, val extendedLocation: ExtendedLocationResponse? = null, val id: String, val inventoryItemId: String? = null, val kind: String? = null, val location: String, val moName: String, val moRefId: String? = null, val name: String, val networkIds: List<String>, val provisioningState: String, val statuses: List<ResourceStatusResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val uuid: String, val vCenterId: String? = null)

Define the cluster.

Link copied to clipboard
data class GetDatastoreResult(val capacityGB: Double, val customResourceName: String, val extendedLocation: ExtendedLocationResponse? = null, val freeSpaceGB: Double, val id: String, val inventoryItemId: String? = null, val kind: String? = null, val location: String, val moName: String, val moRefId: String? = null, val name: String, val provisioningState: String, val statuses: List<ResourceStatusResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val uuid: String, val vCenterId: String? = null)

Define the datastore.

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 statuses: List<ResourceStatusResponse>, val systemData: SystemDataResponse, val type: String, val uuid: String)

Defines the GuestAgent.

Link copied to clipboard
data class GetHostResult(val customResourceName: String, val datastoreIds: List<String>, val extendedLocation: ExtendedLocationResponse? = null, val id: String, val inventoryItemId: String? = null, val kind: String? = null, val location: String, val moName: String, val moRefId: String? = null, val name: String, val networkIds: List<String>, val provisioningState: String, val statuses: List<ResourceStatusResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val uuid: String, val vCenterId: String? = null)

Define the host.

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

Defines the HybridIdentityMetadata.

Link copied to clipboard
data class GetInventoryItemResult(val id: String, val inventoryType: String, val kind: String? = null, val managedResourceId: String? = null, val moName: String? = null, val moRefId: String? = null, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val type: 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? = null, 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 GetResourcePoolResult(val cpuLimitMHz: Double, val cpuReservationMHz: Double, val cpuSharesLevel: String, val customResourceName: String, val datastoreIds: List<String>, val extendedLocation: ExtendedLocationResponse? = null, val id: String, val inventoryItemId: String? = null, val kind: String? = null, val location: String, val memLimitMB: Double, val memReservationMB: Double, val memSharesLevel: String, val moName: String, val moRefId: String? = null, val name: String, val networkIds: List<String>, val provisioningState: String, val statuses: List<ResourceStatusResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val uuid: String, val vCenterId: String? = null)

Define the resourcePool.

Link copied to clipboard
data class GetVCenterResult(val connectionStatus: String, val credentials: VICredentialResponse? = null, val customResourceName: String, val extendedLocation: ExtendedLocationResponse? = null, val fqdn: String, val id: String, val instanceUuid: String, val kind: String? = null, val location: String, val name: String, val port: Int? = null, val provisioningState: String, val statuses: List<ResourceStatusResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val uuid: String, val version: String)

Defines the vCenter.

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

Define the virtualMachineInstance.

Link copied to clipboard
data class GetVirtualMachineResult(val customResourceName: String, val extendedLocation: ExtendedLocationResponse? = null, val firmwareType: String? = null, val folderPath: String, val guestAgentProfile: GuestAgentProfileResponse? = null, val hardwareProfile: HardwareProfileResponse? = null, val id: String, val identity: IdentityResponse? = null, val instanceUuid: String, val inventoryItemId: String? = null, val kind: String? = null, val location: String, val moName: String, val moRefId: String? = null, val name: String, val networkProfile: NetworkProfileResponse? = null, val osProfile: OsProfileResponse? = null, val placementProfile: PlacementProfileResponse? = null, val powerState: String, val provisioningState: String, val resourcePoolId: String? = null, val securityProfile: SecurityProfileResponse? = null, val smbiosUuid: String? = null, val statuses: List<ResourceStatusResponse>, val storageProfile: StorageProfileResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val templateId: String? = null, val type: String, val uuid: String, val vCenterId: String? = null, val vmId: String)

Define the virtualMachine.

Link copied to clipboard
data class GetVirtualMachineTemplateResult(val customResourceName: String, val disks: List<VirtualDiskResponse>, val extendedLocation: ExtendedLocationResponse? = null, val firmwareType: String, val folderPath: String, val id: String, val inventoryItemId: String? = null, val kind: String? = null, val location: String, val memorySizeMB: Int, val moName: String, val moRefId: String? = null, val name: String, val networkInterfaces: List<NetworkInterfaceResponse>, val numCPUs: Int, val numCoresPerSocket: Int, val osName: String, val osType: String, val provisioningState: String, val statuses: List<ResourceStatusResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val toolsVersion: String, val toolsVersionStatus: String, val type: String, val uuid: String, val vCenterId: String? = null)

Define the virtualMachineTemplate.

Link copied to clipboard
data class GetVirtualNetworkResult(val customResourceName: String, val extendedLocation: ExtendedLocationResponse? = null, val id: String, val inventoryItemId: String? = null, val kind: String? = null, val location: String, val moName: String, val moRefId: String? = null, val name: String, val provisioningState: String, val statuses: List<ResourceStatusResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val uuid: String, val vCenterId: String? = null)

Define the virtualNetwork.

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 privateLinkScopeResourceId: String? = null, val provisioningAction: String? = null, val provisioningState: String, val status: String, val statuses: List<ResourceStatusResponse>, val systemData: SystemDataResponse, val type: String, val uuid: String)

Defines the GuestAgent.

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

Specifies the guest agent settings for the virtual machine.

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

Username / Password Credentials to connect to guest.

Link copied to clipboard
data class HardwareProfileResponse(val cpuHotAddEnabled: Boolean, val cpuHotRemoveEnabled: Boolean, val memoryHotAddEnabled: Boolean, val memorySizeMB: Int? = null, val numCPUs: Int? = null, val numCoresPerSocket: Int? = null)

Specifies the hardware settings for the virtual machine.

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 customResourceName: String, val firmwareType: String? = null, val folderPath: String, val instanceUuid: String, val inventoryItemId: String? = null, val moName: String, val moRefId: String, val smbiosUuid: String? = null, val templateId: String? = null, val vCenterId: String? = null)

Specifies the vCenter infrastructure specific settings for the virtual machine.

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 NetworkInterfaceResponse(val deviceKey: Int? = null, val ipAddresses: List<String>, val ipSettings: NicIPSettingsResponse? = null, val label: String, val macAddress: String, val name: String? = null, val networkId: String? = null, val networkMoName: String, val networkMoRefId: String, val nicType: String? = null, val powerOnBoot: String? = null)

Network Interface model

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

Specifies the network interfaces of the virtual machine.

Link copied to clipboard
data class NicIPAddressSettingsResponse(val allocationMethod: String, val ipAddress: String, val subnetMask: String)

IP address information for a virtual network adapter reported by the fabric.

Link copied to clipboard
data class NicIPSettingsResponse(val allocationMethod: String? = null, val dnsServers: List<String>? = null, val gateway: List<String>? = null, val ipAddress: String? = null, val ipAddressInfo: List<NicIPAddressSettingsResponse>, val primaryWinsServer: String, val secondaryWinsServer: String, val subnetMask: String? = null)

Defines the network interface ip settings.

Link copied to clipboard
data class OsProfileForVMInstanceResponse(val adminUsername: String? = null, val computerName: String? = null, val guestId: String? = null, val osSku: String, val osType: String? = null, val toolsRunningStatus: String, val toolsVersion: String, val toolsVersionStatus: String)

Specifies the operating system settings for the virtual machine.

Link copied to clipboard
data class OsProfileResponse(val adminUsername: String? = null, val allowExtensionOperations: Boolean, val computerName: String? = null, val guestId: String? = null, val linuxConfiguration: OsProfileResponseLinuxConfiguration? = null, val osName: String, val osType: String? = null, val toolsRunningStatus: String, val toolsVersion: String, val toolsVersionStatus: String, val windowsConfiguration: OsProfileResponseWindowsConfiguration? = null)

Specifies the operating system settings for the virtual machine.

Link copied to clipboard
data class OsProfileResponseLinuxConfiguration(val assessmentMode: String? = null, val patchMode: String? = null)

Specifies the linux configuration for update management.

Link copied to clipboard
data class OsProfileResponseWindowsConfiguration(val assessmentMode: String? = null, val patchMode: String? = null)

Specifies the windows configuration for update management.

Link copied to clipboard
data class PlacementProfileResponse(val clusterId: String? = null, val datastoreId: String? = null, val hostId: String? = null, val resourcePoolId: String? = null)

Specifies the compute and storage placement settings for the virtual machine.

Link copied to clipboard
data class ResourceStatusResponse(val lastUpdatedAt: String, val message: String, val reason: String, val severity: String, val status: String, val type: String)

The resource status information.

Link copied to clipboard
data class SecurityProfileResponse(val uefiSettings: UefiSettingsResponse? = null)

Specifies the Security profile settings for the virtual machine.

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

Specifies the storage settings for the virtual machine disks.

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 UefiSettingsResponse(val secureBootEnabled: Boolean? = null)

Specifies the security settings like secure boot used while creating the virtual machine.

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

Username / Password Credentials to connect to vcenter.

Link copied to clipboard
data class VirtualDiskResponse(val controllerKey: Int? = null, val deviceKey: Int? = null, val deviceName: String? = null, val diskMode: String? = null, val diskObjectId: String, val diskSizeGB: Int? = null, val diskType: String? = null, val label: String, val name: String? = null, val unitNumber: Int? = null)

Virtual disk model

Link copied to clipboard
data class VirtualSCSIControllerResponse(val busNumber: Int? = null, val controllerKey: Int? = null, val scsiCtlrUnitNumber: Int? = null, val sharing: String? = null, val type: String? = null)

This data object type contains the properties of a SCSI controller device attached to a virtual machine that is reported by the controller.