ComputeExtensions.GetVirtualMachineScaleSetAsync Method

Definition

Namespace:
Azure.ResourceManager.Compute
Assembly:
Azure.ResourceManager.Compute.dll
Package:
Azure.ResourceManager.Compute v1.16.0
Package:
Azure.ResourceManager.Compute v1.15.0-beta.1
Source:
ComputeExtensions.cs
Source:
ComputeExtensions.cs

Display information about a virtual machine scale set. <item> Mocking. To mock this method, please mock GetVirtualMachineScaleSetAsync(String, Nullable<VirtualMachineScaleSetGetExpand>, CancellationToken) instead. </item>

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.VirtualMachineScaleSetResource>> GetVirtualMachineScaleSetAsync(this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string vmScaleSetName, Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetGetExpand? expand = default, System.Threading.CancellationToken cancellationToken = default);
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.VirtualMachineScaleSetResource>> GetVirtualMachineScaleSetAsync(this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string virtualMachineScaleSetName, Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetGetExpand? expand = default, System.Threading.CancellationToken cancellationToken = default);
static member GetVirtualMachineScaleSetAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * Nullable<Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetGetExpand> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.VirtualMachineScaleSetResource>>
static member GetVirtualMachineScaleSetAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * Nullable<Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetGetExpand> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.VirtualMachineScaleSetResource>>
<Extension()>
Public Function GetVirtualMachineScaleSetAsync (resourceGroupResource As ResourceGroupResource, vmScaleSetName As String, Optional expand As Nullable(Of VirtualMachineScaleSetGetExpand) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of VirtualMachineScaleSetResource))
<Extension()>
Public Function GetVirtualMachineScaleSetAsync (resourceGroupResource As ResourceGroupResource, virtualMachineScaleSetName As String, Optional expand As Nullable(Of VirtualMachineScaleSetGetExpand) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of VirtualMachineScaleSetResource))

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource the method will execute against.

vmScaleSetNamevirtualMachineScaleSetName
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<Response<VirtualMachineScaleSetResource>>

Exceptions

ArgumentException

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

ArgumentNullException

resourceGroupResource is null.

Applies to