Task - Get

Usługa:

Batch Service

Wersja interfejsu API:

2024-07-01.20.0

Pobiera informacje o określonym zadaniu.
W przypadku zadań obejmujących wiele wystąpień informacje, takie jak koligacjaId, executionInfo i nodeInfo, zapoznaj się z podstawowym zadaniem. Użyj interfejsu API podzadania listy, aby pobrać informacje o podzadaniach.

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2024-07-01.20.0

Z parametrami opcjonalnymi:

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}?$select={$select}&$expand={$expand}&timeout={timeout}&api-version=2024-07-01.20.0

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
batchUrl	path	True	string	Podstawowy adres URL dla wszystkich żądań usługi Azure Batch.
jobId	path	True	string	Identyfikator zadania zawierającego zadanie.
taskId	path	True	string	Identyfikator zadania do pobrania informacji.
api-version	query	True	string	Wersja interfejsu API klienta.
$expand	query		string	Klauzula OData $expand.
$select	query		string	Klauzula OData $select.
timeout	query		integer (int32)	Maksymalny czas przetwarzania żądania przez serwer w sekundach. Wartość domyślna to 30 sekund. Jeśli wartość jest większa niż 30, zostanie użyta wartość domyślna.

Nagłówek żądania

Media Types: "application/json; odata=minimalmetadata"

Nazwa	Wymagane	Typ	Opis
client-request-id		string (uuid)	Tożsamość żądania wygenerowanego przez obiekt wywołujący w postaci identyfikatora GUID bez dekoracji, takiej jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Czy serwer powinien zwrócić identyfikator żądania klienta w odpowiedzi.
ocp-date		string (date-time-rfc1123)	Czas wystawienia żądania. Biblioteki klienckie zazwyczaj ustawiają tę wartość na bieżący czas zegara systemowego; ustaw go jawnie, jeśli bezpośrednio wywołujesz interfejs API REST.
If-Match		string	Wartość elementu ETag skojarzona z wersją zasobu znaną klientowi. Operacja zostanie wykonana tylko wtedy, gdy bieżący element ETag zasobu w usłudze dokładnie odpowiada wartości określonej przez klienta.
If-None-Match		string	Wartość elementu ETag skojarzona z wersją zasobu znaną klientowi. Operacja zostanie wykonana tylko wtedy, gdy bieżący element ETag zasobu w usłudze nie jest zgodny z wartością określoną przez klienta.
If-Modified-Since		string (date-time-rfc1123)	Sygnatura czasowa wskazująca czas ostatniej modyfikacji zasobu znanego klientowi. Operacja zostanie wykonana tylko wtedy, gdy zasób w usłudze został zmodyfikowany od określonego czasu.
If-Unmodified-Since		string (date-time-rfc1123)	Sygnatura czasowa wskazująca czas ostatniej modyfikacji zasobu znanego klientowi. Operacja zostanie wykonana tylko wtedy, gdy zasób usługi nie został zmodyfikowany od określonego czasu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CloudTask	Odpowiedź zawierająca zadanie. Nagłówki client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Błąd usługi Batch.

Zabezpieczenia

azure_auth

Microsoft Entra OAuth 2.0 — przepływ kodu uwierzytelniania

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Authorization

Typ: apiKey
W: header

Przykłady

Task get

Przykładowe żądanie

HTTP

GET account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2024-07-01.20.0

Przykładowa odpowiedź

Kod stanu:

200

{
  "id": "testTask",
  "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId",
  "eTag": "0x8D3D62350711C55",
  "creationTime": "2016-09-06T06:59:15.1161429Z",
  "lastModified": "2016-09-06T06:59:15.1161429Z",
  "state": "active",
  "stateTransitionTime": "2016-09-06T06:59:15.1161429Z",
  "commandLine": "cmd /c hostname",
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  },
  "multiInstanceSettings": {
    "numberOfInstances": 3,
    "coordinationCommandLine": "cmd /c echo coordinating"
  },
  "constraints": {
    "maxWallClockTime": "P10675199DT2H48M5.4775807S",
    "retentionTime": "P10675199DT2H48M5.4775807S",
    "maxTaskRetryCount": 0
  },
  "requiredSlots": 2,
  "executionInfo": {
    "retryCount": 0,
    "requeueCount": 0
  }
}

Definicje

