Job Step Executions - List By Job Execution

Ссылка

Service:: SQL Database

API Version:: 2021-11-01

Списки этапы выполнения задания.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps?createTimeMin={createTimeMin}&createTimeMax={createTimeMax}&endTimeMin={endTimeMin}&endTimeMax={endTimeMax}&isActive={isActive}&$skip={$skip}&$top={$top}&api-version=2021-11-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
jobAgentName	path	True	string	Имя агента задания.
jobExecutionId	path	True	string uuid	Идентификатор выполнения задания
jobName	path	True	string	Имя получаемого задания.
resourceGroupName	path	True	string	Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор подписки Azure.
api-version	query	True	string	Версия API для использования в запросе.
$skip	query		integer int64	Количество элементов в коллекции, которые необходимо пропустить.
$top	query		integer int64	Количество элементов, возвращаемых из коллекции.
createTimeMax	query		string date-time	Если этот параметр указан, включаются только выполнения заданий, созданные до указанного времени.
createTimeMin	query		string date-time	Если этот параметр указан, включаются только выполнения заданий, созданных в указанное время или после него.
endTimeMax	query		string date-time	Если этот параметр указан, включаются только выполнения заданий, завершенных до указанного времени.
endTimeMin	query		string date-time	Если этот параметр указан, включаются только выполнения заданий, завершенных в указанное время или после него.
isActive	query		boolean	Если этот параметр указан, включаются только активные или только завершенные выполнения заданий.

Ответы

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

Имя

Тип

Описание

200 OK

JobExecutionListResult

Успешно извлечены выполнения шагов.

Other Status Codes

Ответы об ошибках: ***

404 JobAgentNotFound — указанный агент задания не существует на указанном логическом сервере.
404 ResourceNotFound — запрошенный ресурс не найден.
404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден.
404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке.

Примеры

List job step executions

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5A86BF65-43AC-F258-2524-9E92992F97CA/steps?api-version=2021-11-01


import com.azure.core.util.Context;
import java.util.UUID;

/** Samples for JobStepExecutions ListByJobExecution. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobExecutionSteps.json
     */
    /**
     * Sample code: List job step executions.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listJobStepExecutions(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobStepExecutions().listByJobExecution("group1", "server1",
            "agent1", "job1", UUID.fromString("5A86BF65-43AC-F258-2524-9E92992F97CA"), null, null, null, null, null,
            null, null, 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

{
  "value": [
    {
      "properties": {
        "jobVersion": 1,
        "stepName": "step1",
        "stepId": 1,
        "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
        "lifecycle": "Succeeded",
        "provisioningState": "Succeeded",
        "createTime": "2017-12-03T04:33:15.7189151Z",
        "startTime": "2017-12-03T04:33:16.176937Z",
        "endTime": "2017-12-03T04:33:19.0600862Z",
        "currentAttempts": 1,
        "currentAttemptStartTime": "2017-12-03T04:33:17.4840068Z",
        "lastMessage": "Step 1 succeeded."
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999/steps/step1",
      "name": "step1",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions/steps"
    }
  ]
}

Определения

Имя	Описание
JobExecution	Выполнение задания
JobExecutionLifecycle	Подробное состояние выполнения задания.
JobExecutionListResult	Список выполнений заданий.
JobExecutionTarget	Целевой объект, в который выполняется выполнение задания.
JobTargetType	Тип цели.
ProvisioningState	Состояние подготовки ARM для выполнения задания.

JobExecution

Выполнение задания

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.createTime	string	Время создания задания.
properties.currentAttemptStartTime	string	Время начала текущей попытки.
properties.currentAttempts	integer	Количество попыток выполнения задания.
properties.endTime	string	Время завершения выполнения задания.
properties.jobExecutionId	string	Уникальный идентификатор выполнения задания.
properties.jobVersion	integer	Номер версии задания.
properties.lastMessage	string	Последнее состояние или сообщение об ошибке.
properties.lifecycle	JobExecutionLifecycle	Подробное состояние выполнения задания.
properties.provisioningState	ProvisioningState	Состояние подготовки ARM для выполнения задания.
properties.startTime	string	Время начала выполнения задания.
properties.stepId	integer	Идентификатор шага задания.
properties.stepName	string	Имя шага задания.
properties.target	JobExecutionTarget	Целевой объект, на который выполняется это выполнение.
type	string	Тип ресурса.

JobExecutionLifecycle

Подробное состояние выполнения задания.

Имя	Тип	Описание
Canceled	string
Created	string
Failed	string
InProgress	string
Skipped	string
Succeeded	string
SucceededWithSkipped	string
TimedOut	string
WaitingForChildJobExecutions	string
WaitingForRetry	string

JobExecutionListResult

Список выполнений заданий.

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

JobExecutionTarget

Целевой объект, в который выполняется выполнение задания.

Имя	Тип	Описание
databaseName	string	Имя базы данных.
serverName	string	Имя сервера.
type	JobTargetType	Тип цели.

JobTargetType

Тип цели.

Имя	Тип	Описание
SqlDatabase	string
SqlElasticPool	string
SqlServer	string
SqlShardMap	string
TargetGroup	string

ProvisioningState

Состояние подготовки ARM для выполнения задания.

Имя	Тип	Описание
Canceled	string
Created	string
Failed	string
InProgress	string
Succeeded	string

Job Step Executions - List By Job Execution

Параметры URI

Ответы

Примеры

List job step executions

Sample Request

Sample Response

Определения

JobExecution

JobExecutionLifecycle

JobExecutionListResult

JobExecutionTarget

JobTargetType

ProvisioningState

Дополнительные ресурсы