Job Schedule - Add

Dodaje Harmonogram zadań do określonego konta.

POST {batchUrl}/jobschedules?api-version=2020-09-01.12.0
POST {batchUrl}/jobschedules?timeout={timeout}&api-version=2020-09-01.12.0

Parametry identyfikatora URI

Name In Required Type Description
batchUrl
path True
  • string

Podstawowy adres URL dla wszystkich żądań obsługi Azure Batch.

api-version
query True
  • string

Wersja interfejsu API klienta.

timeout
query
  • integer
int32

Maksymalny czas, przez jaki serwer może spędzać przetwarzanie żądania w sekundach. Wartość domyślna to 30 sekund.

Nagłówek żądania

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

Name Required Type Description
client-request-id
  • string
uuid

Tożsamość żądania wygenerowana przez wywołującego, 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

Godzina wystawienia żądania. Biblioteki klienckie zazwyczaj ustawiają tę wartość na bieżącą godzinę zegara systemowego; Ustaw ją jawnie, jeśli wywołujesz interfejs API REST bezpośrednio.

Treść żądania

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

Name Required Type Description
id True
  • string

Ciąg unikatowo identyfikujący harmonogram w ramach konta.
Identyfikator może zawierać dowolną kombinację znaków alfanumerycznych, w tym łączniki i podkreślenia, i nie może zawierać więcej niż 64 znaków. Identyfikator uwzględnia wielkość liter i uwzględnia wielkość liter (oznacza to, że nie ma dwóch identyfikatorów na koncie, które różnią się tylko wielkością liter).

jobSpecification True

Szczegóły zadań, które mają zostać utworzone w ramach tego harmonogramu.

schedule True

Harmonogram zależny od tego, które zadania zostaną utworzone.

displayName
  • string

Nazwa wyświetlana harmonogramu.
Nazwa wyświetlana nie musi być unikatowa i może zawierać dowolne znaki Unicode o maksymalnej długości 1024.

metadata

Lista par nazwa-wartość skojarzonych z harmonogramem jako metadane.
Usługa Batch nie przypisuje żadnych znaczenia do metadanych; służy wyłącznie do korzystania z kodu użytkownika.

Odpowiedzi

Name Type Description
201 Created

Żądanie do usługi Batch zakończyło się pomyślnie.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

Błąd usługi Batch.

Zabezpieczenia

azure_auth

Azure Active Directory przepływ OAuth2

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

Scopes

Name Description
user_impersonation Personifikuj konto użytkownika

Authorization

Type: apiKey
In: header

Przykłady

Add a basic JobSchedule
Add a complex JobScheduleAdd

Add a basic JobSchedule

Sample Request

POST account.region.batch.azure.com/jobschedules?api-version=2020-09-01.12.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "id": "jobScheduleId",
  "schedule": {
    "recurrenceInterval": "PT5M"
  },
  "jobSpecification": {
    "poolInfo": {
      "poolId": "poolId"
    }
  }
}

Sample Response

Add a complex JobScheduleAdd

Sample Request

POST account.region.batch.azure.com/jobschedules?api-version=2020-09-01.12.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "id": "jobScheduleId",
  "schedule": {
    "doNotRunUntil": "2014-09-10T02:30:00.000Z",
    "doNotRunAfter": "2014-09-10T06:30:00.000Z",
    "startWindow": "PT1M",
    "recurrenceInterval": "PT5M"
  },
  "jobSpecification": {
    "priority": 100,
    "constraints": {
      "maxWallClockTime": "PT1H",
      "maxTaskRetryCount": -1
    },
    "jobManagerTask": {
      "id": "mytask1",
      "commandLine": "myprogram.exe",
      "resourceFiles": [
        {
          "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas",
          "filePath": "myprogram.exe"
        },
        {
          "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/test.txt?sas",
          "filePath": "test.txt"
        }
      ],
      "environmentSettings": [
        {
          "name": "myvariable",
          "value": "myvalue"
        }
      ],
      "constraints": {
        "maxWallClockTime": "PT1H",
        "maxTaskRetryCount": 0,
        "retentionTime": "PT1H"
      },
      "requiredSlots": 2,
      "killJobOnCompletion": true,
      "userIdentity": {
        "autoUser": {
          "scope": "task",
          "elevationLevel": "nonadmin"
        }
      },
      "runExclusive": true
    },
    "poolInfo": {
      "autoPoolSpecification": {
        "autoPoolIdPrefix": "mypool",
        "poolLifetimeOption": "jobschedule",
        "pool": {
          "vmSize": "small",
          "cloudServiceConfiguration": {
            "osFamily": "4",
            "osVersion": "*"
          },
          "resizeTimeout": "PT15M",
          "targetDedicatedNodes": 3,
          "targetLowPriorityNodes": 0,
          "taskSlotsPerNode": 2,
          "taskSchedulingPolicy": {
            "nodeFillType": "spread"
          },
          "enableAutoScale": false,
          "enableInterNodeCommunication": true,
          "startTask": {
            "commandLine": "myprogram2.exe",
            "resourceFiles": [
              {
                "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas",
                "filePath": "myprogram2.exe"
              }
            ],
            "environmentSettings": [
              {
                "name": "myvariable",
                "value": "myvalue"
              }
            ],
            "userIdentity": {
              "autoUser": {
                "scope": "task",
                "elevationLevel": "admin"
              }
            },
            "maxTaskRetryCount": 2,
            "waitForSuccess": true
          },
          "certificateReferences": [
            {
              "thumbprint": "0123456789abcdef0123456789abcdef01234567",
              "thumbprintAlgorithm": "sha1",
              "storeLocation": "localmachine",
              "storeName": "Root",
              "visibility": [
                "task"
              ]
            }
          ],
          "metadata": [
            {
              "name": "myproperty",
              "value": "myvalue"
            }
          ]
        }
      }
    }
  },
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Sample Response

Definicje

ApplicationPackageReference

Odwołanie do pakietu do wdrożenia w węzłach obliczeniowych.

AuthenticationTokenSettings

Ustawienia tokenu uwierzytelniania, którego zadanie może użyć do wykonywania operacji usługi Batch.

AutoPoolSpecification

Określa charakterystykę tymczasowej puli "autopool". Usługa Batch utworzy tę pulę Auto, gdy zadanie zostanie przesłane.

AutoUserScope

Zakres dla użytkownika

AutoUserSpecification

Określa parametry dla użytkownika, który uruchamia zadanie w usłudze Batch.

AzureBlobFileSystemConfiguration

Informacje używane do nawiązywania połączenia z kontenerem usługi Azure Storage za pomocą Blobfuse.

AzureFileShareConfiguration

Informacje używane do nawiązywania połączenia z udziałem plików platformy Azure.

BatchError

Odebrano odpowiedź na błąd z usługi Azure Batch.

BatchErrorDetail

Element dodatkowych informacji uwzględnionych w Azure Batch odpowiedzi na błędy.

CachingType

Typ buforowania, który ma zostać włączony dla dysku.

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.

CIFSMountConfiguration

Informacje używane do nawiązywania połączenia z systemem plików CIFS.

CloudServiceConfiguration

Konfiguracja węzłów obliczeniowych w puli w oparciu o platformę Cloud Services platformy Azure.

ComputeNodeFillType

Sposób dystrybuowania zadań w węzłach obliczeniowych w puli.

ContainerConfiguration

Konfiguracja pul z obsługą kontenerów.

ContainerRegistry

Prywatny rejestr kontenerów.

ContainerType

Technologia kontenera, która ma zostać użyta.

ContainerWorkingDirectory

Lokalizacja katalogu roboczego zadania kontenera.

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 w celu ich użycia.

DiskEncryptionConfiguration

Konfiguracja szyfrowania dysku zastosowana w węzłach obliczeniowych w puli. Konfiguracja szyfrowania dysków nie jest obsługiwana w puli systemu Linux utworzonej za pomocą obrazu udostępnionej galerii obrazów.

DynamicVNetAssignmentScope

Zakres dynamicznego przypisywania sieci wirtualnej.

ElevationLevel

Poziom podniesienia uprawnień użytkownika.

EnvironmentSetting

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

ErrorMessage

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

ImageReference

Odwołanie do obrazu platformy Azure Virtual Machines Marketplace lub obrazu udostępnionej galerii obrazów. Aby uzyskać listę wszystkich odwołań do obrazów w portalu Azure Marketplace zweryfikowanych przez Azure Batch, zobacz operację "list obsługiwanych obrazów".

InboundEndpointProtocol

Protokół punktu końcowego.

InboundNATPool

Pula NAT dla ruchu przychodzącego, która może być używana do adresowania określonych portów w węzłach obliczeniowych w puli wsadowej zewnętrznie.

IPAddressProvisioningType

Typ aprowizacji dla Publiczne adresy IP dla puli.

JobConstraints

Ograniczenia wykonania zadania.

JobManagerTask

Określa szczegóły zadania Menedżera zadań.

JobNetworkConfiguration

Konfiguracja sieci dla zadania.

JobPreparationTask

Zadanie przygotowania zadania do uruchomienia przed zadaniami w danym węźle obliczeniowym.

JobReleaseTask

Zadanie zwolnienia zadania do uruchomienia po zakończeniu zadania w dowolnym węźle obliczeniowym, w którym uruchomiono zadanie.

JobScheduleAddParameter

Harmonogram zadań, który umożliwia cykliczne zadania przez określenie czasu uruchamiania zadań i specyfikacji używanych do tworzenia poszczególnych zadań.

JobSpecification

Określa szczegóły zadań, które mają zostać utworzone zgodnie z harmonogramem.

LinuxUserConfiguration

Właściwości służące do tworzenia konta użytkownika w węźle obliczeniowym systemu Linux.

LoginMode

Tryb logowania dla użytkownika

MetadataItem

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

MountConfiguration

System plików do zainstalowania na każdym węźle.

NetworkConfiguration

Konfiguracja sieci dla puli.

NetworkSecurityGroupRule

Reguła sieciowej grupy zabezpieczeń, która ma zostać zastosowana do punktu końcowego ruchu przychodzącego.

NetworkSecurityGroupRuleAccess

Akcja, która powinna zostać wykonana dla określonego adresu IP, zakresu podsieci lub tagu.

NFSMountConfiguration

Informacje używane do nawiązywania połączenia z systemem plików NFS.

OnAllTasksComplete

Akcja, którą usługa Batch powinna wykonać, gdy wszystkie zadania w zadaniu są w stanie ukończone.

OnTaskFailure

Akcja, którą usługa Batch powinna wykonać, gdy dowolne zadanie w zadaniu zakończy się niepowodzeniem.

OutputFile

Specyfikacja przekazywania plików z węzła obliczeniowego Azure Batch do innej lokalizacji po zakończeniu wykonywania zadania przez usługę Batch.

OutputFileBlobContainerDestination

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

OutputFileDestination

Miejsce docelowe, do którego plik powinien zostać przekazany.

OutputFileUploadCondition

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

OutputFileUploadOptions

Szczegółowe informacje o operacji przekazywania pliku wyjściowego, w tym o warunkach do przeprowadzenia przekazywania.

PoolEndpointConfiguration

Konfiguracja punktu końcowego dla puli.

PoolInformation

Określa sposób, w jaki zadanie powinno być przypisane do puli.

PoolLifetimeOption

Minimalny okres istnienia utworzonych pul autopule oraz sposób przypisywania wielu zadań zgodnie z harmonogramem do pul.

PoolSpecification

Specyfikacja tworzenia nowej puli.

PublicIPAddressConfiguration

Konfiguracja publicznego adresu IP konfiguracji sieciowej puli.

ResourceFile

Pojedynczy plik lub wiele plików do pobrania w węźle obliczeniowym.

Schedule

Harmonogram, zgodnie z którym będą tworzone zadania

StartTask

Zadanie uruchamiane, gdy węzeł jest przyłączany do puli w usłudze Azure Batch lub gdy węzeł obliczeniowy jest ponownie uruchamiany lub odtwarzany z obrazu.

StorageAccountType

Typ konta magazynu do użycia podczas tworzenia dysków z danymi.

TaskConstraints

Ograniczenia wykonania, które mają zostać zastosowane do zadania.

TaskContainerSettings

Ustawienia kontenera dla zadania.

TaskSchedulingPolicy

Określa sposób dystrybuowania zadań między węzłami obliczeniowymi.

UserAccount

Właściwości służące do tworzenia użytkownika służącego do wykonywania zadań w węźle obliczeniowym Azure Batch.

UserIdentity

Definicja tożsamości użytkownika, pod którą uruchamiane jest zadanie.

VirtualMachineConfiguration

Konfiguracja węzłów obliczeniowych w puli w oparciu o infrastrukturę usługi Azure Virtual Machines.

WindowsConfiguration

Ustawienia systemu operacyjnego Windows, które mają zostać zastosowane do maszyny wirtualnej.

WindowsUserConfiguration

