Job - List By Automation Account

Referência

Serviço:: Automation

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

Obtenha uma lista de tarefas.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs?api-version=2023-11-01

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs?$filter={$filter}&api-version=2023-11-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
automationAccountName	path	True	string	O nome da conta de automatização.
resourceGroupName	path	True	string	Nome de um grupo de Recursos do Azure. Padrão Regex: `^[-\w\._]+$`
subscriptionId	path	True	string	Obtém credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API de Cliente.
$filter	query		string	O filtro a aplicar na operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
clientRequestId		string	Identifica este pedido de cliente específico.

Respostas

Name	Tipo	Description
200 OK	JobListResultV2	OK
Other Status Codes	ErrorResponse	Resposta de erro de automatização que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

List jobs by automation account

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs?api-version=2023-11-01

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/job1",
      "name": "job1",
      "type": "Microsoft.Automation/AutomationAccounts/Jobs",
      "properties": {
        "jobId": "45203a94-a8cb-47c3-8ce4-4dcc3a5f7d23",
        "runbook": {
          "name": "TestRunbook"
        },
        "provisioningState": "Succeeded",
        "status": "New",
        "creationTime": "2017-03-30T05:53:30.243+00:00",
        "startTime": null,
        "lastModifiedTime": "2017-03-30T05:53:30.243+00:00",
        "endTime": null
      }
    },
    {
      "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/job2",
      "name": "job2",
      "type": "Microsoft.Automation/AutomationAccounts/Jobs",
      "properties": {
        "jobId": "7584055f-5118-460a-a2dd-5176c9c8efe9",
        "runbook": {
          "name": "TestRunbook"
        },
        "provisioningState": "Succeeded",
        "status": "Completed",
        "creationTime": "2017-03-30T05:46:49.37+00:00",
        "startTime": "2017-03-30T05:47:35.2+00:00",
        "lastModifiedTime": "2017-03-30T05:48:38.857+00:00",
        "endTime": "2017-03-30T05:48:38.857+00:00"
      }
    }
  ],
  "nextLink": null
}

Definições

Name	Description
ErrorResponse	Resposta de erro de uma falha de operação
JobCollectionItem	Propriedades do item de coleção de tarefas.
JobListResultV2	O modelo de resposta para a operação de tarefa de lista.
JobStatus	Obtém ou define o estado da tarefa.
RunbookAssociationProperty	A propriedade runbook associada à entidade.

ErrorResponse

Resposta de erro de uma falha de operação

Name	Tipo	Description
code	string	Código de erro
message	string	Mensagem de erro a indicar por que motivo a operação falhou.

JobCollectionItem

Propriedades do item de coleção de tarefas.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso
name	string	O nome do recurso
properties.creationTime	string	A hora de criação da tarefa.
properties.endTime	string	A hora de fim do trabalho.
properties.jobId	string	O ID do trabalho.
properties.lastModifiedTime	string	A última hora modificada da tarefa.
properties.provisioningState	string	O estado de aprovisionamento de um recurso.
properties.runOn	string	Especifica o nome do grupo runOn onde a tarefa foi executada.
properties.runbook	RunbookAssociationProperty	A associação de runbooks.
properties.startTime	string	A hora de início do trabalho.
properties.status	JobStatus	O estado da tarefa.
type	string	O tipo de recurso.

JobListResultV2

O modelo de resposta para a operação de tarefa de lista.

Name	Tipo	Description
nextLink	string	A ligação para a página seguinte.
value	JobCollectionItem[]	Lista de tarefas.

JobStatus

Obtém ou define o estado da tarefa.

Name	Tipo	Description
Activating	string
Blocked	string
Completed	string
Disconnected	string
Failed	string
New	string
Removing	string
Resuming	string
Running	string
Stopped	string
Stopping	string
Suspended	string
Suspending	string

RunbookAssociationProperty

A propriedade runbook associada à entidade.

Name	Tipo	Description
name	string	Obtém ou define o nome do runbook.

Partilhar via