Task - Add Collection

Service:

Batch Service

API Version:

2023-11-01.18.0

Dodaje kolekcję zadań do określonego zadania.
Należy pamiętać, że każde zadanie musi mieć unikatowy identyfikator. Usługa Batch może nie zwracać wyników dla każdego zadania w tej samej kolejności, w których zadania zostały przesłane w tym żądaniu. Jeśli przekroczono limit czasu serwera lub połączenie zostało zamknięte podczas żądania, żądanie mogło zostać częściowo lub w pełni przetworzone lub nie w ogóle. W takich przypadkach użytkownik powinien ponownie wysłać żądanie. Należy pamiętać, że użytkownik musi poprawnie obsługiwać błędy podczas ponownego wystawiania żądania. Na przykład podczas ponawiania próby należy użyć tych samych identyfikatorów zadań, aby jeśli poprzednia operacja zakończyła się pomyślnie, ponawianie próby nie spowoduje nieoczekiwanego utworzenia dodatkowych zadań. Jeśli odpowiedź zawiera jakiekolwiek zadania, których nie można dodać, klient może ponowić próbę żądania. W ponawianiu próby najbardziej wydajne jest ponowne przesłanie tylko zadań, które nie powiodły się do dodania, oraz pominięcie zadań, które zostały pomyślnie dodane podczas pierwszej próby. Maksymalny okres istnienia zadania od dodania do ukończenia wynosi 180 dni. Jeśli zadanie nie zostało ukończone w ciągu 180 dni od dodania, zostanie zakończone przez usługę Batch i pozostawione w jakimkolwiek stanie było w tym czasie.

POST {batchUrl}/jobs/{jobId}/addtaskcollection?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/jobs/{jobId}/addtaskcollection?timeout={timeout}&api-version=2023-11-01.18.0

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
batchUrl	path	True	string	Podstawowy adres URL wszystkich żądań obsługi Azure Batch.
jobId	path	True	string	Identyfikator zadania, do którego ma zostać dodana kolekcja zadań.
api-version	query	True	string	Wersja interfejsu API klienta.
timeout	query		integer int32	Maksymalny czas, który serwer może poświęcić na przetwarzanie żądania w sekundach. Wartość domyślna to 30 sekund.

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, takich jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Określa, czy serwer powinien zwrócić wartość client-request-id 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.

Treść żądania

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

Nazwa	Wymagane	Typ	Opis
value	True	TaskAddParameter[]	Kolekcja zadań do dodania. Maksymalna liczba zadań to 100. Łączny serializowany rozmiar tej kolekcji musi być mniejszy niż 1 MB. Jeśli jest on większy niż 1 MB (na przykład jeśli każde zadanie ma 100 plików zasobów lub zmiennych środowiskowych), żądanie zakończy się niepowodzeniem z kodem "RequestBodyTooLarge" i powinno zostać ponowione z mniejszą liczbą zadań.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	TaskAddCollectionResult	Odpowiedź zawierająca wyniki operacji dodawania kolekcji zadań. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Nieoczekiwany błąd

Zabezpieczenia

azure_auth

przepływ kodu uwierzytelniania OAuth 2.0 Microsoft Entra

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Authorization

Type: apiKey
In: header

Przykłady

Add a basic collection of tasks

Add a complex collection of tasks

Add a basic collection of tasks

Sample Request

HTTP

POST account.region.batch.azure.com/jobs/jobId/addtaskcollection?api-version=2023-11-01.18.0



{
  "value": [
    {
      "id": "simple1",
      "commandLine": "cmd /c dir /s"
    },
    {
      "id": "simple2",
      "commandLine": "cmd /c dir /s"
    }
  ]
}

Sample Response

Status code:

200

{
  "value": [
    {
      "status": "success",
      "taskId": "simple1",
      "eTag": "0x8D3D623CD661246",
      "lastModified": "2016-09-06T07:02:44.7589958Z",
      "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple1"
    },
    {
      "status": "success",
      "taskId": "simple2",
      "eTag": "0x8D3D623CD7072CC",
      "lastModified": "2016-09-06T07:02:44.8270028Z",
      "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple2"
    }
  ]
}

Add a complex collection of tasks

Sample Request

HTTP

POST account.region.batch.azure.com/jobs/jobId/addtaskcollection?api-version=2023-11-01.18.0



