Job Agents - Create Or Update
Creates or updates a job agent.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}?api-version=2021-11-01
Name | In | Required | Type | Description |
---|---|---|---|---|
job
|
path | True |
string |
The name of the job agent to be created or updated. |
resource
|
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. |
server
|
path | True |
string |
The name of the server. |
subscription
|
path | True |
string |
The subscription ID that identifies an Azure subscription. |
api-version
|
query | True |
string |
The API version to use for the request. |
Name | Required | Type | Description |
---|---|---|---|
location | True |
string |
Resource location. |
properties.databaseId | True |
string |
Resource ID of the database to store job metadata in. |
sku |
The name and tier of the SKU. |
||
tags |
object |
Resource tags. |
Name | Type | Description |
---|---|---|
200 OK |
Successfully updated the job agent. |
|
201 Created |
Successfully created the job agent. |
|
202 Accepted |
Accepted |
|
Other Status Codes |
*** Error Responses: ***
|
Sample request
PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1?api-version=2021-11-01
{
"location": "southeastasia",
"properties": {
"databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
}
}
Sample response
{
"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": 100
},
"properties": {
"databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
}
}
{
"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": 100
},
"properties": {
"databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
}
}
Name | Description |
---|---|
Job |
An Azure SQL job agent. |
Job |
The state of the job agent. |
Sku |
An ARM Resource SKU. |
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 |
The state of the job agent. |
|
sku |
The name and tier of the SKU. |
|
tags |
object |
Resource tags. |
type |
string |
Resource type. |
The state of the job agent.
Name | Type | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Disabled |
string |
|
Ready |
string |
|
Updating |
string |
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. |