Freigeben über

Job - Create

Dienst:
Automation
API-Version:
2024-10-23

Erstellen Sie einen Auftrag des Runbook.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
automationAccountName
 path True

string

Der Name des Automatisierungskontos.
jobName
 path True

string

Der Auftragsname.
resourceGroupName
 path True

string

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

Name einer Azure-Ressourcengruppe.
subscriptionId
 path True

string

Ruft 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

Dient zum Abrufen oder Festlegen der Parameter des Auftrags.
properties.runOn

string

Ruft den RunOn ab, der den Gruppennamen angibt, an 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-Fluss

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

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

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

Definitionen

Name Beschreibung
createdByType

Der Identitätstyp, der die Ressource erstellt hat.
ErrorResponse

Fehlerantwort eines Vorgangsfehlers
Job

Definition des Auftrags.
JobCreateParameters

Die Parameter, die für den Erstellungsauftragsvorgang bereitgestellt werden.
JobProvisioningState

Der aktuelle Bereitstellungsstatus des Auftrags.
JobRuntimeEnvironment

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

Dient zum Abrufen oder Festlegen des Status des Auftrags.
RunbookAssociationProperty

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

Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert Beschreibung
User
Application
ManagedIdentity
Key

ErrorResponse

Objekt

Fehlerantwort eines Vorgangsfehlers

Name Typ Beschreibung
code

string

Fehlercode
message

string

Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

Job

Objekt

Definition des Auftrags.

Name Typ Beschreibung
id

string (arm-id)

Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

Der Name der Ressource
properties.creationTime

string (date-time)

Ruft die Erstellungszeit des Auftrags ab oder legt sie fest.
properties.endTime

string (date-time)

Ruft die Endzeit des Auftrags ab oder legt sie fest.
properties.exception

string

Dient zum Abrufen oder Festlegen der Ausnahme des Auftrags.
properties.jobId

string (uuid)

Ruft die ID des Auftrags ab oder legt sie fest.
properties.jobRuntimeEnvironment

JobRuntimeEnvironment

Runtime Environment-Eigenschaft
properties.lastModifiedTime

string (date-time)

Ruft den Zeitpunkt der letzten Änderung des Auftrags ab oder legt sie fest.
properties.lastStatusModifiedTime

string (date-time)

Dient zum Abrufen oder Festlegen des Zeitpunkts der letzten Änderung des Auftrags.
properties.parameters

object

Dient zum Abrufen oder Festlegen der Parameter des Auftrags.
properties.provisioningState

JobProvisioningState

Der aktuelle Bereitstellungsstatus des Auftrags.
properties.runOn

string

Ruft den RunOn ab, der den Gruppennamen angibt, an 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 (date-time)

Ruft die Startzeit des Auftrags ab oder legt sie fest.
properties.startedBy

string

Ruft den Auftrag ab, der gestartet wurde, oder legt den Auftrag fest.
properties.status

JobStatus

Dient zum Abrufen oder Festlegen des Status des Auftrags.
properties.statusDetails

string

Ruft die Statusdetails des Auftrags ab oder legt diese fest.
systemData

systemData

Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

JobCreateParameters

Objekt

Die Parameter, die für den Erstellungsauftragsvorgang bereitgestellt werden.

Name Typ Beschreibung
properties.parameters

object

Dient zum Abrufen oder Festlegen der Parameter des Auftrags.
properties.runOn

string

Ruft den RunOn ab, der den Gruppennamen angibt, an dem der Auftrag ausgeführt werden soll, oder legt diesen fest.
properties.runbook

RunbookAssociationProperty

Ruft das Runbook ab oder legt es fest.

JobProvisioningState

Enumeration

Der aktuelle Bereitstellungsstatus des Auftrags.

Wert Beschreibung
Failed
Succeeded
Suspended
Processing

JobRuntimeEnvironment

Objekt

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

Name Typ Beschreibung
runtimeEnvironmentName

string

Name der Laufzeitumgebung.

JobStatus

Enumeration

Dient zum Abrufen oder Festlegen des Status des Auftrags.

Wert Beschreibung
New
Activating
Running
Completed
Failed
Stopped
Blocked
Suspended
Disconnected
Suspending
Stopping
Resuming
Removing

RunbookAssociationProperty

Objekt

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

Name Typ Beschreibung
name

string

Ruft den Namen des Runbook ab oder legt den Namen fest.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name Typ Beschreibung
createdAt

string (date-time)

Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy

string

Die Identität, die die Ressource erstellt hat.
createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt

string (date-time)

Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.