Nazwa	Opis
AccessScope	Zasoby usługi Batch, do których token udziela dostępu.
AffinityInformation	Wskazówka dotycząca lokalizacji, która może być używana przez usługę Batch do wybierania węzła obliczeniowego, na którym ma zostać uruchomione zadanie.
ApplicationPackageReference	Odwołanie do pakietu do wdrożenia w węzłach obliczeniowych.
AuthenticationTokenSettings	Ustawienia tokenu uwierzytelniania, którego zadanie może używać do wykonywania operacji usługi Batch.
AutoUserScope	Zakres użytkownika automatycznego
AutoUserSpecification	Określa parametry dla użytkownika automatycznego, który uruchamia zadanie w usłudze Batch.
BatchError	Odebrano odpowiedź o błędzie z usługi Azure Batch.
BatchErrorDetail	Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch.
CloudTask	Zadanie usługi Azure Batch.
ComputeNodeIdentityReference	Odwołanie do tożsamości przypisanej przez użytkownika skojarzonej z pulą usługi Batch, która będzie używana przez węzeł obliczeniowy.
ComputeNodeInformation	Informacje o węźle obliczeniowym, na którym uruchomiono zadanie.
ContainerHostBatchBindMountEntry	Wpis ścieżki i trybu instalacji, który chcesz zainstalować w kontenerze zadań.
ContainerHostDataPath	Ścieżki, które zostaną zainstalowane w kontenerze zadania kontenera.
ContainerRegistry	Prywatny rejestr kontenerów.
ContainerWorkingDirectory	Lokalizacja katalogu roboczego zadania kontenera.
DependencyAction	Akcja wykonywana przez usługę Batch dla zadań, które zależą od tego zadania.
ElevationLevel	Poziom podniesienia uprawnień użytkownika.
EnvironmentSetting	Zmienna środowiskowa, która ma być ustawiana w procesie zadania.
ErrorCategory	Kategoria błędu.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.
ExitCodeMapping	Jak usługa Batch powinna odpowiadać, jeśli zadanie zakończy działanie z określonym kodem zakończenia.
ExitCodeRangeMapping	Zakres kodów zakończenia i sposobu, w jaki usługa Batch powinna reagować na kody zakończenia w tym zakresie.
ExitConditions	Określa, jak usługa Batch powinna odpowiadać po zakończeniu zadania.
ExitOptions	Określa sposób, w jaki usługa Batch reaguje na określony warunek zakończenia.
HttpHeader	Para nazwa-wartość nagłówka HTTP
JobAction	Akcja wykonywana dla zadania zawierającego zadanie, jeśli zadanie zostanie zakończone z danym warunkiem zakończenia, a właściwość onTaskFailed zadania to "performExitOptionsJobAction".
MultiInstanceSettings	Ustawienia określające sposób uruchamiania zadania obejmującego wiele wystąpień.
NameValuePair	Reprezentuje parę nazwa-wartość.
OutputFile	Specyfikacja przekazywania plików z węzła obliczeniowego usługi Azure Batch do innej lokalizacji po zakończeniu wykonywania procesu zadania przez usługę Batch.
OutputFileBlobContainerDestination	Określa miejsce docelowe przekazywania plików w kontenerze usługi Azure Blob Storage.
OutputFileDestination	Miejsce docelowe, do którego ma zostać przekazany plik.
OutputFileUploadCondition	Warunki, w których należy przekazać plik wyjściowy zadania lub zestaw plików.
OutputFileUploadOptions	Szczegółowe informacje o operacji przekazywania pliku wyjściowego, w tym o warunkach, w których należy wykonać przekazywanie.
ResourceFile	Jeden plik lub wiele plików do pobrania do węzła obliczeniowego.
TaskConstraints	Ograniczenia wykonywania, które mają zastosowanie do zadania.
TaskContainerExecutionInformation	Zawiera informacje o kontenerze, który wykonuje zadanie.
TaskContainerSettings	Ustawienia kontenera dla zadania.
TaskDependencies	Określa wszelkie zależności zadania. Każde zadanie, które jest jawnie określone lub w zakresie zależności, musi zostać ukończone przed zaplanowaniem zadania zależnego.
TaskExecutionInformation	Informacje o wykonywaniu zadania.
TaskExecutionResult	Wynik wykonania zadania.
TaskFailureInformation	Informacje o niepowodzeniu zadania.
TaskIdRange	Zakres identyfikatorów zadań, od których może zależeć zadanie. Wszystkie zadania z identyfikatorami w zakresie muszą zostać ukończone pomyślnie przed zaplanowaniem zależnego zadania.
TaskState	Stan zadania.
TaskStatistics	Statystyki użycia zasobów dla zadania.
UserIdentity	Definicja tożsamości użytkownika, w ramach której jest uruchamiane zadanie.

AccessScope

Wyliczanie

Zasoby usługi Batch, do których token udziela dostępu.

Wartość	Opis
job	Udziela dostępu do wykonywania wszystkich operacji w zadaniu zawierającym zadanie.

AffinityInformation

Objekt

Wskazówka dotycząca lokalizacji, która może być używana przez usługę Batch do wybierania węzła obliczeniowego, na którym ma zostać uruchomione zadanie.

Nazwa	Typ	Opis
affinityId	string	Nieprzezroczystym ciąg reprezentujący lokalizację węzła obliczeniowego lub zadanie, które zostało wcześniej uruchomione. Możesz przekazać identyfikator koligacji węzła, aby wskazać, że to zadanie musi zostać uruchomione w tym węźle obliczeniowym. Należy pamiętać, że jest to tylko miękka koligacja. Jeśli docelowy węzeł obliczeniowy jest zajęty lub niedostępny w czasie zaplanowanego zadania, zadanie zostanie zaplanowane w innym miejscu.

ApplicationPackageReference

Objekt

Odwołanie do pakietu do wdrożenia w węzłach obliczeniowych.

