Udostępnij przez


Tasks - Get Task

Otrzymuje informacje o określonym zadaniu.
W przypadku zadań wieloinstancjowych informacje takie jak affinityId, executionInfo i nodeInfo odnoszą się do zadania głównego. Użyj API lista podzadań, aby pobrać informacje o podzadaniach.

GET {endpoint}/jobs/{jobId}/tasks/{taskId}?api-version=2025-06-01
GET {endpoint}/jobs/{jobId}/tasks/{taskId}?api-version=2025-06-01&timeOut={timeOut}&$select={$select}&$expand={$expand}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
endpoint
path True

string (uri)

Punkt końcowy konta usługi Batch (na przykład: https://batchaccount.eastus2.batch.azure.com).

jobId
path True

string

ID zadania, które zawiera zadanie.

taskId
path True

string

ID zadania, aby uzyskać informacje.

api-version
query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

$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 domyślna wersja domyślna.".

Nagłówek żądania

Nazwa Wymagane Typ Opis
client-request-id

string

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-rfc7231)

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-Modified-Since

string (date-time-rfc7231)

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-rfc7231)

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.

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.

Odpowiedzi

Nazwa Typ Opis
200 OK

BatchTask

Żądanie zakończyło się pomyślnie.

Nagłówki

  • DataServiceId: string
  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

OAuth2Auth

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

Zakresy

Nazwa Opis
https://batch.core.windows.net//.default

Przykłady

Task get

Przykładowe żądanie

GET {endpoint}/jobs/jobId/tasks/taskId?api-version=2025-06-01


Przykładowa odpowiedź

