Job class

Erstellen sie einen Auftrag.

new Job(client: BatchServiceClientContext)

Parameter

Der Batchdienst unterstützt zwei Möglichkeiten zum Steuern der Arbeit als Teil eines Auftrags. Im ersten Ansatz gibt der Benutzer eine Auftrags-Manager-Aufgabe an. Der Batchdienst startet diese Aufgabe, wenn sie bereit ist, den Auftrag zu starten. Der Auftrags-Manager-Vorgang steuert alle anderen Aufgaben, die unter diesem Auftrag ausgeführt werden, mithilfe der Aufgaben-APIs. Im zweiten Ansatz steuert der Benutzer die Ausführung von Aufgaben unter einem aktiven Auftrag mithilfe der Aufgaben-APIs direkt. Hinweis: Vermeiden Sie beim Benennen von Aufträgen vertrauliche Informationen wie Benutzernamen oder geheime Projektnamen. Diese Informationen können in Telemetrieprotokollen angezeigt werden, auf die microsoft-Supporttechniker zugreifen können.

function add(job: JobAddParameter, options?: JobAddOptionalParams): Promise<JobAddResponse>

Parameter

Gibt zurück

Zusage<Models.JobAddResponse>

function add(job: JobAddParameter, options: JobAddOptionalParams, callback: ServiceCallback<void>)

Parameter

function add(job: JobAddParameter, callback: ServiceCallback<void>)

Parameter

Durch das Löschen eines Auftrags werden auch alle Aufgaben gelöscht, die Teil dieses Auftrags sind, und alle Auftragsstatistiken. Dadurch wird auch der Aufbewahrungszeitraum für Vorgangsdaten außer Kraft gesetzt; Das heißt, wenn der Auftrag Aufgaben enthält, die weiterhin auf Computeknoten aufbewahrt werden, löscht die Batchdienste die Arbeitsverzeichnisse dieser Aufgaben und alle ihre Inhalte. Wenn eine Löschauftragsanforderung empfangen wird, legt der Batchdienst den Auftrag auf den Löschstatus fest. Alle Aktualisierungsvorgänge für einen Auftrag, der sich im Löschzustand befindet, schlagen mit dem Statuscode 409 (Konflikt) fehl, mit zusätzlichen Informationen, die angeben, dass der Auftrag gelöscht wird.

function deleteMethod(jobId: string, options?: JobDeleteMethodOptionalParams): Promise<JobDeleteResponse>

Parameter

Gibt zurück

Promise<Models.JobDeleteResponse>

function deleteMethod(jobId: string, options: JobDeleteMethodOptionalParams, callback: ServiceCallback<void>)

Parameter

function deleteMethod(jobId: string, callback: ServiceCallback<void>)

Parameter

Der Batchdienst verschiebt den Auftrag sofort in den Deaktivierungszustand. Batch verwendet dann den parameter disableTasks, um zu bestimmen, was mit den derzeit ausgeführten Aufgaben des Auftrags zu tun ist. Der Auftrag verbleibt im Deaktivierungszustand, bis der Deaktivierungsvorgang abgeschlossen ist und alle Aufgaben gemäß der Option "disableTasks" behandelt wurden. der Auftrag wechselt dann in den Status "Deaktiviert". Es werden keine neuen Aufgaben unter dem Auftrag gestartet, bis sie wieder in den aktiven Zustand verschoben wird. Wenn Sie versuchen, einen Auftrag zu deaktivieren, der nicht aktiv, deaktiviert oder deaktiviert ist, schlägt die Anforderung mit dem Statuscode 409 fehl.

function disable(jobId: string, disableTasks: DisableJobOption, options?: JobDisableOptionalParams): Promise<JobDisableResponse>

Parameter

Gibt zurück

Promise<Models.JobDisableResponse>

function disable(jobId: string, disableTasks: DisableJobOption, options: JobDisableOptionalParams, callback: ServiceCallback<void>)

Parameter

function disable(jobId: string, disableTasks: DisableJobOption, callback: ServiceCallback<void>)

Parameter

Wenn Sie diese API aufrufen, legt der Batchdienst einen deaktivierten Auftrag auf den Aktivierungsstatus fest. Nach Abschluss dieses Vorgangs wechselt der Auftrag in den aktiven Zustand und die Planung neuer Vorgänge unter dem Auftrag fortsetzen. Der Batchdienst lässt nicht zu, dass ein Vorgang länger als 180 Tage im aktiven Zustand verbleibt. Wenn Sie daher einen Auftrag aktivieren, der aktive Aufgaben enthält, die vor mehr als 180 Tagen hinzugefügt wurden, werden diese Aufgaben nicht ausgeführt.

function enable(jobId: string, options?: JobEnableOptionalParams): Promise<JobEnableResponse>

