1. Packages
  2. Azure Native v2
  3. API Docs
  4. azurestackhci
  5. getVirtualMachine
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.azurestackhci.getVirtualMachine

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Gets a virtual machine Azure REST API version: 2022-12-15-preview.

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:azurestackhci: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
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
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
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
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
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
Name of the virtual machine

getVirtualMachine Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
Provisioning state of the virtual machine.
Status Pulumi.AzureNative.AzureStackHCI.Outputs.VirtualMachineStatusResponse
The observed state of virtual machines
SystemData Pulumi.AzureNative.AzureStackHCI.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"
VmId string
Unique identifier for the vm resource.
ExtendedLocation Pulumi.AzureNative.AzureStackHCI.Outputs.ExtendedLocationResponse
The extendedLocation of the resource.
GuestAgentProfile Pulumi.AzureNative.AzureStackHCI.Outputs.GuestAgentProfileResponse
Guest agent status properties.
HardwareProfile Pulumi.AzureNative.AzureStackHCI.Outputs.VirtualMachinePropertiesResponseHardwareProfile
HardwareProfile - Specifies the hardware settings for the virtual machine.
Identity Pulumi.AzureNative.AzureStackHCI.Outputs.IdentityResponse
Identity for the resource.
NetworkProfile Pulumi.AzureNative.AzureStackHCI.Outputs.VirtualMachinePropertiesResponseNetworkProfile
NetworkProfile - describes the network configuration the virtual machine
OsProfile Pulumi.AzureNative.AzureStackHCI.Outputs.VirtualMachinePropertiesResponseOsProfile
OsProfile - describes the configuration of the operating system and sets login data
SecurityProfile Pulumi.AzureNative.AzureStackHCI.Outputs.VirtualMachinePropertiesResponseSecurityProfile
SecurityProfile - Specifies the security settings for the virtual machine.
StorageProfile Pulumi.AzureNative.AzureStackHCI.Outputs.VirtualMachinePropertiesResponseStorageProfile
StorageProfile - contains information about the disks and storage information for the virtual machine
Tags Dictionary<string, string>
Resource tags.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
Provisioning state of the virtual machine.
Status VirtualMachineStatusResponse
The observed state of virtual machines
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"
VmId string
Unique identifier for the vm resource.
ExtendedLocation ExtendedLocationResponse
The extendedLocation of the resource.
GuestAgentProfile GuestAgentProfileResponse
Guest agent status properties.
HardwareProfile VirtualMachinePropertiesResponseHardwareProfile
HardwareProfile - Specifies the hardware settings for the virtual machine.
Identity IdentityResponse
Identity for the resource.
NetworkProfile VirtualMachinePropertiesResponseNetworkProfile
NetworkProfile - describes the network configuration the virtual machine
OsProfile VirtualMachinePropertiesResponseOsProfile
OsProfile - describes the configuration of the operating system and sets login data
SecurityProfile VirtualMachinePropertiesResponseSecurityProfile
SecurityProfile - Specifies the security settings for the virtual machine.
StorageProfile VirtualMachinePropertiesResponseStorageProfile
StorageProfile - contains information about the disks and storage information for the virtual machine
Tags map[string]string
Resource tags.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
Provisioning state of the virtual machine.
status VirtualMachineStatusResponse
The observed state of virtual machines
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"
vmId String
Unique identifier for the vm resource.
extendedLocation ExtendedLocationResponse
The extendedLocation of the resource.
guestAgentProfile GuestAgentProfileResponse
Guest agent status properties.
hardwareProfile VirtualMachinePropertiesResponseHardwareProfile
HardwareProfile - Specifies the hardware settings for the virtual machine.
identity IdentityResponse
Identity for the resource.
networkProfile VirtualMachinePropertiesResponseNetworkProfile
NetworkProfile - describes the network configuration the virtual machine
osProfile VirtualMachinePropertiesResponseOsProfile
OsProfile - describes the configuration of the operating system and sets login data
securityProfile VirtualMachinePropertiesResponseSecurityProfile
SecurityProfile - Specifies the security settings for the virtual machine.
storageProfile VirtualMachinePropertiesResponseStorageProfile
StorageProfile - contains information about the disks and storage information for the virtual machine
tags Map<String,String>
Resource tags.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string
The geo-location where the resource lives
name string
The name of the resource
provisioningState string
Provisioning state of the virtual machine.
status VirtualMachineStatusResponse
The observed state of virtual machines
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"
vmId string
Unique identifier for the vm resource.
extendedLocation ExtendedLocationResponse
The extendedLocation of the resource.
guestAgentProfile GuestAgentProfileResponse
Guest agent status properties.
hardwareProfile VirtualMachinePropertiesResponseHardwareProfile
HardwareProfile - Specifies the hardware settings for the virtual machine.
identity IdentityResponse
Identity for the resource.
networkProfile VirtualMachinePropertiesResponseNetworkProfile
NetworkProfile - describes the network configuration the virtual machine
osProfile VirtualMachinePropertiesResponseOsProfile
OsProfile - describes the configuration of the operating system and sets login data
securityProfile VirtualMachinePropertiesResponseSecurityProfile
SecurityProfile - Specifies the security settings for the virtual machine.
storageProfile VirtualMachinePropertiesResponseStorageProfile
StorageProfile - contains information about the disks and storage information for the virtual machine
tags {[key: string]: string}
Resource tags.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str
The geo-location where the resource lives
name str
The name of the resource
provisioning_state str
Provisioning state of the virtual machine.
status VirtualMachineStatusResponse
The observed state of virtual machines
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_id str
Unique identifier for the vm resource.
extended_location ExtendedLocationResponse
The extendedLocation of the resource.
guest_agent_profile GuestAgentProfileResponse
Guest agent status properties.
hardware_profile VirtualMachinePropertiesResponseHardwareProfile
HardwareProfile - Specifies the hardware settings for the virtual machine.
identity IdentityResponse
Identity for the resource.
network_profile VirtualMachinePropertiesResponseNetworkProfile
NetworkProfile - describes the network configuration the virtual machine
os_profile VirtualMachinePropertiesResponseOsProfile
OsProfile - describes the configuration of the operating system and sets login data
security_profile VirtualMachinePropertiesResponseSecurityProfile
SecurityProfile - Specifies the security settings for the virtual machine.
storage_profile VirtualMachinePropertiesResponseStorageProfile
StorageProfile - contains information about the disks and storage information for the virtual machine
tags Mapping[str, str]
Resource tags.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
Provisioning state of the virtual machine.
status Property Map
The observed state of virtual machines
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"
vmId String
Unique identifier for the vm resource.
extendedLocation Property Map
The extendedLocation of the resource.
guestAgentProfile Property Map
Guest agent status properties.
hardwareProfile Property Map
HardwareProfile - Specifies the hardware settings for the virtual machine.
identity Property Map
Identity for the resource.
networkProfile Property Map
NetworkProfile - describes the network configuration the virtual machine
osProfile Property Map
OsProfile - describes the configuration of the operating system and sets login data
securityProfile Property Map
SecurityProfile - Specifies the security settings for the virtual machine.
storageProfile Property Map
StorageProfile - contains information about the disks and storage information for the virtual machine
tags Map<String>
Resource tags.