{
  "id": "testTask",
  "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId",
  "eTag": "0x8D3D62350711C55",
  "creationTime": "2025-09-06T06:59:15.1161429Z",
  "lastModified": "2025-09-06T06:59:15.1161429Z",
  "state": "active",
  "stateTransitionTime": "2025-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
AuthenticationTokenSettings

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

AutoUserScope

Enumy AutoUserScope

AutoUserSpecification

Określa opcje dla użytkownika automatycznego, który uruchamia zadanie usługi Azure Batch.

BatchAccessScope

Enumy BatchAccessScope

BatchAffinityInfo

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.

BatchApplicationPackageReference

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

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.

BatchErrorMessage

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

BatchErrorSourceCategory

Enumy BatchErrorSourceCategory

BatchJobActionKind

Enumy BatchJobAction

BatchNodeIdentityReference

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.

BatchNodeInfo

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

BatchTask

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.

BatchTaskConstraints

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

BatchTaskContainerExecutionInfo

Zawiera informacje o kontenerze, który wykonuje zadanie.

BatchTaskContainerSettings

Ustawienia kontenera dla zadania.

BatchTaskDependencies

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.

BatchTaskExecutionInfo

Informacje o wykonywaniu zadania.

BatchTaskExecutionResult

Enumy BatchTaskExecutionResult

BatchTaskFailureInfo

Informacje o niepowodzeniu zadania.

BatchTaskIdRange

Początek i koniec zakresu są włącznie. Jeśli na przykład zakres ma początek 9 i koniec 12, reprezentuje zadania "9", "10", "11" i "12".

BatchTaskState

Enumy BatchTaskState

BatchTaskStatistics

Statystyki użycia zasobów dla zadania.

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.

ContainerRegistryReference

Prywatny rejestr kontenerów.

ContainerWorkingDirectory

Enums ContainerWorkingDirectory

DependencyAction

DependencyAction enumy

ElevationLevel

Enumy ElevationLevel

EnvironmentSetting

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

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.

MultiInstanceSettings

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.

NameValuePair

Reprezentuje parę nazwa-wartość.

OutputFile

Podczas każdego przekazywania plików usługa Batch zapisuje dwa pliki dziennika w węźle obliczeniowym "fileuploadout.txt" i "fileuploaderr.txt". Te pliki dziennika służą do uzyskania dodatkowych informacji na temat konkretnego błędu.

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

OutputFileUploadCondition enums

OutputFileUploadConfig

Opcje operacji przekazywania pliku wyjściowego, w tym w jakich warunkach należy wykonać przekazywanie.

OutputFileUploadHeader

Para nazwa-wartość nagłówka HTTP

ResourceFile

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

UserIdentity

Definicja tożsamości użytkownika, w ramach której jest uruchamiane zadanie. Określ właściwość userName lub autoUser, ale nie obie.

AuthenticationTokenSettings

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

Nazwa Typ Opis
access

BatchAccessScope[]

Zasoby wsadowe, do których token daje dostęp. Token uwierzytelniania przyznaje dostęp do ograniczonego zestawu operacji usług wsadowych. Obecnie jedyną obsługiwaną wartością właściwości dostępu jest "job", która daje dostęp do wszystkich operacji związanych z Jobem zawierającym Zadanie.

AutoUserScope

Enumy AutoUserScope

Wartość Opis
task

Określa, że usługa powinna utworzyć nowego użytkownika do zadania.

pool

Określa, że zadanie jest wykonywane jako wspólne automatyczne konto użytkownika, które jest tworzone na każdym węźle obliczeniowym w puli.

AutoUserSpecification

Określa opcje dla użytkownika automatycznego, który uruchamia zadanie usługi Azure 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. Na przykład, jeśli zadanie mutuje rejestr w sposób, który może mieć wpływ na inne zadania.

BatchAccessScope

Enumy BatchAccessScope

Wartość Opis
job

Daje dostęp do wykonywania wszystkich operacji nad zadaniem zawierającym zadanie.

BatchAffinityInfo

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

Nieprzezroczysty ciąg reprezentujący lokalizację węzła obliczeniowego lub zadania, które wcześniej się uruchomiło. Możesz przekazać affinityId węzła, aby wskazać, że to zadanie musi działać na 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.

BatchApplicationPackageReference

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

Nazwa Typ Opis
applicationId

string

ID 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 ten wniosek zostanie pominięty w Pool, a domyślna wersja nie zostanie określona dla tej aplikacji, żądanie kończy się niepowodzeniem z kodem błędu InvalidApplicationPackageReferences i kodem statusowym HTTP 409. Jeśli to zostanie pominięte w zadaniu i nie podano domyślnej wersji dla tej aplikacji, zadanie zostaje nieudane z błędem wstępnego przetwarzania.

BatchError

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

BatchErrorMessage

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

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.

BatchErrorMessage

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

Nazwa Typ Opis
lang

string

Kod językowy komunikatu o błędzie.

value

string

Tekst wiadomości.

BatchErrorSourceCategory

Enumy BatchErrorSourceCategory

Wartość Opis
usererror

Błąd wynika z problemu użytkownika, na przykład z błędnej konfiguracji.

servererror

Błąd wynika z wewnętrznego problemu z serwerem.

BatchJobActionKind

Enumy BatchJobAction

Wartość Opis
none

Nie podejmuj żadnych działań.

disable

Wyłącz zadanie. Jest to równoważne z wywołaniem API disable Job API, z wartością disableTasks requeue.

terminate

Zakończ pracę. TerminationReason w ExeInfo zadania jest ustawiony na "TaskFailed".

BatchNodeIdentityReference

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 (arm-id)

Identyfikator zasobu usługi ARM tożsamości przypisanej przez użytkownika.

BatchNodeInfo

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

Nazwa Typ Opis
affinityId

string

Identyfikator węzła, na którym działało zadanie, który można przekazać podczas dodawania zadania, aby zażądać zaplanowania zadania na tym węźle obliczeniowym.

nodeId

string

ID węzła obliczeniowego, na którym działało zadanie.

nodeUrl

string (uri)

URL węzła obliczeniowego, na którym działało zadanie.

poolId

string

ID puli, na której działało zadanie.

taskRootDirectory

string

Katalog główny zadania na węźle obliczeniowym.

taskRootDirectoryUrl

string (uri)

URL do katalogu głównego zadania na węźle obliczeniowym.

BatchTask

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.

Nazwa Typ Opis
affinityInfo

BatchAffinityInfo

Wskazówka dotycząca lokalizacji, którą usługa Batch może wykorzystać do wyboru węzła obliczeniowego, na którym rozpocząć nowe zadanie.

applicationPackageReferences

BatchApplicationPackageReference[]

Lista pakietów, które usługa wsadowa wdroży na węzeł obliczeniowym przed uruchomieniem linii poleceń. Pakiety aplikacji są pobierane i wdrażane do współdzielonego katalogu, a nie do katalogu roboczego Task. Dlatego jeśli na węźle znajduje się już odwołany pakiet, który jest aktualny, nie jest ponownie pobierany; używana jest istniejąca kopia na węźle obliczeniowym. Jeśli odwołany pakiet nie może zostać zainstalowany, na przykład dlatego, że pakiet został usunięty lub pobranie się nie powiodło, zadanie nie udaje się.

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 wsadowa zapewnia zadaniu token uwierzytelniający, który może być używany do uwierzytelniania operacji usługi wsadowej bez konieczności posiadania klucza dostępu do konta. Token jest dostarczany za pośrednictwem zmiennej środowiskowej AZ_BATCH_AUTHENTICATION_TOKEN. Operacje, które zadanie może wykonać za pomocą tokena, zależą od ustawień. Na przykład zadanie może żądać uprawnień do zadania, aby dodać inne zadania do zadania lub sprawdzić status zadania lub innych zadań pod zadaniem.

commandLine

string

Linia poleceń Zadania. Dla zadań wieloinstancjowych wiersz poleceń jest wykonywany jako zadanie główne, po zakończeniu wykonania wiersza poleceń głównych i wszystkich podzadań. 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

BatchTaskConstraints

Ograniczenia wykonawcze, które dotyczą tego zadania.

containerSettings

BatchTaskContainerSettings

Ustawienia kontenera, pod którym uruchamia się zadanie. Jeśli pula uruchamiająca to zadanie ma ustawioną containerConfiguration, to również musi być ustawiona. Jeśli pula, która wykona to zadanie, nie ma ustawionej containerConfiguration, nie może być ustawiona. Gdy to zostanie określone, wszystkie katalogi rekurencyjnie poniżej AZ_BATCH_NODE_ROOT_DIR (korzenia katalogów Azure Batch na węźle) są mapowane do kontenera, wszystkie zmienne środowiskowe Task są mapowane do kontenera, a wiersz poleceń Task jest wykonywany w kontenerze. Pliki wytworzone w kontenerze poza AZ_BATCH_NODE_ROOT_DIR mogą nie być odzwierciedlone na dysku hosta, co oznacza, że API plików wsadowych nie będą miały dostępu do tych plików.

creationTime

string (date-time)

Czas utworzenia zadania.

dependsOn

BatchTaskDependencies

Zadania, od których zależy to zadanie. To zadanie nie zostanie zaplanowane, dopóki wszystkie zadania, od których zależy, nie zostaną pomyślnie ukończone. Jeśli któreś z tych zadań nie powiodę i wyczerpie liczbę powtórek, to zadanie nigdy nie zostanie zaplanowane.

displayName

string

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

eTag

string

E-Ag zadania. Jest to nieprzezroczystym ciągiem. Możesz go użyć, aby wykryć, czy zadanie zmieniło się między żądaniami. W szczególności możesz przekazać ETag podczas aktualizacji zadania, aby określić, że zmiany mają wejść w życie tylko wtedy, gdy nikt inny nie zmodyfikował zadania w międzyczasie.

environmentSettings

EnvironmentSetting[]

Lista ustawień zmiennych środowiskowych dla zadania.

executionInfo

BatchTaskExecutionInfo

Informacje o realizacji zadania.

exitConditions

ExitConditions

Jak usługa wsadowa powinna reagować po zakończeniu zadania.

id

string

Ciąg znaków, który jednoznacznie identyfikuje Zadanie w obrębie 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 (date-time)

Ostatni zmodyfikowany czas zadania.

multiInstanceSettings

MultiInstanceSettings

Obiekt wskazujący, że zadanie jest zadaniem wieloinstancyjnym i zawiera informacje o tym, jak wykonać zadanie wieloinstancyjne.

nodeInfo

BatchNodeInfo

Informacje o węźle obliczeniowym, na którym działało zadanie.

outputFiles

OutputFile[]

Lista plików, które usługa wsadowa zagra z węzła obliczeniowego po uruchomieniu linii poleceń. W przypadku zadań wieloinstancjowych pliki będą przesyłane wyłącznie z węzła obliczeniowego, na którym wykonywane jest główne zadanie.

previousState

BatchTaskState

Poprzedni stan Zadania. Ta właściwość nie jest ustalana, jeśli zadanie znajduje się w początkowym stanie aktywnym.

previousStateTransitionTime

string (date-time)

Czas, w którym zadanie weszło w poprzedni stan. Ta właściwość nie jest ustalana, jeśli zadanie znajduje się w początkowym stanie aktywnym.

requiredSlots

integer (int32)

Liczba slotów harmonogramowych wymaganych do wykonania zadania. Wartość domyślna to 1. Zadanie może być zaplanowane do uruchomienia na węźle obliczeniowym tylko wtedy, gdy węzeł ma wystarczająco dużo wolnych slotów do planowania. Dla zadań wieloinstancjowych 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ń wieloinstancjowych pliki zasobów będą pobierane tylko do węzła obliczeniowego, na którym wykonywane jest główne zadanie. 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

BatchTaskState

Obecny stan Zadania.

stateTransitionTime

string (date-time)

Czas, w którym zadanie weszło w obecny stan.

stats

BatchTaskStatistics

Statystyki zużycia zasobów dla zadania.

url

string (uri)

URL zadania.

userIdentity

UserIdentity

Tożsamość użytkownika, pod którą wykonywane jest zadanie. Jeśli zostanie pominięte, Zadanie działa jako użytkownik nieadministracyjny, unikalny dla Zadania.

BatchTaskConstraints

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

Nazwa Typ Opis
maxTaskRetryCount

integer (int32)

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 zauważyć, że ta wartość konkretnie kontroluje liczbę powtórek dla pliku wykonywalnego zadania z powodu niezerowego kodu wyjścia. 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 powtórek wynosi 0, usługa wsadowa nie podejmuje próby 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 (duration)

Maksymalny czas, jaki może wykonać zadanie, mierzony od momentu jego rozpoczęcia. Jeśli zadanie nie zostanie ukończone w wyznaczonym czasie, usługa wsadowa je kończy. Jeśli nie jest to określone, nie ma limitu czasowego na czas trwania zadania.

retentionTime

string (duration)

Minimalny czas zachowania katalogu zadań na węźle obliczeniowym, w którym działał, od momentu zakończenia jego działania. Po upływie tego czasu usługa wsadowa może usunąć katalog zadań oraz całą jego zawartość. Domyślnie to 7 dni, czyli katalog zadań będzie przechowywany przez 7 dni, chyba że węzeł obliczeniowy zostanie usunięty lub zadanie usunięte.

BatchTaskContainerExecutionInfo

Zawiera informacje o kontenerze, który wykonuje zadanie.

Nazwa Typ Opis
containerId

string

Identyfikacja kontenera.

error

string

Szczegółowe informacje o błędach dotyczących kontenera. To jest szczegółowy ciąg błędów z usługi Docker, jeśli jest dostępny. Jest równoważne polu błędu zwracanemu przez "docker inspect".

state

string

Stan pojemnika. Taki jest stan kontenera według usługi Docker. Jest to równoważne polu statusu zwracanemu przez "docker inspect".

BatchTaskContainerSettings

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, którego używa się do stworzenia kontenera, w którym zadanie będzie działać. To jest pełne odniesienie do Image, jak byłoby określone jako "docker pull". Jeśli w nazwie obrazu nie ma tagu, domyślnie używa się tagu ":latest".

registry

ContainerRegistryReference

Prywatny rejestr, który zawiera obraz kontenera. To ustawienie można pominąć, jeśli było już dostępne podczas tworzenia puli.

workingDirectory

ContainerWorkingDirectory

Lokalizacja katalogu roboczego kontenera Task. Wartość domyślna to "taskWorkingDirectory".

BatchTaskDependencies

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

BatchTaskIdRange[]

Lista zakresów ID zadania, od których zależy to zadanie. Wszystkie zadania we wszystkich zakresach muszą zostać pomyślnie ukończone, zanim zadanie zależne może zostać zaplanowane.

taskIds

string[]

Lista ID zadań, od których zależy to zadanie. Wszystkie zadania z tej listy muszą zostać pomyślnie ukończone, zanim zadanie zależne może zostać zaplanowane. Kolekcja taskIds jest ograniczona do 64000 znaków łącznie (czyli łącznej długości wszystkich ID zadań). Jeśli kolekcja taskIds przekroczy maksymalną długość, żądanie Dodaj zadania kończy się niepowodzeniem z kodem błędu TaskDependencyListTooLong. W takim przypadku rozważ użycie zakresów ID zadania.

BatchTaskExecutionInfo

Informacje o wykonywaniu zadania.

Nazwa Typ Opis
containerInfo

BatchTaskContainerExecutionInfo

Informacje o kontenerze, w którym wykonywane jest zadanie. Ta właściwość jest ustawiona tylko wtedy, gdy zadanie działa w kontekście kontenerowym.

endTime

string (date-time)

Czas, w którym zadanie zostało ukończone. Ta właściwość jest ustawiona tylko wtedy, gdy zadanie znajduje się w stanie Zakończone.

exitCode

integer (int32)

Kod wyjścia programu określony w wierszu poleceń Task. Ta właściwość jest ustawiana tylko wtedy, gdy zadanie znajduje się w stanie ukończonym. Ogólnie rzecz biorąc, kod wyjścia dla procesu odzwierciedla konkretną konwencję zaimplementowaną przez twórcę aplikacji dla tego procesu. Jeśli używasz wartości kodu wyjścia do podejmowania decyzji w kodzie, upewnij się, że znasz konwencję kodu wyjścia stosowaną przez proces aplikacji. Jednak jeśli usługa wsadowa zakończy zadanie (z powodu limitu czasu lub zakończenia przez API), możesz zobaczyć kod wyjścia zdefiniowany przez system operacyjny.

failureInfo

BatchTaskFailureInfo

Informacje opisujące ewentualne niepowodzenie zadania. Ta właściwość jest ustawiona tylko wtedy, gdy zadanie jest w stanie ukończonym i napotkało awarię.

lastRequeueTime

string (date-time)

Ostatni raz, gdy zadanie zostało ponownie zakolejone przez usługę Batch w wyniku żądania użytkownika. Ta właściwość jest ustawiana tylko wtedy, gdy liczba requeueCount jest różna od zera.

lastRetryTime

string (date-time)

Ostatni raz, gdy rozpoczęła się powtórka zadania. Ten element występuje tylko wtedy, gdy zadanie zostało ponownie spróbowane (tzn. retryCount jest różny od zera). Jeśli jest obecny, zazwyczaj jest to to samo co startTime, ale może się różnić, jeśli zadanie zostało ponownie uruchomione z powodów innych niż powtórka; na przykład, jeśli węzeł obliczeniowy został zrestartowany podczas ponownej próby, to czas startu zostaje zaktualizowany, ale ostatni czas próby próby nie.

requeueCount

integer (int32)

Liczba razy, gdy zadanie było ponownie kolejkowane przez usługę wsadową w wyniku żądania użytkownika. Gdy użytkownik usuwa węzły obliczeniowe z puli (poprzez zmianę rozmiaru/zmniejszanie puli) lub gdy zadanie jest wyłączane, użytkownik może określić, że wykonywane zadania na węzłach obliczeniowych zostaną ponownie zakolejone do wykonania. To liczenie pokazuje, ile razy zadanie było ponownie kolejkowane z tych powodów.

result

BatchTaskExecutionResult

Wynik wykonania zadania. Jeśli wartość to 'failed', szczegóły awarii można znaleźć w właściwości failureInfo.

retryCount

integer (int32)

Liczba powtórzeń wykonania zadania przez usługę wsadową. Błędy aplikacji zadania (niezerowy kod wyjścia) są powtarzane, błędy wstępnego przetwarzania (zadanie nie mogło zostać wykonane), a błędy przesyłania plików nie są powtarzane. Usługa Batch ponownie spróbuje zadanie do limitu określonego przez ograniczenia.

startTime

string (date-time)

Czas, w którym Zadanie zaczęło działać. "Running" odpowiada stanowi działania (running), więc jeśli zadanie określa pliki zasobów lub pakiety, to czas rozpoczęcia odzwierciedla moment, w którym zadanie zaczęło je pobierać lub wdrażać. Jeśli zadanie zostało ponownie uruchomione lub podjęte ponownie, to jest to najnowszy moment, kiedy zadanie zaczęło działać. Ta właściwość występuje tylko dla zadań będących w stanie uruchomienia lub zakończenia.

BatchTaskExecutionResult

Enumy BatchTaskExecutionResult

Wartość Opis
success

Zadanie przebiegło pomyślnie.

failure

Podczas przetwarzania zadania wystąpił błąd. Awaria mogła nastąpić przed uruchomieniem procesu Zadania, podczas jego wykonywania lub po jego zakończeniu.

BatchTaskFailureInfo

Informacje o niepowodzeniu zadania.

Nazwa Typ Opis
category

BatchErrorSourceCategory

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 tym błędem.

message

string

Komunikat opisujący błąd zadania, przeznaczony do wyświetlania w interfejsie użytkownika.

BatchTaskIdRange

Początek i koniec zakresu są włącznie. Jeśli na przykład zakres ma początek 9 i koniec 12, reprezentuje zadania "9", "10", "11" i "12".

Nazwa Typ Opis
end

integer (int32)

Ostatni identyfikator zadania w zakresie.

start

integer (int32)

Pierwszy identyfikator zadania w zakresie.

BatchTaskState

Enumy BatchTaskState

Wartość Opis
active

Zadanie jest w kolejce i może się uruchomić, ale obecnie nie jest przypisane do węzła obliczeniowego. Zadanie wchodzi w ten stan w momencie utworzenia, gdy jest włączone po wyłączeniu lub gdy oczekuje na ponowną próbę po nieudanym uruchomieniu.

preparing

Zadanie zostało przypisane do węzła obliczeniowego, ale czeka na wykonanie wymaganego zadania przygotowania zadania na tym węźle. Jeśli zadanie Przygotowania Zadania zakończy się sukcesem, przechodzi do działania. Jeśli zadanie Przygotowania Zadania nie powiedzie, Zadanie powróci do aktywnego stanu i będzie kwalifikować się do przypisania do innego węzła obliczeniowego.

running

Zadanie jest uruchamiane na węźle obliczeniowym. Obejmuje to przygotowanie na poziomie zadania, takie jak pobieranie plików zasobów czy wdrażanie pakietów określonych w zadaniu – nie oznacza to koniecznie, że linia poleceń zadania rozpoczęła działanie.

completed

Zadanie nie może już zostać wykonane, zazwyczaj dlatego, że zadanie zakończyło się pomyślnie lub zadanie zakończyło się niepowodzeniem i wyczerpało limit powtórek. Zadanie jest również oznaczane jako zakończone, jeśli wystąpił błąd podczas jego uruchomienia lub gdy zadanie zostało zakończone.

BatchTaskStatistics

Statystyki użycia zasobów dla zadania.

Nazwa Typ Opis
kernelCPUTime

string (duration)

Całkowity czas CPU w trybie jądra (sumowany przez wszystkie rdzenie i wszystkie węzły obliczeniowe) zużywany przez zadanie.

lastUpdateTime

string (date-time)

Czas, w którym ostatnio aktualizowano statystyki. Wszystkie statystyki ograniczają się do zakresu między StartTime a ostatniMAktualizacją.

readIOGiB

number (float)

Łączna liczba gibibajtów odczytanych z dysku przez Task.

readIOps

string (int64)

Całkowita liczba operacji odczytu dysku wykonanych przez zadanie.

startTime

string (date-time)

Czas rozpoczęcia przedziału czasowego objęty statystykami.

url

string (uri)

URL statystyk.

userCPUTime

string (duration)

Całkowity czas CPU w trybie użytkownika (zsumowany przez wszystkie rdzenie i wszystkie węzły obliczeniowe) zużywany przez zadanie.

waitTime

string (duration)

Całkowity czas oczekiwania na zadanie. Czas oczekiwania na zadanie definiuje się jako upływ między utworzeniem zadania a rozpoczęciem jego wykonania. (Jeśli zadanie zostanie powtórzone z powodu niepowodzeń, czas oczekiwania to czas do ostatniego wykonania zadania.)

wallClockTime

string (duration)

Całkowity czas zegara ściennego podczas zadania. Czas zegara ściennego to czas upływu od momentu rozpoczęcia działania Zadania na węźle obliczeniowym do jego zakończenia (lub do ostatniej aktualizacji statystyk, jeśli Zadanie nie zostało jeszcze ukończone do tego czasu). Jeśli zadanie było powtarzane, obejmuje to czas zegara ściennego wszystkich powtórzeń zadania.

writeIOGiB

number (float)

Łączna liczba gibibajtów zapisanych na dysku przez Task.

writeIOps

string (int64)

Całkowita liczba operacji zapisu na dysku wykonanych przez zadanie.

ContainerHostBatchBindMountEntry

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

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

Wartość Opis
Shared

Ścieżka zadania obejmującego wiele wystąpień w celu udostępnienia plików.

Startup

Ścieżka zadania podrzędnego uruchamiania.

VfsMounts

Ścieżka zawiera wszystkie wirtualne systemy plików są instalowane w tym węźle.

Task

Ścieżka zadania.

JobPrep

Ścieżka zadania przygotowania zadania.

Applications

Ścieżka aplikacji.

ContainerRegistryReference

Prywatny rejestr kontenerów.

Nazwa Typ Opis
identityReference

BatchNodeIdentityReference

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.

password

string (password)

Hasło do logowania się na serwerze rejestru.

registryServer

string (uri)

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

Enums ContainerWorkingDirectory

Wartość Opis
taskWorkingDirectory

Użyj standardowego katalogu roboczygo Batch Service Task Task (Task Service Working Folder), który będzie zawierał pliki zasobów zadań wypełnione przez Batch.

containerImageDefault

Użyj katalogu roboczego zdefiniowanego w kontenerze Image. Należy pamiętać, że ten katalog nie będzie zawierał plików zasobów pobranych przez Batch.

DependencyAction

DependencyAction enumy

Wartość Opis
satisfy

Spełnij zadania oczekujące na to zadanie; Gdy wszystkie zależności zostaną spełnione, zadanie zostanie zaplanowane do uruchomienia.

block

Blokuje zadania oczekujące na to zadanie, uniemożliwiając ich zaplanowanie.

ElevationLevel

Enumy ElevationLevel

Wartość Opis
nonadmin

Użytkownik jest użytkownikiem standardowym bez podwyższonego poziomu dostępu.

admin

Użytkownik jest użytkownikiem z podwyższonym poziomem dostępu i działa z pełnymi uprawnieniami administratora.

EnvironmentSetting

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

Nazwa Typ Opis
name

string

Nazwa zmiennej środowiskowej.

value

string

Wartość zmiennej środowiskowej.

ExitCodeMapping

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

Nazwa Typ Opis
code

integer (int32)

Kod wyjścia z procesu.

exitOptions

ExitOptions

Jak usługa wsadowa powinna reagować, jeśli zadanie zakończy się tym kodem wyjścia.

ExitCodeRangeMapping

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 (int32)

Ostatni kod wyjścia w zasięgu.

exitOptions

ExitOptions

Jak powinna zareagować usługa wsadowa, jeśli zadanie zakończy się kodem wyjścia w zakresie od początku do końca (włącznie).

start

integer (int32)

Pierwszy kod wyjścia w zasięgu.

ExitConditions

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

Nazwa Typ Opis
default

ExitOptions

Jak powinna zareagować usługa wsadowa, jeśli zadanie nie ulegnie awarii z warunkiem wyjścia nieobjętym żadną z innych właściwości. Ta wartość jest używana, jeśli zadanie kończy się z dowolnym niezerowym kodem wyjścia niewymienionym w kolekcji exitCodes lub exitCodeRanges, z błędem wstępnego przetwarzania, jeśli nie ma właściwości preProcessingError, lub z błędem przesyłania pliku, jeśli nie ma właściwości fileUploadError. Jeśli chcesz zachować niedomyślne zachowanie przy kodzie wyjścia 0, musisz je wyraźnie wypisać, korzystając z kolekcji exitCodes lub exitCodeRanges.

exitCodeRanges

ExitCodeRangeMapping[]

Lista zakresów kodów wyjścia zadań oraz sposób, w jaki usługa wsadowa powinna na nie reagować.

exitCodes

ExitCodeMapping[]

Lista indywidualnych kodów wyjścia Task oraz sposób, w jaki usługa Batch powinna na nie reagować.

fileUploadError

ExitOptions

Jak usługa wsadowa powinna zareagować, jeśli wystąpi błąd przesyłania plików. Jeśli zadanie zakończyło się z kodem wyjścia określonym za pomocą exitCodes lub exitCodeRanges, a następnie napotkało błąd przesyłania plików, to działanie określone w kodzie wyjściowym ma pierwszeństwo.

preProcessingError

ExitOptions

Jak usługa wsadowa powinna zareagować, jeśli zadanie nie zostanie uruchomione z powodu błędu.

ExitOptions

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ę wsadową na zadaniach zależnych od tego zadania. Możliwe wartości to "satysfakcjonujące" (pozwalające na postęp zadań zależnych) oraz "blok" (zadania zależne nadal czekają). Batch nie obsługuje jeszcze anulowania zadań zależnych.

jobAction

BatchJobActionKind

Akcja do wykonania na zadaniu zawierającym zadanie, jeśli zadanie zakończy się z podanym warunkiem wyjścia, a właściwość onTaskFailed to 'wykonawykonajWyjścieOptionsOperacjaZadanie'. Domyślnie nie ma kodu wyjścia 0 i kończy się dla wszystkich innych warunków wyjścia. Jeśli właściwość onTaskFailed zadania jest nieaktywna, to określenie tej właściwości zwraca błąd, a żądanie dodania zadania kończy się niepowodzeniem błędu wartości właściwości; jeśli wywołujesz bezpośrednio REST API, kod statusu HTTP to 400 (Bad Request).

MultiInstanceSettings

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.

Nazwa Typ Opis
commonResourceFiles

ResourceFile[]

Lista plików, które usługa Batch pobiera przed uruchomieniem linii poleceń koordynacyjnych. Różnica między zwykłymi plikami zasobów a plikami zasobów zadań polega na tym, że pliki zasobów są pobierane dla wszystkich podzadań, w tym głównego, podczas gdy pliki zasobów zadań pobierane są tylko dla głównego. Należy również zauważyć, że te pliki zasobów nie są pobierane do katalogu roboczego Zadań, lecz do katalogu głównego Zadań (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

Linia poleceń uruchamia się na wszystkich węzłach obliczeniowych, aby umożliwić koordynację, gdy główny wykonuje główne polecenie zadania. Typowa linia poleceń koordynacyjnych uruchamia usługę w tle i weryfikuje, że usługa jest gotowa do przetwarzania wiadomości między węzłami.

numberOfInstances

integer (int32)

Liczba węzłów obliczeniowych wymaganych przez zadanie. Jeśli zostanie pominięty, domyślnie to 1.

NameValuePair

Reprezentuje parę nazwa-wartość.

Nazwa Typ Opis
name

string

Nazwa w parze imię-wartość.

value

string

Wartość w parze imię-wartość.

OutputFile

Podczas każdego przekazywania plików usługa Batch zapisuje dwa pliki dziennika w węźle obliczeniowym "fileuploadout.txt" i "fileuploaderr.txt". Te pliki dziennika służą do uzyskania dodatkowych informacji na temat konkretnego błędu.

Nazwa Typ Opis
destination

OutputFileDestination

Cel dla pliku wyjściowego.

filePattern

string

Wzór wskazujący, które pliki (pliki) przesłać. Wspierane są zarówno ścieżki względne, jak i absolutne. Ścieżki względne są względne względem katalogu roboczego Task. Obsługiwane są następujące karty dzikie: * pasuje do 0 lub więcej znaków (na przykład wzór abc* pasowałby do abc lub abcdef), ** pasuje do dowolnego katalogu, ? Pasuje do dowolnej pojedynczej postaci, [ABC] do jednej z nawiasów, a [A-C] do jednej postaci w zakresie. Nawiasy mogą zawierać negację dopasowaną do dowolnego znaku nieokreślonego (na przykład [!abc] pasuje do dowolnego znaku oprócz a, b lub c). Jeśli nazwa pliku zaczyna się od "." jest domyślnie ignorowana, ale może zostać dopasowana przez wyraźne określenie (na przykład .gif nie dopasuje .a.gif, ale ..gif tak). Prosty przykład: ***.txt pasuje do każdego pliku, który nie zaczyna się od '.' i kończy się na .txt w katalogu roboczym Task lub dowolnym podkatalogu. Jeśli nazwa pliku zawiera znak dziki, można ją objąć nawiasami (na przykład abc[] pasuje do pliku o nazwie abc). Należy zauważyć, że zarówno \, jak i / są traktowane jako separatory katalogów na Windows, ale na Linuksie jest tylko / ((Linux). Zmienne środowiskowe (%var% na Windows lub $var na Linuksie) są rozszerzane przed zastosowaniem wzorca.

uploadOptions

OutputFileUploadConfig

Dodatkowe opcje operacji przesyłania, w tym w jakich warunkach wykonać przesyłanie.

OutputFileBlobContainerDestination

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

Nazwa Typ Opis
containerUrl

string (uri)

URL kontenera w Azure Blob Storage, do którego należy przesłać plik(y). Jeśli nie używa się tożsamości zarządzanej, adres URL musi zawierać Wspólny Podpis Dostępu (SAS) przyznający uprawnienia do zapisu do kontenera.

identityReference

BatchNodeIdentityReference

Odniesienie do tożsamości przypisanej przez użytkownika do dostępu do Azure Blob Storage określone przez containerUrl. Tożsamość musi mieć dostęp do zapisu do kontenera Azure Blob Storage.

path

string

Docelowy blob lub wirtualny katalog w kontenerze Azure Storage. Jeśli filePattern odnosi się do konkretnego pliku (czyli nie zawiera dzikich znaków), to path to nazwa blobu, do którego należy przesłać ten plik. Jeśli plikWzorzec zawiera jeden lub więcej znaków dzikich (a zatem może pasować do wielu plików), to ścieżka to nazwa wirtualnego katalogu blobów (przypisanego do każdej nazwy blob), do którego należy przesłać plik(y). Jeśli zostanie pominięty, plik(y) są przesyłane do korzenia kontenera z nazwą blob-a odpowiadającą ich nazwie.

uploadHeaders

OutputFileUploadHeader[]

Lista par nazwy-wartość dla nagłówków przeznaczonych do przesyłania plików wyjściowych. Te nagłówki zostaną określone podczas przesyłania plików do Azure Storage. Oficjalny dokument dotyczący dozwolonych nagłówków przy przesyłaniu blobów: https://learn.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types.

OutputFileDestination

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

Nazwa Typ Opis
container

OutputFileBlobContainerDestination

Lokalizacja w Azure Blob storage, do której przesyłane są pliki.

OutputFileUploadCondition

OutputFileUploadCondition enums

Wartość Opis
tasksuccess

Plik(y) przesyłaj dopiero po zakończeniu procesu zadania z kodem wyjścia 0.

taskfailure

Plik(y) przesyłaj dopiero po zakończeniu procesu zadania z niezerowym kodem wyjścia.

taskcompletion

Przesyłaj plik(y) po zakończeniu procesu Zadania, niezależnie od kodu wyjścia.

OutputFileUploadConfig

Opcje operacji przekazywania pliku wyjściowego, w tym w jakich warunkach należy wykonać przekazywanie.

Nazwa Typ Opis
uploadCondition

OutputFileUploadCondition

Warunki, w jakich plik wyjściowy Zadania lub zestaw plików powinien zostać przesłany. Domyślnie jest wykonywanie zadań.

OutputFileUploadHeader

Para nazwa-wartość nagłówka HTTP

Nazwa Typ Opis
name

string

Nazwa nagłówka nierozróżniająca wielkości wielkości liter, której należy użyć podczas przesyłania plików wyjściowych.

value

string

Wartość nagłówka używanego podczas przesyłania plików wyjściowych.

ResourceFile

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

Nazwa Typ Opis
autoStorageContainerName

string

Nazwa kontenera magazynowego w konto automatycznego przechowywania. 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ść dotyczy tylko plików pobieranych do Linux Compute Nodes. Zostanie zignorowany, jeśli jest określony dla pliku zasobów, który zostanie pobrany do węzła obliczeń Windows. Jeśli ta właściwość nie jest określona dla węzła obliczeniowego Linuksa, do pliku przypisywana jest domyślna wartość 0770.

filePath

string

Lokalizacja na węźle obliczeniowym, do której należy pobrać plik(y), 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 wyjść z katalogu roboczego zadania (na przykład używając '..').

httpUrl

string (uri)

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

BatchNodeIdentityReference

Odniesienie do tożsamości przypisanej przez użytkownika do dostępu do Azure Blob Storage określone przez storageContainerUrl lub httpUrl.

storageContainerUrl

string (uri)

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.

UserIdentity

Definicja tożsamości użytkownika, w ramach której jest uruchamiane zadanie. Określ właściwość userName lub autoUser, ale nie obie.

Nazwa Typ Opis
autoUser

AutoUserSpecification

Użytkownik automatyczny, pod którym uruchamiane jest 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, pod którą wykonywane jest zadanie. Właściwości userName i autoUser wzajemnie się wykluczają; należy określić jeden, ale nie oba te elementy.