Job - Create

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 do URI

Name Em Obrigatório Tipo Descrição
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

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

subscriptionId
path True

string (uuid)

A ID da assinatura de destino. O valor deve ser um UUID.

api-version
query True

string

minLength: 1

A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name Obrigatório Tipo Descrição
clientRequestId

string

Identifica essa solicitação específica do cliente.

Corpo do Pedido

Name Tipo Descrição
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 onde o trabalho deve ser executado.

properties.runbook

RunbookAssociationProperty

Obtém ou define o runbook.

Respostas

Name Tipo Descrição
201 Created

Job

Operação de criação de recurso 'Job' foi bem-sucedida

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

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 Descrição
user_impersonation personificar a sua conta de utilizador

Exemplos

Create job

Pedido de amostra

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": {
    "parameters": {
      "key01": "value01",
      "key02": "value02"
    },
    "runOn": "",
    "runbook": {
      "name": "TestRunbook"
    }
  }
}

Resposta da amostra

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

Definições

Name Descrição
createdByType

O tipo de identidade que criou o recurso.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

Job

Definição do trabalho.

JobCreateParameters

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

JobProvisioningState

O estado de provisionamento do recurso.

JobRuntimeEnvironment

A propriedade runbook associada à entidade.

JobStatus

Obtém ou define o status do trabalho.

RunbookAssociationProperty

A propriedade runbook associada à entidade.

systemData

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

createdByType

O tipo de identidade que criou o recurso.

Valor Descrição
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Descrição
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Descrição
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O alvo do erro.

ErrorResponse

Resposta de erro

Name Tipo Descrição
error

ErrorDetail

O objeto de erro.

Job

Definição do trabalho.

Name Tipo Descrição
id

string (arm-id)

ID de recurso totalmente qualificado 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 o tempo 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 Runtime Environment

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 última hora modificada de status do trabalho.

properties.parameters

object

Obtém ou define os parâmetros do trabalho.

properties.provisioningState

JobProvisioningState

O estado atual de provisionamento do trabalho.

properties.runOn

string

Obtém ou define o runOn que especifica o nome do grupo onde 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 por.

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 contendo informações createdBy e modifiedBy.

type

string

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

JobCreateParameters

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

Name Tipo Descrição
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 onde o trabalho deve ser executado.

properties.runbook

RunbookAssociationProperty

Obtém ou define o runbook.

JobProvisioningState

O estado de provisionamento do recurso.

Valor Descrição
Failed

Falha

Succeeded

Succeeded

Suspended

Suspenso

Processing

Processing

JobRuntimeEnvironment

A propriedade runbook associada à entidade.

Name Tipo Descrição
runtimeEnvironmentName

string

Nome do ambiente de tempo de execução.

JobStatus

Obtém ou define o status do trabalho.

Valor Descrição
New

Novo

Activating

Ativando

Running

Correr

Completed

Concluído

Failed

Falha

Stopped

Parado

Blocked

Bloqueado

Suspended

Suspenso

Disconnected

Disconnected

Suspending

Suspensão

Stopping

Parar

Resuming

Retomar

Removing

Remoção

RunbookAssociationProperty

A propriedade runbook associada à entidade.

Name Tipo Descrição
name

string

Obtém ou define o nome do runbook.

systemData

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

Name Tipo Descrição
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.