Jobs - List By Agent

Service:

SQL Database

API Version:

2021-11-01

Obtém uma lista de trabalhos.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs?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.

Respostas

Nome	Tipo	Description
200 OK	JobListResult	Recuperou com êxito a lista de trabalhos.
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 jobs in a job agent

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for Jobs ListByAgent. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobsByAgent.json
     */
    /**
     * Sample code: List jobs in a job agent.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listJobsInAJobAgent(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobs().listByAgent("group1", "server1", "agent1", 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": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1",
      "name": "job1",
      "type": "Microsoft.Sql/servers/jobAccounts/jobs",
      "properties": {
        "description": "my favourite job",
        "version": 0,
        "schedule": {
          "startTime": "2015-09-24T18:30:01Z",
          "endTime": "2015-09-24T23:59:59Z",
          "type": "Recurring",
          "interval": "PT5M",
          "enabled": true
        }
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job3",
      "name": "job3",
      "type": "Microsoft.Sql/servers/jobAccounts/jobs",
      "properties": {
        "description": "this job will be scheduled once",
        "version": 1,
        "schedule": {
          "startTime": "2017-07-01T03:45:00Z",
          "endTime": "2017-12-27T06:00:00Z",
          "type": "Once",
          "enabled": true
        }
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job2",
      "name": "job2",
      "type": "Microsoft.Sql/servers/jobAccounts/jobs",
      "properties": {
        "description": "this job will never be automatically scheduled",
        "version": 1,
        "schedule": {
          "startTime": "2017-07-01T03:45:00Z",
          "endTime": "2017-12-27T06:00:00Z",
          "type": "Once",
          "enabled": false
        }
      }
    }
  ]
}

Definições

Nome	Description
Job	Um trabalho.
JobListResult	Uma lista de trabalhos.
JobSchedule	Agendando propriedades de um trabalho.
JobScheduleType	Tipo de intervalo de agendamento

Job

Um trabalho.

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.description	string	Descrição definida pelo usuário do trabalho.
properties.schedule	JobSchedule	Agende as propriedades do trabalho.
properties.version	integer	O número da versão do trabalho.
type	string	Tipo de recurso.

JobListResult

Uma lista de trabalhos.

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

JobSchedule

Agendando propriedades de um trabalho.

Nome	Tipo	Valor padrão	Description
enabled	boolean		Se o agendamento está habilitado ou não.
endTime	string	9999-12-31T11:59:59+00:00	Agendar a hora de término.
interval	string		Valor do intervalo recorrente do agendamento, se o ScheduleType for recorrente. ISO8601 formato de duração.
startTime	string	0001-01-01T00:00:00+00:00	Agende a hora de início.
type	JobScheduleType	Once	Tipo de intervalo de agendamento

JobScheduleType

Tipo de intervalo de agendamento

Nome	Tipo	Description
Once	string
Recurring	string