ComputeExtensions.GetVirtualMachineScaleSet Method

Definition

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 Azure.Response<Azure.ResourceManager.Compute.VirtualMachineScaleSetResource> GetVirtualMachineScaleSet (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string virtualMachineScaleSetName, Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetGetExpand? expand = default, System.Threading.CancellationToken cancellationToken = default);
static member GetVirtualMachineScaleSet : Azure.ResourceManager.Resources.ResourceGroupResource * string * Nullable<Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetGetExpand> * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Compute.VirtualMachineScaleSetResource>
<Extension()>
Public Function GetVirtualMachineScaleSet (resourceGroupResource As ResourceGroupResource, virtualMachineScaleSetName As String, Optional expand As Nullable(Of VirtualMachineScaleSetGetExpand) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of VirtualMachineScaleSetResource)

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

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

Exceptions

resourceGroupResource or virtualMachineScaleSetName is null.

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

Applies to