Azure Native v3.1.0, Apr 8 25

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.vmwarecloudsimple.getVirtualMachine

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Using getVirtualMachine

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getVirtualMachine(args: GetVirtualMachineArgs, opts?: InvokeOptions): Promise<GetVirtualMachineResult>
function getVirtualMachineOutput(args: GetVirtualMachineOutputArgs, opts?: InvokeOptions): Output<GetVirtualMachineResult>

def get_virtual_machine(resource_group_name: Optional[str] = None,
                        virtual_machine_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetVirtualMachineResult
def get_virtual_machine_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                        virtual_machine_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetVirtualMachineResult]

func LookupVirtualMachine(ctx *Context, args *LookupVirtualMachineArgs, opts ...InvokeOption) (*LookupVirtualMachineResult, error)
func LookupVirtualMachineOutput(ctx *Context, args *LookupVirtualMachineOutputArgs, opts ...InvokeOption) LookupVirtualMachineResultOutput

> Note: This function is named LookupVirtualMachine in the Go SDK.

public static class GetVirtualMachine 
{
    public static Task<GetVirtualMachineResult> InvokeAsync(GetVirtualMachineArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualMachineResult> Invoke(GetVirtualMachineInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVirtualMachineResult> getVirtualMachine(GetVirtualMachineArgs args, InvokeOptions options)
public static Output<GetVirtualMachineResult> getVirtualMachine(GetVirtualMachineArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:vmwarecloudsimple:getVirtualMachine
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string: The name of the resource group
VirtualMachineName string: virtual machine name

ResourceGroupName string: The name of the resource group
VirtualMachineName string: virtual machine name

resourceGroupName String: The name of the resource group
virtualMachineName String: virtual machine name

resourceGroupName string: The name of the resource group
virtualMachineName string: virtual machine name

resource_group_name str: The name of the resource group
virtual_machine_name str: virtual machine name

resourceGroupName String: The name of the resource group
virtualMachineName String: virtual machine name

getVirtualMachine Result

The following output properties are available:

AmountOfRam int: The amount of memory
AzureApiVersion string: The Azure API version of the resource.
Controllers List<Pulumi.AzureNative.VMwareCloudSimple.Outputs.VirtualDiskControllerResponse>: The list of Virtual Disks' Controllers
Dnsname string: The DNS name of Virtual Machine in VCenter
Folder string: The path to virtual machine folder in VCenter
GuestOS string: The name of Guest OS
GuestOSType string: The Guest OS type
Id string: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName}
Location string: Azure region
Name string: {virtualMachineName}
NumberOfCores int: The number of CPU cores
PrivateCloudId string: Private Cloud Id
ProvisioningState string: The provisioning status of the resource
PublicIP string: The public ip of Virtual Machine
Status string: The status of Virtual machine
Type string: {resourceProviderNamespace}/{resourceType}
VmId string: The internal id of Virtual Machine in VCenter
Vmwaretools string: VMware tools version
Customization Pulumi.AzureNative.VMwareCloudSimple.Outputs.GuestOSCustomizationResponse: Virtual machine properties
Disks List<Pulumi.AzureNative.VMwareCloudSimple.Outputs.VirtualDiskResponse>: The list of Virtual Disks
ExposeToGuestVM bool: Expose Guest OS or not
Nics List<Pulumi.AzureNative.VMwareCloudSimple.Outputs.VirtualNicResponse>: The list of Virtual NICs
Password string: Password for login. Deprecated - use customization property
ResourcePool Pulumi.AzureNative.VMwareCloudSimple.Outputs.ResourcePoolResponse: Virtual Machines Resource Pool
Tags Dictionary<string, string>: The list of tags
TemplateId string: Virtual Machine Template Id
Username string: Username for login. Deprecated - use customization property
VSphereNetworks List<string>: The list of Virtual VSphere Networks

AmountOfRam int: The amount of memory
AzureApiVersion string: The Azure API version of the resource.
Controllers []VirtualDiskControllerResponse: The list of Virtual Disks' Controllers
Dnsname string: The DNS name of Virtual Machine in VCenter
Folder string: The path to virtual machine folder in VCenter
GuestOS string: The name of Guest OS
GuestOSType string: The Guest OS type
Id string: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName}
Location string: Azure region
Name string: {virtualMachineName}
NumberOfCores int: The number of CPU cores
PrivateCloudId string: Private Cloud Id
ProvisioningState string: The provisioning status of the resource
PublicIP string: The public ip of Virtual Machine
Status string: The status of Virtual machine
Type string: {resourceProviderNamespace}/{resourceType}
VmId string: The internal id of Virtual Machine in VCenter
Vmwaretools string: VMware tools version
Customization GuestOSCustomizationResponse: Virtual machine properties
Disks []VirtualDiskResponse: The list of Virtual Disks
ExposeToGuestVM bool: Expose Guest OS or not
Nics []VirtualNicResponse: The list of Virtual NICs
Password string: Password for login. Deprecated - use customization property
ResourcePool ResourcePoolResponse: Virtual Machines Resource Pool
Tags map[string]string: The list of tags
TemplateId string: Virtual Machine Template Id
Username string: Username for login. Deprecated - use customization property
VSphereNetworks []string: The list of Virtual VSphere Networks

amountOfRam Integer: The amount of memory
azureApiVersion String: The Azure API version of the resource.
controllers List<VirtualDiskControllerResponse>: The list of Virtual Disks' Controllers
dnsname String: The DNS name of Virtual Machine in VCenter
folder String: The path to virtual machine folder in VCenter
guestOS String: The name of Guest OS
guestOSType String: The Guest OS type
id String: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName}
location String: Azure region
name String: {virtualMachineName}
numberOfCores Integer: The number of CPU cores
privateCloudId String: Private Cloud Id
provisioningState String: The provisioning status of the resource
publicIP String: The public ip of Virtual Machine
status String: The status of Virtual machine
type String: {resourceProviderNamespace}/{resourceType}
vmId String: The internal id of Virtual Machine in VCenter
vmwaretools String: VMware tools version
customization GuestOSCustomizationResponse: Virtual machine properties
disks List<VirtualDiskResponse>: The list of Virtual Disks
exposeToGuestVM Boolean: Expose Guest OS or not
nics List<VirtualNicResponse>: The list of Virtual NICs
password String: Password for login. Deprecated - use customization property
resourcePool ResourcePoolResponse: Virtual Machines Resource Pool
tags Map<String,String>: The list of tags
templateId String: Virtual Machine Template Id
username String: Username for login. Deprecated - use customization property
vSphereNetworks List<String>: The list of Virtual VSphere Networks

amountOfRam number: The amount of memory
azureApiVersion string: The Azure API version of the resource.
controllers VirtualDiskControllerResponse[]: The list of Virtual Disks' Controllers
dnsname string: The DNS name of Virtual Machine in VCenter
folder string: The path to virtual machine folder in VCenter
guestOS string: The name of Guest OS
guestOSType string: The Guest OS type
id string: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName}
location string: Azure region
name string: {virtualMachineName}
numberOfCores number: The number of CPU cores
privateCloudId string: Private Cloud Id
provisioningState string: The provisioning status of the resource
publicIP string: The public ip of Virtual Machine
status string: The status of Virtual machine
type string: {resourceProviderNamespace}/{resourceType}
vmId string: The internal id of Virtual Machine in VCenter
vmwaretools string: VMware tools version
customization GuestOSCustomizationResponse: Virtual machine properties
disks VirtualDiskResponse[]: The list of Virtual Disks
exposeToGuestVM boolean: Expose Guest OS or not
nics VirtualNicResponse[]: The list of Virtual NICs
password string: Password for login. Deprecated - use customization property
resourcePool ResourcePoolResponse: Virtual Machines Resource Pool
tags {[key: string]: string}: The list of tags
templateId string: Virtual Machine Template Id
username string: Username for login. Deprecated - use customization property
vSphereNetworks string[]: The list of Virtual VSphere Networks

