BatchTaskCreateOptions interface

Pakiet:

@azure-rest/batch

Parametry tworzenia zadania usługi Azure Batch.

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.
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.
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.
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).
constraints	Ograniczenia wykonywania, które mają zastosowanie do tego zadania. Jeśli nie określisz ograniczeń, parametr maxTaskRetryCount jest parametrem maxTaskRetryCount określonym dla zadania, wartość maxWallClockTime jest nieskończona, a czas przechowywania wynosi 7 dni.
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.
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. Jeśli zadanie nie ma parametru usesTaskDependencies ustawione na wartość true, a ten element jest obecny, żądanie kończy się niepowodzeniem z kodem błędu TaskDependenciesNotSpecifiedOnJob.
displayName	Nazwa wyświetlana zadania. Nazwa wyświetlana nie musi być unikatowa i może zawierać znaki Unicode o maksymalnej długości 1024.
environmentSettings	Lista ustawień zmiennych środowiskowych dla zadania.
exitConditions	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. Identyfikator jest zachowywany przy użyciu wielkości liter i bez uwzględniania wielkości liter (oznacza to, że w zadaniu mogą nie znajdować się dwa identyfikatory, które różnią się tylko wielkością liter).
multiInstanceSettings	Obiekt wskazujący, że zadanie jest zadaniem z wieloma wystąpieniami i zawiera informacje o sposobie uruchamiania zadania z wieloma wystąpieniami.
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.
requiredSlots	Liczba miejsc planowania wymaganych do uruchomienia 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.
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.
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.

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

Wartość właściwości

BatchAffinityInfo

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?: BatchApplicationPackageReference[]

Wartość właściwości

BatchApplicationPackageReference[]

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

Wartość właściwości

AuthenticationTokenSettings

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: string

Wartość właściwości

string

constraints

Ograniczenia wykonywania, które mają zastosowanie do tego zadania. Jeśli nie określisz ograniczeń, parametr maxTaskRetryCount jest parametrem maxTaskRetryCount określonym dla zadania, wartość maxWallClockTime jest nieskończona, a czas przechowywania wynosi 7 dni.

constraints?: BatchTaskConstraints

Wartość właściwości

BatchTaskConstraints

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

Wartość właściwości

BatchTaskContainerSettings

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. Jeśli zadanie nie ma parametru usesTaskDependencies ustawione na wartość true, a ten element jest obecny, żądanie kończy się niepowodzeniem z kodem błędu TaskDependenciesNotSpecifiedOnJob.

dependsOn?: BatchTaskDependencies

Wartość właściwości

BatchTaskDependencies

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

environmentSettings

Lista ustawień zmiennych środowiskowych dla zadania.

environmentSettings?: EnvironmentSetting[]

Wartość właściwości

EnvironmentSetting[]

exitConditions

Jak usługa Batch powinna odpowiadać po zakończeniu zadania.

exitConditions?: ExitConditions

Wartość właściwości

ExitConditions

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. Identyfikator jest zachowywany przy użyciu wielkości liter i bez uwzględniania wielkości liter (oznacza to, że w zadaniu mogą nie znajdować się dwa identyfikatory, które różnią się tylko wielkością liter).

id: string

Wartość 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?: MultiInstanceSettings

Wartość właściwości

MultiInstanceSettings

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?: OutputFile[]

Wartość właściwości

OutputFile[]

requiredSlots

Liczba miejsc planowania wymaganych do uruchomienia 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?: number

Wartość 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?: ResourceFile[]

Wartość właściwości

ResourceFile[]

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

Wartość właściwości

UserIdentity