ComputeExtensions.GetVirtualMachineScaleSetAsync Method
Definition
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.
Display information about a virtual machine scale set.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}
- Operation Id: VirtualMachineScaleSets_Get
- Default Api Version: 2024-07-01
- Resource: VirtualMachineScaleSetResource
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>>
<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 instance the method will execute against.
- virtualMachineScaleSetName
- String
The name of the VM scale set.
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
Exceptions
resourceGroupResource
or virtualMachineScaleSetName
is null.
virtualMachineScaleSetName
is an empty string, and was expected to be non-empty.