amount_of_ram int: The amount of memory
azure_api_version str: The Azure API version of the resource.
controllers Sequence[VirtualDiskControllerResponse]: The list of Virtual Disks' Controllers
dnsname str: The DNS name of Virtual Machine in VCenter
folder str: The path to virtual machine folder in VCenter
guest_os str: The name of Guest OS
guest_os_type str: The Guest OS type
id str: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName}
location str: Azure region
name str: {virtualMachineName}
number_of_cores int: The number of CPU cores
private_cloud_id str: Private Cloud Id
provisioning_state str: The provisioning status of the resource
public_ip str: The public ip of Virtual Machine
status str: The status of Virtual machine
type str: {resourceProviderNamespace}/{resourceType}
vm_id str: The internal id of Virtual Machine in VCenter
vmwaretools str: VMware tools version
customization GuestOSCustomizationResponse: Virtual machine properties
disks Sequence[VirtualDiskResponse]: The list of Virtual Disks
expose_to_guest_vm bool: Expose Guest OS or not
nics Sequence[VirtualNicResponse]: The list of Virtual NICs
password str: Password for login. Deprecated - use customization property
resource_pool ResourcePoolResponse: Virtual Machines Resource Pool
tags Mapping[str, str]: The list of tags
template_id str: Virtual Machine Template Id
username str: Username for login. Deprecated - use customization property
v_sphere_networks Sequence[str]: The list of Virtual VSphere Networks

