Share via

Job Agents - Update

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

Updates a job agent.

PATCH 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 updated.
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.

Request Body

Name Type Description
tags

object

Resource tags.

Responses

Name Type Description
200 OK

JobAgent

Successfully updated the job agent.
202 Accepted

Accepted
Other Status Codes

*** Error Responses: ***

  • 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

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

  • 404 PropertyChangeUnsupported - Property cannot be modified.

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

  • 404 OperationIdNotFound - The operation with Id does not exist.

  • 409 ServerDisabled - Server is disabled.

  • 409 OperationCancelled - The operation has been cancelled by user.

  • 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.

  • 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.

  • 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.

  • 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.

  • 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Examples

Update a job agent's tags.

Sample request

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

{
  "tags": {
    "mytag1": "myvalue1"
  }
}

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",
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  },
  "tags": {
    "mytag1": "myvalue1"
  }
}
Status code:
202

Definitions

Name Description
JobAgent

An Azure SQL job agent.
JobAgentState

The state of the job agent.
JobAgentUpdate

An update to an Azure SQL job agent.
Sku

An ARM Resource SKU.

JobAgent

Object

An Azure SQL job agent.

Name Type Description
id

string

Resource ID.
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.

JobAgentState

Enumeration

The state of the job agent.

Value Description
Creating
Ready
Updating
Deleting
Disabled

JobAgentUpdate

Object

An update to an Azure SQL job agent.

Name Type Description
tags

object

Resource tags.

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.