Jobs - List By Agent

Serviço:

SQL Database

Versão da API:

2021-11-01

Obtém uma lista de tarefas.

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

Respostas

Name	Tipo	Description
200 OK	JobListResult	A lista de tarefas 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 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 jobs in a job agent

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?api-version=2021-11-01

Java

/**
 * 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",
            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

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

Name	Description
Job	Um trabalho.
JobListResult	Uma lista de tarefas.
JobSchedule	Propriedades de agendamento de uma tarefa.
JobScheduleType	Tipo de intervalo de agenda

Job

Object

Um trabalho.

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

JobListResult

Object

Uma lista de tarefas.

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

JobSchedule

Object

Propriedades de agendamento de uma tarefa.

Name	Tipo	Default value	Description
enabled	boolean		Se a agenda está ou não ativada.
endTime	string	9999-12-31T11:59:59+00:00	Agendar hora de fim.
interval	string		Valor do intervalo periódico da agenda, se o ScheduleType for periódico. ISO8601 formato de duração.
startTime	string	0001-01-01T00:00:00+00:00	Agendar hora de início.
type	JobScheduleType	Once	Tipo de intervalo de agenda

JobScheduleType

Enumeration

Tipo de intervalo de agenda

Valor	Description
Once
Recurring