Supporting Types

ErrorAdditionalInfoResponse

Info This property is required. object
The additional info.
Type This property is required. string
The additional info type.
Info This property is required. interface{}
The additional info.
Type This property is required. string
The additional info type.
info This property is required. Object
The additional info.
type This property is required. String
The additional info type.
info This property is required. any
The additional info.
type This property is required. string
The additional info type.
info This property is required. Any
The additional info.
type This property is required. str
The additional info type.
info This property is required. Any
The additional info.
type This property is required. String
The additional info type.

ErrorDetailResponse

AdditionalInfo This property is required. List<Pulumi.AzureNative.AzureStackHCI.Inputs.ErrorAdditionalInfoResponse>
The error additional info.
Code This property is required. string
The error code.
Details This property is required. List<Pulumi.AzureNative.AzureStackHCI.Inputs.ErrorDetailResponse>
The error details.
Message This property is required. string
The error message.
Target This property is required. string
The error target.
AdditionalInfo This property is required. []ErrorAdditionalInfoResponse
The error additional info.
Code This property is required. string
The error code.
Details This property is required. []ErrorDetailResponse
The error details.
Message This property is required. string
The error message.
Target This property is required. string
The error target.
additionalInfo This property is required. List<ErrorAdditionalInfoResponse>
The error additional info.
code This property is required. String
The error code.
details This property is required. List<ErrorDetailResponse>
The error details.
message This property is required. String
The error message.
target This property is required. String
The error target.
additionalInfo This property is required. ErrorAdditionalInfoResponse[]
The error additional info.
code This property is required. string
The error code.
details This property is required. ErrorDetailResponse[]
The error details.
message This property is required. string
The error message.
target This property is required. string
The error target.
additional_info This property is required. Sequence[ErrorAdditionalInfoResponse]
The error additional info.
code This property is required. str
The error code.
details This property is required. Sequence[ErrorDetailResponse]
The error details.
message This property is required. str
The error message.
target This property is required. str
The error target.
additionalInfo This property is required. List<Property Map>
The error additional info.
code This property is required. String
The error code.
details This property is required. List<Property Map>
The error details.
message This property is required. String
The error message.
target This property is required. String
The error target.

