Compartilhar via

Job - Create

Serviço:
Automation
Versão da API:
2024-10-23

Crie um trabalho do runbook.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}?api-version=2024-10-23

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

minLength: 1
maxLength: 90
pattern: ^[-\w\._]+$

Nome de um grupo de recursos do Azure.
subscriptionId
 path True

string

Obtém 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 descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo 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

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

{
  "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": "",
    "jobRuntimeEnvironment": {
      "runtimeEnvironmentName": "environmentName"
    }
  }
}

Definições

Nome Description
createdByType

O tipo de identidade que criou o recurso.
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.
JobRuntimeEnvironment

A propriedade runbook associada à entidade.
JobStatus

Obtém ou define o status do trabalho.
RunbookAssociationProperty

A propriedade runbook associada à entidade.
systemData

Metadados relativos à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor Description
User
Application
ManagedIdentity
Key

ErrorResponse

Objeto

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

Objeto

Definição do trabalho.

Nome Tipo Description
id

string (arm-id)

ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

O nome do recurso
properties.creationTime

string (date-time)

Obtém ou define a hora de criação do trabalho.
properties.endTime

string (date-time)

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 (uuid)

Obtém ou define a ID do trabalho.
properties.jobRuntimeEnvironment

JobRuntimeEnvironment

Propriedade de ambiente de runtime
properties.lastModifiedTime

string (date-time)

Obtém ou define a hora da última modificação do trabalho.
properties.lastStatusModifiedTime

string (date-time)

Obtém ou define a hora da última modificação de status 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 (date-time)

Obtém ou define a hora de início do trabalho.
properties.startedBy

string

Obtém ou define o trabalho iniciado.
properties.status

JobStatus

Obtém ou define o status do trabalho.
properties.statusDetails

string

Obtém ou define os detalhes de status do trabalho.
systemData

systemData

Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

JobCreateParameters

Objeto

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

Enumeração

O estado de provisionamento atual do trabalho.

Valor Description
Failed
Succeeded
Suspended
Processing

JobRuntimeEnvironment

Objeto

A propriedade runbook associada à entidade.

Nome Tipo Description
runtimeEnvironmentName

string

Nome do ambiente de runtime.

JobStatus

Enumeração

Obtém ou define o status do trabalho.

Valor Description
New
Activating
Running
Completed
Failed
Stopped
Blocked
Suspended
Disconnected
Suspending
Stopping
Resuming
Removing

RunbookAssociationProperty

Objeto

A propriedade runbook associada à entidade.

Nome Tipo Description
name

string

Obtém ou define o nome do runbook.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome Tipo Description
createdAt

string (date-time)

O carimbo de data/hora da criação de recursos (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

createdByType

O tipo de identidade que criou o recurso.
lastModifiedAt

string (date-time)

O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy

string

A identidade que modificou o recurso pela última vez.
lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.