ComputeExtensions.GetVirtualMachineAsync Method

Definition

Retrieves information about the model view or the instance view of a virtual machine.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}
  • Operation Id: VirtualMachines_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineResource
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.VirtualMachineResource>> GetVirtualMachineAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string vmName, Azure.ResourceManager.Compute.Models.InstanceViewType? expand = default, System.Threading.CancellationToken cancellationToken = default);
static member GetVirtualMachineAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * Nullable<Azure.ResourceManager.Compute.Models.InstanceViewType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.VirtualMachineResource>>
<Extension()>
Public Function GetVirtualMachineAsync (resourceGroupResource As ResourceGroupResource, vmName As String, Optional expand As Nullable(Of InstanceViewType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of VirtualMachineResource))

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

vmName
String

The name of the virtual machine.

expand
Nullable<InstanceViewType>

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.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource or vmName is null.

vmName is an empty string, and was expected to be non-empty.

Applies to