VirtualMachineScaleSetCollection.Get 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:
VirtualMachineScaleSetCollection.cs
Source:
VirtualMachineScaleSetCollection.cs

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. : 2026-03-01. 
public virtual Azure.Response<Azure.ResourceManager.Compute.VirtualMachineScaleSetResource> Get(string vmScaleSetName, Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetGetExpand? expand = default, System.Threading.CancellationToken cancellationToken = default);
public virtual Azure.Response<Azure.ResourceManager.Compute.VirtualMachineScaleSetResource> Get(string virtualMachineScaleSetName, Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetGetExpand? expand = default, System.Threading.CancellationToken cancellationToken = default);
abstract member Get : string * Nullable<Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetGetExpand> * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Compute.VirtualMachineScaleSetResource>
override this.Get : string * Nullable<Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetGetExpand> * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Compute.VirtualMachineScaleSetResource>
abstract member Get : string * Nullable<Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetGetExpand> * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Compute.VirtualMachineScaleSetResource>
override this.Get : string * Nullable<Azure.ResourceManager.Compute.Models.VirtualMachineScaleSetGetExpand> * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Compute.VirtualMachineScaleSetResource>
Public Overridable Function Get (vmScaleSetName As String, Optional expand As Nullable(Of VirtualMachineScaleSetGetExpand) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of VirtualMachineScaleSetResource)
Public Overridable Function Get (virtualMachineScaleSetName As String, Optional expand As Nullable(Of VirtualMachineScaleSetGetExpand) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of VirtualMachineScaleSetResource)

Parameters

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

Response<VirtualMachineScaleSetResource>

Exceptions

ArgumentNullException

vmScaleSetName is null.

ArgumentException

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

Applies to