{
  "value": [
    {
      "id": "complex1",
      "commandLine": "cmd /c dir /s",
      "resourceFiles": [
        {
          "autoStorageContainerName": "containerName",
          "filePath": "data"
        }
      ],
      "environmentSettings": [
        {
          "name": "env1",
          "value": "value1"
        },
        {
          "name": "env2",
          "value": "value2"
        }
      ],
      "affinityInfo": {
        "affinityId": "affinityId"
      },
      "constraints": {
        "maxWallClockTime": "P1D",
        "retentionTime": "P2D",
        "maxTaskRetryCount": 5
      },
      "requiredSlots": 2,
      "multiInstanceSettings": {
        "numberOfInstances": 3,
        "coordinationCommandLine": "cmd /c echo coordinating",
        "commonResourceFiles": [
          {
            "httpUrl": "https://common.blob.core.windows.net/",
            "filePath": "common.exe"
          }
        ]
      }
    },
    {
      "id": "simple3",
      "commandLine": "cmd /c dir /s"
    }
  ]
}

Sample Response

Status code:

200

{
  "value": [
    {
      "taskId": "simple3",
      "status": "success",
      "eTag": "0x8D3D623CE295629",
      "lastModified": "2016-09-06T07:02:46.0386857Z",
      "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple3"
    },
    {
      "taskId": "complex1",
      "status": "success",
      "eTag": "0x8D3D623CE29A412",
      "lastModified": "2016-09-06T07:02:46.0406802Z",
      "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/complex1"
    }
  ]
}

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żyć 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 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.
ContainerRegistry	Prywatny rejestr kontenerów.
ContainerWorkingDirectory	Lokalizacja katalogu roboczego zadania kontenera.
DependencyAction	Akcja wykonywana przez usługę Batch na zadaniach zależnych od tego zadania.
ElevationLevel	Poziom podniesienia uprawnień użytkownika.
EnvironmentSetting	Zmienna środowiskowa, która ma zostać ustawiona w procesie zadania.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.
ExitCodeMapping	Jak usługa Batch powinna odpowiedzieć, jeśli zadanie zakończy działanie z określonym kodem zakończenia.
ExitCodeRangeMapping	Zakres kodów zakończenia i sposób, 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ń.
OutputFile	Specyfikacja przekazywania plików z węzła obliczeniowego 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.
TaskAddCollectionParameter	Kolekcja zadań Azure Batch do dodania.
TaskAddCollectionResult	Wynik dodawania kolekcji zadań do zadania.
TaskAddParameter	Zadanie Azure Batch do dodania.
TaskAddResult	Wynik pojedynczego zadania dodanego w ramach operacji dodawania kolekcji zadań.
TaskAddStatus	Stan żądania dodania zadania.
TaskConstraints	Ograniczenia wykonywania, które mają być stosowane do zadania.
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.
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.
UserIdentity	Definicja tożsamości użytkownika, w ramach której jest uruchamiane zadanie.

AccessScope

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

Nazwa	Typ	Opis
job	string	Udziela dostępu do wykonywania wszystkich operacji na zadaniu zawierającym zadanie.

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.

Nazwa	Typ	Opis
affinityId	string	Nieprzezroczysty 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

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/{resourceGroups}/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 zostanie to pominięte w puli, a dla tej aplikacji nie zostanie określona żadna domyślna wersja, żądanie zakoń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

Ustawienia tokenu uwierzytelniania, którego zadanie może użyć 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ą właściwości dostępu jest "zadanie", które przyznaje dostęp do wszystkich operacji związanych z zadaniem zawierającym zadanie.

AutoUserScope

Zakres użytkownika automatycznego

Nazwa	Typ	Opis
pool	string	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	string	Określa, że usługa powinna utworzyć nowego użytkownika dla zadania.

AutoUserSpecification

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 dla zwykłych zadań, ale powinny być dostępne przez startzadania.

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

Element dodatkowych informacji zawartych w odpowiedzi na błąd 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.

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.

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

ContainerRegistry

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

Lokalizacja katalogu roboczego zadania kontenera.

Nazwa	Typ	Opis
containerImageDefault	string	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	string	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

Akcja wykonywana przez usługę Batch na zadaniach zależnych od tego zadania.

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

ElevationLevel

