BatchJobSpecificationOutput interface

Pakiet:

@azure-rest/batch

Określa szczegóły zadań do utworzenia zgodnie z harmonogramem.

Właściwości

allowTaskPreemption	Czy zadania podrzędne w tym zadaniu mogą zostać wywłaszczone przez inne zadania o wysokim priorytcie. (Ta właściwość nie jest domyślnie dostępna. Skontaktuj się z pomocą techniczną, aby uzyskać więcej informacji) Jeśli wartość jest ustawiona na True, inne zadania o wysokim priorytecie przesłane do systemu będą miały pierwszeństwo i będą mogły ponownie kolejkować zadania z tego zadania. Możesz zaktualizować parametr allowTaskPreemption zadania po jego utworzeniu przy użyciu interfejsu API zadania aktualizacji.
commonEnvironmentSettings	Lista typowych ustawień zmiennych środowiskowych. Te zmienne środowiskowe są ustawiane dla wszystkich zadań w zadaniach utworzonych zgodnie z tym harmonogramem (w tym Menedżera zadań, Przygotowania zadania i Zadania zwolnienia zadania). Poszczególne zadania mogą zastąpić ustawienie środowiska określone w tym miejscu, określając tę samą nazwę ustawienia o innej wartości.
constraints	Ograniczenia wykonywania dla zadań utworzonych zgodnie z tym harmonogramem.
displayName	Nazwa wyświetlana zadań utworzonych zgodnie z tym harmonogramem. Nazwa nie musi być unikatowa i może zawierać znaki Unicode o maksymalnej długości 1024.
jobManagerTask	Szczegóły zadania Menedżera zadań, które mają zostać uruchomione po uruchomieniu zadania zgodnie z tym harmonogramem. Jeśli zadanie nie określi zadania Menedżera zadań, użytkownik musi jawnie dodać zadania do zadania przy użyciu interfejsu API zadań. Jeśli zadanie określi zadanie Menedżera zadań, usługa Batch tworzy zadanie Menedżera zadań podczas tworzenia zadania i spróbuje zaplanować zadanie Menedżera zadań przed zaplanowaniem innych zadań w zadaniu.
jobPreparationTask	Zadanie przygotowania zadania dla zadań utworzonych zgodnie z tym harmonogramem. Jeśli zadanie ma zadanie przygotowania zadania, usługa Batch uruchomi zadanie przygotowania zadania w węźle przed uruchomieniem dowolnego zadania tego zadania w tym węźle obliczeniowym.
jobReleaseTask	Zadanie zwolnienia zadania dla zadań utworzonych zgodnie z tym harmonogramem. Głównym celem zadania zwolnienia zadania jest cofnięcie zmian w węzłach wprowadzonych przez zadanie przygotowania zadania. Przykładowe działania obejmują usuwanie plików lokalnych lub zamykanie usług, które zostały uruchomione w ramach przygotowania zadania. Nie można określić zadania zwolnienia zadania bez określania zadania przygotowania zadania. Usługa Batch uruchamia zadanie zwolnienia zadania w węzłach obliczeniowych, w których uruchomiono zadanie przygotowania zadania.
maxParallelTasks	Maksymalna liczba zadań, które mogą być wykonywane równolegle dla zadania. (Ta właściwość nie jest domyślnie dostępna. Skontaktuj się z pomocą techniczną, aby uzyskać więcej informacji) Wartość maxParallelTasks musi być -1 lub większa niż 0, jeśli zostanie określona. Jeśli nie zostanie określona, wartość domyślna to -1, co oznacza, że nie ma limitu liczby zadań, które można uruchamiać jednocześnie. Wartość maxParallelTasks zadania można zaktualizować po jego utworzeniu przy użyciu interfejsu API zadania aktualizacji.
metadata	Lista par nazwa-wartość skojarzonych z każdym zadaniem utworzonym w ramach tego harmonogramu jako metadanymi. Usługa Batch nie przypisuje żadnego znaczenia metadanym; służy wyłącznie do używania kodu użytkownika.
networkConfiguration	(Ta właściwość nie jest domyślnie dostępna. Skontaktuj się z pomocą techniczną, aby uzyskać więcej informacji) Konfiguracja sieci dla zadania.
onAllTasksComplete	Akcja, którą usługa Batch powinna wykonać, gdy wszystkie zadania w zadaniu utworzonym w ramach tego harmonogramu są w stanie ukończonym. Należy pamiętać, że jeśli zadanie nie zawiera zadań, wszystkie zadania są uznawane za ukończone. W związku z tym ta opcja jest najczęściej używana z zadaniem Menedżera zadań; Jeśli chcesz używać automatycznego kończenia zadań bez Menedżera zadań, należy początkowo ustawić wartość onAllTasksComplete na wartość noaction i zaktualizować właściwości zadania, aby ustawić właściwość onAllTasksComplete na zakończenie zadania po zakończeniu dodawania zadań. Wartość domyślna to noaction. Możliwe wartości: "noaction", "terminatejob"
onTaskFailure	Akcja, którą usługa Batch powinna wykonać, gdy dowolne zadanie zakończy się niepowodzeniem w zadaniu utworzonym zgodnie z tym harmonogramem. Zadanie jest uznawane za nieudane, jeśli nie powiodło się, jeśli ma wartość failureInfo. Właściwość failureInfo jest ustawiana, jeśli zadanie kończy się kodem zakończenia innym niż zero po wyczerpaniu liczby ponownych prób lub jeśli wystąpił błąd podczas uruchamiania zadania, na przykład z powodu błędu pobierania pliku zasobu. Wartość domyślna to noaction. Możliwe wartości: "noaction", "performexitoptionsjobaction"
poolInfo	Pula, w której usługa Batch uruchamia zadania zadań utworzonych w ramach tego harmonogramu.
priority	Priorytet zadań utworzonych zgodnie z tym harmonogramem. Wartości priorytetu mogą mieścić się w zakresie od -1000 do 1000, a -1000 jest najniższym priorytetem, a 1000 jest najwyższym priorytetem. Wartość domyślna to 0. Ten priorytet jest używany jako domyślny dla wszystkich zadań w harmonogramie zadań. Priorytet zadania można zaktualizować po jego utworzeniu przy użyciu interfejsu API aktualizacji zadania.
usesTaskDependencies	Czy zadania w zadaniu mogą definiować zależności od siebie. Wartość domyślna to false.