Właściwości służące do tworzenia konta użytkownika w węźle obliczeniowym systemu Windows.

ApplicationPackageReference

Odwołanie do pakietu do wdrożenia w węzłach obliczeniowych.

Name Type Description
applicationId
  • string

Identyfikator aplikacji do wdrożenia.

version
  • string

Wersja aplikacji do wdrożenia. W przypadku pominięcia zostanie wdrożona domyślna wersja.
Jeśli zostanie pominięty w puli, a dla tej aplikacji nie zostanie określona żadna wersja domyślna, żądanie kończy się niepowodzeniem z kodem błędu InvalidApplicationPackageReferences i kodem stanu HTTP 409. Jeśli zostanie pominięty w zadaniu, a dla tej aplikacji nie zostanie określona domyślna wersja, zadanie zakończy się niepowodzeniem z błędem przetwarzania wstępnego.

AuthenticationTokenSettings

Ustawienia tokenu uwierzytelniania, którego zadanie może użyć do wykonywania operacji usługi Batch.

Name Type Description
access
  • string[]

Zasoby wsadowe, do których token przyznaje dostęp.
Token uwierzytelniania przyznaje dostęp do ograniczonego zestawu operacji usługi Batch. Obecnie jedyną obsługiwaną wartością właściwości Access jest "Job", która umożliwia dostęp do wszystkich operacji związanych z zadaniem, które zawiera zadanie.

AutoPoolSpecification

Określa charakterystykę tymczasowej puli "autopool". Usługa Batch utworzy tę pulę Auto, gdy zadanie zostanie przesłane.

Name Type Description
autoPoolIdPrefix
  • string

Prefiks, który ma zostać dodany do unikatowego identyfikatora podczas automatycznego tworzenia puli.
Usługa Batch przypisuje każdemu autopuli unikatowy identyfikator podczas tworzenia. Aby rozróżnić pule utworzone do różnych celów, możesz określić ten element, aby dodać prefiks do przypisanego identyfikatora. Prefiks może składać się z maksymalnie 20 znaków.

keepAlive
  • boolean

Czy utrzymywać pulę autoaktywności po upływie okresu istnienia.
W przypadku wartości false usługa Batch usuwa pulę po upływie okresu istnienia (zgodnie z ustawieniami poolLifetimeOption). oznacza to, że po zakończeniu zadania lub harmonogramu zadań. Jeśli wartość jest równa true, usługa Batch nie usuwa puli automatycznie. Użytkownik może usunąć pule Autostart utworzone przy użyciu tej opcji.

pool

Specyfikacja puli dla puli Auto.

poolLifetimeOption

Minimalny okres istnienia utworzonych pul autopule oraz sposób przypisywania wielu zadań zgodnie z harmonogramem do pul.

AutoUserScope

Zakres dla użytkownika

Name Type Description
pool
  • string

Określa, że zadanie jest uruchamiane jako wspólne konto użytkownika, 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, który uruchamia zadanie w usłudze Batch.

Name Type Description
elevationLevel

Poziom podniesienia uprawnień dla użytkownika.
Wartość domyślna to unadmin.

scope

Zakres dla użytkownika
Wartość domyślna to Pool. Jeśli w puli jest uruchomiony system Windows, należy określić wartość zadanie, jeśli jest wymagane ściślejsze izolacja między zadaniami. Na przykład, jeśli zadanie przyniesie rejestr w sposób, który może mieć wpływ na inne zadania lub jeśli określono certyfikaty w puli, które nie powinny być dostępne w normalnych zadaniach, ale powinny być dostępne przez StartTasks.

AzureBlobFileSystemConfiguration

Informacje używane do nawiązywania połączenia z kontenerem usługi Azure Storage za pomocą Blobfuse.

Name Type Description
accountKey
  • string

Klucz konta usługi Azure Storage.
Ta właściwość jest wzajemnie wykluczana z sasKey i należy określić ją.

accountName
  • string

Nazwa konta usługi Azure Storage.

blobfuseOptions
  • string

Dodatkowe opcje wiersza polecenia do przekazania do polecenia instalacji.
Są to opcje "net use" w opcjach Windows i "Mount" w systemie Linux.

containerName
  • string

Nazwa kontenera Blob Storage platformy Azure.

relativeMountPath
  • string

Ścieżka względna w węźle obliczeniowym, w którym zostanie zainstalowany system plików
Wszystkie systemy plików są instalowane względem katalogu instalacji usługi Batch, dostępne za pośrednictwem zmiennej środowiskowej AZ_BATCH_NODE_MOUNTS_DIR.

sasKey
  • string

Token SAS usługi Azure Storage.
Ta właściwość jest wzajemnie wykluczana z accountKey i należy określić ją.

AzureFileShareConfiguration

Informacje używane do nawiązywania połączenia z udziałem plików platformy Azure.

Name Type Description
accountKey
  • string

Klucz konta usługi Azure Storage.

accountName
  • string

Nazwa konta usługi Azure Storage.

azureFileUrl
  • string

Adres URL Azure Files.
Jest to forma "https://{account}. File. Core. Windows. NET/".

mountOptions
  • string

Dodatkowe opcje wiersza polecenia do przekazania do polecenia instalacji.
Są to opcje "net use" w opcjach Windows i "Mount" w systemie Linux.

relativeMountPath
  • string

Ścieżka względna w węźle obliczeniowym, w którym zostanie zainstalowany system plików
Wszystkie systemy plików są instalowane względem katalogu instalacji usługi Batch, dostępne za pośrednictwem zmiennej środowiskowej AZ_BATCH_NODE_MOUNTS_DIR.

BatchError

Odebrano odpowiedź na błąd z usługi Azure Batch.

Name Type Description
code
  • string

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

message

Komunikat opisujący błąd, przeznaczony 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 uwzględnionych w Azure Batch odpowiedzi na błędy.

Name Type Description
key
  • string

Identyfikator określający znaczenie właściwości Value.

value
  • string

Dodatkowe informacje dołączone do odpowiedzi na błąd.

CachingType

Typ buforowania, który ma zostać włączony dla dysku.

Name Type Description
none
  • string

Tryb buforowania dysku nie jest włączony.

readonly
  • string

Tryb buforowania dysku jest tylko do odczytu.

readwrite
  • string

Tryb buforowania dysku to odczyt i zapis.

CertificateReference

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

Name Type Description
storeLocation

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 za pomocą węzłów obliczeniowych systemu Windows (czyli utworzonych za pomocą cloudServiceConfiguration lub z virtualMachineConfiguration przy użyciu odwołania obrazu systemu Windows). W przypadku węzłów obliczeniowych systemu Linux certyfikaty są przechowywane w katalogu w katalogu roboczym zadania i zmienna środowiskowa AZ_BATCH_CERTIFICATES_DIR jest dostarczana do zadania zapytania o tę lokalizację. W przypadku certyfikatów z widocznością "remoteUser" jest tworzony katalog "certyfikaty" w katalogu macierzystym użytkownika (np./home/{user-name}/certs), a certyfikaty są umieszczane w tym katalogu.

storeName
  • string

Nazwa magazynu certyfikatów w węźle obliczeniowym, w którym ma zostać zainstalowany certyfikat.
Ta właściwość ma zastosowanie tylko w przypadku pul skonfigurowanych za pomocą węzłów obliczeniowych systemu Windows (czyli utworzonych za pomocą cloudServiceConfiguration lub z virtualMachineConfiguration przy użyciu odwołania obrazu systemu Windows). Popularne nazwy sklepu obejmują: My, root, CA, Trust, unallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, ale można również użyć dowolnej nazwy magazynu niestandardowego. Wartość domyślna to my.

thumbprint
  • string

Odcisk palca certyfikatu.

thumbprintAlgorithm
  • string

Algorytm, z którym jest skojarzony odcisk palca. Musi to być algorytm SHA1.

visibility
  • string[]

Konta użytkowników w węźle obliczeniowym powinny mieć dostęp do danych prywatnych certyfikatu.
W tej kolekcji można określić więcej niż jeden widoczność. Wartość domyślna to wszystkie konta.

CertificateStoreLocation

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

Name Type Description
currentuser
  • string

Certyfikaty powinny być zainstalowane w magazynie certyfikatów CurrentUser.

localmachine
  • string

Certyfikaty powinny być zainstalowane w magazynie certyfikatów LocalMachine.

CIFSMountConfiguration

Informacje używane do nawiązywania połączenia z systemem plików CIFS.

Name Type Description
mountOptions
  • string

Dodatkowe opcje wiersza polecenia do przekazania do polecenia instalacji.
Są to opcje "net use" w opcjach Windows i "Mount" w systemie Linux.

password
  • string

Hasło, które ma być 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
Wszystkie systemy plików są instalowane względem katalogu instalacji usługi Batch, dostępne za pośrednictwem zmiennej środowiskowej AZ_BATCH_NODE_MOUNTS_DIR.

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.

CloudServiceConfiguration

Konfiguracja węzłów obliczeniowych w puli w oparciu o platformę Cloud Services platformy Azure.

Name Type Description
osFamily
  • string

Rodzina systemów operacyjnych gościa platformy Azure do zainstalowania na maszynach wirtualnych w puli.
Możliwe wartości to: 2 — Rodzina systemów operacyjnych 2, równoważna z systemem Windows Server 2008 R2 z dodatkiem SP1. Rodzina 3-SYSTEMowa 3, równoważna z systemem Windows Server 2012. 4 — Rodzina systemów operacyjnych 4, równoważna z systemem Windows Server 2012 R2. 5 — Rodzina systemów operacyjnych 5, równoważna z systemem Windows Server 2016. Rodzina 6-OS 6, równoważna z systemem Windows Server 2019. Aby uzyskać więcej informacji, zobacz wersje systemu operacyjnego gościa platformy Azure ( https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases) .

osVersion
  • string

Wersja systemu operacyjnego gościa platformy Azure do zainstalowania na maszynach wirtualnych w puli.
Wartość domyślna to *, która określa najnowszą wersję systemu operacyjnego dla określonej rodziny systemów operacyjnych.

ComputeNodeFillType

Sposób dystrybuowania zadań w węzłach obliczeniowych w puli.

Name Type Description
pack
  • string

Możliwie jak największą liczbę 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.

ContainerConfiguration

Konfiguracja pul z obsługą kontenerów.

Name Type Description
containerImageNames
  • string[]

Kolekcja nazw obrazów kontenerów.
To jest pełne odwołanie do obrazu, tak jak zostanie ono określone jako "docker pull". Obraz będzie źródłem domyślnego rejestru platformy Docker, chyba że obraz jest w pełni kwalifikowany z alternatywnym rejestrem.

containerRegistries

Dodatkowe prywatne rejestry, z których można ściągnąć kontenery.
Jeśli wszystkie obrazy muszą zostać pobrane z rejestru prywatnego, który wymaga poświadczeń, wówczas te poświadczenia muszą zostać podane w tym miejscu.

type

Technologia kontenera, która ma zostać użyta.

ContainerRegistry

Prywatny rejestr kontenerów.

Name Type Description
password
  • string

Hasło do logowania się do serwera rejestru.

registryServer
  • string

Adres URL rejestru.
W przypadku pominięcia wartość domyślna to "docker.io".

username
  • string

Nazwa użytkownika, aby zalogować się do serwera rejestru.

ContainerType

Technologia kontenera, która ma zostać użyta.

Name Type Description
dockerCompatible
  • string

Technologia kontenera zgodna z platformą Docker zostanie użyta do uruchomienia kontenerów.

ContainerWorkingDirectory

Lokalizacja katalogu roboczego zadania kontenera.

Name Type Description
containerImageDefault
  • string

Użyj katalogu roboczego zdefiniowanego w obrazie kontenera. Uważaj, że ten katalog nie będzie zawierał plików zasobów pobranych przez program Batch.

taskWorkingDirectory
  • string

Użyj katalogu roboczego zadania usługi Batch w warstwie Standardowa, który będzie zawierać pliki zasobów zadania wypełnione 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 w celu ich użycia.

Name Type Description
caching

Typ buforowania, który ma być włączony dla dysków danych.
Wartość domyślna dla buforowania to ReadWrite. Aby uzyskać informacje na temat opcji buforowania, zobacz: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/ .

diskSizeGB
  • integer

Początkowy rozmiar dysku w gigabajtach.

lun
  • integer

Numer jednostki logicznej.
Jednostka LUN służy do jednoznacznego identyfikowania każdego dysku z danymi. W przypadku dołączania wielu dysków każdy z nich powinien mieć odrębną jednostkę LUN. Wartość musi zawierać się w przedziale od 0 do 63 włącznie.

storageAccountType

Typ konta magazynu, który ma być używany na potrzeby dysku danych.
W przypadku pominięcia wartością domyślną jest "standard_lrs".

DiskEncryptionConfiguration

Konfiguracja szyfrowania dysku zastosowana w węzłach obliczeniowych w puli. Konfiguracja szyfrowania dysków nie jest obsługiwana w puli systemu Linux utworzonej za pomocą obrazu udostępnionej galerii obrazów.