Poziom podniesienia uprawnień użytkownika.

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

EnvironmentSetting

Zmienna środowiskowa, która ma zostać ustawiona w procesie zadania.

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

ErrorMessage

Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.

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

ExitCodeMapping

Jak usługa Batch powinna odpowiedzieć, 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 za pomocą tego kodu zakończenia.

ExitCodeRangeMapping

Zakres kodów zakończenia i sposób, 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 odpowiadać, jeśli zadanie zakończy działanie z kodem zakończenia w zakresie od początku do końca (włącznie).
start	integer	Pierwszy kod zakończenia w zakresie.

ExitConditions

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 zadanie kończy działanie z kodem zakończenia bezzerowym, 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 reagowania na nie przez usługę Batch.
fileUploadError	ExitOptions	Jak usługa Batch powinna reagować 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 uruchomienie zadania nie powiedzie się 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ę Batch na zadaniach zależnych od tego zadania. Możliwe wartości to "spełnione" (zezwalanie na postęp zadań zależnych) i "blokuj" (zadania zależne nadal czekają). 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 to brak dla kodu zakończenia 0 i zakończenie dla wszystkich innych warunków zakończenia. Jeśli właściwość onTaskFailed zadania ma wartość noaction, określenie tej właściwości powoduje zwrócenie błędu, 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

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 do użycia podczas przekazywania plików wyjściowych

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".

Nazwa	Typ	Opis
disable	string	Wyłącz zadanie. Jest to odpowiednik wywoływania interfejsu API wyłącz zadania z wartością disableTasks ponownego kolejkowania.
none	string	Nie podejmij żadnych działań.
terminate	string	Zakończ zadanie. Parametr terminateReason w elemecie ExecutionInfo zadania jest ustawiony na wartość "TaskFailed".

MultiInstanceSettings

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

Nazwa	Typ	Opis
commonResourceFiles	ResourceFile[]	Lista plików, które usługa Batch pobierze przed uruchomieniem wiersza polecenia koordynacji. Różnica między typowymi plikami zasobów i plikami zasobów zadania polega na tym, że typowe pliki zasobów są pobierane dla wszystkich podzadań, w tym podstawowego, podczas gdy 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 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 we wszystkich węzłach obliczeniowych, aby umożliwić im koordynowanie, gdy podstawowy uruchamia główne polecenie zadania. 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.

OutputFile

Specyfikacja przekazywania plików z węzła obliczeniowego 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ć dopasowywana przez jawne określenie jej (na przykład .gif nie będzie zgodna z .a.gif, ale ..gif). Prosty przykład: ***.txt pasuje do dowolnego pliku, który nie rozpoczyna się w ciągu ""., a kończy się .txt w katalogu roboczym zadania lub dowolnym podkatalogu. Jeśli nazwa pliku zawiera symbol wieloznaczny, można 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 warunki do wykonania przekazywania.

OutputFileBlobContainerDestination

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

