Pool - Get

Service:

Batch Service

API Version:

2023-11-01.18.0

Získá informace o zadaném fondu.

GET {batchUrl}/pools/{poolId}?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/pools/{poolId}?$select={$select}&$expand={$expand}&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 služby Azure Batch.
poolId	path	True	string	ID fondu, který chcete získat.
api-version	query	True	string	Verze klientského rozhraní API.
$expand	query		string	Klauzule $expand OData.
$select	query		string	Klauzule $select OData.
timeout	query		integer int32	Maximální čas, který 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 ozdob, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Jestli má server v odpovědi vrátit client-request-id.
ocp-date		string date-time-rfc1123	Čas, kdy byla žádost vystavena. Klientské knihovny obvykle tuto možnost nastaví na aktuální systémový čas. pokud přímo voláte rozhraní REST API, nastavte ho explicitně.
If-Match		string	Hodnota ETag přidružená k verzi prostředku známého klientovi. Operace se provede pouze v případě, že aktuální značka ETag prostředku ve službě přesně odpovídá hodnotě zadané klientem.
If-None-Match		string	Hodnota ETag přidružená k verzi prostředku známého klientovi. Operace se provede pouze v případě, že aktuální značka ETag prostředku ve službě neodpovídá hodnotě zadané klientem.
If-Modified-Since		string date-time-rfc1123	Časové razítko označující čas poslední změny prostředku známého klientovi. Operace se provede pouze v případě, že se prostředek ve službě od zadaného času změnil.
If-Unmodified-Since		string date-time-rfc1123	Časové razítko označující čas poslední změny prostředku známého klientovi. Operace se provede pouze v případě, že prostředek ve službě nebyl od zadaného času změněn.

Odpovědi

Name	Typ	Description
200 OK	CloudPool	Odpověď obsahující fond. 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 kódu ověřování 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

Add a VirtualMachineConfiguration pool with OS disk

Get a pool with AcceleratedNetworking

Get a VirtualMachineConfiguration pool with extensions

Get a VirtualMachineConfiguration pool with SecurityProfile

Get a VirtualMachineConfiguration pool with ServiceArtifactReference

Pool get

Add a VirtualMachineConfiguration pool with OS disk

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "id": "mypool001",
  "url": "http://localhost:20302/testaccount1tls/pools/mypool001",
  "eTag": "0x8DBA3B4E91CD7B7",
  "lastModified": "2023-08-23T08:42:40.3479479Z",
  "creationTime": "2023-08-23T08:42:40.3479479Z",
  "state": "active",
  "stateTransitionTime": "2023-08-23T08:42:40.3479479Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2023-08-23T08:42:53.8587829Z",
  "vmSize": "standard_d2s_v3",
  "resizeTimeout": "PT15M",
  "currentDedicatedNodes": 1,
  "targetDedicatedNodes": 1,
  "currentLowPriorityNodes": 0,
  "targetLowPriorityNodes": 0,
  "enableAutoScale": false,
  "enableInterNodeCommunication": false,
  "taskSlotsPerNode": 1,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts",
      "version": "latest"
    },
    "osDisk": {
      "ephemeralOSDiskSettings": {
        "placement": "CacheDisk"
      },
      "managedDisk": {
        "storageAccountType": "standardssd_lrs"
      },
      "diskSizeGB": 100,
      "caching": "readwrite"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "currentNodeCommunicationMode": "classic"
}

Get a pool with AcceleratedNetworking

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "id": "pool",
  "url": "https://account.region.batch.azure.com/pools/pool",
  "eTag": "0x8DB4792BE8566A2",
  "lastModified": "2023-04-28T02:46:19.0268066Z",
  "creationTime": "2023-04-28T02:46:19.0268066Z",
  "state": "active",
  "stateTransitionTime": "2023-04-28T02:46:19.0268066Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2023-04-28T02:47:17.9169655Z",
  "vmSize": "standard_d1_v2",
  "resizeTimeout": "PT15M",
  "currentDedicatedNodes": 2,
  "targetDedicatedNodes": 2,
  "currentLowPriorityNodes": 0,
  "targetLowPriorityNodes": 0,
  "enableAutoScale": false,
  "enableInterNodeCommunication": false,
  "taskSlotsPerNode": 1,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2016-datacenter-smalldisk",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "networkConfiguration": {
    "dynamicVNetAssignmentScope": "none",
    "enableAcceleratedNetworking": true
  },
  "currentNodeCommunicationMode": "classic"
}