amountOfRam Number: The amount of memory
azureApiVersion String: The Azure API version of the resource.
controllers List<Property Map>: The list of Virtual Disks' Controllers
dnsname String: The DNS name of Virtual Machine in VCenter
folder String: The path to virtual machine folder in VCenter
guestOS String: The name of Guest OS
guestOSType String: The Guest OS type
id String: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName}
location String: Azure region
name String: {virtualMachineName}
numberOfCores Number: The number of CPU cores
privateCloudId String: Private Cloud Id
provisioningState String: The provisioning status of the resource
publicIP String: The public ip of Virtual Machine
status String: The status of Virtual machine
type String: {resourceProviderNamespace}/{resourceType}
vmId String: The internal id of Virtual Machine in VCenter
vmwaretools String: VMware tools version
customization Property Map: Virtual machine properties
disks List<Property Map>: The list of Virtual Disks
exposeToGuestVM Boolean: Expose Guest OS or not
nics List<Property Map>: The list of Virtual NICs
password String: Password for login. Deprecated - use customization property
resourcePool Property Map: Virtual Machines Resource Pool
tags Map<String>: The list of tags
templateId String: Virtual Machine Template Id
username String: Username for login. Deprecated - use customization property
vSphereNetworks List<String>: The list of Virtual VSphere Networks

Supporting Types

GuestOSCustomizationResponse

DnsServers List<string>: List of dns servers to use
HostName string: Virtual Machine hostname
Password string: Password for login
PolicyId string: id of customization policy
Username string: Username for login

DnsServers []string: List of dns servers to use
HostName string: Virtual Machine hostname
Password string: Password for login
PolicyId string: id of customization policy
Username string: Username for login

dnsServers List<String>: List of dns servers to use
hostName String: Virtual Machine hostname
password String: Password for login
policyId String: id of customization policy
username String: Username for login

dnsServers string[]: List of dns servers to use
hostName string: Virtual Machine hostname
password string: Password for login
policyId string: id of customization policy
username string: Username for login

dns_servers Sequence[str]: List of dns servers to use
host_name str: Virtual Machine hostname
password str: Password for login
policy_id str: id of customization policy
username str: Username for login

dnsServers List<String>: List of dns servers to use
hostName String: Virtual Machine hostname
password String: Password for login
policyId String: id of customization policy
username String: Username for login

GuestOSNICCustomizationResponse

Allocation string: IP address allocation method
DnsServers List<string>: List of dns servers to use
Gateway List<string>: Gateway addresses assigned to nic
IpAddress string: Static ip address for nic
Mask string: Network mask for nic
PrimaryWinsServer string: primary WINS server for Windows
SecondaryWinsServer string: secondary WINS server for Windows

Allocation string: IP address allocation method
DnsServers []string: List of dns servers to use
Gateway []string: Gateway addresses assigned to nic
IpAddress string: Static ip address for nic
Mask string: Network mask for nic
PrimaryWinsServer string: primary WINS server for Windows
SecondaryWinsServer string: secondary WINS server for Windows

allocation String: IP address allocation method
dnsServers List<String>: List of dns servers to use
gateway List<String>: Gateway addresses assigned to nic
ipAddress String: Static ip address for nic
mask String: Network mask for nic
primaryWinsServer String: primary WINS server for Windows
secondaryWinsServer String: secondary WINS server for Windows

allocation string: IP address allocation method
dnsServers string[]: List of dns servers to use
gateway string[]: Gateway addresses assigned to nic
ipAddress string: Static ip address for nic
mask string: Network mask for nic
primaryWinsServer string: primary WINS server for Windows
secondaryWinsServer string: secondary WINS server for Windows

