Compute Node - List
Wyświetla listę węzłów obliczeniowych w określonej puli.
GET {batchUrl}/pools/{poolId}/nodes?api-version=2023-11-01.18.0
GET {batchUrl}/pools/{poolId}/nodes?$filter={$filter}&$select={$select}&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. |
pool
|
path | True |
string |
Identyfikator puli, z której chcesz wyświetlić listę węzłów obliczeniowych. |
api-version
|
query | True |
string |
Wersja interfejsu API klienta. |
$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-nodes-in-a-pool. |
|
$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 węzłów obliczeniowych. |
|
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ę węzłów obliczeniowych. Headers
|
|
Other Status Codes |
Błąd usługi Batch. |
Zabezpieczenia
azure_auth
Microsoft Entra przepływ kodu uwierzytelniania OAuth 2.0
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
Node list
Sample Request
GET account.region.batch.azure.com/pools/poolId/nodes?api-version=2023-11-01.18.0
Sample Response
{
"value": [
{
"id": "tvm-1695681911_1-20161122t193202z",
"url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z",
"state": "idle",
"schedulingState": "enabled",
"stateTransitionTime": "2016-11-22T22:22:27.2236818Z",
"lastBootTime": "2016-11-22T22:22:24.4634125Z",
"allocationTime": "2016-11-22T19:32:02.8155319Z",
"ipAddress": "1.1.1.1",
"affinityId": "TVM:tvm-1695681911_1-20161122t193202z",
"vmSize": "small",
"totalTasksRun": 0,
"totalTasksSucceeded": 0,
"runningTasksCount": 0,
"runningTaskSlotsCount": 0,
"isDedicated": true,
"startTask": {
"commandLine": "cmd /c echo hello",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"startTaskInfo": {
"state": "completed",
"startTime": "2016-11-22T22:22:27.2236818Z",
"endTime": "2016-11-22T22:22:27.567189Z",
"exitCode": 0,
"retryCount": 0
},
"nodeAgentInfo": {
"version": "1.2.0.0",
"lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
}
},
{
"id": "tvm-1695681911_2-20161122t193202z",
"url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z",
"state": "idle",
"schedulingState": "enabled",
"stateTransitionTime": "2016-11-22T19:37:31.4285526Z",
"lastBootTime": "2016-11-22T19:37:28.623369Z",
"allocationTime": "2016-11-22T19:32:02.8155319Z",
"ipAddress": "1.1.1.1",
"affinityId": "TVM:tvm-1695681911_2-20161122t193202z",
"vmSize": "small",
"totalTasksRun": 0,
"totalTasksSucceeded": 0,
"runningTasksCount": 0,
"runningTaskSlotsCount": 0,
"isDedicated": true,
"startTask": {
"commandLine": "cmd /c echo hello",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"startTaskInfo": {
"state": "completed",
"startTime": "2016-11-22T19:37:31.4285526Z",
"endTime": "2016-11-22T19:37:31.838028Z",
"exitCode": 0,
"retryCount": 0
},
"nodeAgentInfo": {
"version": "1.2.0.0",
"lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
}
},
{
"id": "tvm-1695681911_3-20161122t193202z",
"url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z",
"state": "idle",
"schedulingState": "enabled",
"stateTransitionTime": "2016-11-22T19:36:51.0013378Z",
"lastBootTime": "2016-11-22T19:36:48.21721Z",
"allocationTime": "2016-11-22T19:32:02.8155319Z",
"ipAddress": "1.1.1.1",
"affinityId": "TVM:tvm-1695681911_3-20161122t193202z",
"vmSize": "small",
"totalTasksRun": 0,
"totalTasksSucceeded": 0,
"runningTasksCount": 0,
"runningTaskSlotsCount": 0,
"isDedicated": true,
"startTask": {
"commandLine": "cmd /c echo hello",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"startTaskInfo": {
"state": "completed",
"startTime": "2016-11-22T19:36:51.0013378Z",
"endTime": "2016-11-22T19:36:51.2363447Z",
"exitCode": 0,
"retryCount": 0
},
"nodeAgentInfo": {
"version": "1.2.0.0",
"lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
}
}
]
}
Definicje
Nazwa | Opis |
---|---|
Auto |
Zakres dla użytkownika automatycznego |
Auto |
Określa parametry dla użytkownika automatycznego, który uruchamia zadanie w usłudze Batch. |
Batch |
Odpowiedź o błędzie odebrana z usługi Azure Batch. |
Batch |
Element dodatkowych informacji zawartych w odpowiedzi Azure Batch błędu. |
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. |
Compute |
Węzeł obliczeniowy w usłudze Batch. |
Compute |
Konfiguracja punktu końcowego dla węzła obliczeniowego. |
Compute |
Błąd napotkany przez węzeł obliczeniowy. |
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. |
Compute |
Wynik wyświetlania listy węzłów obliczeniowych w puli. |
Compute |
Bieżący stan węzła obliczeniowego. |
Container |
Prywatny rejestr kontenerów. |
Container |
Lokalizacja katalogu roboczego zadania kontenera. |
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. |
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 |
Przychodzący punkt końcowy w węźle obliczeniowym. |
Inbound |
Protokół punktu końcowego. |
Name |
Reprezentuje parę name-value. |
Node |
Informacje o agencie węzła obliczeniowego. |
Resource |
Jeden plik lub wiele plików do pobrania do węzła obliczeniowego. |
Scheduling |
Czy węzeł obliczeniowy jest dostępny do planowania zadań. |
Start |
Zadanie, które jest uruchamiane, gdy węzeł dołącza do puli w usłudze Azure Batch lub gdy węzeł obliczeniowy jest ponownie uruchamiany lub odtwarzany. |
Start |
Informacje o startTask uruchomionym w węźle obliczeniowym. |
Start |
Stan StartTask w węźle obliczeniowym. |
Task |
Zawiera informacje o kontenerze, który wykonuje zadanie. |
Task |
Ustawienia kontenera dla zadania. |
Task |
Informacje o wykonywaniu zadania. |
Task |
Wynik wykonania zadania. |
Task |
Informacje o niepowodzeniu zadania. |
Task |
Informacje o zadaniu uruchomionym w węźle obliczeniowym. |
Task |
Stan zadania. |
User |
Definicja tożsamości użytkownika, w ramach której jest uruchamiane zadanie. |
Virtual |
Informacje o bieżącym stanie maszyny wirtualnej. |
AutoUserScope
Zakres dla 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 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 |
BatchError
Odpowiedź o błędzie odebrana 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 Azure Batch błędu.
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 |
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 zdalnie uzyskują 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ń. |
ComputeNode
Węzeł obliczeniowy w usłudze Batch.
Nazwa | Typ | Opis |
---|---|---|
affinityId |
string |
Identyfikator, który można przekazać podczas dodawania zadania, aby zażądać, aby zadanie było zaplanowane w tym węźle obliczeniowym. |
allocationTime |
string |
Czas, w którym ten węzeł obliczeniowy został przydzielony do puli. |
certificateReferences |
Lista certyfikatów zainstalowanych w węźle obliczeniowym. Ostrzeżenie: Ta właściwość jest przestarzała i zostanie usunięta po lutym 2024 r. Zamiast tego użyj rozszerzenia Azure KeyVault . |
|
endpointConfiguration |
Konfiguracja punktu końcowego dla węzła obliczeniowego. |
|
errors |
Lista błędów, które są obecnie napotykane przez węzeł obliczeniowy. |
|
id |
string |
Identyfikator węzła obliczeniowego. |
ipAddress |
string |
Adres IP używany przez inne węzły do komunikowania się z tym węzłem obliczeniowym. |
isDedicated |
boolean |
Czy ten węzeł obliczeniowy jest dedykowanym węzłem obliczeniowym. Jeśli wartość false, węzeł obliczeniowy jest węzłem obliczeniowym typu spot/low-priority. |
lastBootTime |
string |
Czas ostatniego uruchomienia węzła obliczeniowego. |
nodeAgentInfo |
Informacje o wersji agenta węzła obliczeniowego i czasie uaktualniania węzła obliczeniowego do nowej wersji. |
|
recentTasks |
Lista zadań, których stan został niedawno zmieniony. |
|
runningTaskSlotsCount |
integer |
Całkowita liczba miejsc planowania używanych przez aktualnie uruchomione zadania podrzędne w węźle obliczeniowym. Obejmuje to zadania menedżera zadań i zadania normalne, ale nie przygotowanie zadania, wydanie zadania lub zadania podrzędne uruchamiania. |
runningTasksCount |
integer |
Całkowita liczba aktualnie uruchomionych zadań w węźle obliczeniowym. Obejmuje to zadania menedżera zadań i zadania normalne, ale nie przygotowanie zadania, wydanie zadania lub zadania podrzędne uruchamiania. |
schedulingState |
Czy węzeł obliczeniowy jest dostępny do planowania zadań. |
|
startTask |
Zadanie określone do uruchomienia w węźle obliczeniowym podczas dołączania do puli. |
|
startTaskInfo |
Informacje o środowisku uruchomieniowym dotyczące wykonywania elementu StartTask w węźle obliczeniowym. |
|
state |
Bieżący stan węzła obliczeniowego. |
|
stateTransitionTime |
string |
Czas, w którym węzeł obliczeniowy wprowadził bieżący stan. |
totalTasksRun |
integer |
Całkowita liczba zadań zakończonych w węźle obliczeniowym. Obejmuje to zadania menedżera zadań i zadania normalne, ale nie przygotowanie zadania, wydanie zadania lub zadania podrzędne uruchamiania. |
totalTasksSucceeded |
integer |
Całkowita liczba zadań zakończonych pomyślnie (z kodem exitCode 0) w węźle obliczeniowym. Obejmuje to zadania menedżera zadań i zadania normalne, ale nie przygotowanie zadania, wydanie zadania lub zadania podrzędne uruchamiania. |
url |
string |
Adres URL węzła obliczeniowego. |
virtualMachineInfo |
Informacje o bieżącym stanie maszyny wirtualnej. |
|
vmSize |
string |
Rozmiar maszyny wirtualnej hostująca węzeł obliczeniowy. |
ComputeNodeEndpointConfiguration
Konfiguracja punktu końcowego dla węzła obliczeniowego.
Nazwa | Typ | Opis |
---|---|---|
inboundEndpoints |
Lista przychodzących punktów końcowych, które są dostępne w węźle obliczeniowym. |
ComputeNodeError
Błąd napotkany przez węzeł obliczeniowy.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Identyfikator błędu węzła obliczeniowego. Kody są niezmienne i mają być używane programowo. |
errorDetails |
Lista dodatkowych szczegółów błędu związanych z błędem węzła obliczeniowego. |
|
message |
string |
Komunikat opisujący błąd węzła obliczeniowego, który ma być odpowiedni do wyświetlania w interfejsie użytkownika. |
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. |
ComputeNodeListResult
Wynik wyświetlania listy węzłów obliczeniowych w puli.
Nazwa | Typ | Opis |
---|---|---|
odata.nextLink |
string |
Adres URL umożliwiający uzyskanie następnego zestawu wyników. |
value |
Lista węzłów obliczeniowych. |
ComputeNodeState
Bieżący stan węzła obliczeniowego.
Nazwa | Typ | Opis |
---|---|---|
creating |
string |
Usługa Batch uzyskała podstawową maszynę wirtualną z usługi Azure Compute, ale nie zaczęła jeszcze dołączać do puli. |
idle |
string |
Węzeł obliczeniowy nie jest obecnie uruchomiony zadanie. |
leavingpool |
string |
Węzeł obliczeniowy opuszcza pulę, ponieważ użytkownik jawnie go usunął lub ponieważ pula zmienia rozmiar lub skalowanie automatyczne w dół. |
offline |
string |
Węzeł obliczeniowy nie jest obecnie uruchomiony zadanie, a planowanie nowych zadań w węźle obliczeniowym jest wyłączone. |
preempted |
string |
Węzeł obliczeniowy typu spot/low-priority został wywłaszczone. Zadania, które były uruchomione w węźle obliczeniowym, gdy został wywłaszczone, zostaną ponownie zaplanowane po udostępnieniu innego węzła obliczeniowego. |
rebooting |
string |
Węzeł obliczeniowy jest uruchamiany ponownie. |
reimaging |
string |
Węzeł obliczeniowy jest ponownie wyobrażany. |
running |
string |
Węzeł obliczeniowy uruchamia co najmniej jedno zadanie (inne niż StartTask). |
starting |
string |
Usługa Batch uruchamia się na podstawowej maszynie wirtualnej. |
starttaskfailed |
string |
Element StartTask zakończył się niepowodzeniem w węźle obliczeniowym (i wyczerpał wszystkie ponownych prób), a właściwość waitForSuccess jest ustawiona. Węzeł obliczeniowy nie może być używany do uruchamiania zadań. |
unknown |
string |
Usługa Batch utraciła kontakt z węzłem obliczeniowym i nie zna swojego prawdziwego stanu. |
unusable |
string |
Nie można użyć węzła obliczeniowego do wykonania zadania z powodu błędów. |
waitingforstarttask |
string |
Usługa StartTask została uruchomiona w węźle obliczeniowym, ale parametr waitForSuccess jest ustawiony, a element StartTask nie został jeszcze ukończony. |
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. |
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. |
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. |
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. |
InboundEndpoint
Przychodzący punkt końcowy w węźle obliczeniowym.
Nazwa | Typ | Opis |
---|---|---|
backendPort |
integer |
Numer portu zaplecza punktu końcowego. |
frontendPort |
integer |
Numer portu publicznego punktu końcowego. |
name |
string |
Nazwa punktu końcowego. |
protocol |
Protokół punktu końcowego. |
|
publicFQDN |
string |
Publiczna w pełni kwalifikowana nazwa domeny węzła obliczeniowego. |
publicIPAddress |
string |
Publiczny adres IP węzła obliczeniowego. |
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. |
NameValuePair
Reprezentuje parę name-value.
Nazwa | Typ | Opis |
---|---|---|
name |
string |
Nazwa w parze name-value. |
value |
string |
Wartość w parze name-value. |
NodeAgentInformation
Informacje o agencie węzła obliczeniowego.
Nazwa | Typ | Opis |
---|---|---|
lastUpdateTime |
string |
Czas aktualizacji agenta węzła obliczeniowego w węźle obliczeniowym. |
version |
string |
Wersja agenta węzła obliczeniowego usługi Batch uruchomionego w węźle obliczeniowym. |
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 węźle obliczeniowym, 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 w celu uzyskania dostępu do Azure Blob Storage określonej przez storageContainerUrl lub httpUrl |
|
storageContainerUrl |
string |
Adres URL kontenera obiektów blob w Azure Blob Storage. |
SchedulingState
Czy węzeł obliczeniowy jest dostępny do planowania zadań.
Nazwa | Typ | Opis |
---|---|---|
disabled |
string |
Nie zostaną zaplanowane żadne nowe zadania w węźle obliczeniowym. Zadania już uruchomione w węźle obliczeniowym mogą być nadal uruchamiane do ukończenia. Wszystkie węzły obliczeniowe zaczynają się od włączonego planowania. |
enabled |
string |
Zadania można zaplanować w węźle obliczeniowym. |
StartTask
Zadanie, które jest uruchamiane, gdy węzeł dołącza do puli w usłudze Azure Batch lub gdy węzeł obliczeniowy jest ponownie uruchamiany lub odtwarzany.
Nazwa | Typ | Opis |
---|---|---|
commandLine |
string |
Wiersz polecenia starttask. |
containerSettings |
Ustawienia kontenera, w którym jest uruchamiana usługa StartTask. |
|
environmentSettings |
Lista ustawień zmiennych środowiskowych dla elementu StartTask. |
|
maxTaskRetryCount |
integer |
Maksymalna liczba ponownych prób 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 usługa StartTask. |
|
waitForSuccess |
boolean |
Czy usługa Batch powinna czekać na pomyślne ukończenie zadania StartTask (czyli zakończenie z kodem zakończenia 0) przed zaplanowaniem wszystkich zadań w węźle obliczeniowym. |
StartTaskInformation
Informacje o startTask uruchomionym w węźle obliczeniowym.
Nazwa | Typ | Opis |
---|---|---|
containerInfo |
Informacje o kontenerze, w którym jest wykonywane zadanie. |
|
endTime |
string |
Czas, w którym starttask przestał działać. |
exitCode |
integer |
Kod zakończenia programu określony w wierszu polecenia StartTask. |
failureInfo |
Informacje opisujące błąd zadania, jeśli istnieje. |
|
lastRetryTime |
string |
Ostatni raz, w którym rozpoczęto ponawianie zadania. |
result |
Wynik wykonania zadania. |
|
retryCount |
integer |
Liczba ponownych prób wykonania zadania przez usługę Batch. |
startTime |
string |
Czas rozpoczęcia działania starttask. |
state |
Stan StartTask w węźle obliczeniowym. |
StartTaskState
Stan StartTask w węźle obliczeniowym.
Nazwa | Typ | Opis |
---|---|---|
completed |
string |
Zadanie StartTask zakończyło się z kodem zakończenia 0 lub nie powiodło się zadanie StartTask i osiągnięto limit ponawiania prób lub proces StartTask nie został uruchomiony z powodu błędów przygotowania zadania (takich jak błędy pobierania pliku zasobu). |
running |
string |
Aplikacja StartTask jest obecnie uruchomiona. |
TaskContainerExecutionInformation
Zawiera informacje o kontenerze, który wykonuje zadanie.
Nazwa | Typ | Opis |
---|---|---|
containerId |
string |
Identyfikator kontenera. |
error |
string |
Szczegółowe informacje o błędzie dotyczące kontenera. |
state |
string |
Stan kontenera. |
TaskContainerSettings
Ustawienia kontenera dla zadania.
Nazwa | Typ | Opis |
---|---|---|
containerRunOptions |
string |
Dodatkowe opcje polecenia tworzenia kontenera. |
imageName |
string |
Obraz do użycia do utworzenia kontenera, w którym zostanie uruchomione zadanie. |
registry |
Rejestr prywatny zawierający obraz kontenera. |
|
workingDirectory |
Lokalizacja katalogu roboczego zadania kontenera. |
TaskExecutionInformation
Informacje o wykonywaniu zadania.
Nazwa | Typ | Opis |
---|---|---|
containerInfo |
Informacje o kontenerze, w którym jest wykonywane zadanie. |
|
endTime |
string |
Czas, w którym zadanie zostało ukończone. |
exitCode |
integer |
Kod zakończenia programu określonego w wierszu polecenia zadania. |
failureInfo |
Informacje opisujące błąd zadania, jeśli istnieje. |
|
lastRequeueTime |
string |
Ostatni raz, w którym zadanie zostało ponownie w kolejce przez usługę Batch w wyniku żądania użytkownika. |
lastRetryTime |
string |
Ostatni raz, w którym uruchomiono ponowną próbę zadania. |
requeueCount |
integer |
Liczba ponownych kolejek zadania przez usługę Batch w wyniku żądania użytkownika. |
result |
Wynik wykonania zadania. |
|
retryCount |
integer |
Liczba ponownych prób wykonania zadania przez usługę Batch. |
startTime |
string |
Czas, w którym zadanie zaczęło działać. |
TaskExecutionResult
Wynik wykonania zadania.
Nazwa | Typ | Opis |
---|---|---|
failure |
string |
Wystąpił błąd podczas przetwarzania zadania. Błąd mógł wystąpić przed uruchomieniem procesu zadania, podczas wykonywania procesu zadania lub po zakończeniu procesu zadania. |
success |
string |
Zadanie zakończyło się pomyślnie. |
TaskFailureInformation
Informacje o niepowodzeniu zadania.
Nazwa | Typ | Opis |
---|---|---|
category |
Kategoria błędu zadania. |
|
code |
string |
Identyfikator błędu zadania. Kody są niezmienne i mają być używane programowo. |
details |
Lista dodatkowych szczegółów związanych z błędem. |
|
message |
string |
Komunikat opisujący błąd zadania, który ma być odpowiedni do wyświetlania w interfejsie użytkownika. |
TaskInformation
Informacje o zadaniu uruchomionym w węźle obliczeniowym.
Nazwa | Typ | Opis |
---|---|---|
executionInfo |
Informacje o wykonywaniu zadania. |
|
jobId |
string |
Identyfikator zadania, do którego należy zadanie. |
subtaskId |
integer |
Identyfikator podzadaku, jeśli zadanie jest zadaniem z wieloma wystąpieniami. |
taskId |
string |
Identyfikator zadania. |
taskState |
Bieżący stan zadania. |
|
taskUrl |
string |
Adres URL zadania. |
TaskState
Stan zadania.
Nazwa | Typ | Opis |
---|---|---|
active |
string |
Zadanie jest w kolejce i można je uruchomić, ale nie jest obecnie przypisane do węzła obliczeniowego. Zadanie wprowadza ten stan po jego utworzeniu, gdy jest on włączony po wyłączeniu lub gdy oczekuje na ponowną próbę po nieudanym uruchomieniu. |
completed |
string |
Zadanie nie kwalifikuje się już do uruchomienia, zwykle dlatego, że zadanie zakończyło się pomyślnie lub zadanie zakończyło się niepowodzeniem i wyczerpało limit ponawiania prób. Zadanie jest również oznaczone jako ukończone, jeśli wystąpił błąd podczas uruchamiania zadania lub gdy zadanie zostało zakończone. |
preparing |
string |
Zadanie zostało przydzielone do węzła obliczeniowego, ale oczekuje na ukończenie wymaganego zadania przygotowania zadania w węźle obliczeniowym. Jeśli zadanie przygotowania zadania zakończy się pomyślnie, zadanie zostanie przeniesione do uruchomienia. Jeśli zadanie przygotowania zadania zakończy się niepowodzeniem, zadanie powróci do aktywnego i będzie kwalifikować się do przypisania do innego węzła obliczeniowego. |
running |
string |
Zadanie jest uruchomione w węźle obliczeniowym. Obejmuje to przygotowanie na poziomie zadania, takie jak pobieranie plików zasobów lub wdrażanie pakietów określonych w zadaniu — niekoniecznie oznacza to, że wiersz polecenia zadania rozpoczął wykonywanie. |
UserIdentity
Definicja tożsamości użytkownika, w ramach której jest uruchamiane zadanie.
Nazwa | Typ | Opis |
---|---|---|
autoUser |
Automatycznie użytkownik, w ramach którego jest uruchamiane zadanie. |
|
username |
string |
Nazwa tożsamości użytkownika, w ramach której jest uruchamiane zadanie. |
VirtualMachineInfo
Informacje o bieżącym stanie maszyny wirtualnej.
Nazwa | Typ | Opis |
---|---|---|
imageReference |
Odwołanie do obrazu witryny Marketplace maszyny wirtualnej platformy Azure. |
|
scaleSetVmResourceId |
string |
Identyfikator zasobu bieżącej maszyny wirtualnej zestawu skalowania maszyn wirtualnych węzła obliczeniowego. Zdefiniowano tylko wtedy, gdy konto usługi Batch zostało utworzone z właściwością poolAllocationMode ustawioną na wartość "UserSubscription". |