@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 13.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Retrieves information about the model view or the instance view of a virtual machine.
*
* Uses Azure REST API version 2024-11-01.
*
* Other available API versions: 2022-08-01, 2022-11-01, 2023-03-01, 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native compute [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getVirtualMachine(args: GetVirtualMachineArgs, opts?: pulumi.InvokeOptions): Promise<GetVirtualMachineResult>;
export interface GetVirtualMachineArgs {
/**
* The expand expression to apply on the operation. 'InstanceView' retrieves a snapshot of the runtime properties of the virtual machine that is managed by the platform and can change outside of control plane operations. 'UserData' retrieves the UserData property as part of the VM model view that was provided by the user during the VM Create/Update operation.
*/
expand?: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
/**
* The name of the virtual machine.
*/
vmName: string;
}
/**
* Describes a Virtual Machine.
*/
export interface GetVirtualMachineResult {
/**
* Specifies additional capabilities enabled or disabled on the virtual machine.
*/
readonly additionalCapabilities?: outputs.compute.AdditionalCapabilitiesResponse;
/**
* Specifies the gallery applications that should be made available to the VM/VMSS.
*/
readonly applicationProfile?: outputs.compute.ApplicationProfileResponse;
/**
* Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.
*/
readonly availabilitySet?: outputs.compute.SubResourceResponse;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01.
*/
readonly billingProfile?: outputs.compute.BillingProfileResponse;
/**
* Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.
*/
readonly capacityReservation?: outputs.compute.CapacityReservationProfileResponse;
/**
* Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
*/
readonly diagnosticsProfile?: outputs.compute.DiagnosticsProfileResponse;
/**
* Etag is property returned in Create/Update/Get response of the VM, so that customer can supply it in the header to ensure optimistic updates.
*/
readonly etag: string;
/**
* Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview.
*/
readonly evictionPolicy?: string;
/**
* The extended location of the Virtual Machine.
*/
readonly extendedLocation?: outputs.compute.ExtendedLocationResponse;
/**
* Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01.
*/
readonly extensionsTimeBudget?: string;
/**
* Specifies the hardware settings for the virtual machine.
*/
readonly hardwareProfile?: outputs.compute.HardwareProfileResponse;
/**
* Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01.
*/
readonly host?: outputs.compute.SubResourceResponse;
/**
* Specifies information about the dedicated host group that the virtual machine resides in. **Note:** User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01.
*/
readonly hostGroup?: outputs.compute.SubResourceResponse;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* The identity of the virtual machine, if configured.
*/
readonly identity?: outputs.compute.VirtualMachineIdentityResponse;
/**
* The virtual machine instance view.
*/
readonly instanceView: outputs.compute.VirtualMachineInstanceViewResponse;
/**
* Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) <br><br> [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) <br><br> Minimum api-version: 2015-06-15
*/
readonly licenseType?: string;
/**
* The geo-location where the resource lives
*/
readonly location: string;
/**
* ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is part of the VMSS. This property is used by platform for internal resource group delete optimization.
*/
readonly managedBy: string;
/**
* The name of the resource
*/
readonly name: string;
/**
* Specifies the network interfaces of the virtual machine.
*/
readonly networkProfile?: outputs.compute.NetworkProfileResponse;
/**
* Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.
*/
readonly osProfile?: outputs.compute.OSProfileResponse;
/**
* Placement section specifies the user-defined constraints for virtual machine hardware placement. This property cannot be changed once VM is provisioned. Minimum api-version: 2024-11-01.
*/
readonly placement?: outputs.compute.PlacementResponse;
/**
* Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**.
*/
readonly plan?: outputs.compute.PlanResponse;
/**
* Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01.
*/
readonly platformFaultDomain?: number;
/**
* Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01
*/
readonly priority?: string;
/**
* The provisioning state, which only appears in the response.
*/
readonly provisioningState: string;
/**
* Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01.
*/
readonly proximityPlacementGroup?: outputs.compute.SubResourceResponse;
/**
* The virtual machine child extension resources.
*/
readonly resources: outputs.compute.VirtualMachineExtensionResponse[];
/**
* Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine.
*/
readonly scheduledEventsPolicy?: outputs.compute.ScheduledEventsPolicyResponse;
/**
* Specifies Scheduled Event related configurations.
*/
readonly scheduledEventsProfile?: outputs.compute.ScheduledEventsProfileResponse;
/**
* Specifies the Security related profile settings for the virtual machine.
*/
readonly securityProfile?: outputs.compute.SecurityProfileResponse;
/**
* Specifies the storage settings for the virtual machine disks.
*/
readonly storageProfile?: outputs.compute.StorageProfileResponse;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.compute.SystemDataResponse;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01.
*/
readonly timeCreated: string;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01.
*/
readonly userData?: string;
/**
* Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01.
*/
readonly virtualMachineScaleSet?: outputs.compute.SubResourceResponse;
/**
* Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.
*/
readonly vmId: string;
/**
* The availability zones.
*/
readonly zones?: string[];
}
/**
* Retrieves information about the model view or the instance view of a virtual machine.
*
* Uses Azure REST API version 2024-11-01.
*
* Other available API versions: 2022-08-01, 2022-11-01, 2023-03-01, 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native compute [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getVirtualMachineOutput(args: GetVirtualMachineOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetVirtualMachineResult>;
export interface GetVirtualMachineOutputArgs {
/**
* The expand expression to apply on the operation. 'InstanceView' retrieves a snapshot of the runtime properties of the virtual machine that is managed by the platform and can change outside of control plane operations. 'UserData' retrieves the UserData property as part of the VM model view that was provided by the user during the VM Create/Update operation.
*/
expand?: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the virtual machine.
*/
vmName: pulumi.Input<string>;
}