Job - Create

Servizio:: Automation

Versione API:: 2024-10-23

Creare un processo del runbook.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
automationAccountName	path	True	string	Nome dell'account di automazione.
jobName	path	True	string	Nome processo.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
clientRequestId		string	Identifica questa richiesta client specifica.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.parameters	object	Ottiene o imposta i parametri del processo.
properties.runOn	string	Ottiene o imposta il runOn che specifica il nome del gruppo in cui deve essere eseguito il processo.
properties.runbook	RunbookAssociationProperty	Ottiene o imposta il runbook.

Risposte

Nome	Tipo	Descrizione
201 Created	Job	Risorsa 'Lavoro' creato operazione di successo
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Create job

Esempio di richiesta

HTTP

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"
    }
  }
}

Risposta di esempio

Codice di stato:: 201

{
  "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"
  }
}

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
Job	Definizione del processo.
JobCreateParameters	Parametri forniti all'operazione di creazione del processo.
JobProvisioningState	Stato di provisioning della risorsa.
JobRuntimeEnvironment	Proprietà del runbook associata all'entità.
JobStatus	Ottiene o imposta lo stato del processo.
RunbookAssociationProperty	Proprietà del runbook associata all'entità.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

Job

Oggetto

Definizione del processo.

Nome	Tipo	Descrizione
id	string (arm-id)	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nome della risorsa
properties.creationTime	string (date-time)	Ottiene o imposta l'ora di creazione del processo.
properties.endTime	string (date-time)	Ottiene o imposta l'ora di fine del processo.
properties.exception	string	Ottiene o imposta l'eccezione del processo.
properties.jobId	string (uuid)	Ottiene o imposta l'ID del processo.
properties.jobRuntimeEnvironment	JobRuntimeEnvironment	Runtime Environment, proprietà
properties.lastModifiedTime	string (date-time)	Ottiene o imposta l'ora dell'ultima modifica del processo.
properties.lastStatusModifiedTime	string (date-time)	Ottiene o imposta l'ora dell'ultima modifica dello stato del processo.
properties.parameters	object	Ottiene o imposta i parametri del processo.
properties.provisioningState	JobProvisioningState	Stato di provisioning corrente del processo.
properties.runOn	string	Ottiene o imposta il runOn che specifica il nome del gruppo in cui deve essere eseguito il processo.
properties.runbook	RunbookAssociationProperty	Ottiene o imposta il runbook.
properties.startTime	string (date-time)	Ottiene o imposta l'ora di inizio del processo.
properties.startedBy	string	Ottiene o imposta il processo avviato da .
properties.status	JobStatus	Ottiene o imposta lo stato del processo.
properties.statusDetails	string	Ottiene o imposta i dettagli dello stato del processo.
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

JobCreateParameters

Oggetto

Parametri forniti all'operazione di creazione del processo.

Nome	Tipo	Descrizione
properties.parameters	object	Ottiene o imposta i parametri del processo.
properties.runOn	string	Ottiene o imposta il runOn che specifica il nome del gruppo in cui deve essere eseguito il processo.
properties.runbook	RunbookAssociationProperty	Ottiene o imposta il runbook.

JobProvisioningState

Enumerazione

Stato di provisioning della risorsa.

Valore	Descrizione
Failed	Non riuscito
Succeeded	Succeeded
Suspended	Sospeso
Processing	Elaborazione

JobRuntimeEnvironment

Oggetto

Proprietà del runbook associata all'entità.

Nome	Tipo	Descrizione
runtimeEnvironmentName	string	Nome dell'ambiente di runtime.

JobStatus

Enumerazione

Ottiene o imposta lo stato del processo.

Valore	Descrizione
New	Nuova
Activating	Attivatore
Running	In esecuzione
Completed	Finito
Failed	Non riuscito
Stopped	Fermato
Blocked	Blocked
Suspended	Sospeso
Disconnected	Scollegato
Suspending	Sospensione
Stopping	Arresto in corso
Resuming	Ripresa
Removing	Rimozione

RunbookAssociationProperty

Oggetto

Proprietà del runbook associata all'entità.

Nome	Tipo	Descrizione
name	string	Ottiene o imposta il nome del runbook.

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.