Name Type Description
targets
  • string[]

Lista obiektów docelowych usługi Batch zostanie zaszyfrowana w węźle obliczeniowym.
W przypadku pominięcia nie będą szyfrowane żadne dyski w węzłach obliczeniowych w puli. W puli systemu Linux obsługiwana jest tylko wartość "TemporaryDisk". w puli systemu Windows należy określić wartość "OsDisk" i "TemporaryDisk".

DynamicVNetAssignmentScope

Zakres dynamicznego przypisywania sieci wirtualnej.

Name Type Description
job
  • string

Dynamiczne przypisanie sieci wirtualnej jest wykonywane dla każdego zadania.

none
  • string

Nie włączono dynamicznego przypisywania sieci wirtualnej.

ElevationLevel

Poziom podniesienia uprawnień użytkownika.

Name Type Description
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.

Name Type Description
name
  • string

Nazwa zmiennej środowiskowej.

value
  • string

Wartość zmiennej środowiskowej.

ErrorMessage

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

Name Type Description
lang
  • string

Kod języka komunikatu o błędzie

value
  • string

Tekst komunikatu.

ImageReference

Odwołanie do obrazu platformy Azure Virtual Machines Marketplace lub obrazu udostępnionej galerii obrazów. Aby uzyskać listę wszystkich odwołań do obrazów w portalu Azure Marketplace zweryfikowanych przez Azure Batch, zobacz operację "list obsługiwanych obrazów".

Name Type Description
offer
  • string

Typ oferty obrazu platformy Azure Virtual Machines Marketplace.
Na przykład UbuntuServer lub WindowsServer.

publisher
  • string

Wydawca obrazu platformy Azure Virtual Machines Marketplace.
Na przykład kanoniczny lub MicrosoftWindowsServer.

sku
  • string

Jednostka SKU obrazu platformy Azure Virtual Machines Marketplace.
Na przykład 18,04-LTS lub 2019 — centrum danych.

version
  • string

Wersja obrazu platformy Azure Virtual Machines Marketplace.
Aby wybrać najnowszą wersję obrazu, można określić wartość "Najnowsza". W przypadku pominięcia wartość domyślna to "Najnowsza".

virtualMachineImageId
  • string

Identyfikator zasobu ARM obrazu galerii obrazów udostępnionych. Węzły obliczeniowe w puli zostaną utworzone przy użyciu tego identyfikatora obrazu. Jest to forma/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} lub/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}, która zawsze domyślnie zawiera najnowszą wersję obrazu.
Ta właściwość wzajemnie się wykluczają z innymi właściwościami elementu imagereference. Obraz udostępnionej galerii obrazów musi mieć replikę w tym samym regionie i musi znajdować się w tej samej subskrypcji co konto Azure Batch. Jeśli wersja obrazu nie została określona w imageId, zostanie użyta Najnowsza wersja. Aby uzyskać informacje na temat ustawień zapory dla agenta węzła obliczeniowego usługi Batch do komunikacji z usługą Batch, zobacz https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration .

InboundEndpointProtocol

Protokół punktu końcowego.

Name Type Description
tcp
  • string

Użyj protokołu TCP dla punktu końcowego.

udp
  • string

Użyj protokołu UDP dla punktu końcowego.

InboundNATPool

Pula NAT dla ruchu przychodzącego, która może być używana do adresowania określonych portów w węzłach obliczeniowych w puli wsadowej zewnętrznie.

Name Type Description
backendPort
  • integer

Numer portu w węźle obliczeniowym.
Ta wartość musi być unikatowa w ramach puli partii. Dopuszczalne wartości należą do zakresu od 1 do 65535, z wyjątkiem 22, 3389, 29876 i 29877, ponieważ są one zarezerwowane. Jeśli jakiekolwiek zastrzeżone wartości są podane, żądanie kończy się niepowodzeniem z kodem stanu HTTP 400.

frontendPortRangeEnd
  • integer

Ostatni numer portu z zakresu portów zewnętrznych, który będzie używany do zapewniania dostępu przychodzącego do backendPort w poszczególnych węzłach obliczeniowych.
Dopuszczalne wartości mieszczą się w zakresie od 1 do 65534, z wyjątkiem portów od 50000 do 55000, które są zarezerwowane przez usługę Batch. Wszystkie zakresy w puli muszą być różne i nie mogą się nakładać. Każdy zakres musi zawierać co najmniej 40 portów. Jeśli są podane jakiekolwiek zastrzeżone lub nakładające się wartości, żądanie kończy się niepowodzeniem z kodem stanu HTTP 400.

frontendPortRangeStart
  • integer

Pierwszy numer portu z zakresu portów zewnętrznych, który będzie używany do zapewniania dostępu przychodzącego do backendPort w poszczególnych węzłach obliczeniowych.
Dopuszczalne wartości mieszczą się w zakresie od 1 do 65534, z wyjątkiem portów od 50000 do 55000, które są zarezerwowane. Wszystkie zakresy w puli muszą być różne i nie mogą się nakładać. Każdy zakres musi zawierać co najmniej 40 portów. Jeśli są podane jakiekolwiek zastrzeżone lub nakładające się wartości, żądanie kończy się niepowodzeniem z kodem stanu HTTP 400.

name
  • string

Nazwa punktu końcowego.
Nazwa musi być unikatowa w ramach puli partii, może zawierać litery, cyfry, podkreślenia, kropki i łączniki. Nazwy muszą zaczynać się literą lub cyfrą, muszą kończyć się literą, cyfrą lub podkreśleniem i nie mogą przekraczać 77 znaków. Jeśli podano nieprawidłowe wartości, żądanie kończy się niepowodzeniem z kodem stanu HTTP 400.

networkSecurityGroupRules

Lista reguł sieciowej grupy zabezpieczeń, które zostaną zastosowane do punktu końcowego.
Maksymalna liczba reguł, które można określić dla wszystkich punktów końcowych w puli partii, to 25. Jeśli nie określono żadnych reguł sieciowej grupy zabezpieczeń, zostanie utworzona reguła domyślna zezwalająca na dostęp przychodzący do określonego backendPort. Jeśli przekroczono maksymalną liczbę reguł sieciowej grupy zabezpieczeń, żądanie nie powiedzie się z kodem stanu HTTP 400.

protocol

Protokół punktu końcowego.

IPAddressProvisioningType

Typ aprowizacji dla Publiczne adresy IP dla puli.

Name Type Description
batchmanaged
  • string

Publiczny adres IP zostanie utworzony i będzie zarządzany przez partię. 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 aprowizacji węzłów obliczeniowych.

JobConstraints

Ograniczenia wykonania zadania.

Name Type Description
maxTaskRetryCount
  • integer

Maksymalna liczba prób wykonania poszczególnych zadań. Usługa Batch ponawia próbę wykonania zadania, jeśli jego kod zakończenia jest różny od zera.
Należy zauważyć, że ta wartość kontroluje liczbę ponownych prób. Usługa Batch spróbuje wykonać każde zadanie jeden raz, a następnie może ponowić próbę wykonania tego limitu. Jeśli na przykład maksymalna liczba ponownych prób wynosi 3, zadanie wsadowe próbuje wykonać zadania 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 wykonuje żadnych ponownych prób wykonywania zadań. Jeśli maksymalna liczba ponownych prób wynosi-1, usługa Batch ponawia zadania bez ograniczeń. Wartość domyślna to 0 (brak ponownych prób).

maxWallClockTime
  • string

Maksymalny czas, który upłynął, gdy zadanie może zostać uruchomione, mierzony od czasu utworzenia zadania.
Jeśli zadanie nie zakończy się w określonym czasie, usługa Batch zakończy działanie i wszystkie zadania, które są nadal uruchomione. W takim przypadku powód zakończenia zostanie MaxWallClockTimeExpiry. Jeśli ta właściwość nie jest określona, nie ma limitu czasu na czas, w którym zadanie może zostać uruchomione.

JobManagerTask

Określa szczegóły zadania Menedżera zadań.

Name Type Description
allowLowPriorityNode
  • boolean

Czy zadanie Menedżera zadań może działać w węźle obliczeniowym o niskim priorytecie.
Wartością domyślną jest true.

applicationPackageReferences

Lista pakietów aplikacji, które usługa Batch będzie wdrażać w węźle obliczeniowym przed uruchomieniem wiersza polecenia.
Pakiety aplikacji są pobierane i wdrażane w udostępnionym katalogu, a nie w katalogu roboczym zadania. W związku z tym, jeśli pakiet aplikacji, do którego istnieje odwołanie, znajduje się już w węźle obliczeniowym, a następnie jest aktualny, nie zostanie pobrany ponownie; zostanie użyta istniejąca kopia w węźle obliczeniowym. Jeśli nie można zainstalować pakietu aplikacji, na przykład dlatego, że pakiet został usunięty lub pobieranie nie powiodło się, zadanie zakończy się niepowodzeniem.

authenticationTokenSettings

Ustawienia tokenu uwierzytelniania, którego zadanie może użyć do wykonywania operacji usługi Batch.
Jeśli ta właściwość jest ustawiona, usługa Batch udostępnia zadanie z tokenem uwierzytelniania, który może służyć do uwierzytelniania operacji usługi Batch bez konieczności używania klucza dostępu do konta. Token jest dostarczany za pośrednictwem zmiennej środowiskowej AZ_BATCH_AUTHENTICATION_TOKEN. Operacje, które zadanie może wykonać przy użyciu tokenu, zależy od ustawień. Na przykład zadanie może zażądać uprawnień do zadania w celu dodania innych zadań do zadania lub sprawdzenia stanu zadania lub innych zadań w ramach zadania.

commandLine
  • string

Wiersz polecenia zadania Menedżera zadań.
Wiersz polecenia nie jest uruchamiany w ramach powłoki i w związku z tym nie może korzystać z funkcji powłoki, takich jak rozszerzenie zmiennej środowiskowej. Jeśli chcesz korzystać z tych funkcji, należy wywołać powłokę w wierszu polecenia, na przykład za pomocą polecenia "cmd/c-Command" w systemie Windows lub "/bin/sh-c webcommand" (system Linux). Jeśli wiersz polecenia odwołuje się do ścieżek plików, należy użyć ścieżki względnej (względem katalogu roboczego zadania) lub użyć zmiennej środowiskowej dostarczonej przez partię ( https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) .

constraints

Ograniczenia dotyczące zadania Menedżera zadań.

containerSettings

Ustawienia dla kontenera, w którym uruchamiane jest zadanie Menedżera zadań.
Jeśli Pula, w której zostanie uruchomione to zadanie, ma ustawioną containerConfiguration, należy ją także ustawić. Jeśli Pula, która będzie uruchamiać to zadanie nie ma ustawionego zestawu containerConfiguration, nie może być ustawiona. Gdy ta wartość jest określona, wszystkie katalogi cyklicznie poniżej AZ_BATCH_NODE_ROOT_DIR (katalog główny Azure Batch katalogów w węźle) są mapowane na kontener, wszystkie zmienne środowiskowe zadań są mapowane do kontenera, a wiersz polecenia zadania jest wykonywany w kontenerze. Pliki utworzone w kontenerze poza AZ_BATCH_NODE_ROOT_DIR mogą nie być odzwierciedlone na dysku hosta, co oznacza, że interfejsy API plików wsadowych nie będą mogły uzyskać dostępu do tych plików.

displayName
  • string

Nazwa wyświetlana zadania Menedżera zadań.
Nie musi być unikatowa i może zawierać dowolnych znaków Unicode o maksymalnej długości 1024.

environmentSettings

Lista ustawień zmiennych środowiskowych dla zadania Menedżera zadań.

id
  • string

Ciąg unikatowo identyfikujący zadanie Menedżera zadań w ramach zadania.
Identyfikator może zawierać dowolną kombinację znaków alfanumerycznych, w tym łączniki i podkreślenia i nie może zawierać więcej niż 64 znaków.

killJobOnCompletion
  • boolean

Czy ukończenie zadania Menedżera zadań oznacza ukończenie całego zadania.
Jeśli wartość jest równa true, po zakończeniu zadania Menedżera zadań usługa Batch oznaczy zadanie jako ukończone. Jeśli jakieś zadania są nadal uruchomione (inne niż wersja zadania), te zadania zostaną zakończone. W przypadku wartości false ukończenie zadania Menedżera zadań nie ma wpływu na stan zadania. W takim przypadku należy użyć atrybutu onAllTasksComplete do zakończenia zadania lub jeśli klient lub użytkownik zakończy zadanie jawnie. Przykładem jest to, że Menedżer zadań tworzy zestaw zadań, ale nie podejmuje dalszej roli w ich wykonywaniu. Wartością domyślną jest true. Jeśli używasz atrybutów onAllTasksComplete i onTaskFailure do kontrolowania okresu istnienia zadania i korzystania z zadania Menedżera zadań tylko do tworzenia zadań dla zadania (nie do monitorowania postępu), należy pamiętać, aby ustawić killJobOnCompletion na wartość false.

