This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
azure-native.azurestackhci.getVirtualMachine
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 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>def get_virtual_machine(resource_group_name: Optional[str] = None,
                        virtual_machine_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetVirtualMachineResult
def get_virtual_machine_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                        virtual_machine_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetVirtualMachineResult]func LookupVirtualMachine(ctx *Context, args *LookupVirtualMachineArgs, opts ...InvokeOption) (*LookupVirtualMachineResult, error)
func LookupVirtualMachineOutput(ctx *Context, args *LookupVirtualMachineOutputArgs, opts ...InvokeOption) LookupVirtualMachineResultOutput> Note: This function is named LookupVirtualMachine in the Go SDK.
public static class GetVirtualMachine 
{
    public static Task<GetVirtualMachineResult> InvokeAsync(GetVirtualMachineArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualMachineResult> Invoke(GetVirtualMachineInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetVirtualMachineResult> getVirtualMachine(GetVirtualMachineArgs args, InvokeOptions options)
public static Output<GetVirtualMachineResult> getVirtualMachine(GetVirtualMachineArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:azurestackhci:getVirtualMachine
  arguments:
    # arguments dictionaryThe following arguments are supported:
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- VirtualMachine stringName 
- Name of the virtual machine
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- VirtualMachine stringName 
- Name of the virtual machine
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- virtualMachine StringName 
- Name of the virtual machine
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- virtualMachine stringName 
- Name of the virtual machine
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- virtual_machine_ strname 
- Name of the virtual machine
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- virtualMachine StringName 
- 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.Azure Native. Azure Stack HCI. Outputs. Virtual Machine Status Response 
- The observed state of virtual machines
- SystemData Pulumi.Azure Native. Azure Stack HCI. Outputs. System Data Response 
- 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.Azure Native. Azure Stack HCI. Outputs. Extended Location Response 
- The extendedLocation of the resource.
- GuestAgent Pulumi.Profile Azure Native. Azure Stack HCI. Outputs. Guest Agent Profile Response 
- Guest agent status properties.
- HardwareProfile Pulumi.Azure Native. Azure Stack HCI. Outputs. Virtual Machine Properties Response Hardware Profile 
- HardwareProfile - Specifies the hardware settings for the virtual machine.
- Identity
Pulumi.Azure Native. Azure Stack HCI. Outputs. Identity Response 
- Identity for the resource.
- NetworkProfile Pulumi.Azure Native. Azure Stack HCI. Outputs. Virtual Machine Properties Response Network Profile 
- NetworkProfile - describes the network configuration the virtual machine
- OsProfile Pulumi.Azure Native. Azure Stack HCI. Outputs. Virtual Machine Properties Response Os Profile 
- OsProfile - describes the configuration of the operating system and sets login data
- SecurityProfile Pulumi.Azure Native. Azure Stack HCI. Outputs. Virtual Machine Properties Response Security Profile 
- SecurityProfile - Specifies the security settings for the virtual machine.
- StorageProfile Pulumi.Azure Native. Azure Stack HCI. Outputs. Virtual Machine Properties Response Storage Profile 
- StorageProfile - contains information about the disks and storage information for the virtual machine
- 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
VirtualMachine Status Response 
- The observed state of virtual machines
- SystemData SystemData Response 
- 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 ExtendedLocation Response 
- The extendedLocation of the resource.
- GuestAgent GuestProfile Agent Profile Response 
- Guest agent status properties.
- HardwareProfile VirtualMachine Properties Response Hardware Profile 
- HardwareProfile - Specifies the hardware settings for the virtual machine.
- Identity
IdentityResponse 
- Identity for the resource.
- NetworkProfile VirtualMachine Properties Response Network Profile 
- NetworkProfile - describes the network configuration the virtual machine
- OsProfile VirtualMachine Properties Response Os Profile 
- OsProfile - describes the configuration of the operating system and sets login data
- SecurityProfile VirtualMachine Properties Response Security Profile 
- SecurityProfile - Specifies the security settings for the virtual machine.
- StorageProfile VirtualMachine Properties Response Storage Profile 
- StorageProfile - contains information about the disks and storage information for the virtual machine
- 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
VirtualMachine Status Response 
- The observed state of virtual machines
- systemData SystemData Response 
- 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 ExtendedLocation Response 
- The extendedLocation of the resource.
- guestAgent GuestProfile Agent Profile Response 
- Guest agent status properties.
- hardwareProfile VirtualMachine Properties Response Hardware Profile 
- HardwareProfile - Specifies the hardware settings for the virtual machine.
- identity
IdentityResponse 
- Identity for the resource.
- networkProfile VirtualMachine Properties Response Network Profile 
- NetworkProfile - describes the network configuration the virtual machine
- osProfile VirtualMachine Properties Response Os Profile 
- OsProfile - describes the configuration of the operating system and sets login data
- securityProfile VirtualMachine Properties Response Security Profile 
- SecurityProfile - Specifies the security settings for the virtual machine.
- storageProfile VirtualMachine Properties Response Storage Profile 
- StorageProfile - contains information about the disks and storage information for the virtual machine
- 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
VirtualMachine Status Response 
- The observed state of virtual machines
- systemData SystemData Response 
- 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 ExtendedLocation Response 
- The extendedLocation of the resource.
- guestAgent GuestProfile Agent Profile Response 
- Guest agent status properties.
- hardwareProfile VirtualMachine Properties Response Hardware Profile 
- HardwareProfile - Specifies the hardware settings for the virtual machine.
- identity
IdentityResponse 
- Identity for the resource.
- networkProfile VirtualMachine Properties Response Network Profile 
- NetworkProfile - describes the network configuration the virtual machine
- osProfile VirtualMachine Properties Response Os Profile 
- OsProfile - describes the configuration of the operating system and sets login data
- securityProfile VirtualMachine Properties Response Security Profile 
- SecurityProfile - Specifies the security settings for the virtual machine.
- storageProfile VirtualMachine Properties Response Storage Profile 
- StorageProfile - contains information about the disks and storage information for the virtual machine
- {[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
VirtualMachine Status Response 
- The observed state of virtual machines
- system_data SystemData Response 
- 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 ExtendedLocation Response 
- The extendedLocation of the resource.
- guest_agent_ Guestprofile Agent Profile Response 
- Guest agent status properties.
- hardware_profile VirtualMachine Properties Response Hardware Profile 
- HardwareProfile - Specifies the hardware settings for the virtual machine.
- identity
IdentityResponse 
- Identity for the resource.
- network_profile VirtualMachine Properties Response Network Profile 
- NetworkProfile - describes the network configuration the virtual machine
- os_profile VirtualMachine Properties Response Os Profile 
- OsProfile - describes the configuration of the operating system and sets login data
- security_profile VirtualMachine Properties Response Security Profile 
- SecurityProfile - Specifies the security settings for the virtual machine.
- storage_profile VirtualMachine Properties Response Storage Profile 
- StorageProfile - contains information about the disks and storage information for the virtual machine
- 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.
- guestAgent Property MapProfile 
- 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
- Map<String>
- Resource tags.
Supporting Types
ErrorAdditionalInfoResponse   
ErrorDetailResponse  
- AdditionalInfo List<Pulumi.Azure Native. Azure Stack HCI. Inputs. Error Additional Info Response> 
- The error additional info.
- Code string
- The error code.
- Details
List<Pulumi.Azure Native. Azure Stack HCI. Inputs. Error Detail Response> 
- The error details.
- Message string
- The error message.
- Target string
- The error target.
- AdditionalInfo []ErrorAdditional Info Response 
- The error additional info.
- Code string
- The error code.
- Details
[]ErrorDetail Response 
- The error details.
- Message string
- The error message.
- Target string
- The error target.
- additionalInfo List<ErrorAdditional Info Response> 
- The error additional info.
- code String
- The error code.
- details
List<ErrorDetail Response> 
- The error details.
- message String
- The error message.
- target String
- The error target.
- additionalInfo ErrorAdditional Info Response[] 
- The error additional info.
- code string
- The error code.
- details
ErrorDetail Response[] 
- The error details.
- message string
- The error message.
- target string
- The error target.
- additional_info Sequence[ErrorAdditional Info Response] 
- The error additional info.
- code str
- The error code.
- details
Sequence[ErrorDetail Response] 
- The error details.
- message str
- The error message.
- target str
- The error target.
- additionalInfo List<Property Map>
- The error additional info.
- code String
- The error code.
- details List<Property Map>
- The error details.
- message String
- The error message.
- target String
- The error target.
ExtendedLocationResponse  
GuestAgentProfileResponse   
- AgentVersion string
- The hybrid machine agent full version.
- ErrorDetails List<Pulumi.Azure Native. Azure Stack HCI. Inputs. Error Detail Response> 
- Details about the error state.
- LastStatus stringChange 
- The time of the last status change.
- Status string
- The status of the hybrid machine agent.
- VmUuid string
- Specifies the VM's unique SMBIOS ID.
- AgentVersion string
- The hybrid machine agent full version.
- ErrorDetails []ErrorDetail Response 
- Details about the error state.
- LastStatus stringChange 
- The time of the last status change.
- Status string
- The status of the hybrid machine agent.
- VmUuid string
- Specifies the VM's unique SMBIOS ID.
- agentVersion String
- The hybrid machine agent full version.
- errorDetails List<ErrorDetail Response> 
- Details about the error state.
- lastStatus StringChange 
- The time of the last status change.
- status String
- The status of the hybrid machine agent.
- vmUuid String
- Specifies the VM's unique SMBIOS ID.
- agentVersion string
- The hybrid machine agent full version.
- errorDetails ErrorDetail Response[] 
- Details about the error state.
- lastStatus stringChange 
- The time of the last status change.
- status string
- The status of the hybrid machine agent.
- vmUuid string
- Specifies the VM's unique SMBIOS ID.
- agent_version str
- The hybrid machine agent full version.
- error_details Sequence[ErrorDetail Response] 
- Details about the error state.
- last_status_ strchange 
- The time of the last status change.
- status str
- The status of the hybrid machine agent.
- vm_uuid str
- Specifies the VM's unique SMBIOS ID.
- agentVersion String
- The hybrid machine agent full version.
- errorDetails List<Property Map>
- Details about the error state.
- lastStatus StringChange 
- The time of the last status change.
- status String
- The status of the hybrid machine agent.
- vmUuid String
- Specifies the VM's unique SMBIOS ID.
IdentityResponse 
- PrincipalId string
- The principal ID of resource identity.
- TenantId string
- The tenant ID of resource.
- Type string
- The identity type.
- PrincipalId string
- The principal ID of resource identity.
- TenantId string
- The tenant ID of resource.
- Type string
- The identity type.
- principalId String
- The principal ID of resource identity.
- tenantId String
- The tenant ID of resource.
- type String
- The identity type.
- principalId string
- The principal ID of resource identity.
- tenantId string
- The tenant ID of resource.
- type string
- The identity type.
- principal_id str
- The principal ID of resource identity.
- tenant_id str
- The tenant ID of resource.
- type str
- The identity type.
- principalId String
- The principal ID of resource identity.
- tenantId 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- 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_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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      
- MaximumMemory doubleMB 
- MinimumMemory doubleMB 
- TargetMemory intBuffer 
- 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.
- MaximumMemory float64MB 
- MinimumMemory float64MB 
- TargetMemory intBuffer 
- 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.
- maximumMemory DoubleMB 
- minimumMemory DoubleMB 
- targetMemory IntegerBuffer 
- 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.
- maximumMemory numberMB 
- minimumMemory numberMB 
- targetMemory numberBuffer 
- 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_ floatmb 
- minimum_memory_ floatmb 
- target_memory_ intbuffer 
- 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.
- maximumMemory NumberMB 
- minimumMemory NumberMB 
- targetMemory NumberBuffer 
- 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     
- DynamicMemory Pulumi.Config Azure Native. Azure Stack HCI. Inputs. Virtual Machine Properties Response Dynamic Memory Config 
- MemoryMB double
- RAM in MB for the virtual machine
- Processors int
- number of processors for the virtual machine
- VmSize string
- DynamicMemory VirtualConfig Machine Properties Response Dynamic Memory Config 
- MemoryMB float64
- RAM in MB for the virtual machine
- Processors int
- number of processors for the virtual machine
- VmSize string
- dynamicMemory VirtualConfig Machine Properties Response Dynamic Memory Config 
- memoryMB Double
- RAM in MB for the virtual machine
- processors Integer
- number of processors for the virtual machine
- vmSize String
- dynamicMemory VirtualConfig Machine Properties Response Dynamic Memory Config 
- memoryMB number
- RAM in MB for the virtual machine
- processors number
- number of processors for the virtual machine
- vmSize string
- dynamic_memory_ Virtualconfig Machine Properties Response Dynamic Memory Config 
- memory_mb float
- RAM in MB for the virtual machine
- processors int
- number of processors for the virtual machine
- vm_size str
- dynamicMemory Property MapConfig 
- 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     
- DisablePassword boolAuthentication 
- 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.Azure Native. Azure Stack HCI. Inputs. Virtual Machine Properties Response Ssh 
- SSH - contains settings related to ssh configuration
- DisablePassword boolAuthentication 
- 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
VirtualMachine Properties Response Ssh 
- SSH - contains settings related to ssh configuration
- disablePassword BooleanAuthentication 
- 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
VirtualMachine Properties Response Ssh 
- SSH - contains settings related to ssh configuration
- disablePassword booleanAuthentication 
- 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
VirtualMachine Properties Response Ssh 
- SSH - contains settings related to ssh configuration
- disable_password_ boolauthentication 
- DisablePasswordAuthentication - whether password authentication should be disabled
- provision_vm_ boolagent 
- Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine creation process.
- ssh
VirtualMachine Properties Response Ssh 
- SSH - contains settings related to ssh configuration
- disablePassword BooleanAuthentication 
- 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.Azure Native. Azure Stack HCI. Inputs. Virtual Machine Properties Response Network Interfaces> 
- NetworkInterfaces - list of network interfaces to be attached to the virtual machine
- NetworkInterfaces []VirtualMachine Properties Response Network Interfaces 
- NetworkInterfaces - list of network interfaces to be attached to the virtual machine
- networkInterfaces List<VirtualMachine Properties Response Network Interfaces> 
- NetworkInterfaces - list of network interfaces to be attached to the virtual machine
- networkInterfaces VirtualMachine Properties Response Network Interfaces[] 
- NetworkInterfaces - list of network interfaces to be attached to the virtual machine
- network_interfaces Sequence[VirtualMachine Properties Response Network Interfaces] 
- 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.Azure Native. Azure Stack HCI. Inputs. Virtual Machine Properties Response Linux Configuration 
- LinuxConfiguration - linux specific configuration values for the virtual machine
- OsType string
- OsType - string specifying whether the OS is Linux or Windows
- WindowsConfiguration Pulumi.Azure Native. Azure Stack HCI. Inputs. Virtual Machine Properties Response Windows Configuration 
- Windows Configuration for the virtual machine
- AdminUsername string
- AdminUsername - admin username
- ComputerName string
- ComputerName - name of the compute
- LinuxConfiguration VirtualMachine Properties Response Linux Configuration 
- LinuxConfiguration - linux specific configuration values for the virtual machine
- OsType string
- OsType - string specifying whether the OS is Linux or Windows
- WindowsConfiguration VirtualMachine Properties Response Windows Configuration 
- Windows Configuration for the virtual machine
- adminUsername String
- AdminUsername - admin username
- computerName String
- ComputerName - name of the compute
- linuxConfiguration VirtualMachine Properties Response Linux Configuration 
- LinuxConfiguration - linux specific configuration values for the virtual machine
- osType String
- OsType - string specifying whether the OS is Linux or Windows
- windowsConfiguration VirtualMachine Properties Response Windows Configuration 
- Windows Configuration for the virtual machine
- adminUsername string
- AdminUsername - admin username
- computerName string
- ComputerName - name of the compute
- linuxConfiguration VirtualMachine Properties Response Linux Configuration 
- LinuxConfiguration - linux specific configuration values for the virtual machine
- osType string
- OsType - string specifying whether the OS is Linux or Windows
- windowsConfiguration VirtualMachine Properties Response Windows Configuration 
- Windows Configuration for the virtual machine
- admin_username str
- AdminUsername - admin username
- computer_name str
- ComputerName - name of the compute
- linux_configuration VirtualMachine Properties Response Linux Configuration 
- LinuxConfiguration - linux specific configuration values for the virtual machine
- os_type str
- OsType - string specifying whether the OS is Linux or Windows
- windows_configuration VirtualMachine Properties Response Windows Configuration 
- 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     
- enableTPM Boolean
- uefiSettings Property Map
VirtualMachinePropertiesResponseSsh    
- PublicKeys List<Pulumi.Azure Native. Azure Stack HCI. Inputs. Virtual Machine Properties Response Public Keys> 
- PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
- PublicKeys []VirtualMachine Properties Response Public Keys 
- PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
- publicKeys List<VirtualMachine Properties Response Public Keys> 
- PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
- publicKeys VirtualMachine Properties Response Public Keys[] 
- PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
- public_keys Sequence[VirtualMachine Properties Response Public Keys] 
- 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.Azure Native. Azure Stack HCI. Inputs. Virtual Machine Properties Response Public Keys Public Keys> 
- PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
- PublicKeys []VirtualMachine Properties Response Public Keys Public Keys 
- PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
- publicKeys List<VirtualMachine Properties Response Public Keys Public Keys> 
- PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
- publicKeys VirtualMachine Properties Response Public Keys Public Keys[] 
- PublicKeys - The list of SSH public keys used to authenticate with linux based VMs.
- public_keys Sequence[VirtualMachine Properties Response Public Keys Public Keys] 
- 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 List<Pulumi.Azure Native. Azure Stack HCI. Inputs. Virtual Machine Properties Response Data Disks> 
- adds data disks to the virtual machine
- ImageReference Pulumi.Azure Native. Azure Stack HCI. Inputs. Virtual Machine Properties Response Image Reference 
- Which Image to use for the virtual machine
- OsDisk Pulumi.Azure Native. Azure Stack HCI. Inputs. Virtual Machine Properties Response Os Disk 
- VHD to attach as OS disk
- VmConfig stringStorage Path Id 
- Id of the storage container that hosts the VM configuration file
- DataDisks []VirtualMachine Properties Response Data Disks 
- adds data disks to the virtual machine
- ImageReference VirtualMachine Properties Response Image Reference 
- Which Image to use for the virtual machine
- OsDisk VirtualMachine Properties Response Os Disk 
- VHD to attach as OS disk
- VmConfig stringStorage Path Id 
- Id of the storage container that hosts the VM configuration file
- dataDisks List<VirtualMachine Properties Response Data Disks> 
- adds data disks to the virtual machine
- imageReference VirtualMachine Properties Response Image Reference 
- Which Image to use for the virtual machine
- osDisk VirtualMachine Properties Response Os Disk 
- VHD to attach as OS disk
- vmConfig StringStorage Path Id 
- Id of the storage container that hosts the VM configuration file
- dataDisks VirtualMachine Properties Response Data Disks[] 
- adds data disks to the virtual machine
- imageReference VirtualMachine Properties Response Image Reference 
- Which Image to use for the virtual machine
- osDisk VirtualMachine Properties Response Os Disk 
- VHD to attach as OS disk
- vmConfig stringStorage Path Id 
- Id of the storage container that hosts the VM configuration file
- data_disks Sequence[VirtualMachine Properties Response Data Disks] 
- adds data disks to the virtual machine
- image_reference VirtualMachine Properties Response Image Reference 
- Which Image to use for the virtual machine
- os_disk VirtualMachine Properties Response Os Disk 
- VHD to attach as OS disk
- vm_config_ strstorage_ path_ id 
- 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
- vmConfig StringStorage Path Id 
- Id of the storage container that hosts the VM configuration file
VirtualMachinePropertiesResponseUefiSettings     
- SecureBoot boolEnabled 
- Specifies whether secure boot should be enabled on the virtual machine.
- SecureBoot boolEnabled 
- Specifies whether secure boot should be enabled on the virtual machine.
- secureBoot BooleanEnabled 
- Specifies whether secure boot should be enabled on the virtual machine.
- secureBoot booleanEnabled 
- Specifies whether secure boot should be enabled on the virtual machine.
- secure_boot_ boolenabled 
- Specifies whether secure boot should be enabled on the virtual machine.
- secureBoot BooleanEnabled 
- Specifies whether secure boot should be enabled on the virtual machine.
VirtualMachinePropertiesResponseWindowsConfiguration     
- EnableAutomatic boolUpdates 
- 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.Azure Native. Azure Stack HCI. Inputs. Virtual Machine Properties Response Ssh Ssh 
- SSH Configuration
- TimeZone string
- TimeZone for the virtual machine
- EnableAutomatic boolUpdates 
- 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
VirtualMachine Properties Response Ssh Ssh 
- SSH Configuration
- TimeZone string
- TimeZone for the virtual machine
- enableAutomatic BooleanUpdates 
- 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
VirtualMachine Properties Response Ssh Ssh 
- SSH Configuration
- timeZone String
- TimeZone for the virtual machine
- enableAutomatic booleanUpdates 
- 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
VirtualMachine Properties Response Ssh Ssh 
- SSH Configuration
- timeZone string
- TimeZone for the virtual machine
- enable_automatic_ boolupdates 
- Whether to EnableAutomaticUpdates on the machine
- provision_vm_ boolagent 
- Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine creation process.
- ssh
VirtualMachine Properties Response Ssh Ssh 
- SSH Configuration
- time_zone str
- TimeZone for the virtual machine
- enableAutomatic BooleanUpdates 
- 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.Azure Native. Azure Stack HCI. Inputs. Virtual Machine Status Response Provisioning Status 
- ErrorCode string
- VirtualMachine provisioning error code
- ErrorMessage string
- Descriptive error message
- PowerState string
- The power state of the virtual machine
- ProvisioningStatus VirtualMachine Status Response Provisioning Status 
- errorCode String
- VirtualMachine provisioning error code
- errorMessage String
- Descriptive error message
- powerState String
- The power state of the virtual machine
- provisioningStatus VirtualMachine Status Response Provisioning Status 
- errorCode string
- VirtualMachine provisioning error code
- errorMessage string
- Descriptive error message
- powerState string
- The power state of the virtual machine
- provisioningStatus VirtualMachine Status Response Provisioning Status 
- 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 VirtualMachine Status Response Provisioning Status 
- 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 pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi