The servers/jobAgents resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.Sql/servers/jobAgents resource, add the following JSON to your template.
{
"type": "Microsoft.Sql/servers/jobAgents",
"apiVersion": "2023-05-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"identity": {
"tenantId": "string",
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"databaseId": "string"
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.Sql/servers/jobAgents' |
apiVersion | The resource api version | '2023-05-01-preview' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
location | Resource location. | string (required) |
tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
sku | The name and tier of the SKU. | Sku |
identity | The identity of the job agent. | JobAgentIdentity |
properties | Resource properties. | JobAgentProperties |
Name | Description | Value |
---|---|---|
tenantId | The job agent identity tenant id | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
type | The job agent identity type | 'None' 'SystemAssigned' 'SystemAssignedUserAssigned' 'UserAssigned' (required) |
userAssignedIdentities | The resource ids of the user assigned identities to use | JobAgentIdentityUserAssignedIdentities |
Name | Description | Value |
---|---|---|
{customized property} | JobAgentUserAssignedIdentity |
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
Name | Description | Value |
---|---|---|
databaseId | Resource ID of the database to store job metadata in. | string (required) |
Name | Description | Value |
---|---|---|
capacity | Capacity of the particular SKU. | int |
family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
name | The name of the SKU, typically, a letter + Number code, e.g. P3. | string (required) |
size | Size of the particular SKU | string |
tier | The tier or edition of the particular SKU, e.g. Basic, Premium. | string |