outputFiles

Lista plików, które usługa Batch przekaże z węzła obliczeniowego po uruchomieniu wiersza polecenia.
W przypadku zadań z obsługą wiele wystąpień pliki zostaną przekazane tylko z węzła obliczeniowego, w którym jest wykonywane zadanie główne.

requiredSlots
  • integer

Liczba gniazd planowania wymaganych do uruchomienia zadania.
Domyślnym ustawieniem jest 1. Zadanie można zaplanować tylko w węźle obliczeniowym, jeśli węzeł ma wystarczającą ilość wolnego miejsca planowania. W przypadku zadań z obsługą wiele wystąpień musi to być 1.

resourceFiles

Lista plików, które usługa Batch pobierze do węzła obliczeniowego przed uruchomieniem wiersza polecenia.
Pliki wymienione poniżej tego elementu znajdują się w katalogu roboczym zadania. Istnieje maksymalny rozmiar listy plików zasobów. Po przekroczeniu maksymalnego rozmiaru żądanie zakończy się niepowodzeniem, a kod błędu odpowiedzi zostanie 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.

runExclusive
  • boolean

Czy zadanie Menedżera zadań wymaga wyłącznego użycia węzła obliczeniowego, w którym działa.
Jeśli wartość jest równa true, żadne inne zadania nie będą uruchamiane w tym samym węźle, tak długo, jak Menedżer zadań jest uruchomiony. W przypadku wartości false inne zadania mogą być uruchamiane jednocześnie z Menedżerem zadań w węźle obliczeniowym. Zadanie Menedżera zadań jest zwykle wykonywane względem współbieżnego limitu zadań węzła obliczeniowego, więc jest to istotne tylko w przypadku, gdy węzeł obliczeniowy zezwala na wiele współbieżnych zadań. Wartością domyślną jest true.

userIdentity

Tożsamość użytkownika, w ramach której jest uruchamiane zadanie Menedżera zadań.
W przypadku pominięcia zadanie zostanie uruchomione jako użytkownik niebędący użytkownikiem administracyjnym, który jest unikatowy dla tego zadania.

JobNetworkConfiguration

Konfiguracja sieci dla zadania.

Name Type Description
subnetId
  • string

Identyfikator zasobu usługi ARM podsieci sieci wirtualnej, w której węzły obliczeniowe, które uruchamiają zadania z zadania, zostaną przyłączone na czas trwania zadania. Ta wartość będzie działała tylko z pulą VirtualMachineConfiguration.
Sieć wirtualna musi znajdować się w tym samym regionie i subskrypcji co konto Azure Batch. Określona podsieć powinna mieć wystarczającą liczbę bezpłatnych adresów IP w celu pouwzględnienia liczby węzłów obliczeniowych, w których będą uruchamiane zadania z zadania. Może to być liczba węzłów obliczeniowych w puli. Nazwa główna usługi "MicrosoftAzureBatch" musi mieć rolę "Współautor klasycznej maszyny wirtualnej" Access Control opartą na rolach (RBAC) dla określonej sieci wirtualnej, aby usługa Azure Batch mogła zaplanować zadania w węzłach. Można to sprawdzić, sprawdzając, czy określona Sieć wirtualna ma wszystkie skojarzone sieciowe grupy zabezpieczeń (sieciowej grupy zabezpieczeń). Jeśli komunikacja z węzłami w określonej podsieci zostanie odrzucona przez sieciowej grupy zabezpieczeń, usługa Batch ustawi stan węzłów obliczeniowych na niezdatny do użytku. Jest to formularz/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. Jeśli określona Sieć wirtualna ma wszystkie skojarzone sieciowe grupy zabezpieczeń (sieciowej grupy zabezpieczeń), to w przypadku komunikacji przychodzącej z usługi Azure Batch należy włączyć kilka zarezerwowanych portów systemowych. W przypadku pul utworzonych za pomocą konfiguracji maszyny wirtualnej Włącz porty 29876 i 29877, a także port 22 dla systemu Linux i Port 3389 w systemie Windows. Port 443 jest również wymagany do otwarcia dla połączeń wychodzących na potrzeby komunikacji z usługą Azure Storage. Aby uzyskać więcej informacji, zobacz: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

JobPreparationTask

Zadanie przygotowania zadania do uruchomienia przed zadaniami w danym węźle obliczeniowym.

Name Type Description
commandLine
  • string

Wiersz polecenia zadania przygotowania zadania.
Wiersz polecenia nie jest uruchamiany w ramach powłoki i w związku z tym nie może korzystać z funkcji powłoki, takich jak rozszerzenie zmiennej środowiskowej. Jeśli chcesz korzystać z tych funkcji, należy wywołać powłokę w wierszu polecenia, na przykład za pomocą polecenia "cmd/c-Command" w systemie Windows lub "/bin/sh-c webcommand" (system Linux). Jeśli wiersz polecenia odwołuje się do ścieżek plików, należy użyć ścieżki względnej (względem katalogu roboczego zadania) lub użyć zmiennej środowiskowej dostarczonej przez partię ( https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) .

constraints

Ograniczenia dotyczące zadania przygotowania zadania.

containerSettings

Ustawienia dla kontenera, w którym uruchamiane jest zadanie przygotowania zadania.
Gdy ta wartość jest określona, wszystkie katalogi cyklicznie poniżej AZ_BATCH_NODE_ROOT_DIR (katalog główny Azure Batch katalogów w węźle) są mapowane na kontener, wszystkie zmienne środowiskowe zadań są mapowane do kontenera, a wiersz polecenia zadania jest wykonywany w kontenerze. Pliki utworzone w kontenerze poza AZ_BATCH_NODE_ROOT_DIR mogą nie być odzwierciedlone na dysku hosta, co oznacza, że interfejsy API plików wsadowych nie będą mogły uzyskać dostępu do tych plików.

environmentSettings

Lista ustawień zmiennych środowiskowych dla zadania przygotowania zadania.

id
  • string

Ciąg unikatowo identyfikujący zadanie przygotowania zadania w ramach zadania.
Identyfikator może zawierać dowolną kombinację znaków alfanumerycznych, w tym łączniki i podkreślenia i nie może zawierać więcej niż 64 znaków. Jeśli ta właściwość nie zostanie określona, usługa Batch przypisze wartość domyślną "jobpreparation". Żadne inne zadanie w zadaniu nie może mieć takiego samego identyfikatora jak zadanie przygotowania zadania. Jeśli spróbujesz przesłać zadanie o takim samym identyfikatorze, usługa Batch odrzuci żądanie z kodem błędu TaskIdSameAsJobPreparationTask; Jeśli wywołujesz interfejs API REST bezpośrednio, kod stanu HTTP to 409 (konflikt).

rerunOnNodeRebootAfterSuccess
  • boolean

Czy usługa Batch ma ponownie uruchamiać zadanie przygotowania zadania po ponownym uruchomieniu węzła obliczeniowego.
Zadanie przygotowania zadania jest zawsze uruchamiane ponownie, jeśli węzeł obliczeniowy jest odtwarzany z obrazu lub zadanie przygotowania zadania nie zostało ukończone (np. z powodu ponownego uruchomienia zadania). W związku z tym należy zawsze napisać zadanie przygotowania zadania do idempotentne i działać prawidłowo, jeśli zostanie uruchomione wiele razy. Wartością domyślną jest true.

resourceFiles

Lista plików, które usługa Batch pobierze do węzła obliczeniowego przed uruchomieniem wiersza polecenia.
Pliki wymienione poniżej tego elementu znajdują się w katalogu roboczym zadania. Istnieje maksymalny rozmiar listy plików zasobów. Po przekroczeniu maksymalnego rozmiaru żądanie zakończy się niepowodzeniem, a kod błędu odpowiedzi zostanie 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 uruchamiane zadanie przygotowania zadania.
W przypadku pominięcia zadanie zostanie uruchomione jako użytkownik niebędący administratorami unikatowymi względem zadania w węzłach obliczeniowych systemu Windows lub nieadministracyjnym unikatowym względem puli w węzłach obliczeniowych z systemem Linux.

waitForSuccess
  • boolean

Określa, czy usługa Batch ma czekać na pomyślne zakończenie zadania przygotowania zadania przed zaplanowaniem jakichkolwiek innych zadań zadania w węźle obliczeniowym. Zadanie przygotowania zadania zostało zakończone pomyślnie, jeśli zostanie zakończone z kodem zakończenia 0.
Jeśli wartość jest równa true, a zadanie przygotowania zadania kończy się niepowodzeniem w węźle, usługa Batch ponawia zadanie przygotowania zadania do maksymalnej liczby ponownych prób (jak określono w elemencie Constraints). Jeśli zadanie jeszcze nie zostało zakończone pomyślnie po wszystkich ponownych próbach, usługa Batch nie będzie planować zadań dla tego zadania w węźle. Węzeł pozostaje aktywny i uprawnia do uruchamiania zadań innych zadań. W przypadku wartości false usługa Batch nie będzie czekać na ukończenie zadania przygotowania zadania. W takim przypadku inne zadania zadania mogą rozpocząć wykonywanie w węźle obliczeniowym, podczas gdy zadanie przygotowania zadania jest nadal uruchomione. nawet jeśli zadanie przygotowania zadania nie powiedzie się, nowe zadania będą nadal planowane w węźle obliczeniowym. Wartością domyślną jest true.

JobReleaseTask

Zadanie zwolnienia zadania do uruchomienia po zakończeniu zadania w dowolnym węźle obliczeniowym, w którym uruchomiono zadanie.

Name Type Description
commandLine
  • string

Wiersz polecenia zadania zwolnienia zadania.
Wiersz polecenia nie jest uruchamiany w ramach powłoki i w związku z tym nie może korzystać z funkcji powłoki, takich jak rozszerzenie zmiennej środowiskowej. Jeśli chcesz korzystać z tych funkcji, należy wywołać powłokę w wierszu polecenia, na przykład za pomocą polecenia "cmd/c-Command" w systemie Windows lub "/bin/sh-c webcommand" (system Linux). Jeśli wiersz polecenia odwołuje się do ścieżek plików, należy użyć ścieżki względnej (względem katalogu roboczego zadania) lub użyć zmiennej środowiskowej dostarczonej przez partię ( https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) .

containerSettings

Ustawienia dla kontenera, w którym jest uruchamiane zadanie zwolnienia zadania.
Gdy ta wartość jest określona, wszystkie katalogi cyklicznie poniżej AZ_BATCH_NODE_ROOT_DIR (katalog główny Azure Batch katalogów w węźle) są mapowane na kontener, wszystkie zmienne środowiskowe zadań są mapowane do kontenera, a wiersz polecenia zadania jest wykonywany w kontenerze. Pliki utworzone w kontenerze poza AZ_BATCH_NODE_ROOT_DIR mogą nie być odzwierciedlone na dysku hosta, co oznacza, że interfejsy API plików wsadowych nie będą mogły uzyskać dostępu do tych plików.

environmentSettings

Lista ustawień zmiennych środowiskowych dla zadania zwolnienia zadania.

id
  • string

Ciąg unikatowo identyfikujący zadanie zwolnienia zadania w ramach zadania.
Identyfikator może zawierać dowolną kombinację znaków alfanumerycznych, w tym łączniki i podkreślenia i nie może zawierać więcej niż 64 znaków. Jeśli ta właściwość nie zostanie określona, usługa Batch przypisze wartość domyślną "jobrelease". Żadne inne zadanie w zadaniu nie może mieć takiego samego identyfikatora jak zadanie zwolnienia zadania. Jeśli spróbujesz przesłać zadanie o takim samym identyfikatorze, usługa Batch odrzuci żądanie z kodem błędu TaskIdSameAsJobReleaseTask; Jeśli wywołujesz interfejs API REST bezpośrednio, kod stanu HTTP to 409 (konflikt).

maxWallClockTime
  • string

Maksymalny czas, przez jaki zadanie zwolnienia zadania może zostać uruchomione w danym węźle obliczeniowym, mierzone od momentu uruchomienia zadania. Jeśli zadanie nie zostanie ukończone w określonym czasie, usługa Batch zakończy działanie. 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 interfejs API REST jest wywoływany bezpośrednio, 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 zostanie 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.
Pliki wymienione poniżej tego elementu znajdują się w katalogu roboczym zadania.

retentionTime
  • string

Minimalny czas zachowywania 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ść.
Wartość domyślna to 7 dni, czyli katalog zadań zostanie zachowany przez 7 dni, chyba że węzeł obliczeniowy zostanie usunięty lub zadanie zostanie usunięte.

userIdentity

Tożsamość użytkownika, w ramach której jest uruchamiane zadanie zwolnienia zadania.
W przypadku pominięcia zadanie zostanie uruchomione jako użytkownik niebędący użytkownikiem administracyjnym, który jest unikatowy dla tego zadania.

