Udostępnij za pośrednictwem


Compute Node - List

Wyświetla listę węzłów obliczeniowych w określonej puli.

GET {batchUrl}/pools/{poolId}/nodes?api-version=2024-07-01.20.0
GET {batchUrl}/pools/{poolId}/nodes?$filter={$filter}&$select={$select}&maxresults={maxresults}&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, z której chcesz wyświetlić listę węzłów obliczeniowych.

api-version
query True

string

Wersja interfejsu API klienta.

$filter
query

string

Klauzula OData $filter. Aby uzyskać więcej informacji na temat konstruowania tego filtru, zobacz https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.

$select
query

string

Klauzula OData $select.

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

Odpowiedzi

Nazwa Typ Opis
200 OK

ComputeNodeListResult

Odpowiedź zawierająca listę węzłów obliczeniowych.

Nagłówki

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: 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

Node list

Przykładowe żądanie

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


Przykładowa odpowiedź

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

ComputeNode

Węzeł obliczeniowy w usłudze Batch.

ComputeNodeEndpointConfiguration

Konfiguracja punktu końcowego dla węzła obliczeniowego.

ComputeNodeError

Błąd napotkany przez węzeł obliczeniowy.

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.

ComputeNodeListResult

Wynik wyświetlania listy węzłów obliczeniowych w puli.

ComputeNodeState

Bieżący stan węzła obliczeniowego.

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.

ErrorCategory

Kategoria błędu.

ErrorMessage

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

ImageReference

Odwołanie do obrazu witryny Marketplace usługi Azure Virtual Machines lub obrazu galerii obliczeniowej platformy Azure. Aby uzyskać listę wszystkich odwołań do obrazów witryny Azure Marketplace zweryfikowanych przez usługę Azure Batch, zobacz operację "Lista obsługiwanych obrazów".

InboundEndpoint

Przychodzący punkt końcowy w węźle obliczeniowym.

InboundEndpointProtocol

Protokół punktu końcowego.

NameValuePair

Reprezentuje parę nazwa-wartość.

NodeAgentInformation

Informacje o agencie węzła obliczeniowego.

ResourceFile

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

SchedulingState

Określa, czy węzeł obliczeniowy jest dostępny do planowania zadań.

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.

StartTaskInformation

Informacje na temat elementu StartTask uruchomionego w węźle obliczeniowym.

StartTaskState

Stan StartTask w węźle obliczeniowym.

TaskContainerExecutionInformation

Zawiera informacje o kontenerze, który wykonuje zadanie.

TaskContainerSettings

Ustawienia kontenera dla zadania.

TaskExecutionInformation

Informacje o wykonywaniu zadania.

TaskExecutionResult

Wynik wykonania zadania.

TaskFailureInformation

Informacje o niepowodzeniu zadania.

TaskInformation

Informacje o zadaniu uruchomionym w węźle obliczeniowym.

TaskState

Stan zadania.

UserIdentity

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

VirtualMachineInfo

Informacje o bieżącym stanie maszyny wirtualnej.

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.

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.
Należy pamiętać, że jest to tylko miękka koligacja. Jeśli docelowy węzeł obliczeniowy jest zajęty lub niedostępny w czasie zaplanowanego zadania, zadanie zostanie zaplanowane w innym miejscu.

allocationTime

string

Czas przydzielania tego węzła obliczeniowego do puli.
Jest to czas, kiedy węzeł obliczeniowy został początkowo przydzielony i nie zmienia się po ustawieniu. Nie jest aktualizowany, gdy węzeł obliczeniowy jest poprawiany lub wywłaszczony.

certificateReferences

CertificateReference[]

Lista certyfikatów zainstalowanych w węźle obliczeniowym.
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.

endpointConfiguration

ComputeNodeEndpointConfiguration

Konfiguracja punktu końcowego dla węzła obliczeniowego.

errors

ComputeNodeError[]

Lista błędów, które są obecnie napotykane przez węzeł obliczeniowy.

id

string

Identyfikator węzła obliczeniowego.
Każdy węzeł obliczeniowy dodawany do puli ma przypisany unikatowy identyfikator. Za każdym razem, gdy węzeł obliczeniowy zostanie usunięty z puli, wszystkie jego pliki lokalne zostaną usunięte, a identyfikator zostanie odzyskany i może zostać ponownie użyty dla nowych węzłów obliczeniowych.

ipAddress

string

Adres IP, którego mogą używać inne węzły do komunikowania się z tym węzłem obliczeniowym.
Każdy węzeł obliczeniowy dodawany do puli ma przypisany unikatowy adres IP. Za każdym razem, gdy węzeł obliczeniowy zostanie usunięty z puli, wszystkie jego pliki lokalne zostaną usunięte, a adres IP zostanie odzyskany i może zostać użyty ponownie dla nowych węzłów obliczeniowych.

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

Ostatni raz, kiedy węzeł obliczeniowy został uruchomiony.
Ta właściwość może nie być obecna, jeśli stan węzła obliczeniowego jest bezużyteczny.

nodeAgentInfo

NodeAgentInformation

Informacje o wersji agenta węzła obliczeniowego i czasie uaktualniania węzła obliczeniowego do nowej wersji.
Agent węzła obliczeniowego usługi Batch to program uruchamiany w każdym węźle obliczeniowym w puli i zapewnia możliwość usługi Batch w węźle obliczeniowym.

recentTasks

TaskInformation[]

Lista zadań, których stan został ostatnio zmieniony.
Ta właściwość jest obecna tylko wtedy, gdy co najmniej jedno zadanie zostało uruchomione w tym węźle obliczeniowym, ponieważ zostało przypisane do puli.

runningTaskSlotsCount

integer

Całkowita liczba miejsc planowania używanych przez aktualnie uruchomione zadania podrzędne w węźle obliczeniowym. Dotyczy to zadań podrzędnych Menedżera zadań i zadań normalnych, ale nie podrzędnych przygotowania zadań, zwolnienia zadania lub uruchamiania.

runningTasksCount

integer

Całkowita liczba aktualnie uruchomionych zadań podrzędnych w węźle obliczeniowym. Dotyczy to zadań podrzędnych Menedżera zadań i zadań normalnych, ale nie podrzędnych przygotowania zadań, zwolnienia zadania lub uruchamiania.

schedulingState

SchedulingState

Określa, czy węzeł obliczeniowy jest dostępny do planowania zadań.

startTask

StartTask

Zadanie określone do uruchomienia w węźle obliczeniowym podczas dołączania do puli.
Usługa Batch ponowi próbę wykonania zadań po wyzwoleniu operacji odzyskiwania w węźle. Przykłady operacji odzyskiwania obejmują (ale nie tylko) ponowne uruchomienie węzła w złej kondycji lub zniknięcie węzła obliczeniowego z powodu awarii hosta. Ponowne próby z powodu operacji odzyskiwania są niezależne i nie są liczone względem parametru maxTaskRetryCount. Nawet jeśli parametr maxTaskRetryCount wynosi 0, może wystąpić wewnętrzna ponowna próba spowodowana operacją odzyskiwania. W związku z tym wszystkie zadania powinny być idempotentne. Oznacza to, że zadania muszą tolerować przerywanie i ponowne uruchamianie bez powodowania uszkodzenia lub duplikowania danych. Najlepszym rozwiązaniem dla długotrwałych zadań jest użycie jakiejś formy tworzenia punktów kontrolnych. W niektórych przypadkach funkcja StartTask może zostać ponownie uruchomiona, mimo że węzeł obliczeniowy nie został ponownie uruchomiony. Należy zachować szczególną ostrożność, aby uniknąć zadań StartTasks, które tworzą proces przerwania lub instalują/uruchamiają usługi z katalogu roboczego StartTask, ponieważ uniemożliwi to usłudze Batch ponowne uruchomienie zadania StartTask.

startTaskInfo

StartTaskInformation

Informacje o środowisku uruchomieniowym dotyczące wykonywania elementu StartTask w węźle obliczeniowym.

state

ComputeNodeState

Bieżący stan węzła obliczeniowego.
Węzeł obliczeniowy typu spot/low-priority został wywłaszczone. Zadania, które były uruchomione w węźle obliczeniowym, gdy został on wywłaszczone, zostaną ponownie zaplanowane, gdy inny węzeł obliczeniowy stanie się dostępny.

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. Dotyczy to zadań podrzędnych Menedżera zadań i zadań normalnych, ale nie podrzędnych przygotowania zadań, zwolnienia zadania lub uruchamiania.

totalTasksSucceeded

integer

Całkowita liczba zadań zakończonych pomyślnie (z kodem exitCode 0) w węźle obliczeniowym. Dotyczy to zadań podrzędnych Menedżera zadań i zadań normalnych, ale nie podrzędnych przygotowania zadań, zwolnienia zadania lub uruchamiania.

url

string

Adres URL węzła obliczeniowego.

virtualMachineInfo

VirtualMachineInfo

Informacje o bieżącym stanie maszyny wirtualnej.

vmSize

string