ExtendedLocationResponse

Name string
The name of the extended location.
Type string
The type of the extended location.
Name string
The name of the extended location.
Type string
The type of the extended location.
name String
The name of the extended location.
type String
The type of the extended location.
name string
The name of the extended location.
type string
The type of the extended location.
name str
The name of the extended location.
type str
The type of the extended location.
name String
The name of the extended location.
type String
The type of the extended location.

GuestAgentProfileResponse

AgentVersion This property is required. string
The hybrid machine agent full version.
ErrorDetails This property is required. List<Pulumi.AzureNative.AzureStackHCI.Inputs.ErrorDetailResponse>
Details about the error state.
LastStatusChange This property is required. string
The time of the last status change.
Status This property is required. string
The status of the hybrid machine agent.
VmUuid This property is required. string
Specifies the VM's unique SMBIOS ID.
AgentVersion This property is required. string
The hybrid machine agent full version.
ErrorDetails This property is required. []ErrorDetailResponse
Details about the error state.
LastStatusChange This property is required. string
The time of the last status change.
Status This property is required. string
The status of the hybrid machine agent.
VmUuid This property is required. string
Specifies the VM's unique SMBIOS ID.
agentVersion This property is required. String
The hybrid machine agent full version.
errorDetails This property is required. List<ErrorDetailResponse>
Details about the error state.
lastStatusChange This property is required. String
The time of the last status change.
status This property is required. String
The status of the hybrid machine agent.
vmUuid This property is required. String
Specifies the VM's unique SMBIOS ID.
agentVersion This property is required. string
The hybrid machine agent full version.
errorDetails This property is required. ErrorDetailResponse[]
Details about the error state.
lastStatusChange This property is required. string
The time of the last status change.
status This property is required. string
The status of the hybrid machine agent.
vmUuid This property is required. string
Specifies the VM's unique SMBIOS ID.
agent_version This property is required. str
The hybrid machine agent full version.
error_details This property is required. Sequence[ErrorDetailResponse]
Details about the error state.
last_status_change This property is required. str
The time of the last status change.
status This property is required. str
The status of the hybrid machine agent.
vm_uuid This property is required. str
Specifies the VM's unique SMBIOS ID.
agentVersion This property is required. String
The hybrid machine agent full version.
errorDetails This property is required. List<Property Map>
Details about the error state.
lastStatusChange This property is required. String
The time of the last status change.
status This property is required. String
The status of the hybrid machine agent.
vmUuid This property is required. String
Specifies the VM's unique SMBIOS ID.