allocation str: IP address allocation method
dns_servers Sequence[str]: List of dns servers to use
gateway Sequence[str]: Gateway addresses assigned to nic
ip_address str: Static ip address for nic
mask str: Network mask for nic
primary_wins_server str: primary WINS server for Windows
secondary_wins_server str: secondary WINS server for Windows

allocation String: IP address allocation method
dnsServers List<String>: List of dns servers to use
gateway List<String>: Gateway addresses assigned to nic
ipAddress String: Static ip address for nic
mask String: Network mask for nic
primaryWinsServer String: primary WINS server for Windows
secondaryWinsServer String: secondary WINS server for Windows

ResourcePoolResponse

FullName string: Hierarchical resource pool name
Id string: resource pool id (privateCloudId:vsphereId)
Location string: Azure region
Name string: {ResourcePoolName}
PrivateCloudId string: The Private Cloud Id
Type string: {resourceProviderNamespace}/{resourceType}

FullName string: Hierarchical resource pool name
Id string: resource pool id (privateCloudId:vsphereId)
Location string: Azure region
Name string: {ResourcePoolName}
PrivateCloudId string: The Private Cloud Id
Type string: {resourceProviderNamespace}/{resourceType}

fullName String: Hierarchical resource pool name
id String: resource pool id (privateCloudId:vsphereId)
location String: Azure region
name String: {ResourcePoolName}
privateCloudId String: The Private Cloud Id
type String: {resourceProviderNamespace}/{resourceType}

fullName string: Hierarchical resource pool name
id string: resource pool id (privateCloudId:vsphereId)
location string: Azure region
name string: {ResourcePoolName}
privateCloudId string: The Private Cloud Id
type string: {resourceProviderNamespace}/{resourceType}

full_name str: Hierarchical resource pool name
id str: resource pool id (privateCloudId:vsphereId)
location str: Azure region
name str: {ResourcePoolName}
private_cloud_id str: The Private Cloud Id
type str: {resourceProviderNamespace}/{resourceType}

fullName String: Hierarchical resource pool name
id String: resource pool id (privateCloudId:vsphereId)
location String: Azure region
name String: {ResourcePoolName}
privateCloudId String: The Private Cloud Id
type String: {resourceProviderNamespace}/{resourceType}

VirtualDiskControllerResponse

Id string: Controller's id
Name string: The display name of Controller
SubType string: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS)
Type string: disk controller type (SCSI)

Id string: Controller's id
Name string: The display name of Controller
SubType string: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS)
Type string: disk controller type (SCSI)

id String: Controller's id
name String: The display name of Controller
subType String: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS)
type String: disk controller type (SCSI)

id string: Controller's id
name string: The display name of Controller
subType string: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS)
type string: disk controller type (SCSI)

id str: Controller's id
name str: The display name of Controller
sub_type str: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS)
type str: disk controller type (SCSI)

id String: Controller's id
name String: The display name of Controller
subType String: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS)
type String: disk controller type (SCSI)

VirtualDiskResponse

ControllerId string: Disk's Controller id
IndependenceMode string: Disk's independence mode type
TotalSize int: Disk's total size
VirtualDiskName string: Disk's display name
VirtualDiskId string: Disk's id

ControllerId string: Disk's Controller id
IndependenceMode string: Disk's independence mode type
TotalSize int: Disk's total size
VirtualDiskName string: Disk's display name
VirtualDiskId string: Disk's id

controllerId String: Disk's Controller id
independenceMode String: Disk's independence mode type
totalSize Integer: Disk's total size
virtualDiskName String: Disk's display name
virtualDiskId String: Disk's id

controllerId string: Disk's Controller id
independenceMode string: Disk's independence mode type
totalSize number: Disk's total size
virtualDiskName string: Disk's display name
virtualDiskId string: Disk's id

controller_id str: Disk's Controller id
independence_mode str: Disk's independence mode type
total_size int: Disk's total size
virtual_disk_name str: Disk's display name
virtual_disk_id str: Disk's id

controllerId String: Disk's Controller id
independenceMode String: Disk's independence mode type
totalSize Number: Disk's total size
virtualDiskName String: Disk's display name
virtualDiskId String: Disk's id

VirtualNetworkResponse

