Job Step Executions - List By Job Execution

Referência

Service:: SQL Database

API Version:: 2021-11-01

Listas as execuções de passos de uma execução de trabalho.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
jobAgentName	path	True	string	O nome do agente de tarefas.
jobExecutionId	path	True	string uuid	O ID da execução da tarefa
jobName	path	True	string	O nome da tarefa a obter.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	O ID da subscrição que identifica uma subscrição do Azure.
api-version	query	True	string	A versão da API a utilizar para o pedido.
$skip	query		integer int64	O número de elementos na coleção a ignorar.
$top	query		integer int64	O número de elementos a devolver da coleção.
createTimeMax	query		string date-time	Se especificado, só são incluídas as execuções de tarefas criadas antes da hora especificada.
createTimeMin	query		string date-time	Se for especificado, só são incluídas as execuções de tarefas criadas no ou após a hora especificada.
endTimeMax	query		string date-time	Se especificado, apenas as execuções de tarefas concluídas antes da hora especificada são incluídas.
endTimeMin	query		string date-time	Se especificado, apenas são incluídas as execuções de tarefas concluídas no ou após o tempo especificado.
isActive	query		boolean	Se especificado, só são incluídas execuções de tarefas ativas ou concluídas.

Respostas

Name	Tipo	Description
200 OK	JobExecutionListResult	As execuções de passos foram obtidas com êxito.
Other Status Codes		Respostas de Erro: *** 404 JobAgentNotFound – o agente de tarefa especificado não existe no servidor lógico especificado. 404 ResourceNotFound – o recurso pedido não foi encontrado. 404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na subscrição especificados.

Name

Tipo

Description

200 OK

JobExecutionListResult

As execuções de passos foram obtidas com êxito.

Other Status Codes

Respostas de Erro: ***

404 JobAgentNotFound – o agente de tarefa especificado não existe no servidor lógico especificado.
404 ResourceNotFound – o recurso pedido não foi encontrado.
404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado
404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na subscrição especificados.

Exemplos

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"
    }
  ]
}

Definições

Name	Description
JobExecution	Uma execução de uma tarefa
JobExecutionLifecycle	O estado detalhado da execução da tarefa.
JobExecutionListResult	Uma lista de execuções de tarefas.
JobExecutionTarget	O destino em que uma execução de tarefa é executada.
JobTargetType	O tipo de destino.
ProvisioningState	O estado de aprovisionamento do ARM da execução da tarefa.

JobExecution

Uma execução de uma tarefa

Name	Tipo	Description
id	string	ID do Recurso.
name	string	Nome do recurso.
properties.createTime	string	A hora em que a execução da tarefa foi criada.
properties.currentAttemptStartTime	string	Hora de início da tentativa atual.
properties.currentAttempts	integer	Número de vezes que a execução da tarefa foi tentada.
properties.endTime	string	A hora em que a execução da tarefa foi concluída.
properties.jobExecutionId	string	O identificador exclusivo da execução da tarefa.
properties.jobVersion	integer	O número da versão da tarefa.
properties.lastMessage	string	O último estado ou mensagem de erro.
properties.lifecycle	JobExecutionLifecycle	O estado detalhado da execução da tarefa.
properties.provisioningState	ProvisioningState	O estado de aprovisionamento do ARM da execução da tarefa.
properties.startTime	string	A hora em que a execução da tarefa foi iniciada.
properties.stepId	integer	O ID do passo da tarefa.
properties.stepName	string	O nome do passo da tarefa.
properties.target	JobExecutionTarget	O destino em que esta execução é executada.
type	string	Tipo de recurso.

JobExecutionLifecycle

O estado detalhado da execução da tarefa.

Name	Tipo	Description
Canceled	string
Created	string
Failed	string
InProgress	string
Skipped	string
Succeeded	string
SucceededWithSkipped	string
TimedOut	string
WaitingForChildJobExecutions	string
WaitingForRetry	string

JobExecutionListResult

Uma lista de execuções de tarefas.

Name	Tipo	Description
nextLink	string	Ligação para obter a página seguinte dos resultados.
value	JobExecution[]	Matriz de resultados.

JobExecutionTarget

O destino em que uma execução de tarefa é executada.

Name	Tipo	Description
databaseName	string	O nome da base de dados.
serverName	string	O nome do servidor.
type	JobTargetType	O tipo de destino.

JobTargetType

O tipo de destino.

Name	Tipo	Description
SqlDatabase	string
SqlElasticPool	string
SqlServer	string
SqlShardMap	string
TargetGroup	string

ProvisioningState

O estado de aprovisionamento do ARM da execução da tarefa.

Name	Tipo	Description
Canceled	string
Created	string
Failed	string
InProgress	string
Succeeded	string

Job Step Executions - List By Job Execution

Parâmetros do URI

Respostas

Exemplos

List job step executions

Sample Request

Sample Response

Definições

JobExecution

JobExecutionLifecycle

JobExecutionListResult

JobExecutionTarget

JobTargetType

ProvisioningState

Recursos adicionais