Job - List
Wyświetla listę wszystkich zadań w określonym koncie.
GET {batchUrl}/jobs?api-version=2023-11-01.18.0
GET {batchUrl}/jobs?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
batch
|
path | True |
string |
Podstawowy adres URL wszystkich żądań obsługi Azure Batch. |
api-version
|
query | True |
string |
Wersja interfejsu API klienta. |
$expand
|
query |
string |
Klauzula $expand OData. |
|
$filter
|
query |
string |
Klauzula $filter OData. Aby uzyskać więcej informacji na temat konstruowania tego filtru, zobacz https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs. |
|
$select
|
query |
string |
Klauzula $select OData. |
|
maxresults
|
query |
integer int32 |
Maksymalna liczba elementów do zwrócenia w odpowiedzi. Można zwrócić maksymalnie 1000 zadań. |
|
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, takiej jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
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. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Odpowiedź zawierająca listę zadań. Nagłówki
|
|
Other Status Codes |
Błąd usługi Batch. |
Zabezpieczenia
azure_auth
Microsoft Entra przepływ kodu uwierzytelniania OAuth 2.0
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
Job list
Przykładowe żądanie
GET account.region.batch.azure.com/jobs?api-version=2023-11-01.18.0
Przykładowa odpowiedź
{
"value": [
{
"id": "jobId",
"url": "https://account.region.batch.azure.com/jobs/jobId",
"eTag": "0x8D4100FC46D5BF4",
"lastModified": "2016-11-19T00:05:27.2137716Z",
"creationTime": "2016-11-19T00:05:25.311915Z",
"state": "active",
"stateTransitionTime": "2016-11-19T00:05:27.2137716Z",
"previousState": "disabled",
"previousStateTransitionTime": "2016-11-19T00:05:26.88777Z",
"priority": 0,
"maxParallelTasks": -1,
"allowTaskPreemption": false,
"usesTaskDependencies": false,
"constraints": {
"maxWallClockTime": "P10675199DT2H48M5.4775807S",
"maxTaskRetryCount": 0
},
"poolInfo": {
"poolId": "poolId"
},
"executionInfo": {
"startTime": "2016-11-19T00:05:25.3309105Z",
"poolId": "poolId"
},
"onAllTasksComplete": "noaction",
"onTaskFailure": "noaction"
}
]
}
Definicje
Nazwa | Opis |
---|---|
Access |
Zasoby usługi Batch, do których token udziela dostępu. |
Application |
Odwołanie do pakietu do wdrożenia w węzłach obliczeniowych. |
Authentication |
Ustawienia tokenu uwierzytelniania, którego zadanie może użyć do wykonywania operacji usługi Batch. |
Auto |
Określa charakterystykę tymczasowej "puli automatycznej". Usługa Batch utworzy tę automatyczną pulę po przesłaniu zadania. |
Auto |
Zakres użytkownika automatycznego |
Auto |
Określa parametry dla użytkownika automatycznego, który uruchamia zadanie w usłudze Batch. |
Azure |
Informacje używane do nawiązywania połączenia z kontenerem usługi Azure Storage przy użyciu systemu Blobfuse. |
Azure |
Informacje używane do nawiązywania połączenia z udziałem plików platformy Azure. |
Batch |
Odebrano odpowiedź o błędzie z usługi Azure Batch. |
Batch |
Element dodatkowych informacji zawartych w odpowiedzi na błąd Azure Batch. |
Caching |
Typ buforowania, który ma być włączony dla dysku. |
Certificate |
Odwołanie do certyfikatu do zainstalowania w węzłach obliczeniowych w puli. |
Certificate |
Lokalizacja magazynu certyfikatów w węźle obliczeniowym, w którym ma zostać zainstalowany certyfikat. |
Certificate |
Które konta użytkowników w węźle obliczeniowym powinny mieć dostęp do prywatnych danych certyfikatu. |
CIFSMount |
Informacje używane do nawiązywania połączenia z systemem plików CIFS. |
Cloud |
Zadanie Azure Batch. |
Cloud |
Wynik wyświetlania listy zadań na koncie. |
Cloud |
Konfiguracja węzłów obliczeniowych w puli na podstawie platformy Azure Cloud Services. |
Compute |
Sposób dystrybucji zadań między węzłami obliczeniowymi w puli. |
Compute |
Odwołanie do tożsamości przypisanej przez użytkownika skojarzonej z pulą usługi Batch, której będzie używać węzeł obliczeniowy. |
Container |
Konfiguracja pul z obsługą kontenerów. |
Container |
Prywatny rejestr kontenerów. |
Container |
Używana technologia kontenerów. |
Container |
Lokalizacja katalogu roboczego zadania kontenera. |
Data |
Ustawienia, które będą używane przez dyski danych skojarzone z węzłami obliczeniowymi w puli. W przypadku korzystania z dołączonych dysków danych należy zainstalować i sformatować dyski z poziomu maszyny wirtualnej, aby ich używać. |
Diff |
Określa efemeryczne umieszczanie dysku systemu operacyjnego dla wszystkich węzłów obliczeniowych (maszyn wirtualnych) w puli. |
Diff |
Określa ustawienia dysku efemerycznego dla dysku systemu operacyjnego używanego przez węzeł obliczeniowy (VM). |
Disk |
Konfiguracja szyfrowania dysków zastosowana w węzłach obliczeniowych w puli. Konfiguracja szyfrowania dysków nie jest obsługiwana w puli systemu Linux utworzonej przy użyciu obrazu galerii obliczeń platformy Azure. |
Disk |
Lista dysków przeznaczonych dla usługi Batch zostanie zaszyfrowana w węźle obliczeniowym. |
Dynamic |
Zakres dynamicznego przypisania sieci wirtualnej. |
Elevation |
Poziom podniesienia uprawnień użytkownika. |
Environment |
Zmienna środowiskowa, która ma zostać ustawiona w procesie zadania. |
Error |
Kategoria błędu. |
Error |
Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu. |
Http |
Para nazwa-wartość nagłówka HTTP |
Image |
Odwołanie do obrazu witryny Azure Virtual Machines Marketplace lub obrazu galerii obliczeniowej platformy Azure. Aby uzyskać listę wszystkich odwołań do obrazu Azure Marketplace zweryfikowanych przez Azure Batch, zobacz operację "Wyświetlanie listy obsługiwanych obrazów". |
Inbound |
Protokół punktu końcowego. |
Inbound |
Przychodzącą pulę translatora adresów sieciowych, która może służyć do obsługi określonych portów w węzłach obliczeniowych w puli usługi Batch zewnętrznie. |
IPAddress |
Typ aprowizacji dla publicznych adresów IP dla puli. |
Job |
Ograniczenia wykonywania zadania. |
Job |
Zawiera informacje o wykonywaniu zadania w usłudze Azure Batch. |
Job |
Określa szczegóły zadania Menedżera zadań. |
Job |
Konfiguracja sieci dla zadania. |
Job |
Zadanie przygotowania zadania do uruchomienia przed wszystkimi zadaniami zadania w dowolnym węźle obliczeniowym. |
Job |
Zadanie wydania zadania do uruchomienia po zakończeniu zadania w dowolnym węźle obliczeniowym, w którym uruchomiono zadanie. |
Job |
Błąd napotkany przez usługę Batch podczas planowania zadania. |
Job |
Stan zadania. |
Job |
Statystyki użycia zasobów dla zadania. |
Linux |
Właściwości używane do tworzenia konta użytkownika w węźle obliczeniowym systemu Linux. |
Login |
Tryb logowania użytkownika |
Managed |
|
Metadata |
Para nazwa-wartość skojarzona z zasobem usługi Batch. |
Mount |
System plików do zainstalowania w każdym węźle. |
Name |
Reprezentuje parę nazwa-wartość. |
Network |
Konfiguracja sieci dla puli. |
Network |
Reguła sieciowej grupy zabezpieczeń, która ma być stosowana do przychodzącego punktu końcowego. |
Network |
Akcja, która powinna zostać podjęta dla określonego adresu IP, zakresu podsieci lub tagu. |
NFSMount |
Informacje używane do nawiązywania połączenia z systemem plików NFS. |
Node |
Określa sposób komunikowania się puli z usługą Batch. |
Node |
Konfiguracja umieszczania węzła dla puli. |
Node |
Zasady umieszczania dla przydzielania węzłów w puli. |
On |
Akcja, jaką usługa Batch powinna wykonać, gdy wszystkie zadania w zadaniu są w stanie ukończonym. |
On |
Akcja, jaką usługa Batch powinna wykonać, gdy dowolne zadanie w zadaniu zakończy się niepowodzeniem. |
OSDisk |
Ustawienia dysku systemu operacyjnego węzła obliczeniowego (VM). |
Output |
Specyfikacja przekazywania plików z węzła obliczeniowego Azure Batch do innej lokalizacji po zakończeniu wykonywania procesu zadania przez usługę Batch. |
Output |
Określa miejsce docelowe przekazywania plików w kontenerze usługi Azure Blob Storage. |
Output |
Miejsce docelowe, do którego ma zostać przekazany plik. |
Output |
Warunki, w których należy przekazać plik wyjściowy zadania lub zestaw plików. |
Output |
Szczegółowe informacje o operacji przekazywania pliku wyjściowego, w tym o warunkach do wykonania przekazywania. |
Pool |
Konfiguracja punktu końcowego dla puli. |
Pool |
Określa sposób przypisania zadania do puli. |
Pool |
Minimalny okres istnienia utworzonych automatycznych pul oraz sposób przypisywaniu wielu zadań zgodnie z harmonogramem do pul. |
Pool |
Specyfikacja tworzenia nowej puli. |
Public |
Konfiguracja publicznego adresu IP konfiguracji sieci puli. |
Resource |
Jeden plik lub wiele plików do pobrania do węzła obliczeniowego. |
Security |
Określa ustawienia profilu zabezpieczeń dla maszyny wirtualnej lub zestawu skalowania maszyn wirtualnych. |
Security |
Określa typ zabezpieczeń maszyny wirtualnej. Należy ustawić ją na dowolną określoną wartość, aby włączyć funkcję UefiSettings. |
Service |
Określa identyfikator odwołania artefaktu usługi używany do ustawiania tej samej wersji obrazu dla wszystkich maszyn wirtualnych w zestawie skalowania podczas korzystania z wersji obrazu "latest". |
Start |
Zadanie uruchamiane po dołączeniu węzła do puli w usłudze Azure Batch lub po ponownym uruchomieniu lub ponownym uruchomieniu węzła obliczeniowego lub ponownym obrazie. |
Storage |
Typ konta magazynu do użycia podczas tworzenia dysków danych lub dysku systemu operacyjnego. |
Task |
Ograniczenia wykonywania, które mają być stosowane do zadania. |
Task |
Ustawienia kontenera dla zadania. |
Task |
Określa sposób dystrybucji zadań w węzłach obliczeniowych. |
Uefi |
Określa ustawienia zabezpieczeń, takie jak bezpieczny rozruch i vTPM używane podczas tworzenia maszyny wirtualnej. |
User |
Właściwości używane do tworzenia użytkownika używanego do wykonywania zadań w węźle obliczeniowym Azure Batch. |
User |
Definicja tożsamości użytkownika, w ramach której jest uruchamiane zadanie. |
Virtual |
Konfiguracja węzłów obliczeniowych w puli na podstawie infrastruktury usługi Azure Virtual Machines. |
VMExtension |
Konfiguracja rozszerzeń maszyn wirtualnych. |
Windows |
Ustawienia systemu operacyjnego Windows do zastosowania do maszyny wirtualnej. |
Windows |
Właściwości używane do tworzenia konta użytkownika w węźle obliczeniowym systemu Windows. |
AccessScope
Zasoby usługi Batch, do których token udziela dostępu.
Nazwa | Typ | Opis |
---|---|---|
job |
string |
Udziela dostępu do wykonywania wszystkich operacji w zadaniu zawierającym zadanie. |
ApplicationPackageReference
Odwołanie do pakietu do wdrożenia w węzłach obliczeniowych.
Nazwa | Typ | Opis |
---|---|---|
applicationId |
string |
Identyfikator aplikacji do wdrożenia. |
version |
string |
Wersja aplikacji do wdrożenia. Jeśli pominięto, zostanie wdrożona domyślna wersja. |
AuthenticationTokenSettings
Ustawienia tokenu uwierzytelniania, którego zadanie może użyć do wykonywania operacji usługi Batch.
Nazwa | Typ | Opis |
---|---|---|
access |
Zasoby usługi Batch, do których token udziela dostępu. |
AutoPoolSpecification
Określa charakterystykę tymczasowej "puli automatycznej". Usługa Batch utworzy tę automatyczną pulę po przesłaniu zadania.
Nazwa | Typ | Opis |
---|---|---|
autoPoolIdPrefix |
string |
Prefiks, który ma zostać dodany do unikatowego identyfikatora po automatycznym utworzeniu puli. |
keepAlive |
boolean |
Czy zachować pulę automatyczną przy życiu po wygaśnięciu okresu istnienia. |
pool |
Specyfikacja puli dla puli automatycznej. |
|
poolLifetimeOption |
Minimalny okres istnienia utworzonych automatycznych pul oraz sposób przypisywaniu wielu zadań zgodnie z harmonogramem do pul. |
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 |
Poziom podniesienia uprawnień użytkownika automatycznego. |
|
scope |
Zakres dla użytkownika automatycznego |
AzureBlobFileSystemConfiguration
Informacje używane do nawiązywania połączenia z kontenerem usługi Azure Storage przy użyciu systemu Blobfuse.
Nazwa | Typ | Opis |
---|---|---|
accountKey |
string |
Klucz konta usługi Azure Storage. |
accountName |
string |
Nazwa konta usługi Azure Storage. |
blobfuseOptions |
string |
Dodatkowe opcje wiersza polecenia umożliwiające przekazanie polecenia instalacji. |
containerName |
string |
Nazwa kontenera Azure Blob Storage. |
identityReference |
Odwołanie do tożsamości przypisanej przez użytkownika do użycia w celu uzyskania dostępu do nazwy kontenera |
|
relativeMountPath |
string |
Ścieżka względna w węźle obliczeniowym, w którym zostanie zainstalowany system plików |
sasKey |
string |
Token SAS usługi Azure Storage. |
AzureFileShareConfiguration
Informacje używane do nawiązywania połączenia z udziałem plików platformy Azure.
Nazwa | Typ | Opis |
---|---|---|
accountKey |
string |
Klucz konta usługi Azure Storage. |
accountName |
string |
Nazwa konta usługi Azure Storage. |
azureFileUrl |
string |
Adres URL Azure Files. |
mountOptions |
string |
Dodatkowe opcje wiersza polecenia umożliwiające przekazanie polecenia instalacji. |
relativeMountPath |
string |
Ścieżka względna w węźle obliczeniowym, w którym zostanie zainstalowany system plików |
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 |
Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika. |
|
values |
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. |
CachingType
Typ buforowania, który ma być włączony dla dysku.
Nazwa | Typ | Opis |
---|---|---|
none |
string |
Tryb buforowania dysku nie jest włączony. |
readonly |
string |
Tryb buforowania dla dysku jest tylko do odczytu. |
readwrite |
string |
Tryb buforowania dysku jest odczytywany i zapisywany. |
CertificateReference
Odwołanie do certyfikatu do zainstalowania w węzłach obliczeniowych w puli.
Nazwa | Typ | Opis |
---|---|---|
storeLocation |
Lokalizacja magazynu certyfikatów w węźle obliczeniowym, w którym ma zostać zainstalowany certyfikat. |
|
storeName |
string |
Nazwa magazynu certyfikatów w węźle obliczeniowym, w którym ma zostać zainstalowany certyfikat. |
thumbprint |
string |
Odcisk palca certyfikatu. |
thumbprintAlgorithm |
string |
Algorytm, z którym jest skojarzony odcisk palca. Musi to być sha1. |
visibility |
Które konta użytkowników w węźle obliczeniowym powinny mieć dostęp do prywatnych danych certyfikatu. |
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 uruchamiany element StartTask. Należy pamiętać, że jeśli zakres autoużytkownika jest pulą dla zadania StartTask i Zadania, ten certyfikat będzie również widoczny dla zadania. |
task |
string |
Certyfikat powinien być widoczny dla kont użytkowników, w których są uruchamiane zadania zadań. |
CIFSMountConfiguration
Informacje używane do nawiązywania połączenia z systemem plików CIFS.
Nazwa | Typ | Opis |
---|---|---|
mountOptions |
string |
Dodatkowe opcje wiersza polecenia umożliwiające przekazanie polecenia instalacji. |
password |
string |
Hasło używane do uwierzytelniania w systemie plików CIFS. |
relativeMountPath |
string |
Ścieżka względna w węźle obliczeniowym, w którym zostanie zainstalowany system plików |
source |
string |
Identyfikator URI systemu plików do zainstalowania. |
username |
string |
Użytkownik, który ma być używany do uwierzytelniania w systemie plików CIFS. |
CloudJob
Zadanie Azure Batch.
Nazwa | Typ | Domyślna wartość | Opis |
---|---|---|---|
allowTaskPreemption |
boolean |
Czy zadania podrzędne w tym zadaniu mogą zostać wywłaszczone przez inne zadania o wysokim priorytcie |
|
commonEnvironmentSettings |
Lista typowych ustawień zmiennych środowiskowych. Te zmienne środowiskowe są ustawiane dla wszystkich zadań podrzędnych w zadaniu (w tym Menedżera zadań, przygotowania zadania i zadania zwolnienia zadania). |
||
constraints |
Ograniczenia wykonywania zadania. |
||
creationTime |
string |
Czas tworzenia zadania. |
|
displayName |
string |
Nazwa wyświetlana zadania. |
|
eTag |
string |
Element ETag zadania. |
|
executionInfo |
Informacje o wykonaniu zadania. |
||
id |
string |
Ciąg, który jednoznacznie identyfikuje zadanie w ramach konta. |
|
jobManagerTask |
Szczegółowe informacje o zadaniu Menedżera zadań, które ma zostać uruchomione po uruchomieniu zadania. |
||
jobPreparationTask |
Zadanie przygotowania zadania. |
||
jobReleaseTask |
Zadanie zwolnienia zadania. |
||
lastModified |
string |
Czas ostatniej modyfikacji zadania. |
|
maxParallelTasks |
integer |
-1 |
Maksymalna liczba zadań, które mogą być wykonywane równolegle dla zadania. |
metadata |
Lista par name-value skojarzonych z zadaniem jako metadanymi. |
||
networkConfiguration |
Konfiguracja sieci dla zadania. |
||
onAllTasksComplete |
Akcja, jaką usługa Batch powinna wykonać, gdy wszystkie zadania w zadaniu są w stanie ukończonym. |
||
onTaskFailure |
Akcja, jaką usługa Batch powinna wykonać, gdy dowolne zadanie w zadaniu zakończy się niepowodzeniem. |
||
poolInfo |
Ustawienia puli skojarzone z zadaniem. |
||
previousState |
Poprzedni stan zadania. |
||
previousStateTransitionTime |
string |
Czas, w którym zadanie zostało wprowadzone w poprzednim stanie. |
|
priority |
integer |
Priorytet zadania. |
|
state |
Bieżący stan zadania. |
||
stateTransitionTime |
string |
Czas, w którym zadanie wprowadziło bieżący stan. |
|
stats |
Statystyki użycia zasobów dla całego okresu istnienia zadania. |
||
url |
string |
Adres URL zadania. |
|
usesTaskDependencies |
boolean |
Określa, czy zadania w zadaniu mogą definiować zależności od siebie. Wartością domyślną jest false. |
CloudJobListResult
Wynik wyświetlania listy zadań na koncie.
Nazwa | Typ | Opis |
---|---|---|
odata.nextLink |
string |
Adres URL umożliwiający uzyskanie następnego zestawu wyników. |
value |
Cloud |
Lista zadań. |
CloudServiceConfiguration
Konfiguracja węzłów obliczeniowych w puli na podstawie platformy Azure Cloud Services.
Nazwa | Typ | Opis |
---|---|---|
osFamily |
string |
Rodzina systemu operacyjnego gościa platformy Azure, która ma zostać zainstalowana na maszynach wirtualnych w puli. |
osVersion |
string |
Wersja systemu operacyjnego gościa platformy Azure, która ma zostać zainstalowana na maszynach wirtualnych w puli. |
ComputeNodeFillType
Sposób dystrybucji zadań między węzłami obliczeniowymi w puli.
Nazwa | Typ | Opis |
---|---|---|
pack |
string |
Jak najwięcej zadań (taskSlotsPerNode) należy przypisać do każdego węzła obliczeniowego w puli, zanim wszystkie zadania zostaną przypisane do następnego węzła obliczeniowego w puli. |
spread |
string |
Zadania powinny być przypisywane równomiernie we wszystkich węzłach obliczeniowych w puli. |
ComputeNodeIdentityReference
Odwołanie do tożsamości przypisanej przez użytkownika skojarzonej z pulą usługi Batch, której będzie używać węzeł obliczeniowy.
Nazwa | Typ | Opis |
---|---|---|
resourceId |
string |
Identyfikator zasobu usługi ARM tożsamości przypisanej przez użytkownika. |
ContainerConfiguration
Konfiguracja pul z obsługą kontenerów.
Nazwa | Typ | Opis |
---|---|---|
containerImageNames |
string[] |
Kolekcja nazw obrazów kontenera. |
containerRegistries |
Dodatkowe prywatne rejestry, z których można ściągać kontenery. |
|
type |
Technologia kontenera do użycia. |
ContainerRegistry
Prywatny rejestr kontenerów.
Nazwa | Typ | Opis |
---|---|---|
identityReference |
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. |
|
password |
string |
Hasło do logowania się na serwerze rejestru. |
registryServer |
string |
Adres URL rejestru. |
username |
string |
Nazwa użytkownika do logowania się na serwerze rejestru. |
ContainerType
Używana technologia kontenerów.
Nazwa | Typ | Opis |
---|---|---|
criCompatible |
string |
Technologia oparta na cri będzie używana do uruchamiania kontenerów. |
dockerCompatible |
string |
Technologia kontenera zgodna z platformą Docker będzie używana do uruchamiania kontenerów. |
ContainerWorkingDirectory
Lokalizacja katalogu roboczego zadania kontenera.
Nazwa | Typ | Opis |
---|---|---|
containerImageDefault |
string |
Użyj katalogu roboczego zdefiniowanego w obrazie kontenera. Pamiętaj, ż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. |
DataDisk
Ustawienia, które będą używane przez dyski danych skojarzone z węzłami obliczeniowymi w puli. W przypadku korzystania z dołączonych dysków danych należy zainstalować i sformatować dyski z poziomu maszyny wirtualnej, aby ich używać.
Nazwa | Typ | Opis |
---|---|---|
caching |
Typ buforowania, który ma być włączony dla dysków danych. |
|
diskSizeGB |
integer |
Początkowy rozmiar dysku w gigabajtach. |
lun |
integer |
Numer jednostki logicznej. |
storageAccountType |
Typ konta magazynu, który ma być używany dla dysku danych. |
DiffDiskPlacement
Określa efemeryczne umieszczanie dysku systemu operacyjnego dla wszystkich węzłów obliczeniowych (maszyn wirtualnych) w puli.
Nazwa | Typ | Opis |
---|---|---|
CacheDisk |
string |
Efemeryczny dysk systemu operacyjnego jest przechowywany w pamięci podręcznej maszyny wirtualnej. |
DiffDiskSettings
Określa ustawienia dysku efemerycznego dla dysku systemu operacyjnego używanego przez węzeł obliczeniowy (VM).
Nazwa | Typ | Opis |
---|---|---|
placement |
Określa efemeryczne umieszczanie dysku systemu operacyjnego dla wszystkich maszyn wirtualnych w puli. |
DiskEncryptionConfiguration
Konfiguracja szyfrowania dysków zastosowana w węzłach obliczeniowych w puli. Konfiguracja szyfrowania dysków nie jest obsługiwana w puli systemu Linux utworzonej przy użyciu obrazu galerii obliczeń platformy Azure.
Nazwa | Typ | Opis |
---|---|---|
targets |
Lista miejsc docelowych dysków usługi Batch zostanie zaszyfrowana w węźle obliczeniowym. |
DiskEncryptionTarget
Lista dysków przeznaczonych dla usługi Batch zostanie zaszyfrowana w węźle obliczeniowym.
Nazwa | Typ | Opis |
---|---|---|
osdisk |
string |
Dysk systemu operacyjnego w węźle obliczeniowym jest szyfrowany. |
temporarydisk |
string |
Dysk tymczasowy w węźle obliczeniowym jest szyfrowany. W systemie Linux to szyfrowanie ma zastosowanie do innych partycji (takich jak te na zainstalowanych dyskach danych), gdy szyfrowanie odbywa się w czasie rozruchu. |
DynamicVNetAssignmentScope
Zakres dynamicznego przypisania sieci wirtualnej.
Nazwa | Typ | Opis |
---|---|---|
job |
string |
Dynamiczne przypisywanie sieci wirtualnej jest wykonywane na zadanie. |
none |
string |
Nie włączono dynamicznego przypisania sieci wirtualnej. |
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. |
ErrorCategory
Kategoria błędu.
Nazwa | Typ | Opis |
---|---|---|
servererror |
string |
Błąd jest spowodowany wewnętrznym problemem z serwerem. |
usererror |
string |
Błąd jest spowodowany problemem użytkownika, takim jak błędna konfiguracja. |
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. |
HttpHeader
Para nazwa-wartość nagłówka HTTP
Nazwa | Typ | Opis |
---|---|---|
name |
string |
Nazwa nagłówka bez uwzględniania wielkości liter, 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 |
ImageReference
Odwołanie do obrazu witryny Azure Virtual Machines Marketplace lub obrazu galerii obliczeniowej platformy Azure. Aby uzyskać listę wszystkich odwołań do obrazu Azure Marketplace zweryfikowanych przez Azure Batch, zobacz operację "Wyświetlanie listy obsługiwanych obrazów".
Nazwa | Typ | Opis |
---|---|---|
exactVersion |
string |
Określona wersja obrazu platformy lub obrazu witryny Marketplace używana do utworzenia węzła. To pole tylko do odczytu różni się od "wersji" tylko wtedy, gdy wartość określona dla "wersji" podczas tworzenia puli była "najnowsza". |
offer |
string |
Typ oferty obrazu witryny Azure Virtual Machines Marketplace. |
publisher |
string |
Wydawca obrazu witryny Azure Virtual Machines Marketplace. |
sku |
string |
Jednostka SKU obrazu witryny Azure Virtual Machines Marketplace. |
version |
string |
Wersja obrazu witryny Azure Virtual Machines Marketplace. |
virtualMachineImageId |
string |
Identyfikator zasobu usługi ARM obrazu galerii obliczeniowej platformy Azure. Węzły obliczeniowe w puli zostaną utworzone przy użyciu tego identyfikatora obrazu. Jest to formularz /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} lub /subscriptions/{subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{gallerys/{galleryName}/images/{imageDefinitionName} dla zawsze domyślnej wersji obrazu. |
InboundEndpointProtocol
Protokół punktu końcowego.
Nazwa | Typ | Opis |
---|---|---|
tcp |
string |
Użyj protokołu TCP dla punktu końcowego. |
udp |
string |
Użyj protokołu UDP dla punktu końcowego. |
InboundNATPool
Przychodzącą pulę translatora adresów sieciowych, która może służyć do obsługi określonych portów w węzłach obliczeniowych w puli usługi Batch zewnętrznie.
Nazwa | Typ | Opis |
---|---|---|
backendPort |
integer |
Numer portu w węźle obliczeniowym. |
frontendPortRangeEnd |
integer |
Ostatni numer portu w zakresie portów zewnętrznych, które będą używane do zapewnienia dostępu przychodzącego do zapleczaPort w poszczególnych węzłach obliczeniowych. |
frontendPortRangeStart |
integer |
Pierwszy numer portu w zakresie portów zewnętrznych, które będą używane do zapewnienia dostępu przychodzącego do zapleczaPort w poszczególnych węzłach obliczeniowych. |
name |
string |
Nazwa punktu końcowego. |
networkSecurityGroupRules |
Lista reguł sieciowej grupy zabezpieczeń, które zostaną zastosowane do punktu końcowego. |
|
protocol |
Protokół punktu końcowego. |
IPAddressProvisioningType
Typ aprowizacji dla publicznych adresów IP dla puli.
Nazwa | Typ | Opis |
---|---|---|
batchmanaged |
string |
Publiczny adres IP zostanie utworzony i zarządzany przez usługę Batch. W zależności od rozmiaru puli może istnieć wiele publicznych adresów IP. |
nopublicipaddresses |
string |
Nie zostanie utworzony publiczny adres IP. |
usermanaged |
string |
Publiczne adresy IP są udostępniane przez użytkownika i będą używane do aprowizowania węzłów obliczeniowych. |
JobConstraints
Ograniczenia wykonywania zadania.
Nazwa | Typ | Opis |
---|---|---|
maxTaskRetryCount |
integer |
Maksymalna liczba ponownych prób każdego zadania. Usługa Batch ponawia próbę zadania, jeśli jego kod zakończenia jest niezerowy. |
maxWallClockTime |
string |
Maksymalny czas, który upłynął do uruchomienia zadania, mierzony od momentu utworzenia zadania. |
JobExecutionInformation
Zawiera informacje o wykonywaniu zadania w usłudze Azure Batch.
Nazwa | Typ | Opis |
---|---|---|
endTime |
string |
Czas ukończenia zadania. |
poolId |
string |
Identyfikator puli, do której przypisano to zadanie. |
schedulingError |
Szczegóły dowolnego błędu napotkanego przez usługę podczas uruchamiania zadania. |
|
startTime |
string |
Godzina rozpoczęcia zadania. |
terminateReason |
string |
Ciąg opisujący przyczynę zakończenia zadania. |
JobManagerTask
Określa szczegóły zadania Menedżera zadań.
Nazwa | Typ | Opis |
---|---|---|
allowLowPriorityNode |
boolean |
Czy zadanie Menedżera zadań może być uruchamiane w węźle obliczeniowym typu spot/low-priority. |
applicationPackageReferences |
Lista pakietów aplikacji wdrożonych przez usługę Batch w węźle obliczeniowym przed uruchomieniem wiersza polecenia. |
|
authenticationTokenSettings |
Ustawienia tokenu uwierzytelniania, którego zadanie może użyć do wykonywania operacji usługi Batch. |
|
commandLine |
string |
Wiersz polecenia zadania Menedżera zadań. |
constraints |
Ograniczenia, które mają zastosowanie do zadania Menedżera zadań. |
|
containerSettings |
Ustawienia kontenera, w którym jest uruchamiane zadanie Menedżera zadań. |
|
displayName |
string |
Nazwa wyświetlana zadania Menedżera zadań. |
environmentSettings |
Lista ustawień zmiennych środowiskowych dla zadania Menedżera zadań. |
|
id |
string |
Ciąg, który jednoznacznie identyfikuje zadanie Menedżera zadań w ramach zadania. |
killJobOnCompletion |
boolean |
Czy ukończenie zadania Menedżera zadań oznacza ukończenie całego zadania. |
outputFiles |
Lista plików przekazanych przez usługę Batch z węzła obliczeniowego po uruchomieniu wiersza polecenia. |
|
requiredSlots |
integer |
Liczba miejsc planowania, których zadanie wymaga uruchomienia. |
resourceFiles |
Lista plików, które usługa Batch pobierze do węzła obliczeniowego przed uruchomieniem wiersza polecenia. |
|
runExclusive |
boolean |
Czy zadanie Menedżera zadań wymaga wyłącznego użycia węzła obliczeniowego, w którym jest uruchamiany. |
userIdentity |
Tożsamość użytkownika, w ramach której jest uruchamiane zadanie Menedżera zadań. |
JobNetworkConfiguration
Konfiguracja sieci dla zadania.
Nazwa | Typ | Opis |
---|---|---|
subnetId |
string |
Identyfikator zasobu usługi ARM podsieci sieci wirtualnej, do której węzły obliczeniowe uruchomione z zadania zostaną przyłączone przez czas trwania zadania. Będzie to działać tylko z pulą VirtualMachineConfiguration. |
JobPreparationTask
Zadanie przygotowania zadania do uruchomienia przed wszystkimi zadaniami zadania w dowolnym węźle obliczeniowym.
Nazwa | Typ | Opis |
---|---|---|
commandLine |
string |
Wiersz polecenia zadania przygotowania zadania. |
constraints |
Ograniczenia, które mają zastosowanie do zadania przygotowania zadania. |
|
containerSettings |
Ustawienia kontenera, w którym jest uruchamiane zadanie przygotowania zadania. |
|
environmentSettings |
Lista ustawień zmiennych środowiskowych dla zadania przygotowania zadania. |
|
id |
string |
Ciąg, który jednoznacznie identyfikuje zadanie przygotowania zadania w ramach zadania. |
rerunOnNodeRebootAfterSuccess |
boolean |
Czy usługa Batch powinna ponownie uruchomić zadanie przygotowania zadania po ponownym uruchomieniu węzła obliczeniowego. |
resourceFiles |
Lista plików, które usługa Batch pobierze do węzła obliczeniowego przed uruchomieniem wiersza polecenia. |
|
userIdentity |
Tożsamość użytkownika, w ramach której jest uruchamiane zadanie przygotowania zadania. |
|
waitForSuccess |
boolean |
Czy usługa Batch powinna czekać na pomyślne ukończenie zadania przygotowania zadania przed zaplanowanie innych zadań zadania w węźle obliczeniowym. Zadanie przygotowania zadania zostało ukończone pomyślnie, jeśli zostanie zakończone z kodem zakończenia 0. |
JobReleaseTask
Zadanie wydania zadania do uruchomienia po zakończeniu zadania w dowolnym węźle obliczeniowym, w którym uruchomiono zadanie.
Nazwa | Typ | Opis |
---|---|---|
commandLine |
string |
Wiersz polecenia zadania zwolnienia zadania. |
containerSettings |
Ustawienia kontenera, w którym jest uruchamiane zadanie zwolnienia zadania. |
|
environmentSettings |
Lista ustawień zmiennych środowiskowych dla zadania zwolnienia zadania. |
|
id |
string |
Ciąg, który jednoznacznie identyfikuje zadanie wydania zadania w ramach zadania. |
maxWallClockTime |
string |
Maksymalny czas, jaki upłynął, kiedy zadanie zwolnienia zadania może być uruchamiane w danym węźle obliczeniowym mierzonym od momentu uruchomienia zadania. Jeśli zadanie nie zostanie ukończone w limicie czasu, usługa Batch ją zakończy. Wartość domyślna to 15 minut. Nie można określić limitu czasu dłuższego niż 15 minut. Jeśli to zrobisz, usługa Batch odrzuci ją z powodu błędu; Jeśli bezpośrednio wywołujesz interfejs API REST, kod stanu HTTP to 400 (Nieprawidłowe żądanie). |
resourceFiles |
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 ResourceFiles. Można to osiągnąć przy użyciu plików .zip, pakietów aplikacji lub kontenerów platformy Docker. |
|
retentionTime |
string |
Minimalny czas przechowywania katalogu zadań dla zadania zwolnienia zadania w węźle obliczeniowym. Po tym czasie usługa Batch może usunąć katalog Zadań i całą jego zawartość. |
userIdentity |
Tożsamość użytkownika, w ramach której jest uruchamiane zadanie zwolnienia zadania. |
JobSchedulingError
Błąd napotkany przez usługę Batch podczas planowania zadania.
Nazwa | Typ | Opis |
---|---|---|
category |
Kategoria błędu planowania zadań. |
|
code |
string |
Identyfikator błędu planowania zadań. Kody są niezmienne i mają być używane programowo. |
details |
Lista dodatkowych szczegółów błędu związanych z błędem planowania. |
|
message |
string |
Komunikat opisujący błąd planowania zadań, który ma być odpowiedni do wyświetlania w interfejsie użytkownika. |
JobState
Stan zadania.
Nazwa | Typ | Opis |
---|---|---|
active |
string |
Zadanie jest dostępne do zaplanowanych zadań. |
completed |
string |
Wszystkie zadania zostały zakończone, a system nie zaakceptuje kolejnych zadań ani żadnych dalszych zmian w zadaniu. |
deleting |
string |
Użytkownik zażądał usunięcia zadania, ale operacja usuwania jest nadal w toku (na przykład dlatego, że system nadal kończy uruchomione zadania). |
disabled |
string |
Użytkownik wyłączył zadanie. Żadne zadania nie są uruchomione i nie zostaną zaplanowane żadne nowe zadania. |
disabling |
string |
Użytkownik zażądał wyłączenia zadania, ale operacja wyłączania jest nadal w toku (na przykład oczekiwanie na zakończenie zadań). |
enabling |
string |
Użytkownik zażądał włączenia zadania, ale operacja włączania jest nadal w toku. |
terminating |
string |
Zadanie zostanie ukończone, ponieważ zadanie Menedżera zadań zostało ukończone lub użytkownik zakończył zadanie, ale operacja zakończenia jest nadal w toku (na przykład dlatego, że zadania zwolnienia zadania są uruchomione). |
JobStatistics
Statystyki użycia zasobów dla zadania.
Nazwa | Typ | Opis |
---|---|---|
kernelCPUTime |
string |
Łączny czas procesora CPU w trybie jądra (zsumowany na wszystkich rdzeniach i wszystkich węzłach obliczeniowych) używany przez wszystkie zadania w zadaniu. |
lastUpdateTime |
string |
Czas ostatniej aktualizacji statystyk. Wszystkie statystyki są ograniczone do zakresu od startTime do lastUpdateTime. |
numFailedTasks |
integer |
Łączna liczba zadań w zadaniu, które zakończyły się niepowodzeniem w danym zakresie czasu. |
numSucceededTasks |
integer |
Łączna liczba zadań zakończonych pomyślnie w zadaniu w danym zakresie czasu. |
numTaskRetries |
integer |
Łączna liczba ponownych prób dla wszystkich zadań w zadaniu w danym zakresie czasu. |
readIOGiB |
number |
Łączna ilość danych w giB odczytanych z dysku przez wszystkie zadania w zadaniu. |
readIOps |
integer |
Całkowita liczba operacji odczytu dysku wykonanych przez wszystkie zadania w zadaniu. |
startTime |
string |
Godzina rozpoczęcia zakresu czasu objętego statystykami. |
url |
string |
Adres URL statystyk. |
userCPUTime |
string |
Łączny czas procesora CPU w trybie użytkownika (zsumowany na wszystkich rdzeniach i wszystkich węzłach obliczeniowych) używany przez wszystkie zadania w zadaniu. |
waitTime |
string |
Łączny czas oczekiwania wszystkich zadań w zadaniu. |
wallClockTime |
string |
Łączny czas zegara ściany wszystkich zadań w zadaniu. |
writeIOGiB |
number |
Łączna ilość danych w giB zapisywana na dysku przez wszystkie zadania w zadaniu. |
writeIOps |
integer |
Całkowita liczba operacji zapisu na dysku wykonanych przez wszystkie zadania w zadaniu. |
LinuxUserConfiguration
Właściwości używane do tworzenia konta użytkownika w węźle obliczeniowym systemu Linux.
Nazwa | Typ | Opis |
---|---|---|
gid |
integer |
Identyfikator grupy dla konta użytkownika. |
sshPrivateKey |
string |
Klucz prywatny SSH dla konta użytkownika. |
uid |
integer |
Identyfikator użytkownika konta użytkownika. |
LoginMode
Tryb logowania użytkownika
Nazwa | Typ | Opis |
---|---|---|
batch |
string |
Tryb logowania LOGON32_LOGON_BATCH Win32. Tryb logowania wsadowego jest zalecany w przypadku długotrwałych procesów równoległych. |
interactive |
string |
Tryb logowania LOGON32_LOGON_INTERACTIVE Win32. Kontrola konta użytkownika jest włączona w pulach Windows VirtualMachineConfiguration. Jeśli ta opcja jest używana z tożsamością użytkownika z podwyższonym poziomem uprawnień w puli Windows VirtualMachineConfiguration, sesja użytkownika nie zostanie podwyższona, chyba że aplikacja wykonywana przez wiersz polecenia zadania jest skonfigurowana tak, aby zawsze wymagała uprawnień administracyjnych lub zawsze wymagać maksymalnego uprawnień. |
ManagedDisk
Nazwa | Typ | Opis |
---|---|---|
storageAccountType |
Typ konta magazynu dla dysku zarządzanego. |
MetadataItem
Para nazwa-wartość skojarzona z zasobem usługi Batch.
Nazwa | Typ | Opis |
---|---|---|
name |
string |
Nazwa elementu metadanych. |
value |
string |
Wartość elementu metadanych. |
MountConfiguration
System plików do zainstalowania w każdym węźle.
Nazwa | Typ | Opis |
---|---|---|
azureBlobFileSystemConfiguration |
Kontener usługi Azure Storage do zainstalowania przy użyciu funkcji FUSE obiektu blob w każdym węźle. |
|
azureFileShareConfiguration |
Udział plików platformy Azure do zainstalowania w każdym węźle. |
|
cifsMountConfiguration |
System plików CIFS/SMB do zainstalowania w każdym węźle. |
|
nfsMountConfiguration |
System plików NFS do zainstalowania w każdym węźle. |
NameValuePair
Reprezentuje parę nazwa-wartość.
Nazwa | Typ | Opis |
---|---|---|
name |
string |
Nazwa w parze name-value. |
value |
string |
Wartość w parze name-value. |
NetworkConfiguration
Konfiguracja sieci dla puli.
Nazwa | Typ | Opis |
---|---|---|
dynamicVNetAssignmentScope |
Zakres dynamicznego przypisania sieci wirtualnej. |
|
enableAcceleratedNetworking |
boolean |
Określa, czy ta pula powinna włączyć przyspieszoną sieć. |
endpointConfiguration |
Konfiguracja punktów końcowych w węzłach obliczeniowych w puli usługi Batch. |
|
publicIPAddressConfiguration |
Konfiguracja publicznego adresu IP Dla węzłów obliczeniowych w puli usługi Batch. |
|
subnetId |
string |
Identyfikator zasobu usługi ARM podsieci sieci wirtualnej, do której zostaną przyłączone węzły obliczeniowe puli. Jest to formularz /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. |
NetworkSecurityGroupRule
Reguła sieciowej grupy zabezpieczeń, która ma być stosowana do przychodzącego punktu końcowego.
Nazwa | Typ | Opis |
---|---|---|
access |
Akcja, która powinna zostać podjęta dla określonego adresu IP, zakresu podsieci lub tagu. |
|
priority |
integer |
Priorytet dla tej reguły. |
sourceAddressPrefix |
string |
Prefiks lub tag adresu źródłowego zgodny z regułą. |
sourcePortRanges |
string[] |
Zakresy portów źródłowych pasujące do reguły. |
NetworkSecurityGroupRuleAccess
Akcja, która powinna zostać podjęta dla określonego adresu IP, zakresu podsieci lub tagu.
Nazwa | Typ | Opis |
---|---|---|
allow |
string |
Zezwalaj na dostęp. |
deny |
string |
Odmowa dostępu. |
NFSMountConfiguration
Informacje używane do nawiązywania połączenia z systemem plików NFS.
Nazwa | Typ | Opis |
---|---|---|
mountOptions |
string |
Dodatkowe opcje wiersza polecenia umożliwiające przekazanie polecenia instalacji. |
relativeMountPath |
string |
Ścieżka względna w węźle obliczeniowym, w którym zostanie zainstalowany system plików |
source |
string |
Identyfikator URI systemu plików do zainstalowania. |
NodeCommunicationMode
Określa sposób komunikowania się puli z usługą Batch.
Nazwa | Typ | Opis |
---|---|---|
classic |
string |
Węzły korzystające z klasycznego trybu komunikacji 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ą wychodzącej komunikacji TCP na porcie 443 do "BatchNodeManagement. {region}" tag usługi. Nie są wymagane otwarte porty przychodzące. |
NodePlacementConfiguration
Konfiguracja umieszczania węzła dla puli.
Nazwa | Typ | Opis |
---|---|---|
policy |
Typ zasad umieszczania węzła w pulach usługi Batch. |
NodePlacementPolicyType
Zasady umieszczania dla przydzielania węzłów w puli.
Nazwa | Typ | Opis |
---|---|---|
regional |
string |
Wszystkie węzły w puli zostaną przydzielone w tym samym regionie. |
zonal |
string |
Węzły w puli będą rozmieszczone w różnych strefach dostępności z najlepszym rozwiązaniem. |
OnAllTasksComplete
Akcja, jaką usługa Batch powinna wykonać, gdy wszystkie zadania w zadaniu są w stanie ukończonym.
Nazwa | Typ | Opis |
---|---|---|
noaction |
string |
Nic nie robić. Zadanie pozostaje aktywne, chyba że zostało przerwane lub wyłączone w inny sposób. |
terminatejob |
string |
Zakończ zadanie. Parametr terminateReason zadania jest ustawiony na wartość "AllTasksComplete". |
OnTaskFailure
Akcja, jaką usługa Batch powinna wykonać, gdy dowolne zadanie w zadaniu zakończy się niepowodzeniem.
Nazwa | Typ | Opis |
---|---|---|
noaction |
string |
Nic nie robić. Zadanie pozostaje aktywne, chyba że zostało przerwane lub wyłączone w inny sposób. |
performexitoptionsjobaction |
string |
Wykonaj akcję skojarzona z warunkiem zakończenia zadania w kolekcji ExitConditions zadania. (Może to spowodować, że nie zostanie podjęta żadna akcja, jeśli jest to określone zadanie). |
OSDisk
Ustawienia dysku systemu operacyjnego węzła obliczeniowego (VM).
Nazwa | Typ | Opis |
---|---|---|
caching |
Określa wymagania dotyczące buforowania. Możliwe wartości to: Brak, ReadOnly, ReadWrite. Wartości domyślne to: Brak dla magazynu w warstwie Standardowa. ReadOnly dla usługi Premium Storage. |
|
diskSizeGB |
integer |
Początkowy rozmiar dysku w GB podczas tworzenia nowego dysku systemu operacyjnego. |
ephemeralOSDiskSettings |
Określa efemeryczne ustawienia dysku systemu operacyjnego używanego przez węzeł obliczeniowy (VM). |
|
managedDisk |
Parametry dysku zarządzanego. |
|
writeAcceleratorEnabled |
boolean |
Określa, czy na dysku należy włączyć lub wyłączyć funkcję writeAccelerator. |
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 |
Miejsce docelowe plików wyjściowych. |
|
filePattern |
string |
Wzorzec wskazujący, które pliki mają być przekazywane. |
uploadOptions |
Dodatkowe opcje operacji przekazywania, w tym na jakich warunkach należy wykonać przekazywanie. |
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. |
identityReference |
Odwołanie do tożsamości przypisanej przez użytkownika w celu uzyskania dostępu do Azure Blob Storage określonych przez containerUrl |
|
path |
string |
Docelowy obiekt blob lub katalog wirtualny w kontenerze usługi Azure Storage. |
uploadHeaders |
Lista par nazwa-wartość dla nagłówków, które mają być używane w przekazywaniu plików wyjściowych |
OutputFileDestination
Miejsce docelowe, do którego ma zostać przekazany plik.
Nazwa | Typ | Opis |
---|---|---|
container |
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 do wykonania przekazywania.
Nazwa | Typ | Opis |
---|---|---|
uploadCondition |
Warunki, w których należy przekazać plik wyjściowy zadania lub zestaw plików. |
PoolEndpointConfiguration
Konfiguracja punktu końcowego dla puli.
Nazwa | Typ | Opis |
---|---|---|
inboundNATPools |
Lista pul nat dla ruchu przychodzącego, których można użyć do adresowania określonych portów na pojedynczym węźle obliczeniowym zewnętrznie. |
PoolInformation
Określa sposób przypisania zadania do puli.
Nazwa | Typ | Opis |
---|---|---|
autoPoolSpecification |
Cechy tymczasowej "automatycznej puli". Usługa Batch utworzy tę automatyczną pulę po przesłaniu zadania. |
|
poolId |
string |
Identyfikator istniejącej puli. Wszystkie zadania zadania zadania zostaną uruchomione w określonej puli. |
PoolLifetimeOption
Minimalny okres istnienia utworzonych automatycznych pul oraz sposób przypisywaniu wielu zadań zgodnie z harmonogramem do pul.
Nazwa | Typ | Opis |
---|---|---|
job |
string |
Pula istnieje przez cały okres istnienia zadania, do którego jest ona dedykowana. Usługa Batch tworzy pulę podczas tworzenia zadania. Jeśli opcja "job" jest stosowana do harmonogramu zadań, usługa Batch tworzy nową automatyczną pulę dla każdego zadania utworzonego zgodnie z harmonogramem. |
jobschedule |
string |
Pula istnieje przez okres istnienia harmonogramu zadań. Usługa Batch tworzy pulę podczas tworzenia pierwszego zadania zgodnie z harmonogramem. Tę opcję można zastosować tylko do harmonogramów zadań, a nie do zadań. |
PoolSpecification
Specyfikacja tworzenia nowej puli.
Nazwa | Typ | Opis |
---|---|---|
applicationLicenses |
string[] |
Lista licencji aplikacji udostępnianych przez usługę Batch w każdym węźle obliczeniowym w puli. |
applicationPackageReferences |
Lista pakietów do zainstalowania w każdym węźle obliczeniowym w puli. |
|
autoScaleEvaluationInterval |
string |
Interwał czasu, w którym ma automatycznie dostosować rozmiar puli zgodnie z formułą autoskalowania. |
autoScaleFormula |
string |
Formuła żądanej liczby węzłów obliczeniowych w puli. |
certificateReferences |
Lista certyfikatów do zainstalowania w każdym węźle obliczeniowym w puli. Ostrzeżenie: Ta właściwość jest przestarzała i zostanie usunięta po lutym 2024 r. Zamiast tego użyj rozszerzenia Azure KeyVault . |
|
cloudServiceConfiguration |
Konfiguracja usługi w chmurze dla puli. |
|
displayName |
string |
Nazwa wyświetlana puli. |
enableAutoScale |
boolean |
Określa, czy rozmiar puli powinien być automatycznie dostosowywany w czasie. |
enableInterNodeCommunication |
boolean |
Czy pula zezwala na bezpośrednią komunikację między węzłami obliczeniowymi. |
metadata |
Lista par nazwa-wartość skojarzona z pulą jako metadanymi. |
|
mountConfiguration |
Lista systemów plików do zainstalowania w każdym węźle w puli. |
|
networkConfiguration |
Konfiguracja sieci dla puli. |
|
resizeTimeout |
string |
Limit czasu alokacji węzłów obliczeniowych do puli. |
resourceTags |
object |
Tagi określone przez użytkownika skojarzone z pulą. |
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 ponownego uruchomienia węzła obliczeniowego. |
|
targetDedicatedNodes |
integer |
Żądana liczba dedykowanych węzłów obliczeniowych w puli. |
targetLowPriorityNodes |
integer |
Żądana liczba węzłów obliczeniowych typu spot/low-priority w puli. |
targetNodeCommunicationMode |
Żądany tryb komunikacji węzła dla puli. |
|
taskSchedulingPolicy |
Sposób dystrybucji zadań między węzłami obliczeniowymi w puli. |
|
taskSlotsPerNode |
integer |
Liczba miejsc zadań, których można użyć do uruchamiania współbieżnych zadań w jednym węźle obliczeniowym w puli. |
userAccounts |
Lista kont użytkowników do utworzenia w każdym węźle obliczeniowym w puli. |
|
virtualMachineConfiguration |
Konfiguracja maszyny wirtualnej dla puli. |
|
vmSize |
string |
Rozmiar maszyn wirtualnych w puli. Wszystkie maszyny wirtualne w puli mają taki sam rozmiar. |
PublicIPAddressConfiguration
Konfiguracja publicznego adresu IP konfiguracji sieci puli.
Nazwa | Typ | Opis |
---|---|---|
ipAddressIds |
string[] |
Lista publicznych adresów IP, których usługa Batch będzie używać podczas aprowizacji węzłów obliczeniowych. |
provision |
Typ aprowizacji dla publicznych adresów IP dla puli. |
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. |
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. |
fileMode |
string |
Atrybut trybu uprawnień pliku w formacie ósemkowym. |
filePath |
string |
Lokalizacja węzła obliczeniowego, do którego mają być pobierane pliki względem katalogu roboczego zadania. |
httpUrl |
string |
Adres URL pliku do pobrania. |
identityReference |
Odwołanie do tożsamości przypisanej przez użytkownika do użycia w celu uzyskania dostępu do Azure Blob Storage określonego przez storageContainerUrl lub httpUrl |
|
storageContainerUrl |
string |
Adres URL kontenera obiektów blob w Azure Blob Storage. |
SecurityProfile
Określa ustawienia profilu zabezpieczeń dla maszyny wirtualnej lub zestawu skalowania maszyn wirtualnych.
Nazwa | Typ | Opis |
---|---|---|
encryptionAtHost |
boolean |
Ta właściwość może być używana przez użytkownika w żądaniu włączenia lub wyłączenia szyfrowania hosta dla maszyny wirtualnej lub zestawu skalowania maszyn wirtualnych. Spowoduje to włączenie szyfrowania dla wszystkich dysków, w tym dysku zasobu/tempa na samym hoście. |
securityType |
Określa typ zabezpieczeń maszyny wirtualnej. Musi być ustawiona na dowolną określoną wartość, aby włączyć funkcję UefiSettings. |
|
uefiSettings |
Określa ustawienia zabezpieczeń, takie jak bezpieczny rozruch i vTPM używane podczas tworzenia maszyny wirtualnej. |
SecurityTypes
Określa typ zabezpieczeń maszyny wirtualnej. Należy ustawić ją na dowolną określoną wartość, aby włączyć funkcję UefiSettings.
Nazwa | Typ | Opis |
---|---|---|
trustedLaunch |
string |
Zaufane uruchamianie chroni przed zaawansowanymi i trwałymi technikami ataków. |
ServiceArtifactReference
Określa identyfikator odwołania artefaktu usługi używany do ustawiania tej samej wersji obrazu dla wszystkich maszyn wirtualnych w zestawie skalowania podczas korzystania z wersji obrazu "latest".
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator odwołania do artefaktu usługi serviceArtifactReference |
StartTask
Zadanie uruchamiane po dołączeniu węzła do puli w usłudze Azure Batch lub po ponownym uruchomieniu lub ponownym uruchomieniu węzła obliczeniowego lub ponownym obrazie.
Nazwa | Typ | Opis |
---|---|---|
commandLine |
string |
Wiersz polecenia starttask. |
containerSettings |
Ustawienia kontenera, w którym jest uruchamiana funkcja StartTask. |
|
environmentSettings |
Lista ustawień zmiennych środowiskowych dla elementu StartTask. |
|
maxTaskRetryCount |
integer |
Maksymalna liczba ponownych prób wykonania zadania. |
resourceFiles |
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 ResourceFiles. Można to osiągnąć przy użyciu plików .zip, pakietów aplikacji lub kontenerów platformy Docker. |
|
userIdentity |
Tożsamość użytkownika, w ramach której jest uruchamiana funkcja StartTask. |
|
waitForSuccess |
boolean |
Określa, czy usługa Batch powinna czekać na pomyślne zakończenie zadania StartTask (czyli zakończenie pracy z kodem zakończenia 0) przed zaplanowaniem jakichkolwiek zadań w węźle obliczeniowym. |
StorageAccountType
Typ konta magazynu do użycia podczas tworzenia dysków danych lub dysku systemu operacyjnego.
Nazwa | Typ | Opis |
---|---|---|
premium_lrs |
string |
Dysk danych/dysk systemu operacyjnego powinien używać magazynu lokalnie nadmiarowego w warstwie Premium. |
standard_lrs |
string |
Dysk danych/dysk systemu operacyjnego powinien używać standardowego magazynu lokalnie nadmiarowego. |
standardssd_lrs |
string |
Dysk danych/dysk systemu operacyjnego powinien używać magazynu lokalnie nadmiarowego SSD w warstwie Standardowa. |
TaskConstraints
Ograniczenia wykonywania, które mają być stosowane do zadania.
Nazwa | Typ | Opis |
---|---|---|
maxTaskRetryCount |
integer |
Maksymalna liczba ponownych prób zadania. Usługa Batch ponawia próbę zadania, jeśli jego kod zakończenia jest niezerowy. |
maxWallClockTime |
string |
Maksymalny czas, który upłynął do uruchomienia zadania, mierzony od momentu uruchomienia zadania. Jeśli zadanie nie zostanie ukończone w ramach limitu czasu, usługa Batch go zakończy. |
retentionTime |
string |
Minimalny czas przechowywania katalogu zadań w węźle obliczeniowym, w którym został uruchomiony, od momentu ukończenia wykonywania. Po tym czasie usługa Batch może usunąć katalog Zadań i całą jego zawartość. |
TaskContainerSettings
Ustawienia kontenera dla zadania.
Nazwa | Typ | Opis |
---|---|---|
containerRunOptions |
string |
Dodatkowe opcje polecenia tworzenia kontenera. |
imageName |
string |
Obraz używany do utworzenia kontenera, w którym zostanie uruchomione zadanie. |
registry |
Rejestr prywatny zawierający obraz kontenera. |
|
workingDirectory |
Lokalizacja katalogu roboczego zadania kontenera. |
TaskSchedulingPolicy
Określa sposób dystrybucji zadań w węzłach obliczeniowych.
Nazwa | Typ | Opis |
---|---|---|
nodeFillType |
Jak zadania są dystrybuowane między węzłami obliczeniowymi w puli. |
UefiSettings
Określa ustawienia zabezpieczeń, takie jak bezpieczny rozruch i vTPM używane podczas tworzenia maszyny wirtualnej.
Nazwa | Typ | Opis |
---|---|---|
secureBootEnabled |
boolean |
Określa, czy bezpieczny rozruch powinien być włączony na maszynie wirtualnej. |
vTpmEnabled |
boolean |
Określa, czy maszyna wirtualna ma być włączona na maszynie wirtualnej. |
UserAccount
Właściwości używane do tworzenia użytkownika używanego do wykonywania zadań w węźle obliczeniowym Azure Batch.
Nazwa | Typ | Opis |
---|---|---|
elevationLevel |
Poziom podniesienia uprawnień konta użytkownika. |
|
linuxUserConfiguration |
Konfiguracja użytkownika specyficzna dla systemu Linux dla konta użytkownika. |
|
name |
string |
Nazwa konta użytkownika. Nazwy mogą zawierać dowolne znaki Unicode o maksymalnej długości do 20. |
password |
string |
Hasło do konta użytkownika. |
windowsUserConfiguration |
Konfiguracja użytkownika specyficznego dla systemu Windows dla konta użytkownika. |
UserIdentity
Definicja tożsamości użytkownika, w ramach której jest uruchamiane zadanie.
Nazwa | Typ | Opis |
---|---|---|
autoUser |
Użytkownik automatyczny, w ramach którego jest uruchamiane zadanie. |
|
username |
string |
Nazwa tożsamości użytkownika, w ramach której jest uruchamiane zadanie. |
VirtualMachineConfiguration
Konfiguracja węzłów obliczeniowych w puli na podstawie infrastruktury usługi Azure Virtual Machines.
Nazwa | Typ | Opis |
---|---|---|
containerConfiguration |
Konfiguracja kontenera dla puli. |
|
dataDisks |
Data |
Konfiguracja dysków danych dołączonych do węzłów obliczeniowych w puli. |
diskEncryptionConfiguration |
Konfiguracja szyfrowania dysków dla puli. |
|
extensions |
Rozszerzenie maszyny wirtualnej dla puli. |
|
imageReference |
Odwołanie do obrazu witryny Azure Virtual Machines Marketplace lub niestandardowego obrazu maszyny wirtualnej do użycia. |
|
licenseType |
string |
Typ licencji lokalnej, która ma być używana podczas wdrażania systemu operacyjnego. Windows_Server — licencja lokalna dotyczy systemu Windows Server. Windows_Client — licencja lokalna jest dla klienta systemu Windows. |
nodeAgentSKUId |
string |
Jednostka SKU agenta węzła obliczeniowego usługi Batch, która ma być aprowizowana w węzłach obliczeniowych w puli. |
nodePlacementConfiguration |
Konfiguracja umieszczania węzłów dla puli. |
|
osDisk |
Ustawienia dysku systemu operacyjnego maszyny wirtualnej. |
|
securityProfile |
Określa ustawienia profilu zabezpieczeń dla maszyny wirtualnej lub zestawu skalowania maszyn wirtualnych. |
|
serviceArtifactReference |
Określa identyfikator odwołania do artefaktu usługi używany do ustawiania tej samej wersji obrazu dla wszystkich maszyn wirtualnych w zestawie skalowania w przypadku używania "najnowszej" wersji obrazu. |
|
windowsConfiguration |
Ustawienia systemu operacyjnego Windows na maszynie wirtualnej. |
VMExtension
Konfiguracja rozszerzeń maszyn wirtualnych.
Nazwa | Typ | Opis |
---|---|---|
autoUpgradeMinorVersion |
boolean |
Wskazuje, czy rozszerzenie powinno używać nowszej wersji pomocniczej, jeśli jest ona dostępna w czasie wdrażania. Po wdrożeniu rozszerzenie nie będzie jednak uaktualniać wersji pomocniczych, chyba że zostanie ponownie wdrożone, nawet jeśli ta właściwość ma wartość true. |
enableAutomaticUpgrade |
boolean |
Wskazuje, czy rozszerzenie powinno zostać automatycznie uaktualnione przez platformę, jeśli dostępna jest nowsza wersja rozszerzenia. |
name |
string |
Nazwa rozszerzenia maszyny wirtualnej. |
protectedSettings |
object |
Rozszerzenie może zawierać ustawienia protectedSettings lub protectedSettingsFromKeyVault lub w ogóle nie są chronione. |
provisionAfterExtensions |
string[] |
Kolekcja nazw rozszerzeń. |
publisher |
string |
Nazwa wydawcy programu obsługi rozszerzeń. |
settings |
object |
Ustawienia publiczne w formacie JSON dla rozszerzenia. |
type |
string |
Typ rozszerzenia. |
typeHandlerVersion |
string |
Wersja programu obsługi skryptów. |
WindowsConfiguration
Ustawienia systemu operacyjnego Windows do zastosowania do maszyny wirtualnej.
Nazwa | Typ | Opis |
---|---|---|
enableAutomaticUpdates |
boolean |
Określa, czy aktualizacje automatyczne są włączone na maszynie wirtualnej. |
WindowsUserConfiguration
Właściwości używane do tworzenia konta użytkownika w węźle obliczeniowym systemu Windows.
Nazwa | Typ | Opis |
---|---|---|
loginMode |
Tryb logowania użytkownika |