BatchTaskOutput interface
Usługa Batch ponowi próbę wykonania zadań po wyzwoleniu operacji odzyskiwania w węźle. Przykłady operacji odzyskiwania obejmują (ale nie tylko) ponowne uruchomienie węzła w złej kondycji lub zniknięcie węzła obliczeniowego z powodu awarii hosta. Ponowne próby z powodu operacji odzyskiwania są niezależne i nie są liczone względem parametru maxTaskRetryCount. Nawet jeśli parametr maxTaskRetryCount wynosi 0, może wystąpić wewnętrzna ponowna próba spowodowana operacją odzyskiwania. W związku z tym wszystkie zadania powinny być idempotentne. Oznacza to, że zadania muszą tolerować przerywanie i ponowne uruchamianie bez powodowania uszkodzenia lub duplikowania danych. Najlepszym rozwiązaniem dla długotrwałych zadań jest użycie jakiejś formy tworzenia punktów kontrolnych.
Właściwości
| affinity |
Wskazówka dotycząca lokalizacji, która może być używana przez usługę Batch w celu wybrania węzła obliczeniowego, na którym ma zostać uruchomione nowe zadanie. |
| application |
Lista pakietów wdrożonych przez usługę Batch w węźle obliczeniowym przed uruchomieniem wiersza polecenia. Pakiety aplikacji są pobierane i wdrażane w udostępnionym katalogu, a nie w katalogu roboczym Zadanie. W związku z tym, jeśli przywoływanego pakietu znajduje się już w węźle i jest aktualny, nie jest on ponownie pobierany; używana jest istniejąca kopia w węźle obliczeniowym. Jeśli nie można zainstalować przywoływanego pakietu, na przykład ze względu na to, że pakiet został usunięty lub pobieranie nie powiodło się, zadanie kończy się niepowodzeniem. |
| authentication |
Ustawienia tokenu uwierzytelniania, którego zadanie może używać do wykonywania operacji usługi Batch. Jeśli ta właściwość jest ustawiona, usługa Batch udostępnia zadanie z tokenem uwierzytelniania, który może służyć do uwierzytelniania operacji usługi Batch bez konieczności używania klucza dostępu do konta. Token jest dostarczany za pośrednictwem zmiennej środowiskowej AZ_BATCH_AUTHENTICATION_TOKEN. Operacje, które zadanie może wykonać przy użyciu tokenu, zależą od ustawień. Na przykład zadanie może zażądać uprawnień zadania w celu dodania innych zadań do zadania lub sprawdzenia stanu zadania lub innych zadań w ramach zadania. |
| command |
Wiersz polecenia zadania. W przypadku zadań z wieloma wystąpieniami wiersz polecenia jest wykonywany jako zadanie podstawowe, po zakończeniu wykonywania wiersza polecenia koordynacji przez zadanie podstawowe i wszystkie podzadania. Wiersz polecenia nie jest uruchamiany w powłoce i dlatego nie może korzystać z funkcji powłoki, takich jak rozszerzenie zmiennej środowiskowej. Jeśli chcesz skorzystać z takich funkcji, należy wywołać powłokę w wierszu polecenia, na przykład za pomocą polecenia "cmd /c MyCommand" w systemie Windows lub "/bin/sh -c MyCommand" w systemie Linux. Jeśli wiersz polecenia odwołuje się do ścieżek plików, powinien użyć ścieżki względnej (względem katalogu roboczego zadania) lub użyć zmiennej środowiskowej udostępnionej w usłudze Batch (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). |
| constraints | Ograniczenia wykonywania, które mają zastosowanie do tego zadania. |
| container |
Ustawienia kontenera, w którym jest uruchamiane zadanie. Jeśli pula, która uruchomi to zadanie, ma ustawioną wartość containerConfiguration, należy również ustawić tę opcję. Jeśli pula, która uruchomi to zadanie, nie ma ustawionego konteneraKonfiguracja, nie może być ustawiona. Po określeniu tej wartości wszystkie katalogi rekursywnie poniżej AZ_BATCH_NODE_ROOT_DIR (katalogi główne katalogów usługi Azure Batch w węźle) są mapowane do kontenera, wszystkie zmienne środowiskowe zadania są mapowane do kontenera, a wiersz polecenia zadania jest wykonywany w kontenerze. Pliki utworzone w kontenerze poza AZ_BATCH_NODE_ROOT_DIR mogą nie zostać odzwierciedlone na dysku hosta, co oznacza, że interfejsy API plików usługi Batch nie będą mogły uzyskać dostępu do tych plików. |
| creation |
Czas tworzenia zadania. |
| depends |
Zadania, od których zależy to zadanie. To zadanie nie zostanie zaplanowane do momentu pomyślnego ukończenia wszystkich zadań podrzędnych. Jeśli którykolwiek z tych zadań zakończy się niepowodzeniem i wyczerpuje liczbę ponownych prób, to zadanie nigdy nie zostanie zaplanowane. |
| display |
Nazwa wyświetlana zadania. Nazwa wyświetlana nie musi być unikatowa i może zawierać znaki Unicode o maksymalnej długości 1024. |
| environment |
Lista ustawień zmiennych środowiskowych dla zadania. |
| e |
Element ETag zadania. Jest to nieprzezroczystym ciągiem. Można go użyć do wykrywania, czy zadanie uległo zmianie między żądaniami. W szczególności można przekazać element ETag podczas aktualizowania zadania w celu określenia, że zmiany powinny obowiązywać tylko wtedy, gdy nikt inny nie zmodyfikował zadania w międzyczasie. |
| execution |
Informacje o wykonaniu zadania. |
| exit |
Jak usługa Batch powinna odpowiadać po zakończeniu zadania. |
| id | Ciąg, który jednoznacznie identyfikuje zadanie w ramach zadania. 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. |
| last |
Czas ostatniej modyfikacji zadania. |
| multi |
Obiekt wskazujący, że zadanie jest zadaniem z wieloma wystąpieniami i zawiera informacje o sposobie uruchamiania zadania z wieloma wystąpieniami. |
| node |
Informacje o węźle obliczeniowym, na którym uruchomiono zadanie. |
| output |
Lista plików przekazanych przez usługę Batch z węzła obliczeniowego po uruchomieniu wiersza polecenia. W przypadku zadań z wieloma wystąpieniami pliki zostaną przekazane tylko z węzła obliczeniowego, na którym jest wykonywane zadanie podstawowe. |
| previous |
Poprzedni stan zadania. Ta właściwość nie jest ustawiona, jeśli zadanie jest w początkowym stanie Aktywny. Możliwe wartości: "active", "preparing", "running", "completed" |
| previous |
Czas, w którym zadanie wprowadziło poprzedni stan. Ta właściwość nie jest ustawiona, jeśli zadanie jest w początkowym stanie Aktywny. |
| required |
Liczba miejsc planowania, których wymaga uruchomienie zadania. Wartość domyślna to 1. Zadanie można zaplanować tylko w węźle obliczeniowym, jeśli węzeł ma wystarczającą ilość dostępnych wolnych miejsc planowania. W przypadku zadań z wieloma wystąpieniami musi to być 1. |
| resource |
Lista plików, które usługa Batch pobierze do węzła obliczeniowego przed uruchomieniem wiersza polecenia. W przypadku zadań z wieloma wystąpieniami pliki zasobów zostaną pobrane tylko do węzła obliczeniowego, na którym jest wykonywane zadanie podstawowe. Istnieje maksymalny rozmiar listy plików zasobów. Po przekroczeniu maksymalnego rozmiaru żądanie zakończy się niepowodzeniem, a kod błędu odpowiedzi to RequestEntityTooLarge. W takim przypadku należy zmniejszyć rozmiar kolekcji plików ResourceFiles. Można to osiągnąć przy użyciu plików .zip, pakietów aplikacji lub kontenerów platformy Docker. |
| state | Bieżący stan zadania. Możliwe wartości: "active", "preparing", "running", "completed" |
| state |
Czas, w którym zadanie wprowadziło bieżący stan. |
| stats | Statystyki użycia zasobów dla zadania. |
| url | Adres URL zadania. |
| user |
Tożsamość użytkownika, w ramach której jest uruchamiane zadanie. W przypadku pominięcia zadanie jest uruchamiane jako użytkownik niebędący administratorem unikatowym dla zadania. |
Szczegóły właściwości
affinityInfo
Wskazówka dotycząca lokalizacji, która może być używana przez usługę Batch w celu wybrania węzła obliczeniowego, na którym ma zostać uruchomione nowe zadanie.
affinityInfo?: BatchAffinityInfoOutputWartość właściwości
applicationPackageReferences
Lista pakietów wdrożonych przez usługę Batch w węźle obliczeniowym przed uruchomieniem wiersza polecenia. Pakiety aplikacji są pobierane i wdrażane w udostępnionym katalogu, a nie w katalogu roboczym Zadanie. W związku z tym, jeśli przywoływanego pakietu znajduje się już w węźle i jest aktualny, nie jest on ponownie pobierany; używana jest istniejąca kopia w węźle obliczeniowym. Jeśli nie można zainstalować przywoływanego pakietu, na przykład ze względu na to, że pakiet został usunięty lub pobieranie nie powiodło się, zadanie kończy się niepowodzeniem.
applicationPackageReferences?: BatchApplicationPackageReferenceOutput[]Wartość właściwości
authenticationTokenSettings
Ustawienia tokenu uwierzytelniania, którego zadanie może używać do wykonywania operacji usługi Batch. Jeśli ta właściwość jest ustawiona, usługa Batch udostępnia zadanie z tokenem uwierzytelniania, który może służyć do uwierzytelniania operacji usługi Batch bez konieczności używania klucza dostępu do konta. Token jest dostarczany za pośrednictwem zmiennej środowiskowej AZ_BATCH_AUTHENTICATION_TOKEN. Operacje, które zadanie może wykonać przy użyciu tokenu, zależą od ustawień. Na przykład zadanie może zażądać uprawnień zadania w celu dodania innych zadań do zadania lub sprawdzenia stanu zadania lub innych zadań w ramach zadania.
authenticationTokenSettings?: AuthenticationTokenSettingsOutputWartość właściwości
commandLine
Wiersz polecenia zadania. W przypadku zadań z wieloma wystąpieniami wiersz polecenia jest wykonywany jako zadanie podstawowe, po zakończeniu wykonywania wiersza polecenia koordynacji przez zadanie podstawowe i wszystkie podzadania. Wiersz polecenia nie jest uruchamiany w powłoce i dlatego nie może korzystać z funkcji powłoki, takich jak rozszerzenie zmiennej środowiskowej. Jeśli chcesz skorzystać z takich funkcji, należy wywołać powłokę w wierszu polecenia, na przykład za pomocą polecenia "cmd /c MyCommand" w systemie Windows lub "/bin/sh -c MyCommand" w systemie Linux. Jeśli wiersz polecenia odwołuje się do ścieżek plików, powinien użyć ścieżki względnej (względem katalogu roboczego zadania) lub użyć zmiennej środowiskowej udostępnionej w usłudze Batch (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).
commandLine: stringWartość właściwości
string
constraints
Ograniczenia wykonywania, które mają zastosowanie do tego zadania.
constraints?: BatchTaskConstraintsOutputWartość właściwości
containerSettings
Ustawienia kontenera, w którym jest uruchamiane zadanie. Jeśli pula, która uruchomi to zadanie, ma ustawioną wartość containerConfiguration, należy również ustawić tę opcję. Jeśli pula, która uruchomi to zadanie, nie ma ustawionego konteneraKonfiguracja, nie może być ustawiona. Po określeniu tej wartości wszystkie katalogi rekursywnie poniżej AZ_BATCH_NODE_ROOT_DIR (katalogi główne katalogów usługi Azure Batch w węźle) są mapowane do kontenera, wszystkie zmienne środowiskowe zadania są mapowane do kontenera, a wiersz polecenia zadania jest wykonywany w kontenerze. Pliki utworzone w kontenerze poza AZ_BATCH_NODE_ROOT_DIR mogą nie zostać odzwierciedlone na dysku hosta, co oznacza, że interfejsy API plików usługi Batch nie będą mogły uzyskać dostępu do tych plików.
containerSettings?: BatchTaskContainerSettingsOutputWartość właściwości
creationTime
Czas tworzenia zadania.
creationTime: stringWartość właściwości
string
dependsOn
Zadania, od których zależy to zadanie. To zadanie nie zostanie zaplanowane do momentu pomyślnego ukończenia wszystkich zadań podrzędnych. Jeśli którykolwiek z tych zadań zakończy się niepowodzeniem i wyczerpuje liczbę ponownych prób, to zadanie nigdy nie zostanie zaplanowane.
dependsOn?: BatchTaskDependenciesOutputWartość właściwości
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?: stringWartość właściwości
string
environmentSettings
Lista ustawień zmiennych środowiskowych dla zadania.
environmentSettings?: EnvironmentSettingOutput[]Wartość właściwości
eTag
Element ETag zadania. Jest to nieprzezroczystym ciągiem. Można go użyć do wykrywania, czy zadanie uległo zmianie między żądaniami. W szczególności można przekazać element ETag podczas aktualizowania zadania w celu określenia, że zmiany powinny obowiązywać tylko wtedy, gdy nikt inny nie zmodyfikował zadania w międzyczasie.
eTag: stringWartość właściwości
string
executionInfo
Informacje o wykonaniu zadania.
executionInfo?: BatchTaskExecutionInfoOutputWartość właściwości
exitConditions
Jak usługa Batch powinna odpowiadać po zakończeniu zadania.
exitConditions?: ExitConditionsOutputWartość właściwości
id
Ciąg, który jednoznacznie identyfikuje zadanie w ramach zadania. 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.
id: stringWartość właściwości
string
lastModified
Czas ostatniej modyfikacji zadania.
lastModified: stringWartość właściwości
string
multiInstanceSettings
Obiekt wskazujący, że zadanie jest zadaniem z wieloma wystąpieniami i zawiera informacje o sposobie uruchamiania zadania z wieloma wystąpieniami.
multiInstanceSettings?: MultiInstanceSettingsOutputWartość właściwości
nodeInfo
Informacje o węźle obliczeniowym, na którym uruchomiono zadanie.
nodeInfo?: BatchNodeInfoOutputWartość właściwości
outputFiles
Lista plików przekazanych przez usługę Batch z węzła obliczeniowego po uruchomieniu wiersza polecenia. W przypadku zadań z wieloma wystąpieniami pliki zostaną przekazane tylko z węzła obliczeniowego, na którym jest wykonywane zadanie podstawowe.
outputFiles?: OutputFileOutput[]Wartość właściwości
previousState
Poprzedni stan zadania. Ta właściwość nie jest ustawiona, jeśli zadanie jest w początkowym stanie Aktywny.
Możliwe wartości: "active", "preparing", "running", "completed"
previousState?: stringWartość właściwości
string
previousStateTransitionTime
Czas, w którym zadanie wprowadziło poprzedni stan. Ta właściwość nie jest ustawiona, jeśli zadanie jest w początkowym stanie Aktywny.
previousStateTransitionTime?: stringWartość właściwości
string
requiredSlots
Liczba miejsc planowania, których wymaga uruchomienie zadania. Wartość domyślna to 1. Zadanie można zaplanować tylko w węźle obliczeniowym, jeśli węzeł ma wystarczającą ilość dostępnych wolnych miejsc planowania. W przypadku zadań z wieloma wystąpieniami musi to być 1.
requiredSlots?: numberWartość właściwości
number
resourceFiles
Lista plików, które usługa Batch pobierze do węzła obliczeniowego przed uruchomieniem wiersza polecenia. W przypadku zadań z wieloma wystąpieniami pliki zasobów zostaną pobrane tylko do węzła obliczeniowego, na którym jest wykonywane zadanie podstawowe. Istnieje maksymalny rozmiar listy plików zasobów. Po przekroczeniu maksymalnego rozmiaru żądanie zakończy się niepowodzeniem, a kod błędu odpowiedzi to RequestEntityTooLarge. W takim przypadku należy zmniejszyć rozmiar kolekcji plików ResourceFiles. Można to osiągnąć przy użyciu plików .zip, pakietów aplikacji lub kontenerów platformy Docker.
resourceFiles?: ResourceFileOutput[]Wartość właściwości
state
Bieżący stan zadania.
Możliwe wartości: "active", "preparing", "running", "completed"
state: stringWartość właściwości
string
stateTransitionTime
Czas, w którym zadanie wprowadziło bieżący stan.
stateTransitionTime: stringWartość właściwości
string
stats
Statystyki użycia zasobów dla zadania.
stats?: BatchTaskStatisticsOutputWartość właściwości
url
Adres URL zadania.
url: stringWartość właściwości
string
userIdentity
Tożsamość użytkownika, w ramach której jest uruchamiane zadanie. W przypadku pominięcia zadanie jest uruchamiane jako użytkownik niebędący administratorem unikatowym dla zadania.
userIdentity?: UserIdentityOutput