Rozmiar maszyny wirtualnej hostująca węzeł obliczeniowy.
Aby uzyskać informacje o dostępnych rozmiarach maszyn wirtualnych w pulach, zobacz Wybieranie rozmiaru maszyny wirtualnej dla węzłów obliczeniowych w puli usługi Azure Batch (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

ComputeNodeEndpointConfiguration

Konfiguracja punktu końcowego dla węzła obliczeniowego.

Nazwa Typ Opis
inboundEndpoints

InboundEndpoint[]

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

NameValuePair[]

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

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

ComputeNode[]

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.

deallocated

string

Przydział węzła obliczeniowego jest cofnięty.

deallocating

string

Węzeł obliczeniowy cofa przydział.

idle

string

Węzeł obliczeniowy nie uruchamia obecnie zadania.

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 uruchamia obecnie zadania, 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ł on wywłaszczone, zostaną ponownie zaplanowane, gdy inny węzeł obliczeniowy stanie się dostępny.

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 podrzędne (inne niż StartTask).

starting

string

Usługa Batch jest uruchamiana na podstawowej maszynie wirtualnej.

starttaskfailed

string

Zadanie StartTask nie powiodło się w węźle obliczeniowym (i wyczerpało wszystkie ponowne próby) i ustawiono wartość waitForSuccess. 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 rzeczywistego stanu.

unusable

string

Nie można użyć węzła obliczeniowego do wykonywania zadania z powodu błędów.

upgradingos

string

Węzeł obliczeniowy przechodzi operację uaktualniania systemu operacyjnego.

waitingforstarttask

string

Polecenie StartTask zostało uruchomione w węźle obliczeniowym, ale ustawiono polecenie waitForSuccess, a element StartTask nie został jeszcze ukończony.

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.

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 na błąd usługi Azure Batch.

Nazwa Typ Opis
lang

string

Kod języka komunikatu o błędzie

value

string

Tekst wiadomości.

ImageReference

Odwołanie do obrazu witryny Marketplace usługi Azure Virtual Machines lub obrazu galerii obliczeniowej platformy Azure. Aby uzyskać listę wszystkich odwołań do obrazów witryny Azure Marketplace zweryfikowanych przez usługę Azure Batch, zobacz operację "Lista obsługiwanych obrazów".

Nazwa Typ Opis
communityGalleryImageId

string

Unikatowy identyfikator obrazu galerii społeczności
Ta właściwość wzajemnie wyklucza się z innymi właściwościami i może być pobierana z wywołania GET obrazu galerii społeczności.

exactVersion

string

Określona wersja obrazu platformy lub obrazu platformy handlowej użytego do utworzenia węzła. To pole tylko do odczytu różni się od "version" tylko wtedy, gdy wartość określona dla "version" podczas tworzenia puli miała wartość "latest".

offer

string

Typ oferty obrazu witryny Marketplace usługi Azure Virtual Machines.
Na przykład UbuntuServer lub WindowsServer.

publisher

string

Wydawca obrazu witryny Marketplace usługi Azure Virtual Machines.
Na przykład Canonical lub MicrosoftWindowsServer.

sharedGalleryImageId

string

Unikatowy identyfikator obrazu galerii udostępnionej
Ta właściwość wzajemnie wyklucza się z innymi właściwościami i może zostać pobrana z wywołania GET obrazu galerii udostępnionej.

sku

string

Jednostka SKU obrazu witryny Marketplace usługi Azure Virtual Machines.
Na przykład 18.04-LTS lub 2019-Datacenter.

version

string

Wersja obrazu witryny Marketplace usługi Azure Virtual Machines.
Można określić wartość "latest", aby wybrać najnowszą wersję obrazu. W przypadku pominięcia wartość domyślna to "latest".

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/{galleryName}/images/{imageDefinitionName} dla zawsze domyślnej wersji obrazu.
Ta właściwość wzajemnie wyklucza się z innymi właściwościami ImageReference. Obraz galerii obliczeniowej platformy Azure musi mieć repliki w tym samym regionie i musi znajdować się w tej samej subskrypcji co konto usługi Azure Batch. Jeśli wersja obrazu nie zostanie określona w identyfikatorze imageId, zostanie użyta najnowsza wersja. Aby uzyskać informacje o ustawieniach zapory dla agenta węzła obliczeniowego usługi Batch do komunikowania się z usługą Batch, zobacz https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

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

InboundEndpointProtocol

Protokół punktu końcowego.

publicFQDN

string

Publiczna w pełni kwalifikowana nazwa domeny dla 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ę nazwa-wartość.

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.
Jest to ostatni raz, gdy agent węzła obliczeniowego został zaktualizowany do nowej wersji.

version

string

Wersja agenta węzła obliczeniowego usługi Batch uruchomiona w węźle obliczeniowym.
Ten numer wersji można sprawdzić w informacjach o wersji agenta węzła obliczeniowego znajdujących się w https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md.

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.

SchedulingState

Określa, czy węzeł obliczeniowy jest dostępny do planowania zadań.

Nazwa Typ Opis
disabled

string

W węźle obliczeniowym nie zostaną zaplanowane żadne nowe zadania. Zadania uruchomione już 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 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://docs.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.

StartTaskInformation

Informacje na temat elementu StartTask uruchomionego w węźle obliczeniowym.

Nazwa Typ Opis
containerInfo

TaskContainerExecutionInformation

Informacje o kontenerze, w którym jest wykonywane zadanie.
Ta właściwość jest ustawiana tylko wtedy, gdy zadanie jest uruchamiane w kontekście kontenera.

endTime

string

Czas, w którym startTask przestał działać.
Jest to czas zakończenia ostatniego uruchomienia starttask, jeśli przebieg został ukończony (nawet jeśli przebieg zakończył się niepowodzeniem, a ponowna próba jest oczekująca). Ten element nie jest obecny, jeśli element StartTask jest obecnie uruchomiony.

exitCode

integer

Kod zakończenia programu określony w wierszu polecenia StartTask.
Ta właściwość jest ustawiana tylko wtedy, gdy właściwość StartTask jest w stanie ukończonym. Ogólnie rzecz biorąc, kod zakończenia procesu odzwierciedla konkretną konwencję zaimplementowaną przez dewelopera aplikacji dla tego procesu. Jeśli używasz wartości kodu zakończenia do podejmowania decyzji w kodzie, upewnij się, że znasz konwencję kodu zakończenia używaną przez proces aplikacji. Jeśli jednak usługa Batch zakończy działanie funkcji StartTask (z powodu przekroczenia limitu czasu lub zakończenia działania użytkownika za pośrednictwem interfejsu API), może zostać wyświetlony kod zakończenia zdefiniowany przez system operacyjny.

failureInfo

TaskFailureInformation

Informacje opisujące błąd zadania, jeśli istnieje.
Ta właściwość jest ustawiana tylko wtedy, gdy zadanie jest w stanie ukończonym i napotkało błąd.

lastRetryTime

string

Ostatni raz, w którym uruchomiono ponowną próbę zadania.
Ten element jest obecny tylko wtedy, gdy zadanie zostało ponowione (tj. retryCount jest nonzero). Jeśli jest obecny, zazwyczaj jest to samo co startTime, ale może się różnić, jeśli zadanie zostało uruchomione ponownie z powodów innych niż ponawianie próby; na przykład jeśli węzeł obliczeniowy został uruchomiony ponownie podczas ponawiania próby, godzina rozpoczęcia zostanie zaktualizowana, ale parametr lastRetryTime nie jest.

result

TaskExecutionResult

Wynik wykonania zadania.
Jeśli wartość to "failed", szczegóły błędu można znaleźć we właściwości failureInfo.

retryCount

integer

Liczba ponownych prób wykonania zadania przez usługę Batch.
Błędy aplikacji zadań (kod zakończenia niezerowy) są ponawiane, błędy przetwarzania wstępnego (nie można uruchomić zadania) i błędy przekazywania plików nie są ponawiane. Usługa Batch ponowi próbę wykonania zadania do limitu określonego przez ograniczenia.

startTime

string

Godzina rozpoczęcia uruchamiania aplikacji StartTask.
Ta wartość jest resetowana za każdym razem, gdy zadanie jest uruchamiane ponownie lub ponawiane (czyli jest to ostatni raz, w którym uruchomiono zadanie StartTask).

state

StartTaskState

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 zadanie StartTask nie powiodło się 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

Polecenie StartTask jest obecnie uruchomione.

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.
Jest to szczegółowy ciąg błędu z usługi Docker, jeśli jest dostępny. Jest to odpowiednik pola błędu zwróconego przez wyrażenie "docker inspect".

state

string

Stan kontenera.
Jest to stan kontenera zgodnie z usługą Docker. Jest to odpowiednik pola stanu zwróconego przez wyrażenie "docker inspect".

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

TaskExecutionInformation

Informacje o wykonywaniu zadania.

Nazwa Typ Opis
containerInfo

TaskContainerExecutionInformation

Informacje o kontenerze, w którym jest wykonywane zadanie.
Ta właściwość jest ustawiana tylko wtedy, gdy zadanie jest uruchamiane w kontekście kontenera.

endTime

string

Czas, w którym zadanie zostało ukończone.
Ta właściwość jest ustawiana tylko wtedy, gdy zadanie jest w stanie Ukończono.

exitCode

integer

Kod zakończenia programu określony w wierszu polecenia zadania.
Ta właściwość jest ustawiana tylko wtedy, gdy zadanie jest w stanie ukończonym. Ogólnie rzecz biorąc, kod zakończenia procesu odzwierciedla konkretną konwencję zaimplementowaną przez dewelopera aplikacji dla tego procesu. Jeśli używasz wartości kodu zakończenia do podejmowania decyzji w kodzie, upewnij się, że znasz konwencję kodu zakończenia używaną przez proces aplikacji. Jeśli jednak usługa Batch zakończy zadanie (z powodu przekroczenia limitu czasu lub zakończenia działania użytkownika za pośrednictwem interfejsu API), może zostać wyświetlony kod zakończenia zdefiniowany przez system operacyjny.

failureInfo

TaskFailureInformation

Informacje opisujące błąd zadania, jeśli istnieje.
Ta właściwość jest ustawiana tylko wtedy, gdy zadanie jest w stanie ukończonym i napotkało błąd.

lastRequeueTime

string

Ostatni czas, w którym zadanie zostało ponownie w kolejce przez usługę Batch w wyniku żądania użytkownika.
Ta właściwość jest ustawiana tylko wtedy, gdy requeueCount jest nonzero.

lastRetryTime

string

Ostatni raz, w którym uruchomiono ponowną próbę zadania.
Ten element jest obecny tylko wtedy, gdy zadanie zostało ponowione (tj. retryCount jest nonzero). Jeśli jest obecny, zazwyczaj jest to samo co startTime, ale może się różnić, jeśli zadanie zostało uruchomione ponownie z powodów innych niż ponawianie próby; na przykład jeśli węzeł obliczeniowy został uruchomiony ponownie podczas ponawiania próby, godzina rozpoczęcia zostanie zaktualizowana, ale parametr lastRetryTime nie jest.

requeueCount

integer

Liczba ponownych kolejek zadania przez usługę Batch w wyniku żądania użytkownika.
Gdy użytkownik usunie węzły obliczeniowe z puli (przez zmianę rozmiaru/zmniejszenie puli) lub gdy zadanie jest wyłączone, użytkownik może określić, że uruchomione zadania w węzłach obliczeniowych zostaną ponownie w kolejce do wykonania. Ta liczba śledzi liczbę ponownych kolejek zadania z tych powodów.

result

TaskExecutionResult

Wynik wykonania zadania.
Jeśli wartość to "failed", szczegóły błędu można znaleźć we właściwości failureInfo.

retryCount

integer

Liczba ponownych prób wykonania zadania przez usługę Batch.
Błędy aplikacji zadań (kod zakończenia niezerowy) są ponawiane, błędy przetwarzania wstępnego (nie można uruchomić zadania) i błędy przekazywania plików nie są ponawiane. Usługa Batch ponowi próbę wykonania zadania do limitu określonego przez ograniczenia.

startTime

string

Czas, w którym zadanie zaczęło działać.
Polecenie "Uruchomione" odpowiada stanowi uruchomienia, więc jeśli zadanie określa pliki zasobów lub pakiety, godzina rozpoczęcia odzwierciedla czas rozpoczęcia, w którym zadanie rozpoczęło pobieranie lub wdrażanie tych plików. Jeśli zadanie zostało ponownie uruchomione lub ponowione, jest to ostatni czas, w którym zadanie zostało uruchomione. Ta właściwość jest obecna tylko w przypadku zadań, które są w stanie uruchomionym lub ukończonym.

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

ErrorCategory

Kategoria błędu zadania.

code

string

Identyfikator błędu zadania. Kody są niezmienne i mają być używane programowo.

details

NameValuePair[]

Lista dodatkowych szczegółów związanych z 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

TaskExecutionInformation

Informacje o wykonaniu zadania.

jobId

string

Identyfikator zadania, do którego należy zadanie.

subtaskId

integer

Identyfikator podzadaktu, jeśli zadanie jest zadaniem z wieloma wystąpieniami.

taskId

string

Identyfikator zadania.

taskState

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 włączone po wyłączeniu lub gdy oczekuje na ponowienie próby 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 aktywnej 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

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.

VirtualMachineInfo

Informacje o bieżącym stanie maszyny wirtualnej.

Nazwa Typ Opis
imageReference

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