IdentityResponse

PrincipalId This property is required. string
The principal ID of resource identity.
TenantId This property is required. string
The tenant ID of resource.
Type string
The identity type.
PrincipalId This property is required. string
The principal ID of resource identity.
TenantId This property is required. string
The tenant ID of resource.
Type string
The identity type.
principalId This property is required. String
The principal ID of resource identity.
tenantId This property is required. String
The tenant ID of resource.
type String
The identity type.
principalId This property is required. string
The principal ID of resource identity.
tenantId This property is required. string
The tenant ID of resource.
type string
The identity type.
principal_id This property is required. str
The principal ID of resource identity.
tenant_id This property is required. str
The tenant ID of resource.
type str
The identity type.
principalId This property is required. String
The principal ID of resource identity.
tenantId This property is required. String
The tenant ID of resource.
type String
The identity type.

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.

VirtualMachinePropertiesResponseDataDisks

Id string
Resource ID of the data disk
Id string
Resource ID of the data disk
id String
Resource ID of the data disk
id string
Resource ID of the data disk
id str
Resource ID of the data disk
id String
Resource ID of the data disk

VirtualMachinePropertiesResponseDynamicMemoryConfig

MaximumMemoryMB double
MinimumMemoryMB double
TargetMemoryBuffer int
Defines the amount of extra memory that should be reserved for a virtual machine at runtime, as a percentage of the total memory that the virtual machine is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000.
MaximumMemoryMB float64
MinimumMemoryMB float64
TargetMemoryBuffer int
Defines the amount of extra memory that should be reserved for a virtual machine at runtime, as a percentage of the total memory that the virtual machine is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000.
maximumMemoryMB Double
minimumMemoryMB Double
targetMemoryBuffer Integer
Defines the amount of extra memory that should be reserved for a virtual machine at runtime, as a percentage of the total memory that the virtual machine is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000.
maximumMemoryMB number
minimumMemoryMB number
targetMemoryBuffer number
Defines the amount of extra memory that should be reserved for a virtual machine at runtime, as a percentage of the total memory that the virtual machine is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000.
maximum_memory_mb float
minimum_memory_mb float
target_memory_buffer int
Defines the amount of extra memory that should be reserved for a virtual machine at runtime, as a percentage of the total memory that the virtual machine is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000.
maximumMemoryMB Number
minimumMemoryMB Number
targetMemoryBuffer Number
Defines the amount of extra memory that should be reserved for a virtual machine at runtime, as a percentage of the total memory that the virtual machine is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000.

VirtualMachinePropertiesResponseHardwareProfile

DynamicMemoryConfig Pulumi.AzureNative.AzureStackHCI.Inputs.VirtualMachinePropertiesResponseDynamicMemoryConfig
MemoryMB double
RAM in MB for the virtual machine
Processors int
number of processors for the virtual machine
VmSize string
DynamicMemoryConfig VirtualMachinePropertiesResponseDynamicMemoryConfig
MemoryMB float64
RAM in MB for the virtual machine
Processors int
number of processors for the virtual machine
VmSize string
dynamicMemoryConfig VirtualMachinePropertiesResponseDynamicMemoryConfig
memoryMB Double
RAM in MB for the virtual machine
processors Integer
number of processors for the virtual machine
vmSize String
dynamicMemoryConfig VirtualMachinePropertiesResponseDynamicMemoryConfig
memoryMB number
RAM in MB for the virtual machine
processors number
number of processors for the virtual machine
vmSize string
dynamic_memory_config VirtualMachinePropertiesResponseDynamicMemoryConfig
memory_mb float
RAM in MB for the virtual machine
processors int
number of processors for the virtual machine
vm_size str
dynamicMemoryConfig Property Map
memoryMB Number
RAM in MB for the virtual machine
processors Number
number of processors for the virtual machine
vmSize String

