Jobs - Create Or Update

Reference

Service:: SQL Database

API Version:: 2021-11-01

Creates or updates a job.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}?api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
jobAgentName	path	True	string	The name of the job agent.
jobName	path	True	string	The name of the job to get.
resourceGroupName	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.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Request Body

Name	Type	Description
properties.description	string	User-defined description of the job.
properties.schedule	JobSchedule	Schedule properties of the job.

Responses

Name	Type	Description
200 OK	Job	Successfully updated the job.
201 Created	Job	Successfully created the job.
Other Status Codes		* Error Responses: * 400 ElasticJobsOperationFailed - Elastic jobs management operation failed. 400 ElasticJobsOperationFailed - Elastic jobs management operation failed. 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid. 400 InvalidDuration - Invalid duration. 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.

Name

Type

Description

200 OK

Job

Successfully updated the job.

201 Created

Job

Successfully created the job.

Other Status Codes

*** Error Responses: ***

400 ElasticJobsOperationFailed - Elastic jobs management operation failed.
400 ElasticJobsOperationFailed - Elastic jobs management operation failed.
400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.
400 InvalidDuration - Invalid duration.
404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.
404 SubscriptionDoesNotHaveServer - The requested server was not found
404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.

Examples

Create a job with all properties specified

Create a job with default properties

Create a job with all properties specified

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1?api-version=2021-11-01

{
  "properties": {
    "description": "my favourite job",
    "schedule": {
      "startTime": "2015-09-24T18:30:01Z",
      "endTime": "2015-09-24T23:59:59Z",
      "type": "Recurring",
      "interval": "PT5M",
      "enabled": true
    }
  }
}


import com.azure.resourcemanager.sql.fluent.models.JobInner;
import com.azure.resourcemanager.sql.models.JobSchedule;
import com.azure.resourcemanager.sql.models.JobScheduleType;
import java.time.OffsetDateTime;

/**
 * Samples for Jobs CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/CreateOrUpdateJobMax.json
     */
    /**
     * Sample code: Create a job with all properties specified.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createAJobWithAllPropertiesSpecified(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobs().createOrUpdateWithResponse("group1", "server1", "agent1",
            "job1",
            new JobInner().withDescription("my favourite job")
                .withSchedule(new JobSchedule().withStartTime(OffsetDateTime.parse("2015-09-24T18:30:01Z"))
                    .withEndTime(OffsetDateTime.parse("2015-09-24T23:59:59Z")).withType(JobScheduleType.RECURRING)
                    .withEnabled(true).withInterval("PT5M")),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1",
  "name": "job1",
  "type": "Microsoft.Sql/servers/jobAccounts/jobs",
  "properties": {
    "description": "my favourite job",
    "version": 0,
    "schedule": {
      "startTime": "2015-09-24T18:30:01Z",
      "endTime": "2015-09-24T23:59:59Z",
      "type": "Recurring",
      "interval": "PT5M",
      "enabled": true
    }
  }
}

Status code:: 201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1",
  "name": "job1",
  "type": "Microsoft.Sql/servers/jobAccounts/jobs",
  "properties": {
    "description": "my favourite job",
    "version": 0,
    "schedule": {
      "startTime": "2015-09-24T18:30:01Z",
      "endTime": "2015-09-24T23:59:59Z",
      "type": "Recurring",
      "interval": "PT5M",
      "enabled": true
    }
  }
}

Create a job with default properties

Sample request

HTTP
Java

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1?api-version=2021-11-01

{}


import com.azure.resourcemanager.sql.fluent.models.JobInner;

/**
 * Samples for Jobs CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/CreateOrUpdateJobMin.json
     */
    /**
     * Sample code: Create a job with default properties.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createAJobWithDefaultProperties(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobs().createOrUpdateWithResponse("group1", "server1", "agent1",
            "job1", new JobInner(), com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1",
  "name": "job1",
  "type": "Microsoft.Sql/servers/jobAccounts/jobs",
  "properties": {
    "description": "",
    "version": 0,
    "schedule": {
      "startTime": "0001-01-01T00:00:00Z",
      "endTime": "9999-12-31T11:59:59Z",
      "type": "Once",
      "enabled": false
    }
  }
}

Status code:: 201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1",
  "name": "job1",
  "type": "Microsoft.Sql/servers/jobAccounts/jobs",
  "properties": {
    "description": "",
    "version": 0,
    "schedule": {
      "startTime": "0001-01-01T00:00:00Z",
      "endTime": "9999-12-31T11:59:59Z",
      "type": "Once",
      "enabled": false
    }
  }
}

Definitions

Name	Description
Job	A job.
JobSchedule	Scheduling properties of a job.
JobScheduleType	Schedule interval type

Job

A job.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.description	string	User-defined description of the job.
properties.schedule	JobSchedule	Schedule properties of the job.
properties.version	integer	The job version number.
type	string	Resource type.

JobSchedule

Scheduling properties of a job.

Name	Type	Default value	Description
enabled	boolean		Whether or not the schedule is enabled.
endTime	string	9999-12-31T11:59:59+00:00	Schedule end time.
interval	string		Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format.
startTime	string	0001-01-01T00:00:00+00:00	Schedule start time.
type	JobScheduleType	Once	Schedule interval type

JobScheduleType

Schedule interval type

Name	Type	Description
Once	string
Recurring	string

Share via

Jobs - Create Or Update

URI Parameters

Request Body

Responses

Examples

Create a job with all properties specified

Sample request

Sample response

Create a job with default properties

Sample request

Sample response

Definitions

Job

JobSchedule

JobScheduleType

Additional resources