ComputeExtensions.GetVirtualMachine Method

Reference

Definition

Namespace:: Azure.ResourceManager.Compute

Assembly:: Azure.ResourceManager.Compute.dll

Package:: Azure.ResourceManager.Compute v1.5.0

Package:: Azure.ResourceManager.Compute v1.5.0-beta.1

Source:: ComputeExtensions.cs

Source:: ComputeExtensions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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-03-01
Resource: VirtualMachineResource

public static Azure.Response<Azure.ResourceManager.Compute.VirtualMachineResource> GetVirtualMachine (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string vmName, Azure.ResourceManager.Compute.Models.InstanceViewType? expand = default, System.Threading.CancellationToken cancellationToken = default);

static member GetVirtualMachine : Azure.ResourceManager.Resources.ResourceGroupResource * string * Nullable<Azure.ResourceManager.Compute.Models.InstanceViewType> * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Compute.VirtualMachineResource>

<Extension()>
Public Function GetVirtualMachine (resourceGroupResource As ResourceGroupResource, vmName As String, Optional expand As Nullable(Of InstanceViewType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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

Response<VirtualMachineResource>

Exceptions

ArgumentNullException

resourceGroupResource or vmName is null.

ArgumentException

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

Applies to

Condividi tramite