JobScheduleAddParameter

Harmonogram zadań, który umożliwia cykliczne zadania przez określenie czasu uruchamiania zadań i specyfikacji używanych do tworzenia poszczególnych zadań.

Name Type Description
displayName
  • string

Nazwa wyświetlana harmonogramu.
Nazwa wyświetlana nie musi być unikatowa i może zawierać dowolne znaki Unicode o maksymalnej długości 1024.

id
  • string

Ciąg unikatowo identyfikujący harmonogram w ramach konta.
Identyfikator może zawierać dowolną kombinację znaków alfanumerycznych, w tym łączniki i podkreślenia, i nie może zawierać więcej niż 64 znaków. Identyfikator uwzględnia wielkość liter i uwzględnia wielkość liter (oznacza to, że nie ma dwóch identyfikatorów na koncie, które różnią się tylko wielkością liter).

jobSpecification

Szczegóły zadań, które mają zostać utworzone w ramach tego harmonogramu.

metadata

Lista par nazwa-wartość skojarzonych z harmonogramem jako metadane.
Usługa Batch nie przypisuje żadnych znaczenia do metadanych; służy wyłącznie do korzystania z kodu użytkownika.

schedule

Harmonogram zależny od tego, które zadania zostaną utworzone.

JobSpecification

Określa szczegóły zadań, które mają zostać utworzone zgodnie z harmonogramem.

Name Type Description
commonEnvironmentSettings

Lista typowych ustawień zmiennych środowiskowych. Te zmienne środowiskowe są ustawiane dla wszystkich zadań w zadaniach utworzonych w ramach tego harmonogramu (w tym Menedżer zadań, przygotowanie zadania i zadania zwolnienia zadania).
Poszczególne zadania mogą przesłonić ustawienie środowiska określone w tym miejscu przez określenie tej samej nazwy ustawienia z inną wartością.

constraints

Ograniczenia wykonania dla zadań utworzonych w ramach tego harmonogramu.

displayName
  • string

Nazwa wyświetlana dla zadań utworzonych w ramach tego harmonogramu.
Nazwa nie musi być unikatowa i może zawierać dowolne znaki Unicode o maksymalnej długości 1024.

jobManagerTask

Szczegóły zadania Menedżera zadań, które mają zostać uruchomione, gdy zadanie zostanie uruchomione w ramach tego harmonogramu.
Jeśli zadanie nie określa zadania Menedżera zadań, użytkownik musi jawnie dodać zadania do zadania za pomocą interfejsu API zadań. Jeśli zadanie Określa zadanie Menedżera zadań, usługa Batch tworzy zadanie Menedżera zadań, gdy zadanie zostanie utworzone i spróbuje zaplanować zadanie Menedżera zadań przed zaplanowaniem innych zadań w zadaniu.

jobPreparationTask

Zadanie przygotowania zadania dla zadań utworzonych w ramach tego harmonogramu.
Jeśli zadanie zawiera zadanie przygotowania zadania, usługa Batch uruchomi zadanie przygotowania zadania w węźle przed rozpoczęciem wykonywania zadań tego zadania w tym węźle obliczeniowym.

jobReleaseTask

Zadanie zwolnienia zadania dla zadań utworzonych w ramach tego harmonogramu.
Głównym celem zadania zwolnienia zadania jest cofnięcie zmian w węzłach wykonywanych przez zadanie przygotowania zadania. Przykładowe działania obejmują usuwanie plików lokalnych lub zamykanie usług, które zostały uruchomione w ramach przygotowania zadania. Zadanie zwolnienia zadania nie może zostać określone bez również określania zadania przygotowania zadania dla tego zadania. Usługa Batch uruchamia zadanie zwolnienia zadania w węzłach obliczeniowych, na których uruchomiono zadanie przygotowania zadania.

metadata

Lista par nazwa-wartość skojarzonych z poszczególnymi zadaniami utworzonymi w ramach tego harmonogramu jako metadanych.
Usługa Batch nie przypisuje żadnych znaczenia do metadanych; służy wyłącznie do korzystania z kodu użytkownika.

networkConfiguration

Konfiguracja sieci dla zadania.

onAllTasksComplete

Akcja, którą usługa Batch powinna wykonać, gdy wszystkie zadania w zadaniu utworzonym w ramach tego harmonogramu są w stanie ukończone.
Należy pamiętać, że jeśli zadanie nie zawiera żadnych zadań, wszystkie zadania są uważane za ukończone. Ta opcja jest najczęściej używana z zadaniem Menedżera zadań; Jeśli chcesz użyć automatycznego kończenia zadania bez Menedżera zadań, najpierw należy ustawić onAllTasksComplete na NoAction i zaktualizować właściwości zadania, aby ustawić onAllTasksComplete na terminatejob po zakończeniu dodawania zadań. Wartość domyślna to NoAction.

onTaskFailure

Akcja, którą usługa Batch powinna wykonać, gdy dowolne zadanie zakończy się niepowodzeniem w ramach zadania utworzonego w ramach tego harmonogramu. Zadanie jest uznawane za niepowodzenie, jeśli zakończyło się niepowodzeniem, jeśli ma failureInfo. FailureInfo jest ustawiona, jeśli zadanie kończy się kodem zakończenia innym niż zero po wyczerpaniu liczby ponownych prób lub jeśli wystąpił błąd podczas uruchamiania zadania, na przykład z powodu błędu pobierania pliku zasobu.
Wartość domyślna to NoAction.

poolInfo

Pula, w której usługa Batch uruchamia zadania utworzone w ramach tego harmonogramu.

priority
  • integer

Priorytet zadań utworzonych w ramach tego harmonogramu.
Wartości priorytetów mogą naliczane do zakresu od-1000 do 1000, z-1000, jako najniższy priorytet i 1000 jest najwyższy priorytet. Wartość domyślna to 0. Ten priorytet jest używany jako domyślny dla wszystkich zadań w ramach harmonogramu zadań. Priorytet zadania można zaktualizować po jego utworzeniu przy użyciu interfejsu API zadań aktualizacji.

usesTaskDependencies
  • boolean

Czy zadania w zadaniu mogą definiować zależności od siebie. Wartością domyślną jest false.

LinuxUserConfiguration

Właściwości służące do tworzenia konta użytkownika w węźle obliczeniowym systemu Linux.

Name Type Description
gid
  • integer

Identyfikator grupy dla konta użytkownika.
Właściwości UID i GID muszą być określone razem lub wcale. Jeśli nie zostanie określony, podstawowy system operacyjny wybiera identyfikator GID.

sshPrivateKey
  • string

Klucz prywatny SSH dla konta użytkownika.
Klucz prywatny nie może być chroniony hasłem. Klucz prywatny służy do automatycznego konfigurowania uwierzytelniania opartego na kluczach asymetrycznych dla protokołu SSH między węzłami obliczeniowymi w puli systemu Linux, gdy właściwość enableInterNodeCommunication puli ma wartość true (jest ignorowana, jeśli enableInterNodeCommunication ma wartość false). Robi to poprzez umieszczenie pary kluczy w katalogu. SSH użytkownika. Jeśli nie zostanie określony, protokół SSH bez hasła nie jest skonfigurowany między węzłami obliczeniowymi (nie jest wykonywane żadne modyfikacje katalogu SSH użytkownika).

uid
  • integer

Identyfikator użytkownika konta użytkownika.
Właściwości UID i GID muszą być określone razem lub wcale. Jeśli nie zostanie określony, podstawowy system operacyjny wybiera identyfikator UID.

LoginMode

Tryb logowania dla użytkownika

Name Type Description
batch
  • string

Tryb logowania LOGON32_LOGON_BATCH Win32. Tryb logowania wsadowego jest zalecany dla długotrwałych procesów równoległych.

interactive
  • string

Tryb logowania LOGON32_LOGON_INTERACTIVE Win32. Funkcja Kontrola konta użytkownika jest włączona w pulach VirtualMachineConfiguration systemu Windows. Jeśli ta opcja jest używana z podwyższonym poziomem uprawnień użytkownika w puli VirtualMachineConfiguration systemu Windows, sesja użytkownika nie zostanie podwyższona, chyba że aplikacja wykonywana przez wiersz polecenia zadania zostanie skonfigurowana w taki sposób, aby zawsze wymagała uprawnień administracyjnych lub zawsze wymagała maksymalnego poziomu uprawnień.

MetadataItem

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

Name Type Description
name
  • string

Nazwa elementu metadanych.

value
  • string

Wartość elementu metadanych.

MountConfiguration

System plików do zainstalowania na każdym węźle.

Name Type Description
azureBlobFileSystemConfiguration

Kontener usługi Azure Storage do zainstalowania przy użyciu obiektu BLOB Odmów na każdym węźle.
Ta właściwość jest wzajemnie wykluczana z wszystkimi innymi właściwościami.

azureFileShareConfiguration

Udział plików platformy Azure do zainstalowania na każdym węźle.
Ta właściwość jest wzajemnie wykluczana z wszystkimi innymi właściwościami.

cifsMountConfiguration

System plików CIFS/SMB do zainstalowania na każdym węźle.
Ta właściwość jest wzajemnie wykluczana z wszystkimi innymi właściwościami.

nfsMountConfiguration

System plików NFS do zainstalowania na każdym węźle.
Ta właściwość jest wzajemnie wykluczana z wszystkimi innymi właściwościami.

NetworkConfiguration

Konfiguracja sieci dla puli.

Name Type Description
dynamicVNetAssignmentScope

Zakres dynamicznego przypisywania sieci wirtualnej.

endpointConfiguration

Konfiguracja punktów końcowych w węzłach obliczeniowych w puli usługi Batch.
Konfiguracja punktu końcowego puli jest obsługiwana tylko w pulach z właściwością virtualMachineConfiguration.

publicIPAddressConfiguration

Konfiguracja publicznego adresu IP dla węzłów obliczeniowych w puli usługi Batch.
Właściwość konfiguracji publicznego adresu IP jest obsługiwana tylko w pulach z właściwością virtualMachineConfiguration.

subnetId
  • string

Identyfikator zasobu 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}.
Sieć wirtualna musi znajdować się w tym samym regionie i subskrypcji co konto Azure Batch. Określona podsieć powinna mieć wystarczającą liczbę bezpłatnych adresów IP w celu porozumienia liczby węzłów obliczeniowych w puli. Jeśli podsieć nie ma wystarczającej liczby wolnych adresów IP, Pula spowoduje częściowe przydzielenie węzłów i wystąpi błąd zmiany rozmiaru. Nazwa główna usługi "MicrosoftAzureBatch" musi mieć rolę "Współautor klasycznej maszyny wirtualnej" Access Control opartą na rolach (RBAC) dla określonej sieci wirtualnej. Określona podsieć musi zezwalać na komunikację z usługi Azure Batch, aby można było zaplanować zadania w węzłach. Można to sprawdzić, sprawdzając, czy określona Sieć wirtualna ma wszystkie skojarzone sieciowe grupy zabezpieczeń (sieciowej grupy zabezpieczeń). Jeśli komunikacja z węzłami w określonej podsieci zostanie odrzucona przez sieciowej grupy zabezpieczeń, usługa Batch ustawi stan węzłów obliczeniowych na niezdatny do użytku. W przypadku pul utworzonych za pomocą virtualMachineConfiguration są obsługiwane tylko sieci wirtualne ARM ("Microsoft. Network/virtualNetworks"), ale w przypadku pul utworzonych przy użyciu cloudServiceConfiguration zarówno ARM, jak i klasycznych sieci wirtualnych są obsługiwane. Jeśli określona sieć wirtualna ma skojarzone sieciowe grupy zabezpieczeń, należy włączyć kilka zarezerwowanych portów systemu na potrzeby komunikacji przychodzącej. W przypadku pul utworzonych za pomocą konfiguracji maszyny wirtualnej Włącz porty 29876 i 29877, a także port 22 dla systemu Linux i Port 3389 w systemie Windows. W przypadku pul utworzonych za pomocą konfiguracji usługi w chmurze Włącz porty 10100, 20100 i 30100. Należy również włączyć połączenia wychodzące do usługi Azure Storage na porcie 443. Aby uzyskać więcej informacji, zobacz: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Reguła sieciowej grupy zabezpieczeń, która ma zostać zastosowana do punktu końcowego ruchu przychodzącego.

Name Type Description
access

Akcja, która powinna zostać wykonana dla określonego adresu IP, zakresu podsieci lub tagu.

priority
  • integer

Priorytet dla tej reguły.
Priorytety w puli muszą być unikatowe i oceniane w kolejności priorytetu. Im niższa wartość, tym wyższy priorytet. Na przykład można określić reguły o numerach porządkowych 150, 250 i 350. Reguła o numerze porządkowym 150 ma pierwszeństwo przed regułą z kolejnością 250. Dozwolone priorytety są 150 do 4096. Jeśli są podane jakiekolwiek zastrzeżone lub zduplikowane wartości, żądanie kończy się niepowodzeniem z kodem stanu HTTP 400.

