pulumi-azure-native-kotlin/com.pulumi.azurenative.compute.kotlin.outputs/GetVirtualMachineResult

GetVirtualMachineResult

data class GetVirtualMachineResult(val additionalCapabilities: AdditionalCapabilitiesResponse? = null, val availabilitySet: SubResourceResponse? = null, val billingProfile: BillingProfileResponse? = null, val diagnosticsProfile: DiagnosticsProfileResponse? = null, val evictionPolicy: String? = null, val extendedLocation: ExtendedLocationResponse? = null, val extensionsTimeBudget: String? = null, val hardwareProfile: HardwareProfileResponse? = null, val host: SubResourceResponse? = null, val hostGroup: SubResourceResponse? = null, val id: String, val identity: VirtualMachineIdentityResponse? = null, val instanceView: VirtualMachineInstanceViewResponse, val licenseType: String? = null, val location: String, val name: String, val networkProfile: NetworkProfileResponse? = null, val osProfile: OSProfileResponse? = null, val plan: PlanResponse? = null, val platformFaultDomain: Int? = null, val priority: String? = null, val provisioningState: String, val proximityPlacementGroup: SubResourceResponse? = null, val resources: List<VirtualMachineExtensionResponse>, val scheduledEventsProfile: ScheduledEventsProfileResponse? = null, val securityProfile: SecurityProfileResponse? = null, val storageProfile: StorageProfileResponse? = null, val tags: Map<String, String>? = null, val type: String, val userData: String? = null, val virtualMachineScaleSet: SubResourceResponse? = null, val vmId: String, val zones: List<String>? = null)

Describes a Virtual Machine.

Constructors

Link copied to clipboard
constructor(additionalCapabilities: AdditionalCapabilitiesResponse? = null, availabilitySet: SubResourceResponse? = null, billingProfile: BillingProfileResponse? = null, diagnosticsProfile: DiagnosticsProfileResponse? = null, evictionPolicy: String? = null, extendedLocation: ExtendedLocationResponse? = null, extensionsTimeBudget: String? = null, hardwareProfile: HardwareProfileResponse? = null, host: SubResourceResponse? = null, hostGroup: SubResourceResponse? = null, id: String, identity: VirtualMachineIdentityResponse? = null, instanceView: VirtualMachineInstanceViewResponse, licenseType: String? = null, location: String, name: String, networkProfile: NetworkProfileResponse? = null, osProfile: OSProfileResponse? = null, plan: PlanResponse? = null, platformFaultDomain: Int? = null, priority: String? = null, provisioningState: String, proximityPlacementGroup: SubResourceResponse? = null, resources: List<VirtualMachineExtensionResponse>, scheduledEventsProfile: ScheduledEventsProfileResponse? = null, securityProfile: SecurityProfileResponse? = null, storageProfile: StorageProfileResponse? = null, tags: Map<String, String>? = null, type: String, userData: String? = null, virtualMachineScaleSet: SubResourceResponse? = null, vmId: String, zones: List<String>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val additionalCapabilities: AdditionalCapabilitiesResponse? = null

Specifies additional capabilities enabled or disabled on the virtual machine.

Link copied to clipboard
val availabilitySet: SubResourceResponse? = null

Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview.

For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure

Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set.

This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

Link copied to clipboard
val billingProfile: BillingProfileResponse? = null

Specifies the billing related details of a Azure Spot virtual machine.

Minimum api-version: 2019-03-01.

Link copied to clipboard
val diagnosticsProfile: DiagnosticsProfileResponse? = null

Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15.

Link copied to clipboard
val evictionPolicy: String? = null

Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.

For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01.

For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview.

Link copied to clipboard
val extendedLocation: ExtendedLocationResponse? = null

The extended location of the Virtual Machine.

Link copied to clipboard
val extensionsTimeBudget: String? = null

Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

Minimum api-version: 2020-06-01

Link copied to clipboard
val hardwareProfile: HardwareProfileResponse? = null

Specifies the hardware settings for the virtual machine.

Link copied to clipboard
val host: SubResourceResponse? = null

Specifies information about the dedicated host that the virtual machine resides in.

Minimum api-version: 2018-10-01.

Link copied to clipboard
val hostGroup: SubResourceResponse? = null

Specifies information about the dedicated host group that the virtual machine resides in.

Minimum api-version: 2020-06-01.

NOTE: User cannot specify both host and hostGroup properties.

Link copied to clipboard
val id: String

Resource Id

Link copied to clipboard
val identity: VirtualMachineIdentityResponse? = null

The identity of the virtual machine, if configured.

Link copied to clipboard
val instanceView: VirtualMachineInstanceViewResponse

The virtual machine instance view.

Link copied to clipboard
val licenseType: String? = null

Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see Azure Hybrid Use Benefit for Windows Server

Azure Hybrid Use Benefit for Linux Server

Minimum api-version: 2015-06-15

Link copied to clipboard
val location: String

Resource location

Link copied to clipboard
val name: String

Resource name

Link copied to clipboard
val networkProfile: NetworkProfileResponse? = null

Specifies the network interfaces of the virtual machine.

Link copied to clipboard
val osProfile: OSProfileResponse? = null

Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.

Link copied to clipboard
val plan: PlanResponse? = null

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

Link copied to clipboard
val platformFaultDomain: Int? = null

Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.

  • This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.
  • The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' > 1.
  • This property cannot be updated once the Virtual Machine is created.
  • Fault domain assignment can be viewed in the Virtual Machine Instance View.

    Minimum api‐version: 2020‐12‐01

    • Link copied to clipboard
    val priority: String? = null

    Specifies the priority for the virtual machine.

    Minimum api-version: 2019-03-01

    Link copied to clipboard
    val provisioningState: String

    The provisioning state, which only appears in the response.

    Link copied to clipboard
    val proximityPlacementGroup: SubResourceResponse? = null

    Specifies information about the proximity placement group that the virtual machine should be assigned to.

    Minimum api-version: 2018-04-01.

    Link copied to clipboard
    val resources: List<VirtualMachineExtensionResponse>

    The virtual machine child extension resources.

    Link copied to clipboard
    val scheduledEventsProfile: ScheduledEventsProfileResponse? = null

    Specifies Scheduled Event related configurations.

    Link copied to clipboard
    val securityProfile: SecurityProfileResponse? = null

    Specifies the Security related profile settings for the virtual machine.

    Link copied to clipboard
    val storageProfile: StorageProfileResponse? = null

    Specifies the storage settings for the virtual machine disks.

    Link copied to clipboard
    val tags: Map<String, String>? = null

    Resource tags

    Link copied to clipboard
    val type: String

    Resource type

    Link copied to clipboard
    val userData: String? = null

    UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01

    Link copied to clipboard
    val virtualMachineScaleSet: SubResourceResponse? = null

    Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set.

    This property cannot exist along with a non-null properties.availabilitySet reference.

    Minimum api‐version: 2019‐03‐01

    Link copied to clipboard
    val vmId: String

    Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

    Link copied to clipboard
    val zones: List<String>? = null

    The virtual machine zones.