Microsoft.Sql servers/jobAgents/jobs
Bicep resource definition
The servers/jobAgents/jobs 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/jobs resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Sql/servers/jobAgents/jobs@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
description: 'string'
schedule: {
enabled: bool
endTime: 'string'
interval: 'string'
startTime: 'string'
type: 'string'
}
}
}
Property values
servers/jobAgents/jobs
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
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: jobAgents |
| properties | Resource properties. | JobProperties |
JobProperties
| Name | Description | Value |
|---|---|---|
| description | User-defined description of the job. | string |
| schedule | Schedule properties of the job. | JobSchedule |
JobSchedule
| Name | Description | Value |
|---|---|---|
| enabled | Whether or not the schedule is enabled. | bool |
| endTime | Schedule end time. | string |
| interval | Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. | string |
| startTime | Schedule start time. | string |
| type | Schedule interval type | 'Once' 'Recurring' |
ARM template resource definition
The servers/jobAgents/jobs 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/jobs resource, add the following JSON to your template.
{
"type": "Microsoft.Sql/servers/jobAgents/jobs",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"description": "string",
"schedule": {
"enabled": "bool",
"endTime": "string",
"interval": "string",
"startTime": "string",
"type": "string"
}
}
}
Property values
servers/jobAgents/jobs
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Sql/servers/jobAgents/jobs' |
| 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) |
| properties | Resource properties. | JobProperties |
JobProperties
| Name | Description | Value |
|---|---|---|
| description | User-defined description of the job. | string |
| schedule | Schedule properties of the job. | JobSchedule |
JobSchedule
| Name | Description | Value |
|---|---|---|
| enabled | Whether or not the schedule is enabled. | bool |
| endTime | Schedule end time. | string |
| interval | Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. | string |
| startTime | Schedule start time. | string |
| type | Schedule interval type | 'Once' 'Recurring' |
Terraform (AzAPI provider) resource definition
The servers/jobAgents/jobs 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/jobs resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Sql/servers/jobAgents/jobs@2023-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
schedule = {
enabled = bool
endTime = "string"
interval = "string"
startTime = "string"
type = "string"
}
}
})
}
Property values
servers/jobAgents/jobs
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Sql/servers/jobAgents/jobs@2023-05-01-preview" |
| 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: jobAgents |
| properties | Resource properties. | JobProperties |
JobProperties
| Name | Description | Value |
|---|---|---|
| description | User-defined description of the job. | string |
| schedule | Schedule properties of the job. | JobSchedule |
JobSchedule
| Name | Description | Value |
|---|---|---|
| enabled | Whether or not the schedule is enabled. | bool |
| endTime | Schedule end time. | string |
| interval | Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. | string |
| startTime | Schedule start time. | string |
| type | Schedule interval type | "Once" "Recurring" |