Microsoft.Sql servers/jobAgents 2024-05-01-preview
- Latest
- 2024-05-01-preview
- 2023-08-01-preview
- 2023-05-01-preview
- 2023-02-01-preview
- 2022-11-01-preview
- 2022-08-01-preview
- 2022-05-01-preview
- 2022-02-01-preview
- 2021-11-01
- 2021-11-01-preview
- 2021-08-01-preview
- 2021-05-01-preview
- 2021-02-01-preview
- 2020-11-01-preview
- 2020-08-01-preview
- 2020-02-02-preview
- 2017-03-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@2024-05-01-preview' = {
parent: resourceSymbolicName
identity: {
tenantId: 'string'
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
databaseId: 'string'
}
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property values
JobAgentIdentity
| 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 |
JobAgentIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
JobAgentProperties
| Name | Description | Value |
|---|---|---|
| databaseId | Resource ID of the database to store job metadata in. | string (required) |
JobAgentUserAssignedIdentity
| Name | Description | Value |
|---|
Microsoft.Sql/servers/jobAgents
| Name | Description | Value |
|---|---|---|
| identity | The identity of the job agent. | JobAgentIdentity |
| location | Resource location. | string (required) |
| name | The resource name | string (required) |
| 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 |
| sku | The name and tier of the SKU. | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
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 |
TrackedResourceTags
| Name | Description | Value |
|---|
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": "2024-05-01-preview",
"name": "string",
"identity": {
"tenantId": "string",
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"databaseId": "string"
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property values
JobAgentIdentity
| 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 |
JobAgentIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
JobAgentProperties
| Name | Description | Value |
|---|---|---|
| databaseId | Resource ID of the database to store job metadata in. | string (required) |
JobAgentUserAssignedIdentity
| Name | Description | Value |
|---|
Microsoft.Sql/servers/jobAgents
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-05-01-preview' |
| identity | The identity of the job agent. | JobAgentIdentity |
| location | Resource location. | string (required) |
| name | The resource name | string (required) |
| properties | Resource properties. | JobAgentProperties |
| sku | The name and tier of the SKU. | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Sql/servers/jobAgents' |
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 |
TrackedResourceTags
| Name | Description | Value |
|---|
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@2024-05-01-preview"
name = "string"
identity = {
tenantId = "string"
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
databaseId = "string"
}
})
}
Property values
JobAgentIdentity
| 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 |
JobAgentIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
JobAgentProperties
| Name | Description | Value |
|---|---|---|
| databaseId | Resource ID of the database to store job metadata in. | string (required) |
JobAgentUserAssignedIdentity
| Name | Description | Value |
|---|
Microsoft.Sql/servers/jobAgents
| Name | Description | Value |
|---|---|---|
| identity | The identity of the job agent. | JobAgentIdentity |
| location | Resource location. | string (required) |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: servers |
| properties | Resource properties. | JobAgentProperties |
| sku | The name and tier of the SKU. | Sku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Sql/servers/jobAgents@2024-05-01-preview" |
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 |
TrackedResourceTags
| Name | Description | Value |
|---|