VirtualMachineScaleSetVmCollection.GetIfExistsAsync Method

Definition

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}
  • Operation Id: VirtualMachineScaleSetVMs_Get
  • Default Api Version: 2024-07-01
  • Resource: VirtualMachineScaleSetVmResource
public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Compute.VirtualMachineScaleSetVmResource>> GetIfExistsAsync (string instanceId, Azure.ResourceManager.Compute.Models.InstanceViewType? expand = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIfExistsAsync : string * Nullable<Azure.ResourceManager.Compute.Models.InstanceViewType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Compute.VirtualMachineScaleSetVmResource>>
override this.GetIfExistsAsync : string * Nullable<Azure.ResourceManager.Compute.Models.InstanceViewType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Compute.VirtualMachineScaleSetVmResource>>
Public Overridable Function GetIfExistsAsync (instanceId As String, Optional expand As Nullable(Of InstanceViewType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(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

Exceptions

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

instanceId is null.

Applies to