Nazwa	Typ	Opis
applicationId	string	Identyfikator aplikacji do wdrożenia. Podczas tworzenia puli identyfikator aplikacji pakietu musi być w pełni kwalifikowany (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	Wersja aplikacji do wdrożenia. W przypadku pominięcia zostanie wdrożona domyślna wersja. Jeśli pominięto tę pulę i nie określono domyślnej wersji dla tej aplikacji, żądanie kończy się niepowodzeniem z kodem błędu InvalidApplicationPackageReferences i kodem stanu HTTP 409. Jeśli zostanie to pominięte w zadaniu, a dla tej aplikacji nie zostanie określona żadna domyślna wersja, zadanie zakończy się niepowodzeniem z powodu błędu przetwarzania wstępnego.

AuthenticationTokenSettings

Objekt

Ustawienia tokenu uwierzytelniania, którego zadanie może używać do wykonywania operacji usługi Batch.

Nazwa	Typ	Opis
access	AccessScope[]	Zasoby usługi Batch, do których token udziela dostępu. Token uwierzytelniania udziela dostępu do ograniczonego zestawu operacji usługi Batch. Obecnie jedyną obsługiwaną wartością dla właściwości dostępu jest zadanie, które przyznaje dostęp do wszystkich operacji związanych z zadaniem zawierającym zadanie.

AutoUserScope

Wyliczanie

Zakres użytkownika automatycznego

Wartość	Opis
pool	Określa, że zadanie jest uruchamiane jako wspólne konto użytkownika automatycznego, które jest tworzone w każdym węźle obliczeniowym w puli.
task	Określa, że usługa powinna utworzyć nowego użytkownika dla zadania.

AutoUserSpecification

Objekt

Określa parametry dla użytkownika automatycznego, który uruchamia zadanie w usłudze Batch.

Nazwa	Typ	Opis
elevationLevel	ElevationLevel	Poziom podniesienia uprawnień użytkownika automatycznego. Wartość domyślna to nonAdmin.
scope	AutoUserScope	Zakres użytkownika automatycznego Wartość domyślna to pula. Jeśli pula jest uruchomiona w systemie Windows, należy określić wartość Zadanie, jeśli wymagana jest ściślejsza izolacja między zadaniami. Jeśli na przykład zadanie wycisza rejestr w sposób, który może mieć wpływ na inne zadania, lub jeśli certyfikaty zostały określone w puli, które nie powinny być dostępne przez zwykłe zadania, ale powinny być dostępne przez zadania StartTasks.

BatchError

Objekt

Odebrano odpowiedź o błędzie z usługi Azure Batch.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
message	ErrorMessage	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
values	BatchErrorDetail[]	Kolekcja par klucz-wartość zawierająca dodatkowe szczegóły dotyczące błędu.

BatchErrorDetail

Objekt

Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch.

Nazwa	Typ	Opis
key	string	Identyfikator określający znaczenie właściwości Value.
value	string	Dodatkowe informacje zawarte w odpowiedzi na błąd.

CloudTask

Objekt

Zadanie usługi Azure Batch.

Nazwa	Typ	Opis
affinityInfo	AffinityInformation	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	ApplicationPackageReference[]	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	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	string	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	TaskConstraints	Ograniczenia wykonywania, które mają zastosowanie do tego zadania.
containerSettings	TaskContainerSettings	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.
creationTime	string	Czas tworzenia zadania.
dependsOn	TaskDependencies	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.
displayName	string	Nazwa wyświetlana zadania. Nazwa wyświetlana nie musi być unikatowa i może zawierać znaki Unicode o maksymalnej długości 1024.
eTag	string	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.
environmentSettings	EnvironmentSetting[]	Lista ustawień zmiennych środowiskowych dla zadania.
executionInfo	TaskExecutionInformation	Informacje o wykonaniu zadania.
exitConditions	ExitConditions	Określa, jak usługa Batch powinna odpowiadać po zakończeniu zadania. Jak usługa Batch powinna odpowiadać po zakończeniu zadania.
id	string	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.
lastModified	string	Czas ostatniej modyfikacji zadania.
multiInstanceSettings	MultiInstanceSettings	Obiekt wskazujący, że zadanie jest zadaniem z wieloma wystąpieniami i zawiera informacje o sposobie uruchamiania zadania z wieloma wystąpieniami. Zadania z wieloma wystąpieniami są często używane do obsługi zadań MPI. W przypadku mpI, jeśli którykolwiek z podzadań zakończy się niepowodzeniem (na przykład z powodu zakończenia z kodem zakończenia bez zera), całe zadanie z wieloma wystąpieniami zakończy się niepowodzeniem. Zadanie z wieloma wystąpieniami jest następnie przerywane i ponawiane, aż do limitu ponawiania prób.
nodeInfo	ComputeNodeInformation	Informacje o węźle obliczeniowym, na którym uruchomiono zadanie.
outputFiles	OutputFile[]	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.
previousState	TaskState	Poprzedni stan zadania. Ta właściwość nie jest ustawiona, jeśli zadanie jest w początkowym stanie Aktywny.
previousStateTransitionTime	string	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.
requiredSlots	integer	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.
resourceFiles	ResourceFile[]	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	TaskState	Bieżący stan zadania.
stateTransitionTime	string	Czas, w którym zadanie wprowadziło bieżący stan.
stats	TaskStatistics	Statystyki użycia zasobów dla zadania.
url	string	Adres URL zadania.
userIdentity	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.

ComputeNodeIdentityReference

Objekt

Odwołanie do tożsamości przypisanej przez użytkownika skojarzonej z pulą usługi Batch, która będzie używana przez węzeł obliczeniowy.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu usługi ARM tożsamości przypisanej przez użytkownika.

ComputeNodeInformation

Objekt

Informacje o węźle obliczeniowym, na którym uruchomiono zadanie.

Nazwa	Typ	Opis
affinityId	string	Identyfikator węzła, na którym uruchomiono zadanie, który można przekazać podczas dodawania zadania, aby zażądać, aby zadanie było zaplanowane w tym węźle obliczeniowym.
nodeId	string	Identyfikator węzła obliczeniowego, na którym uruchomiono zadanie.
nodeUrl	string	Adres URL węzła obliczeniowego, na którym uruchomiono zadanie.
poolId	string	Identyfikator puli, na której uruchomiono zadanie.
taskRootDirectory	string	Katalog główny zadania w węźle obliczeniowym.
taskRootDirectoryUrl	string	Adres URL katalogu głównego zadania w węźle obliczeniowym.

ContainerHostBatchBindMountEntry

Objekt

Wpis ścieżki i trybu instalacji, który chcesz zainstalować w kontenerze zadań.

Nazwa	Typ	Opis
isReadOnly	boolean	Zainstaluj tę ścieżkę źródłową jako tryb tylko do odczytu lub nie. Wartość domyślna to false (tryb odczytu/zapisu). W przypadku systemu Linux, jeśli zainstalujesz tę ścieżkę jako tryb odczytu/zapisu, nie oznacza to, że wszyscy użytkownicy w kontenerze mają dostęp do odczytu/zapisu dla ścieżki, zależy to od dostępu na maszynie wirtualnej hosta. Jeśli ta ścieżka jest instalowana tylko do odczytu, wszyscy użytkownicy w kontenerze nie będą mogli modyfikować ścieżki.
source	ContainerHostDataPath	Można wybrać ścieżkę instalowaną dla klienta kontenera.

ContainerHostDataPath

Wyliczanie

Ścieżki, które zostaną zainstalowane w kontenerze zadania kontenera.

Wartość	Opis
Applications	Ścieżka aplikacji.
JobPrep	Ścieżka zadania przygotowania zadania.
Shared	Ścieżka zadania obejmującego wiele wystąpień w celu udostępnienia plików.
Startup	Ścieżka zadania podrzędnego uruchamiania.
Task	Ścieżka zadania.
VfsMounts	Ścieżka zawiera wszystkie wirtualne systemy plików są instalowane w tym węźle.

ContainerRegistry

Objekt

Prywatny rejestr kontenerów.

Nazwa	Typ	Opis
identityReference	ComputeNodeIdentityReference	Odwołanie do tożsamości przypisanej przez użytkownika w celu uzyskania dostępu do usługi Azure Container Registry zamiast nazwy użytkownika i hasła. Odwołanie do tożsamości przypisanej przez użytkownika skojarzonej z pulą usługi Batch, która będzie używana przez węzeł obliczeniowy.
password	string	Hasło do logowania się na serwerze rejestru.
registryServer	string	Adres URL rejestru. W przypadku pominięcia wartość domyślna to "docker.io".
username	string	Nazwa użytkownika do logowania się na serwerze rejestru.

ContainerWorkingDirectory

Wyliczanie

Lokalizacja katalogu roboczego zadania kontenera.

Wartość	Opis
containerImageDefault	Użyj katalogu roboczego zdefiniowanego w obrazie kontenera. Należy pamiętać, że ten katalog nie będzie zawierać plików zasobów pobranych przez usługę Batch.
taskWorkingDirectory	Użyj standardowego katalogu roboczego zadania usługi Batch, który będzie zawierać pliki zasobów zadań wypełniane przez usługę Batch.

DependencyAction

Wyliczanie

Akcja wykonywana przez usługę Batch dla zadań, które zależą od tego zadania.

Wartość	Opis
block	Blokuje zadania oczekujące na to zadanie, uniemożliwiając ich zaplanowanie.
satisfy	Spełnij zadania oczekujące na to zadanie; gdy wszystkie zależności zostaną spełnione, zadanie zostanie zaplanowane do uruchomienia.

ElevationLevel

Wyliczanie

Poziom podniesienia uprawnień użytkownika.

Wartość	Opis
admin	Użytkownik jest użytkownikiem z podwyższonym poziomem dostępu i działa z pełnymi uprawnieniami administratora.
nonadmin	Użytkownik jest użytkownikiem standardowym bez podwyższonego poziomu dostępu.

EnvironmentSetting

Objekt

Zmienna środowiskowa, która ma być ustawiana w procesie zadania.

Nazwa	Typ	Opis
name	string	Nazwa zmiennej środowiskowej.
value	string	Wartość zmiennej środowiskowej.

ErrorCategory

Wyliczanie

Kategoria błędu.

Wartość	Opis
servererror	Błąd jest spowodowany wewnętrznym problemem z serwerem.
usererror	Błąd jest spowodowany problemem użytkownika, takim jak błędna konfiguracja.

ErrorMessage

Objekt

Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.

Nazwa	Typ	Opis
lang	string	Kod języka komunikatu o błędzie
value	string	Tekst wiadomości.

ExitCodeMapping

Objekt

Jak usługa Batch powinna odpowiadać, jeśli zadanie zakończy działanie z określonym kodem zakończenia.

Nazwa	Typ	Opis
code	integer	Kod zakończenia procesu.
exitOptions	ExitOptions	Jak usługa Batch powinna odpowiedzieć, jeśli zadanie zakończy działanie z tym kodem zakończenia.

ExitCodeRangeMapping

Objekt

Zakres kodów zakończenia i sposobu, w jaki usługa Batch powinna reagować na kody zakończenia w tym zakresie.

Nazwa	Typ	Opis
end	integer	Ostatni kod zakończenia w zakresie.
exitOptions	ExitOptions	Jak usługa Batch powinna odpowiedzieć, jeśli zadanie zakończy działanie z kodem zakończenia w zakresie rozpoczynającym się (włącznie).
start	integer	Pierwszy kod zakończenia w zakresie.

ExitConditions

Objekt

Określa, jak usługa Batch powinna odpowiadać po zakończeniu zadania.

Nazwa	Typ	Opis
default	ExitOptions	Jak usługa Batch powinna odpowiedzieć, jeśli zadanie zakończy się niepowodzeniem z warunkiem zakończenia, który nie jest objęty żadną z innych właściwości. Ta wartość jest używana, jeśli właściwość Task kończy działanie z kodem niezerowym, który nie jest wymieniony w kolekcji exitCodes lub exitCodeRanges, z błędem przetwarzania wstępnego, jeśli właściwość preProcessingError nie jest obecna, lub z błędem przekazywania pliku, jeśli właściwość fileUploadError nie jest obecna. Jeśli chcesz, aby w kodzie zakończenia 0 nie było domyślne zachowanie, musisz je jawnie wyświetlić przy użyciu kolekcji exitCodes lub exitCodeRanges.
exitCodeRanges	ExitCodeRangeMapping[]	Lista zakresów kodu zakończenia zadania i sposobu reagowania na nie przez usługę Batch.
exitCodes	ExitCodeMapping[]	Lista poszczególnych kodów zakończenia zadania i sposobu, w jaki usługa Batch powinna odpowiadać na nie.
fileUploadError	ExitOptions	Jak usługa Batch powinna odpowiadać w przypadku wystąpienia błędu przekazywania pliku. Jeśli zadanie zakończyło działanie z kodem zakończenia określonym za pośrednictwem exitCodes lub exitCodeRanges, a następnie napotkało błąd przekazywania pliku, akcja określona przez kod zakończenia ma pierwszeństwo.
preProcessingError	ExitOptions	Jak usługa Batch powinna odpowiedzieć, jeśli zadanie nie powiedzie się z powodu błędu.

ExitOptions

Objekt

Określa sposób, w jaki usługa Batch reaguje na określony warunek zakończenia.

Nazwa	Typ	Opis
dependencyAction	DependencyAction	Akcja wykonywana przez usługę Batch dla zadań, które zależą od tego zadania. Możliwe wartości są "spełnione" (co umożliwia wykonywanie zadań zależnych) i "blokuj" (zadania zależne będą nadal czekać). Usługa Batch nie obsługuje jeszcze anulowania zadań zależnych.
jobAction	JobAction	Akcja wykonywana dla zadania zawierającego zadanie, jeśli zadanie zostanie zakończone z danym warunkiem zakończenia, a właściwość onTaskFailed zadania to "performExitOptionsJobAction". Wartość domyślna nie dotyczy kodu zakończenia 0 i zakończenia dla wszystkich innych warunków zakończenia. Jeśli właściwość onTaskFailed zadania ma wartość noaction, wówczas określenie tej właściwości zwraca błąd, a dodanie żądania zadania kończy się niepowodzeniem z powodu błędu nieprawidłowej wartości właściwości; Jeśli bezpośrednio wywołujesz interfejs API REST, kod stanu HTTP to 400 (Nieprawidłowe żądanie).

HttpHeader

Objekt

Para nazwa-wartość nagłówka HTTP

Nazwa	Typ	Opis
name	string	Bez uwzględniania wielkości liter nazwa nagłówka, która ma być używana podczas przekazywania plików wyjściowych
value	string	Wartość nagłówka, która ma być używana podczas przekazywania plików wyjściowych

JobAction

Wyliczanie

Akcja wykonywana dla zadania zawierającego zadanie, jeśli zadanie zostanie zakończone z danym warunkiem zakończenia, a właściwość onTaskFailed zadania to "performExitOptionsJobAction".

Wartość	Opis
disable	Wyłącz zadanie. Jest to równoważne wywołaniu interfejsu API wyłączania zadania z wartością disableTasks w kolejce.
none	Nie podejmij żadnych działań.
terminate	Zakończ zadanie. Parametr terminateReason w poleceniu ExecutionInfo zadania jest ustawiony na wartość "TaskFailed".

MultiInstanceSettings

Objekt

Ustawienia określające sposób uruchamiania zadania obejmującego wiele wystąpień.

Nazwa	Typ	Opis
commonResourceFiles	ResourceFile[]	Lista plików pobranych przez usługę Batch przed uruchomieniem wiersza polecenia koordynacji. Różnica między typowymi plikami zasobów i plikami zasobów zadania polega na tym, że wspólne pliki zasobów są pobierane dla wszystkich podzadań, w tym podstawowego, natomiast pliki zasobów zadania są pobierane tylko dla podstawowego. Należy również pamiętać, że te pliki zasobów nie są pobierane do katalogu roboczego Zadania, ale zamiast tego są pobierane do katalogu głównego zadania (jeden katalog powyżej katalogu roboczego). 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.
coordinationCommandLine	string	Wiersz polecenia do uruchomienia na wszystkich węzłach obliczeniowych, aby umożliwić im koordynowanie, gdy podstawowy uruchamia główne polecenie zadanie. Typowy wiersz polecenia koordynacji uruchamia usługę w tle i sprawdza, czy usługa jest gotowa do przetwarzania komunikatów między węzłami.
numberOfInstances	integer	Liczba węzłów obliczeniowych wymaganych przez zadanie. W przypadku pominięcia wartość domyślna to 1.

NameValuePair

Objekt

Reprezentuje parę nazwa-wartość.

Nazwa	Typ	Opis
name	string	Nazwa w parze name-value.
value	string	Wartość w parze name-value.

OutputFile

Objekt

Specyfikacja przekazywania plików z węzła obliczeniowego usługi Azure Batch do innej lokalizacji po zakończeniu wykonywania procesu zadania przez usługę Batch.

Nazwa	Typ	Opis
destination	OutputFileDestination	Miejsce docelowe plików wyjściowych.
filePattern	string	Wzorzec wskazujący, które pliki mają być przekazywane. Obsługiwane są ścieżki względne i bezwzględne. Ścieżki względne są względne względem katalogu roboczego Zadania. Obsługiwane są następujące symbole wieloznaczne: * pasuje do 0 lub większej liczby znaków (na przykład wzorzec abc* pasuje do abc lub abcdef), ** pasuje do dowolnego katalogu, ? pasuje do dowolnego pojedynczego znaku, [abc] pasuje do jednego znaku w nawiasach kwadratowych, a [a-c] pasuje do jednego znaku w zakresie. Nawiasy mogą zawierać negację, aby dopasować dowolny nieokreślony znak (na przykład [!abc] pasuje do dowolnego znaku, ale a, b lub c). Jeśli nazwa pliku zaczyna się od "." jest domyślnie ignorowana, ale może być zgodna, określając ją jawnie (na przykład .gif nie będzie zgodna z .a.gif, ale ..gif będzie). Prosty przykład: ***.txt pasuje do dowolnego pliku, który nie rozpoczyna się w '.' i kończy się .txt w katalogu roboczym Zadanie lub w żadnym podkatalogu. Jeśli nazwa pliku zawiera symbol wieloznaczny, można go użyć nawiasów kwadratowych (na przykład abc[] będzie pasować do pliku o nazwie abc). Należy pamiętać, że zarówno \, jak i / są traktowane jako separatory katalogów w systemie Windows, ale tylko / jest w systemie Linux. Zmienne środowiskowe (%var% w systemie Windows lub $var w systemie Linux) są rozszerzane przed zastosowaniem wzorca.
uploadOptions	OutputFileUploadOptions	Dodatkowe opcje operacji przekazywania, w tym w jakich warunkach należy wykonać przekazywanie.

OutputFileBlobContainerDestination

Objekt

Określa miejsce docelowe przekazywania plików w kontenerze usługi Azure Blob Storage.

Nazwa	Typ	Opis
containerUrl	string	Adres URL kontenera w usłudze Azure Blob Storage, do którego mają być przekazywane pliki. Jeśli nie używasz tożsamości zarządzanej, adres URL musi zawierać sygnaturę dostępu współdzielonego udzielając uprawnień do zapisu w kontenerze.
identityReference	ComputeNodeIdentityReference	Odwołanie do tożsamości przypisanej przez użytkownika w celu uzyskania dostępu do usługi Azure Blob Storage określonej przez containerUrl Tożsamość musi mieć dostęp do zapisu do kontenera usługi Azure Blob Storage
path	string	Docelowy obiekt blob lub katalog wirtualny w kontenerze usługi Azure Storage. Jeśli filePattern odwołuje się do określonego pliku (tj. nie zawiera symboli wieloznacznych), ścieżka to nazwa obiektu blob, do którego ma być przekazany ten plik. Jeśli plikPattern zawiera co najmniej jedną symbol wieloznaczny (i dlatego może być zgodna z wieloma plikami), ścieżka jest nazwą katalogu wirtualnego obiektu blob (który jest poprzedzany każdą nazwą obiektu blob), do którego mają zostać przekazane pliki. Jeśli pominięto, pliki są przekazywane do katalogu głównego kontenera z nazwą obiektu blob pasującą do nazwy pliku.
uploadHeaders	HttpHeader[]	Lista par nazwa-wartość dla nagłówków, które mają być używane podczas przekazywania plików wyjściowych Te nagłówki zostaną określone podczas przekazywania plików do usługi Azure Storage. Oficjalny dokument dotyczący dozwolonych nagłówków podczas przekazywania obiektów blob: https://learn.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

Objekt

Miejsce docelowe, do którego ma zostać przekazany plik.

Nazwa	Typ	Opis
container	OutputFileBlobContainerDestination	Lokalizacja w usłudze Azure Blob Storage, do której są przekazywane pliki.

OutputFileUploadCondition

Wyliczanie

Warunki, w których należy przekazać plik wyjściowy zadania lub zestaw plików.

Wartość	Opis
taskcompletion	Przekaż pliki po zakończeniu procesu zadania, niezależnie od tego, jaki był kod zakończenia.
taskfailure	Przekaż pliki tylko po zakończeniu procesu zadania z kodem zakończenia bezzerowym.
tasksuccess	Przekaż pliki tylko po zakończeniu procesu zadania z kodem zakończenia 0.

OutputFileUploadOptions

Objekt

Szczegółowe informacje o operacji przekazywania pliku wyjściowego, w tym o warunkach, w których należy wykonać przekazywanie.

Nazwa	Typ	Opis
uploadCondition	OutputFileUploadCondition	Warunki, w których należy przekazać plik wyjściowy zadania lub zestaw plików. Wartość domyślna to taskcompletion.

ResourceFile

Objekt

Jeden plik lub wiele plików do pobrania do węzła obliczeniowego.

Nazwa	Typ	Opis
autoStorageContainerName	string	Nazwa kontenera magazynu na koncie automatycznego magazynu. Właściwości autoStorageContainerName, storageContainerUrl i httpUrl wzajemnie się wykluczają i należy określić jedną z nich.
blobPrefix	string	Prefiks obiektu blob używany podczas pobierania obiektów blob z kontenera usługi Azure Storage. Zostaną pobrane tylko obiekty blob, których nazwy zaczynają się od określonego prefiksu. Właściwość jest prawidłowa tylko wtedy, gdy jest używana właściwość autoStorageContainerName lub storageContainerUrl. Ten prefiks może być częściową nazwą pliku lub podkatalogem. Jeśli prefiks nie zostanie określony, zostaną pobrane wszystkie pliki w kontenerze.
fileMode	string	Atrybut trybu uprawnień pliku w formacie ósemkowym. Ta właściwość ma zastosowanie tylko do plików pobieranych do węzłów obliczeniowych systemu Linux. Zostanie on zignorowany, jeśli zostanie określony dla elementu resourceFile, który zostanie pobrany do węzła obliczeniowego systemu Windows. Jeśli ta właściwość nie zostanie określona dla węzła obliczeniowego systemu Linux, do pliku zostanie zastosowana wartość domyślna 0770.
filePath	string	Lokalizacja w węźle obliczeniowym, do którego mają być pobierane pliki względem katalogu roboczego zadania. Jeśli określono właściwość httpUrl, parametr filePath jest wymagany i opisuje ścieżkę, do której zostanie pobrany plik, w tym nazwę pliku. W przeciwnym razie, jeśli określono właściwość autoStorageContainerName lub storageContainerUrl, parametr filePath jest opcjonalny i jest katalogem do pobrania plików. W przypadku, gdy filePath jest używany jako katalog, każda struktura katalogów już skojarzona z danymi wejściowymi zostanie zachowana w całości i dołączona do określonego katalogu filePath. Określona ścieżka względna nie może przerwać katalogu roboczego zadania (na przykład przy użyciu ".".
httpUrl	string	Adres URL pliku do pobrania. Właściwości autoStorageContainerName, storageContainerUrl i httpUrl wzajemnie się wykluczają i należy określić jedną z nich. Jeśli adres URL wskazuje usługę Azure Blob Storage, musi być czytelny z węzłów obliczeniowych. Istnieją trzy sposoby uzyskiwania takiego adresu URL dla obiektu blob w usłudze Azure Storage: obejmują sygnaturę dostępu współdzielonego udzielając uprawnień do odczytu dla obiektu blob, używanie tożsamości zarządzanej z uprawnieniami do odczytu lub ustawianie listy ACL dla obiektu blob lub kontenera, aby zezwolić na dostęp publiczny.
identityReference	ComputeNodeIdentityReference	Odwołanie do tożsamości przypisanej przez użytkownika w celu uzyskania dostępu do usługi Azure Blob Storage określonej przez wartość storageContainerUrl lub httpUrl Odwołanie do tożsamości przypisanej przez użytkownika skojarzonej z pulą usługi Batch, która będzie używana przez węzeł obliczeniowy.
storageContainerUrl	string	Adres URL kontenera obiektów blob w usłudze Azure Blob Storage. Właściwości autoStorageContainerName, storageContainerUrl i httpUrl wzajemnie się wykluczają i należy określić jedną z nich. Ten adres URL musi być czytelny i możliwy do wyświetlenia z węzłów obliczeniowych. Istnieją trzy sposoby uzyskania takiego adresu URL dla kontenera w usłudze Azure Storage: obejmują sygnaturę dostępu współdzielonego (SAS) udzielając uprawnień do odczytu i listy w kontenerze, używanie tożsamości zarządzanej z uprawnieniami do odczytu i listy lub ustawianie listy ACL dla kontenera, aby zezwolić na dostęp publiczny.

TaskConstraints

Objekt

Ograniczenia wykonywania, które mają zastosowanie do zadania.

Nazwa	Typ	Opis
maxTaskRetryCount	integer	Maksymalna liczba ponownych prób wykonania zadania. Usługa Batch ponawia próbę zadania, jeśli jego kod zakończenia jest inny niżzer. Należy pamiętać, że ta wartość steruje liczbą ponownych prób dla pliku wykonywalnego zadania ze względu na kod zakończenia niezerowy. Usługa Batch spróbuje raz wykonać zadanie, a następnie może ponowić próbę do tego limitu. Jeśli na przykład maksymalna liczba ponownych prób wynosi 3, usługa Batch próbuje wykonać zadanie do 4 razy (jedna początkowa próba i 3 ponownych prób). Jeśli maksymalna liczba ponownych prób wynosi 0, usługa Batch nie ponowi próby wykonania zadania po pierwszej próbie. Jeśli maksymalna liczba ponownych prób wynosi -1, usługa Batch ponawia próbę zadania bez limitu, jednak nie jest to zalecane w przypadku zadania podrzędnego uruchamiania ani żadnego zadania podrzędnego. Wartość domyślna to 0 (bez ponownych prób).
maxWallClockTime	string	Maksymalny czas, który upłynął, który może zostać uruchomiony przez zadanie, mierzony od momentu uruchomienia zadania. Jeśli zadanie nie zostanie ukończone w limicie czasu, usługa Batch zakończy je. Jeśli to nie zostanie określone, nie ma limitu czasu na czas uruchomienia zadania.
retentionTime	string	Minimalny czas przechowywania katalogu zadań w węźle obliczeniowym, w którym został uruchomiony, od momentu zakończenia wykonywania. Po tym czasie usługa Batch może usunąć katalog Task i całą jego zawartość. Wartość domyślna to 7 dni, tj. katalog zadań zostanie zachowany przez 7 dni, chyba że węzeł obliczeniowy zostanie usunięty lub zadanie zostanie usunięte.

TaskContainerExecutionInformation

Objekt

Zawiera informacje o kontenerze, który wykonuje zadanie.

Nazwa	Typ	Opis
containerId	string	Identyfikator kontenera.
error	string	Szczegółowe informacje o błędzie dotyczące kontenera. Jest to szczegółowy ciąg błędu z usługi Docker, jeśli jest dostępny. Jest to odpowiednik pola błędu zwróconego przez wyrażenie "docker inspect".
state	string	Stan kontenera. Jest to stan kontenera zgodnie z usługą Docker. Jest to odpowiednik pola stanu zwróconego przez wyrażenie "docker inspect".

TaskContainerSettings

Objekt

Ustawienia kontenera dla zadania.

Nazwa	Typ	Opis
containerHostBatchBindMounts	ContainerHostBatchBindMountEntry[]	Ścieżki, które chcesz zamontować w zadaniu kontenera. Jeśli ta tablica ma wartość null lub nie istnieje, zadanie kontenera zainstaluje cały dysk tymczasowy w systemie Windows (lub AZ_BATCH_NODE_ROOT_DIR w systemie Linux). Jeśli ta tablica jest ustawiona jako pusta, nie zainstaluje żadnych ścieżek danych w kontenerze.
containerRunOptions	string	Dodatkowe opcje polecenia create kontenera. Te dodatkowe opcje są dostarczane jako argumenty polecenia "docker create" oprócz tych kontrolowanych przez usługę Batch.
imageName	string	Obraz używany do utworzenia kontenera, w którym zostanie uruchomione zadanie. Jest to pełne odwołanie do obrazu, jak można określić na "ściąganie platformy Docker". Jeśli w nazwie obrazu nie podano żadnego tagu, tag ":latest" jest używany jako domyślny.
registry	ContainerRegistry	Prywatny rejestr zawierający obraz kontenera. To ustawienie można pominąć, jeśli zostało już udostępnione podczas tworzenia puli.
workingDirectory	ContainerWorkingDirectory	Lokalizacja katalogu roboczego zadania kontenera. Wartość domyślna to "taskWorkingDirectory".

TaskDependencies

Objekt

Określa wszelkie zależności zadania. Każde zadanie, które jest jawnie określone lub w zakresie zależności, musi zostać ukończone przed zaplanowaniem zadania zależnego.

Nazwa	Typ	Opis
taskIdRanges	TaskIdRange[]	Lista zakresów identyfikatorów zadań, od których zależy to zadanie. Wszystkie zadania we wszystkich zakresach muszą zostać ukończone pomyślnie przed zaplanowaniem zależnego zadania.
taskIds	string[]	Lista identyfikatorów zadań, od których zależy to zadanie. Wszystkie zadania na tej liście muszą zostać ukończone pomyślnie przed zaplanowanym zadaniem zależnym. Kolekcja taskIds jest ograniczona do 64000 znaków (tj. łączna długość wszystkich identyfikatorów zadań). Jeśli kolekcja taskIds przekracza maksymalną długość, żądanie dodawania zadania kończy się niepowodzeniem z kodem błędu TaskDependencyListTooLong. W tym przypadku rozważ użycie zakresów identyfikatorów zadań.

TaskExecutionInformation

Objekt

Informacje o wykonywaniu zadania.

Nazwa	Typ	Opis
containerInfo	TaskContainerExecutionInformation	Informacje o kontenerze, w którym jest wykonywane zadanie. Ta właściwość jest ustawiana tylko wtedy, gdy zadanie jest uruchamiane w kontekście kontenera.
endTime	string	Czas, w którym zadanie zostało ukończone. Ta właściwość jest ustawiana tylko wtedy, gdy zadanie jest w stanie Ukończono.
exitCode	integer	Kod zakończenia programu określony w wierszu polecenia zadania. Ta właściwość jest ustawiana tylko wtedy, gdy zadanie jest w stanie ukończonym. Ogólnie rzecz biorąc, kod zakończenia procesu odzwierciedla konkretną konwencję zaimplementowaną przez dewelopera aplikacji dla tego procesu. Jeśli używasz wartości kodu zakończenia do podejmowania decyzji w kodzie, upewnij się, że znasz konwencję kodu zakończenia używaną przez proces aplikacji. Jeśli jednak usługa Batch zakończy zadanie (z powodu przekroczenia limitu czasu lub zakończenia działania użytkownika za pośrednictwem interfejsu API), może zostać wyświetlony kod zakończenia zdefiniowany przez system operacyjny.
failureInfo	TaskFailureInformation	Informacje opisujące błąd zadania, jeśli istnieje. Ta właściwość jest ustawiana tylko wtedy, gdy zadanie jest w stanie ukończonym i napotkało błąd.
lastRequeueTime	string	Ostatni czas, w którym zadanie zostało ponownie w kolejce przez usługę Batch w wyniku żądania użytkownika. Ta właściwość jest ustawiana tylko wtedy, gdy requeueCount jest nonzero.
lastRetryTime	string	Ostatni raz, w którym uruchomiono ponowną próbę zadania. Ten element jest obecny tylko wtedy, gdy zadanie zostało ponowione (tj. retryCount jest nonzero). Jeśli jest obecny, zazwyczaj jest to samo co startTime, ale może się różnić, jeśli zadanie zostało uruchomione ponownie z powodów innych niż ponawianie próby; na przykład jeśli węzeł obliczeniowy został uruchomiony ponownie podczas ponawiania próby, godzina rozpoczęcia zostanie zaktualizowana, ale parametr lastRetryTime nie jest.
requeueCount	integer	Liczba ponownych kolejek zadania przez usługę Batch w wyniku żądania użytkownika. Gdy użytkownik usunie węzły obliczeniowe z puli (przez zmianę rozmiaru/zmniejszenie puli) lub gdy zadanie jest wyłączone, użytkownik może określić, że uruchomione zadania w węzłach obliczeniowych zostaną ponownie w kolejce do wykonania. Ta liczba śledzi liczbę ponownych kolejek zadania z tych powodów.
result	TaskExecutionResult	Wynik wykonania zadania. Jeśli wartość to "failed", szczegóły błędu można znaleźć we właściwości failureInfo.
retryCount	integer	Liczba ponownych prób wykonania zadania przez usługę Batch. Błędy aplikacji zadań (kod zakończenia niezerowy) są ponawiane, błędy przetwarzania wstępnego (nie można uruchomić zadania) i błędy przekazywania plików nie są ponawiane. Usługa Batch ponowi próbę wykonania zadania do limitu określonego przez ograniczenia.
startTime	string	Czas, w którym zadanie zaczęło działać. Polecenie "Uruchomione" odpowiada stanowi uruchomienia, więc jeśli zadanie określa pliki zasobów lub pakiety, godzina rozpoczęcia odzwierciedla czas rozpoczęcia, w którym zadanie rozpoczęło pobieranie lub wdrażanie tych plików. Jeśli zadanie zostało ponownie uruchomione lub ponowione, jest to ostatni czas, w którym zadanie zostało uruchomione. Ta właściwość jest obecna tylko w przypadku zadań, które są w stanie uruchomionym lub ukończonym.

TaskExecutionResult

Wyliczanie

Wynik wykonania zadania.

Wartość	Opis
failure	Wystąpił błąd podczas przetwarzania zadania. Błąd mógł wystąpić przed uruchomieniem procesu zadania, podczas wykonywania procesu zadania lub po zakończeniu procesu zadania.
success	Zadanie zakończyło się pomyślnie.

TaskFailureInformation

Objekt

Informacje o niepowodzeniu zadania.

Nazwa	Typ	Opis
category	ErrorCategory	Kategoria błędu zadania.
code	string	Identyfikator błędu zadania. Kody są niezmienne i mają być używane programowo.
details	NameValuePair[]	Lista dodatkowych szczegółów związanych z błędem.
message	string	Komunikat opisujący błąd zadania, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.

TaskIdRange

Objekt

Zakres identyfikatorów zadań, od których może zależeć zadanie. Wszystkie zadania z identyfikatorami w zakresie muszą zostać ukończone pomyślnie przed zaplanowaniem zależnego zadania.

Nazwa	Typ	Opis
end	integer	Ostatni identyfikator zadania w zakresie.
start	integer	Pierwszy identyfikator zadania w zakresie.

TaskState

Wyliczanie

Stan zadania.

Wartość	Opis
active	Zadanie jest w kolejce i można je uruchomić, ale nie jest obecnie przypisane do węzła obliczeniowego. Zadanie wprowadza ten stan po jego utworzeniu, gdy jest włączone po wyłączeniu lub gdy oczekuje na ponowienie próby po nieudanym uruchomieniu.
completed	Zadanie nie kwalifikuje się już do uruchomienia, zwykle dlatego, że zadanie zakończyło się pomyślnie lub zadanie zakończyło się niepowodzeniem i wyczerpało limit ponawiania prób. Zadanie jest również oznaczone jako ukończone, jeśli wystąpił błąd podczas uruchamiania zadania lub gdy zadanie zostało zakończone.
preparing	Zadanie zostało przydzielone do węzła obliczeniowego, ale oczekuje na ukończenie wymaganego zadania przygotowania zadania w węźle obliczeniowym. Jeśli zadanie przygotowania zadania zakończy się pomyślnie, zadanie zostanie przeniesione do uruchomienia. Jeśli zadanie przygotowania zadania zakończy się niepowodzeniem, zadanie powróci do aktywnej i będzie kwalifikować się do przypisania do innego węzła obliczeniowego.
running	Zadanie jest uruchomione w węźle obliczeniowym. Obejmuje to przygotowanie na poziomie zadania, takie jak pobieranie plików zasobów lub wdrażanie pakietów określonych w zadaniu — niekoniecznie oznacza to, że wiersz polecenia zadania rozpoczął wykonywanie.

TaskStatistics

Objekt

Statystyki użycia zasobów dla zadania.

Nazwa	Typ	Opis
kernelCPUTime	string	Łączny czas procesora CPU trybu jądra (sumowany na wszystkich rdzeniach i wszystkich węzłach obliczeniowych) używany przez zadanie.
lastUpdateTime	string	Czas ostatniej aktualizacji statystyk. Wszystkie statystyki są ograniczone do zakresu między startTime i lastUpdateTime.
readIOGiB	number	Łączna liczba gibibajtów odczytanych z dysku przez zadanie.
readIOps	integer	Całkowita liczba operacji odczytu dysku wykonanych przez zadanie.
startTime	string	Godzina rozpoczęcia zakresu czasu objętego statystykami.
url	string	Adres URL statystyk.
userCPUTime	string	Łączny czas procesora CPU trybu użytkownika (sumowany na wszystkich rdzeniach i wszystkich węzłach obliczeniowych) używany przez zadanie.
waitTime	string	Łączny czas oczekiwania zadania. Czas oczekiwania zadania jest definiowany jako czas, który upłynął między utworzeniem zadania a rozpoczęciem wykonywania zadania. (Jeśli zadanie zostanie ponowione z powodu awarii, czas oczekiwania to czas ostatniego wykonania zadania).
wallClockTime	string	Łączna godzina zegara ściany zadania. Czas zegara ściany to czas, który upłynął od momentu uruchomienia zadania w węźle obliczeniowym do momentu zakończenia (lub do czasu ostatniej aktualizacji statystyk, jeśli zadanie nie zostało zakończone do tego czasu). Jeśli zadanie zostało ponowione, obejmuje to zegar ściany wszystkich ponownych prób zadania.
writeIOGiB	number	Łączna liczba gibibajtów zapisywanych na dysku przez zadanie.
writeIOps	integer	Całkowita liczba operacji zapisu na dysku wykonanych przez zadanie.

UserIdentity

Objekt

Definicja tożsamości użytkownika, w ramach której jest uruchamiane zadanie.

Nazwa	Typ	Opis
autoUser	AutoUserSpecification	Użytkownik automatyczny, w ramach którego jest uruchamiane zadanie. Właściwości userName i autoUser wzajemnie się wykluczają; należy określić jeden, ale nie oba te elementy.
username	string	Nazwa tożsamości użytkownika, w ramach której jest uruchamiane zadanie. Właściwości userName i autoUser wzajemnie się wykluczają; należy określić jeden, ale nie oba te elementy.