Nazwa	Typ	Opis
containerUrl	string	Adres URL kontenera w 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 Azure Blob Storage określonych przez containerUrl Tożsamość musi mieć dostęp do zapisu do kontenera Azure Blob Storage
path	string	Docelowy obiekt blob lub katalog wirtualny w kontenerze usługi Azure Storage. Jeśli parametr filePattern odwołuje się do określonego pliku (tj. nie zawiera symboli wieloznacznych), ścieżka to nazwa obiektu blob, do którego ma być przekazywany ten plik. Jeśli plikPattern zawiera co najmniej jeden symbol wieloznaczny (i w związku z tym może być zgodny 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. W przypadku pominięcia 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 w przekazywaniu 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://docs.microsoft.com/en-us/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 usłudze Azure Blob Storage, do której są przekazywane pliki.

OutputFileUploadCondition

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

Nazwa	Typ	Opis
taskcompletion	string	Przekaż pliki po zakończeniu procesu zadania, niezależnie od kodu zakończenia.
taskfailure	string	Przekaż pliki dopiero po zakończeniu procesu zadania z kodem zakończenia bezzerowym.
tasksuccess	string	Przekaż pliki dopiero po zakończeniu procesu zadania z kodem zakończenia 0.

OutputFileUploadOptions

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

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

Nazwa	Typ	Opis
autoStorageContainerName	string	Nazwa kontenera magazynu na koncie magazynu automatycznego. 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 parametr filePath jest używany jako katalog, każda struktura katalogów skojarzona już 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 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 w celu umożliwienia dostępu publicznego.
identityReference	ComputeNodeIdentityReference	Odwołanie do tożsamości przypisanej przez użytkownika w celu uzyskania dostępu do Azure Blob Storage określonej przez 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 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 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 w celu umożliwienia dostępu publicznego.

TaskAddCollectionParameter

Kolekcja zadań Azure Batch do dodania.

Nazwa	Typ	Opis
value	TaskAddParameter[]	Kolekcja zadań do dodania. Maksymalna liczba zadań to 100. Łączny serializowany rozmiar tej kolekcji musi być mniejszy niż 1 MB. Jeśli jest on większy niż 1 MB (na przykład jeśli każde zadanie ma 100 plików zasobów lub zmiennych środowiskowych), żądanie zakończy się niepowodzeniem z kodem "RequestBodyTooLarge" i powinno zostać ponowione z mniejszą liczbą zadań.

TaskAddCollectionResult

Wynik dodawania kolekcji zadań do zadania.

Nazwa	Typ	Opis
value	TaskAddResult[]	Wyniki operacji dodawania kolekcji zadań.

TaskAddParameter

Zadanie Azure Batch do dodania.

Nazwa	Typ	Opis
affinityInfo	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 nowe zadanie.
applicationPackageReferences	ApplicationPackageReference[]	Lista pakietów, które usługa Batch zostanie wdrożona w węźle obliczeniowym przed uruchomieniem wiersza polecenia. Pakiety aplikacji są pobierane i wdrażane w udostępnionym katalogu, a nie w katalogu roboczym Zadania. W związku z tym jeśli pakiet, do których odwołuje się odwołanie, znajduje się już w węźle i jest aktualny, nie jest on pobierany ponownie; jest używana 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żyć do wykonywania operacji usługi Batch. Jeśli ta właściwość jest ustawiona, usługa Batch udostępnia zadaniu token uwierzytelniania, który może służyć do uwierzytelniania operacji usługi Batch 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ć 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ń podrzędnych 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 rozszerzanie zmiennych środowiskowych. Jeśli chcesz korzystać 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ędnej względem katalogu roboczego zadania) lub użyć zmiennej środowiskowej udostępnionej w usłudze Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
constraints	TaskConstraints	Ograniczenia wykonywania, które mają zastosowanie do tego zadania. Jeśli nie określisz ograniczeń, parametr maxTaskRetryCount jest parametrem maxTaskRetryCount określonym dla zadania, parametr maxWallClockTime jest nieskończony, a parametr retentionTime wynosi 7 dni.
containerSettings	TaskContainerSettings	Ustawienia kontenera, w którym jest uruchamiane zadanie. Jeśli pula, która będzie uruchamiać to zadanie, ma ustawioną wartość containerConfiguration, należy to również ustawić. Jeśli pula, która uruchomi to zadanie, nie ma ustawionego konteneraKonfiguracja, nie można go ustawić. Po określeniu tego ustawienia wszystkie katalogi cyklicznie poniżej AZ_BATCH_NODE_ROOT_DIR (katalog główny katalogów Azure Batch w węźle) są mapowane do kontenera, wszystkie zmienne środowiskowe zadania są mapowane do kontenera, a wiersz polecenia zadania jest wykonywany w kontenerze. Pliki utworzone w kontenerze poza AZ_BATCH_NODE_ROOT_DIR mogą nie zostać odzwierciedlone na dysku hosta, co oznacza, że interfejsy API plików usługi Batch nie będą mogły uzyskać dostępu do tych plików.
dependsOn	TaskDependencies	Zadania, od których zależy to zadanie. To zadanie nie zostanie zaplanowane do momentu pomyślnego ukończenia wszystkich zadań, od których zależy. Jeśli którykolwiek z tych zadań zakończy się niepowodzeniem i wyczerpuje liczbę ponownych prób, to zadanie nigdy nie zostanie zaplanowane. Jeśli zadanie nie ma parametru usesTaskDependencies ustawionego na wartość true, a ten element jest obecny, żądanie kończy się niepowodzeniem z kodem błędu TaskDependenciesNotSpecifiedOnJob.
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.
environmentSettings	EnvironmentSetting[]	Lista ustawień zmiennych środowiskowych dla 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. Identyfikator zachowuje wielkość liter i nie uwzględnia wielkości liter (oznacza to, że w zadaniu nie ma dwóch identyfikatorów, które różnią się tylko wielkością liter).
multiInstanceSettings	MultiInstanceSettings	Obiekt wskazujący, że zadanie jest zadaniem o wielu wystąpieniach 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 innego niż zero), całe zadanie obejmujące wiele wystąpień kończy się niepowodzeniem. Zadanie obejmujące wiele wystąpień jest następnie przerywane i ponawiane do limitu ponawiania prób.
outputFiles	OutputFile[]	Lista plików, które usługa Batch przekaże z węzła obliczeniowego po uruchomieniu wiersza polecenia. W przypadku zadań z wieloma wystąpieniami pliki zostaną przekazane tylko z węzła obliczeniowego, na którym jest wykonywane zadanie podstawowe.
requiredSlots	integer	Liczba miejsc planowania wymaganych do uruchomienia zadania. Wartość domyślna to 1. Zadanie można zaplanować tylko w węźle obliczeniowym, jeśli węzeł ma wystarczającą liczbę wolnych miejsc planowania. W przypadku zadań z wieloma wystąpieniami musi to być wartość 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 ResourceFiles. Można to osiągnąć przy użyciu plików .zip, pakietów aplikacji lub kontenerów platformy Docker.
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.

