SqlServerResource.GetSqlServerJobAgent(String, CancellationToken) Method

Definition

Gets a job agent.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}
  • Operation Id: JobAgents_Get
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlServerJobAgentResource
public virtual Azure.Response<Azure.ResourceManager.Sql.SqlServerJobAgentResource> GetSqlServerJobAgent (string jobAgentName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetSqlServerJobAgent : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Sql.SqlServerJobAgentResource>
override this.GetSqlServerJobAgent : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Sql.SqlServerJobAgentResource>
Public Overridable Function GetSqlServerJobAgent (jobAgentName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SqlServerJobAgentResource)

Parameters

jobAgentName
String

The name of the job agent to be retrieved.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

jobAgentName is null.

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

Applies to