Pool - Update Properties

Usługa:

Batch Service

Wersja interfejsu API:

2024-07-01.20.0

Aktualizuje właściwości określonej puli.
Spowoduje to całkowite zastąpienie wszystkich aktualizowalnych właściwości puli. Jeśli na przykład pula ma skojarzona wartość StartTask i jeśli parametr StartTask nie zostanie określony z tym żądaniem, usługa Batch usunie istniejącą wartość StartTask.

POST {batchUrl}/pools/{poolId}/updateproperties?api-version=2024-07-01.20.0

Z parametrami opcjonalnymi:

POST {batchUrl}/pools/{poolId}/updateproperties?timeout={timeout}&api-version=2024-07-01.20.0

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
batchUrl	path	True	string	Podstawowy adres URL dla wszystkich żądań usługi Azure Batch.
poolId	path	True	string	Identyfikator puli do zaktualizowania.
api-version	query	True	string	Wersja interfejsu API klienta.
timeout	query		integer int32	Maksymalny czas przetwarzania żądania przez serwer w sekundach. Wartość domyślna to 30 sekund. Jeśli wartość jest większa niż 30, zostanie użyta wartość domyślna.

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
client-request-id		string uuid	Tożsamość żądania wygenerowanego przez obiekt wywołujący w postaci identyfikatora GUID bez dekoracji, takiej jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Czy serwer powinien zwrócić identyfikator żądania klienta w odpowiedzi.
ocp-date		string date-time-rfc1123	Czas wystawienia żądania. Biblioteki klienckie zazwyczaj ustawiają tę wartość na bieżący czas zegara systemowego; ustaw go jawnie, jeśli bezpośrednio wywołujesz interfejs API REST.

Treść żądania

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

Nazwa	Wymagane	Typ	Opis
applicationPackageReferences	True	ApplicationPackageReference[]	Lista pakietów aplikacji do zainstalowania w każdym węźle obliczeniowym w puli. Lista zastępuje wszystkie istniejące odwołania do pakietu aplikacji w puli. Zmiany odwołań do pakietu aplikacji mają wpływ na wszystkie nowe węzły obliczeniowe przyłączone do puli, ale nie mają wpływu na węzły obliczeniowe, które znajdują się już w puli, dopóki nie zostaną ponownie uruchomione lub zrewidowane. W danej puli istnieje maksymalnie 10 odwołań do pakietu aplikacji. Jeśli pominięto lub jeśli określisz pustą kolekcję, wszystkie istniejące odwołania do pakietów aplikacji zostaną usunięte z puli. W danej puli można określić maksymalnie 10 odwołań.
certificateReferences	True	CertificateReference[]	Lista certyfikatów do zainstalowania w każdym węźle obliczeniowym w puli. Ta lista zastępuje wszystkie istniejące odwołania do certyfikatów skonfigurowane w puli. Jeśli określisz pustą kolekcję, wszystkie istniejące odwołania do certyfikatów zostaną usunięte z puli. W przypadku węzłów systemu Windows usługa Batch instaluje certyfikaty w określonym magazynie certyfikatów i lokalizacji. W przypadku węzłów obliczeniowych systemu Linux certyfikaty są przechowywane w katalogu roboczym Zadanie, a zmienna środowiskowa AZ_BATCH_CERTIFICATES_DIR jest dostarczana do zadania, aby wykonać zapytanie o tę lokalizację. W przypadku certyfikatów z widocznością "remoteUser" katalog "certs" jest tworzony w katalogu głównym użytkownika (np. /home/{user-name}/certs) i certyfikaty są umieszczane w tym katalogu. Ostrzeżenie: Ta właściwość jest przestarzała i zostanie usunięta po lutym 2024 r. Zamiast tego użyj rozszerzenia Azure KeyVault.
metadata	True	MetadataItem[]	Lista par name-value skojarzonych z pulą jako metadanych. Ta lista zastępuje wszystkie istniejące metadane skonfigurowane w puli. Jeśli pominięto lub jeśli określisz pustą kolekcję, wszystkie istniejące metadane zostaną usunięte z puli.
startTask		StartTask	Zadanie do uruchomienia w każdym węźle obliczeniowym podczas dołączania do puli. Zadanie jest uruchamiane po dodaniu węzła obliczeniowego do puli lub ponownym uruchomieniu węzła obliczeniowego. Jeśli ten element jest obecny, zastępuje wszystkie istniejące elementy StartTask. W przypadku pominięcia wszystkie istniejące elementy StartTask zostaną usunięte z puli.
targetNodeCommunicationMode		NodeCommunicationMode	Żądany tryb komunikacji węzła dla puli. To ustawienie zastępuje wszystkie istniejące ustawienie targetNodeCommunication w puli. W przypadku pominięcia istniejące ustawienie jest domyślne.