TaskAddResult

Wynik pojedynczego zadania dodanego w ramach operacji dodawania kolekcji zadań.

Nazwa	Typ	Opis
eTag	string	Element ETag zadania, jeśli zadanie zostało pomyślnie dodane. Za pomocą tego polecenia można wykryć, czy zadanie uległo zmianie między żądaniami. W szczególności można przekazać element ETag z żądaniem zadania aktualizacji, aby określić, że zmiany powinny obowiązywać tylko wtedy, gdy nikt inny nie zmodyfikował zadania w międzyczasie.
error	BatchError	Napotkano błąd podczas próby dodania zadania.
lastModified	string	Czas ostatniej modyfikacji zadania.
location	string	Adres URL zadania, jeśli zadanie zostało pomyślnie dodane.
status	TaskAddStatus	Stan żądania dodania zadania.
taskId	string	Identyfikator zadania, dla którego jest to wynik.

TaskAddStatus

Stan żądania dodania zadania.

Nazwa	Typ	Opis
clienterror	string	Nie można dodać zadania z powodu błędu klienta i nie powinno być ponawiane bez modyfikowania żądania zgodnie z potrzebami.
servererror	string	Nie można dodać zadania z powodu błędu serwera i można je ponowić bez modyfikacji.
success	string	Zadanie zostało pomyślnie dodane.

TaskConstraints

Ograniczenia wykonywania, które mają być stosowane 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 niezerowy. Należy pamiętać, że ta wartość określa w szczególności liczbę ponownych prób dla pliku wykonywalnego zadania z powodu kodu zakończenia niezerowego. 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 maksymalnie 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 (brak ponownych prób).
maxWallClockTime	string	Maksymalny czas, który upłynął do uruchomienia zadania, mierzony od momentu uruchomienia zadania. Jeśli zadanie nie zostanie ukończone w limicie czasu, usługa Batch ją zakończy. 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 czasu zakończenia wykonywania. Po tym czasie usługa Batch może usunąć katalog Zadań 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.

TaskContainerSettings

Ustawienia kontenera dla zadania.

Nazwa	Typ	Opis
containerRunOptions	string	Dodatkowe opcje polecenia tworzenia kontenera. Te dodatkowe opcje są dostarczane jako argumenty polecenia "docker create" oprócz tych kontrolowanych przez usługę Batch.
imageName	string	Obraz do użycia do utworzenia kontenera, w którym zostanie uruchomione zadanie. Jest to pełne odwołanie do obrazu, które zostanie określone jako "ściąganie platformy Docker". Jeśli tag nie jest podany jako część nazwy obrazu, tag ":latest" jest używany jako domyślny.
registry	ContainerRegistry	Rejestr prywatny 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

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ń.

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.

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

UserIdentity

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

Nazwa	Typ	Opis
autoUser	AutoUserSpecification	Automatycznie użytkownik, 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.