Parameter

Gibt zurück

Zusage<Models.JobEnableResponse>

function enable(jobId: string, options: JobEnableOptionalParams, callback: ServiceCallback<void>)

Parameter

function enable(jobId: string, callback: ServiceCallback<void>)

Parameter

function get(jobId: string, options?: JobGetOptionalParams): Promise<JobGetResponse>

Parameter

Gibt zurück

Zusage<Models.JobGetResponse>

function get(jobId: string, options: JobGetOptionalParams, callback: ServiceCallback<CloudJob>)

Parameter

function get(jobId: string, callback: ServiceCallback<CloudJob>)

Parameter

Statistiken werden in allen Aufträgen aggregiert, die je im Konto vorhanden sind, von der Kontoerstellung bis zur letzten Aktualisierungszeit der Statistik. 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.

function getAllLifetimeStatistics(options?: JobGetAllLifetimeStatisticsOptionalParams): Promise<JobGetAllLifetimeStatisticsResponse>

Parameter

Gibt zurück

Promise<Models.JobGetAllLifetimeStatisticsResponse>

function getAllLifetimeStatistics(options: JobGetAllLifetimeStatisticsOptionalParams, callback: ServiceCallback<JobStatistics>)

Parameter

function getAllLifetimeStatistics(callback: ServiceCallback<JobStatistics>)

Parameter

Aufgabenanzahlen stellen eine Anzahl der Aufgaben nach aktivem, ausgeführtem oder abgeschlossenem Vorgangsstatus und einer Anzahl von Aufgaben bereit, die erfolgreich waren oder fehlgeschlagen sind. Aufgaben im Vorbereitungszustand werden als ausgeführt gezählt. Beachten Sie, dass die zurückgegebenen Zahlen möglicherweise nicht immer auf dem neuesten Stand sind. Wenn Sie genaue Vorgangsanzahlen benötigen, verwenden Sie eine Listenabfrage.

function getTaskCounts(jobId: string, options?: JobGetTaskCountsOptionalParams): Promise<JobGetTaskCountsResponse>

Parameter

Gibt zurück

Promise<Models.JobGetTaskCountsResponse>

function getTaskCounts(jobId: string, options: JobGetTaskCountsOptionalParams, callback: ServiceCallback<TaskCountsResult>)

Parameter

function getTaskCounts(jobId: string, callback: ServiceCallback<TaskCountsResult>)

Parameter

function list(options?: JobListOptionalParams): Promise<JobListResponse>

Parameter

Gibt zurück

Zusage<Models.JobListResponse>

function list(options: JobListOptionalParams, callback: ServiceCallback<CloudJobListResult>)

Parameter

function list(callback: ServiceCallback<CloudJobListResult>)

Parameter

function listFromJobSchedule(jobScheduleId: string, options?: JobListFromJobScheduleOptionalParams): Promise<JobListFromJobScheduleResponse>

Parameter

Gibt zurück

Promise<Models.JobListFromJobScheduleResponse>

function listFromJobSchedule(jobScheduleId: string, options: JobListFromJobScheduleOptionalParams, callback: ServiceCallback<CloudJobListResult>)

Parameter

function listFromJobSchedule(jobScheduleId: string, callback: ServiceCallback<CloudJobListResult>)

Parameter

function listFromJobScheduleNext(nextPageLink: string, options?: JobListFromJobScheduleNextOptionalParams): Promise<JobListFromJobScheduleResponse>

Parameter

Gibt zurück

Promise<Models.JobListFromJobScheduleResponse>

function listFromJobScheduleNext(nextPageLink: string, options: JobListFromJobScheduleNextOptionalParams, callback: ServiceCallback<CloudJobListResult>)

Parameter

function listFromJobScheduleNext(nextPageLink: string, callback: ServiceCallback<CloudJobListResult>)

Parameter

function listNext(nextPageLink: string, options?: JobListNextOptionalParams): Promise<JobListResponse>

Parameter

Gibt zurück

Zusage<Models.JobListResponse>

function listNext(nextPageLink: string, options: JobListNextOptionalParams, callback: ServiceCallback<CloudJobListResult>)

Parameter

function listNext(nextPageLink: string, callback: ServiceCallback<CloudJobListResult>)

Parameter

Diese API gibt den Auftragsvorbereitungs- und Auftragsveröffentlichungsvorgangsstatus für alle Computeknoten zurück, die die Aufgabe "Auftragsvorbereitung" oder "Auftragsfreigabe" ausgeführt haben. Dazu gehören Computeknoten, die seitdem aus dem Pool entfernt wurden. Wenn diese API für einen Auftrag aufgerufen wird, der keine Auftragsvorbereitungs- oder Auftragsfreigabeaufgabe enthält, gibt der Batchdienst DEN HTTP-Statuscode 409 (Conflict) mit einem Fehlercode von JobPreparationTaskNotSpecified zurück.

