BatchJobCreateOptions interface

Pakiet:

@azure-rest/batch

Parametry tworzenia zadania usługi Azure Batch.

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 zadaniu (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 zadania.
displayName	Nazwa wyświetlana zadania. Nazwa wyświetlana nie musi być unikatowa i może zawierać znaki Unicode o maksymalnej długości 1024.
id	Ciąg, który jednoznacznie identyfikuje zadanie w ramach konta. Identyfikator może zawierać dowolną kombinację znaków alfanumerycznych, w tym łączników i podkreśleń, i nie może zawierać więcej niż 64 znaków. Identyfikator jest zachowywany przy użyciu wielkości liter i bez uwzględniania wielkości liter (oznacza to, że w ramach konta mogą nie istnieć dwa identyfikatory, które różnią się tylko wielkością liter).
jobManagerTask	Szczegóły zadania Menedżera zadań, które mają zostać uruchomione po uruchomieniu zadania. Jeśli zadanie nie określi zadania Menedżera zadań, użytkownik musi jawnie dodać zadania do zadania. 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. Typowym celem zadania Menedżera zadań jest kontrolowanie i/lub monitorowanie wykonywania zadania, na przykład poprzez podjęcie decyzji o tym, jakie dodatkowe zadania do uruchomienia, określenie, kiedy praca jest ukończona itp. (Jednak zadanie Menedżera zadań nie jest ograniczone do tych działań — jest to w pełni funkcjonalne zadanie w systemie i wykonywanie jakichkolwiek akcji wymaganych dla zadania). Na przykład zadanie Menedżera zadań może pobrać plik określony jako parametr, przeanalizować zawartość tego pliku i przesłać dodatkowe zadania na podstawie tej zawartości.
jobPreparationTask	Zadanie przygotowania zadania. 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. 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, w których uruchomiono zadanie przygotowania zadania. Głównym celem zadania zwolnienia zadania jest cofnięcie zmian w węzłach obliczeniowych 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.
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 name-value skojarzonych z zadaniem 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, jaką usługa Batch powinna wykonać, gdy wszystkie zadania w zadaniu 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, jaką usługa Batch powinna wykonać, gdy dowolne zadanie w zadaniu zakończy się niepowodzeniem. Zadanie jest uznawane za nieudane, jeśli występuje błądInfo. 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 podrzędne zadania.
priority	Priorytet zadania. 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.
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 zadaniu (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?: EnvironmentSetting[]

Wartość właściwości

EnvironmentSetting[]

constraints

Ograniczenia wykonywania zadania.

constraints?: BatchJobConstraints

Wartość właściwości

BatchJobConstraints

displayName

Nazwa wyświetlana zadania. Nazwa wyświetlana nie musi być unikatowa i może zawierać znaki Unicode o maksymalnej długości 1024.

displayName?: string

Wartość właściwości

string

id

Ciąg, który jednoznacznie identyfikuje zadanie w ramach konta. Identyfikator może zawierać dowolną kombinację znaków alfanumerycznych, w tym łączników i podkreśleń, i nie może zawierać więcej niż 64 znaków. Identyfikator jest zachowywany przy użyciu wielkości liter i bez uwzględniania wielkości liter (oznacza to, że w ramach konta mogą nie istnieć dwa identyfikatory, które różnią się tylko wielkością liter).

id: string

Wartość właściwości

string

jobManagerTask

Szczegóły zadania Menedżera zadań, które mają zostać uruchomione po uruchomieniu zadania. Jeśli zadanie nie określi zadania Menedżera zadań, użytkownik musi jawnie dodać zadania do zadania. 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. Typowym celem zadania Menedżera zadań jest kontrolowanie i/lub monitorowanie wykonywania zadania, na przykład poprzez podjęcie decyzji o tym, jakie dodatkowe zadania do uruchomienia, określenie, kiedy praca jest ukończona itp. (Jednak zadanie Menedżera zadań nie jest ograniczone do tych działań — jest to w pełni funkcjonalne zadanie w systemie i wykonywanie jakichkolwiek akcji wymaganych dla zadania). Na przykład zadanie Menedżera zadań może pobrać plik określony jako parametr, przeanalizować zawartość tego pliku i przesłać dodatkowe zadania na podstawie tej zawartości.

jobManagerTask?: BatchJobManagerTask

Wartość właściwości

BatchJobManagerTask

jobPreparationTask

Zadanie przygotowania zadania. 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?: BatchJobPreparationTask

Wartość właściwości

BatchJobPreparationTask

jobReleaseTask

Zadanie zwolnienia 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, w których uruchomiono zadanie przygotowania zadania. Głównym celem zadania zwolnienia zadania jest cofnięcie zmian w węzłach obliczeniowych 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.

jobReleaseTask?: BatchJobReleaseTask

Wartość właściwości

BatchJobReleaseTask

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 name-value skojarzonych z zadaniem jako metadanymi. Usługa Batch nie przypisuje żadnego znaczenia metadanym; służy wyłącznie do używania kodu użytkownika.

metadata?: BatchMetadataItem[]

Wartość właściwości

BatchMetadataItem[]

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?: BatchJobNetworkConfiguration

Wartość właściwości

BatchJobNetworkConfiguration

onAllTasksComplete

Akcja, jaką usługa Batch powinna wykonać, gdy wszystkie zadania w zadaniu 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, jaką usługa Batch powinna wykonać, gdy dowolne zadanie w zadaniu zakończy się niepowodzeniem. Zadanie jest uznawane za nieudane, jeśli występuje błądInfo. 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 podrzędne zadania.

poolInfo: BatchPoolInfo

Wartość właściwości

BatchPoolInfo

priority

Priorytet zadania. 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.

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