VirtualMachinePropertiesResponseImageReference

Id string
Resource ID of the image
Id string
Resource ID of the image
id String
Resource ID of the image
id string
Resource ID of the image
id str
Resource ID of the image
id String
Resource ID of the image

VirtualMachinePropertiesResponseLinuxConfiguration

DisablePasswordAuthentication bool
DisablePasswordAuthentication - whether password authentication should be disabled
ProvisionVMAgent bool
Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine creation process.
Ssh Pulumi.AzureNative.AzureStackHCI.Inputs.VirtualMachinePropertiesResponseSsh
SSH - contains settings related to ssh configuration
DisablePasswordAuthentication bool
DisablePasswordAuthentication - whether password authentication should be disabled
ProvisionVMAgent bool
Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine creation process.
Ssh VirtualMachinePropertiesResponseSsh
SSH - contains settings related to ssh configuration
disablePasswordAuthentication Boolean
DisablePasswordAuthentication - whether password authentication should be disabled
provisionVMAgent Boolean
Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine creation process.
ssh VirtualMachinePropertiesResponseSsh
SSH - contains settings related to ssh configuration
disablePasswordAuthentication boolean
DisablePasswordAuthentication - whether password authentication should be disabled
provisionVMAgent boolean
Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine creation process.
ssh VirtualMachinePropertiesResponseSsh
SSH - contains settings related to ssh configuration
disable_password_authentication bool
DisablePasswordAuthentication - whether password authentication should be disabled
provision_vm_agent bool
Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine creation process.
ssh VirtualMachinePropertiesResponseSsh
SSH - contains settings related to ssh configuration
disablePasswordAuthentication Boolean
DisablePasswordAuthentication - whether password authentication should be disabled
provisionVMAgent Boolean
Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine creation process.
ssh Property Map
SSH - contains settings related to ssh configuration

VirtualMachinePropertiesResponseNetworkInterfaces

Id string
ID - Resource Id of the network interface
Id string
ID - Resource Id of the network interface
id String
ID - Resource Id of the network interface
id string
ID - Resource Id of the network interface
id str
ID - Resource Id of the network interface
id String
ID - Resource Id of the network interface

VirtualMachinePropertiesResponseNetworkProfile

NetworkInterfaces List<Pulumi.AzureNative.AzureStackHCI.Inputs.VirtualMachinePropertiesResponseNetworkInterfaces>
NetworkInterfaces - list of network interfaces to be attached to the virtual machine
NetworkInterfaces []VirtualMachinePropertiesResponseNetworkInterfaces
NetworkInterfaces - list of network interfaces to be attached to the virtual machine
networkInterfaces List<VirtualMachinePropertiesResponseNetworkInterfaces>
NetworkInterfaces - list of network interfaces to be attached to the virtual machine
networkInterfaces VirtualMachinePropertiesResponseNetworkInterfaces[]
NetworkInterfaces - list of network interfaces to be attached to the virtual machine
network_interfaces Sequence[VirtualMachinePropertiesResponseNetworkInterfaces]
NetworkInterfaces - list of network interfaces to be attached to the virtual machine
networkInterfaces List<Property Map>
NetworkInterfaces - list of network interfaces to be attached to the virtual machine

VirtualMachinePropertiesResponseOsDisk

Id string
Resource ID of the OS disk
Id string
Resource ID of the OS disk
id String
Resource ID of the OS disk
id string
Resource ID of the OS disk
id str
Resource ID of the OS disk
id String
Resource ID of the OS disk

VirtualMachinePropertiesResponseOsProfile

