Job - Create

Referenz

Dienst:: Automation

API-Version:: 2023-11-01

Erstellen Sie einen Auftrag des Runbooks.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
automationAccountName	path	True	string	Der Name des Automation-Kontos.
jobName	path	True	string	Der Auftragsname.
resourceGroupName	path	True	string	Name einer Azure-Ressourcengruppe. RegEx-Muster: `^[-\w\._]+$`
subscriptionId	path	True	string	Ruft die Abonnementanmeldeinformationen ab, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
clientRequestId		string	Identifiziert diese spezifische Clientanforderung.

Anforderungstext

Name	Typ	Beschreibung
properties.parameters	object	Ruft die Parameter des Auftrags ab oder legt sie fest.
properties.runOn	string	Ruft den runOn ab, der den Gruppennamen angibt, in dem der Auftrag ausgeführt werden soll, oder legt diesen fest.
properties.runbook	RunbookAssociationProperty	Ruft das Runbook ab oder legt es fest.

Antworten

Name	Typ	Beschreibung
201 Created	Job	Erstellt
Other Status Codes	ErrorResponse	Automatisierungsfehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Create job

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
ErrorResponse	Fehlerantwort eines Vorgangsfehlers
Job	Definition des Auftrags.
JobCreateParameters	Die Parameter, die für den Vorgang zum Erstellen des Auftrags angegeben werden.
JobProvisioningState	Der aktuelle Bereitstellungsstatus des Auftrags.
JobStatus	Ruft den status des Auftrags ab oder legt diese fest.
RunbookAssociationProperty	Die runbook-Eigenschaft, die der Entität zugeordnet ist.

ErrorResponse

Fehlerantwort eines Vorgangsfehlers

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

Job

Definition des Auftrags.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource
name	string	Der Name der Ressource
properties.creationTime	string	Ruft die Erstellungszeit des Auftrags ab oder legt diese fest.
properties.endTime	string	Ruft die Endzeit des Auftrags ab oder legt diese fest.
properties.exception	string	Ruft die Ausnahme des Auftrags ab oder legt diese fest.
properties.jobId	string	Ruft die ID des Auftrags ab oder legt sie fest.
properties.lastModifiedTime	string	Ruft den Zeitpunkt der letzten Änderung des Auftrags ab oder legt diese fest.
properties.lastStatusModifiedTime	string	Ruft die letzte status Änderungszeit des Auftrags ab oder legt sie fest.
properties.parameters	object	Ruft die Parameter des Auftrags ab oder legt sie fest.
properties.provisioningState	JobProvisioningState	Der aktuelle Bereitstellungsstatus des Auftrags.
properties.runOn	string	Ruft den runOn ab, der den Gruppennamen angibt, in dem der Auftrag ausgeführt werden soll, oder legt diesen fest.
properties.runbook	RunbookAssociationProperty	Ruft das Runbook ab oder legt es fest.
properties.startTime	string	Ruft die Startzeit des Auftrags ab oder legt diese fest.
properties.startedBy	string	Ruft den von gestarteten Auftrag ab oder legt diese fest.
properties.status	JobStatus	Ruft den status des Auftrags ab oder legt diese fest.
properties.statusDetails	string	Ruft die status Details des Auftrags ab oder legt sie fest.
type	string	Der Typ der Ressource.

JobCreateParameters

Die Parameter, die für den Vorgang zum Erstellen des Auftrags angegeben werden.

Name	Typ	Beschreibung
properties.parameters	object	Ruft die Parameter des Auftrags ab oder legt sie fest.
properties.runOn	string	Ruft den runOn ab, der den Gruppennamen angibt, in dem der Auftrag ausgeführt werden soll, oder legt diesen fest.
properties.runbook	RunbookAssociationProperty	Ruft das Runbook ab oder legt es fest.

JobProvisioningState

Der aktuelle Bereitstellungsstatus des Auftrags.

Name	Typ	Beschreibung
Failed	string
Processing	string
Succeeded	string
Suspended	string

JobStatus

Ruft den status des Auftrags ab oder legt diese fest.

Name	Typ	Beschreibung
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

Die runbook-Eigenschaft, die der Entität zugeordnet ist.

Name	Typ	Beschreibung
name	string	Ruft den Namen des Runbooks ab oder legt den Namen fest.

Freigeben über