Assignable bool: can be used in vm creation/deletion
Id string: virtual network id (privateCloudId:vsphereId)
Location string: Azure region
Name string: {VirtualNetworkName}
PrivateCloudId string: The Private Cloud id
Type string: {resourceProviderNamespace}/{resourceType}

Assignable bool: can be used in vm creation/deletion
Id string: virtual network id (privateCloudId:vsphereId)
Location string: Azure region
Name string: {VirtualNetworkName}
PrivateCloudId string: The Private Cloud id
Type string: {resourceProviderNamespace}/{resourceType}

assignable Boolean: can be used in vm creation/deletion
id String: virtual network id (privateCloudId:vsphereId)
location String: Azure region
name String: {VirtualNetworkName}
privateCloudId String: The Private Cloud id
type String: {resourceProviderNamespace}/{resourceType}

assignable boolean: can be used in vm creation/deletion
id string: virtual network id (privateCloudId:vsphereId)
location string: Azure region
name string: {VirtualNetworkName}
privateCloudId string: The Private Cloud id
type string: {resourceProviderNamespace}/{resourceType}

assignable bool: can be used in vm creation/deletion
id str: virtual network id (privateCloudId:vsphereId)
location str: Azure region
name str: {VirtualNetworkName}
private_cloud_id str: The Private Cloud id
type str: {resourceProviderNamespace}/{resourceType}

assignable Boolean: can be used in vm creation/deletion
id String: virtual network id (privateCloudId:vsphereId)
location String: Azure region
name String: {VirtualNetworkName}
privateCloudId String: The Private Cloud id
type String: {resourceProviderNamespace}/{resourceType}

VirtualNicResponse

Network Pulumi.AzureNative.VMwareCloudSimple.Inputs.VirtualNetworkResponse: Virtual Network
NicType string: NIC type
VirtualNicName string: NIC name
Customization Pulumi.AzureNative.VMwareCloudSimple.Inputs.GuestOSNICCustomizationResponse: guest OS customization for nic
IpAddresses List<string>: NIC ip address
MacAddress string: NIC MAC address
PowerOnBoot bool: Is NIC powered on/off on boot
VirtualNicId string: NIC id

Network VirtualNetworkResponse: Virtual Network
NicType string: NIC type
VirtualNicName string: NIC name
Customization GuestOSNICCustomizationResponse: guest OS customization for nic
IpAddresses []string: NIC ip address
MacAddress string: NIC MAC address
PowerOnBoot bool: Is NIC powered on/off on boot
VirtualNicId string: NIC id

network VirtualNetworkResponse: Virtual Network
nicType String: NIC type
virtualNicName String: NIC name
customization GuestOSNICCustomizationResponse: guest OS customization for nic
ipAddresses List<String>: NIC ip address
macAddress String: NIC MAC address
powerOnBoot Boolean: Is NIC powered on/off on boot
virtualNicId String: NIC id

network VirtualNetworkResponse: Virtual Network
nicType string: NIC type
virtualNicName string: NIC name
customization GuestOSNICCustomizationResponse: guest OS customization for nic
ipAddresses string[]: NIC ip address
macAddress string: NIC MAC address
powerOnBoot boolean: Is NIC powered on/off on boot
virtualNicId string: NIC id

network VirtualNetworkResponse: Virtual Network
nic_type str: NIC type
virtual_nic_name str: NIC name
customization GuestOSNICCustomizationResponse: guest OS customization for nic
ip_addresses Sequence[str]: NIC ip address
mac_address str: NIC MAC address
power_on_boot bool: Is NIC powered on/off on boot
virtual_nic_id str: NIC id

network Property Map: Virtual Network
nicType String: NIC type
virtualNicName String: NIC name
customization Property Map: guest OS customization for nic
ipAddresses List<String>: NIC ip address
macAddress String: NIC MAC address
powerOnBoot Boolean: Is NIC powered on/off on boot
virtualNicId String: NIC id

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.vmwarecloudsimple.getVirtualMachine

On this page

On this page

Using getVirtualMachine

getVirtualMachine Result

Supporting Types

GuestOSCustomizationResponse

GuestOSNICCustomizationResponse

ResourcePoolResponse

VirtualDiskControllerResponse

VirtualDiskResponse

VirtualNetworkResponse

VirtualNicResponse

Package Details

On this page

On this page