Get a VirtualMachineConfiguration pool with extensions

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "id": "pool",
  "url": "https://account.region.batch.azure.com/pools/pool",
  "eTag": "0x8D413091E739A56",
  "lastModified": "2016-11-22T18:55:25.2608598Z",
  "creationTime": "2016-11-22T18:55:24.2632496Z",
  "state": "active",
  "stateTransitionTime": "2016-11-22T18:55:24.2632496Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z",
  "vmSize": "standard_a1",
  "resizeTimeout": "PT15M",
  "currentDedicatedNodes": 0,
  "currentLowPriorityNodes": 0,
  "targetDedicatedNodes": 0,
  "targetLowPriorityNodes": 0,
  "enableAutoScale": false,
  "enableInterNodeCommunication": false,
  "startTask": {
    "commandLine": "/bin/bash -c 'echo start task'",
    "userIdentity": {
      "autoUser": {
        "scope": "task",
        "elevationLevel": "nonadmin"
      }
    },
    "maxTaskRetryCount": 0,
    "waitForSuccess": false
  },
  "taskSlotsPerNode": 1,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04",
    "extensions": [
      {
        "name": "batchextension1",
        "type": "KeyVaultForLinux",
        "publisher": "Microsoft.Azure.KeyVault",
        "typeHandlerVersion": "2.0",
        "autoUpgradeMinorVersion": true,
        "enableAutomaticUpgrade": true,
        "settings": "{\"secretsManagementSettingsKey\":\"secretsManagementSettingsValue\",\"authenticationSettingsKey\":\"authenticationSettingsValue\"}"
      }
    ]
  },
  "targetNodeCommunicationMode": "classic",
  "currentNodeCommunicationMode": "classic"
}

Get a VirtualMachineConfiguration pool with SecurityProfile

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "id": "mypool001",
  "url": "https://account.region.batch.azure.com/pools/pool",
  "eTag": "0x8DB6CA2DFF530D1",
  "lastModified": "2023-06-14T06:45:00.0946897Z",
  "creationTime": "2023-06-14T06:45:00.0946897Z",
  "state": "active",
  "stateTransitionTime": "2023-06-14T06:45:00.0946897Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2023-06-14T06:45:59.4770341Z",
  "vmSize": "standard_dc2s_v2",
  "resizeTimeout": "PT15M",
  "currentDedicatedNodes": 1,
  "targetDedicatedNodes": 1,
  "currentLowPriorityNodes": 0,
  "targetLowPriorityNodes": 0,
  "enableAutoScale": false,
  "enableInterNodeCommunication": false,
  "taskSlotsPerNode": 1,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "18_04-lts-gen2",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 18.04",
    "securityProfile": {
      "securityType": "trustedLaunch",
      "encryptionAtHost": true,
      "uefiSettings": {
        "secureBootEnabled": false
      }
    }
  },
  "currentNodeCommunicationMode": "classic"
}

Get a VirtualMachineConfiguration pool with ServiceArtifactReference

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "id": "pool",
  "url": "https://account.region.batch.azure.com/pools/pool",
  "eTag": "0x8DB51F652DFC78F",
  "lastModified": "2023-05-11T08:04:19.7259151Z",
  "creationTime": "2023-05-11T08:04:19.7259151Z",
  "state": "active",
  "stateTransitionTime": "2023-05-11T08:04:19.7259151Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2023-05-11T08:05:22.0020052Z",
  "vmSize": "standard_a1_v2",
  "resizeTimeout": "PT15M",
  "currentDedicatedNodes": 2,
  "targetDedicatedNodes": 2,
  "currentLowPriorityNodes": 0,
  "targetLowPriorityNodes": 0,
  "enableAutoScale": false,
  "enableInterNodeCommunication": false,
  "taskSlotsPerNode": 1,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2016-datacenter-smalldisk",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.windows amd64",
    "windowsConfiguration": {
      "enableAutomaticUpdates": false
    },
    "serviceArtifactReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile"
    }
  },
  "currentNodeCommunicationMode": "classic"
}

Pool get

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "id": "pool",
  "url": "https://account.region.batch.azure.com/pools/pool",
  "eTag": "0x8D413091E739A56",
  "lastModified": "2016-11-22T18:55:25.2608598Z",
  "creationTime": "2016-11-22T18:55:24.2632496Z",
  "state": "active",
  "stateTransitionTime": "2016-11-22T18:55:24.2632496Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z",
  "vmSize": "standard_a1",
  "resizeTimeout": "PT15M",
  "currentDedicatedNodes": 0,
  "currentLowPriorityNodes": 0,
  "targetDedicatedNodes": 0,
  "targetLowPriorityNodes": 0,
  "enableAutoScale": false,
  "enableInterNodeCommunication": false,
  "startTask": {
    "commandLine": "/bin/bash -c 'echo start task'",
    "userIdentity": {
      "autoUser": {
        "scope": "task",
        "elevationLevel": "nonadmin"
      }
    },
    "maxTaskRetryCount": 0,
    "waitForSuccess": false
  },
  "taskSlotsPerNode": 1,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  }
}

Definice