Szczegóły właściwości

allowTaskPreemption

Czy zadania podrzędne w tym zadaniu mogą zostać wywłaszczone przez inne zadania o wysokim priorytcie. (Ta właściwość nie jest domyślnie dostępna. Skontaktuj się z pomocą techniczną, aby uzyskać więcej informacji) Jeśli wartość jest ustawiona na True, inne zadania o wysokim priorytecie przesłane do systemu będą miały pierwszeństwo i będą mogły ponownie kolejkować zadania z tego zadania. Możesz zaktualizować parametr allowTaskPreemption zadania po jego utworzeniu przy użyciu interfejsu API zadania aktualizacji.

allowTaskPreemption?: boolean

Wartość właściwości

boolean

commonEnvironmentSettings

Lista typowych ustawień zmiennych środowiskowych. Te zmienne środowiskowe są ustawiane dla wszystkich zadań w zadaniach utworzonych zgodnie z tym harmonogramem (w tym Menedżera zadań, Przygotowania zadania i Zadania zwolnienia zadania). Poszczególne zadania mogą zastąpić ustawienie środowiska określone w tym miejscu, określając tę samą nazwę ustawienia o innej wartości.

commonEnvironmentSettings?: EnvironmentSettingOutput[]

Wartość właściwości

EnvironmentSettingOutput[]

constraints

Ograniczenia wykonywania dla zadań utworzonych zgodnie z tym harmonogramem.

constraints?: BatchJobConstraintsOutput

Wartość właściwości

BatchJobConstraintsOutput

displayName

Nazwa wyświetlana zadań utworzonych zgodnie z tym harmonogramem. Nazwa nie musi być unikatowa i może zawierać znaki Unicode o maksymalnej długości 1024.

displayName?: string

Wartość właściwości

string

jobManagerTask

Szczegóły zadania Menedżera zadań, które mają zostać uruchomione po uruchomieniu zadania zgodnie z tym harmonogramem. Jeśli zadanie nie określi zadania Menedżera zadań, użytkownik musi jawnie dodać zadania do zadania przy użyciu interfejsu API zadań. Jeśli zadanie określi zadanie Menedżera zadań, usługa Batch tworzy zadanie Menedżera zadań podczas tworzenia zadania i spróbuje zaplanować zadanie Menedżera zadań przed zaplanowaniem innych zadań w zadaniu.

jobManagerTask?: BatchJobManagerTaskOutput

Wartość właściwości

BatchJobManagerTaskOutput

jobPreparationTask

Zadanie przygotowania zadania dla zadań utworzonych zgodnie z tym harmonogramem. Jeśli zadanie ma zadanie przygotowania zadania, usługa Batch uruchomi zadanie przygotowania zadania w węźle przed uruchomieniem dowolnego zadania tego zadania w tym węźle obliczeniowym.

jobPreparationTask?: BatchJobPreparationTaskOutput

Wartość właściwości

BatchJobPreparationTaskOutput

jobReleaseTask

