Microsoft.Sql servers/jobAgents 2022-11-01-preview
Bicep resource definition
The servers/jobAgents resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Sql/servers/jobAgents resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Sql/servers/jobAgents@2022-11-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
parent: resourceSymbolicName
properties: {
databaseId: 'string'
}
}
Property values
servers/jobAgents
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
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 |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: servers |
| properties | Resource properties. | JobAgentProperties |
JobAgentProperties
| Name | Description | Value |
|---|---|---|
| databaseId | Resource ID of the database to store job metadata in. | string (required) |
Sku
| 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 |
ARM template resource definition
The servers/jobAgents resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Sql/servers/jobAgents resource, add the following JSON to your template.
{
"type": "Microsoft.Sql/servers/jobAgents",
"apiVersion": "2022-11-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"properties": {
"databaseId": "string"
}
}
Property values
servers/jobAgents
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Sql/servers/jobAgents' |
| apiVersion | The resource api version | '2022-11-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 |
| properties | Resource properties. | JobAgentProperties |
JobAgentProperties
| Name | Description | Value |
|---|---|---|
| databaseId | Resource ID of the database to store job metadata in. | string (required) |
Sku
| 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 |
Terraform (AzAPI provider) resource definition
The servers/jobAgents resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Sql/servers/jobAgents resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Sql/servers/jobAgents@2022-11-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
databaseId = "string"
}
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
})
}
Property values
servers/jobAgents
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Sql/servers/jobAgents@2022-11-01-preview" |
| name | The resource name | string (required) |
| location | Resource location. | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: servers |
| tags | Resource tags. | Dictionary of tag names and values. |
| sku | The name and tier of the SKU. | Sku |
| properties | Resource properties. | JobAgentProperties |
JobAgentProperties
| Name | Description | Value |
|---|---|---|
| databaseId | Resource ID of the database to store job metadata in. | string (required) |
Sku
| 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 |