Name	Description
AllocationState	Určuje, jestli fond provádí změnu velikosti.
ApplicationPackageReference	Odkaz na balíček, který se má nasadit do výpočetních uzlů.
AutoScaleRun	Výsledky a chyby při spuštění vzorce automatického škálování fondu
AutoScaleRunError	Chyba, ke které došlo při spouštění nebo vyhodnocování vzorce automatického škálování fondu.
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 používané pro připojení ke kontejneru služby Azure Storage pomocí blobfuse
AzureFileShareConfiguration	Informace používané 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.
BatchPoolIdentity	Identita fondu Batch, pokud je nakonfigurovaná.
CachingType	Typ ukládání do mezipaměti, který se má pro disk povolit.
CertificateReference	Odkaz na certifikát, který se má nainstalovat na výpočetní uzly 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é pro připojení k systému souborů CIFS
CloudPool	Fond ve službě Azure Batch.
CloudServiceConfiguration	Konfigurace výpočetních uzlů ve fondu na základě platformy Azure Cloud Services.
ComputeNodeFillType	Způsob distribuce úkolů 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 používat výpočetní uzel.
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 operačního systému 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á má být nastavena pro proces úlohy.
ErrorMessage	Chybová zpráva přijatá v Azure Batch chybovou odpověď.
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í pro veřejné IP adresy fondu.
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í 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 má použít pro 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é pro 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.
OSDisk	Nastavení pro disk operačního systému výpočetního uzlu
PoolEndpointConfiguration	Konfigurace koncového bodu pro fond
PoolIdentityType	Identita fondu Batch, pokud je nakonfigurovaná.
PoolState	Aktuální stav fondu.
PoolStatistics	Obsahuje statistiky využití a využití prostředků po dobu životnosti fondu.
PublicIPAddressConfiguration	Konfigurace veřejné IP adresy síťové konfigurace fondu.
ResizeError	Chyba, ke které došlo při změně velikosti fondu.
ResourceFile	Jeden soubor nebo více souborů ke stažení do výpočetního uzlu.
ResourceStatistics	Statistiky související se spotřebou prostředků výpočetními uzly ve fondu
SecurityProfile	Určuje nastavení profilu zabezpečení pro virtuální počítač nebo škálovací sadu virtuálních počítačů.
SecurityTypes	Určuje typ zabezpečení virtuálního počítače. Aby bylo možné UefiSettings povolit, musí být nastavená 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í, když se uzel připojí k fondu ve službě Azure Batch nebo když se výpočetní uzel restartuje nebo znovu z image.
StorageAccountType	Typ účtu úložiště pro použití při vytváření datových disků nebo disku s operačním systémem.
TaskContainerSettings	Nastavení kontejneru pro úlohu.
TaskSchedulingPolicy	Určuje, jak se mají úkoly distribuovat napříč výpočetními uzly.
UefiSettings	Určuje nastavení zabezpečení, jako je zabezpečené spouštění a virtuálnítpm použité při vytváření virtuálního počítače.
UsageStatistics	Statistiky související s informacemi o využití fondu
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.
UserAssignedIdentity	Identita přiřazená uživatelem
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.

AllocationState

Určuje, jestli fond provádí změnu velikosti.

Name	Typ	Description
resizing	string	Fond je změna velikosti; to znamená, že výpočetní uzly se přidávají do fondu nebo se z fondu odebírají.
steady	string	Velikost fondu se neskončuje. Počet výpočetních uzlů v probíhajícím fondu se nijak nemění. Fond přejde do tohoto stavu při jeho vytvoření a když se ve fondu neprovádí žádné operace, které by změnily počet výpočetních uzlů.
stopping	string	Došlo ke změně velikosti fondu, ale uživatel požádal o zastavení změny velikosti, ale žádost o zastavení ještě nebyla dokončena.

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 tento parametr vynecháte, nasadí se výchozí verze. Pokud je 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í.

AutoScaleRun

Výsledky a chyby při spuštění vzorce automatického škálování fondu

Name	Typ	Description
error	AutoScaleRunError	Podrobnosti o chybě, ke které došlo při vyhodnocování vzorce automatického škálování ve fondu, pokud vyhodnocení nebylo úspěšné.
results	string	Konečné hodnoty všech proměnných použitých při vyhodnocení vzorce automatického škálování Každá hodnota proměnné se vrátí ve formátu $variable=value a proměnné jsou oddělené středníky.
timestamp	string	Čas posledního vyhodnocení vzorce automatického škálování

AutoScaleRunError

Chyba, ke které došlo při spouštění nebo vyhodnocování vzorce automatického škálování fondu.

Name	Typ	Description
code	string	Identifikátor chyby automatického škálování. Kódy jsou invariantní a mají být využívány programově.
message	string	Zpráva popisující chybu automatického škálování, která má být vhodná pro zobrazení v uživatelském rozhraní.
values	NameValuePair[]	Seznam dalších podrobností o chybách souvisejících s chybou automatického škálování

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é normálním úkolům, ale měly by být přístupné pomocí startTasks.

AzureBlobFileSystemConfiguration

Informace používané pro připojení ke kontejneru služby Azure Storage pomocí blobfuse

