Job Executions - List By Agent

Referência

Serviço:: SQL Database

Versão da API:: 2021-11-01

Listas todas as execuções em um agente de trabalho.

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

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/executions?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.
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.
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	Execuções de trabalho recuperadas com êxito.
Other Status Codes		Respostas de erro: *** 404 JobAgentNotFound – O agente de trabalho especificado não existe no servidor lógico especificado. 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

Execuções de trabalho recuperadas com êxito.

Other Status Codes

Respostas de erro: ***

404 JobAgentNotFound – O agente de trabalho especificado não existe no servidor lógico especificado.
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 all job executions in a job agent with filtering.

List all job executions in a job agent.

List all job executions in a job agent with filtering.

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/executions?createTimeMin=2017-03-21T19:00:00Z&createTimeMax=2017-03-21T19:05:00Z&endTimeMin=2017-03-21T19:20:00Z&endTimeMax=2017-03-21T19:25:00Z&isActive=False&api-version=2021-11-01


import java.time.OffsetDateTime;

/**
 * Samples for JobExecutions ListByAgent.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobExecutionsByAgentWithFilter.
     * json
     */
    /**
     * Sample code: List all job executions in a job agent with filtering.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        listAllJobExecutionsInAJobAgentWithFiltering(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobExecutions().listByAgent("group1", "server1", "agent1",
            OffsetDateTime.parse("2017-03-21T19:00:00Z"), OffsetDateTime.parse("2017-03-21T19:05:00Z"),
            OffsetDateTime.parse("2017-03-21T19:20:00Z"), OffsetDateTime.parse("2017-03-21T19:25:00Z"), false, null,
            null, 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 de exemplo

Código de status:: 200

{
  "value": [
    {
      "properties": {
        "jobVersion": 1,
        "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
        "lifecycle": "Created",
        "provisioningState": "Created",
        "createTime": "2017-03-21T19:02:00.8707045Z",
        "startTime": "2017-03-21T19:12:00.8707045Z",
        "endTime": "2017-03-21T19:22:00.8707045Z",
        "currentAttempts": 0,
        "currentAttemptStartTime": "2017-03-21T19:12:00.8707045Z",
        "lastMessage": "Job execution created."
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999",
      "name": "5555-6666-7777-8888-999999999999",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions"
    },
    {
      "properties": {
        "jobVersion": 1,
        "jobExecutionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
        "lifecycle": "Succeeded",
        "provisioningState": "Succeeded",
        "createTime": "2017-12-15T19:02:00.8707045Z",
        "startTime": "2017-12-15T19:12:00.8707045Z",
        "endTime": "2017-12-15T19:22:00.8707045Z",
        "currentAttempts": 1,
        "lastMessage": "Job execution succeeded."
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job2/executions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "name": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions"
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1//executions?api-version=2017-03-01-preview&%24skip=2"
}

List all job executions in a job agent.

Solicitação de exemplo

HTTP
Java

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/executions?api-version=2021-11-01


/**
 * Samples for JobExecutions ListByAgent.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobExecutionsByAgent.json
     */
    /**
     * Sample code: List all job executions in a job agent.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAllJobExecutionsInAJobAgent(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobExecutions().listByAgent("group1", "server1", "agent1", null,
            null, null, null, null, null, null, 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 de exemplo

Código de status:: 200

{
  "value": [
    {
      "properties": {
        "jobVersion": 1,
        "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
        "lifecycle": "Created",
        "provisioningState": "Created",
        "createTime": "2017-03-21T19:02:00.8707045Z",
        "startTime": "2017-03-21T19:12:00.8707045Z",
        "endTime": "2017-03-21T19:22:00.8707045Z",
        "currentAttempts": 0,
        "currentAttemptStartTime": "2017-03-21T19:12:00.8707045Z",
        "lastMessage": "Job execution created."
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999",
      "name": "5555-6666-7777-8888-999999999999",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions"
    },
    {
      "properties": {
        "jobVersion": 1,
        "jobExecutionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
        "lifecycle": "Succeeded",
        "provisioningState": "Succeeded",
        "createTime": "2017-12-15T19:02:00.8707045Z",
        "startTime": "2017-12-15T19:12:00.8707045Z",
        "endTime": "2017-12-15T19:22:00.8707045Z",
        "currentAttempts": 1,
        "lastMessage": "Job execution succeeded."
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job2/executions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "name": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions"
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1//executions?api-version=2017-03-01-preview&%24skip=2"
}

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

Compartilhar via

Job Executions - List By Agent

Parâmetros de URI

Respostas

Exemplos

List all job executions in a job agent with filtering.

Solicitação de exemplo

Resposta de exemplo

List all job executions in a job agent.

Solicitação de exemplo

Resposta de exemplo

Definições

JobExecution

JobExecutionLifecycle

JobExecutionListResult

JobExecutionTarget

JobTargetType

ProvisioningState

Recursos adicionais