Odpowiedzi

Nazwa	Typ	Opis
204 No Content		Żądanie do usługi Batch zakończyło się pomyślnie. Nagłówki client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Błąd usługi Batch.

Zabezpieczenia

azure_auth

Microsoft Entra OAuth 2.0 — przepływ kodu uwierzytelniania

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

Zakresy

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Authorization

Typ: apiKey
W: header

Przykłady

Pool update

Przykładowe żądanie

HTTP

POST account.region.batch.azure.com/pools/poolId/updateproperties?api-version=2024-07-01.20.0



{
  "startTask": {
    "commandLine": "/bin/bash -c 'echo start task'"
  },
  "certificateReferences": [],
  "applicationPackageReferences": [],
  "metadata": []
}

Przykładowa odpowiedź

Kod stanu:

204

Definicje

Nazwa	Opis
ApplicationPackageReference	Odwołanie do pakietu do wdrożenia w węzłach obliczeniowych.
AutoUserScope	Zakres użytkownika automatycznego
AutoUserSpecification	Określa parametry dla użytkownika automatycznego, który uruchamia zadanie w usłudze Batch.
BatchError	Odebrano odpowiedź o błędzie z usługi Azure Batch.
BatchErrorDetail	Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch.
CertificateReference	Odwołanie do certyfikatu do zainstalowania w węzłach obliczeniowych w puli.
CertificateStoreLocation	Lokalizacja magazynu certyfikatów w węźle obliczeniowym, w którym ma zostać zainstalowany certyfikat.
CertificateVisibility	Które konta użytkowników w węźle obliczeniowym powinny mieć dostęp do prywatnych danych certyfikatu.
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.
ContainerHostBatchBindMountEntry	Wpis ścieżki i trybu instalacji, który chcesz zainstalować w kontenerze zadań.
ContainerHostDataPath	Ścieżki, które zostaną zainstalowane w kontenerze zadania kontenera.
ContainerRegistry	Prywatny rejestr kontenerów.
ContainerWorkingDirectory	Lokalizacja katalogu roboczego zadania kontenera.
ElevationLevel	Poziom podniesienia uprawnień użytkownika.
EnvironmentSetting	Zmienna środowiskowa, która ma być ustawiana w procesie zadania.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.
MetadataItem	Para nazwa-wartość skojarzona z zasobem usługi Batch.
NodeCommunicationMode	Określa, jak pula komunikuje się z usługą Batch.
PoolUpdatePropertiesParameter	Zestaw zmian, które mają zostać wprowadzone w puli.
ResourceFile	Jeden plik lub wiele plików do pobrania do węzła obliczeniowego.
StartTask	Zadanie uruchamiane po dołączeniu węzła do puli w usłudze Azure Batch lub ponownym uruchomieniu lub ponownym uruchomieniu węzła obliczeniowego lub ponownym obrazie.
TaskContainerSettings	Ustawienia kontenera dla zadania.
UserIdentity	Definicja tożsamości użytkownika, w ramach której jest uruchamiane zadanie.

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/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	Wersja aplikacji do wdrożenia. W przypadku pominięcia zostanie wdrożona domyślna wersja. Jeśli pominięto tę pulę i nie określono domyślnej wersji dla tej aplikacji, żądanie kończy się niepowodzeniem z kodem błędu InvalidApplicationPackageReferences i kodem stanu HTTP 409. Jeśli zostanie to pominięte w zadaniu, a dla tej aplikacji nie zostanie określona żadna domyślna wersja, zadanie zakończy się niepowodzeniem z powodu błędu przetwarzania wstępnego.

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 przez zwykłe zadania, ale powinny być dostępne przez zadania StartTasks.

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

