1. Packages
  2. Azure Native
  3. API Docs
  4. networkcloud
  5. getVirtualMachine
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.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.networkcloud.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.2.0 published on Monday, Apr 14, 2025 by Pulumi

Get properties of the provided virtual machine.

Uses Azure REST API version 2025-02-01.

Other available API versions: 2023-10-01-preview, 2024-06-01-preview, 2024-07-01, 2024-10-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native networkcloud [ApiVersion]. See the version guide for details.

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.

function getVirtualMachine(args: GetVirtualMachineArgs, opts?: InvokeOptions): Promise<GetVirtualMachineResult>
function getVirtualMachineOutput(args: GetVirtualMachineOutputArgs, opts?: InvokeOptions): Output<GetVirtualMachineResult>
Copy
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]
Copy
func LookupVirtualMachine(ctx *Context, args *LookupVirtualMachineArgs, opts ...InvokeOption) (*LookupVirtualMachineResult, error)
func LookupVirtualMachineOutput(ctx *Context, args *LookupVirtualMachineOutputArgs, opts ...InvokeOption) LookupVirtualMachineResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetVirtualMachineResult> getVirtualMachine(GetVirtualMachineArgs args, InvokeOptions options)
public static Output<GetVirtualMachineResult> getVirtualMachine(GetVirtualMachineArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:networkcloud:getVirtualMachine
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
VirtualMachineName
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual machine.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
VirtualMachineName
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual machine.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
virtualMachineName
This property is required.
Changes to this property will trigger replacement.
String
The name of the virtual machine.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
virtualMachineName
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual machine.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
virtual_machine_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the virtual machine.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
virtualMachineName
This property is required.
Changes to this property will trigger replacement.
String
The name of the virtual machine.

getVirtualMachine Result

The following output properties are available:

AdminUsername string
The name of the administrator to which the ssh public keys will be added into the authorized keys.
AvailabilityZone string
The cluster availability zone containing this virtual machine.
AzureApiVersion string
The Azure API version of the resource.
BareMetalMachineId string
The resource ID of the bare metal machine that hosts the virtual machine.
CloudServicesNetworkAttachment Pulumi.AzureNative.NetworkCloud.Outputs.NetworkAttachmentResponse
The cloud service network that provides platform-level services for the virtual machine.
ClusterId string
The resource ID of the cluster the virtual machine is created for.
CpuCores double
The number of CPU cores in the virtual machine.
DetailedStatus string
The more detailed status of the virtual machine.
DetailedStatusMessage string
The descriptive message about the current detailed status.
Etag string
Resource ETag.
ExtendedLocation Pulumi.AzureNative.NetworkCloud.Outputs.ExtendedLocationResponse
The extended location of the cluster associated with the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
MemorySizeGB double
The memory size of the virtual machine. Allocations are measured in gibibytes.
Name string
The name of the resource
PowerState string
The power state of the virtual machine.
ProvisioningState string
The provisioning state of the virtual machine.
StorageProfile Pulumi.AzureNative.NetworkCloud.Outputs.StorageProfileResponse
The storage profile that specifies size and other parameters about the disks related to the virtual machine.
SystemData Pulumi.AzureNative.NetworkCloud.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
VmImage string
The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image.
Volumes List<string>
The resource IDs of volumes that are attached to the virtual machine.
BootMethod string
Selects the boot method for the virtual machine.
ConsoleExtendedLocation Pulumi.AzureNative.NetworkCloud.Outputs.ExtendedLocationResponse
The extended location to use for creation of a VM console resource.
IsolateEmulatorThread string
Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine.
NetworkAttachments List<Pulumi.AzureNative.NetworkCloud.Outputs.NetworkAttachmentResponse>
The list of network attachments to the virtual machine.
NetworkData string
The Base64 encoded cloud-init network data.
PlacementHints List<Pulumi.AzureNative.NetworkCloud.Outputs.VirtualMachinePlacementHintResponse>
The scheduling hints for the virtual machine.
SshPublicKeys List<Pulumi.AzureNative.NetworkCloud.Outputs.SshPublicKeyResponse>
The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername.
Tags Dictionary<string, string>
Resource tags.
UserData string
The Base64 encoded cloud-init user data.
VirtioInterface string
Field Deprecated, use virtualizationModel instead. The type of the virtio interface.
VmDeviceModel string
The type of the device model to use.
VmImageRepositoryCredentials Pulumi.AzureNative.NetworkCloud.Outputs.ImageRepositoryCredentialsResponse
The credentials used to login to the image repository that has access to the specified image.
AdminUsername string
The name of the administrator to which the ssh public keys will be added into the authorized keys.
AvailabilityZone string
The cluster availability zone containing this virtual machine.
AzureApiVersion string
The Azure API version of the resource.
BareMetalMachineId string
The resource ID of the bare metal machine that hosts the virtual machine.
CloudServicesNetworkAttachment NetworkAttachmentResponse
The cloud service network that provides platform-level services for the virtual machine.
ClusterId string
The resource ID of the cluster the virtual machine is created for.
CpuCores float64
The number of CPU cores in the virtual machine.
DetailedStatus string
The more detailed status of the virtual machine.
DetailedStatusMessage string
The descriptive message about the current detailed status.
Etag string
Resource ETag.
ExtendedLocation ExtendedLocationResponse
The extended location of the cluster associated with the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
MemorySizeGB float64
The memory size of the virtual machine. Allocations are measured in gibibytes.
Name string
The name of the resource
PowerState string
The power state of the virtual machine.
ProvisioningState string
The provisioning state of the virtual machine.
StorageProfile StorageProfileResponse
The storage profile that specifies size and other parameters about the disks related to the virtual machine.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
VmImage string
The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image.
Volumes []string
The resource IDs of volumes that are attached to the virtual machine.
BootMethod string
Selects the boot method for the virtual machine.
ConsoleExtendedLocation ExtendedLocationResponse
The extended location to use for creation of a VM console resource.
IsolateEmulatorThread string
Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine.
NetworkAttachments []NetworkAttachmentResponse
The list of network attachments to the virtual machine.
NetworkData string
The Base64 encoded cloud-init network data.
PlacementHints []VirtualMachinePlacementHintResponse
The scheduling hints for the virtual machine.
SshPublicKeys []SshPublicKeyResponse
The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername.
Tags map[string]string
Resource tags.
UserData string
The Base64 encoded cloud-init user data.
VirtioInterface string
Field Deprecated, use virtualizationModel instead. The type of the virtio interface.
VmDeviceModel string
The type of the device model to use.
VmImageRepositoryCredentials ImageRepositoryCredentialsResponse
The credentials used to login to the image repository that has access to the specified image.
adminUsername String
The name of the administrator to which the ssh public keys will be added into the authorized keys.
availabilityZone String
The cluster availability zone containing this virtual machine.
azureApiVersion String
The Azure API version of the resource.
bareMetalMachineId String
The resource ID of the bare metal machine that hosts the virtual machine.
cloudServicesNetworkAttachment NetworkAttachmentResponse
The cloud service network that provides platform-level services for the virtual machine.
clusterId String
The resource ID of the cluster the virtual machine is created for.
cpuCores Double
The number of CPU cores in the virtual machine.
detailedStatus String
The more detailed status of the virtual machine.
detailedStatusMessage String
The descriptive message about the current detailed status.
etag String
Resource ETag.
extendedLocation ExtendedLocationResponse
The extended location of the cluster associated with the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
memorySizeGB Double
The memory size of the virtual machine. Allocations are measured in gibibytes.
name String
The name of the resource
powerState String
The power state of the virtual machine.
provisioningState String
The provisioning state of the virtual machine.
storageProfile StorageProfileResponse
The storage profile that specifies size and other parameters about the disks related to the virtual machine.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
vmImage String
The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image.
volumes List<String>
The resource IDs of volumes that are attached to the virtual machine.
bootMethod String
Selects the boot method for the virtual machine.
consoleExtendedLocation ExtendedLocationResponse
The extended location to use for creation of a VM console resource.
isolateEmulatorThread String
Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine.
networkAttachments List<NetworkAttachmentResponse>
The list of network attachments to the virtual machine.
networkData String
The Base64 encoded cloud-init network data.
placementHints List<VirtualMachinePlacementHintResponse>
The scheduling hints for the virtual machine.
sshPublicKeys List<SshPublicKeyResponse>
The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername.
tags Map<String,String>
Resource tags.
userData String
The Base64 encoded cloud-init user data.
virtioInterface String
Field Deprecated, use virtualizationModel instead. The type of the virtio interface.
vmDeviceModel String
The type of the device model to use.
vmImageRepositoryCredentials ImageRepositoryCredentialsResponse
The credentials used to login to the image repository that has access to the specified image.
adminUsername string
The name of the administrator to which the ssh public keys will be added into the authorized keys.
availabilityZone string
The cluster availability zone containing this virtual machine.
azureApiVersion string
The Azure API version of the resource.
bareMetalMachineId string
The resource ID of the bare metal machine that hosts the virtual machine.
cloudServicesNetworkAttachment NetworkAttachmentResponse
The cloud service network that provides platform-level services for the virtual machine.
clusterId string
The resource ID of the cluster the virtual machine is created for.
cpuCores number
The number of CPU cores in the virtual machine.
detailedStatus string
The more detailed status of the virtual machine.
detailedStatusMessage string
The descriptive message about the current detailed status.
etag string
Resource ETag.
extendedLocation ExtendedLocationResponse
The extended location of the cluster associated with the resource.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location string
The geo-location where the resource lives
memorySizeGB number
The memory size of the virtual machine. Allocations are measured in gibibytes.
name string
The name of the resource
powerState string
The power state of the virtual machine.
provisioningState string
The provisioning state of the virtual machine.
storageProfile StorageProfileResponse
The storage profile that specifies size and other parameters about the disks related to the virtual machine.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
vmImage string
The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image.
volumes string[]
The resource IDs of volumes that are attached to the virtual machine.
bootMethod string
Selects the boot method for the virtual machine.
consoleExtendedLocation ExtendedLocationResponse
The extended location to use for creation of a VM console resource.
isolateEmulatorThread string
Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine.
networkAttachments NetworkAttachmentResponse[]
The list of network attachments to the virtual machine.
networkData string
The Base64 encoded cloud-init network data.
placementHints VirtualMachinePlacementHintResponse[]
The scheduling hints for the virtual machine.
sshPublicKeys SshPublicKeyResponse[]
The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername.
tags {[key: string]: string}
Resource tags.
userData string
The Base64 encoded cloud-init user data.
virtioInterface string
Field Deprecated, use virtualizationModel instead. The type of the virtio interface.
vmDeviceModel string
The type of the device model to use.
vmImageRepositoryCredentials ImageRepositoryCredentialsResponse
The credentials used to login to the image repository that has access to the specified image.
admin_username str
The name of the administrator to which the ssh public keys will be added into the authorized keys.
availability_zone str
The cluster availability zone containing this virtual machine.
azure_api_version str
The Azure API version of the resource.
bare_metal_machine_id str
The resource ID of the bare metal machine that hosts the virtual machine.
cloud_services_network_attachment NetworkAttachmentResponse
The cloud service network that provides platform-level services for the virtual machine.
cluster_id str
The resource ID of the cluster the virtual machine is created for.
cpu_cores float
The number of CPU cores in the virtual machine.
detailed_status str
The more detailed status of the virtual machine.
detailed_status_message str
The descriptive message about the current detailed status.
etag str
Resource ETag.
extended_location ExtendedLocationResponse
The extended location of the cluster associated with the resource.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location str
The geo-location where the resource lives
memory_size_gb float
The memory size of the virtual machine. Allocations are measured in gibibytes.
name str
The name of the resource
power_state str
The power state of the virtual machine.
provisioning_state str
The provisioning state of the virtual machine.
storage_profile StorageProfileResponse
The storage profile that specifies size and other parameters about the disks related to the virtual machine.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
vm_image str
The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image.
volumes Sequence[str]
The resource IDs of volumes that are attached to the virtual machine.
boot_method str
Selects the boot method for the virtual machine.
console_extended_location ExtendedLocationResponse
The extended location to use for creation of a VM console resource.
isolate_emulator_thread str
Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine.
network_attachments Sequence[NetworkAttachmentResponse]
The list of network attachments to the virtual machine.
network_data str
The Base64 encoded cloud-init network data.
placement_hints Sequence[VirtualMachinePlacementHintResponse]
The scheduling hints for the virtual machine.
ssh_public_keys Sequence[SshPublicKeyResponse]
The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername.
tags Mapping[str, str]
Resource tags.
user_data str
The Base64 encoded cloud-init user data.
virtio_interface str
Field Deprecated, use virtualizationModel instead. The type of the virtio interface.
vm_device_model str
The type of the device model to use.
vm_image_repository_credentials ImageRepositoryCredentialsResponse
The credentials used to login to the image repository that has access to the specified image.
adminUsername String
The name of the administrator to which the ssh public keys will be added into the authorized keys.
availabilityZone String
The cluster availability zone containing this virtual machine.
azureApiVersion String
The Azure API version of the resource.
bareMetalMachineId String
The resource ID of the bare metal machine that hosts the virtual machine.
cloudServicesNetworkAttachment Property Map
The cloud service network that provides platform-level services for the virtual machine.
clusterId String
The resource ID of the cluster the virtual machine is created for.
cpuCores Number
The number of CPU cores in the virtual machine.
detailedStatus String
The more detailed status of the virtual machine.
detailedStatusMessage String
The descriptive message about the current detailed status.
etag String
Resource ETag.
extendedLocation Property Map
The extended location of the cluster associated with the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
memorySizeGB Number
The memory size of the virtual machine. Allocations are measured in gibibytes.
name String
The name of the resource
powerState String
The power state of the virtual machine.
provisioningState String
The provisioning state of the virtual machine.
storageProfile Property Map
The storage profile that specifies size and other parameters about the disks related to the virtual machine.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
vmImage String
The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image.
volumes List<String>
The resource IDs of volumes that are attached to the virtual machine.
bootMethod String
Selects the boot method for the virtual machine.
consoleExtendedLocation Property Map
The extended location to use for creation of a VM console resource.
isolateEmulatorThread String
Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine.
networkAttachments List<Property Map>
The list of network attachments to the virtual machine.
networkData String
The Base64 encoded cloud-init network data.
placementHints List<Property Map>
The scheduling hints for the virtual machine.
sshPublicKeys List<Property Map>
The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername.
tags Map<String>
Resource tags.
userData String
The Base64 encoded cloud-init user data.
virtioInterface String
Field Deprecated, use virtualizationModel instead. The type of the virtio interface.
vmDeviceModel String
The type of the device model to use.
vmImageRepositoryCredentials Property Map
The credentials used to login to the image repository that has access to the specified image.

Supporting Types

ExtendedLocationResponse

Name This property is required. string
The resource ID of the extended location on which the resource will be created.
Type This property is required. string
The extended location type, for example, CustomLocation.
Name This property is required. string
The resource ID of the extended location on which the resource will be created.
Type This property is required. string
The extended location type, for example, CustomLocation.
name This property is required. String
The resource ID of the extended location on which the resource will be created.
type This property is required. String
The extended location type, for example, CustomLocation.
name This property is required. string
The resource ID of the extended location on which the resource will be created.
type This property is required. string
The extended location type, for example, CustomLocation.
name This property is required. str
The resource ID of the extended location on which the resource will be created.
type This property is required. str
The extended location type, for example, CustomLocation.
name This property is required. String
The resource ID of the extended location on which the resource will be created.
type This property is required. String
The extended location type, for example, CustomLocation.

ImageRepositoryCredentialsResponse

Password This property is required. string
The password or token used to access an image in the target repository.
RegistryUrl This property is required. string
The URL of the authentication server used to validate the repository credentials.
Username This property is required. string
The username used to access an image in the target repository.
Password This property is required. string
The password or token used to access an image in the target repository.
RegistryUrl This property is required. string
The URL of the authentication server used to validate the repository credentials.
Username This property is required. string
The username used to access an image in the target repository.
password This property is required. String
The password or token used to access an image in the target repository.
registryUrl This property is required. String
The URL of the authentication server used to validate the repository credentials.
username This property is required. String
The username used to access an image in the target repository.
password This property is required. string
The password or token used to access an image in the target repository.
registryUrl This property is required. string
The URL of the authentication server used to validate the repository credentials.
username This property is required. string
The username used to access an image in the target repository.
password This property is required. str
The password or token used to access an image in the target repository.
registry_url This property is required. str
The URL of the authentication server used to validate the repository credentials.
username This property is required. str
The username used to access an image in the target repository.
password This property is required. String
The password or token used to access an image in the target repository.
registryUrl This property is required. String
The URL of the authentication server used to validate the repository credentials.
username This property is required. String
The username used to access an image in the target repository.

NetworkAttachmentResponse

AttachedNetworkId This property is required. string
The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources.
IpAllocationMethod This property is required. string
The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value.
MacAddress This property is required. string
The MAC address of the interface for the virtual machine that corresponds to this network attachment.
DefaultGateway string
The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True.
Ipv4Address string

The IPv4 address of the virtual machine.

This field is used only if the attached network has IPAllocationType of IPV4 or DualStack.

If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty.

Ipv6Address string

The IPv6 address of the virtual machine.

This field is used only if the attached network has IPAllocationType of IPV6 or DualStack.

If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty.

NetworkAttachmentName string
The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored.
AttachedNetworkId This property is required. string
The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources.
IpAllocationMethod This property is required. string
The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value.
MacAddress This property is required. string
The MAC address of the interface for the virtual machine that corresponds to this network attachment.
DefaultGateway string
The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True.
Ipv4Address string

The IPv4 address of the virtual machine.

This field is used only if the attached network has IPAllocationType of IPV4 or DualStack.

If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty.

Ipv6Address string

The IPv6 address of the virtual machine.

This field is used only if the attached network has IPAllocationType of IPV6 or DualStack.

If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty.

NetworkAttachmentName string
The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored.
attachedNetworkId This property is required. String
The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources.
ipAllocationMethod This property is required. String
The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value.
macAddress This property is required. String
The MAC address of the interface for the virtual machine that corresponds to this network attachment.
defaultGateway String
The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True.
ipv4Address String

The IPv4 address of the virtual machine.

This field is used only if the attached network has IPAllocationType of IPV4 or DualStack.

If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty.

ipv6Address String

The IPv6 address of the virtual machine.

This field is used only if the attached network has IPAllocationType of IPV6 or DualStack.

If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty.

networkAttachmentName String
The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored.
attachedNetworkId This property is required. string
The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources.
ipAllocationMethod This property is required. string
The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value.
macAddress This property is required. string
The MAC address of the interface for the virtual machine that corresponds to this network attachment.
defaultGateway string
The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True.
ipv4Address string

The IPv4 address of the virtual machine.

This field is used only if the attached network has IPAllocationType of IPV4 or DualStack.

If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty.

ipv6Address string

The IPv6 address of the virtual machine.

This field is used only if the attached network has IPAllocationType of IPV6 or DualStack.

If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty.

networkAttachmentName string
The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored.
attached_network_id This property is required. str
The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources.
ip_allocation_method This property is required. str
The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value.
mac_address This property is required. str
The MAC address of the interface for the virtual machine that corresponds to this network attachment.
default_gateway str
The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True.
ipv4_address str

The IPv4 address of the virtual machine.

This field is used only if the attached network has IPAllocationType of IPV4 or DualStack.

If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty.

ipv6_address str

The IPv6 address of the virtual machine.

This field is used only if the attached network has IPAllocationType of IPV6 or DualStack.

If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty.

network_attachment_name str
The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored.
attachedNetworkId This property is required. String
The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources.
ipAllocationMethod This property is required. String
The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value.
macAddress This property is required. String
The MAC address of the interface for the virtual machine that corresponds to this network attachment.
defaultGateway String
The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True.
ipv4Address String

The IPv4 address of the virtual machine.

This field is used only if the attached network has IPAllocationType of IPV4 or DualStack.

If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty.

ipv6Address String

The IPv6 address of the virtual machine.

This field is used only if the attached network has IPAllocationType of IPV6 or DualStack.

If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty.

networkAttachmentName String
The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored.

OsDiskResponse

DiskSizeGB This property is required. double
The size of the disk. Required if the createOption is Ephemeral. Allocations are measured in gibibytes.
CreateOption string
The strategy for creating the OS disk.
DeleteOption string
The strategy for deleting the OS disk.
DiskSizeGB This property is required. float64
The size of the disk. Required if the createOption is Ephemeral. Allocations are measured in gibibytes.
CreateOption string
The strategy for creating the OS disk.
DeleteOption string
The strategy for deleting the OS disk.
diskSizeGB This property is required. Double
The size of the disk. Required if the createOption is Ephemeral. Allocations are measured in gibibytes.
createOption String
The strategy for creating the OS disk.
deleteOption String
The strategy for deleting the OS disk.
diskSizeGB This property is required. number
The size of the disk. Required if the createOption is Ephemeral. Allocations are measured in gibibytes.
createOption string
The strategy for creating the OS disk.
deleteOption string
The strategy for deleting the OS disk.
disk_size_gb This property is required. float
The size of the disk. Required if the createOption is Ephemeral. Allocations are measured in gibibytes.
create_option str
The strategy for creating the OS disk.
delete_option str
The strategy for deleting the OS disk.
diskSizeGB This property is required. Number
The size of the disk. Required if the createOption is Ephemeral. Allocations are measured in gibibytes.
createOption String
The strategy for creating the OS disk.
deleteOption String
The strategy for deleting the OS disk.

SshPublicKeyResponse

KeyData This property is required. string
The SSH public key data.
KeyData This property is required. string
The SSH public key data.
keyData This property is required. String
The SSH public key data.
keyData This property is required. string
The SSH public key data.
key_data This property is required. str
The SSH public key data.
keyData This property is required. String
The SSH public key data.

StorageProfileResponse

OsDisk This property is required. Pulumi.AzureNative.NetworkCloud.Inputs.OsDiskResponse
The disk to use with this virtual machine.
VolumeAttachments List<string>
The resource IDs of volumes that are requested to be attached to the virtual machine.
OsDisk This property is required. OsDiskResponse
The disk to use with this virtual machine.
VolumeAttachments []string
The resource IDs of volumes that are requested to be attached to the virtual machine.
osDisk This property is required. OsDiskResponse
The disk to use with this virtual machine.
volumeAttachments List<String>
The resource IDs of volumes that are requested to be attached to the virtual machine.
osDisk This property is required. OsDiskResponse
The disk to use with this virtual machine.
volumeAttachments string[]
The resource IDs of volumes that are requested to be attached to the virtual machine.
os_disk This property is required. OsDiskResponse
The disk to use with this virtual machine.
volume_attachments Sequence[str]
The resource IDs of volumes that are requested to be attached to the virtual machine.
osDisk This property is required. Property Map
The disk to use with this virtual machine.
volumeAttachments List<String>
The resource IDs of volumes that are requested to be attached to the virtual machine.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

VirtualMachinePlacementHintResponse

HintType This property is required. string
The specification of whether this hint supports affinity or anti-affinity with the referenced resources.
ResourceId This property is required. string
The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine.
SchedulingExecution This property is required. string
The indicator of whether the hint is a hard or soft requirement during scheduling.
Scope This property is required. string
The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity.
HintType This property is required. string
The specification of whether this hint supports affinity or anti-affinity with the referenced resources.
ResourceId This property is required. string
The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine.
SchedulingExecution This property is required. string
The indicator of whether the hint is a hard or soft requirement during scheduling.
Scope This property is required. string
The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity.
hintType This property is required. String
The specification of whether this hint supports affinity or anti-affinity with the referenced resources.
resourceId This property is required. String
The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine.
schedulingExecution This property is required. String
The indicator of whether the hint is a hard or soft requirement during scheduling.
scope This property is required. String
The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity.
hintType This property is required. string
The specification of whether this hint supports affinity or anti-affinity with the referenced resources.
resourceId This property is required. string
The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine.
schedulingExecution This property is required. string
The indicator of whether the hint is a hard or soft requirement during scheduling.
scope This property is required. string
The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity.
hint_type This property is required. str
The specification of whether this hint supports affinity or anti-affinity with the referenced resources.
resource_id This property is required. str
The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine.
scheduling_execution This property is required. str
The indicator of whether the hint is a hard or soft requirement during scheduling.
scope This property is required. str
The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity.
hintType This property is required. String
The specification of whether this hint supports affinity or anti-affinity with the referenced resources.
resourceId This property is required. String
The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine.
schedulingExecution This property is required. String
The indicator of whether the hint is a hard or soft requirement during scheduling.
scope This property is required. String
The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity.

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.2.0 published on Monday, Apr 14, 2025 by Pulumi