Share via

Job Agents - Get

  • Reference
Service:
SQL Database
API Version:
2023-08-01

Gets a job agent.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}?api-version=2023-08-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

ErrorResponse

*** Error Responses: ***

  • 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state

  • 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state

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

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

  • 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=2023-08-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": "JA400",
    "capacity": 400
  },
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
JobAgent

An Azure SQL job agent.
JobAgentIdentity

Azure Active Directory identity configuration for a resource.
JobAgentIdentityType

The job agent identity type
JobAgentState

The state of the job agent.
JobAgentUserAssignedIdentity

Azure Active Directory identity configuration for a resource.
Sku

An ARM Resource SKU.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.

JobAgent

Object

An Azure SQL job agent.

Name Type Description
id

string

Resource ID.
identity

JobAgentIdentity

The identity of the job agent.
location

string

Resource location.
name

string

Resource name.
properties.databaseId

string (arm-id)

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.

JobAgentIdentity

Object

Azure Active Directory identity configuration for a resource.

Name Type Description
tenantId

string (uuid)

The job agent identity tenant id
type

JobAgentIdentityType

The job agent identity type
userAssignedIdentities

<string,  JobAgentUserAssignedIdentity>

The resource ids of the user assigned identities to use

JobAgentIdentityType

Enumeration

The job agent identity type

Value Description
None
SystemAssigned
SystemAssignedUserAssigned
UserAssigned

JobAgentState

Enumeration

The state of the job agent.

Value Description
Creating
Deleting
Disabled
Ready
Updating

JobAgentUserAssignedIdentity

Object

Azure Active Directory identity configuration for a resource.

Name Type Description
clientId

string (uuid)

The Azure Active Directory client id.
principalId

string (uuid)

The Azure Active Directory principal id.

Sku

Object

An ARM Resource SKU.

Name Type Description
capacity

integer (int32)

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.