CertificateReference

Odwołanie do certyfikatu do zainstalowania w węzłach obliczeniowych w puli.

Nazwa	Typ	Opis
storeLocation	CertificateStoreLocation	Lokalizacja magazynu certyfikatów w węźle obliczeniowym, w którym ma zostać zainstalowany certyfikat. Wartość domyślna to currentuser. Ta właściwość ma zastosowanie tylko w przypadku pul skonfigurowanych z węzłami obliczeniowymi systemu Windows. W przypadku węzłów obliczeniowych systemu Linux certyfikaty są przechowywane w katalogu roboczym Zadanie, a zmienna środowiskowa AZ_BATCH_CERTIFICATES_DIR jest dostarczana do zadania, aby wykonać zapytanie o tę lokalizację. W przypadku certyfikatów z widocznością "remoteUser" katalog "certs" jest tworzony w katalogu głównym użytkownika (np. /home/{user-name}/certs) i certyfikaty są umieszczane w tym katalogu.
storeName	string	Nazwa magazynu certyfikatów w węźle obliczeniowym, do którego ma zostać zainstalowany certyfikat. Ta właściwość ma zastosowanie tylko w przypadku pul skonfigurowanych z węzłami obliczeniowymi systemu Windows. Typowe nazwy sklepów to: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, ale można również użyć dowolnej niestandardowej nazwy sklepu. Wartość domyślna to Moja.
thumbprint	string	Odcisk palca certyfikatu.
thumbprintAlgorithm	string	Algorytm, z którym jest skojarzony odcisk palca. Musi to być sha1.
visibility	CertificateVisibility[]	Które konta użytkowników w węźle obliczeniowym powinny mieć dostęp do prywatnych danych certyfikatu. W tej kolekcji można określić więcej niż jedną widoczność. Wartość domyślna to wszystkie konta.

CertificateStoreLocation

Lokalizacja magazynu certyfikatów w węźle obliczeniowym, w którym ma zostać zainstalowany certyfikat.

Nazwa	Typ	Opis
currentuser	string	Certyfikaty należy zainstalować w magazynie certyfikatów CurrentUser.
localmachine	string	Certyfikaty należy zainstalować w magazynie certyfikatów LocalMachine.

CertificateVisibility

Które konta użytkowników w węźle obliczeniowym powinny mieć dostęp do prywatnych danych certyfikatu.

Nazwa	Typ	Opis
remoteuser	string	Certyfikat powinien być widoczny dla kont użytkowników, w ramach których użytkownicy uzyskują zdalny dostęp do węzła obliczeniowego.
starttask	string	Certyfikat powinien być widoczny dla konta użytkownika, w ramach którego jest uruchamiana wartość StartTask. Należy pamiętać, że jeśli zakres autoużytkownika jest pulą zarówno dla zadania startowego, jak i zadania, ten certyfikat będzie również widoczny dla zadania.
task	string	Certyfikat powinien być widoczny dla kont użytkowników, w ramach których są uruchamiane zadania podrzędne.

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.

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.

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

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

ContainerWorkingDirectory

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.

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 być ustawiana w procesie zadania.

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

ErrorMessage

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

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

MetadataItem