Zadanie zwolnienia zadania dla zadań utworzonych zgodnie z tym harmonogramem. Głównym celem zadania zwolnienia zadania jest cofnięcie zmian w węzłach wprowadzonych przez zadanie przygotowania zadania. Przykładowe działania obejmują usuwanie plików lokalnych lub zamykanie usług, które zostały uruchomione w ramach przygotowania zadania. Nie można określić zadania zwolnienia zadania bez określania zadania przygotowania zadania. Usługa Batch uruchamia zadanie zwolnienia zadania w węzłach obliczeniowych, w których uruchomiono zadanie przygotowania zadania.

jobReleaseTask?: BatchJobReleaseTaskOutput

Wartość właściwości

BatchJobReleaseTaskOutput

maxParallelTasks

Maksymalna liczba zadań, które mogą być wykonywane równolegle dla zadania. (Ta właściwość nie jest domyślnie dostępna. Skontaktuj się z pomocą techniczną, aby uzyskać więcej informacji) Wartość maxParallelTasks musi być -1 lub większa niż 0, jeśli zostanie określona. Jeśli nie zostanie określona, wartość domyślna to -1, co oznacza, że nie ma limitu liczby zadań, które można uruchamiać jednocześnie. Wartość maxParallelTasks zadania można zaktualizować po jego utworzeniu przy użyciu interfejsu API zadania aktualizacji.

maxParallelTasks?: number

Wartość właściwości

number

metadata

Lista par nazwa-wartość skojarzonych z każdym zadaniem utworzonym w ramach tego harmonogramu jako metadanymi. Usługa Batch nie przypisuje żadnego znaczenia metadanym; służy wyłącznie do używania kodu użytkownika.

metadata?: BatchMetadataItemOutput[]

Wartość właściwości

BatchMetadataItemOutput[]

networkConfiguration

(Ta właściwość nie jest domyślnie dostępna. Skontaktuj się z pomocą techniczną, aby uzyskać więcej informacji) Konfiguracja sieci dla zadania.

networkConfiguration?: BatchJobNetworkConfigurationOutput

Wartość właściwości

BatchJobNetworkConfigurationOutput

onAllTasksComplete

Akcja, którą usługa Batch powinna wykonać, gdy wszystkie zadania w zadaniu utworzonym w ramach tego harmonogramu są w stanie ukończonym. Należy pamiętać, że jeśli zadanie nie zawiera zadań, wszystkie zadania są uznawane za ukończone. W związku z tym ta opcja jest najczęściej używana z zadaniem Menedżera zadań; Jeśli chcesz używać automatycznego kończenia zadań bez Menedżera zadań, należy początkowo ustawić wartość onAllTasksComplete na wartość noaction i zaktualizować właściwości zadania, aby ustawić właściwość onAllTasksComplete na zakończenie zadania po zakończeniu dodawania zadań. Wartość domyślna to noaction.

Możliwe wartości: "noaction", "terminatejob"

onAllTasksComplete?: string

Wartość właściwości

string

onTaskFailure

Akcja, którą usługa Batch powinna wykonać, gdy dowolne zadanie zakończy się niepowodzeniem w zadaniu utworzonym zgodnie z tym harmonogramem. Zadanie jest uznawane za nieudane, jeśli nie powiodło się, jeśli ma wartość failureInfo. Właściwość failureInfo jest ustawiana, jeśli zadanie kończy się kodem zakończenia innym niż zero po wyczerpaniu liczby ponownych prób lub jeśli wystąpił błąd podczas uruchamiania zadania, na przykład z powodu błędu pobierania pliku zasobu. Wartość domyślna to noaction.

Możliwe wartości: "noaction", "performexitoptionsjobaction"

onTaskFailure?: string

Wartość właściwości

string

poolInfo

Pula, w której usługa Batch uruchamia zadania zadań utworzonych w ramach tego harmonogramu.

poolInfo: BatchPoolInfoOutput

Wartość właściwości

BatchPoolInfoOutput

priority

Priorytet zadań utworzonych zgodnie z tym harmonogramem. Wartości priorytetu mogą mieścić się w zakresie od -1000 do 1000, a -1000 jest najniższym priorytetem, a 1000 jest najwyższym priorytetem. Wartość domyślna to 0. Ten priorytet jest używany jako domyślny dla wszystkich zadań w harmonogramie zadań. Priorytet zadania można zaktualizować po jego utworzeniu przy użyciu interfejsu API aktualizacji zadania.

priority?: number

Wartość właściwości

number

usesTaskDependencies

Czy zadania w zadaniu mogą definiować zależności od siebie. Wartość domyślna to false.

usesTaskDependencies?: boolean

Wartość właściwości

boolean