SynapseWorkloadGroupCollection.GetAsync(String, CancellationToken) Method

Definition

Get a Sql pool's workload group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/workloadGroups/{workloadGroupName}
  • Operation Id: SqlPoolWorkloadGroup_Get
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Synapse.SynapseWorkloadGroupResource>> GetAsync (string workloadGroupName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Synapse.SynapseWorkloadGroupResource>>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Synapse.SynapseWorkloadGroupResource>>
Public Overridable Function GetAsync (workloadGroupName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SynapseWorkloadGroupResource))

Parameters

workloadGroupName
String

The name of the workload group.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

workloadGroupName is null.

Applies to