Para nazwa-wartość skojarzona z zasobem usługi Batch.

Nazwa	Typ	Opis
name	string	Nazwa elementu metadanych.
value	string	Wartość elementu metadanych.

NodeCommunicationMode

Określa, jak pula komunikuje się z usługą Batch.

Nazwa	Typ	Opis
classic	string	Węzły korzystające z trybu komunikacji klasycznej wymagają przychodzącej komunikacji TCP na portach 29876 i 29877 z "BatchNodeManagement". {region}" tag usługi i wychodząca komunikacja TCP na porcie 443 do "Storage.region" i "BatchNodeManagement". Tagi usługi {region}.
default	string	Tryb komunikacji węzła jest automatycznie ustawiany przez usługę Batch.
simplified	string	Węzły korzystające z uproszczonego trybu komunikacji wymagają komunikacji wychodzącej TCP na porcie 443 do "BatchNodeManagement. Tag usługi {region}. Nie są wymagane otwarte porty wejściowe.

PoolUpdatePropertiesParameter

Zestaw zmian, które mają zostać wprowadzone w puli.

Nazwa	Typ	Opis
applicationPackageReferences	ApplicationPackageReference[]	Lista pakietów aplikacji do zainstalowania w każdym węźle obliczeniowym w puli. Lista zastępuje wszystkie istniejące odwołania do pakietu aplikacji w puli. Zmiany odwołań do pakietu aplikacji mają wpływ na wszystkie nowe węzły obliczeniowe przyłączone do puli, ale nie mają wpływu na węzły obliczeniowe, które znajdują się już w puli, dopóki nie zostaną ponownie uruchomione lub zrewidowane. W danej puli istnieje maksymalnie 10 odwołań do pakietu aplikacji. Jeśli pominięto lub jeśli określisz pustą kolekcję, wszystkie istniejące odwołania do pakietów aplikacji zostaną usunięte z puli. W danej puli można określić maksymalnie 10 odwołań.
certificateReferences	CertificateReference[]	Lista certyfikatów do zainstalowania w każdym węźle obliczeniowym w puli. Ta lista zastępuje wszystkie istniejące odwołania do certyfikatów skonfigurowane w puli. Jeśli określisz pustą kolekcję, wszystkie istniejące odwołania do certyfikatów zostaną usunięte z puli. W przypadku węzłów systemu Windows usługa Batch instaluje certyfikaty w określonym magazynie certyfikatów i lokalizacji. W przypadku węzłów obliczeniowych systemu Linux certyfikaty są przechowywane w katalogu roboczym Zadanie, a zmienna środowiskowa AZ_BATCH_CERTIFICATES_DIR jest dostarczana do zadania, aby wykonać zapytanie o tę lokalizację. W przypadku certyfikatów z widocznością "remoteUser" katalog "certs" jest tworzony w katalogu głównym użytkownika (np. /home/{user-name}/certs) i certyfikaty są umieszczane w tym katalogu. Ostrzeżenie: Ta właściwość jest przestarzała i zostanie usunięta po lutym 2024 r. Zamiast tego użyj rozszerzenia Azure KeyVault.
metadata	MetadataItem[]	Lista par name-value skojarzonych z pulą jako metadanych. Ta lista zastępuje wszystkie istniejące metadane skonfigurowane w puli. Jeśli pominięto lub jeśli określisz pustą kolekcję, wszystkie istniejące metadane zostaną usunięte z puli.
startTask	StartTask	Zadanie do uruchomienia w każdym węźle obliczeniowym podczas dołączania do puli. Zadanie jest uruchamiane po dodaniu węzła obliczeniowego do puli lub ponownym uruchomieniu węzła obliczeniowego. Jeśli ten element jest obecny, zastępuje wszystkie istniejące elementy StartTask. W przypadku pominięcia wszystkie istniejące elementy StartTask zostaną usunięte z puli.
targetNodeCommunicationMode	NodeCommunicationMode	Żądany tryb komunikacji węzła dla puli. To ustawienie zastępuje wszystkie istniejące ustawienie targetNodeCommunication w puli. W przypadku pominięcia istniejące ustawienie jest domyślne.