function listPreparationAndReleaseTaskStatus(jobId: string, options?: JobListPreparationAndReleaseTaskStatusOptionalParams): Promise<JobListPreparationAndReleaseTaskStatusResponse>

Parameter

Gibt zurück

Promise<Models.JobListPreparationAndReleaseTaskStatusResponse>

function listPreparationAndReleaseTaskStatus(jobId: string, options: JobListPreparationAndReleaseTaskStatusOptionalParams, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)

Parameter

function listPreparationAndReleaseTaskStatus(jobId: string, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)

Parameter

Diese API gibt den Auftragsvorbereitungs- und Auftragsveröffentlichungsvorgangsstatus für alle Computeknoten zurück, die die Aufgabe "Auftragsvorbereitung" oder "Auftragsfreigabe" ausgeführt haben. Dazu gehören Computeknoten, die seitdem aus dem Pool entfernt wurden. Wenn diese API für einen Auftrag aufgerufen wird, der keine Auftragsvorbereitungs- oder Auftragsfreigabeaufgabe enthält, gibt der Batchdienst DEN HTTP-Statuscode 409 (Conflict) mit einem Fehlercode von JobPreparationTaskNotSpecified zurück.

function listPreparationAndReleaseTaskStatusNext(nextPageLink: string, options?: JobListPreparationAndReleaseTaskStatusNextOptionalParams): Promise<JobListPreparationAndReleaseTaskStatusResponse>

Parameter

Gibt zurück

Promise<Models.JobListPreparationAndReleaseTaskStatusResponse>

function listPreparationAndReleaseTaskStatusNext(nextPageLink: string, options: JobListPreparationAndReleaseTaskStatusNextOptionalParams, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)

Parameter

function listPreparationAndReleaseTaskStatusNext(nextPageLink: string, callback: ServiceCallback<CloudJobListPreparationAndReleaseTaskStatusResult>)

Parameter

Dadurch werden nur die in der Anforderung angegebenen Auftragseigenschaften ersetzt. Wenn der Auftrag z. B. Einschränkungen aufweist und eine Anforderung nicht das Einschränkungselement angibt, behält der Auftrag die vorhandenen Einschränkungen bei.

function patch(jobId: string, jobPatchParameter: JobPatchParameter, options?: JobPatchOptionalParams): Promise<JobPatchResponse>

Parameter

Gibt zurück

Zusage<Models.JobPatchResponse>

function patch(jobId: string, jobPatchParameter: JobPatchParameter, options: JobPatchOptionalParams, callback: ServiceCallback<void>)

Parameter

function patch(jobId: string, jobPatchParameter: JobPatchParameter, callback: ServiceCallback<void>)

Parameter

Wenn eine Terminierungsauftragsanforderung empfangen wird, legt der Batchdienst den Auftrag auf den Beendigungszustand fest. Der Batchdienst beendet dann alle ausgeführten Aufgaben, die dem Auftrag zugeordnet sind, und führt alle erforderlichen Aufgaben für die Auftragsfreigabe aus. Anschließend wechselt der Auftrag in den abgeschlossenen Zustand. Wenn der Auftrag im aktiven Zustand enthalten ist, verbleiben sie im aktiven Zustand. Nachdem ein Auftrag beendet wurde, können keine neuen Vorgänge hinzugefügt werden, und alle verbleibenden aktiven Vorgänge werden nicht geplant.

function terminate(jobId: string, options?: JobTerminateOptionalParams): Promise<JobTerminateResponse>

Parameter

Gibt zurück

Zusage<Models.JobTerminateResponse>

function terminate(jobId: string, options: JobTerminateOptionalParams, callback: ServiceCallback<void>)

Parameter

function terminate(jobId: string, callback: ServiceCallback<void>)

Parameter

Dadurch werden alle aktualisierbaren Eigenschaften des Auftrags vollständig ersetzt. Wenn z. B. der Auftrag Einschränkungen zugeordnet hat und Einschränkungen nicht mit dieser Anforderung angegeben werden, entfernt der Batchdienst die vorhandenen Einschränkungen.

function update(jobId: string, jobUpdateParameter: JobUpdateParameter, options?: JobUpdateOptionalParams): Promise<JobUpdateResponse>

Parameter

Gibt zurück

Promise<Models.JobUpdateResponse>

function update(jobId: string, jobUpdateParameter: JobUpdateParameter, options: JobUpdateOptionalParams, callback: ServiceCallback<void>)

Parameter

function update(jobId: string, jobUpdateParameter: JobUpdateParameter, callback: ServiceCallback<void>)

Parameter