Name	Typ	Description
accountKey	string	Klíč účtu úložiště Azure. Tato vlastnost se vzájemně vylučuje s sasKey a identity; přesně jeden musí být zadán.
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. Jedná se o 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 použije pro přístup k názvu kontejneru containerName Tato vlastnost se vzájemně vylučuje s accountKey a sasKey; přesně jeden musí být zadán.
relativeMountPath	string	Relativní cesta na výpočetním uzlu, ke které se připojí systém souborů Všechny systémy souborů jsou připojené vzhledem k adresáři připojení služby Batch 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; přesně jeden musí být zadán.

AzureFileShareConfiguration

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

Name	Typ	Description
accountKey	string	Klíč účtu Azure Storage.
accountName	string	Název účtu služby Azure Storage.
azureFileUrl	string	Adresa URL Azure Files. Toto je ve formátu https://{account}.file.core.windows.net/.
mountOptions	string	Další možnosti příkazového řádku, které se mají předat příkazu mount. Jedná se o možnosti net use ve Windows a možnosti připojení v Linuxu.
relativeMountPath	string	Relativní cesta na výpočetním uzlu, ke které se připojí systém souborů Všechny systémy souborů jsou připojené vzhledem k adresáři připojení služby Batch 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.

BatchPoolIdentity

Identita fondu Batch, pokud je nakonfigurovaná.

Name	Typ	Description
type	PoolIdentityType	Identita fondu Batch, pokud je nakonfigurovaná. Seznam identit uživatelů přidružených k fondu služby Batch. Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.
userAssignedIdentities	UserAssignedIdentity[]	Seznam identit uživatelů přidružených k účtu Batch. Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

CachingType

Typ ukládání do mezipaměti, který se má 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 na výpočetní uzly 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é pomocí výpočetních uzlů Windows (to znamená vytvořených pomocí cloudServiceConfiguration nebo virtualMachineConfiguration pomocí odkazu na image Windows). V případě linuxových výpočetních uzlů jsou certifikáty uložené v adresáři v pracovním adresáři úlohy a proměnná prostředí AZ_BATCH_CERTIFICATES_DIR je předána úkolu, který se má dotazovat na toto umístění. V případě certifikátů s viditelností remoteUser se adresář certs vytvoří v domovském adresáři uživatele (např. /home/{uživatelské_jméno}/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é pomocí výpočetních uzlů Windows (to znamená vytvořených 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 je možné použít také jakýkoli vlastní název obchodu. Výchozí hodnota je My.
thumbprint	string	Kryptografický otisk certifikátu.
thumbprintAlgorithm	string	Algoritmus, se kterým 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 měly být nainstalovány 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 startTask spouští. Všimněte si, že pokud je obor automatického uživatele fond pro startTask i úlohu, bude tento certifikát viditelný i pro úlohu.
task	string	Certifikát by měl být viditelný pro uživatelské účty, pod kterými se spouští úlohy úloh.

CIFSMountConfiguration

Informace používané pro 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. Jedná se o možnosti net use ve Windows a možnosti připojení v Linuxu.
password	string	Heslo, které se má použít k ověřování v systému souborů CIFS.
relativeMountPath	string	Relativní cesta na výpočetním uzlu, ke které se připojí systém souborů Všechny systémy souborů jsou připojené vzhledem k adresáři připojení služby Batch 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ý chcete připojit.
username	string	Uživatel, který se má použít k ověřování v systému souborů CIFS.

CloudPool

Fond ve službě Azure Batch.

Name	Typ	Description
allocationState	AllocationState	Určuje, jestli fond provádí změnu velikosti.
allocationStateTransitionTime	string	Čas, kdy fond vstoupil do aktuálního stavu přidělení.
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í podporována, vytvoření fondu se nezdaří.
applicationPackageReferences	ApplicationPackageReference[]	Seznam balíčků, které se mají nainstalovat na každý výpočetní uzel ve fondu. Změny odkazů na balíčky ovlivní 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 nereimagí. 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í. Tato vlastnost je nastavena pouze v případě, že se fond automaticky škáluje, tj. enableAutoScale má hodnotu true.
autoScaleFormula	string	Vzorec pro požadovaný počet výpočetních uzlů ve fondu. Tato vlastnost je nastavena pouze v případě, že se fond automaticky škáluje, tj. enableAutoScale má hodnotu true.
autoScaleRun	AutoScaleRun	Výsledky a chyby z posledního spuštění vzorce automatického škálování Tato vlastnost je nastavena pouze v případě, že se fond automaticky škáluje, tj. enableAutoScale má hodnotu true.
certificateReferences	CertificateReference[]	Seznam certifikátů, které se mají nainstalovat na každý výpočetní uzel ve fondu. V případě uzlů Windows služba Batch nainstaluje certifikáty do zadaného úložiště a umístění certifikátů. V případě linuxových výpočetních uzlů jsou certifikáty uložené v adresáři v pracovním adresáři úlohy a proměnná prostředí AZ_BATCH_CERTIFICATES_DIR je předána úkolu, který se má dotazovat na toto umístění. V případě certifikátů s viditelností remoteUser se adresář certs vytvoří v domovském adresáři uživatele (např. /home/{uživatelské_jméno}/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 a virtualMachineConfiguration se vzájemně vylučují a jedna z vlastností musí být zadána. Tuto vlastnost nelze zadat, pokud byl účet Batch vytvořen s vlastností poolAllocationMode nastavenou na hodnotu UserSubscription.
creationTime	string	Čas vytvoření fondu.
currentDedicatedNodes	integer	Počet vyhrazených výpočetních uzlů, které jsou aktuálně ve fondu.
currentLowPriorityNodes	integer	Počet spotových výpočetních uzlů nebo výpočetních uzlů s nízkou prioritou, které jsou aktuálně ve fondu. Do tohoto počtu se započítávají spotové výpočetní uzly nebo výpočetní uzly s nízkou prioritou, které byly zrušeny.
currentNodeCommunicationMode	NodeCommunicationMode	Aktuální stav režimu komunikace fondu.
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.
eTag	string	Značka ETag fondu. Jedná se o neprůzrůzný řetězec. Můžete ho použít ke zjištění, jestli se fond mezi požadavky změnil. Konkrétně můžete při aktualizaci fondu předat eTag a určit, že změny se mají projevit pouze v případě, že mezitím fond nikdo jiný neupravoval.
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 hodnota true, vlastnost autoScaleFormula je povinná a 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. Tím se stanoví omezení, které výpočetní uzly je možné přiřadit k fondu. Zadání této hodnoty může snížit riziko přidělení požadovaného počtu výpočetních uzlů ve fondu.
id	string	Řetězec, který jednoznačně identifikuje fond v rámci účtu. ID může obsahovat libovolnou kombinaci alfanumerických znaků včetně spojovníků a podtržítků a nesmí obsahovat více než 64 znaků. 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).
identity	BatchPoolIdentity	Identita fondu Batch, pokud je nakonfigurovaná. Seznam identit uživatelů přidružených k fondu služby Batch. Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.
lastModified	string	Čas poslední změny fondu. Jedná se o poslední čas, kdy se změnila data na úrovni fondu, například nastavení targetDedicatedNodes nebo enableAutoscale. Nebere v potaz změny na úrovni uzlu, jako je změna stavu výpočetního uzlu.
metadata	MetadataItem[]	Seznam dvojic název-hodnota přidružených k fondu jako metadata.
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.
resizeErrors	ResizeError[]	Seznam chyb, ke kterým došlo při poslední změně velikosti fondu. Tato vlastnost je nastavena pouze v případě, že došlo k jedné nebo více chybám během poslední změny velikosti fondu, a pouze v případě, že je stav přidělení fondu stabilní.
resizeTimeout	string	Časový limit pro přidělení výpočetních uzlů do fondu. Toto je časový limit poslední operace změny velikosti. (Počáteční změna velikosti při vytvoření fondu se počítá jako změna velikosti.) Výchozí hodnota je 15 minut.
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 je možné zadat pouze v případě, že byl účet Batch vytvořen s vlastností poolAllocationMode nastavenou na hodnotu UserSubscription.
startTask	StartTask	Úkol určený ke spuštění na každém výpočetním uzlu při připojení k fondu. 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ů. V některých případech se startTask může znovu spustit, i když se výpočetní uzel nerestartoval. Zvláštní pozornost je třeba věnovat tomu, abyste se vyhnuli úlohám StartTasks, které vytvářejí přerušovaný proces nebo instalují nebo spouštějí služby z pracovního adresáře StartTask, protože to službě Batch zablokuje možnost znovu spustit startTask.
state	PoolState	Aktuální stav fondu.
stateTransitionTime	string	Čas, kdy fond vstoupil do aktuálního stavu.
stats	PoolStatistics	Statistika využití a využití prostředků za celou dobu životnosti fondu. Tato vlastnost je naplněna pouze v případě, že CloudPool byl načten s expand klauzule, včetně 'stats' atributu; 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.
targetDedicatedNodes	integer	Požadovaný počet vyhrazených výpočetních uzlů ve fondu
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
targetNodeCommunicationMode	NodeCommunicationMode	Požadovaný režim komunikace uzlu pro fond. Pokud ho vynecháte, 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.
url	string	Adresa URL fondu.
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. Tato vlastnost a cloudServiceConfiguration se vzájemně vylučují a musí být zadána jedna z vlastností.
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).

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ího systému 2, což odpovídá Systému Windows Server 2008 R2 SP1. 3 – Řada operačního systému 3, ekvivalent Windows Server 2012. 4 – Řada operačního systému 4, ekvivalent Windows Server 2012 R2. 5 – Řada operačního systému 5, ekvivalent Windows Server 2016. 6 – Operační systém řady 6, ekvivalent k 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

Způsob distribuce úkolů mezi výpočetní uzly ve fondu

Name	Typ	Description
pack	string	Před přiřazením úkolů k dalšímu výpočetnímu uzlu ve fondu by se mělo každému výpočetnímu uzlu ve fondu přiřadit co nejvíce úkolů (taskSlotsPerNode).
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 používat výpočetní uzel.

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 CRI.
dockerCompatible	string	Ke spuštění kontejnerů se použije technologie kontejnerů kompatibilní s Dockerem.

ContainerWorkingDirectory

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

Name	Typ	Description
containerImageDefault	string	Použijte pracovní adresář definovaný v kontejneru Image. Mějte na pozoru, že tento adresář nebude obsahovat soubory prostředků stažené službou Batch.
taskWorkingDirectory	string	Použijte standardní pracovní adresář úloh služby Batch, který bude obsahovat soubory zdrojů úkolů vyplně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 operačního systému 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í disku 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 dočasného disku s 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 k šifrování dojde 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á má být nastavena pro proces úlohy.

Name	Typ	Description
name	string	Název proměnné prostředí.
value	string	Hodnota proměnné prostředí.

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

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	Pro koncový bod použijte protokol TCP.
udp	string	Pro 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 služby Batch, je 25. Pokud nejsou zadána žá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 skupin 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í pro veřejné IP adresy fondu.

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 budou použity ke zřízení výpočetních uzlů.

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 uživatelského účtu. Vlastnosti uid a gid musí být zadány společně, nebo vůbec. Pokud není zadán základní operační systém vybere gid.
sshPrivateKey	string	Privátní klíč SSH uživatelského účtu. 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 má vlastnost enableInterNodeCommunication fondu hodnotu true (pokud má vlastnost enableInterNodeCommunication hodnotu false), je ignorována). Provede to tak, že pár klíčů umístí do adresáře .ssh uživatele. Pokud není zadaný, mezi výpočetními uzly se nenakonfiguruje SSH bez hesla (nedojde k žádné úpravě 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í zadaný, základní operační systém vybere identifikátor UID.

LoginMode

Režim přihlášení 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. Řízení uživatelských účtů je povolené ve fondech konfigurace Windows VirtualMachine. Pokud se tato možnost používá se zvýšenou identitou uživatele ve fondu Windows VirtualMachineConfiguration, relace uživatele nebude zvýšena, pokud není aplikace spuštěná příkazovým řádkem úlohy nakonfigurovaná 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 připojí 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 připojí 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 připojí 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í virtuálnímu počítači virtualizaci SR-IOV (Single Root I/O Virtualization), což může vést ke zvýšení výkonu sítě. Další podrobnosti najdete tady: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.
endpointConfiguration	PoolEndpointConfiguration	Konfigurace koncových bodů na výpočetních uzlech ve fondu 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 je podporována pouze ve fondech 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. Má formát /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 se pojal 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 Role-Based Access Control Přispěvatel klasických virtuálních počítačů (RBAC). Zadaná podsíť musí umožňovat komunikaci ze služby Azure Batch, aby mohla plánovat úlohy na uzlech. Můžete to ověřit tak, že zkontrolujete, jestli má zadaná virtuální síť přidružené nějaké 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í pouze 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, 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 má použít pro 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žší číslo, tím vyšší je priorita. Například pravidla mohou být zadána 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 nějaké rezervované nebo duplicitní hodnoty, požadavek selže se stavovým kódem HTTP 400.
sourceAddressPrefix	string	Předpona nebo značka zdrojové adresy, která se má s pravidlem shodovat. Platné hodnoty jsou jedna IP adresa (tj. 10.10.10.10.10), podsíť IP (tj. 192.168.1.0/24), výchozí značka nebo * (pro všechny adresy). Pokud jsou zadány 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 0 až 65535. Každá položka v této kolekci nesmí překrývat žádnou jinou položku (buď oblast, nebo jednotlivý port). Pokud jsou zadány 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é pro 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. Jedná se o možnosti net use ve Windows a možnosti připojení v Linuxu.
relativeMountPath	string	Relativní cesta na výpočetním uzlu, ke které se připojí systém souborů Všechny systémy souborů jsou připojené vzhledem k adresáři připojení služby Batch 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ý chcete 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 ze služby BatchNodeManagement. Značka služby {region} a odchozí komunikace TCP na portu 443 s úložištěm 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 služby BatchNodeManagement. Značka služby {region} Nevyžadují se žá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 rozdělené do různých zón dostupnosti s vyrovnáváním maximálního úsilí.

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.

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.

PoolIdentityType

Identita fondu Batch, pokud je nakonfigurovaná.

Name	Typ	Description
None	string	K fondu služby Batch není přidružená žádná identita. Nastavení None ve fondu aktualizací odebere existující identity.
UserAssigned	string	Fond služby Batch má přiřazené identity uživatelem.

PoolState

Aktuální stav fondu.

Name	Typ	Description
active	string	Fond je k dispozici pro spouštění úkolů v závislosti na dostupnosti výpočetních uzlů.
deleting	string	Uživatel požádal o odstranění fondu, ale operace odstranění ještě nebyla dokončena.

PoolStatistics

Obsahuje statistiky využití a využití prostředků po dobu životnosti fondu.

Name	Typ	Description
lastUpdateTime	string	Čas, kdy byly statistiky naposledy aktualizovány. Všechny statistiky jsou omezené na rozsah mezi startTime a lastUpdateTime.
resourceStats	ResourceStatistics	Statistiky související se spotřebou prostředků výpočetními uzly ve fondu
startTime	string	Počáteční čas časového rozsahu, na který se statistika vztahuje.
url	string	Adresa URL statistiky.
usageStats	UsageStatistics	Statistiky související s využitím fondu, například využitý čas jádra

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ů. Zde zadaný počet 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ů s přímou nebo nízkou prioritou. Například fond, který potřebuje 250 vyhrazených virtuálních počítačů, by potřeboval zadat alespoň 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.

ResizeError

Chyba, ke které došlo při změně velikosti fondu.

Name	Typ	Description
code	string	Identifikátor chyby Změny velikosti fondu. Kódy jsou neutrální a mají být využívány programově.
message	string	Zpráva popisující chybu změny velikosti fondu, která má být vhodná pro zobrazení v uživatelském rozhraní.
values	NameValuePair[]	Seznam dalších podrobností o chybách souvisejících s chybou změny velikosti fondu.

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 jeden z nich musí být zadán.
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 v případě, že se používá autoStorageContainerName nebo storageContainerUrl. Touto předponou může být částečný název souboru nebo podadresář. Pokud předpona není zadaná, 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 prostředekFile, který se stáhne do výpočetního uzlu Windows, bude ignorován. Pokud tato vlastnost není určena pro výpočetní uzel s Linuxem, 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í soubory stáhnout, vzhledem k pracovnímu adresáři úkolu. Pokud je zadána vlastnost httpUrl, parametr filePath je povinný a popisuje cestu, do které se soubor stáhne, včetně názvu souboru. Jinak pokud je zadána vlastnost autoStorageContainerName nebo storageContainerUrl, je parametr filePath volitelný a jedná se o adresář ke stažení souborů. V případě, že se filePath použije jako adresář, jakákoli adresářová struktura, která je již přidružena ke vstupním datům, se zachovají v plném rozsahu a připojí se k zadanému adresáři filePath. Zadaná relativní cesta nemůže přerušit pracovní adresář úkolu (například pomocí ..).
httpUrl	string	Adresa URL souboru, který se má stáhnout. Vlastnosti autoStorageContainerName, storageContainerUrl a httpUrl se vzájemně vylučují a jeden z nich musí být zadán. 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 objektu blob v úložišti Azure: zahrnují 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 pro přístup k Azure Blob Storage určený storageContainerUrl nebo httpUrl Odkaz na identitu přiřazenou uživatelem přidruženou k fondu služby Batch, který bude výpočetní uzel používat.
storageContainerUrl	string	Adresa URL kontejneru objektů blob v rámci Azure Blob Storage. Vlastnosti autoStorageContainerName, storageContainerUrl a httpUrl se vzájemně vylučují a jeden z nich musí být zadán. 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 v úložišti Azure získat: zahrnují sdílený přístupový podpis (SAS) udělující oprávnění ke čtení a výpisu kontejneru, použití spravované identity s oprávněními ke čtení a výpisu nebo nastavení seznamu ACL pro kontejner tak, aby umožňoval veřejný přístup.

ResourceStatistics

Statistiky související se spotřebou prostředků výpočetními uzly ve fondu

Name	Typ	Description
avgCPUPercentage	number	Průměrné využití procesoru napříč všemi výpočetními uzly ve fondu (procento na uzel)
avgDiskGiB	number	Průměrné využité místo na disku v GiB napříč všemi výpočetními uzly ve fondu.
avgMemoryGiB	number	Průměrné využití paměti v GiB napříč všemi výpočetními uzly ve fondu.
diskReadGiB	number	Celkový objem dat v GiB disku čte ve všech výpočetních uzlech ve fondu.
diskReadIOps	integer	Celkový počet operací čtení z disku ve všech výpočetních uzlech ve fondu.
diskWriteGiB	number	Celkový objem dat v GiB zápisů na disk napříč všemi výpočetními uzly ve fondu.
diskWriteIOps	integer	Celkový počet operací zápisu na disk ve všech výpočetních uzlech ve fondu.
lastUpdateTime	string	Čas, kdy byly statistiky naposledy aktualizovány. Všechny statistiky jsou omezené na rozsah mezi startTime a lastUpdateTime.
networkReadGiB	number	Celkový objem dat v GiB sítě čte napříč všemi výpočetními uzly ve fondu.
networkWriteGiB	number	Celkové množství dat v GiB síťových zápisů napříč všemi výpočetními uzly ve fondu.
peakDiskGiB	number	Maximální využité místo na disku v GiB napříč všemi výpočetními uzly ve fondu.
peakMemoryGiB	number	Maximální využití paměti v GiB napříč všemi výpočetními uzly ve fondu.
startTime	string	Počáteční čas časového rozsahu, na který se statistika vztahuje.

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 typ zabezpečení virtuálního počítače. Aby bylo možné UefiSettings povolit, musí být nastavená 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í, když se uzel připojí k fondu ve službě Azure Batch nebo když se výpočetní uzel restartuje nebo znovu z image.

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 úkolů) nebo proměnnou prostředí poskytnutou službou Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
containerSettings	TaskContainerSettings	Nastavení pro kontejner, pod kterým se spouští StartTask. Při zadání se všechny adresáře rekurzivně pod AZ_BATCH_NODE_ROOT_DIR (kořen Azure Batch adresářů na uzlu) namapují do kontejneru, všechny proměnné prostředí task se mapují do kontejneru a příkazový řádek Task 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 pro soubory 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 pokusů o opakování úkolu Služba Batch opakuje úlohu, pokud je její ukončovací kód nenulový. Všimněte si, že tato hodnota konkrétně řídí počet opakovaných pokusů. Služba Batch tuto úlohu jednou vyzkouší a pak to může opakovat až do tohoto limitu. Pokud je například maximální počet opakování 3, služba Batch zkouší ú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 úlohu opakovat nebude. 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. Pro seznam souborů prostředků platí 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 tento parametr vynecháte, spustí se úloha jako uživatel bez oprávnění správce, který je pro úlohu jedinečný.
waitForSuccess	boolean	Zda 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 úkol ani po všech opakováních úspěšně nedokončil, služba Batch označí uzel jako nepoužitelný a neplánuje na něj ú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 false, služba Batch nebude čekat na dokončení StartTask. V takovém případě se na výpočetním uzlu můžou spustit další úkoly, 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 standardní místně redundantní úložiště SSD.

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, jak by bylo určeno pro "docker pull". Pokud se jako součást názvu image nezadá žádná značka, použije se jako výchozí značka :latest.
registry	ContainerRegistry	Privátní registr, který obsahuje image kontejneru. Toto nastavení můžete vynechat, pokud už bylo zadané 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 napříč výpočetními uzly.

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

UefiSettings

Určuje nastavení zabezpečení, jako je zabezpečené spouštění a virtuálnítpm 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.

UsageStatistics

Statistiky související s informacemi o využití fondu

Name	Typ	Description
dedicatedCoreTime	string	Agregovaný hodinový čas vyhrazených jader výpočetních uzlů, která jsou součástí fondu.
lastUpdateTime	string	Čas, kdy byly statistiky naposledy aktualizovány. Všechny statistiky jsou omezené na rozsah mezi startTime a lastUpdateTime.
startTime	string	Počáteční čas časového rozsahu, na který se statistika vztahuje.

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 je ignorována, 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 pro uživatelský účet.
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í zadaný a ve fondu Windows, uživatel se vytvoří s výchozími možnostmi.

UserAssignedIdentity

Identita přiřazená uživatelem

Name	Typ	Description
clientId	string	ID klienta identity přiřazené uživatelem.
principalId	string	ID objektu zabezpečení identity přiřazené uživatelem.
resourceId	string	ID prostředku ARM identity přiřazené uživatelem

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 jednu, ale ne obě.
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 jednu, ale ne obě.

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 zadaný, nastavení se provede na každém výpočetním uzlu ve fondu, aby se úlohy mohly spouštět v kontejnerech. Všechny běžné úkoly a úlohy správce úloh spuštěné v tomto fondu musí určovat vlastnost containerSettings a všechny ostatní úkoly ji mohou určovat.
dataDisks	DataDisk[]	Konfigurace pro datové disky připojené k výpočetním uzlům ve fondu. Tato vlastnost musí být zadána, pokud výpočetní uzly ve fondu musí 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 odstraní také disk a všechna data k němu přidružená. Disk není po připojení naformátován, musí být před použitím naformátován – další informace najdete v článcích 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ělo by se používat jenom v případě, že máte platné místní licence pro výpočetní uzly, které se nasadí. Pokud tento parametr vynecháte, 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í příkazů a řízení mezi výpočetním uzlem a službou Batch. Existují různé implementace agenta výpočetního uzlu, označované jako SKU, 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, projdě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 bude určovat pravidla týkající se způsobu fyzického přidělování uzlů ve fondu.
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 tvaru /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í pro uživatele Výchozí hodnota pro fondy VirtualMachineConfiguration je batch a pro CloudServiceConfiguration Pools je interaktivní.