AdminUsername string
AdminUsername - admin username
ComputerName string
ComputerName - name of the compute
LinuxConfiguration Pulumi.AzureNative.AzureStackHCI.Inputs.VirtualMachinePropertiesResponseLinuxConfiguration
LinuxConfiguration - linux specific configuration values for the virtual machine
OsType string
OsType - string specifying whether the OS is Linux or Windows
WindowsConfiguration Pulumi.AzureNative.AzureStackHCI.Inputs.VirtualMachinePropertiesResponseWindowsConfiguration
Windows Configuration for the virtual machine
AdminUsername string
AdminUsername - admin username
ComputerName string
ComputerName - name of the compute
LinuxConfiguration VirtualMachinePropertiesResponseLinuxConfiguration
LinuxConfiguration - linux specific configuration values for the virtual machine
OsType string
OsType - string specifying whether the OS is Linux or Windows
WindowsConfiguration VirtualMachinePropertiesResponseWindowsConfiguration
Windows Configuration for the virtual machine
adminUsername String
AdminUsername - admin username
computerName String
ComputerName - name of the compute
linuxConfiguration VirtualMachinePropertiesResponseLinuxConfiguration
LinuxConfiguration - linux specific configuration values for the virtual machine
osType String
OsType - string specifying whether the OS is Linux or Windows
windowsConfiguration VirtualMachinePropertiesResponseWindowsConfiguration
Windows Configuration for the virtual machine
adminUsername string
AdminUsername - admin username
computerName string
ComputerName - name of the compute
linuxConfiguration VirtualMachinePropertiesResponseLinuxConfiguration
LinuxConfiguration - linux specific configuration values for the virtual machine
osType string
OsType - string specifying whether the OS is Linux or Windows
windowsConfiguration VirtualMachinePropertiesResponseWindowsConfiguration
Windows Configuration for the virtual machine
admin_username str
AdminUsername - admin username
computer_name str
ComputerName - name of the compute
linux_configuration VirtualMachinePropertiesResponseLinuxConfiguration
LinuxConfiguration - linux specific configuration values for the virtual machine
os_type str
OsType - string specifying whether the OS is Linux or Windows
windows_configuration VirtualMachinePropertiesResponseWindowsConfiguration
Windows Configuration for the virtual machine
adminUsername String
AdminUsername - admin username
computerName String
ComputerName - name of the compute
linuxConfiguration Property Map
LinuxConfiguration - linux specific configuration values for the virtual machine
osType String
OsType - string specifying whether the OS is Linux or Windows
windowsConfiguration Property Map
Windows Configuration for the virtual machine

VirtualMachinePropertiesResponsePublicKeys

KeyData string
KeyData - SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see Create SSH keys on Linux and Mac for Li nux VMs in Azure.
Path string
Path - Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys
KeyData string
KeyData - SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see Create SSH keys on Linux and Mac for Li nux VMs in Azure.
Path string
Path - Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys
keyData String
KeyData - SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see Create SSH keys on Linux and Mac for Li nux VMs in Azure.
path String
Path - Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys
keyData string
KeyData - SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see Create SSH keys on Linux and Mac for Li nux VMs in Azure.
path string
Path - Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys
key_data str
KeyData - SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see Create SSH keys on Linux and Mac for Li nux VMs in Azure.
path str
Path - Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys
keyData String
KeyData - SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see Create SSH keys on Linux and Mac for Li nux VMs in Azure.
path String
Path - Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys

VirtualMachinePropertiesResponsePublicKeysPublicKeys

KeyData string
KeyData - SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see Create SSH keys on Linux and Mac for Li nux VMs in Azure.
Path string
Path - Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys
KeyData string
KeyData - SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see Create SSH keys on Linux and Mac for Li nux VMs in Azure.
Path string
Path - Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys
keyData String
KeyData - SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see Create SSH keys on Linux and Mac for Li nux VMs in Azure.
path String
Path - Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys
keyData string
KeyData - SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see Create SSH keys on Linux and Mac for Li nux VMs in Azure.
path string
Path - Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys
key_data str
KeyData - SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see Create SSH keys on Linux and Mac for Li nux VMs in Azure.
path str
Path - Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys
keyData String
KeyData - SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see Create SSH keys on Linux and Mac for Li nux VMs in Azure.
path String
Path - Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys

VirtualMachinePropertiesResponseSecurityProfile

VirtualMachinePropertiesResponseSsh

PublicKeys List<Pulumi.AzureNative.AzureStackHCI.Inputs.VirtualMachinePropertiesResponsePublicKeys>
PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
PublicKeys []VirtualMachinePropertiesResponsePublicKeys
PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
publicKeys List<VirtualMachinePropertiesResponsePublicKeys>
PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
publicKeys VirtualMachinePropertiesResponsePublicKeys[]
PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
public_keys Sequence[VirtualMachinePropertiesResponsePublicKeys]
PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
publicKeys List<Property Map>
PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.

VirtualMachinePropertiesResponseSshSsh

PublicKeys List<Pulumi.AzureNative.AzureStackHCI.Inputs.VirtualMachinePropertiesResponsePublicKeysPublicKeys>
PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
PublicKeys []VirtualMachinePropertiesResponsePublicKeysPublicKeys
PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
publicKeys List<VirtualMachinePropertiesResponsePublicKeysPublicKeys>
PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
publicKeys VirtualMachinePropertiesResponsePublicKeysPublicKeys[]
PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
public_keys Sequence[VirtualMachinePropertiesResponsePublicKeysPublicKeys]
PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
publicKeys List<Property Map>
PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.

VirtualMachinePropertiesResponseStorageProfile

DataDisks []VirtualMachinePropertiesResponseDataDisks
adds data disks to the virtual machine
ImageReference VirtualMachinePropertiesResponseImageReference
Which Image to use for the virtual machine
OsDisk VirtualMachinePropertiesResponseOsDisk
VHD to attach as OS disk
VmConfigStoragePathId string
Id of the storage container that hosts the VM configuration file
dataDisks List<VirtualMachinePropertiesResponseDataDisks>
adds data disks to the virtual machine
imageReference VirtualMachinePropertiesResponseImageReference
Which Image to use for the virtual machine
osDisk VirtualMachinePropertiesResponseOsDisk
VHD to attach as OS disk
vmConfigStoragePathId String
Id of the storage container that hosts the VM configuration file
dataDisks VirtualMachinePropertiesResponseDataDisks[]
adds data disks to the virtual machine
imageReference VirtualMachinePropertiesResponseImageReference
Which Image to use for the virtual machine
osDisk VirtualMachinePropertiesResponseOsDisk
VHD to attach as OS disk
vmConfigStoragePathId string
Id of the storage container that hosts the VM configuration file
data_disks Sequence[VirtualMachinePropertiesResponseDataDisks]
adds data disks to the virtual machine
image_reference VirtualMachinePropertiesResponseImageReference
Which Image to use for the virtual machine
os_disk VirtualMachinePropertiesResponseOsDisk
VHD to attach as OS disk
vm_config_storage_path_id str
Id of the storage container that hosts the VM configuration file
dataDisks List<Property Map>
adds data disks to the virtual machine
imageReference Property Map
Which Image to use for the virtual machine
osDisk Property Map
VHD to attach as OS disk
vmConfigStoragePathId String
Id of the storage container that hosts the VM configuration file

VirtualMachinePropertiesResponseUefiSettings

SecureBootEnabled bool
Specifies whether secure boot should be enabled on the virtual machine.
SecureBootEnabled bool
Specifies whether secure boot should be enabled on the virtual machine.
secureBootEnabled Boolean
Specifies whether secure boot should be enabled on the virtual machine.
secureBootEnabled boolean
Specifies whether secure boot should be enabled on the virtual machine.
secure_boot_enabled bool
Specifies whether secure boot should be enabled on the virtual machine.
secureBootEnabled Boolean
Specifies whether secure boot should be enabled on the virtual machine.

