Job Target Executions - List By Step

Referência

Service:: SQL Database

API Version:: 2021-11-01

Listas as execuções de destino de uma execução da etapa de trabalho.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
jobAgentName	path	True	string	O nome do agente de trabalho.
jobExecutionId	path	True	string uuid	A ID da execução do trabalho
jobName	path	True	string	O nome do trabalho a ser obtido.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
serverName	path	True	string	O nome do servidor.
stepName	path	True	string	O nome da etapa.
subscriptionId	path	True	string	A ID de assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.
$skip	query		integer int64	O número de elementos na coleção a serem ignoradas.
$top	query		integer int64	O número de elementos a serem retornados da coleção.
createTimeMax	query		string date-time	Se especificado, somente as execuções de trabalho criadas antes da hora especificada serão incluídas.
createTimeMin	query		string date-time	Se especificado, somente as execuções de trabalho criadas em ou após a hora especificada serão incluídas.
endTimeMax	query		string date-time	Se especificado, somente as execuções de trabalho concluídas antes da hora especificada serão incluídas.
endTimeMin	query		string date-time	Se especificado, somente as execuções de trabalho concluídas em ou após a hora especificada serão incluídas.
isActive	query		boolean	Se especificado, somente execuções de trabalho ativas ou concluídas serão incluídas.

Respostas

Nome	Tipo	Description
200 OK	JobExecutionListResult	Recuperou com êxito as execuções de destino.
Other Status Codes		Respostas de erro: *** 404 JobAgentNotFound – O agente de trabalho especificado não existe no servidor lógico especificado. 404 ResourceNotFound – O recurso solicitado não foi encontrado. 404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado 404 ServerNotInSubscriptionResourceGroup – O servidor especificado não existe no grupo de recursos e na assinatura especificados.

Nome

Tipo

Description

200 OK

JobExecutionListResult

Recuperou com êxito as execuções de destino.

Other Status Codes

Respostas de erro: ***

404 JobAgentNotFound – O agente de trabalho especificado não existe no servidor lógico especificado.
404 ResourceNotFound – O recurso solicitado não foi encontrado.
404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado
404 ServerNotInSubscriptionResourceGroup – O servidor especificado não existe no grupo de recursos e na assinatura especificados.

Exemplos

List job step target 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/step1/targets?api-version=2021-11-01


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

/** Samples for JobTargetExecutions ListByStep. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobExecutionTargetsByStep.json
     */
    /**
     * Sample code: List job step target executions.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listJobStepTargetExecutions(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobTargetExecutions().listByStep("group1", "server1", "agent1",
            "job1", UUID.fromString("5A86BF65-43AC-F258-2524-9E92992F97CA"), "step1", 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-07-01T04:33:17.5133333Z",
        "startTime": "2017-07-01T04:33:18.1230403Z",
        "endTime": "2017-07-01T04:33:18.7031029Z",
        "currentAttempts": 1,
        "currentAttemptStartTime": "2017-07-01T04:33:18.2391013Z",
        "lastMessage": "Step 1 succeeded execution on target (server 'server1', database 'database1').",
        "target": {
          "type": "SqlDatabase",
          "serverName": "server1",
          "databaseName": "database1"
        }
      },
      "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/targets/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "name": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions/steps/targets"
    }
  ]
}

Definições

Nome	Description
JobExecution	Uma execução de um trabalho
JobExecutionLifecycle	O estado detalhado da execução do trabalho.
JobExecutionListResult	Uma lista de execuções de trabalho.
JobExecutionTarget	O destino no qual uma execução de trabalho é executada.
JobTargetType	O tipo do destino.
ProvisioningState	O estado de provisionamento do ARM da execução do trabalho.

JobExecution

Uma execução de um trabalho

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

JobExecutionLifecycle

O estado detalhado da execução do trabalho.

Nome	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 trabalho.

Nome	Tipo	Description
nextLink	string	Link para recuperar a próxima página de resultados.
value	JobExecution[]	Matriz de resultados.

JobExecutionTarget

O destino no qual uma execução de trabalho é executada.

Nome	Tipo	Description
databaseName	string	Nome do banco de dados.
serverName	string	O nome do servidor.
type	JobTargetType	O tipo do destino.

JobTargetType

O tipo do destino.

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

ProvisioningState

O estado de provisionamento do ARM da execução do trabalho.

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

Job Target Executions - List By Step

Parâmetros de URI

Respostas

Exemplos

List job step target executions

Sample Request

Sample Response

Definições

JobExecution

JobExecutionLifecycle

JobExecutionListResult

JobExecutionTarget

JobTargetType

ProvisioningState

Recursos adicionais