CloudJob interface
Eine Schnittstelle, die CloudJob darstellt.
Eigenschaften
| common |
Die Liste der allgemeinen Umgebungsvariableneinstellungen. Diese Umgebungsvariablen werden für alle Aufgaben im Auftrag festgelegt (einschließlich job manager, Job Preparation and Job Release Tasks). Einzelne Aufgaben können eine hier angegebene Umgebungseinstellung außer Kraft setzen, indem sie denselben Einstellungsnamen mit einem anderen Wert angeben. |
| constraints | Die Ausführungseinschränkungen für den Auftrag. |
| creation |
Die Erstellungszeit des Auftrags. |
| display |
Der Anzeigename für den Auftrag. |
| e |
Das ETag des Auftrags. Dies ist eine undurchsichtige Zeichenfolge. Sie können es verwenden, um zu erkennen, ob sich der Auftrag zwischen Anforderungen geändert hat. Insbesondere können Sie das ETag übergeben, wenn Sie einen Auftrag aktualisieren, um anzugeben, dass Ihre Änderungen nur wirksam werden sollen, wenn niemand sonst den Auftrag in der Zwischenzeit geändert hat. |
| execution |
Die Ausführungsinformationen für den Auftrag. |
| id | Eine Zeichenfolge, die den Auftrag innerhalb des Kontos eindeutig identifiziert. Bei der ID wird die Groß-/Kleinschreibung beibehalten und die Groß-/Kleinschreibung nicht beachtet (d. h., Sie verfügen möglicherweise nicht über zwei IDs innerhalb eines Kontos, die nur nach Groß-/Kleinschreibung abweichen). |
| job |
Details zu einer Job Manager-Aufgabe, die gestartet werden soll, wenn der Auftrag gestartet wird. |
| job |
Der Vorgang zur Auftragsvorbereitung. Der Auftragsvorbereitungsvorgang ist eine spezielle Aufgabe, die auf jedem Computeknoten ausgeführt wird, bevor eine andere Aufgabe des Auftrags ausgeführt wird. |
| job |
Die Aufgabe "Auftragsfreigabe". Die Auftragsfreigabeaufgabe ist eine spezielle Aufgabe, die am Ende des Auftrags auf jedem Computeknoten ausgeführt wird, der eine andere Aufgabe des Auftrags ausgeführt hat. |
| last |
Der Zeitpunkt der letzten Änderung des Auftrags. Dies ist das letzte Mal, zu dem die Daten auf Auftragsebene, z. B. der Auftragsstatus oder die Priorität, geändert wurden. Es spielt keine Rolle bei Änderungen auf Vorgangsebene, z. B. beim Hinzufügen neuer Vorgänge oder von Vorgängen, die den Zustand ändern. |
| metadata | Eine Liste von Name-Wert-Paaren, die dem Auftrag als Metadaten zugeordnet sind. Der Batchdienst weist Metadaten keine Bedeutung zu; sie ist ausschließlich für die Verwendung von Benutzercode vorgesehen. |
| network |
Die Netzwerkkonfiguration für den Auftrag. |
| on |
Die Aktion, die der Batchdienst ausführen soll, wenn sich alle Aufgaben im Auftrag im Abgeschlossenen Zustand befinden. Der Standardwert ist keine Aktion. Mögliche Werte sind: 'noAction', 'terminateJob' |
| on |
Die Aktion, die der Batchdienst ausführen soll, wenn eine Aufgabe im Auftrag fehlschlägt. Eine Aufgabe wird als fehlgeschlagen betrachtet, wenn eine failureInfo vorhanden ist. Eine failureInfo wird festgelegt, wenn der Vorgang mit einem Nicht-Null-Beendigungscode abgeschlossen wird, nachdem die Wiederholungsanzahl aufgebraucht wurde, oder wenn ein Fehler beim Starten des Vorgangs aufgetreten ist, z. B. aufgrund eines Fehlers beim Herunterladen einer Ressourcendatei. Der Standardwert ist keine Aktion. Mögliche Werte sind: 'noAction', 'performExitOptionsJobAction' |
| pool |
Die Pooleinstellungen, die dem Auftrag zugeordnet sind. |
| previous |
Der vorherige Status des Auftrags. Diese Eigenschaft wird nicht festgelegt, wenn sich der Auftrag im anfangs aktiven Zustand befindet. Mögliche Werte sind: "aktiv", "deaktivieren", "disabled", "enabling", "terminating", "completed", "deleting" |
| previous |
Die Zeit, zu der der Auftrag seinen vorherigen Zustand eingegeben hat. Diese Eigenschaft wird nicht festgelegt, wenn sich der Auftrag im anfangs aktiven Zustand befindet. |
| priority | Die Priorität des Auftrags. Prioritätswerte können zwischen -1000 und 1000 liegen, wobei -1000 die niedrigste Priorität und 1000 die höchste Priorität sind. Der Standardwert ist 0. |
| state | Der aktuelle Status des Auftrags. Mögliche Werte sind: "aktiv", "deaktivieren", "disabled", "enabling", "terminating", "completed", "deleting" |
| state |
Die Zeit, zu der der Auftrag seinen aktuellen Zustand eingegeben hat. |
| stats | Ressourcennutzungsstatistiken für die gesamte Lebensdauer des Auftrags. Diese Eigenschaft wird nur aufgefüllt, wenn der CloudJob mit einer Erweiterungsklausel abgerufen wurde, einschließlich des Attributs "stats"; andernfalls ist sie NULL. Die Statistiken sind möglicherweise nicht sofort verfügbar. Der Batchdienst führt regelmäßige Rollups von Statistiken durch. Die typische Verzögerung beträgt ca. 30 Minuten. |
| url | Die URL des Auftrags. |
| uses |
Gibt an, ob Aufgaben im Auftrag Abhängigkeiten voneinander definieren können. Der Standardwert ist "false". |
Details zur Eigenschaft
commonEnvironmentSettings
Die Liste der allgemeinen Umgebungsvariableneinstellungen. Diese Umgebungsvariablen werden für alle Aufgaben im Auftrag festgelegt (einschließlich job manager, Job Preparation and Job Release Tasks). Einzelne Aufgaben können eine hier angegebene Umgebungseinstellung außer Kraft setzen, indem sie denselben Einstellungsnamen mit einem anderen Wert angeben.
commonEnvironmentSettings?: EnvironmentSetting[]
Eigenschaftswert
constraints
Die Ausführungseinschränkungen für den Auftrag.
constraints?: JobConstraints
Eigenschaftswert
creationTime
Die Erstellungszeit des Auftrags.
creationTime?: Date
Eigenschaftswert
Date
displayName
Der Anzeigename für den Auftrag.
displayName?: string
Eigenschaftswert
string
eTag
Das ETag des Auftrags. Dies ist eine undurchsichtige Zeichenfolge. Sie können es verwenden, um zu erkennen, ob sich der Auftrag zwischen Anforderungen geändert hat. Insbesondere können Sie das ETag übergeben, wenn Sie einen Auftrag aktualisieren, um anzugeben, dass Ihre Änderungen nur wirksam werden sollen, wenn niemand sonst den Auftrag in der Zwischenzeit geändert hat.
eTag?: string
Eigenschaftswert
string
executionInfo
Die Ausführungsinformationen für den Auftrag.
executionInfo?: JobExecutionInformation
Eigenschaftswert
id
Eine Zeichenfolge, die den Auftrag innerhalb des Kontos eindeutig identifiziert. Bei der ID wird die Groß-/Kleinschreibung beibehalten und die Groß-/Kleinschreibung nicht beachtet (d. h., Sie verfügen möglicherweise nicht über zwei IDs innerhalb eines Kontos, die nur nach Groß-/Kleinschreibung abweichen).
id?: string
Eigenschaftswert
string
jobManagerTask
Details zu einer Job Manager-Aufgabe, die gestartet werden soll, wenn der Auftrag gestartet wird.
jobManagerTask?: JobManagerTask
Eigenschaftswert
jobPreparationTask
Der Vorgang zur Auftragsvorbereitung. Der Auftragsvorbereitungsvorgang ist eine spezielle Aufgabe, die auf jedem Computeknoten ausgeführt wird, bevor eine andere Aufgabe des Auftrags ausgeführt wird.
jobPreparationTask?: JobPreparationTask
Eigenschaftswert
jobReleaseTask
Die Aufgabe "Auftragsfreigabe". Die Auftragsfreigabeaufgabe ist eine spezielle Aufgabe, die am Ende des Auftrags auf jedem Computeknoten ausgeführt wird, der eine andere Aufgabe des Auftrags ausgeführt hat.
jobReleaseTask?: JobReleaseTask
Eigenschaftswert
lastModified
Der Zeitpunkt der letzten Änderung des Auftrags. Dies ist das letzte Mal, zu dem die Daten auf Auftragsebene, z. B. der Auftragsstatus oder die Priorität, geändert wurden. Es spielt keine Rolle bei Änderungen auf Vorgangsebene, z. B. beim Hinzufügen neuer Vorgänge oder von Vorgängen, die den Zustand ändern.
lastModified?: Date
Eigenschaftswert
Date
metadata
Eine Liste von Name-Wert-Paaren, die dem Auftrag als Metadaten zugeordnet sind. Der Batchdienst weist Metadaten keine Bedeutung zu; sie ist ausschließlich für die Verwendung von Benutzercode vorgesehen.
metadata?: MetadataItem[]
Eigenschaftswert
networkConfiguration
Die Netzwerkkonfiguration für den Auftrag.
networkConfiguration?: JobNetworkConfiguration
Eigenschaftswert
onAllTasksComplete
Die Aktion, die der Batchdienst ausführen soll, wenn sich alle Aufgaben im Auftrag im Abgeschlossenen Zustand befinden. Der Standardwert ist keine Aktion. Mögliche Werte sind: 'noAction', 'terminateJob'
onAllTasksComplete?: OnAllTasksComplete
Eigenschaftswert
onTaskFailure
Die Aktion, die der Batchdienst ausführen soll, wenn eine Aufgabe im Auftrag fehlschlägt. Eine Aufgabe wird als fehlgeschlagen betrachtet, wenn eine failureInfo vorhanden ist. Eine failureInfo wird festgelegt, wenn der Vorgang mit einem Nicht-Null-Beendigungscode abgeschlossen wird, nachdem die Wiederholungsanzahl aufgebraucht wurde, oder wenn ein Fehler beim Starten des Vorgangs aufgetreten ist, z. B. aufgrund eines Fehlers beim Herunterladen einer Ressourcendatei. Der Standardwert ist keine Aktion. Mögliche Werte sind: 'noAction', 'performExitOptionsJobAction'
onTaskFailure?: OnTaskFailure
Eigenschaftswert
poolInfo
Die Pooleinstellungen, die dem Auftrag zugeordnet sind.
poolInfo?: PoolInformation
Eigenschaftswert
previousState
Der vorherige Status des Auftrags. Diese Eigenschaft wird nicht festgelegt, wenn sich der Auftrag im anfangs aktiven Zustand befindet. Mögliche Werte sind: "aktiv", "deaktivieren", "disabled", "enabling", "terminating", "completed", "deleting"
previousState?: JobState
Eigenschaftswert
previousStateTransitionTime
Die Zeit, zu der der Auftrag seinen vorherigen Zustand eingegeben hat. Diese Eigenschaft wird nicht festgelegt, wenn sich der Auftrag im anfangs aktiven Zustand befindet.
previousStateTransitionTime?: Date
Eigenschaftswert
Date
priority
Die Priorität des Auftrags. Prioritätswerte können zwischen -1000 und 1000 liegen, wobei -1000 die niedrigste Priorität und 1000 die höchste Priorität sind. Der Standardwert ist 0.
priority?: number
Eigenschaftswert
number
state
Der aktuelle Status des Auftrags. Mögliche Werte sind: "aktiv", "deaktivieren", "disabled", "enabling", "terminating", "completed", "deleting"
state?: JobState
Eigenschaftswert
stateTransitionTime
Die Zeit, zu der der Auftrag seinen aktuellen Zustand eingegeben hat.
stateTransitionTime?: Date
Eigenschaftswert
Date
stats
Ressourcennutzungsstatistiken für die gesamte Lebensdauer des Auftrags. Diese Eigenschaft wird nur aufgefüllt, wenn der CloudJob mit einer Erweiterungsklausel abgerufen wurde, einschließlich des Attributs "stats"; andernfalls ist sie NULL. Die Statistiken sind möglicherweise nicht sofort verfügbar. Der Batchdienst führt regelmäßige Rollups von Statistiken durch. Die typische Verzögerung beträgt ca. 30 Minuten.
stats?: JobStatistics
Eigenschaftswert
url
Die URL des Auftrags.
url?: string
Eigenschaftswert
string
usesTaskDependencies
Gibt an, ob Aufgaben im Auftrag Abhängigkeiten voneinander definieren können. Der Standardwert ist "false".
usesTaskDependencies?: boolean
Eigenschaftswert
boolean