ResourceFile

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

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

StartTask

Zadanie uruchamiane po dołączeniu węzła do puli w usłudze Azure Batch lub ponownym uruchomieniu lub ponownym uruchomieniu węzła obliczeniowego lub ponownym obrazie.

Nazwa	Typ	Opis
commandLine	string	Wiersz polecenia starttask. 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).
containerSettings	TaskContainerSettings	Ustawienia kontenera, w którym jest uruchamiana funkcja StartTask. Po określeniu tej wartości wszystkie katalogi rekursywnie poniżej AZ_BATCH_NODE_ROOT_DIR (katalogi główne katalogów usługi Azure Batch w węźle) są mapowane do kontenera, wszystkie zmienne środowiskowe zadania są mapowane do kontenera, a wiersz polecenia zadania jest wykonywany w kontenerze. Pliki utworzone w kontenerze poza AZ_BATCH_NODE_ROOT_DIR mogą nie zostać odzwierciedlone na dysku hosta, co oznacza, że interfejsy API plików usługi Batch nie będą mogły uzyskać dostępu do tych plików.
environmentSettings	EnvironmentSetting[]	Lista ustawień zmiennych środowiskowych dla elementu StartTask.
maxTaskRetryCount	integer	Maksymalna liczba ponownych prób wykonania zadania. Usługa Batch ponawia próbę zadania, jeśli jego kod zakończenia jest inny niżzer. Należy pamiętać, że ta wartość steruje liczbą ponownych prób. Usługa Batch spróbuje raz wykonać zadanie, a następnie może ponowić próbę do tego limitu. Jeśli na przykład maksymalna liczba ponownych prób wynosi 3, usługa Batch próbuje wykonać zadanie do 4 razy (jedna początkowa próba i 3 ponownych prób). Jeśli maksymalna liczba ponownych prób wynosi 0, usługa Batch nie ponowi próby wykonania zadania. 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).
resourceFiles	ResourceFile[]	Lista plików, które usługa Batch pobierze do węzła obliczeniowego przed uruchomieniem wiersza polecenia. 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. Pliki wymienione w ramach tego elementu znajdują się w katalogu roboczym zadania.
userIdentity	UserIdentity	Tożsamość użytkownika, w ramach której jest uruchamiana funkcja StartTask. W przypadku pominięcia zadanie jest uruchamiane jako użytkownik niebędący administratorem unikatowym dla zadania.
waitForSuccess	boolean	Czy usługa Batch powinna czekać na pomyślne zakończenie zadania StartTask (czyli zakończenie z kodem zakończenia 0) przed zaplanowaniem zadań w węźle obliczeniowym. Jeśli wartość true i parametr StartTask zakończy się niepowodzeniem w węźle, usługa Batch ponawia próbę do maksymalnej liczby ponownych prób (maxTaskRetryCount). Jeśli zadanie nadal nie zostało ukończone pomyślnie po ponownych próbach, usługa Batch oznacza węzeł bezużyteczny i nie będzie planować zadań do niego. Ten warunek można wykryć za pomocą szczegółów stanu węzła obliczeniowego i informacji o błędzie. Jeśli wartość false, usługa Batch nie będzie czekać na ukończenie zadania StartTask. W takim przypadku inne zadania mogą rozpocząć wykonywanie w węźle obliczeniowym, gdy funkcja StartTask jest nadal uruchomiona; a nawet jeśli zadanie StartTask zakończy się niepowodzeniem, nowe zadania będą nadal zaplanowane w węźle obliczeniowym. Wartość domyślna to true.

TaskContainerSettings

Ustawienia kontenera dla zadania.

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

UserIdentity

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

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