sourceAddressPrefix
  • string

Prefiks adresu źródłowego lub znacznik odpowiadający regule.
Prawidłowe wartości to pojedynczy adres IP (tj. 10.10.10.10), podsieć IP (tj. 192.168.1.0/24), tag domyślny lub * (dla wszystkich adresów). Jeśli są podane inne wartości, żądanie kończy się niepowodzeniem z kodem stanu HTTP 400.

sourcePortRanges
  • string[]

Zakresy portów źródłowych do dopasowania dla reguły.
Prawidłowe wartości to "" (dla wszystkich portów 0-65535), określony port (tj. 22) lub zakres portów (tj. 100-200). Porty muszą być z zakresu od 0 do 65535. Każdy wpis w tej kolekcji nie może pokrywać się z żadną inną pozycją (zakresem lub pojedynczym portem). Jeśli są podane inne wartości, żądanie kończy się niepowodzeniem z kodem stanu HTTP 400. Wartość domyślna to "".

NetworkSecurityGroupRuleAccess

Akcja, która powinna zostać wykonana dla określonego adresu IP, zakresu podsieci lub tagu.

Name Type Description
allow
  • string

Zezwalaj na dostęp.

deny
  • string

Odmów dostępu.

NFSMountConfiguration

Informacje używane do nawiązywania połączenia z systemem plików NFS.

Name Type Description
mountOptions
  • string

Dodatkowe opcje wiersza polecenia do przekazania do polecenia instalacji.
Są to opcje "net use" w opcjach Windows i "Mount" w systemie Linux.

relativeMountPath
  • string

Ścieżka względna w węźle obliczeniowym, w którym zostanie zainstalowany system plików
Wszystkie systemy plików są instalowane względem katalogu instalacji usługi Batch, dostępne za pośrednictwem zmiennej środowiskowej AZ_BATCH_NODE_MOUNTS_DIR.

source
  • string

Identyfikator URI systemu plików do zainstalowania.

OnAllTasksComplete

Akcja, którą usługa Batch powinna wykonać, gdy wszystkie zadania w zadaniu są w stanie ukończone.

Name Type Description
noaction
  • string

Nic nie robić. Zadanie pozostaje aktywne, chyba że zostało zakończone lub wyłączone w inny sposób.

terminatejob
  • string

Zakończ zadanie. TerminateReason zadania jest ustawiony na wartość "AllTasksComplete".

OnTaskFailure

Akcja, którą usługa Batch powinna wykonać, gdy dowolne zadanie w zadaniu zakończy się niepowodzeniem.

Name Type Description
noaction
  • string

Nic nie robić. Zadanie pozostaje aktywne, chyba że zostało zakończone lub wyłączone w inny sposób.

performexitoptionsjobaction
  • string

Wykonaj akcję skojarzoną z warunkiem zakończenia zadania w kolekcji exitConditions zadania. (Może to spowodować, że nie podejmowane są żadne akcje, jeśli jest to zadanie określone w tym obszarze).

OutputFile

Specyfikacja przekazywania plików z węzła obliczeniowego Azure Batch do innej lokalizacji po zakończeniu wykonywania zadania przez usługę Batch.

Name Type Description
destination

Miejsce docelowe plików wyjściowych.

filePattern
  • string

