VirtualMachineScaleSetResource.GetVirtualMachineScaleSetVmAsync Method

Definition

Namespace:

Azure.ResourceManager.Compute

Assembly:

Azure.ResourceManager.Compute.dll

Package:

Azure.ResourceManager.Compute v1.4.0

Source:

VirtualMachineScaleSetResource.cs

Gets a virtual machine from a VM scale set.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}
• Operation Id: VirtualMachineScaleSetVMs_Get
• Default Api Version: 2023-09-01
• Resource: VirtualMachineScaleSetVmResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.VirtualMachineScaleSetVmResource>> GetVirtualMachineScaleSetVmAsync (string instanceId, Azure.ResourceManager.Compute.Models.InstanceViewType? expand = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetVirtualMachineScaleSetVmAsync : string * Nullable<Azure.ResourceManager.Compute.Models.InstanceViewType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.VirtualMachineScaleSetVmResource>>
override this.GetVirtualMachineScaleSetVmAsync : string * Nullable<Azure.ResourceManager.Compute.Models.InstanceViewType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.VirtualMachineScaleSetVmResource>>

Public Overridable Function GetVirtualMachineScaleSetVmAsync (instanceId As String, Optional expand As Nullable(Of InstanceViewType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of VirtualMachineScaleSetVmResource))

Parameters

instanceId

String

The instance ID of the virtual machine.

expand

Nullable<InstanceViewType>

The expand expression to apply on the operation. 'InstanceView' will retrieve the instance view of the virtual machine. 'UserData' will retrieve the UserData of the virtual machine.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<VirtualMachineScaleSetVmResource>>

Exceptions

ArgumentNullException

instanceId is null.

ArgumentException

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