Share via


SynapseSqlPoolResource.GetSynapseWorkloadGroupAsync 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>> GetSynapseWorkloadGroupAsync (string workloadGroupName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetSynapseWorkloadGroupAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Synapse.SynapseWorkloadGroupResource>>
override this.GetSynapseWorkloadGroupAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Synapse.SynapseWorkloadGroupResource>>
Public Overridable Function GetSynapseWorkloadGroupAsync (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 null.

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

Applies to