Wzorzec wskazujący, które pliki do przekazania.
Obsługiwane są zarówno ścieżki względne, jak i bezwzględne. Ścieżki względne są względne dla katalogu roboczego zadania. Obsługiwane są następujące symbole wieloznaczne: * dopasowuje 0 lub więcej znaków (na przykład wzorzec ABC * byłoby zgodny z ABC lub abcdef), * * dopasowuje dowolny katalog? Dopasowuje dowolny pojedynczy znak, [abc] dopasowuje jeden znak w nawiasach, a [a-c] dopasowuje jeden znak z zakresu. Nawiasy mogą zawierać negację, aby dopasować dowolny znak, który nie został określony (na przykład [! abc] dopasowuje dowolny znak, a, b lub c). Jeśli nazwa pliku zaczyna się od "." jest domyślnie ignorowana, ale może być dopasowana przez bezpośrednie określenie go (na przykład . gif nie będzie zgodne .a.gif, ale. GIF będzie. Prosty przykład: ** * . txt dopasowuje dowolny plik, który nie zaczyna się znakiem "." i kończąc na. txt w katalogu roboczym zadania lub w dowolnym podkatalogu. Jeśli nazwa pliku zawiera symbol wieloznaczny, można użyć nawiasów kwadratowych (na przykład ABC [*] pasuje do pliku o nazwie ABC *). Należy zauważyć, że oba elementy \ i/są traktowane jako separatory katalogów w systemie Windows, ale tylko/jest w systemie Linux. Zmienne środowiskowe (% var% w systemie Windows lub $var na komputerze z systemem Linux) są rozwinięte przed zastosowaniem wzorca.

uploadOptions

Dodatkowe opcje dla operacji przekazywania, w tym informacje o warunkach do przeprowadzenia przekazywania.

OutputFileBlobContainerDestination

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

Name Type Description
containerUrl
  • string

Adres URL kontenera w usłudze Azure Blob Storage, do którego mają zostać przekazane pliki.
Adres URL musi zawierać dostęp do sygnatury dostępu współdzielonego (SAS) do kontenera.

path
  • string

Docelowy obiekt BLOB lub katalog wirtualny w kontenerze usługi Azure Storage.
Jeśli filePattern odwołuje się do określonego pliku (tj. nie zawiera symboli wieloznacznych), a następnie Path to nazwa obiektu BLOB, do którego ma zostać przekazany ten plik. Jeśli filePattern zawiera jeden lub więcej symboli wieloznacznych (i w związku z tym może być zgodny z wieloma plikami), to ścieżka jest nazwą katalogu wirtualnego obiektów BLOB (który jest dołączany do poszczególnych nazw obiektów BLOB), do którego mają zostać przekazane pliki. W przypadku pominięcia pliki są przekazywane do katalogu głównego kontenera z nazwą obiektu BLOB pasującą do nazwy pliku.

OutputFileDestination

Miejsce docelowe, do którego plik powinien zostać przekazany.

Name Type Description
container

Lokalizacja w magazynie obiektów blob platformy Azure, do której przekazywane są pliki.

OutputFileUploadCondition

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

Name Type Description
taskcompletion
  • string

Przekaż pliki po zakończeniu procesu zadania, niezależnie od tego, jak miał kod zakończenia.

taskfailure
  • string

Przekaż pliki tylko po zakończeniu procesu zadania z kodem zakończenia o wartości niezerowej.

tasksuccess
  • string

Przekaż pliki tylko po zakończeniu procesu zadania z kodem zakończenia równym 0.

OutputFileUploadOptions

Szczegółowe informacje o operacji przekazywania pliku wyjściowego, w tym o warunkach do przeprowadzenia przekazywania.

Name Type Description
uploadCondition

Warunki, w których należy przekazać plik wyjściowy zadania lub zestaw plików.
Wartość domyślna to taskcompletion.

PoolEndpointConfiguration

Konfiguracja punktu końcowego dla puli.

Name Type Description
inboundNATPools

Lista pul NAT dla ruchu przychodzącego, które mogą być używane do obsługi określonych portów w zewnętrznym węźle obliczeniowym.
Maksymalna liczba przychodzących pul NAT na pulę wsadową wynosi 5. W przypadku przekroczenia maksymalnej liczby przychodzących pul NAT żądanie kończy się niepowodzeniem z kodem stanu HTTP 400. Nie można określić, jeśli IPAddressProvisioningType jest NoPublicIPAddresses.

PoolInformation

Określa sposób, w jaki zadanie powinno być przypisane do puli.

Name Type Description
autoPoolSpecification

Charakterystyka tymczasowej puli "autopool". Usługa Batch utworzy tę pulę Auto, gdy zadanie zostanie przesłane.
Jeśli utworzenie puli nie powiedzie się, usługa Batch przeniesie zadanie do stanu ukończone, a w właściwości błędu planowania zadania zostanie ustawiony błąd tworzenia puli. Usługa Batch zarządza okresem istnienia (zarówno tworzeniem, jak i, o ile nie określono utrzymywania aktywności, usuwania) puli. Wszystkie akcje użytkownika, które mają wpływ na okres istnienia puli, gdy zadanie jest aktywne, spowodują nieoczekiwane zachowanie. Należy określić identyfikator puli lub Specyfikacja autopuli, ale nie oba te elementy.

poolId
  • string

Identyfikator istniejącej puli. Wszystkie zadania zadania zostaną uruchomione w określonej puli.
Musisz się upewnić, że Pula, do której odwołuje się ta właściwość, już istnieje. Jeśli pula nie istnieje w momencie, gdy usługa Batch próbuje zaplanować zadanie, żadne zadania nie zostaną uruchomione do momentu utworzenia puli o tym identyfikatorze. Należy pamiętać, że usługa Batch nie odrzuci żądania zadania; po prostu nie będzie ona uruchamiać zadań do momentu, aż Pula już istnieje. Należy określić identyfikator puli lub Specyfikacja autopuli, ale nie oba te elementy.

PoolLifetimeOption

Minimalny okres istnienia utworzonych pul autopule oraz sposób przypisywania wielu zadań zgodnie z harmonogramem do pul.

Name Type Description
job
  • string

Pula istnieje dla okresu istnienia zadania, dla którego jest dedykowana. Usługa Batch tworzy pulę podczas tworzenia zadania. Jeśli opcja "Job" została zastosowana do harmonogramu zadań, usługa Batch tworzy nową pulę automatycznie dla każdego zadania utworzonego zgodnie z harmonogramem.

jobschedule
  • string

Pula istnieje dla okresu 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ń, nie do zadań.

PoolSpecification

Specyfikacja tworzenia nowej puli.

Name Type Description
applicationLicenses
  • string[]

Lista licencji aplikacji, które usługa Batch udostępni w każdym węźle obliczeniowym w puli.
Lista licencji aplikacji musi być podzbiorem dostępnych licencji aplikacji usługi Batch. Jeśli zażądano licencji, która nie jest obsługiwana, tworzenie puli zakończy się niepowodzeniem. Dozwolone licencje dostępne w puli to "Maya", "VRay", "3dsMax", "Arnold". Dodatkowa opłata dotyczy każdej licencji aplikacji dodanej do puli.

applicationPackageReferences

Lista pakietów do zainstalowania na każdym węźle obliczeniowym w puli.
Zmiany w odwołaniach do pakietów mają wpływ na wszystkie nowe węzły łączące się z pulą, ale nie mają wpływu na węzły obliczeniowe, które znajdują się już w puli, dopóki nie zostaną ponownie uruchomione lub odłączone. W danej puli znajduje się maksymalnie 10 odwołań do pakietów.

autoScaleEvaluationInterval
  • string

Przedział czasu, w którym ma zostać automatycznie dostosowany rozmiar puli zgodnie z formułą skalowania automatycznego.
Wartość domyślna to 15 minut. Minimalna i maksymalna wartość to 5 minut i 168 godzin. W przypadku określenia wartości mniejszej niż 5 minut lub więcej niż 168 godzin usługa Batch odrzuca żądanie z nieprawidłowym błędem wartości właściwości; Jeśli interfejs API REST jest wywoływany bezpośrednio, kod stanu HTTP to 400 (Nieprawidłowe żądanie).

autoScaleFormula
  • string

Formuła dla żądanej liczby węzłów obliczeniowych w puli.
Ta właściwość nie może być określona, jeśli enableAutoScale ma wartość false. Jest to wymagane, jeśli enableAutoScale ma wartość true. Formuła jest sprawdzana pod kątem poprawności przed utworzeniem puli. Jeśli formuła jest nieprawidłowa, usługa Batch odrzuca żądanie ze szczegółowymi informacjami o błędzie.

certificateReferences

Lista certyfikatów, które mają być zainstalowane na każdym węźle obliczeniowym w puli.
W przypadku węzłów systemu Windows usługa Batch instaluje certyfikaty do określonego magazynu certyfikatów i lokalizacji. W przypadku węzłów obliczeniowych systemu Linux certyfikaty są przechowywane w katalogu w katalogu roboczym zadania i zmienna środowiskowa AZ_BATCH_CERTIFICATES_DIR jest dostarczana do zadania zapytania o tę lokalizację. W przypadku certyfikatów z widocznością "remoteUser" jest tworzony katalog "certyfikaty" w katalogu macierzystym użytkownika (np./home/{user-name}/certs), a certyfikaty są umieszczane w tym katalogu.

cloudServiceConfiguration

Konfiguracja usługi w chmurze dla puli.
Należy określić tę właściwość, jeśli Pula musi być utworzona przy użyciu maszyn wirtualnych usługi Azure PaaS. Ta właściwość i virtualMachineConfiguration wzajemnie się wykluczają, a jedna z właściwości musi być określona. Jeśli żaden z nich nie zostanie określony, usługa Batch zwróci błąd; Jeśli interfejs API REST jest wywoływany bezpośrednio, kod stanu HTTP to 400 (Nieprawidłowe żądanie). Nie można określić tej właściwości, jeśli konto wsadowe zostało utworzone z właściwością poolAllocationMode ustawioną na wartość "UserSubscription".

displayName
  • string

Nazwa wyświetlana puli.
Nazwa wyświetlana nie musi być unikatowa i może zawierać dowolne znaki Unicode o maksymalnej długości 1024.

enableAutoScale
  • boolean

Określa, czy rozmiar puli ma być automatycznie dostosowywany w miarę upływu czasu.
W przypadku wartości false należy określić co najmniej jedną z targetDedicateNodes i targetLowPriorityNodes. W przypadku wartości true wymagany jest element autoScaleFormula. Pula automatycznie zmienia rozmiar zgodnie z formułą. Wartość domyślna to false.

enableInterNodeCommunication
  • boolean

Czy pula zezwala na bezpośrednią komunikację między węzłami obliczeniowymi.
Włączenie komunikacji między węzłami ogranicza maksymalny rozmiar puli z powodu ograniczeń wdrożenia w węzłach obliczeniowych puli. Może to spowodować, że pula nie osiągnie żądanego rozmiaru. Wartość domyślna to false.

metadata

Lista par nazwa-wartość skojarzonych z pulą jako metadane.
Usługa Batch nie przypisuje żadnych znaczenia do metadanych; służy wyłącznie do korzystania z kodu użytkownika.

mountConfiguration

Lista systemów plików do zainstalowania na każdym węźle w puli.
Obsługuje to Azure Files, NFS, CIFS/SMB i Blobfuse.

networkConfiguration

Konfiguracja sieci dla puli.
Konfiguracja sieci dla puli.

resizeTimeout
  • string

Limit czasu przydziału węzłów obliczeniowych do puli.
Ten limit czasu ma zastosowanie tylko do skalowania ręcznego; nie ma ono wpływu, gdy enableAutoScale ma wartość true. Wartość domyślna to 15 minut. Minimalna wartość to 5 minut. W przypadku określenia wartości mniejszej niż 5 minut usługa Batch odrzuca żądanie z powodu błędu; Jeśli interfejs API REST jest wywoływany bezpośrednio, kod stanu HTTP to 400 (Nieprawidłowe żądanie).

startTask

Zadanie do uruchomienia na każdym węźle obliczeniowym w miarę dołączania do puli. Zadanie jest uruchamiane po dodaniu węzła obliczeniowego do puli lub po ponownym uruchomieniu węzła obliczeniowego.
Zadanie wsadowe zostanie ponowione w przypadku wyzwolenia operacji odzyskiwania w węźle. Przykłady operacji odzyskiwania obejmują (ale nie są ograniczone do) po ponownym uruchomieniu węzła w złej kondycji lub węźle obliczeniowym, z powodu awarii hosta. Ponowne próby wynikające z operacji odzyskiwania są niezależne od i nie są wliczane do maxTaskRetryCount. Nawet jeśli maxTaskRetryCount jest równa 0, może wystąpić wewnętrzna ponowna próba spowodowana operacją odzyskiwania. Z tego powodu wszystkie zadania powinny być idempotentne. Oznacza to, że zadania muszą być tolerowane i uruchamiane ponownie bez powodowania uszkodzenia lub zduplikowanych danych. Najlepszym rozwiązaniem dla długotrwałych zadań jest użycie niektórych form tworzenia punktów kontrolnych. W niektórych przypadkach StartTask może być ponownie uruchomiona, mimo że węzeł obliczeniowy nie został jeszcze uruchomiony. Należy zwrócić szczególną uwagę na to, aby uniknąć StartTasks, w którym można tworzyć procesy Breakaway lub instalować i uruchamiać usługi z katalogu roboczego StartTask, ponieważ spowoduje to zablokowanie możliwości ponownego uruchomienia StartTask przez usługę Batch.

targetDedicatedNodes
  • integer

Wymagana liczba dedykowanych węzłów obliczeniowych w puli.
Ta właściwość nie może być określona, jeśli enableAutoScale ma wartość true. Jeśli enableAutoScale ma wartość false, należy ustawić wartość targetDedicatedNodes, targetLowPriorityNodes lub Both.

targetLowPriorityNodes
  • integer

Wymagana liczba węzłów obliczeniowych o niskim priorytecie w puli.
Ta właściwość nie może być określona, jeśli enableAutoScale ma wartość true. Jeśli enableAutoScale ma wartość false, należy ustawić wartość targetDedicatedNodes, targetLowPriorityNodes lub Both.

taskSchedulingPolicy

Sposób dystrybuowania zadań w węzłach obliczeniowych w puli.
Jeśli nie zostanie określony, wartość domyślna to rozpraszanie.

taskSlotsPerNode
  • integer

Liczba gniazd zadań, których można użyć do uruchamiania współbieżnych zadań w pojedynczym węźle obliczeniowym w puli.
Wartość domyślna to 1. Wartość maksymalna jest mniejsza z 4 razy większa niż liczba rdzeni vmSize puli lub 256.

userAccounts

Lista kont użytkowników, które mają zostać utworzone w każdym węźle obliczeniowym w puli.

virtualMachineConfiguration

Konfiguracja maszyny wirtualnej dla puli.
Należy określić tę właściwość, jeśli Pula musi być utworzona przy użyciu maszyn wirtualnych usługi Azure IaaS. Ta właściwość i cloudServiceConfiguration wzajemnie się wykluczają, a jedna z właściwości musi być określona. Jeśli żaden z nich nie zostanie określony, usługa Batch zwróci błąd; Jeśli interfejs API REST jest wywoływany bezpośrednio, kod stanu HTTP to 400 (Nieprawidłowe żądanie).

vmSize
  • string

Rozmiar maszyn wirtualnych w puli. Wszystkie maszyny wirtualne w puli mają ten sam rozmiar.
Aby uzyskać informacje o dostępnych rozmiarach maszyn wirtualnych w pulach, zobacz Wybieranie rozmiaru maszyny wirtualnej dla węzłów obliczeniowych w puli Azure Batch ( https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes) .

PublicIPAddressConfiguration

Konfiguracja publicznego adresu IP konfiguracji sieciowej puli.

Name Type Description
ipAddressIds
  • string[]

Lista publicznych adresów IP, które będą używane przez usługę Batch podczas aprowizacji węzłów obliczeniowych.
Liczba adresów IP określona w tym miejscu ogranicza maksymalny rozmiar puli-100 dedykowanych węzłów lub 100 węzły o niskim priorytecie mogą być przydzielane dla każdego publicznego adresu IP. Na przykład Pula, w której wymagane są 250 dedykowanych maszyn wirtualnych, potrzebuje co najmniej 3 określonych publicznych adresów IP. Każdy element tej kolekcji ma postać:/subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

provision

Typ aprowizacji dla Publiczne adresy IP dla puli.
Wartość domyślna to BatchManaged.

ResourceFile

Pojedynczy plik lub wiele plików do pobrania w węźle obliczeniowym.

Name Type Description
autoStorageContainerName
  • string

Nazwa kontenera magazynu na koncie magazynu.
Właściwości autoStorageContainerName, storageContainerUrl i httpUrl wzajemnie się wykluczają i należy określić jeden z nich.

blobPrefix
  • string

Prefiks obiektu BLOB do użycia podczas pobierania obiektów blob z kontenera usługi Azure Storage. Zostaną pobrane tylko obiekty blob, których nazwy rozpoczynają się od określonego prefiksu.
Właściwość jest prawidłowa tylko wtedy, gdy jest używany autoStorageContainerName lub storageContainerUrl. Ten prefiks może być częściową nazwą pliku lub podkatalogiem. Jeśli prefiks nie zostanie określony, zostaną pobrane wszystkie pliki w kontenerze.

fileMode
  • string

Atrybut trybu uprawnień do pliku w formacie ósemkowym.
Ta właściwość ma zastosowanie tylko do plików pobieranych do węzłów obliczeniowych systemu Linux. Ta wartość zostanie zignorowana, jeśli zostanie określona dla resourceFile, która zostanie pobrana do węzła obliczeniowego systemu Windows. Jeśli ta właściwość nie jest 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órej mają zostać pobrane pliki, względem katalogu roboczego zadania.
Jeśli właściwość httpUrl jest określona, ścieżka pliku jest wymagana i opisuje ścieżkę, do której zostanie pobrany plik, łącznie z nazwą pliku. W przeciwnym razie, jeśli właściwość autoStorageContainerName lub storageContainerUrl jest określona, filePath jest opcjonalny i jest katalogiem, do którego mają być pobierane pliki. W przypadku, gdy ścieżka pliku jest używana 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 zostać wykorzystana z 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ć jeden z nich. Jeśli adres URL wskazuje na platformę Azure Blob Storage, musi być możliwy do odczytania przy użyciu dostępu anonimowego; oznacza to, że usługa Batch nie wystawia żadnych poświadczeń podczas pobierania obiektu BLOB. Istnieją dwa sposoby uzyskania takiego adresu URL dla obiektu BLOB w usłudze Azure Storage: Dołącz sygnaturę dostępu współdzielonego (SAS) udzielenie uprawnień do odczytu obiektu BLOB lub ustaw listę ACL dla obiektu BLOB lub jego kontenera, aby zezwolić na dostęp publiczny.

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ć jeden z nich. Ten adres URL musi być możliwy do odczytu i listy przy użyciu dostępu anonimowego; oznacza to, że usługa Batch nie zaprezentuje żadnych poświadczeń podczas pobierania obiektów blob z kontenera. Istnieją dwa sposoby uzyskania takiego adresu URL dla kontenera w usłudze Azure Storage: Dołącz sygnaturę dostępu współdzielonego (SAS) przyznającą uprawnienia do odczytu i listy dla kontenera lub ustaw listę ACL dla kontenera, aby umożliwić dostęp publiczny.

Schedule

Harmonogram, zgodnie z którym będą tworzone zadania

Name Type Description
doNotRunAfter
  • string

Czas, po którym zadanie nie zostanie utworzone w ramach tego harmonogramu zadań. Harmonogram zostanie przesunięty w stan ukończony, gdy tylko ten termin zostanie wklejony i nie będzie żadnych aktywnych zadań w ramach tego harmonogramu zadań.
Jeśli nie określisz czasu doNotRunAfter, a tworzysz cykliczny harmonogram zadań, harmonogram zadań pozostanie aktywny, dopóki nie zostanie on jawnie zamknięty.

doNotRunUntil
  • string

Najwcześniejsza godzina, o której można utworzyć dowolne zadanie w ramach tego harmonogramu zadań.
Jeśli nie określisz czasu doNotRunUntil, harmonogram będzie gotowy do natychmiastowego utworzenia zadań.

recurrenceInterval
  • string

Przedział czasu między godzinami rozpoczęcia dwóch kolejnych zadań zgodnie z harmonogramem zadania. Harmonogram zadań może mieć co najwyżej jedno aktywne zadanie w danym momencie.
Ponieważ Harmonogram zadań może mieć co najwyżej jedno aktywne zadanie w danym momencie, jeśli jest to czas na utworzenie nowego zadania w ramach harmonogramu zadań, ale poprzednie zadanie jest nadal uruchomione, usługa Batch nie utworzy nowego zadania, dopóki nie zakończy się poprzednie zadanie. Jeśli poprzednie zadanie nie zakończy się w startWindow okresie nowej recurrenceInterval, nie zostanie zaplanowane żadne nowe zadanie dla tego interwału. W przypadku zadań cyklicznych należy zwykle określić jobManagerTask w jobSpecification. Jeśli nie korzystasz z programu jobManagerTask, będzie potrzebny proces zewnętrzny do monitorowania czasu tworzenia zadań, dodawania zadań do zadań i kończenia zadań gotowych do następnego cyklu. Domyślnie harmonogram nie powtarza się: jedno zadanie jest tworzone w ramach startWindow po upływie doNotRunUntil czasu, a harmonogram zostanie ukończony zaraz po zakończeniu zadania. Wartość minimalna wynosi 1 minutę. W przypadku określenia niższej wartości usługa Batch odrzuca harmonogram z błędem; Jeśli interfejs API REST jest wywoływany bezpośrednio, kod stanu HTTP to 400 (Nieprawidłowe żądanie).

startWindow
  • string

Przedział czasu, rozpoczynając od momentu, w którym harmonogram wskazuje, że zadanie powinno zostać utworzone, w ramach którego należy utworzyć zadanie.
Jeśli zadanie nie zostanie utworzone w interwale startWindow, oznacza to, że "Szansa" zostanie utracona; żadne zadanie nie zostanie utworzone do następnego cyklu harmonogramu. Jeśli harmonogram jest cykliczny, a startWindow jest dłuższy niż interwał cyklu, to jest równoważne nieskończonemu startWindow, ponieważ zadanie, które ma wartość "zaległe" w jednej recurrenceInterval, nie jest przenoszone do następnego interwału cyklicznego. Wartość domyślna to nieskończoność. Wartość minimalna wynosi 1 minutę. W przypadku określenia niższej wartości usługa Batch odrzuca harmonogram z błędem; Jeśli interfejs API REST jest wywoływany bezpośrednio, kod stanu HTTP to 400 (Nieprawidłowe żądanie).

StartTask

Zadanie uruchamiane, gdy węzeł jest przyłączany do puli w usłudze Azure Batch lub gdy węzeł obliczeniowy jest ponownie uruchamiany lub odtwarzany z obrazu.

Name Type Description
commandLine
  • string

Wiersz polecenia StartTask.
Wiersz polecenia nie jest uruchamiany w ramach powłoki i w związku z tym nie może korzystać z funkcji powłoki, takich jak rozszerzenie zmiennej środowiskowej. Jeśli chcesz korzystać z tych funkcji, należy wywołać powłokę w wierszu polecenia, na przykład za pomocą polecenia "cmd/c-Command" w systemie Windows lub "/bin/sh-c webcommand" (system Linux). Jeśli wiersz polecenia odwołuje się do ścieżek plików, należy użyć ścieżki względnej (względem katalogu roboczego zadania) lub użyć zmiennej środowiskowej dostarczonej przez partię ( https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) .

containerSettings

Ustawienia dla kontenera, w którym działa StartTask.
Gdy ta wartość jest określona, wszystkie katalogi cyklicznie poniżej AZ_BATCH_NODE_ROOT_DIR (katalog główny Azure Batch katalogów w węźle) są mapowane na kontener, wszystkie zmienne środowiskowe zadań są mapowane do kontenera, a wiersz polecenia zadania jest wykonywany w kontenerze. Pliki utworzone w kontenerze poza AZ_BATCH_NODE_ROOT_DIR mogą nie być odzwierciedlone na dysku hosta, co oznacza, że interfejsy API plików wsadowych nie będą mogły uzyskać dostępu do tych plików.

environmentSettings

Lista ustawień zmiennych środowiskowych dla StartTask.

maxTaskRetryCount
  • integer

Maksymalna liczba prób wykonania zadania.
Usługa Batch ponawia próbę wykonania zadania, jeśli jego kod zakończenia jest różny od zera. Należy zauważyć, że ta wartość kontroluje liczbę ponownych prób. Usługa Batch spróbuje wykonać zadanie jeden raz, a następnie ponowić próbę wykonania tego limitu. Jeśli na przykład maksymalna liczba ponownych prób wynosi 3, zadanie wsadowe próbuje wykonać zadania 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 spróbuje wykonać zadania ponownie. Jeśli maksymalna liczba ponownych prób wynosi-1, usługa Batch ponowi próbę wykonania zadania bez ograniczenia.

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 zostanie 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.
Pliki wymienione poniżej tego elementu znajdują się w katalogu roboczym zadania.

userIdentity

Tożsamość użytkownika, w ramach której działa StartTask.
W przypadku pominięcia zadanie zostanie uruchomione jako użytkownik niebędący użytkownikiem administracyjnym, który jest unikatowy dla tego zadania.

waitForSuccess
  • boolean

Określa, czy usługa Batch ma czekać na pomyślne zakończenie StartTask (to oznacza, aby wyjść z kodem zakończenia 0) przed zaplanowaniem jakichkolwiek zadań w węźle obliczeniowym.
Jeśli wartość jest równa true, a StartTask kończy się niepowodzeniem w węźle, usługa Batch ponawia próbę StartTask do maksymalnej liczby ponownych prób (maxTaskRetryCount). Jeśli zadanie jeszcze nie zostało zakończone pomyślnie po wszystkich ponownych próbach, usługa Batch oznaczy węzeł jako bezużyteczny i nie zaplanuje do niego zadań. Ten warunek można wykryć za pomocą szczegółów stanu węzła obliczeniowego i informacji o błędzie. W przypadku wartości false usługa Batch nie czeka na zakończenie StartTask. W takim przypadku inne zadania mogą rozpocząć wykonywanie w węźle obliczeniowym, gdy nadal działa StartTask. nawet jeśli StartTask nie powiedzie się, nowe zadania będą nadal planowane w węźle obliczeniowym. Wartość domyślna to true.

StorageAccountType

Typ konta magazynu do użycia podczas tworzenia dysków z danymi.

Name Type Description
premium_lrs
  • string

Dysk danych powinien używać magazynu lokalnie nadmiarowego w warstwie Premium.

standard_lrs
  • string

Dysk danych powinien używać standardowego magazynu lokalnie nadmiarowego.

TaskConstraints

Ograniczenia wykonania, które mają zostać zastosowane do zadania.

Name Type Description
maxTaskRetryCount
  • integer

Maksymalna liczba prób wykonania zadania. Usługa Batch ponawia próbę wykonania zadania, jeśli jego kod zakończenia jest różny od zera.
Należy zauważyć, że ta wartość kontroluje liczbę ponownych prób dla pliku wykonywalnego zadania z powodu niezerowego kodu zakończenia. Usługa Batch spróbuje wykonać zadanie jeden raz, a następnie ponowić próbę wykonania tego limitu. Jeśli na przykład maksymalna liczba ponownych prób wynosi 3, zadanie wsadowe próbuje wykonać zadania 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 spróbuje wykonać zadania po pierwszej próbie. Jeśli maksymalna liczba ponownych prób wynosi-1, usługa Batch ponowi próbę wykonania zadania bez ograniczenia.

maxWallClockTime
  • string

Maksymalny czas, który upłynął, gdy zadanie może zostać uruchomione, mierzony od momentu uruchomienia zadania. Jeśli zadanie nie zostanie ukończone w określonym czasie, usługa Batch zakończy działanie.
Jeśli ta wartość nie jest określona, nie ma limitu czasu na czas, w którym zadanie może zostać uruchomione.

retentionTime
  • string

Minimalny czas zachowywania katalogu zadań w węźle obliczeniowym, w którym uruchomiono, od momentu ukończenia jego wykonywania. Po tym czasie usługa Batch może usunąć katalog zadań i całą jego zawartość.
Wartość domyślna to 7 dni, czyli katalog zadań zostanie zachowany przez 7 dni, chyba że węzeł obliczeniowy zostanie usunięty lub zadanie zostanie usunięte.

TaskContainerSettings

Ustawienia kontenera dla zadania.

Name Type Description
containerRunOptions
  • string

Dodatkowe opcje do polecenia Utwórz kontener.
Te dodatkowe opcje są dostarczane jako argumenty do polecenia "Docker Create" Oprócz tych, które są kontrolowane przez usługę Batch.

imageName
  • string

Obraz, który ma zostać użyty do utworzenia kontenera, w którym zadanie zostanie uruchomione.
To jest pełne odwołanie do obrazu, tak jak zostanie ono określone jako "docker pull". Jeśli żaden tag nie jest dostarczany jako część nazwy obrazu, tag ": Najnowsza" jest używany jako domyślny.

registry

Rejestr prywatny zawierający obraz kontenera.
To ustawienie można pominąć, jeśli zostało już podane podczas tworzenia puli.

workingDirectory

Lokalizacja katalogu roboczego zadania kontenera.
Wartość domyślna to "taskWorkingDirectory".

TaskSchedulingPolicy

Określa sposób dystrybuowania zadań między węzłami obliczeniowymi.

Name Type Description
nodeFillType

Sposób dystrybuowania zadań w węzłach obliczeniowych w puli.
Jeśli nie zostanie określony, wartość domyślna to rozpraszanie.

UserAccount

Właściwości służące do tworzenia użytkownika służącego do wykonywania zadań w węźle obliczeniowym Azure Batch.

Name Type Description
elevationLevel

Poziom podniesienia uprawnień konta użytkownika.
Wartość domyślna to unadmin.

linuxUserConfiguration

Konfiguracja użytkownika dotycząca systemu Linux dla konta użytkownika.
Ta właściwość jest ignorowana, jeśli została określona w puli systemu Windows. Jeśli nie zostanie określony, użytkownik zostanie utworzony z opcjami domyślnymi.

name
  • string

Nazwa konta użytkownika.

password
  • string

Hasło konta użytkownika.

windowsUserConfiguration

Konfiguracja użytkownika specyficzna dla systemu Windows dla konta użytkownika.
Tę właściwość można określić tylko wtedy, gdy użytkownik znajduje się w puli systemu Windows. Jeśli nie zostanie określony i w puli systemu Windows, użytkownik zostanie utworzony z opcjami domyślnymi.

UserIdentity

Definicja tożsamości użytkownika, pod którą uruchamiane jest zadanie.

Name Type Description
autoUser

Użytkownik będący użytkownikiem, pod którym uruchamiane jest zadanie.
Właściwości nazwy użytkownika i użytkownika są wzajemnie wykluczane; należy określić jeden, ale nie oba.

username
  • string

Nazwa tożsamości użytkownika, pod którą uruchamiane jest zadanie.
Właściwości nazwy użytkownika i użytkownika są wzajemnie wykluczane; należy określić jeden, ale nie oba.

VirtualMachineConfiguration

Konfiguracja węzłów obliczeniowych w puli w oparciu o infrastrukturę usługi Azure Virtual Machines.

Name Type Description
containerConfiguration

Konfiguracja kontenera dla puli.
Jeśli ta wartość jest określona, Instalator jest wykonywany w każdym węźle obliczeniowym w puli, aby umożliwić uruchamianie zadań w kontenerach. Wszystkie zwykłe zadania i zadania Menedżera zadań uruchomione w tej puli muszą określać Właściwość containerSettings, a wszystkie inne zadania mogą je określić.

dataDisks

Konfiguracja dysków danych podłączonych do węzłów obliczeniowych w puli.
Ta właściwość musi być określona, jeśli węzły obliczeniowe w puli muszą mieć dołączone do nich puste dyski danych. Nie można go zaktualizować. Każdy węzeł obliczeniowy pobiera swój własny dysk (dysk nie jest udziałem plików). Nie można dołączyć istniejących dysków, każdy dołączony dysk jest pusty. Po usunięciu węzła compute z puli zostanie również usunięty dysk i wszystkie skojarzone z nim dane. Dysk nie jest sformatowany po dołączeniu, należy go sformatować przed użyciem — Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux i https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine .

diskEncryptionConfiguration

Konfiguracja szyfrowania dysku dla puli.
Jeśli ta wartość jest określona, szyfrowanie jest wykonywane na każdym węźle w puli podczas aprowizacji węzła.

imageReference

Odwołanie do obrazu platformy Azure Virtual Machines Marketplace lub niestandardowego obrazu maszyny wirtualnej, który ma być używany.

licenseType
  • string

Typ licencji lokalnej, która ma być używana podczas wdrażania systemu operacyjnego.
Dotyczy to tylko obrazów zawierających system operacyjny Windows i powinna być używana tylko w przypadku przechowywania prawidłowych licencji lokalnych dla węzłów obliczeniowych, które zostaną wdrożone. W przypadku pominięcia nie zostanie zastosowana żadna lokalna stawka licencji. Wartości to:

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 partii do aprowizacji w węzłach obliczeniowych w puli.
Agent przetwarzania wsadowego usługi Batch jest programem, który działa w każdym węźle obliczeniowym w puli, oraz udostępnia interfejs poleceń i kontroli między węzłem obliczeniowym a usługą Batch. Istnieją różne implementacje agenta węzła obliczeniowego, nazywane jednostkami SKU dla różnych systemów operacyjnych. Należy określić jednostkę SKU agenta węzła obliczeniowego, która odpowiada wybranemu odwołaniu do obrazu. Aby uzyskać listę obsługiwanych jednostek SKU agenta węzła obliczeniowego wraz z listą zweryfikowanych odwołań do obrazu, zobacz operację "Lista obsługiwanych jednostek SKU agenta węzłów obliczeniowych".

windowsConfiguration

Ustawienia systemu operacyjnego Windows na maszynie wirtualnej.
Ta właściwość nie może być określona, jeśli właściwość elementu imagereference określa obraz systemu operacyjnego Linux.

WindowsConfiguration

Ustawienia systemu operacyjnego Windows, które mają zostać zastosowane do maszyny wirtualnej.

Name Type Description
enableAutomaticUpdates
  • boolean

Czy aktualizacje automatyczne są włączone na maszynie wirtualnej.
W przypadku pominięcia wartość domyślna to true.

WindowsUserConfiguration

Właściwości służące do tworzenia konta użytkownika w węźle obliczeniowym systemu Windows.

Name Type Description
loginMode

Tryb logowania dla użytkownika
Wartość domyślna dla pul VirtualMachineConfiguration to "Batch", a w przypadku pul CloudServiceConfiguration to "Interactive".