Job Step Executions - Get

Serviço:

SQL Database

Versão da API:

2021-11-01

Obtém um passo de execução de uma tarefa.

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

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 exclusivo 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.
stepName	path	True	string	O nome do passo.
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.

Respostas

Name	Tipo	Description
200 OK	JobExecution	A execução do passo foi obtida 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. 404 ResourceNotFound – o recurso pedido não foi encontrado.

Exemplos

Get a job step execution

Pedido de amostra

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

Resposta da amostra

Código de estado:

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

Definições

Name	Description
JobExecution	Uma execução de uma tarefa
JobExecutionLifecycle	O estado detalhado da execução da tarefa.
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

Object

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

Enumeration

O estado detalhado da execução da tarefa.

Valor	Description
Canceled
Created
Failed
InProgress
Skipped
Succeeded
SucceededWithSkipped
TimedOut
WaitingForChildJobExecutions
WaitingForRetry

JobExecutionTarget

Object

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

Enumeration

O tipo de destino.

Valor	Description
SqlDatabase
SqlElasticPool
SqlServer
SqlShardMap
TargetGroup

ProvisioningState

Enumeration

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

Valor	Description
Canceled
Created
Failed
InProgress
Succeeded