Jobs - List By Agent

Служба:

SQL Database

Версия API:

2021-11-01

Возвращает список заданий.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
jobAgentName	path	True	string	Имя агента задания.
resourceGroupName	path	True	string	Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор подписки Azure.
api-version	query	True	string	Версия API для использования в запросе.

Ответы

Имя	Тип	Описание
200 OK	JobListResult	Список заданий успешно получен.
Other Status Codes		Ответы на ошибки: *** 404 JobAgentNotFound — указанный агент задания не существует на указанном логическом сервере. 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден 404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке.

Примеры

List jobs in a job agent

Образец запроса

HTTP

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

Java

/**
 * Samples for Jobs ListByAgent.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobsByAgent.json
     */
    /**
     * Sample code: List jobs in a job agent.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listJobsInAJobAgent(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobs().listByAgent("group1", "server1", "agent1",
            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

Пример ответа

Код состояния:

200

{
  "value": [
    {
      "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
        }
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job3",
      "name": "job3",
      "type": "Microsoft.Sql/servers/jobAccounts/jobs",
      "properties": {
        "description": "this job will be scheduled once",
        "version": 1,
        "schedule": {
          "startTime": "2017-07-01T03:45:00Z",
          "endTime": "2017-12-27T06:00:00Z",
          "type": "Once",
          "enabled": true
        }
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job2",
      "name": "job2",
      "type": "Microsoft.Sql/servers/jobAccounts/jobs",
      "properties": {
        "description": "this job will never be automatically scheduled",
        "version": 1,
        "schedule": {
          "startTime": "2017-07-01T03:45:00Z",
          "endTime": "2017-12-27T06:00:00Z",
          "type": "Once",
          "enabled": false
        }
      }
    }
  ]
}

Определения

Имя	Описание
Job	Задание.
JobListResult	Список заданий.
JobSchedule	Свойства планирования задания.
JobScheduleType	Тип интервала расписания

Job

Задание.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.description	string	Пользовательское описание задания.
properties.schedule	JobSchedule	Планирование свойств задания.
properties.version	integer	Номер версии задания.
type	string	Тип ресурса.

JobListResult

Список заданий.

Имя	Тип	Описание
nextLink	string	Ссылка для получения следующей страницы результатов.
value	Job[]	Массив результатов.

JobSchedule

Свойства планирования задания.

Имя	Тип	Default value	Описание
enabled	boolean		Указывает, включено ли расписание.
endTime	string	9999-12-31T11:59:59+00:00	Запланируйте время окончания.
interval	string		Значение повторяющегося интервала расписания, если ScheduleType является повторяющимся. ISO8601 формат длительности.
startTime	string	0001-01-01T00:00:00+00:00	Запланируйте время начала.
type	JobScheduleType	Once	Тип интервала расписания

JobScheduleType

Тип интервала расписания

Имя	Тип	Описание
Once	string
Recurring	string