VirtualMachinePropertiesResponseWindowsConfiguration

EnableAutomaticUpdates bool
Whether to EnableAutomaticUpdates on the machine
ProvisionVMAgent bool
Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine creation process.
Ssh Pulumi.AzureNative.AzureStackHCI.Inputs.VirtualMachinePropertiesResponseSshSsh
SSH Configuration
TimeZone string
TimeZone for the virtual machine
EnableAutomaticUpdates bool
Whether to EnableAutomaticUpdates on the machine
ProvisionVMAgent bool
Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine creation process.
Ssh VirtualMachinePropertiesResponseSshSsh
SSH Configuration
TimeZone string
TimeZone for the virtual machine
enableAutomaticUpdates Boolean
Whether to EnableAutomaticUpdates on the machine
provisionVMAgent Boolean
Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine creation process.
ssh VirtualMachinePropertiesResponseSshSsh
SSH Configuration
timeZone String
TimeZone for the virtual machine
enableAutomaticUpdates boolean
Whether to EnableAutomaticUpdates on the machine
provisionVMAgent boolean
Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine creation process.
ssh VirtualMachinePropertiesResponseSshSsh
SSH Configuration
timeZone string
TimeZone for the virtual machine
enable_automatic_updates bool
Whether to EnableAutomaticUpdates on the machine
provision_vm_agent bool
Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine creation process.
ssh VirtualMachinePropertiesResponseSshSsh
SSH Configuration
time_zone str
TimeZone for the virtual machine
enableAutomaticUpdates Boolean
Whether to EnableAutomaticUpdates on the machine
provisionVMAgent Boolean
Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine creation process.
ssh Property Map
SSH Configuration
timeZone String
TimeZone for the virtual machine

VirtualMachineStatusResponse

ErrorCode string
VirtualMachine provisioning error code
ErrorMessage string
Descriptive error message
PowerState string
The power state of the virtual machine
ProvisioningStatus Pulumi.AzureNative.AzureStackHCI.Inputs.VirtualMachineStatusResponseProvisioningStatus
ErrorCode string
VirtualMachine provisioning error code
ErrorMessage string
Descriptive error message
PowerState string
The power state of the virtual machine
ProvisioningStatus VirtualMachineStatusResponseProvisioningStatus
errorCode String
VirtualMachine provisioning error code
errorMessage String
Descriptive error message
powerState String
The power state of the virtual machine
provisioningStatus VirtualMachineStatusResponseProvisioningStatus
errorCode string
VirtualMachine provisioning error code
errorMessage string
Descriptive error message
powerState string
The power state of the virtual machine
provisioningStatus VirtualMachineStatusResponseProvisioningStatus
error_code str
VirtualMachine provisioning error code
error_message str
Descriptive error message
power_state str
The power state of the virtual machine
provisioning_status VirtualMachineStatusResponseProvisioningStatus
errorCode String
VirtualMachine provisioning error code
errorMessage String
Descriptive error message
powerState String
The power state of the virtual machine
provisioningStatus Property Map

VirtualMachineStatusResponseProvisioningStatus

OperationId string
The ID of the operation performed on the virtual machine
Status string
The status of the operation performed on the virtual machine [Succeeded, Failed, InProgress]
OperationId string
The ID of the operation performed on the virtual machine
Status string
The status of the operation performed on the virtual machine [Succeeded, Failed, InProgress]
operationId String
The ID of the operation performed on the virtual machine
status String
The status of the operation performed on the virtual machine [Succeeded, Failed, InProgress]
operationId string
The ID of the operation performed on the virtual machine
status string
The status of the operation performed on the virtual machine [Succeeded, Failed, InProgress]
operation_id str
The ID of the operation performed on the virtual machine
status str
The status of the operation performed on the virtual machine [Succeeded, Failed, InProgress]
operationId String
The ID of the operation performed on the virtual machine
status String
The status of the operation performed on the virtual machine [Succeeded, Failed, InProgress]

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi