Job - List

Zobrazí seznam všech úloh v zadaném účtu.

GET {batchUrl}/jobs?api-version=2023-11-01.18.0
GET {batchUrl}/jobs?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
batchUrl
path True

string

Základní adresa URL pro všechny požadavky Azure Batch služby.

api-version
query True

string

Verze rozhraní API klienta.

$expand
query

string

Klauzule $expand OData.

$filter
query

string

Klauzule $filter OData. Další informace o vytváření tohoto filtru najdete v tématu https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs.

$select
query

string

Klauzule $select OData.

maxresults
query

integer

int32

Maximální počet položek, které se mají v odpovědi vrátit. Může se vrátit maximálně 1000 úloh.

timeout
query

integer

int32

Maximální doba, kterou může server strávit zpracováním požadavku( v sekundách). Výchozí hodnota je 30 sekund.

Hlavička požadavku

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

Name Vyžadováno Typ Description
client-request-id

string

uuid

Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez dekorace, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Určuje, jestli má server v odpovědi vrátit client-request-id.

ocp-date

string

date-time-rfc1123

Čas, kdy byla žádost vydána. Klientské knihovny obvykle nastavit na aktuální systémový čas hodin; pokud voláte rozhraní REST API přímo, explicitně ho nastavte.

Odpovědi

Name Typ Description
200 OK

CloudJobListResult

Odpověď obsahující seznam úloh.

Headers

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

BatchError

Chyba ze služby Batch.

Zabezpečení

azure_auth

Microsoft Entra tok ověřovacího kódu OAuth 2.0

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

Scopes

Name Description
user_impersonation Zosobnění uživatelského účtu

Authorization

Type: apiKey
In: header

Příklady

Job list

Sample Request

GET account.region.batch.azure.com/jobs?api-version=2023-11-01.18.0


Sample Response

{
  "value": [
    {
      "id": "jobId",
      "url": "https://account.region.batch.azure.com/jobs/jobId",
      "eTag": "0x8D4100FC46D5BF4",
      "lastModified": "2016-11-19T00:05:27.2137716Z",
      "creationTime": "2016-11-19T00:05:25.311915Z",
      "state": "active",
      "stateTransitionTime": "2016-11-19T00:05:27.2137716Z",
      "previousState": "disabled",
      "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z",
      "priority": 0,
      "maxParallelTasks": -1,
      "allowTaskPreemption": false,
      "usesTaskDependencies": false,
      "constraints": {
        "maxWallClockTime": "P10675199DT2H48M5.4775807S",
        "maxTaskRetryCount": 0
      },
      "poolInfo": {
        "poolId": "poolId"
      },
      "executionInfo": {
        "startTime": "2016-11-19T00:05:25.3309105Z",
        "poolId": "poolId"
      },
      "onAllTasksComplete": "noaction",
      "onTaskFailure": "noaction"
    }
  ]
}

Definice

Name Description
AccessScope

Prostředky služby Batch, ke kterým token uděluje přístup.

ApplicationPackageReference

Odkaz na balíček, který se má nasadit do výpočetních uzlů.

AuthenticationTokenSettings

Nastavení ověřovacího tokenu, který může úloha použít k provádění operací služby Batch.

AutoPoolSpecification

Určuje charakteristiky dočasného automatického fondu. Služba Batch vytvoří tento automatický fond při odeslání úlohy.

AutoUserScope

Obor automatického uživatele

AutoUserSpecification

Určuje parametry pro automatického uživatele, který spouští úlohu ve službě Batch.

AzureBlobFileSystemConfiguration

Informace, které slouží k připojení ke kontejneru služby Azure Storage pomocí blobfuse

AzureFileShareConfiguration

Informace použité pro připojení ke sdílené složce Azure

BatchError

Služba Azure Batch obdržela chybovou odpověď.

BatchErrorDetail

Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.

CachingType

Typ ukládání do mezipaměti, které chcete pro disk povolit.

CertificateReference

Odkaz na certifikát, který se má nainstalovat do výpočetních uzlů ve fondu.

CertificateStoreLocation

Umístění úložiště certifikátů na výpočetním uzlu, do kterého se má certifikát nainstalovat.

CertificateVisibility

Které uživatelské účty na výpočetním uzlu by měly mít přístup k privátním datům certifikátu.

CIFSMountConfiguration

Informace používané k připojení k systému souborů CIFS.

CloudJob

Úloha Azure Batch.

CloudJobListResult

Výsledek výpisu úloh v účtu.

CloudServiceConfiguration

Konfigurace výpočetních uzlů ve fondu na základě platformy Azure Cloud Services.

ComputeNodeFillType

Jak se úlohy distribuují mezi výpočetní uzly ve fondu.

ComputeNodeIdentityReference

Odkaz na identitu přiřazenou uživatelem přidruženou k fondu služby Batch, který bude výpočetní uzel používat.

ContainerConfiguration

Konfigurace pro fondy s podporou kontejnerů.

ContainerRegistry

Privátní registr kontejneru.

ContainerType

Technologie kontejneru, která se má použít.

ContainerWorkingDirectory

Umístění pracovního adresáře úloh kontejneru.

DataDisk

Nastavení, která budou používat datové disky přidružené k výpočetním uzlům ve fondu. Pokud používáte připojené datové disky, musíte je připojit a naformátovat z virtuálního počítače, abyste je mohli používat.

DiffDiskPlacement

Určuje dočasné umístění disku pro disk s operačním systémem pro všechny výpočetní uzly (virtuální počítače) ve fondu.

DiffDiskSettings

Určuje dočasné nastavení disku pro disk operačního systému používaný výpočetním uzlem (virtuálním počítačem).

DiskEncryptionConfiguration

Konfigurace šifrování disku použitá na výpočetních uzlech ve fondu Konfigurace šifrování disků se nepodporuje ve fondu Linuxu vytvořeném s imagí Azure Compute Gallery.

DiskEncryptionTarget

Seznam cílových disků bude služba Batch šifrovat na výpočetním uzlu.

DynamicVNetAssignmentScope

Rozsah dynamického přiřazení virtuální sítě.

ElevationLevel

Úroveň zvýšení oprávnění uživatele.

EnvironmentSetting

Proměnná prostředí, která se má nastavit v procesu úlohy.

ErrorCategory

Kategorie chyby.

ErrorMessage

Chybová zpráva přijatá v Azure Batch chybovou odpověď.

HttpHeader

Pár název-hodnota hlavičky HTTP

ImageReference

Odkaz na image Azure Virtual Machines Marketplace nebo image Azure Compute Gallery. Pokud chcete získat seznam všech odkazů na Azure Marketplace image ověřených Azure Batch, podívejte se na operaci Výpis podporovaných imagí.

InboundEndpointProtocol

Protokol koncového bodu.

InboundNATPool

Fond příchozího překladu adres (NAT), který je možné použít k externímu adresní adrese konkrétních portů na výpočetních uzlech ve fondu služby Batch.

IPAddressProvisioningType

Typ zřizování veřejných IP adres pro fond.

JobConstraints

Omezení provádění pro úlohu.

JobExecutionInformation

Obsahuje informace o spuštění úlohy ve službě Azure Batch.

JobManagerTask

Určuje podrobnosti úlohy Správce úloh.

JobNetworkConfiguration

Konfigurace sítě pro úlohu

JobPreparationTask

Úloha přípravy, která se má spustit před libovolnými úkoly úlohy na libovolném výpočetním uzlu.

JobReleaseTask

Úloha uvolnění úlohy, která se spustí po dokončení úlohy na libovolném výpočetním uzlu, na kterém je úloha spuštěná.

JobSchedulingError

Při plánování úlohy došlo ve službě Batch k chybě.

JobState

Stav úlohy.

JobStatistics

Statistika využití prostředků pro úlohu

LinuxUserConfiguration

Vlastnosti použité k vytvoření uživatelského účtu na výpočetním uzlu s Linuxem

LoginMode

Režim přihlášení pro uživatele

ManagedDisk
MetadataItem

Pár název-hodnota přidružený k prostředku služby Batch.

MountConfiguration

Systém souborů, který se má připojit k jednotlivým uzlům.

NameValuePair

Představuje dvojici název-hodnota.

NetworkConfiguration

Konfigurace sítě pro fond

NetworkSecurityGroupRule

Pravidlo skupiny zabezpečení sítě, které se použije na příchozí koncový bod.

NetworkSecurityGroupRuleAccess

Akce, která by se měla provést pro zadanou IP adresu, rozsah podsítě nebo značku.

NFSMountConfiguration

Informace používané k připojení k systému souborů NFS

NodeCommunicationMode

Určuje, jak fond komunikuje se službou Batch.

NodePlacementConfiguration

Konfigurace umístění uzlů pro fond

NodePlacementPolicyType

Zásady umístění pro přidělování uzlů ve fondu.

OnAllTasksComplete

Akce, kterou má služba Batch provést, když jsou všechny úkoly v úloze ve stavu dokončení.

OnTaskFailure

Akce, kterou by služba Batch měla provést, když jakákoli úloha v úloze selže.

OSDisk

Nastavení pro disk operačního systému výpočetního uzlu

OutputFile

Specifikace pro nahrávání souborů z Azure Batch výpočetního uzlu do jiného umístění po dokončení procesu úlohy službou Batch.

OutputFileBlobContainerDestination

Určuje cíl pro nahrání souboru v kontejneru úložiště objektů blob v Azure.

OutputFileDestination

Cíl, do kterého se má soubor nahrát.

OutputFileUploadCondition

Podmínky, za kterých se má nahrát výstupní soubor úkolu nebo sada souborů.

OutputFileUploadOptions

Podrobnosti o operaci nahrávání výstupního souboru, včetně toho, za jakých podmínek se má nahrávání provést.

PoolEndpointConfiguration

Konfigurace koncového bodu pro fond

PoolInformation

Určuje, jak má být úloha přiřazena k fondu.

PoolLifetimeOption

Minimální životnost vytvořených automatických fondů a způsob přiřazení více úloh podle plánu k fondům.

PoolSpecification

Specifikace pro vytvoření nového fondu

PublicIPAddressConfiguration

Konfigurace veřejné IP adresy síťové konfigurace fondu.

ResourceFile

Jeden soubor nebo více souborů ke stažení do výpočetního uzlu

SecurityProfile

Určuje nastavení profilu zabezpečení pro virtuální počítač nebo škálovací sadu virtuálních počítačů.

SecurityTypes

Určuje SecurityType virtuálního počítače. Pokud chcete povolit UefiSettings, musí být nastavena na libovolnou zadanou hodnotu.

ServiceArtifactReference

Určuje REFERENČNÍ ID artefaktu služby, které se používá k nastavení stejné verze image pro všechny virtuální počítače ve škálovací sadě při použití nejnovější verze image.

StartTask

Úloha, která se spustí při připojení uzlu k fondu ve službě Azure Batch nebo při restartování nebo opětovném nastavení výpočetního uzlu.

StorageAccountType

Typ účtu úložiště pro použití při vytváření datových disků nebo disku s operačním systémem.

TaskConstraints

Omezení provádění, která se mají použít pro úlohu.

TaskContainerSettings

Nastavení kontejneru pro úlohu.

TaskSchedulingPolicy

Určuje, jak se mají úkoly distribuovat mezi výpočetní uzly.

UefiSettings

Určuje nastavení zabezpečení, jako je zabezpečené spouštění a virtuální počítač vTPM použitý při vytváření virtuálního počítače.

UserAccount

Vlastnosti použité k vytvoření uživatele sloužícího ke spouštění úloh na výpočetním uzlu Azure Batch.

UserIdentity

Definice identity uživatele, pod kterou je úloha spuštěna.

VirtualMachineConfiguration

Konfigurace výpočetních uzlů ve fondu na základě infrastruktury Azure Virtual Machines

VMExtension

Konfigurace pro rozšíření virtuálních počítačů

WindowsConfiguration

Nastavení operačního systému Windows, která se mají použít pro virtuální počítač.

WindowsUserConfiguration

Vlastnosti použité k vytvoření uživatelského účtu na výpočetním uzlu Windows

AccessScope

Prostředky služby Batch, ke kterým token uděluje přístup.

Name Typ Description
job

string

Uděluje přístup k provádění všech operací s úlohou, která obsahuje úlohu.

ApplicationPackageReference

Odkaz na balíček, který se má nasadit do výpočetních uzlů.

Name Typ Description
applicationId

string

ID aplikace, která se má nasadit.
Při vytváření fondu musí být ID aplikace balíčku plně kvalifikované (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).

version

string

Verze aplikace, která se má nasadit. Pokud ji vynecháte, nasadí se výchozí verze.
Pokud je tato možnost ve fondu vynechána a pro tuto aplikaci není zadána žádná výchozí verze, požadavek selže s kódem chyby InvalidApplicationPackageReferences a stavovým kódem HTTP 409. Pokud je tato možnost u úlohy vynechána a pro tuto aplikaci není zadána žádná výchozí verze, úloha selže s chybou předběžného zpracování.

AuthenticationTokenSettings

Nastavení ověřovacího tokenu, který může úloha použít k provádění operací služby Batch.

Name Typ Description
access

AccessScope[]

Prostředky služby Batch, ke kterým token uděluje přístup.
Ověřovací token uděluje přístup k omezené sadě operací služby Batch. V současné době je jedinou podporovanou hodnotou vlastnosti přístupu "job", která uděluje přístup ke všem operacím souvisejícím s úlohou, která obsahuje úlohu.

AutoPoolSpecification

Určuje charakteristiky dočasného automatického fondu. Služba Batch vytvoří tento automatický fond při odeslání úlohy.

Name Typ Description
autoPoolIdPrefix

string

Předpona, která se má přidat k jedinečnému identifikátoru při automatickém vytvoření fondu.
Služba Batch přiřadí každému automatickému fondu jedinečný identifikátor při vytvoření. Chcete-li rozlišovat mezi fondy vytvořenými pro různé účely, můžete zadat tento prvek pro přidání předpony přiřazeného ID. Předpona může mít délku až 20 znaků.

keepAlive

boolean

Jestli se má automatický fond udržovat aktivní i po vypršení jeho životnosti.
Pokud je false, služba Batch odstraní fond po jeho životnosti (podle nastavení poolLifetimeOption) vyprší; to znamená po dokončení úlohy nebo plánu úlohy. Pokud je hodnota true, služba Batch fond automaticky neodstraní. Odstranění automatických fondů vytvořených pomocí této možnosti je na uživateli.

pool

PoolSpecification

Specifikace fondu pro automatický fond.

poolLifetimeOption

PoolLifetimeOption

Minimální životnost vytvořených automatických fondů a způsob přiřazení více úloh podle plánu k fondům.

AutoUserScope

Obor automatického uživatele

Name Typ Description
pool

string

Určuje, že úloha se spustí jako běžný účet automatického uživatele, který se vytvoří na každém výpočetním uzlu ve fondu.

task

string

Určuje, že služba by měla pro úlohu vytvořit nového uživatele.

AutoUserSpecification

Určuje parametry pro automatického uživatele, který spouští úlohu ve službě Batch.

Name Typ Description
elevationLevel

ElevationLevel

Úroveň zvýšení oprávnění automatického uživatele.
Výchozí hodnota je nonAdmin.

scope

AutoUserScope

Obor automatického uživatele
Výchozí hodnota je fond. Pokud fond používá Systém Windows, měla by být zadána hodnota Úloha, pokud je vyžadována přísnější izolace mezi úkoly. Pokud například úloha zmutuje registr způsobem, který by mohl mít vliv na jiné úlohy, nebo pokud byly ve fondu zadány certifikáty, které by neměly být přístupné pro běžné úlohy, ale měly by být přístupné pro StartTasks.

AzureBlobFileSystemConfiguration

Informace, které slouží k připojení ke kontejneru služby Azure Storage pomocí blobfuse

Name Typ Description
accountKey

string

Klíč účtu služby Azure Storage.
Tato vlastnost se vzájemně vylučuje s sasKey a identity; musí být zadána přesně jedna.

accountName

string

Název účtu služby Azure Storage.

blobfuseOptions

string

Další možnosti příkazového řádku, které se mají předat příkazu mount.
Toto jsou možnosti net use ve Windows a možnosti připojení v Linuxu.

containerName

string

Název kontejneru Azure Blob Storage.

identityReference

ComputeNodeIdentityReference

Odkaz na identitu přiřazenou uživatelem, která se má použít pro přístup ke kontejneru containerName
Tato vlastnost se vzájemně vylučuje s accountKey a sasKey; musí být zadána přesně jedna.

relativeMountPath

string

Relativní cesta na výpočetním uzlu, kam se připojí systém souborů
Všechny systémy souborů jsou připojené vzhledem k adresáři Batch mounts a jsou přístupné prostřednictvím proměnné prostředí AZ_BATCH_NODE_MOUNTS_DIR.

sasKey

string

Token SAS služby Azure Storage.
Tato vlastnost se vzájemně vylučuje s accountKey a identity; musí být zadána přesně jedna.

AzureFileShareConfiguration

Informace použité pro připojení ke sdílené složce Azure

Name Typ Description
accountKey

string

Klíč účtu služby Azure Storage.

accountName

string

Název účtu služby Azure Storage.

azureFileUrl

string

Adresa URL Azure Files.
Jedná se o formulář "https://{account}.file.core.windows.net/".

mountOptions

string

Další možnosti příkazového řádku, které se mají předat příkazu mount.
Toto jsou možnosti net use ve Windows a možnosti připojení v Linuxu.

relativeMountPath

string

Relativní cesta na výpočetním uzlu, kam se připojí systém souborů
Všechny systémy souborů jsou připojené vzhledem k adresáři Batch mounts a jsou přístupné prostřednictvím proměnné prostředí AZ_BATCH_NODE_MOUNTS_DIR.

BatchError

Služba Azure Batch obdržela chybovou odpověď.

Name Typ Description
code

string

Identifikátor chyby. Kódy jsou neutrální a mají být využívány programově.

message

ErrorMessage

Zpráva popisující chybu, která má být vhodná k zobrazení v uživatelském rozhraní.

values

BatchErrorDetail[]

Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě.

BatchErrorDetail

Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.

Name Typ Description
key

string

Identifikátor určující význam value vlastnost.

value

string

Další informace zahrnuté v chybové odpovědi.

CachingType

Typ ukládání do mezipaměti, které chcete pro disk povolit.

Name Typ Description
none

string

Režim ukládání do mezipaměti pro disk není povolený.

readonly

string

Režim ukládání do mezipaměti pro disk je jen pro čtení.

readwrite

string

Režim ukládání do mezipaměti pro disk je čtení a zápis.

CertificateReference

Odkaz na certifikát, který se má nainstalovat do výpočetních uzlů ve fondu.

Name Typ Description
storeLocation

CertificateStoreLocation

Umístění úložiště certifikátů na výpočetním uzlu, do kterého se má certifikát nainstalovat.
Výchozí hodnota je currentuser. Tato vlastnost se vztahuje pouze na fondy nakonfigurované s výpočetními uzly Windows (to znamená vytvořené pomocí cloudServiceConfiguration nebo virtualMachineConfiguration pomocí odkazu na image Windows). V případě linuxových výpočetních uzlů se certifikáty ukládají v adresáři v pracovním adresáři úlohy a do úlohy se zadává proměnná prostředí, AZ_BATCH_CERTIFICATES_DIR se má dotazovat na toto umístění. U certifikátů s viditelností remoteUser se v domovském adresáři uživatele vytvoří adresář certs (např. /home/{user-name}/certs) a certifikáty se umístí do tohoto adresáře.

storeName

string

Název úložiště certifikátů na výpočetním uzlu, do kterého se má certifikát nainstalovat.
Tato vlastnost se vztahuje pouze na fondy nakonfigurované s výpočetními uzly Windows (to znamená vytvořené pomocí cloudServiceConfiguration nebo virtualMachineConfiguration pomocí odkazu na image Windows). Mezi běžné názvy obchodů patří: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, ale můžete použít i jakýkoliv vlastní název obchodu. Výchozí hodnota je My.

thumbprint

string

Kryptografický otisk certifikátu.

thumbprintAlgorithm

string

Algoritmus, ke kterému je kryptografický otisk přidružený. To musí být sha1.

visibility

CertificateVisibility[]

Které uživatelské účty na výpočetním uzlu by měly mít přístup k privátním datům certifikátu.
V této kolekci můžete zadat více než jednu viditelnost. Výchozí hodnota je všechny účty.

CertificateStoreLocation

Umístění úložiště certifikátů na výpočetním uzlu, do kterého se má certifikát nainstalovat.

Name Typ Description
currentuser

string

Certifikáty by se měly nainstalovat do úložiště certifikátů CurrentUser.

localmachine

string

Certifikáty by se měly nainstalovat do úložiště certifikátů LocalMachine.

CertificateVisibility

Které uživatelské účty na výpočetním uzlu by měly mít přístup k privátním datům certifikátu.

Name Typ Description
remoteuser

string

Certifikát by měl být viditelný pro uživatelské účty, pod kterými uživatelé vzdáleně přistupují k výpočetnímu uzlu.

starttask

string

Certifikát by měl být viditelný pro uživatelský účet, pod kterým se spouští StartTask. Všimněte si, že pokud je obor automatického uživatele fond pro startTask i úkol, bude tento certifikát viditelný i pro úkol.

task

string

Certifikát by měl být viditelný pro uživatelské účty, pod kterými se spouští úlohy.

CIFSMountConfiguration

Informace používané k připojení k systému souborů CIFS.

Name Typ Description
mountOptions

string

Další možnosti příkazového řádku, které se mají předat příkazu mount.
Toto jsou možnosti net use ve Windows a možnosti připojení v Linuxu.

password

string

Heslo, které se má použít pro ověřování v systému souborů CIFS.

relativeMountPath

string

Relativní cesta na výpočetním uzlu, kam se připojí systém souborů
Všechny systémy souborů jsou připojené vzhledem k adresáři Batch mounts a jsou přístupné prostřednictvím proměnné prostředí AZ_BATCH_NODE_MOUNTS_DIR.

source

string

Identifikátor URI systému souborů, který se má připojit.

username

string

Uživatel, který se má použít pro ověřování v systému souborů CIFS.

CloudJob

Úloha Azure Batch.

Name Typ Výchozí hodnota Description
allowTaskPreemption

boolean

Určuje, zda mohou být úkoly v této úloze zrušeny jinými úlohami s vysokou prioritou.
Pokud je hodnota nastavená na True, budou mít přednost jiné úlohy s vysokou prioritou odeslané do systému a budou moct z této úlohy znovu vytvořit frontu úkolů. Úlohu allowTaskPreemption můžete po vytvoření aktualizovat pomocí rozhraní API úlohy aktualizace.

commonEnvironmentSettings

EnvironmentSetting[]

Seznam běžných nastavení proměnných prostředí Tyto proměnné prostředí jsou nastavené pro všechny úkoly v úloze (včetně správce úloh, úkolů přípravy úlohy a uvolnění úlohy).
Jednotlivé úlohy můžou přepsat nastavení prostředí zadané zde zadáním stejného názvu nastavení s jinou hodnotou.

constraints

JobConstraints

Omezení provádění úlohy.

creationTime

string

Čas vytvoření úlohy.

displayName

string

Zobrazovaný název úlohy.

eTag

string

Značka ETag úlohy.
Jedná se o neprůzrůzný řetězec. Můžete ho použít ke zjištění, jestli se úloha mezi jednotlivými požadavky změnila. Konkrétně můžete při aktualizaci úlohy předat eTag a určit, že se změny projeví pouze v případě, že mezitím úlohu nikdo jiný neupraví.

executionInfo

JobExecutionInformation

Informace o spuštění úlohy.

id

string

Řetězec, který jednoznačně identifikuje úlohu v rámci účtu.
ID zachovává malá a velká písmena a nerozlišuje velká a malá písmena (to znamená, že v rámci účtu nemusíte mít dvě ID, která se liší pouze velikostí písmen).

jobManagerTask

JobManagerTask

Podrobnosti o úkolu Správce úloh, který se má spustit při spuštění úlohy.
Úloha Správce úloh se automaticky spustí při vytvoření úlohy. Služba Batch se pokusí naplánovat úlohu Správce úloh před všemi ostatními úkoly v úloze. Při zmenšení fondu se služba Batch pokusí co nejdéle zachovat uzly, ve kterých jsou úkoly Správce úloh spuštěné (to znamená, že výpočetní uzly se spuštěnými normálními úkoly se odeberou před výpočetními uzly, na kterých běží úkoly Správce úloh). Když úloha Správce úloh selže a je třeba ji restartovat, systém se ji pokusí naplánovat s nejvyšší prioritou. Pokud nejsou k dispozici žádné nečinné výpočetní uzly, může systém ukončit jednu ze spuštěných úloh ve fondu a vrátit ji do fronty, aby uvolnil místo pro restartování úlohy správce úloh. Všimněte si, že úkol Správce úloh v jedné úloze nemá prioritu před úkoly v jiných úlohách. V rámci úloh se zobrazují pouze priority na úrovni úloh. Pokud je třeba například restartovat Správce úloh s prioritou 0 Úloha, nevytěsní úkoly s prioritou 1. Služba Batch bude opakovat úlohy při aktivaci operace obnovení na uzlu. Mezi příklady operací obnovení patří (mimo jiné) restartování uzlu, který není v pořádku, nebo zmizení výpočetního uzlu kvůli selhání hostitele. Opakování kvůli operacím obnovení jsou nezávislé na a nezapočítávají se do hodnoty maxTaskRetryCount. I když je hodnota maxTaskRetryCount 0, může dojít k internímu opakování kvůli operaci obnovení. Z tohoto důvodu by všechny úkoly měly být idempotentní. To znamená, že úlohy musí tolerovat přerušení a restartování bez poškození nebo duplicitních dat. Osvědčeným postupem pro dlouhotrvající úlohy je použít nějakou formu vytváření kontrolních bodů.

jobPreparationTask

JobPreparationTask

Úkol přípravy úlohy.
Úkol přípravy úlohy je speciální úkol spuštěný na každém výpočetním uzlu před jakýmkoli jiným úkolem úlohy.

jobReleaseTask

JobReleaseTask

Úloha uvolnění úlohy.
Úloha uvolnění úlohy je speciální spuštění úlohy na konci úlohy na každém výpočetním uzlu, který spustil jakýkoli jiný úkol úlohy.

lastModified

string

Čas poslední změny úlohy.
Jedná se o poslední čas, kdy se data na úrovni úlohy, například stav nebo priorita úlohy, změnila. Nebere v potaz změny na úrovni úkolů, jako je přidání nových úkolů nebo změna stavu úkolů.

maxParallelTasks

integer

-1

Maximální počet úkolů, které lze pro úlohu provést paralelně.
Hodnota maxParallelTasks musí být -1 nebo větší než 0, pokud je zadaná. Pokud není zadaný, výchozí hodnota je -1, což znamená, že počet úloh, které je možné spustit najednou, není nijak omezený. Po vytvoření úlohy pomocí rozhraní API úlohy aktualizace můžete aktualizovat hodnotu maxParallelTasks.

metadata

MetadataItem[]

Seznam dvojic název-hodnota přidružených k úloze jako metadata.
Služba Batch nepřiřazuje metadatům žádný význam; slouží výhradně k použití uživatelského kódu.

networkConfiguration

JobNetworkConfiguration

Konfigurace sítě pro úlohu.

onAllTasksComplete

OnAllTasksComplete

Akce, kterou by služba Batch měla provést, když jsou všechny úkoly v úloze v dokončeném stavu.
Výchozí hodnota je noaction.

onTaskFailure

OnTaskFailure

Akce, kterou by služba Batch měla provést, když některý úkol v úloze selže.
Úloha se považuje za neúspěšnou, pokud má failureInfo. FailureInfo se nastaví, pokud se úloha dokončí s nenulovým ukončovacím kódem po vyčerpání počtu opakování nebo pokud došlo k chybě při spuštění úlohy, například kvůli chybě při stahování souboru zdroje. Výchozí hodnota je noaction.

poolInfo

PoolInformation

Nastavení fondu přidružené k úloze.

previousState

JobState

Předchozí stav úlohy.
Tato vlastnost není nastavena, pokud je úloha v počátečním stavu Aktivní.

previousStateTransitionTime

string

Čas, kdy úloha přešla do předchozího stavu.
Tato vlastnost není nastavena, pokud je úloha v počátečním stavu Aktivní.

priority

integer

Priorita úlohy.
Hodnoty priority mohou být v rozsahu od -1000 do 1000, přičemž -1000 je nejnižší prioritou a 1000 nejvyšší prioritou. Výchozí hodnota je 0.

state

JobState

Aktuální stav úlohy.

stateTransitionTime

string

Čas, kdy úloha přešla do aktuálního stavu.

stats

JobStatistics

Statistika využití prostředků za celou dobu životnosti úlohy
Tato vlastnost je naplněna pouze v případě, že cloudová úloha byla načtena s klauzulí expand včetně atributu stats; v opačném případě je null. Statistika nemusí být okamžitě dostupná. Služba Batch pravidelně shrnuje statistiky. Typické zpoždění je přibližně 30 minut.

url

string

Adresa URL úlohy.

usesTaskDependencies

boolean

Určuje, jestli úkoly v úloze můžou definovat vzájemné závislosti. Výchozí hodnotou je hodnota false.

CloudJobListResult

Výsledek výpisu úloh v účtu.

Name Typ Description
odata.nextLink

string

Adresa URL pro získání další sady výsledků

value

CloudJob[]

Seznam úloh.

CloudServiceConfiguration

Konfigurace výpočetních uzlů ve fondu na základě platformy Azure Cloud Services.

Name Typ Description
osFamily

string

Řada hostovaných operačních systémů Azure, která se má nainstalovat na virtuální počítače ve fondu.
Možné hodnoty jsou: 2 – řada operačních systémů 2, což odpovídá systému Windows Server 2008 R2 SP1. 3 – Řada operačního systému 3, která odpovídá Windows Server 2012. 4 – Řada operačního systému 4, ekvivalent Windows Server 2012 R2. 5 – Řada operačních systémů 5, což odpovídá Windows Server 2016. 6 – Řada operačního systému 6, která odpovídá Windows Serveru 2019. Další informace najdete v tématu Verze hostovaného operačního systému Azure (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).

osVersion

string

Verze hostovaného operačního systému Azure, která se má nainstalovat na virtuální počítače ve fondu.
Výchozí hodnota je * , která určuje nejnovější verzi operačního systému pro zadanou řadu operačních systémů.

ComputeNodeFillType

Jak se úlohy distribuují mezi výpočetní uzly ve fondu.

Name Typ Description
pack

string

Každému výpočetnímu uzlu ve fondu by mělo být přiřazeno co nejvíce úkolů (taskSlotsPerNode) před přiřazením k dalšímu výpočetnímu uzlu ve fondu.

spread

string

Úkoly by měly být přiřazeny rovnoměrně napříč všemi výpočetními uzly ve fondu.

ComputeNodeIdentityReference

Odkaz na identitu přiřazenou uživatelem přidruženou k fondu služby Batch, který bude výpočetní uzel používat.

Name Typ Description
resourceId

string

ID prostředku ARM identity přiřazené uživatelem.

ContainerConfiguration

Konfigurace pro fondy s podporou kontejnerů.

Name Typ Description
containerImageNames

string[]

Kolekce názvů imagí kontejneru.
Toto je úplný odkaz na image, který by byl zadán pro "docker pull". Image bude zdrojem z výchozího registru Dockeru, pokud image není plně kvalifikovaná s alternativním registrem.

containerRegistries

ContainerRegistry[]

Další privátní registry, ze kterých je možné kontejnery načíst.
Pokud je nutné stáhnout nějaké image z privátního registru, který vyžaduje přihlašovací údaje, musí být tyto přihlašovací údaje uvedené tady.

type

ContainerType

Technologie kontejneru, která se má použít.

ContainerRegistry

Privátní registr kontejneru.

Name Typ Description
identityReference

ComputeNodeIdentityReference

Odkaz na identitu přiřazenou uživatelem, která se použije pro přístup k Azure Container Registry místo uživatelského jména a hesla.
Odkaz na identitu přiřazenou uživatelem přidruženou k fondu služby Batch, který bude výpočetní uzel používat.

password

string

Heslo pro přihlášení k serveru registru.

registryServer

string

Adresa URL registru.
Pokud ho vynecháte, výchozí hodnota je "docker.io".

username

string

Uživatelské jméno pro přihlášení k serveru registru.

ContainerType

Technologie kontejneru, která se má použít.

Name Typ Description
criCompatible

string

Ke spuštění kontejnerů se použije technologie založená na CRI.

dockerCompatible

string

Ke spuštění kontejnerů se použije kontejnerová technologie kompatibilní s Dockerem.

ContainerWorkingDirectory

Umístění pracovního adresáře úloh kontejneru.

Name Typ Description
containerImageDefault

string

Použijte pracovní adresář definovaný v imagi kontejneru. Mějte na pozoru, že tento adresář nebude obsahovat soubory prostředků stažené službou Batch.

taskWorkingDirectory

string

Použijte standardní pracovní adresář úkolů služby Batch, který bude obsahovat soubory zdrojů úkolů naplněné službou Batch.

DataDisk

Nastavení, která budou používat datové disky přidružené k výpočetním uzlům ve fondu. Pokud používáte připojené datové disky, musíte je připojit a naformátovat z virtuálního počítače, abyste je mohli používat.

Name Typ Description
caching

CachingType

Typ ukládání do mezipaměti, který se má povolit pro datové disky.
Výchozí hodnota pro ukládání do mezipaměti je readwrite. Informace o možnostech ukládání do mezipaměti najdete tady: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

diskSizeGB

integer

Počáteční velikost disku v gigabajtech.

lun

integer

Číslo logické jednotky.
Logická jednotka se používá k jedinečné identifikaci jednotlivých datových disků. Pokud připojujete více disků, každý z nich by měl mít jinou logickou jednotku. Hodnota musí být mezi 0 a 63 včetně.

storageAccountType

StorageAccountType

Typ účtu úložiště, který se má použít pro datový disk.
Pokud je vynechán, výchozí hodnota je "standard_lrs".

DiffDiskPlacement

Určuje dočasné umístění disku pro disk s operačním systémem pro všechny výpočetní uzly (virtuální počítače) ve fondu.

Name Typ Description
CacheDisk

string

Dočasný disk s operačním systémem je uložený v mezipaměti virtuálního počítače.

DiffDiskSettings

Určuje dočasné nastavení disku pro disk operačního systému používaný výpočetním uzlem (virtuálním počítačem).

Name Typ Description
placement

DiffDiskPlacement

Určuje umístění dočasného disku pro disk operačního systému pro všechny virtuální počítače ve fondu.
Tuto vlastnost může uživatel v požadavku použít k volbě umístění, například místo na disku mezipaměti pro dočasné zřizování disků s operačním systémem. Další informace o požadavcích na velikost disku s dočasným operačním systémem najdete v tématu Požadavky na velikost disku s dočasným operačním systémem pro virtuální počítače s Windows na https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements a virtuální počítače s Linuxem na adrese https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

DiskEncryptionConfiguration

Konfigurace šifrování disku použitá na výpočetních uzlech ve fondu Konfigurace šifrování disků se nepodporuje ve fondu Linuxu vytvořeném s imagí Azure Compute Gallery.

Name Typ Description
targets

DiskEncryptionTarget[]

Seznam cílových disků bude služba Batch šifrovat na výpočetním uzlu.
Pokud ji vynecháte, nebudou zašifrovány žádné disky na výpočetních uzlech ve fondu. Ve fondu Linuxu se podporuje pouze Dočasný disk. ve fondu Windows musí být zadány "OsDisk" a "TemporaryDisk".

DiskEncryptionTarget

Seznam cílových disků bude služba Batch šifrovat na výpočetním uzlu.

Name Typ Description
osdisk

string

Disk s operačním systémem na výpočetním uzlu je šifrovaný.

temporarydisk

string

Dočasný disk na výpočetním uzlu je šifrovaný. V Linuxu se toto šifrování vztahuje na jiné oddíly (například na připojených datových discích), pokud šifrování probíhá při spuštění.

DynamicVNetAssignmentScope

Rozsah dynamického přiřazení virtuální sítě.

Name Typ Description
job

string

Dynamické přiřazení virtuální sítě se provádí pro každou úlohu.

none

string

Není povolené žádné dynamické přiřazení virtuální sítě.

ElevationLevel

Úroveň zvýšení oprávnění uživatele.

Name Typ Description
admin

string

Uživatel je uživatel se zvýšeným přístupem a pracuje s úplnými oprávněními správce.

nonadmin

string

Uživatel je standardní uživatel bez zvýšeného přístupu.

EnvironmentSetting

Proměnná prostředí, která se má nastavit v procesu úlohy.

Name Typ Description
name

string

Název proměnné prostředí.

value

string

Hodnota proměnné prostředí.

ErrorCategory

Kategorie chyby.

Name Typ Description
servererror

string

Příčinou chyby je interní problém se serverem.

usererror

string

Příčinou chyby je problém s uživatelem, například chybná konfigurace.

ErrorMessage

Chybová zpráva přijatá v Azure Batch chybovou odpověď.

Name Typ Description
lang

string

Kód jazyka chybové zprávy

value

string

Text zprávy

HttpHeader

Pár název-hodnota hlavičky HTTP

Name Typ Description
name

string

Název hlavičky, která se má použít při nahrávání výstupních souborů, nerozlišují malá a velká písmena.

value

string

Hodnota hlavičky, která se má použít při nahrávání výstupních souborů

ImageReference

Odkaz na image Azure Virtual Machines Marketplace nebo image Azure Compute Gallery. Pokud chcete získat seznam všech odkazů na Azure Marketplace image ověřených Azure Batch, podívejte se na operaci Výpis podporovaných imagí.

Name Typ Description
exactVersion

string

Konkrétní verze image platformy nebo image marketplace použité k vytvoření uzlu Toto pole jen pro čtení se liší od verze pouze v případě, že hodnota zadaná pro "version" při vytvoření fondu byla "nejnovější".

offer

string

Typ nabídky image Azure Virtual Machines Marketplace.
Například UbuntuServer nebo WindowsServer.

publisher

string

Vydavatel image Azure Virtual Machines Marketplace.
Například Canonical nebo MicrosoftWindowsServer.

sku

string

Skladová položka image Azure Virtual Machines Marketplace.
Například 18.04-LTS nebo 2019-Datacenter.

version

string

Verze image Azure Virtual Machines Marketplace.
Pro výběr nejnovější verze image je možné zadat hodnotu "latest". Pokud je vynechán, výchozí hodnota je "nejnovější".

virtualMachineImageId

string

Identifikátor prostředku ARM image Azure Compute Gallery. Výpočetní uzly ve fondu se vytvoří pomocí tohoto ID image. Toto je ve formátu /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} nebo /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} pro vždy výchozí nejnovější verzi image.
Tato vlastnost se vzájemně vylučuje s jinými vlastnostmi ImageReference. Image Azure Compute Gallery musí mít repliky ve stejné oblasti a musí být ve stejném předplatném jako účet Azure Batch. Pokud verze image není v identifikátoru imageId zadána, použije se nejnovější verze. Informace o nastavení brány firewall pro agenta Výpočetního uzlu služby Batch pro komunikaci se službou Batch najdete v tématu https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

InboundEndpointProtocol

Protokol koncového bodu.

Name Typ Description
tcp

string

Jako koncový bod použijte protokol TCP.

udp

string

Jako koncový bod použijte UDP.

InboundNATPool

Fond příchozího překladu adres (NAT), který je možné použít k externímu adresní adrese konkrétních portů na výpočetních uzlech ve fondu služby Batch.

Name Typ Description
backendPort

integer

Číslo portu na výpočetním uzlu.
Musí být jedinečný v rámci fondu služby Batch. Přijatelné hodnoty jsou mezi 1 a 65535 s výjimkou 22, 3389, 29876 a 29877, protože jsou rezervované. Pokud jsou zadány rezervované hodnoty, požadavek selže se stavovým kódem HTTP 400.

frontendPortRangeEnd

integer

Poslední číslo portu v rozsahu externích portů, které se použije k poskytování příchozího přístupu k backendPortu na jednotlivých výpočetních uzlech.
Přípustné hodnoty jsou v rozsahu od 1 do 65534 s výjimkou portů od 50000 do 55000, které jsou rezervované službou Batch. Všechny oblasti v rámci fondu musí být odlišné a nesmí se překrývat. Každý rozsah musí obsahovat alespoň 40 portů. Pokud jsou zadány rezervované nebo překrývající se hodnoty, požadavek selže se stavovým kódem HTTP 400.

frontendPortRangeStart

integer

První číslo portu v rozsahu externích portů, které se použije k poskytování příchozího přístupu k backendPortu na jednotlivých výpočetních uzlech.
Přípustné hodnoty jsou v rozsahu od 1 do 65534 s výjimkou rezervovaných portů od 50000 do 55000. Všechny oblasti v rámci fondu musí být odlišné a nesmí se překrývat. Každý rozsah musí obsahovat alespoň 40 portů. Pokud jsou zadány rezervované nebo překrývající se hodnoty, požadavek selže se stavovým kódem HTTP 400.

name

string

Název koncového bodu.
Název musí být jedinečný v rámci fondu služby Batch a musí obsahovat písmena, číslice, podtržítka, tečky a pomlčky. Názvy musí začínat písmenem nebo číslicí, musí končit písmenem, číslicí nebo podtržítkem a nesmí být delší než 77 znaků. Pokud jsou zadány neplatné hodnoty, požadavek selže se stavovým kódem HTTP 400.

networkSecurityGroupRules

NetworkSecurityGroupRule[]

Seznam pravidel skupiny zabezpečení sítě, která se použijí na koncový bod.
Maximální počet pravidel, která je možné zadat ve všech koncových bodech ve fondu batch, je 25. Pokud nejsou zadaná žádná pravidla skupiny zabezpečení sítě, vytvoří se výchozí pravidlo, které povolí příchozí přístup k zadanému backendPortu. Pokud dojde k překročení maximálního počtu pravidel skupiny zabezpečení sítě, požadavek selže se stavovým kódem HTTP 400.

protocol

InboundEndpointProtocol

Protokol koncového bodu.

IPAddressProvisioningType

Typ zřizování veřejných IP adres pro fond.

Name Typ Description
batchmanaged

string

Služba Batch vytvoří a spravuje veřejnou IP adresu. V závislosti na velikosti fondu může existovat několik veřejných IP adres.

nopublicipaddresses

string

Nebude vytvořena žádná veřejná IP adresa.

usermanaged

string

Veřejné IP adresy poskytuje uživatel a použijí se ke zřízení výpočetních uzlů.

JobConstraints

Omezení provádění pro úlohu.

Name Typ Description
maxTaskRetryCount

integer

Maximální počet opakování jednotlivých úkolů. Služba Batch opakuje úlohu, pokud její ukončovací kód není nenulový.
Všimněte si, že tato hodnota konkrétně řídí počet opakování. Služba Batch jednou vyzkouší každou úlohu a pak to může opakovat až do tohoto limitu. Pokud je například maximální počet opakování 3, služba Batch se pokusí o úlohu až 4krát (jeden počáteční pokus a 3 opakování). Pokud je maximální počet opakování 0, služba Batch nezopakuje úlohy. Pokud je maximální počet opakování -1, služba Batch opakuje úlohy bez omezení. Výchozí hodnota je 0 (bez opakování).

maxWallClockTime

string

Maximální uplynulý čas, po který může úloha běžet, měřená od okamžiku vytvoření úlohy.
Pokud se úloha nedokončila ve stanoveném časovém limitu, služba Batch ji a všechny úkoly, které jsou stále spuštěné, ukončí. V takovém případě bude důvodem ukončení MaxWallClockTimeExpiry. Pokud tato vlastnost není zadána, neexistuje žádný časový limit, jak dlouho může úloha běžet.

JobExecutionInformation

Obsahuje informace o spuštění úlohy ve službě Azure Batch.

Name Typ Description
endTime

string

Čas dokončení úlohy.
Tato vlastnost je nastavena pouze v případě, že je úloha ve stavu dokončeno.

poolId

string

ID fondu, ke kterému je tato úloha přiřazena.
Tento prvek obsahuje skutečný fond, ve kterém je přiřazena úloha. Když ze služby získáte podrobnosti o úloze, obsahují také element poolInfo, který obsahuje konfigurační data fondu z toho, kdy byla úloha přidána nebo aktualizována. Tento poolInfo element může také obsahovat poolId element. Pokud ano, jsou obě ID stejná. Pokud ne, znamená to, že úloha byla spuštěna v automatickém fondu a tato vlastnost obsahuje ID tohoto automatického fondu.

schedulingError

JobSchedulingError

Podrobnosti o všech chybách, které služba zjistila při spuštění úlohy.
Tato vlastnost není nastavena, pokud nedošlo k chybě při spuštění úlohy.

startTime

string

Čas zahájení úlohy.
Toto je čas, ve kterém byla úloha vytvořena.

terminateReason

string

Řetězec popisující důvod ukončení úlohy.
Tato vlastnost je nastavena pouze v případě, že je úloha ve stavu dokončeno. Pokud služba Batch ukončí úlohu, nastaví důvod takto: JMComplete – úloha Správce úloh byla dokončena a killJobOnCompletion byla nastavena na hodnotu true. MaxWallClockTimeExpiry – úloha dosáhla omezení maxWallClockTime. TerminateJobSchedule – úloha se spustila jako součást plánu a plán se ukončil. AllTasksComplete – atribut úlohy onAllTasksComplete je nastavený na terminatejob a všechny úkoly v úloze jsou dokončené. TaskFailed – atribut onTaskFailure úlohy je nastavený na performExitOptionsJobAction a úkol v úloze selhal s ukončovací podmínkou, která určila akci úlohy terminatejob. Jakýkoli jiný řetězec je uživatelem definovaný důvod zadaný při volání operace "Ukončit úlohu".

JobManagerTask

Určuje podrobnosti úlohy Správce úloh.

Name Typ Description
allowLowPriorityNode

boolean

Určuje, jestli může úloha Správce úloh běžet na výpočetním uzlu s spotovou nebo nízkou prioritou.
Výchozí hodnotou je hodnota true.

applicationPackageReferences

ApplicationPackageReference[]

Seznam balíčků aplikací, které služba Batch nasadí do výpočetního uzlu před spuštěním příkazového řádku.
Balíčky aplikací se stahují a nasazují do sdíleného adresáře, nikoli do pracovního adresáře úloh. Proto pokud odkazovaný balíček aplikace je již na výpočetním uzlu a je aktuální, pak se znovu nestáhnou; použije se existující kopie na výpočetním uzlu. Pokud odkazovaný balíček aplikace nelze nainstalovat, například proto, že balíček byl odstraněn nebo protože stahování selhalo, úloha selže.

authenticationTokenSettings

AuthenticationTokenSettings

Nastavení ověřovacího tokenu, který může úloha použít k provádění operací služby Batch.
Pokud je tato vlastnost nastavená, služba Batch poskytne úkolu ověřovací token, který lze použít k ověření operací služby Batch bez nutnosti přístupového klíče účtu. Token se poskytuje prostřednictvím proměnné prostředí AZ_BATCH_AUTHENTICATION_TOKEN. Operace, které může úloha provádět pomocí tokenu, závisí na nastavení. Úkol může například požádat o oprávnění úlohy, aby mohl do úlohy přidat další úkoly, nebo zkontrolovat stav úlohy nebo jiných úkolů v rámci úlohy.

commandLine

string

Příkazový řádek úlohy Správce úloh.
Příkazový řádek se nespouští v prostředí, a proto nemůže využívat funkce prostředí, jako je rozšíření proměnné prostředí. Pokud chcete tyto funkce využít, měli byste vyvolat prostředí v příkazovém řádku, například pomocí příkazu "cmd /c MyCommand" ve Windows nebo "/bin/sh -c MyCommand" v Linuxu. Pokud příkazový řádek odkazuje na cesty k souborům, měl by použít relativní cestu (vzhledem k pracovnímu adresáři Úloh) nebo proměnnou prostředí poskytovanou službou Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

constraints

TaskConstraints

Omezení, která platí pro úlohu Správce úloh.

containerSettings

TaskContainerSettings

Nastavení kontejneru, ve kterém běží úloha Správce úloh.
Pokud má fond, který bude tuto úlohu spouštět, nastavenou konfiguraci kontejneru, musí být nastavena i tato možnost. Pokud fond, který spustí tuto úlohu, nemá nastavenou konfiguraci kontejneru, nesmí být nastavená. Když je tato možnost zadána, všechny adresáře rekurzivně pod AZ_BATCH_NODE_ROOT_DIR (kořen Azure Batch adresářů na uzlu) se mapují do kontejneru, všechny proměnné prostředí úloh se mapují do kontejneru a příkazový řádek úlohy se spustí v kontejneru. Soubory vytvořené v kontejneru mimo AZ_BATCH_NODE_ROOT_DIR se nemusí projevit na disku hostitele, což znamená, že rozhraní API služby Batch nebudou mít k těmto souborům přístup.

displayName

string

Zobrazovaný název úlohy Správce úloh.
Nemusí být jedinečný a může obsahovat jakékoli znaky Unicode až do maximální délky 1024.

environmentSettings

EnvironmentSetting[]

Seznam nastavení proměnných prostředí pro úlohu Správce úloh.

id

string

Řetězec, který jednoznačně identifikuje úlohu Správce úloh v rámci úlohy.
ID může obsahovat libovolnou kombinaci alfanumerických znaků, včetně spojovníků a podtržítků, a nesmí obsahovat více než 64 znaků.

killJobOnCompletion

boolean

Jestli dokončení úlohy Správce úloh znamená dokončení celé úlohy.
Pokud ano, po dokončení úlohy Správce úloh služba Batch označí úlohu jako dokončenou. Pokud jsou v tuto chvíli stále spuštěné některé úlohy (kromě uvolnění úlohy), budou tyto úlohy ukončeny. Pokud je false, nemá dokončení úlohy Správce úloh vliv na stav úlohy. V tomto případě byste měli buď použít atribut onAllTasksComplete k ukončení úlohy, nebo nechat klienta nebo uživatele ukončit úlohu explicitně. Příkladem je, když Správce úloh vytvoří sadu úkolů, ale pak nemá při jejich provádění žádnou další roli. Výchozí hodnotou je hodnota true. Pokud k řízení životnosti úlohy používáte atributy onAllTasksComplete a onTaskFailure a úlohu Správce úloh používáte pouze k vytvoření úkolů pro úlohu (ne k monitorování průběhu), je důležité nastavit killJobOnCompletion na false.

outputFiles

OutputFile[]

Seznam souborů, které služba Batch nahraje z výpočetního uzlu po spuštění příkazového řádku.
V případě úloh s více instancemi se soubory nahrají jenom z výpočetního uzlu, na kterém se provádí primární úloha.

requiredSlots

integer

Počet slotů plánování, které úloha vyžaduje ke spuštění.
Výchozí hodnota je 1. Úlohu je možné naplánovat tak, aby běžela na výpočetním uzlu pouze v případě, že má k dispozici dostatek volných slotů plánování. U úloh s více instancemi se tato vlastnost nepodporuje a nesmí být zadána.

resourceFiles

ResourceFile[]

Seznam souborů, které služba Batch stáhne do výpočetního uzlu před spuštěním příkazového řádku.
Soubory uvedené v tomto prvku jsou umístěny v pracovním adresáři úlohy. Seznam souborů prostředků má maximální velikost. Při překročení maximální velikosti požadavek selže a kód chyby odpovědi bude RequestEntityTooLarge. Pokud k tomu dojde, musí se zmenšit velikost kolekce ResourceFiles. Toho můžete dosáhnout pomocí souborů .zip, balíčků aplikací nebo kontejnerů Dockeru.

runExclusive

boolean

Jestli úloha Správce úloh vyžaduje výhradní použití výpočetního uzlu, na kterém běží.
Pokud je hodnota true, žádné další úlohy se nespustí na stejném uzlu tak dlouho, dokud je spuštěný Správce úloh. Pokud je false, můžou se na výpočetním uzlu spustit současně se Správcem úloh další úlohy. Úloha Správce úloh se normálně počítá do limitu souběžných úloh výpočetního uzlu, takže to je relevantní jenom v případě, že výpočetní uzel umožňuje více souběžných úloh. Výchozí hodnotou je hodnota true.

userIdentity

UserIdentity

Identita uživatele, pod kterou běží úloha Správce úloh.
Pokud je úloha vynechána, spustí se jako uživatel bez oprávnění správce, který je jedinečný pro danou úlohu.

JobNetworkConfiguration

Konfigurace sítě pro úlohu

Name Typ Description
subnetId

string

Identifikátor prostředku ARM podsítě virtuální sítě, ke které se po dobu trvání úlohy připojí výpočetní uzly spouštěné úkoly z úlohy. To bude fungovat pouze s fondem VirtualMachineConfiguration.
Virtuální síť musí být ve stejné oblasti a předplatném jako účet Azure Batch. Zadaná podsíť by měla mít dostatek volných IP adres, aby pojala počet výpočetních uzlů, které budou spouštět úlohy z úlohy. Může to být až počet výpočetních uzlů ve fondu. Instanční objekt MicrosoftAzureBatch musí mít pro zadanou virtuální síť roli Přispěvatel virtuálních počítačů Classic (RBAC) Role-Based Access Control, aby služba Azure Batch mohlo plánovat úlohy na uzlech. Můžete to ověřit tak, že zkontrolujete, jestli má zadaná virtuální síť nějaké přidružené skupiny zabezpečení sítě (NSG). Pokud skupina zabezpečení sítě odmítne komunikaci s uzly v zadané podsíti, nastaví služba Batch stav výpočetních uzlů na nepoužitelné. Toto je ve formátu /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. Pokud má zadaná virtuální síť nějaké přidružené skupiny zabezpečení sítě (NSG), musí být pro příchozí komunikaci ze služby Azure Batch povolené několik rezervovaných systémových portů. Pro fondy vytvořené pomocí konfigurace virtuálního počítače povolte porty 29876 a 29877 a také port 22 pro Linux a port 3389 pro Windows. Port 443 musí být také otevřený pro odchozí připojení pro komunikaci se službou Azure Storage. Další podrobnosti najdete tady: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

JobPreparationTask

Úloha přípravy, která se má spustit před libovolnými úkoly úlohy na libovolném výpočetním uzlu.

Name Typ Description
commandLine

string

Příkazový řádek úkolu přípravy úlohy.
Příkazový řádek se nespouští v prostředí, a proto nemůže využívat funkce prostředí, jako je rozšíření proměnné prostředí. Pokud chcete tyto funkce využít, měli byste vyvolat prostředí v příkazovém řádku, například pomocí příkazu "cmd /c MyCommand" ve Windows nebo "/bin/sh -c MyCommand" v Linuxu. Pokud příkazový řádek odkazuje na cesty k souborům, měl by použít relativní cestu (vzhledem k pracovnímu adresáři Úloh) nebo proměnnou prostředí poskytovanou službou Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

constraints

TaskConstraints

Omezení, která platí pro úkol přípravy úlohy.

containerSettings

TaskContainerSettings

Nastavení kontejneru, ve kterém běží úloha přípravy úlohy.
Když je tato možnost zadána, všechny adresáře rekurzivně pod AZ_BATCH_NODE_ROOT_DIR (kořen Azure Batch adresářů na uzlu) se mapují do kontejneru, všechny proměnné prostředí úloh se mapují do kontejneru a příkazový řádek úlohy se spustí v kontejneru. Soubory vytvořené v kontejneru mimo AZ_BATCH_NODE_ROOT_DIR se nemusí projevit na disku hostitele, což znamená, že rozhraní API služby Batch nebudou mít k těmto souborům přístup.

environmentSettings

EnvironmentSetting[]

Seznam nastavení proměnných prostředí pro úlohu přípravy úlohy.

id

string

Řetězec, který jednoznačně identifikuje úlohu přípravy úlohy v rámci úlohy.
ID může obsahovat libovolnou kombinaci alfanumerických znaků, včetně spojovníků a podtržítků, a nesmí obsahovat více než 64 znaků. Pokud tuto vlastnost nezadáte, služba Batch přiřadí výchozí hodnotu "jobpreparation". Žádný jiný úkol v úloze nemůže mít stejné ID jako úkol přípravy úlohy. Pokud se pokusíte odeslat úlohu se stejným ID, služba Batch odmítne požadavek s kódem chyby TaskIdSameAsJobPreparationTask; Pokud voláte rozhraní REST API přímo, stavový kód HTTP je 409 (konflikt).

rerunOnNodeRebootAfterSuccess

boolean

Jestli má služba Batch znovu spustit úlohu přípravy úlohy po restartování výpočetního uzlu.
Úloha přípravy úlohy se vždy znovu spustí, pokud je výpočetní uzel reimaged nebo pokud se úloha přípravy úlohy nedokončila (například proto, že při spuštění úlohy došlo k restartování). Proto byste vždy měli zapsat úlohu přípravy úlohy tak, aby byla idempotentní a aby se při vícenásobném spuštění chovala správně. Výchozí hodnotou je hodnota true.

resourceFiles

ResourceFile[]

Seznam souborů, které služba Batch stáhne do výpočetního uzlu před spuštěním příkazového řádku.
Soubory uvedené v tomto prvku jsou umístěny v pracovním adresáři úlohy. Seznam souborů prostředků má maximální velikost. Při překročení maximální velikosti požadavek selže a kód chyby odpovědi bude RequestEntityTooLarge. Pokud k tomu dojde, musí se zmenšit velikost kolekce ResourceFiles. Toho můžete dosáhnout pomocí souborů .zip, balíčků aplikací nebo kontejnerů Dockeru.

userIdentity

UserIdentity

Identita uživatele, pod kterou se úloha přípravy úlohy spustí.
Pokud je tato úloha vynechána, spustí se jako uživatel bez oprávnění správce, který je jedinečný pro danou úlohu na výpočetních uzlech Windows, nebo jako uživatel bez oprávnění správce, který je jedinečný pro fond na výpočetních uzlech s Linuxem.

waitForSuccess

boolean

Zda má služba Batch čekat na úspěšné dokončení úlohy přípravy úlohy před plánováním jakýchkoli dalších úkolů úlohy na výpočetním uzlu. Úloha přípravy úlohy byla úspěšně dokončena, pokud se ukončí s ukončovacím kódem 0.
Pokud je hodnota true a úloha přípravy úlohy selže na uzlu, služba Batch opakuje úlohu přípravy úlohy až do maximálního počtu opakování (jak je uvedeno v elementu constraints). Pokud se úloha ani po všech opakovaných pokusech úspěšně nedokončila, pak služba Batch neplánuje úlohy úlohy na uzel. Uzel zůstává aktivní a může spouštět úkoly jiných úloh. Pokud je hodnota false, služba Batch nebude čekat na dokončení úlohy přípravy úlohy. V tomto případě mohou na výpočetním uzlu spustit jiné úkoly úlohy, zatímco úloha přípravy úlohy je stále spuštěna. a i když úloha přípravy úlohy selže, budou se nové úkoly dál plánovat na výpočetním uzlu. Výchozí hodnotou je hodnota true.

JobReleaseTask

Úloha uvolnění úlohy, která se spustí po dokončení úlohy na libovolném výpočetním uzlu, na kterém je úloha spuštěná.

Name Typ Description
commandLine

string

Příkazový řádek úlohy uvolnění úlohy.
Příkazový řádek se nespouští v prostředí, a proto nemůže využívat funkce prostředí, jako je rozšíření proměnné prostředí. Pokud chcete tyto funkce využít, měli byste vyvolat prostředí v příkazovém řádku, například pomocí příkazu "cmd /c MyCommand" ve Windows nebo "/bin/sh -c MyCommand" v Linuxu. Pokud příkazový řádek odkazuje na cesty k souborům, měl by použít relativní cestu (vzhledem k pracovnímu adresáři Úloh) nebo proměnnou prostředí poskytovanou službou Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

containerSettings

TaskContainerSettings

Nastavení kontejneru, ve kterém se úloha uvolnění úlohy spouští.
Když je tato možnost zadána, všechny adresáře rekurzivně pod AZ_BATCH_NODE_ROOT_DIR (kořen Azure Batch adresářů na uzlu) se mapují do kontejneru, všechny proměnné prostředí úloh se mapují do kontejneru a příkazový řádek úlohy se spustí v kontejneru. Soubory vytvořené v kontejneru mimo AZ_BATCH_NODE_ROOT_DIR se nemusí projevit na disku hostitele, což znamená, že rozhraní API služby Batch nebudou mít k těmto souborům přístup.

environmentSettings

EnvironmentSetting[]

Seznam nastavení proměnných prostředí pro úlohu uvolnění úlohy.

id

string

Řetězec, který jednoznačně identifikuje úlohu uvolnění úlohy v rámci úlohy.
ID může obsahovat libovolnou kombinaci alfanumerických znaků, včetně spojovníků a podtržítků, a nesmí obsahovat více než 64 znaků. Pokud tuto vlastnost nezadáte, služba Batch přiřadí výchozí hodnotu jobrelease. Žádný jiný úkol v úloze nemůže mít stejné ID jako úloha uvolnění úlohy. Pokud se pokusíte odeslat úlohu se stejným ID, služba Batch odmítne požadavek s kódem chyby TaskIdSameAsJobReleaseTask; Pokud voláte rozhraní REST API přímo, stavový kód HTTP je 409 (konflikt).

maxWallClockTime

string

Maximální uplynulý čas, po který může úloha uvolnění úlohy běžet na daném výpočetním uzlu, měřená od okamžiku spuštění úlohy. Pokud se úkol nedokončil v časovém limitu, služba Batch ji ukončí. Výchozí hodnota je 15 minut. Časový limit nesmí být delší než 15 minut. Pokud ano, služba Batch ji odmítne s chybou; Pokud voláte rozhraní REST API přímo, stavový kód HTTP je 400 (chybný požadavek).

resourceFiles

ResourceFile[]

Seznam souborů, které služba Batch stáhne do výpočetního uzlu před spuštěním příkazového řádku. Seznam souborů prostředků má maximální velikost. Při překročení maximální velikosti požadavek selže a kód chyby odpovědi bude RequestEntityTooLarge. Pokud k tomu dojde, musí se zmenšit velikost kolekce ResourceFiles. Toho můžete dosáhnout pomocí souborů .zip, balíčků aplikací nebo kontejnerů Dockeru.
Soubory uvedené v tomto prvku jsou umístěny v pracovním adresáři úlohy.

retentionTime

string

Minimální doba pro uchování adresáře úloh pro úlohu uvolnění úlohy na výpočetním uzlu. Po uplynutí této doby může služba Batch odstranit adresář úloh a veškerý jeho obsah.
Výchozí hodnota je 7 dnů, tj. adresář úloh se zachová po dobu 7 dnů, pokud se neodebere výpočetní uzel nebo úloha neodstraní.

userIdentity

UserIdentity

Identita uživatele, pod kterou se úloha uvolnění úlohy spouští.
Pokud je úloha vynechána, spustí se jako uživatel bez oprávnění správce, který je jedinečný pro danou úlohu.

JobSchedulingError

Při plánování úlohy došlo ve službě Batch k chybě.

Name Typ Description
category

ErrorCategory

Kategorie chyby plánování úloh.

code

string

Identifikátor chyby plánování úlohy. Kódy jsou neutrální a mají být využívány programově.

details

NameValuePair[]

Seznam dalších podrobností o chybách souvisejících s chybou plánování

message

string

Zpráva popisující chybu plánování úlohy, která má být vhodná pro zobrazení v uživatelském rozhraní.

JobState

Stav úlohy.

Name Typ Description
active

string

Úloha je k dispozici pro naplánování úkolů.

completed

string

Všechny úkoly byly ukončeny a systém nebude přijímat žádné další úkoly ani žádné další změny úlohy.

deleting

string

Uživatel požádal o odstranění úlohy, ale operace odstranění stále probíhá (například proto, že systém stále ukončuje spouštění úloh).

disabled

string

Uživatel úlohu zakázal. Nejsou spuštěny žádné úlohy a nebudou naplánovány žádné nové úlohy.

disabling

string

Uživatel požádal o zakázání úlohy, ale operace zakázání stále probíhá (například čeká na ukončení úlohy).

enabling

string

Uživatel požádal o povolení úlohy, ale operace povolení stále probíhá.

terminating

string

Úloha se chystá dokončit, protože se dokončila úloha Správce úloh, nebo protože uživatel úlohu ukončil, ale operace ukončení stále probíhá (například proto, že jsou spuštěné úkoly uvolnění úlohy).

JobStatistics

Statistika využití prostředků pro úlohu

Name Typ Description
kernelCPUTime

string

Celkový čas procesoru v režimu jádra (sečtený napříč všemi jádry a všemi výpočetními uzly) spotřebovaný všemi úkoly v úloze.

lastUpdateTime

string

Čas, kdy byly statistiky naposledy aktualizovány. Všechny statistiky jsou omezené na rozsah mezi startTime a lastUpdateTime.

numFailedTasks

integer

Celkový počet úkolů v úloze, které selhaly v daném časovém rozsahu.
Úloha selže, pokud vyčerpá maximální počet opakování bez vrácení ukončovací kód 0.

numSucceededTasks

integer

Celkový počet úkolů úspěšně dokončených v úloze v daném časovém rozsahu.
Úkol se úspěšně dokončí, pokud vrátí ukončovací kód 0.

numTaskRetries

integer

Celkový počet opakování všech úkolů v úloze v daném časovém rozsahu.

readIOGiB

number

Celkové množství dat v GiB přečtených z disku všemi úkoly v úloze.

readIOps

integer

Celkový počet operací čtení z disku provedených všemi úkoly v úloze

startTime

string

Počáteční čas časového rozsahu, na který se statistika vztahuje.

url

string

Adresa URL statistiky.

userCPUTime

string

Celkový čas procesoru v uživatelském režimu (sečtený napříč všemi jádry a všemi výpočetními uzly) spotřebovaný všemi úkoly v úloze.

waitTime

string

Celková doba čekání všech úkolů v úloze
Čekací doba pro úkol je definována jako uplynulý čas mezi vytvořením úlohy a zahájením spuštění úlohy. (Pokud se úloha opakuje kvůli selháním, doba čekání je doba do posledního spuštění úlohy.) Tato hodnota je hlášena pouze ve statistikách životnosti účtu; není součástí statistiky úlohy.

wallClockTime

string

Celkový hodinový čas všech úkolů v úloze.
Čas nástěnných hodin je uplynulý čas od okamžiku, kdy úloha začala běžet na výpočetním uzlu do dokončení (nebo k poslední aktualizaci statistik, pokud se úkol do té doby nedokončil). Pokud byl úkol zopakován, zahrnuje to čas nástěnných hodin všech opakování úkolu.

writeIOGiB

number

Celkový objem dat v GiB zapisovaných na disk všemi úkoly v úloze

writeIOps

integer

Celkový počet operací zápisu na disk provedených všemi úkoly v úloze

LinuxUserConfiguration

Vlastnosti použité k vytvoření uživatelského účtu na výpočetním uzlu s Linuxem

Name Typ Description
gid

integer

ID skupiny pro uživatelský účet.
Vlastnosti uid a gid musí být zadány společně, nebo vůbec. Pokud není zadaný, vybere příslušný operační systém gid.

sshPrivateKey

string

Privátní klíč SSH pro uživatelský účet.
Privátní klíč nesmí být chráněný heslem. Privátní klíč se používá k automatické konfiguraci ověřování na základě asymetrického klíče pro SSH mezi výpočetními uzly ve fondu Linuxu, pokud je vlastnost enableInterNodeCommunication fondu true (je ignorována, pokud má vlastnost enableInterNodeCommunication hodnotu false). Provede to umístěním páru klíčů do adresáře .ssh uživatele. Pokud není zadaný, není mezi výpočetními uzly nakonfigurovaný SSH bez hesla (neprovozuje se žádná úprava adresáře .ssh uživatele).

uid

integer

ID uživatele uživatelského účtu.
Vlastnosti uid a gid musí být zadány společně, nebo vůbec. Pokud není zadáno, základní operační systém vybere identifikátor UID.

LoginMode

Režim přihlášení pro uživatele

Name Typ Description
batch

string

Režim přihlášení LOGON32_LOGON_BATCH Win32. Režim dávkového přihlášení se doporučuje pro dlouhotrvající paralelní procesy.

interactive

string

Režim přihlášení LOGON32_LOGON_INTERACTIVE Win32. Nástroj Řízení uživatelských účtů je povolený ve fondech konfigurace Windows VirtualMachine. Pokud je tato možnost použita se zvýšenou identitou uživatele ve fondu Windows VirtualMachineConfiguration, relace uživatele nebude zvýšena, pokud aplikace spuštěná příkazovým řádkem task není nakonfigurována tak, aby vždy vyžadovala oprávnění správce nebo aby vždy vyžadovala maximální oprávnění.

ManagedDisk

Name Typ Description
storageAccountType

StorageAccountType

Typ účtu úložiště pro spravovaný disk.

MetadataItem

Pár název-hodnota přidružený k prostředku služby Batch.

Name Typ Description
name

string

Název položky metadat.

value

string

Hodnota položky metadat.

MountConfiguration

Systém souborů, který se má připojit k jednotlivým uzlům.

Name Typ Description
azureBlobFileSystemConfiguration

AzureBlobFileSystemConfiguration

Kontejner služby Azure Storage, který se má připojit pomocí FUSE objektů blob na každém uzlu.
Tato vlastnost se vzájemně vylučuje se všemi ostatními vlastnostmi.

azureFileShareConfiguration

AzureFileShareConfiguration

Sdílená složka Azure, která se má připojit k jednotlivým uzlům.
Tato vlastnost se vzájemně vylučuje se všemi ostatními vlastnostmi.

cifsMountConfiguration

CIFSMountConfiguration

Systém souborů CIFS/SMB, který se má připojit k jednotlivým uzlům.
Tato vlastnost se vzájemně vylučuje se všemi ostatními vlastnostmi.

nfsMountConfiguration

NFSMountConfiguration

Systém souborů NFS, který se má připojit k jednotlivým uzlům.
Tato vlastnost se vzájemně vylučuje se všemi ostatními vlastnostmi.

NameValuePair

Představuje dvojici název-hodnota.

Name Typ Description
name

string

Název ve dvojici název-hodnota.

value

string

Hodnota ve dvojici název-hodnota.

NetworkConfiguration

Konfigurace sítě pro fond

Name Typ Description
dynamicVNetAssignmentScope

DynamicVNetAssignmentScope

Rozsah dynamického přiřazení virtuální sítě.

enableAcceleratedNetworking

boolean

Jestli má tento fond povolit akcelerované síťové služby.
Akcelerované síťové služby umožňují virtualizaci SR-IOV (Single Root I/O Virtualization) na virtuálním počítači, což může vést k lepšímu výkonu sítě. Další podrobnosti najdete tady: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.

endpointConfiguration

PoolEndpointConfiguration

Konfigurace pro koncové body na výpočetních uzlech ve fondu služby Batch.
Konfigurace koncového bodu fondu se podporuje pouze u fondů s vlastností virtualMachineConfiguration.

publicIPAddressConfiguration

PublicIPAddressConfiguration

Konfigurace veřejné IP adresy pro výpočetní uzly ve fondu služby Batch.
Vlastnost konfigurace veřejné IP adresy se podporuje pouze u fondů s vlastností virtualMachineConfiguration.

subnetId

string

Identifikátor prostředku ARM podsítě virtuální sítě, ke které se připojí výpočetní uzly fondu. Toto je ve formátu /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.
Virtuální síť musí být ve stejné oblasti a předplatném jako účet Azure Batch. Zadaná podsíť by měla mít dostatek volných IP adres, aby pojala počet výpočetních uzlů ve fondu. Pokud podsíť nemá dostatek volných IP adres, fond částečně přidělí uzly a dojde k chybě změny velikosti. Instanční objekt MicrosoftAzureBatch musí mít pro zadanou virtuální síť roli přispěvatele klasických virtuálních počítačů Role-Based Access Control (RBAC). Zadaná podsíť musí umožňovat komunikaci ze služby Azure Batch, aby bylo možné plánovat úlohy na uzlech. Můžete to ověřit tak, že zkontrolujete, jestli má zadaná virtuální síť nějaké přidružené skupiny zabezpečení sítě (NSG). Pokud skupina zabezpečení sítě odmítne komunikaci s uzly v zadané podsíti, nastaví služba Batch stav výpočetních uzlů na nepoužitelné. Pro fondy vytvořené pomocí virtualMachineConfiguration se podporují jenom virtuální sítě ARM (Microsoft.Network/virtualNetworks), ale pro fondy vytvořené pomocí cloudServiceConfiguration se podporují virtuální sítě ARM i klasické virtuální sítě. Pokud zadaná virtuální síť nemá žádné přidružené skupiny zabezpečení sítě (NSG), musí být pro několik vyhrazených systémových portů povolena příchozí komunikace. Pro fondy vytvořené s konfigurací virtuálního počítače povolte porty 29876 a 29877 a také port 22 pro Linux a port 3389 pro Windows. Pro fondy vytvořené s konfigurací cloudové služby povolte porty 10100, 20100 a 30100. Povolte také odchozí připojení ke službě Azure Storage na portu 443. Další podrobnosti najdete tady: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Pravidlo skupiny zabezpečení sítě, které se použije na příchozí koncový bod.

Name Typ Description
access

NetworkSecurityGroupRuleAccess

Akce, která by se měla provést pro zadanou IP adresu, rozsah podsítě nebo značku.

priority

integer

Priorita tohoto pravidla.
Priority v rámci fondu musí být jedinečné a vyhodnocují se v pořadí podle priority. Čím nižší je číslo, tím vyšší je priorita. Pravidla mohou být například určena s čísly objednávek 150, 250 a 350. Pravidlo s číslem objednávky 150 má přednost před pravidlem, které má pořadí 250. Povolené priority jsou 150 až 4096. Pokud jsou zadány rezervované nebo duplicitní hodnoty, požadavek selže se stavovým kódem HTTP 400.

sourceAddressPrefix

string

Předpona zdrojové adresy nebo značka, která se má shodovat s pravidlem.
Platnými hodnotami jsou jedna IP adresa (tj. 10.10.10.10), podsíť PROTOKOLU IP (tj. 192.168.1.0/24), výchozí značka nebo * (pro všechny adresy). Pokud jsou zadané nějaké další hodnoty, požadavek selže se stavovým kódem HTTP 400.

sourcePortRanges

string[]

Rozsahy zdrojových portů, které se mají shodovat s pravidlem.
Platné hodnoty jsou '' (pro všechny porty 0 až 65535), konkrétní port (tj. 22) nebo rozsah portů (tj. 100–200). Porty musí být v rozsahu od 0 do 65535. Každá položka v této kolekci nesmí překrývat žádnou jinou položku (buď rozsah, nebo jednotlivý port). Pokud jsou zadané nějaké další hodnoty, požadavek selže se stavovým kódem HTTP 400. Výchozí hodnota je .

NetworkSecurityGroupRuleAccess

Akce, která by se měla provést pro zadanou IP adresu, rozsah podsítě nebo značku.

Name Typ Description
allow

string

Povolit přístup.

deny

string

Odepřít přístup.

NFSMountConfiguration

Informace používané k připojení k systému souborů NFS

Name Typ Description
mountOptions

string

Další možnosti příkazového řádku, které se mají předat příkazu mount.
Toto jsou možnosti net use ve Windows a možnosti připojení v Linuxu.

relativeMountPath

string

Relativní cesta na výpočetním uzlu, kam se připojí systém souborů
Všechny systémy souborů jsou připojené vzhledem k adresáři Batch mounts a jsou přístupné prostřednictvím proměnné prostředí AZ_BATCH_NODE_MOUNTS_DIR.

source

string

Identifikátor URI systému souborů, který se má připojit.

NodeCommunicationMode

Určuje, jak fond komunikuje se službou Batch.

Name Typ Description
classic

string

Uzly používající klasický režim komunikace vyžadují příchozí komunikaci TCP na portech 29876 a 29877 z rutiny BatchNodeManagement. Značka služby {region} a odchozí komunikace TCP na portu 443 do "Storage.region" a "BatchNodeManagement. Značky služby {region}".

default

string

Režim komunikace uzlu je automaticky nastaven službou Batch.

simplified

string

Uzly používající zjednodušený režim komunikace vyžadují odchozí komunikaci TCP na portu 443 do BatchNodeManagement. Značka služby {region}" Nejsou vyžadovány žádné otevřené příchozí porty.

NodePlacementConfiguration

Konfigurace umístění uzlů pro fond

Name Typ Description
policy

NodePlacementPolicyType

Typ zásad umístění uzlů ve fondech služby Batch.
Zásady přidělování, které služba Batch používá ke zřizování uzlů. Pokud není zadáno, služba Batch použije místní zásady.

NodePlacementPolicyType

Zásady umístění pro přidělování uzlů ve fondu.

Name Typ Description
regional

string

Všechny uzly ve fondu budou přiděleny ve stejné oblasti.

zonal

string

Uzly ve fondu budou rozložené do různých zón dostupnosti s maximálním úsilím.

OnAllTasksComplete

Akce, kterou má služba Batch provést, když jsou všechny úkoly v úloze ve stavu dokončení.

Name Typ Description
noaction

string

Není potřeba dělat nic. Úloha zůstane aktivní, pokud není ukončena nebo zakázána jiným způsobem.

terminatejob

string

Ukončete úlohu. Hodnota terminateReason úlohy je nastavená na AllTasksComplete.

OnTaskFailure

Akce, kterou by služba Batch měla provést, když jakákoli úloha v úloze selže.

Name Typ Description
noaction

string

Není potřeba dělat nic. Úloha zůstane aktivní, pokud není ukončena nebo zakázána jiným způsobem.

performexitoptionsjobaction

string

Proveďte akci přidruženou k podmínce ukončení úkolu v kolekci exitConditions úkolu. (To může mít za následek, že se neprovedou žádné akce, pokud je to přesně to, co určuje úkol.)

OSDisk

Nastavení pro disk operačního systému výpočetního uzlu

Name Typ Description
caching

CachingType

Určuje požadavky na ukládání do mezipaměti. Možné hodnoty jsou: None, ReadOnly, ReadWrite. Výchozí hodnoty jsou: Žádné pro úložiště úrovně Standard. ReadOnly pro Premium Storage.
Výchozí hodnota pro ukládání do mezipaměti je žádná. Informace o možnostech ukládání do mezipaměti najdete tady: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

diskSizeGB

integer

Počáteční velikost disku v GB při vytváření nového disku s operačním systémem

ephemeralOSDiskSettings

DiffDiskSettings

Určuje dočasné nastavení disku pro disk operačního systému používaný výpočetním uzlem (virtuálním počítačem).

managedDisk

ManagedDisk

Parametry spravovaného disku.

writeAcceleratorEnabled

boolean

Určuje, jestli má být na disku povolený nebo zakázaný writeAccelerator.

OutputFile

Specifikace pro nahrávání souborů z Azure Batch výpočetního uzlu do jiného umístění po dokončení procesu úlohy službou Batch.

Name Typ Description
destination

OutputFileDestination

Cíl pro výstupní soubory.

filePattern

string

Vzor označující, které soubory se mají nahrát.
Podporují se relativní i absolutní cesty. Relativní cesty jsou relativní vzhledem k pracovnímu adresáři task. Podporují se následující zástupné znaky: * odpovídá 0 nebo více znakům (například vzor abc* odpovídá abc nebo abcdef), ** odpovídá libovolnému adresáři, ? odpovídá jakémukoli jednotlivému znaku, [abc] odpovídá jednomu znaku v hranatých závorkách a [a-c] odpovídá jednomu znaku v oblasti. Hranaté závorky můžou obsahovat negaci, která odpovídá libovolnému nezadanému znaku (například [!abc] odpovídá libovolnému znaku, ale a, b nebo c). Pokud název souboru začíná na "." je ve výchozím nastavení ignorován, ale může být shodný tak, že ho explicitně zadáte (například .gif nebude odpovídat .a.gif, ale ..gif bude). Jednoduchý příklad: ***.txt odpovídá jakémukoli souboru, který nezačíná na ., a končí .txt v pracovním adresáři úlohy nebo v libovolném podadresáři. Pokud název souboru obsahuje zástupný znak, může být řídicí znak pomocí závorek (například abc[] odpovídá souboru s názvem abc). Všimněte si, že \ i / se ve Windows považují za oddělovače adresářů, ale pouze / je v Linuxu. Proměnné prostředí (%var% ve Windows nebo $var v Linuxu) se před použitím vzoru rozbalí.

uploadOptions

OutputFileUploadOptions

Další možnosti pro operaci nahrávání, včetně podmínek, za jakých se má nahrávání provést.

OutputFileBlobContainerDestination

Určuje cíl pro nahrání souboru v kontejneru úložiště objektů blob v Azure.

Name Typ Description
containerUrl

string

Adresa URL kontejneru v rámci Azure Blob Storage, do které se mají nahrát soubory.
Pokud spravovanou identitu nepoužíváte, musí adresa URL obsahovat sdílený přístupový podpis (SAS) udělující oprávnění k zápisu do kontejneru.

identityReference

ComputeNodeIdentityReference

Odkaz na identitu přiřazenou uživatelem, která se má použít pro přístup k Azure Blob Storage určené pomocí containerUrl
Identita musí mít oprávnění k zápisu do kontejneru Azure Blob Storage.

path

string

Cílový objekt blob nebo virtuální adresář v kontejneru Azure Storage.
Pokud filePattern odkazuje na konkrétní soubor (tj. neobsahuje žádné zástupné é kódy), pak cesta je název objektu blob, do kterého se má soubor nahrát. Pokud filePattern obsahuje jeden nebo více zástupných znaků (a proto se může shodovat s více soubory), pak cesta je název virtuálního adresáře objektů blob (který je před každým názvem objektu blob), do kterého se mají nahrát soubory. Pokud je vynechán, soubory se nahrají do kořenového adresáře kontejneru s názvem objektu blob, který odpovídá názvu souboru.

uploadHeaders

HttpHeader[]

Seznam dvojic název-hodnota pro hlavičky, které se mají použít při nahrávání výstupních souborů
Tyto hlavičky se zadají při nahrávání souborů do služby Azure Storage. Oficiální dokument o povolených hlavicích při nahrávání objektů blob: https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

Cíl, do kterého se má soubor nahrát.

Name Typ Description
container

OutputFileBlobContainerDestination

Umístění v úložišti objektů blob v Azure, do kterého se nahrají soubory.

OutputFileUploadCondition

Podmínky, za kterých se má nahrát výstupní soubor úkolu nebo sada souborů.

Name Typ Description
taskcompletion

string

Po ukončení procesu úlohy nahrajte soubory bez ohledu na to, jaký byl ukončovací kód.

taskfailure

string

Nahrajte soubory až po ukončení procesu úlohy s nenulovým ukončovacím kódem.

tasksuccess

string

Nahrajte soubory až po ukončení procesu úlohy s ukončovacím kódem 0.

OutputFileUploadOptions

Podrobnosti o operaci nahrávání výstupního souboru, včetně toho, za jakých podmínek se má nahrávání provést.

Name Typ Description
uploadCondition

OutputFileUploadCondition

Podmínky, za kterých se má výstupní soubor úkolu nebo sada souborů nahrát.
Výchozí hodnota je taskcompletion.

PoolEndpointConfiguration

Konfigurace koncového bodu pro fond

Name Typ Description
inboundNATPools

InboundNATPool[]

Seznam příchozích fondů NAT, které je možné použít k externímu adresování konkrétních portů na jednotlivých výpočetních uzlech.
Maximální počet příchozích fondů NAT na fond služby Batch je 5. Pokud je překročen maximální počet příchozích fondů NAT, požadavek selže se stavovým kódem HTTP 400. To nelze zadat, pokud IPAddressProvisioningType je NoPublicIPAddresses.

PoolInformation

Určuje, jak má být úloha přiřazena k fondu.

Name Typ Description
autoPoolSpecification

AutoPoolSpecification

Charakteristiky dočasného "automatického fondu". Služba Batch vytvoří tento automatický fond při odeslání úlohy.
Pokud automatické vytváření fondu selže, služba Batch přesune úlohu do dokončeného stavu a chyba vytvoření fondu se nastaví ve vlastnosti chyby plánování úlohy. Služba Batch spravuje životnost automatického fondu (vytvoření i odstranění, pokud není zadáno keepAlive). Jakékoli akce uživatele, které mají vliv na životnost automatického fondu, když je úloha aktivní, budou mít za následek neočekávané chování. Musíte zadat buď ID fondu, nebo specifikaci automatického fondu, ale ne obojí.

poolId

string

ID existujícího fondu. Všechny úlohy úlohy se poběží v zadaném fondu.
Musíte zajistit, že fond, na který tato vlastnost odkazuje, existuje. Pokud fond neexistuje v okamžiku, kdy se služba Batch pokusí naplánovat úlohu, nebudou žádné úlohy pro tuto úlohu spuštěny, dokud nevytvoříte fond s tímto ID. Všimněte si, že služba Batch neodmítne žádost o úlohu. Jednoduše nespustí úkoly, dokud fond neexistuje. Musíte zadat buď ID fondu, nebo specifikaci automatického fondu, ale ne obojí.

PoolLifetimeOption

Minimální životnost vytvořených automatických fondů a způsob přiřazení více úloh podle plánu k fondům.

Name Typ Description
job

string

Fond existuje po celou dobu životnosti úlohy, pro kterou je vyhrazený. Služba Batch vytvoří fond při vytváření úlohy. Pokud se u plánu úloh použije možnost "úloha", služba Batch vytvoří nový automatický fond pro každou úlohu vytvořenou v plánu.

jobschedule

string

Fond existuje po celou dobu životnosti plánu úloh. Služba Batch vytvoří fond při vytvoření první úlohy podle plánu. Tuto možnost můžete použít pouze u plánů úloh, nikoli u úloh.

PoolSpecification

Specifikace pro vytvoření nového fondu

Name Typ Description
applicationLicenses

string[]

Seznam licencí aplikací, které služba Batch zpřístupní na každém výpočetním uzlu ve fondu.
Seznam licencí aplikací musí být podmnožinou dostupných licencí aplikací služby Batch. Pokud je požadována licence, která není podporovaná, vytvoření fondu se nezdaří. Povolené licence dostupné ve fondu jsou maya, vray, 3dsmax, arnold. Za každou licenci aplikace přidanou do fondu se účtuje další poplatek.

applicationPackageReferences

ApplicationPackageReference[]

Seznam balíčků, které se mají nainstalovat na každý výpočetní uzel ve fondu.
Při vytváření fondu musí být ID aplikace balíčku plně kvalifikované (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Změny odkazů na balíčky mají vliv na všechny nové uzly, které se připojují k fondu, ale nemají vliv na výpočetní uzly, které už jsou ve fondu, dokud se nerestartují nebo nereimagují. V každém daném fondu je maximálně 10 odkazů na balíčky.

autoScaleEvaluationInterval

string

Časový interval, ve kterém se má velikost fondu automaticky upravit podle vzorce automatického škálování.
Výchozí hodnota je 15 minut. Minimální a maximální hodnota je 5 minut a 168 hodin. Pokud zadáte hodnotu menší než 5 minut nebo větší než 168 hodin, služba Batch odmítne požadavek s chybou neplatné hodnoty vlastnosti. Pokud voláte rozhraní REST API přímo, stavový kód HTTP je 400 (Chybný požadavek).

autoScaleFormula

string

Vzorec pro požadovaný počet výpočetních uzlů ve fondu.
Tato vlastnost nesmí být zadána, pokud je vlastnost enableAutoScale nastavená na hodnotu false. Vyžaduje se, pokud je vlastnost enableAutoScale nastavená na hodnotu true. Platnost vzorce se kontroluje před vytvořením fondu. Pokud vzorec není platný, služba Batch požadavek odmítne s podrobnými informacemi o chybě.

certificateReferences

CertificateReference[]

Seznam certifikátů, které se mají nainstalovat na každý výpočetní uzel ve fondu.
U uzlů Windows služba Batch nainstaluje certifikáty do zadaného úložiště certifikátů a umístění. V případě linuxových výpočetních uzlů se certifikáty ukládají v adresáři v pracovním adresáři úlohy a do úlohy se zadává proměnná prostředí, AZ_BATCH_CERTIFICATES_DIR se má dotazovat na toto umístění. U certifikátů s viditelností remoteUser se v domovském adresáři uživatele vytvoří adresář certs (např. /home/{user-name}/certs) a certifikáty se umístí do tohoto adresáře.

Upozornění: Tato vlastnost je zastaralá a po únoru 2024 se odebere. Místo toho použijte rozšíření Azure KeyVault .

cloudServiceConfiguration

CloudServiceConfiguration

Konfigurace cloudové služby pro fond
Tato vlastnost se musí zadat, pokud je potřeba fond vytvořit s virtuálními počítači Azure PaaS. Tato vlastnost a virtualMachineConfiguration se vzájemně vylučují a jedna z vlastností musí být zadána. Pokud není zadán ani jeden, služba Batch vrátí chybu; Pokud voláte rozhraní REST API přímo, stavový kód HTTP je 400 (Chybný požadavek). Tuto vlastnost nelze zadat, pokud byl účet Batch vytvořen s vlastností poolAllocationMode nastavenou na hodnotu UserSubscription.

displayName

string

Zobrazovaný název fondu.
Zobrazovaný název nemusí být jedinečný a může obsahovat jakékoli znaky Unicode až do maximální délky 1024.

enableAutoScale

boolean

Určuje, jestli se má velikost fondu v průběhu času automaticky upravovat.
Pokud false, musí být zadána alespoň jedna z targetDedicatedNodes a targetLowPriorityNodes. Pokud je true, autoScaleFormula element je povinný. Velikost fondu se automaticky změní podle vzorce. Výchozí hodnota je False.

enableInterNodeCommunication

boolean

Určuje, jestli fond umožňuje přímou komunikaci mezi výpočetními uzly.
Povolení komunikace mezi uzly omezuje maximální velikost fondu z důvodu omezení nasazení na výpočetní uzly fondu. To může mít za následek, že fond nedosáhne požadované velikosti. Výchozí hodnota je False.

metadata

MetadataItem[]

Seznam párů název-hodnota přidružených k fondu jako metadata.
Služba Batch nepřiřazuje metadatům žádný význam. je určen výhradně pro použití uživatelského kódu.

mountConfiguration

MountConfiguration[]

Seznam systémů souborů, které se mají připojit k jednotlivým uzlům ve fondu.
To podporuje Azure Files, NFS, CIFS/SMB a Blobfuse.

networkConfiguration

NetworkConfiguration

Konfigurace sítě pro fond.
Konfigurace sítě pro fond.

resizeTimeout

string

Časový limit pro přidělení výpočetních uzlů do fondu.
Tento časový limit platí pouze pro ruční škálování. pokud je vlastnost enableAutoScale nastavená na hodnotu true, nemá žádný vliv. Výchozí hodnota je 15 minut. Minimální hodnota je 5 minut. Pokud zadáte hodnotu menší než 5 minut, služba Batch odmítne požadavek s chybou; Pokud voláte rozhraní REST API přímo, stavový kód HTTP je 400 (Chybný požadavek).

resourceTags

object

Uživatelem zadané značky přidružené k fondu.
Uživatelem definované značky, které mají být přidruženy k fondu Azure Batch. Po zadání se tyto značky rozšíří do záložních prostředků Azure přidružených k fondu. Tuto vlastnost lze zadat pouze v případě, že byl účet Batch vytvořen s vlastností poolAllocationMode nastavenou na UserSubscription.

startTask

StartTask

Úloha, která se spustí na každém výpočetním uzlu při připojování k fondu. Úloha se spustí při přidání výpočetního uzlu do fondu nebo při restartování výpočetního uzlu.
Služba Batch bude opakovat úlohy při aktivaci operace obnovení na uzlu. Mezi příklady operací obnovení patří (mimo jiné) restartování uzlu, který není v pořádku, nebo když výpočetní uzel zmizel kvůli selhání hostitele. Opakování kvůli operacím obnovení jsou nezávislé na a nezapočítávají se do hodnoty maxTaskRetryCount. I když je hodnota maxTaskRetryCount 0, může dojít k internímu opakování kvůli operaci obnovení. Z tohoto důvodu by všechny úkoly měly být idempotentní. To znamená, že úkoly musí tolerovat přerušení a restartování bez poškození nebo duplicitních dat. Osvědčeným postupem pro dlouhotrvající úlohy je použít nějakou formu vytváření kontrolních bodů. V některých případech může být startTask znovu spuštěn, i když se výpočetní uzel nerestartoval. Je třeba věnovat zvláštní pozornost tomu, abyste se vyhnuli starttaskům, které vytvářejí přerušovaný proces nebo instalují/spouští služby z pracovního adresáře StartTask, protože to službě Batch zablokuje možnost znovu spustit startTask.

targetDedicatedNodes

integer

Požadovaný počet vyhrazených výpočetních uzlů ve fondu
Tato vlastnost nesmí být zadána, pokud je vlastnost enableAutoScale nastavená na hodnotu true. Pokud je vlastnost enableAutoScale nastavená na hodnotu false, musíte nastavit buď targetDedicatedNodes, targetLowPriorityNodes, nebo obojí.

targetLowPriorityNodes

integer

Požadovaný počet spotových výpočetních uzlů nebo výpočetních uzlů s nízkou prioritou ve fondu
Tato vlastnost nesmí být zadána, pokud je vlastnost enableAutoScale nastavená na hodnotu true. Pokud je vlastnost enableAutoScale nastavená na hodnotu false, musíte nastavit buď targetDedicatedNodes, targetLowPriorityNodes, nebo obojí.

targetNodeCommunicationMode

NodeCommunicationMode

Požadovaný režim komunikace uzlu pro fond.
Pokud je vynechán, výchozí hodnota je Výchozí.

taskSchedulingPolicy

TaskSchedulingPolicy

Způsob distribuce úkolů mezi výpočetní uzly ve fondu
Pokud není zadaný, je výchozí hodnota rozložena.

taskSlotsPerNode

integer

Počet slotů úloh, které lze použít ke spouštění souběžných úloh na jednom výpočetním uzlu ve fondu.
Výchozí hodnota je 1. Maximální hodnota je menší ze 4násobku počtu jader vmSize fondu nebo 256.

userAccounts

UserAccount[]

Seznam uživatelských účtů, které se mají vytvořit na každém výpočetním uzlu ve fondu.

virtualMachineConfiguration

VirtualMachineConfiguration

Konfigurace virtuálního počítače pro fond.
Tuto vlastnost je potřeba zadat, pokud je potřeba fond vytvořit s virtuálními počítači Azure IaaS. Tato vlastnost a cloudServiceConfiguration se vzájemně vylučují a musí být zadána jedna z vlastností. Pokud není zadán ani jeden, služba Batch vrátí chybu; Pokud voláte rozhraní REST API přímo, stavový kód HTTP je 400 (Chybný požadavek).

vmSize

string

Velikost virtuálních počítačů ve fondu. Všechny virtuální počítače ve fondu mají stejnou velikost.
Informace o dostupných velikostech virtuálních počítačů ve fondech najdete v tématu Volba velikosti virtuálního počítače pro výpočetní uzly v Azure Batch fondu (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

PublicIPAddressConfiguration

Konfigurace veřejné IP adresy síťové konfigurace fondu.

Name Typ Description
ipAddressIds

string[]

Seznam veřejných IP adres, které bude služba Batch používat při zřizování výpočetních uzlů.
Počet ZDE zadaných IP adres omezuje maximální velikost fondu – pro každou veřejnou IP adresu je možné přidělit 100 vyhrazených uzlů nebo 100 uzlů spotové/s nízkou prioritou. Například fond, který potřebuje 250 vyhrazených virtuálních počítačů, bude potřebovat aspoň 3 veřejné IP adresy. Každý prvek této kolekce má tvar: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

provision

IPAddressProvisioningType

Typ zřizování pro veřejné IP adresy fondu.
Výchozí hodnota je BatchManaged.

ResourceFile

Jeden soubor nebo více souborů ke stažení do výpočetního uzlu

Name Typ Description
autoStorageContainerName

string

Název kontejneru úložiště v účtu automatického úložiště.
Vlastnosti autoStorageContainerName, storageContainerUrl a httpUrl se vzájemně vylučují a jedna z nich musí být zadána.

blobPrefix

string

Předpona objektu blob, která se má použít při stahování objektů blob z kontejneru Azure Storage. Stáhnou se jenom objekty blob, jejichž názvy začínají zadanou předponou.
Vlastnost je platná pouze při použití autoStorageContainerName nebo storageContainerUrl. Tato předpona může být částečný název souboru nebo podadresář. Pokud není předpona zadána, stáhnou se všechny soubory v kontejneru.

fileMode

string

Atribut režimu oprávnění k souboru v osmičkovém formátu.
Tato vlastnost se vztahuje pouze na soubory stahované do výpočetních uzlů s Linuxem. Pokud je zadaný pro resourceFile, který se stáhne do výpočetního uzlu Windows, bude ignorován. Pokud tato vlastnost není pro výpočetní uzel s Linuxem zadaná, použije se pro soubor výchozí hodnota 0770.

filePath

string

Umístění na výpočetním uzlu, do kterého se mají stáhnout soubory, vzhledem k pracovnímu adresáři úlohy.
Pokud je zadána vlastnost httpUrl, filePath je povinný a popisuje cestu, do které bude soubor stažen, včetně názvu souboru. Jinak pokud je zadána vlastnost autoStorageContainerName nebo storageContainerUrl, filePath je nepovinný a je adresář ke stažení souborů do. V případě použití filePath jako adresáře se veškerá adresářová struktura, která je již přidružená ke vstupním datům, zachovají v plném rozsahu a připojí se k zadanému adresáři filePath. Zadaná relativní cesta nemůže být oddělena od pracovního adresáře úlohy (například pomocí ..).

httpUrl

string

Adresa URL souboru, který chcete stáhnout.
Vlastnosti autoStorageContainerName, storageContainerUrl a httpUrl se vzájemně vylučují a jedna z nich musí být zadána. Pokud adresa URL odkazuje na Azure Blob Storage, musí být čitelná z výpočetních uzlů. Existují tři způsoby, jak získat takovou adresu URL pro objekt blob ve službě Azure Storage: patří sdílený přístupový podpis (SAS) udělující oprávnění ke čtení objektu blob, použití spravované identity s oprávněním ke čtení nebo nastavení seznamu ACL pro objekt blob nebo jeho kontejner tak, aby umožňoval veřejný přístup.

identityReference

ComputeNodeIdentityReference

Odkaz na identitu přiřazenou uživatelem, která se má použít pro přístup k Azure Blob Storage určené pomocí storageContainerUrl nebo httpUrl
Odkaz na identitu přiřazenou uživatelem přidruženou k fondu služby Batch, který bude používat výpočetní uzel.

storageContainerUrl

string

Adresa URL kontejneru objektů blob v rámci Azure Blob Storage.
Vlastnosti autoStorageContainerName, storageContainerUrl a httpUrl se vzájemně vylučují a jedna z nich musí být zadána. Tato adresa URL musí být čitelná a vypsatelná z výpočetních uzlů. Existují tři způsoby, jak takovou adresu URL pro kontejner ve službě Azure Storage získat: můžete zahrnout sdílený přístupový podpis (SAS) udělující oprávnění ke čtení a seznamu v kontejneru, použít spravovanou identitu s oprávněními ke čtení a seznamu seznamů nebo nastavit seznam ACL pro kontejner tak, aby umožňoval veřejný přístup.

SecurityProfile

Určuje nastavení profilu zabezpečení pro virtuální počítač nebo škálovací sadu virtuálních počítačů.

Name Typ Description
encryptionAtHost

boolean

Tuto vlastnost může uživatel v požadavku použít k povolení nebo zakázání šifrování hostitele pro virtuální počítač nebo škálovací sadu virtuálních počítačů. Tím se povolí šifrování pro všechny disky, včetně disku prostředku nebo dočasného disku v samotném hostiteli.

securityType

SecurityTypes

Určuje SecurityType virtuálního počítače. Pokud chcete povolit UefiSettings, musí být nastavena na libovolnou zadanou hodnotu.

uefiSettings

UefiSettings

Určuje nastavení zabezpečení, jako je zabezpečené spouštění a virtuální počítač vTPM použitý při vytváření virtuálního počítače.
Určuje nastavení zabezpečení, jako je zabezpečené spouštění a virtuální počítač vTPM použitý při vytváření virtuálního počítače.

SecurityTypes

Určuje SecurityType virtuálního počítače. Pokud chcete povolit UefiSettings, musí být nastavena na libovolnou zadanou hodnotu.

Name Typ Description
trustedLaunch

string

Důvěryhodné spuštění chrání před pokročilými a trvalými technikami útoku.

ServiceArtifactReference

Určuje REFERENČNÍ ID artefaktu služby, které se používá k nastavení stejné verze image pro všechny virtuální počítače ve škálovací sadě při použití nejnovější verze image.

Name Typ Description
id

string

ID odkazu na artefakt služby ServiceArtifactReference
Referenční ID artefaktu služby ve formě /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

StartTask

Úloha, která se spustí při připojení uzlu k fondu ve službě Azure Batch nebo při restartování nebo opětovném nastavení výpočetního uzlu.

Name Typ Description
commandLine

string

Příkazový řádek StartTask.
Příkazový řádek se nespouští v prostředí, a proto nemůže využívat funkce prostředí, jako je rozšíření proměnné prostředí. Pokud chcete tyto funkce využít, měli byste vyvolat prostředí v příkazovém řádku, například pomocí příkazu "cmd /c MyCommand" ve Windows nebo "/bin/sh -c MyCommand" v Linuxu. Pokud příkazový řádek odkazuje na cesty k souborům, měl by použít relativní cestu (vzhledem k pracovnímu adresáři Úloh) nebo proměnnou prostředí poskytovanou službou Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

containerSettings

TaskContainerSettings

Nastavení kontejneru, ve kterém běží StartTask.
Když je tato možnost zadána, všechny adresáře rekurzivně pod AZ_BATCH_NODE_ROOT_DIR (kořen Azure Batch adresářů na uzlu) se mapují do kontejneru, všechny proměnné prostředí úloh se mapují do kontejneru a příkazový řádek úlohy se spustí v kontejneru. Soubory vytvořené v kontejneru mimo AZ_BATCH_NODE_ROOT_DIR se nemusí projevit na disku hostitele, což znamená, že rozhraní API služby Batch nebudou mít k těmto souborům přístup.

environmentSettings

EnvironmentSetting[]

Seznam nastavení proměnných prostředí pro StartTask.

maxTaskRetryCount

integer

Maximální počet opakování úkolu.
Služba Batch opakuje úlohu, pokud její ukončovací kód není nenulový. Všimněte si, že tato hodnota konkrétně řídí počet opakování. Služba Batch tuto úlohu jednou vyzkouší a až do tohoto limitu se může zkusit znovu. Pokud je například maximální počet opakování 3, služba Batch zkusí úlohu až 4krát (jeden počáteční pokus a 3 opakování). Pokud je maximální počet opakování 0, služba Batch nezkusí úlohu zopakovat. Pokud je maximální počet opakování -1, služba Batch opakuje úlohu bez omezení, ale nedoporučuje se to pro spouštěcí úkol ani žádný úkol. Výchozí hodnota je 0 (bez opakování).

resourceFiles

ResourceFile[]

Seznam souborů, které služba Batch stáhne do výpočetního uzlu před spuštěním příkazového řádku. Seznam souborů prostředků má maximální velikost. Při překročení maximální velikosti požadavek selže a kód chyby odpovědi bude RequestEntityTooLarge. Pokud k tomu dojde, musí se zmenšit velikost kolekce ResourceFiles. Toho můžete dosáhnout pomocí souborů .zip, balíčků aplikací nebo kontejnerů Dockeru.
Soubory uvedené v tomto prvku jsou umístěny v pracovním adresáři úlohy.

userIdentity

UserIdentity

Identita uživatele, pod kterou běží StartTask.
Pokud je úloha vynechána, spustí se jako uživatel bez oprávnění správce, který je jedinečný pro danou úlohu.

waitForSuccess

boolean

Jestli má služba Batch čekat na úspěšné dokončení startTask (tj. na ukončení s ukončovacím kódem 0) před plánováním úkolů na výpočetním uzlu.
Pokud je hodnota true a startTask selže na uzlu, služba Batch opakuje startTask až do maximálního počtu opakování (maxTaskRetryCount). Pokud se úloha ani po všech opakováních úspěšně nedokončila, služba Batch označí uzel jako nepoužitelný a nebude na něj plánovat úkoly. Tuto podmínku je možné zjistit prostřednictvím podrobností o stavu výpočetního uzlu a informací o selhání. Pokud je hodnota false, služba Batch nebude čekat na dokončení startTask. V tomto případě se na výpočetním uzlu mohou spustit jiné úlohy, zatímco startTask je stále spuštěný. a i když startTask selže, budou se nové úkoly dál plánovat na výpočetním uzlu. Výchozí hodnota je true.

StorageAccountType

Typ účtu úložiště pro použití při vytváření datových disků nebo disku s operačním systémem.

Name Typ Description
premium_lrs

string

Datový disk nebo disk s operačním systémem by měl používat místně redundantní úložiště úrovně Premium.

standard_lrs

string

Datový disk nebo disk s operačním systémem by měl používat standardní místně redundantní úložiště.

standardssd_lrs

string

Datový disk nebo disk s operačním systémem by měl používat místně redundantní úložiště SSD úrovně Standard.

TaskConstraints

Omezení provádění, která se mají použít pro úlohu.

Name Typ Description
maxTaskRetryCount

integer

Maximální počet opakování úkolu. Služba Batch opakuje úlohu, pokud její ukončovací kód není nenulový.
Všimněte si, že tato hodnota konkrétně řídí počet opakování spustitelného souboru úlohy kvůli nenulovém ukončovacímu kódu. Služba Batch tuto úlohu jednou vyzkouší a až do tohoto limitu se může zkusit znovu. Pokud je například maximální počet opakování 3, služba Batch zkusí úlohu až 4krát (jeden počáteční pokus a 3 opakování). Pokud je maximální počet opakování 0, služba Batch se po prvním pokusu o opakování úlohy nepokusí. Pokud je maximální počet opakování -1, služba Batch opakuje úlohu bez omezení, ale nedoporučuje se to pro spouštěcí úkol ani žádný úkol. Výchozí hodnota je 0 (bez opakování).

maxWallClockTime

string

Maximální uplynulý čas, který může úkol spustit, měřený od okamžiku spuštění úlohy. Pokud se úkol nedokončil v časovém limitu, služba Batch ji ukončí.
Pokud to není zadané, neexistuje žádný časový limit, jak dlouho může úloha běžet.

retentionTime

string

Minimální doba uchování adresáře úloh na výpočetním uzlu, na kterém byl spuštěn, od okamžiku dokončení provádění. Po uplynutí této doby může služba Batch odstranit adresář úloh a veškerý jeho obsah.
Výchozí hodnota je 7 dnů, tj. adresář úloh se zachová po dobu 7 dnů, pokud se neodebere výpočetní uzel nebo úloha neodstraní.

TaskContainerSettings

Nastavení kontejneru pro úlohu.

Name Typ Description
containerRunOptions

string

Další možnosti příkazu container create
Tyto další možnosti jsou kromě možností řízených službou Batch k dispozici jako argumenty příkazu docker create.

imageName

string

Image, která se má použít k vytvoření kontejneru, ve kterém bude úloha spuštěna.
Toto je úplný odkaz na image, který by byl zadán pro "docker pull". Pokud jako součást názvu obrázku není uvedena žádná značka, použije se jako výchozí značka ":latest".

registry

ContainerRegistry

Privátní registr, který obsahuje image kontejneru.
Toto nastavení je možné vynechat, pokud už jste ho zadali při vytváření fondu.

workingDirectory

ContainerWorkingDirectory

Umístění pracovního adresáře úloh kontejneru.
Výchozí hodnota je taskWorkingDirectory.

TaskSchedulingPolicy

Určuje, jak se mají úkoly distribuovat mezi výpočetní uzly.

Name Typ Description
nodeFillType

ComputeNodeFillType

Jak se úlohy distribuují mezi výpočetní uzly ve fondu.
Pokud není zadáno, je výchozí rozprostřený.

UefiSettings

Určuje nastavení zabezpečení, jako je zabezpečené spouštění a virtuální počítač vTPM použitý při vytváření virtuálního počítače.

Name Typ Description
secureBootEnabled

boolean

Určuje, jestli má být na virtuálním počítači povolené zabezpečené spouštění.

vTpmEnabled

boolean

Určuje, jestli se má na virtuálním počítači povolit vTPM.

UserAccount

Vlastnosti použité k vytvoření uživatele sloužícího ke spouštění úloh na výpočetním uzlu Azure Batch.

Name Typ Description
elevationLevel

ElevationLevel

Úroveň zvýšení oprávnění uživatelského účtu.
Výchozí hodnota je nonAdmin.

linuxUserConfiguration

LinuxUserConfiguration

Konfigurace uživatele specifická pro Linux pro uživatelský účet.
Tato vlastnost se ignoruje, pokud je zadána ve fondu Windows. Pokud není zadaný, uživatel se vytvoří s výchozími možnostmi.

name

string

Název uživatelského účtu. Názvy můžou obsahovat libovolné znaky Unicode až do maximální délky 20.

password

string

Heslo k uživatelskému účtu.

windowsUserConfiguration

WindowsUserConfiguration

Konfigurace uživatele specifická pro systém Windows pro uživatelský účet.
Tuto vlastnost lze zadat pouze v případě, že je uživatel ve fondu Windows. Pokud není zadáno a ve fondu Windows, uživatel se vytvoří s výchozími možnostmi.

UserIdentity

Definice identity uživatele, pod kterou je úloha spuštěna.

Name Typ Description
autoUser

AutoUserSpecification

Automatický uživatel, pod kterým je úloha spuštěna.
Vlastnosti userName a autoUser se vzájemně vylučují; musíte zadat jeden, ale ne oba.

username

string

Název identity uživatele, pod kterou je úloha spuštěna.
Vlastnosti userName a autoUser se vzájemně vylučují; musíte zadat jeden, ale ne oba.

VirtualMachineConfiguration

Konfigurace výpočetních uzlů ve fondu na základě infrastruktury Azure Virtual Machines

Name Typ Description
containerConfiguration

ContainerConfiguration

Konfigurace kontejneru pro fond.
Pokud je tato možnost zadána, provede se na každém výpočetním uzlu ve fondu nastavení, aby se úlohy mohly spouštět v kontejnerech. Všechny běžné úlohy a úlohy správce úloh spuštěné v tomto fondu musí určovat vlastnost containerSettings a všechny ostatní úkoly ji mohou určit.

dataDisks

DataDisk[]

Konfigurace datových disků připojených k výpočetním uzlům ve fondu
Tato vlastnost musí být zadána, pokud výpočetní uzly ve fondu potřebují mít připojené prázdné datové disky. Tuto aktualizaci nelze aktualizovat. Každý výpočetní uzel získá svůj vlastní disk (disk není sdílená složka). Existující disky nelze připojit, každý připojený disk je prázdný. Při odebrání výpočetního uzlu z fondu se disk a všechna data k němu přidružená také odstraní. Disk není po připojení naformátovaný, musí být před použitím naformátován – další informace najdete v tématu https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux a https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.

diskEncryptionConfiguration

DiskEncryptionConfiguration

Konfigurace šifrování disku pro fond.
Pokud je zadáno, šifrování se provádí na každém uzlu ve fondu během zřizování uzlů.

extensions

VMExtension[]

Rozšíření virtuálního počítače pro fond.
Pokud je tato hodnota zadána, rozšíření uvedená v této konfiguraci se nainstalují na každý uzel.

imageReference

ImageReference

Odkaz na image Azure Virtual Machines Marketplace nebo vlastní image virtuálního počítače, která se má použít.

licenseType

string

Typ místní licence, která se má použít při nasazování operačního systému.
To platí jenom pro image, které obsahují operační systém Windows, a měly by se používat jenom v případě, že máte platné místní licence pro výpočetní uzly, které se nasadí. Pokud je tato možnost vynechána, neuplatní se žádná sleva za místní licencování. Hodnoty jsou:

Windows_Server – místní licence je určená pro Windows Server. Windows_Client – místní licence je určená pro klienta Windows.

nodeAgentSKUId

string

Skladová položka agenta výpočetního uzlu Služby Batch, která se má zřídit na výpočetních uzlech ve fondu.
Agent výpočetního uzlu služby Batch je program, který běží na každém výpočetním uzlu ve fondu a poskytuje rozhraní pro příkazy a řízení mezi výpočetním uzlem a službou Batch. Existují různé implementace agenta výpočetního uzlu, označovaného jako skladové položky, pro různé operační systémy. Musíte zadat skladovou položku agenta výpočetního uzlu, která odpovídá vybranému odkazu na image. Pokud chcete získat seznam podporovaných skladových položek agenta výpočetního uzlu spolu se seznamem ověřených odkazů na image, přečtěte si operaci Výpis podporovaných skladových položek agenta výpočetního uzlu.

nodePlacementConfiguration

NodePlacementConfiguration

Konfigurace umístění uzlu pro fond.
Tato konfigurace určí pravidla, jak se budou uzly ve fondu fyzicky přidělovat.

osDisk

OSDisk

Nastavení pro disk operačního systému virtuálního počítače.

securityProfile

SecurityProfile

Určuje nastavení profilu zabezpečení pro virtuální počítač nebo škálovací sadu virtuálních počítačů.
Určuje nastavení profilu zabezpečení pro virtuální počítač nebo škálovací sadu virtuálních počítačů.

serviceArtifactReference

ServiceArtifactReference

Určuje REFERENČNÍ ID artefaktu služby, které se používá k nastavení stejné verze image pro všechny virtuální počítače ve škálovací sadě při použití nejnovější verze image.
Referenční ID artefaktu služby ve formě /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

windowsConfiguration

WindowsConfiguration

Nastavení operačního systému Windows na virtuálním počítači.
Tato vlastnost nesmí být zadána, pokud vlastnost imageReference určuje image operačního systému Linux.

VMExtension

Konfigurace pro rozšíření virtuálních počítačů

Name Typ Description
autoUpgradeMinorVersion

boolean

Označuje, jestli by rozšíření mělo používat novější podverzi, pokud je k dispozici v době nasazení. Po nasazení však rozšíření neupgraduje podverze, pokud se znovu nenasadí, a to ani s touto vlastností nastavenou na true.

enableAutomaticUpgrade

boolean

Určuje, jestli má platforma rozšíření automaticky upgradovat, pokud je k dispozici novější verze rozšíření.

name

string

Název rozšíření virtuálního počítače.

protectedSettings

object

Rozšíření může obsahovat buď protectedSettings, nebo protectedSettingsFromKeyVault nebo vůbec žádné chráněné nastavení.

provisionAfterExtensions

string[]

Kolekce názvů rozšíření.
Kolekce názvů rozšíření, po které je potřeba toto rozšíření zřídit.

publisher

string

Název vydavatele obslužné rutiny rozšíření.

settings

object

Veřejná nastavení rozšíření formátovaná ve formátu JSON

type

string

Typ rozšíření.

typeHandlerVersion

string

Verze obslužné rutiny skriptu.

WindowsConfiguration

Nastavení operačního systému Windows, která se mají použít pro virtuální počítač.

Name Typ Description
enableAutomaticUpdates

boolean

Určuje, jestli jsou na virtuálním počítači povolené automatické aktualizace.
Pokud je vynechán, výchozí hodnota je true.

WindowsUserConfiguration

Vlastnosti použité k vytvoření uživatelského účtu na výpočetním uzlu Windows

Name Typ Description
loginMode

LoginMode

Režim přihlášení uživatele
Výchozí hodnota pro fondy VirtualMachineConfiguration je batch a pro CloudServiceConfiguration Pools je interaktivní.