Job Step Executions - Get

Служба:

SQL Database

Версия API:

2021-11-01

Возвращает выполнение шага выполнения задания.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}?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	Имя сервера.
stepName	path	True	string	Имя шага этапа.
subscriptionId	path	True	string	Идентификатор подписки Azure.
api-version	query	True	string	Версия API для использования в запросе.

Ответы

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

Примеры

Get a job step execution

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

HTTP

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/step1?api-version=2021-11-01

Java

import java.util.UUID;

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

{
  "properties": {
    "jobVersion": 1,
    "stepName": "step1",
    "stepId": 1,
    "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
    "lifecycle": "Succeeded",
    "provisioningState": "Succeeded",
    "createTime": "2017-12-27T04:33:15.7189151Z",
    "startTime": "2017-12-27T04:33:16.176937Z",
    "endTime": "2017-12-27T04:33:19.0600862Z",
    "currentAttempts": 1,
    "currentAttemptStartTime": "2017-12-27T04: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	Подробное состояние выполнения задания.
JobExecutionTarget	Целевой объект, на который выполняется задание.
JobTargetType	Тип цели.
ProvisioningState	Состояние подготовки ARM для выполнения задания.

JobExecution

Object

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

Имя	Тип	Описание
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

Enumeration

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

Значение	Описание
Canceled
Created
Failed
InProgress
Skipped
Succeeded
SucceededWithSkipped
TimedOut
WaitingForChildJobExecutions
WaitingForRetry

JobExecutionTarget

Object

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

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

JobTargetType

Enumeration

Тип цели.

Значение	Описание
SqlDatabase
SqlElasticPool
SqlServer
SqlShardMap
TargetGroup

ProvisioningState

Enumeration

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

Значение	Описание
Canceled
Created
Failed
InProgress
Succeeded