Job - Create

Referência

Serviço:: Automation

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

Crie um trabalho 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 de URI

Nome	Em	Obrigatório	Tipo	Description
automationAccountName	path	True	string	O nome da conta de automação.
jobName	path	True	string	O nome do trabalho.
resourceGroupName	path	True	string	Nome de um grupo de recursos do Azure. Padrão Regex: `^[-\w\._]+$`
subscriptionId	path	True	string	Obtém as credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
clientRequestId		string	Identifica essa solicitação de cliente específica.

Corpo da solicitação

Nome	Tipo	Description
properties.parameters	object	Obtém ou define os parâmetros do trabalho.
properties.runOn	string	Obtém ou define o runOn que especifica o nome do grupo em que o trabalho deve ser executado.
properties.runbook	RunbookAssociationProperty	Obtém ou define o runbook.

Respostas

Nome	Tipo	Description
201 Created	Job	Criado
Other Status Codes	ErrorResponse	Resposta de erro de automação que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Create job

Solicitação de exemplo

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 de exemplo

Código de status:: 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

Nome	Description
ErrorResponse	Resposta de erro de uma falha de operação
Job	Definição do trabalho.
JobCreateParameters	Os parâmetros fornecidos para a operação de criação de trabalho.
JobProvisioningState	O estado de provisionamento atual do trabalho.
JobStatus	Obtém ou define o status do trabalho.
RunbookAssociationProperty	A propriedade runbook associada à entidade .

ErrorResponse

Resposta de erro de uma falha de operação

Nome	Tipo	Description
code	string	Código do erro
message	string	Mensagem de erro indicando por que a operação falhou.

Job

Definição do trabalho.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso
name	string	O nome do recurso
properties.creationTime	string	Obtém ou define a hora de criação do trabalho.
properties.endTime	string	Obtém ou define a hora de término do trabalho.
properties.exception	string	Obtém ou define a exceção do trabalho.
properties.jobId	string	Obtém ou define a ID do trabalho.
properties.lastModifiedTime	string	Obtém ou define a hora da última modificação do trabalho.
properties.lastStatusModifiedTime	string	Obtém ou define o último status hora modificada do trabalho.
properties.parameters	object	Obtém ou define os parâmetros do trabalho.
properties.provisioningState	JobProvisioningState	O estado de provisionamento atual do trabalho.
properties.runOn	string	Obtém ou define o runOn que especifica o nome do grupo em que o trabalho deve ser executado.
properties.runbook	RunbookAssociationProperty	Obtém ou define o runbook.
properties.startTime	string	Obtém ou define a hora de início do trabalho.
properties.startedBy	string	Obtém ou define o trabalho iniciado por.
properties.status	JobStatus	Obtém ou define o status do trabalho.
properties.statusDetails	string	Obtém ou define os detalhes status do trabalho.
type	string	Tipo do recurso.

JobCreateParameters

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

Nome	Tipo	Description
properties.parameters	object	Obtém ou define os parâmetros do trabalho.
properties.runOn	string	Obtém ou define o runOn que especifica o nome do grupo em que o trabalho deve ser executado.
properties.runbook	RunbookAssociationProperty	Obtém ou define o runbook.

JobProvisioningState

O estado de provisionamento atual do trabalho.

Nome	Tipo	Description
Failed	string
Processing	string
Succeeded	string
Suspended	string

JobStatus

Obtém ou define o status do trabalho.

Nome	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 .

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

Compartilhar via