Job - Create

Referência

Serviço:: Automation

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

Crie uma tarefa do runbook.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}?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.
jobName	path	True	string	O nome da tarefa.
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 do Cliente.

Cabeçalho do Pedido

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

Corpo do Pedido

Name	Tipo	Description
properties.parameters	object	Obtém ou define os parâmetros da tarefa.
properties.runOn	string	Obtém ou define o runOn que especifica o nome do grupo onde a tarefa vai ser executada.
properties.runbook	RunbookAssociationProperty	Obtém ou define o runbook.

Respostas

Name	Tipo	Description
201 Created	Job	Criado
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

Create job

Pedido de amostra

HTTP

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

{
  "properties": {
    "runbook": {
      "name": "TestRunbook"
    },
    "parameters": {
      "key01": "value01",
      "key02": "value02"
    },
    "runOn": ""
  }
}

Resposta da amostra

Código de estado:: 201

{
  "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/jobName",
  "name": "foo",
  "type": "Microsoft.Automation/AutomationAccounts/Jobs",
  "properties": {
    "jobId": "5b8a3960-e8ab-45f6-bec6-567df8467d1a",
    "runbook": {
      "name": "TestRunbook"
    },
    "provisioningState": "Processing",
    "creationTime": "2018-02-01T05:53:30.243+00:00",
    "endTime": null,
    "exception": null,
    "lastModifiedTime": "2018-02-01T05:53:30.243+00:00",
    "lastStatusModifiedTime": "2018-02-01T05:53:30.243+00:00",
    "startTime": null,
    "status": "New",
    "statusDetails": "None",
    "parameters": {
      "tag01": "value01",
      "tag02": "value02"
    },
    "runOn": ""
  }
}

Definições

Name	Description
ErrorResponse	Resposta de erro de uma falha de operação
Job	Definição da tarefa.
JobCreateParameters	Os parâmetros fornecidos para a operação de criação de tarefa.
JobProvisioningState	O estado de aprovisionamento atual da tarefa.
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 o motivo pela qual a operação falhou.

Job

Definição da tarefa.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso
name	string	O nome do recurso
properties.creationTime	string	Obtém ou define a hora de criação da tarefa.
properties.endTime	string	Obtém ou define a hora de fim da tarefa.
properties.exception	string	Obtém ou define a exceção da tarefa.
properties.jobId	string	Obtém ou define o ID da tarefa.
properties.lastModifiedTime	string	Obtém ou define a hora da última modificação da tarefa.
properties.lastStatusModifiedTime	string	Obtém ou define a hora da última modificação do estado da tarefa.
properties.parameters	object	Obtém ou define os parâmetros da tarefa.
properties.provisioningState	JobProvisioningState	O estado de aprovisionamento atual da tarefa.
properties.runOn	string	Obtém ou define o runOn que especifica o nome do grupo onde a tarefa vai ser executada.
properties.runbook	RunbookAssociationProperty	Obtém ou define o runbook.
properties.startTime	string	Obtém ou define a hora de início da tarefa.
properties.startedBy	string	Obtém ou define a tarefa iniciada por.
properties.status	JobStatus	Obtém ou define o estado da tarefa.
properties.statusDetails	string	Obtém ou define os detalhes de estado da tarefa.
type	string	O tipo do recurso.

JobCreateParameters

Os parâmetros fornecidos para a operação de criação de tarefa.

Name	Tipo	Description
properties.parameters	object	Obtém ou define os parâmetros da tarefa.
properties.runOn	string	Obtém ou define o runOn que especifica o nome do grupo onde a tarefa vai ser executada.
properties.runbook	RunbookAssociationProperty	Obtém ou define o runbook.

JobProvisioningState

O estado de aprovisionamento atual da tarefa.

Name	Tipo	Description
Failed	string
Processing	string
Succeeded	string
Suspended	string

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