Share via

Job Agents - Get

  • Reference
Service:
SQL Database
API Version:
2021-11-01

Gets a job agent.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}?api-version=2021-11-01

URI Parameters

Name In Required Type Description
jobAgentName
 path True

string

The name of the job agent to be retrieved.
resourceGroupName
 path True

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
 path True

string

The name of the server.
subscriptionId
 path True

string

The subscription ID that identifies an Azure subscription.
api-version
 query True

string

The API version to use for the request.

Responses

Name Type Description
200 OK

JobAgent

Successfully retrieved the specified job agent.
Other Status Codes

*** Error Responses: ***

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

  • 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.

  • 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.

  • 409 ServerDisabled - Server is disabled.

Examples

Get a job agent

Sample request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1?api-version=2021-11-01

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1",
  "name": "agent1",
  "type": "Microsoft.Sql/servers/jobAgents",
  "location": "southeastasia",
  "sku": {
    "name": "Agent",
    "capacity": 400
  },
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}

Definitions

Name Description
JobAgent

An Azure SQL job agent.
JobAgentState

The state of the job agent.
Sku

An ARM Resource SKU.

JobAgent

An Azure SQL job agent.

Name Type Description
id

string

Resource ID.
location

string

Resource location.
name

string

Resource name.
properties.databaseId

string

Resource ID of the database to store job metadata in.
properties.state

JobAgentState

The state of the job agent.
sku

Sku

The name and tier of the SKU.
tags

object

Resource tags.
type

string

Resource type.

JobAgentState

The state of the job agent.

Name Type Description
Creating

string

Deleting

string

Disabled

string

Ready

string

Updating

string

Sku

An ARM Resource SKU.

Name Type Description
capacity

integer

Capacity of the particular SKU.
family

string

If the service has different generations of hardware, for the same SKU, then that can be captured here.
name

string

The name of the SKU, typically, a letter + Number code, e.g. P3.
size

string

Size of the particular SKU
tier

string

The tier or edition of the particular SKU, e.g. Basic, Premium.