Share via

VirtualMachineScaleSetCollection.GetIfExistsAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.Compute
Assembly:
Azure.ResourceManager.Compute.dll
Package:
Azure.ResourceManager.Compute v1.6.0
Package:
Azure.ResourceManager.Compute v1.7.0-beta.1
Source:
VirtualMachineScaleSetCollection.cs
Source:
VirtualMachineScaleSetCollection.cs

Tries to get details for this resource from the service.

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

Parameters

virtualMachineScaleSetName
String

The name of the VM scale set.

expand
Nullable<VirtualMachineScaleSetGetExpand>

The expand expression to apply on the operation. 'UserData' retrieves the UserData property of the VM scale set that was provided by the user during the VM scale set Create/Update operation.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<VirtualMachineScaleSetResource>>

Exceptions

ArgumentException

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

ArgumentNullException

virtualMachineScaleSetName is null.

Applies to