Pool - Add

Referens

Service:: Batch Service

API Version:: 2022-01-01.15.0

Lägger till en pool i det angivna kontot.
När du namnger pooler bör du undvika att inkludera känslig information, till exempel användarnamn eller hemliga projektnamn. Den här informationen kan visas i telemetriloggar som är tillgängliga för Microsoft Support tekniker.

POST {batchUrl}/pools?api-version=2022-01-01.15.0

With optional parameters:

POST {batchUrl}/pools?timeout={timeout}&api-version=2022-01-01.15.0

URI-parametrar

Name	In	Required	Type	Description
batchUrl	path	True	string	Bas-URL:en för alla Azure Batch tjänstbegäranden.
api-version	query	True	string	Klient-API-version.
timeout	query		integer int32	Den maximala tid som servern kan ägna åt att bearbeta begäran, i sekunder. Standardvärdet är 30 sekunder.

Begärandehuvud

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

Name	Type	Description
client-request-id	string uuid	Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Om servern ska returnera client-request-id i svaret.
ocp-date	string date-time-rfc1123	Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till systemets aktuella klocktid. ange det uttryckligen om du anropar REST-API:et direkt.

Begärandetext

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

Name	Required	Type	Description
id	True	string	En sträng som unikt identifierar poolen i kontot. ID:t kan innehålla valfri kombination av alfanumeriska tecken, inklusive bindestreck och understreck, och får inte innehålla fler än 64 tecken. ID:t är skiftlägesbevarande och skiftlägesokänsligt (dvs. du kanske inte har två pool-ID:n inom ett konto som endast skiljer sig från fall till fall).
vmSize	True	string	Storleken på virtuella datorer i poolen. Alla virtuella datorer i en pool har samma storlek. Information om tillgängliga storlekar på virtuella datorer för Cloud Services pooler (pooler som skapats med cloudServiceConfiguration) finns i Storlekar för Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch stöder alla Cloud Services VM-storlekar utom ExtraSmall, A1V2 och A2V2. Information om tillgängliga VM-storlekar för pooler som använder avbildningar från Virtual Machines Marketplace (pooler som skapats med virtualMachineConfiguration) finns i Storlekar för Virtual Machines (Linux) () ellerhttps://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/ Storlekar för Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch stöder alla storlekar på virtuella Azure-datorer utom STANDARD_A0 och de med Premium Storage (STANDARD_GS, STANDARD_DS och STANDARD_DSV2-serien).
applicationLicenses		string[]	Listan över programlicenser som Batch-tjänsten gör tillgängliga på varje beräkningsnod i poolen. Listan över programlicenser måste vara en delmängd av tillgängliga Batch-tjänstprogramlicenser. Om en licens begärs som inte stöds misslyckas skapandet av poolen.
applicationPackageReferences		ApplicationPackageReference[]	Listan över paket som ska installeras på varje beräkningsnod i poolen. Ändringar av paketreferenser påverkar alla nya noder som ansluter till poolen, men påverkar inte beräkningsnoder som redan finns i poolen förrän de startas om eller avfinns på nytt. Det finns högst 10 paketreferenser i en viss pool.
autoScaleEvaluationInterval		string	Det tidsintervall då poolstorleken ska justeras automatiskt enligt autoskalningsformeln. Standardvärdet är 15 minuter. Det minsta och högsta värdet är 5 minuter respektive 168 timmar. Om du anger ett värde som är mindre än 5 minuter eller större än 168 timmar returnerar Batch-tjänsten ett fel. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran).
autoScaleFormula		string	En formel för önskat antal beräkningsnoder i poolen. Den här egenskapen får inte anges om enableAutoScale är inställt på false. Det krävs om enableAutoScale är inställt på true. Formeln kontrolleras för giltighet innan poolen skapas. Om formeln inte är giltig avvisar Batch-tjänsten begäran med detaljerad felinformation. Mer information om hur du anger den här formeln finns i Skala beräkningsnoder automatiskt i en Azure Batch pool (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).
certificateReferences		CertificateReference[]	Listan över certifikat som ska installeras på varje beräkningsnod i poolen. För Windows-noder installerar Batch-tjänsten certifikaten till det angivna certifikatarkivet och platsen. För Linux-beräkningsnoder lagras certifikaten i en katalog i arbetskatalogen Aktivitet och en miljövariabel AZ_BATCH_CERTIFICATES_DIR anges till uppgiften för att fråga efter den här platsen. För certifikat med synligheten "remoteUser" skapas en "certs"-katalog i användarens hemkatalog (t.ex. /home/{user-name}/certs) och certifikat placeras i den katalogen.
cloudServiceConfiguration		CloudServiceConfiguration	Molntjänstkonfigurationen för poolen. Den här egenskapen och virtualMachineConfiguration är ömsesidigt uteslutande och en av egenskaperna måste anges. Det går inte att ange den här egenskapen om Batch-kontot har skapats med egenskapen poolAllocationMode inställd på UserSubscription.
displayName		string	Visningsnamnet för poolen. Visningsnamnet behöver inte vara unikt och kan innehålla unicode-tecken upp till en maximal längd på 1 024.
enableAutoScale		boolean	Om poolstorleken ska justeras automatiskt över tid. Om värdet är falskt måste minst en av targetDedicatedNodes och targetLowPriorityNodes anges. Om det är sant krävs egenskapen autoScaleFormula och poolen ändras automatiskt enligt formeln. Standardvärdet är false.
enableInterNodeCommunication		boolean	Om poolen tillåter direkt kommunikation mellan beräkningsnoder. Om kommunikation mellan noder aktiveras begränsas poolens maximala storlek på grund av distributionsbegränsningar för poolens beräkningsnoder. Detta kan leda till att poolen inte når önskad storlek. Standardvärdet är false.
metadata		MetadataItem[]	En lista över namn/värde-par som är associerade med poolen som metadata. Batch-tjänsten tilldelar ingen mening till metadata. endast för användning av användarkod.
mountConfiguration		MountConfiguration[]	Montera lagring med angivet filsystem under hela poolens livslängd. Montera lagringen med hjälp av Azure-filresurs-, NFS-, CIFS- eller Blobfuse-baserat filsystem.
networkConfiguration		NetworkConfiguration	Nätverkskonfigurationen för poolen. Nätverkskonfigurationen för en pool.
resizeTimeout		string	Tidsgränsen för allokering av beräkningsnoder till poolen. Den här tidsgränsen gäller endast för manuell skalning. det har ingen effekt när enableAutoScale är inställt på sant. Standardvärdet är 15 minuter. Det minsta värdet är 5 minuter. Om du anger ett värde som är mindre än 5 minuter returnerar Batch-tjänsten ett fel. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran).
startTask		StartTask	En uppgift som har angetts för att köras på varje beräkningsnod när den ansluter till poolen. Aktiviteten körs när beräkningsnoden läggs till i poolen eller när beräkningsnoden startas om.
targetDedicatedNodes		integer	Önskat antal dedikerade beräkningsnoder i poolen. Den här egenskapen får inte anges om enableAutoScale har angetts till true. Om enableAutoScale är inställt på false måste du ange antingen targetDedicatedNodes, targetLowPriorityNodes eller båda.
targetLowPriorityNodes		integer	Önskat antal beräkningsnoder med oanvänd kapacitet/låg prioritet i poolen. Den här egenskapen får inte anges om enableAutoScale har angetts till true. Om enableAutoScale är inställt på false måste du ange antingen targetDedicatedNodes, targetLowPriorityNodes eller båda.
taskSchedulingPolicy		TaskSchedulingPolicy	Hur uppgifter distribueras mellan beräkningsnoder i en pool. Om inget anges är standardvärdet utspritt.
taskSlotsPerNode		integer	Antalet aktivitetsplatser som kan användas för att köra samtidiga aktiviteter på en enda beräkningsnod i poolen. Standardvärdet är 1. Det maximala värdet är mindre än 4 gånger antalet kärnor i vmSize för poolen eller 256.
userAccounts		UserAccount[]	Listan över användarkonton som ska skapas på varje beräkningsnod i poolen.
virtualMachineConfiguration		VirtualMachineConfiguration	Konfigurationen av den virtuella datorn för poolen. Den här egenskapen och cloudServiceConfiguration är ömsesidigt uteslutande och en av egenskaperna måste anges.

Svar

Name	Type	Description
201 Created		Begäran till Batch-tjänsten lyckades. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Felet från Batch-tjänsten.

Name

Type

Description

201 Created

Begäran till Batch-tjänsten lyckades.

Headers

client-request-id: string
request-id: string
ETag: string
Last-Modified: string
DataServiceId: string

Other Status Codes

BatchError

Felet från Batch-tjänsten.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	Personifiera ditt användarkonto

Authorization

Type: apiKey
In: header

Exempel

Add a CloudServiceConfiguration pool

Add a pool with mount drive specified

Add a VirtualMachineConfiguration pool

Add a VirtualMachineConfiguration pool with containers

Add a VirtualMachineConfiguration pool with extensions

Add a CloudServiceConfiguration pool

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2022-01-01.15.0



{
  "id": "poolId",
  "vmSize": "small",
  "cloudServiceConfiguration": {
    "osFamily": "4"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Sample Response

Status code:: 201

Add a pool with mount drive specified

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2022-01-01.15.0


{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "20_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "mountConfiguration": [
    {
      "azureBlobFileSystemConfiguration": {
        "accountName": "accountName",
        "containerName": "blobContainerName",
        "accountKey": "accountKey",
        "relativeMountPath": "bfusepath"
      }
    },
    {
      "azureFileShareConfiguration": {
        "accountName": "accountName",
        "azureFileUrl": "https://myaccount.file.core.windows.net/fileshare",
        "accountKey": "accountKey",
        "relativeMountPath": "filesharepath",
        "mountOptions": "mount options ver=1.0"
      }
    },
    {
      "nfsMountConfiguration": {
        "source": "somesource nfs url",
        "relativeMountPath": "mountpath",
        "mountOptions": "mount options ver=1.0"
      }
    },
    {
      "cifsMountConfiguration": {
        "username": "accountName",
        "password": "password",
        "source": "//myaccount.file.core.windows.net/file",
        "relativeMountPath": "mountpath",
        "mountOptions": "mount options ver=1.0"
      }
    }
  ],
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false
}

Sample Response

Status code:: 201

Add a VirtualMachineConfiguration pool

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2022-01-01.15.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Sample Response

Status code:: 201

Add a VirtualMachineConfiguration pool with containers

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2022-01-01.15.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "120_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04",
    "containerConfiguration": {
      "type": "dockerCompatible",
      "containerImageNames": [
        "busybox"
      ]
    }
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false
}

Sample Response

Status code:: 201

Add a VirtualMachineConfiguration pool with extensions

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2022-01-01.15.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04",
    "extensions": [
      {
        "name": "batchextension1",
        "type": "SecurityMonitoringForLinux",
        "publisher": "Microsoft.Azure.Security.Monitoring",
        "typeHandlerVersion": "1.0",
        "autoUpgradeMinorVersion": true,
        "settings": "{\"settingsKey\":\"settingsValue\"}",
        "protectedSettings": "{\"protectedSettingsKey\":\"protectedSettingsValue\"}"
      }
    ]
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Sample Response

Status code:: 201

Definitioner

ApplicationPackageReference	En referens till ett paket som ska distribueras till beräkningsnoder.
AutoUserScope	Omfånget för den automatiska användaren
AutoUserSpecification	Anger parametrarna för den automatiska användare som kör en aktivitet i Batch-tjänsten.
AzureBlobFileSystemConfiguration	Information som används för att ansluta till en Azure Storage container med blobfuse.
AzureFileShareConfiguration	Information som används för att ansluta till en Azure Fileshare.
BatchError	Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail	Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.
CachingType	Typen av cachelagring som ska aktiveras för disken.
CertificateReference	En referens till ett certifikat som ska installeras på beräkningsnoder i en pool.
CertificateStoreLocation	Platsen för certifikatarkivet på beräkningsnoden där certifikatet ska installeras.
CIFSMountConfiguration	Information som används för att ansluta till ett CIFS-filsystem.
CloudServiceConfiguration	Konfigurationen för beräkningsnoder i en pool baserat på Azure Cloud Services-plattformen.
ComputeNodeFillType	Hur aktiviteter distribueras mellan beräkningsnoder i en pool.
ComputeNodeIdentityReference	Referensen till en användartilldelad identitet som är associerad med batchpoolen som en beräkningsnod ska använda.
ContainerConfiguration	Konfigurationen för containeraktiverade pooler.
ContainerRegistry	Ett privat containerregister.
ContainerType	Containertekniken som ska användas.
ContainerWorkingDirectory	Platsen för containerns arbetskatalog för uppgift.
DataDisk	Inställningar som ska användas av de datadiskar som är associerade med beräkningsnoder i poolen. När du använder anslutna datadiskar måste du montera och formatera diskarna inifrån en virtuell dator för att kunna använda dem.
DiffDiskPlacement	Anger den tillfälliga diskplaceringen för operativsystemdisken för alla beräkningsnoder (VIRTUELLA datorer) i poolen.
DiffDiskSettings	Anger den tillfälliga disken Inställningar för operativsystemdisken som används av beräkningsnoden (VM).
DiskEncryptionConfiguration	Diskkrypteringskonfigurationen som tillämpas på beräkningsnoder i poolen. Konfiguration av diskkryptering stöds inte i En Linux-pool som skapats med Shared Image Gallery Image.
DynamicVNetAssignmentScope	Omfånget för dynamisk vnet-tilldelning.
ElevationLevel	Användarens höjdnivå.
EnvironmentSetting	En miljövariabel som ska anges i en uppgiftsprocess.
ErrorMessage	Ett felmeddelande som togs emot i ett Azure Batch felsvar.
ImageReference	En referens till en Azure Virtual Machines Marketplace-avbildning eller en Shared Image Gallery image. Om du vill hämta en lista över alla Azure Marketplace Image-referenser som verifierats av Azure Batch läser du åtgärden "Lista över avbildningar som stöds".
InboundEndpointProtocol	Protokollet för slutpunkten.
InboundNATPool	En inkommande NAT-pool som kan användas för att adressera specifika portar på beräkningsnoder i en Batch-pool externt.
IPAddressProvisioningType	Etableringstypen för offentliga IP-adresser för poolen.
LinuxUserConfiguration	Egenskaper som används för att skapa ett användarkonto på en Linux-beräkningsnod.
LoginMode	Inloggningsläget för användaren
MetadataItem	Ett namn/värde-par som är associerat med en Batch-tjänstresurs.
MountConfiguration	Filsystemet som ska monteras på varje nod.
NetworkConfiguration	Nätverkskonfigurationen för en pool.
NetworkSecurityGroupRule	En regel för nätverkssäkerhetsgrupp som ska tillämpas på en inkommande slutpunkt.
NetworkSecurityGroupRuleAccess	Den åtgärd som ska vidtas för en angiven IP-adress, ett undernätsintervall eller en tagg.
NFSMountConfiguration	Information som används för att ansluta till ett NFS-filsystem.
NodePlacementConfiguration	Konfiguration av nodplacering för en pool.
NodePlacementPolicyType	Placeringsprincipen för allokering av noder i poolen.
OSDisk	Inställningar för operativsystemdisken på beräkningsnoden (VM).
PoolAddParameter	En pool i Azure Batch-tjänsten som ska läggas till.
PoolEndpointConfiguration	Slutpunktskonfigurationen för en pool.
PublicIPAddressConfiguration	Den offentliga IP-adresskonfigurationen för nätverkskonfigurationen för en pool.
ResourceFile	En enskild fil eller flera filer som ska laddas ned till en beräkningsnod.
StartTask	En aktivitet som körs när en nod ansluter till en pool i Azure Batch-tjänsten, eller när beräkningsnoden startas om eller omskapas.
StorageAccountType	Lagringskontotypen som ska användas för att skapa datadiskar.
TaskContainerSettings	Containerinställningarna för en aktivitet.
TaskSchedulingPolicy	Anger hur aktiviteter ska distribueras mellan beräkningsnoder.
UserAccount	Egenskaper som används för att skapa en användare som används för att köra uppgifter på en Azure Batch beräkningsnod.
UserIdentity	Definitionen av den användaridentitet som aktiviteten körs under.
VirtualMachineConfiguration	Konfigurationen för beräkningsnoder i en pool baserat på Azure Virtual Machines-infrastrukturen.
VMExtension	Konfigurationen för tillägg för virtuella datorer.
WindowsConfiguration	Windows operativsysteminställningar som ska tillämpas på den virtuella datorn.
WindowsUserConfiguration	Egenskaper som används för att skapa ett användarkonto på en Windows beräkningsnod.

ApplicationPackageReference

En referens till ett paket som ska distribueras till beräkningsnoder.

Name	Type	Description
applicationId	string	ID för programmet som ska distribueras.
version	string	Den version av programmet som ska distribueras. Om den utelämnas distribueras standardversionen. Om detta utelämnas i en pool och ingen standardversion har angetts för det här programmet misslyckas begäran med felkoden InvalidApplicationPackageReferences och HTTP-statuskod 409. Om detta utelämnas för en aktivitet och ingen standardversion har angetts för det här programmet misslyckas uppgiften med ett förbearbetningsfel.

AutoUserScope

Omfånget för den automatiska användaren

Name	Type	Description
pool	string	Anger att aktiviteten körs som det vanliga automatiska användarkontot som skapas på varje beräkningsnod i en pool.
task	string	Anger att tjänsten ska skapa en ny användare för uppgiften.

AutoUserSpecification

Anger parametrarna för den automatiska användare som kör en aktivitet i Batch-tjänsten.

Name	Type	Description
elevationLevel	ElevationLevel	Den automatiska användarens höjdnivå. Standardvärdet är nonAdmin.
scope	AutoUserScope	Omfånget för den automatiska användaren Standardvärdet är pool. Om poolen körs Windows ska värdet Aktivitet anges om striktare isolering mellan aktiviteter krävs. Om uppgiften till exempel muterar registret på ett sätt som kan påverka andra aktiviteter, eller om certifikat har angetts i poolen som inte ska vara tillgängliga för normala uppgifter, men som ska vara tillgängliga av StartTasks.

AzureBlobFileSystemConfiguration

Information som används för att ansluta till en Azure Storage container med blobfuse.

Name	Type	Description
accountKey	string	Nyckeln Azure Storage konto. Den här egenskapen är ömsesidigt uteslutande med både sasKey och identitet; exakt ett måste anges.
accountName	string	Namnet på det Azure Storage kontot.
blobfuseOptions	string	Ytterligare kommandoradsalternativ för att skicka till monteringskommandot. Det här är alternativ för "net use" i Windows- och "mount"-alternativ i Linux.
containerName	string	Namnet på Azure Blob Storage container.
identityReference	ComputeNodeIdentityReference	Referensen till den användartilldelade identitet som ska användas för att komma åt containerName Den här egenskapen är ömsesidigt uteslutande med både accountKey och sasKey; exakt ett måste anges.
relativeMountPath	string	Den relativa sökvägen på beräkningsnoden där filsystemet ska monteras Alla filsystem monteras i förhållande till katalogen Batch-monteringar som är tillgängliga via AZ_BATCH_NODE_MOUNTS_DIR miljövariabeln.
sasKey	string	AZURE STORAGE SAS-token. Den här egenskapen är ömsesidigt uteslutande med både accountKey och identitet; exakt ett måste anges.

AzureFileShareConfiguration

Information som används för att ansluta till en Azure Fileshare.

Name	Type	Description
accountKey	string	Den Azure Storage kontonyckeln.
accountName	string	Det Azure Storage kontonamnet.
azureFileUrl	string	URL:en för Azure Files. Det här är av formatet "https://{account}.file.core.windows.net/".
mountOptions	string	Ytterligare kommandoradsalternativ för att skicka till monteringskommandot. Det här är alternativ för "net use" i Windows- och "mount"-alternativ i Linux.
relativeMountPath	string	Den relativa sökvägen på beräkningsnoden där filsystemet ska monteras Alla filsystem monteras i förhållande till katalogen Batch-monteringar som är tillgängliga via AZ_BATCH_NODE_MOUNTS_DIR miljövariabeln.

BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name	Type	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message	ErrorMessage	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values	BatchErrorDetail[]	En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.

Name	Type	Description
key	string	En identifierare som anger innebörden av egenskapen Value.
value	string	Den ytterligare information som ingår i felsvaret.

CachingType

Typen av cachelagring som ska aktiveras för disken.

Name	Type	Description
none	string	Cachelagringsläget för disken är inte aktiverat.
readonly	string	Cachelagringsläget för disken är skrivskyddat.
readwrite	string	Cachelagringsläget för disken är läs- och skrivläge.

CertificateReference

En referens till ett certifikat som ska installeras på beräkningsnoder i en pool.

Name	Type	Description
storeLocation	CertificateStoreLocation	Platsen för certifikatarkivet på beräkningsnoden där certifikatet ska installeras. Standardvärdet är currentuser. Den här egenskapen gäller endast för pooler som konfigurerats med Windows beräkningsnoder (det vill: skapad med cloudServiceConfiguration eller med virtualMachineConfiguration med hjälp av en referens för Windows Image). För Linux-beräkningsnoder lagras certifikaten i en katalog i arbetskatalogen Aktivitet och en miljövariabel AZ_BATCH_CERTIFICATES_DIR anges till uppgiften för att fråga efter den här platsen. För certifikat med synligheten "remoteUser" skapas en "certs"-katalog i användarens hemkatalog (t.ex. /home/{user-name}/certs) och certifikat placeras i den katalogen.
storeName	string	Namnet på certifikatarkivet på beräkningsnoden där certifikatet ska installeras. Den här egenskapen gäller endast för pooler som konfigurerats med Windows beräkningsnoder (det vill: skapad med cloudServiceConfiguration eller med virtualMachineConfiguration med hjälp av en referens för Windows Image). Vanliga butiksnamn är: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, men alla anpassade butiksnamn kan också användas. Standardvärdet är Min.
thumbprint	string	Tumavtrycket för certifikatet.
thumbprintAlgorithm	string	Algoritmen som tumavtrycket är associerat med. Det här måste vara sha1.
visibility	string[]	Vilka användarkonton på beräkningsnoden ska ha åtkomst till certifikatets privata data. Du kan ange mer än en synlighet i den här samlingen. Standardvärdet är alla konton.

CertificateStoreLocation

Platsen för certifikatarkivet på beräkningsnoden där certifikatet ska installeras.

Name	Type	Description
currentuser	string	Certifikat ska installeras i CurrentUser-certifikatarkivet.
localmachine	string	Certifikat ska installeras i LocalMachine-certifikatarkivet.

CIFSMountConfiguration

Information som används för att ansluta till ett CIFS-filsystem.

Name	Type	Description
mountOptions	string	Ytterligare kommandoradsalternativ för att skicka till monteringskommandot. Det här är alternativ för "net use" i Windows- och "mount"-alternativ i Linux.
password	string	Lösenordet som ska användas för autentisering mot CIFS-filsystemet.
relativeMountPath	string	Den relativa sökvägen på beräkningsnoden där filsystemet ska monteras Alla filsystem monteras i förhållande till katalogen Batch-monteringar som är tillgängliga via AZ_BATCH_NODE_MOUNTS_DIR miljövariabeln.
source	string	URI:n för filsystemet som ska monteras.
username	string	Användaren som ska användas för autentisering mot CIFS-filsystemet.

CloudServiceConfiguration

Konfigurationen för beräkningsnoder i en pool baserat på Azure Cloud Services-plattformen.

Name	Type	Description
osFamily	string	Den Azure-gästoperativsystemfamilj som ska installeras på de virtuella datorerna i poolen. Möjliga värden är: 2 – OS Family 2, motsvarande Windows Server 2008 R2 SP1. 3 – OS Family 3, motsvarande Windows Server 2012. 4 – OS Family 4, motsvarande Windows Server 2012 R2. 5 – OS Family 5, motsvarande Windows Server 2016. 6 – OS Family 6, motsvarande Windows Server 2019. Mer information finns i Versioner av Azure-gästoperativsystem (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).
osVersion	string	Den Azure-gästoperativsystemversion som ska installeras på de virtuella datorerna i poolen. Standardvärdet är * som anger den senaste operativsystemversionen för den angivna operativsystemfamiljen.

ComputeNodeFillType

Hur aktiviteter distribueras mellan beräkningsnoder i en pool.

Name	Type	Description
pack	string	Så många aktiviteter som möjligt (taskSlotsPerNode) bör tilldelas till varje beräkningsnod i poolen innan aktiviteter tilldelas till nästa beräkningsnod i poolen.
spread	string	Aktiviteter bör tilldelas jämnt över alla beräkningsnoder i poolen.

ComputeNodeIdentityReference

Referensen till en användartilldelad identitet som är associerad med batchpoolen som en beräkningsnod ska använda.

Name	Type	Description
resourceId	string	ARM-resurs-ID för den användartilldelade identiteten.

ContainerConfiguration

Konfigurationen för containeraktiverade pooler.

Name	Type	Description
containerImageNames	string[]	Samlingen med containeravbildningsnamn. Det här är den fullständiga avbildningsreferensen, som skulle anges till "docker pull". En avbildning kommer att hämtas från Docker-standardregistret om inte avbildningen är fullständigt kvalificerad med ett alternativt register.
containerRegistries	ContainerRegistry[]	Ytterligare privata register från vilka containrar kan hämtas. Om några avbildningar måste laddas ned från ett privat register som kräver autentiseringsuppgifter måste dessa autentiseringsuppgifter anges här.
type	ContainerType	Containertekniken som ska användas.

ContainerRegistry

Ett privat containerregister.

Name	Type	Description
identityReference	ComputeNodeIdentityReference	Referensen till den användartilldelade identitet som ska användas för att komma åt en Azure Container Registry i stället för användarnamn och lösenord. Referensen till en användartilldelad identitet som är associerad med batchpoolen som en beräkningsnod ska använda.
password	string	Lösenordet för att logga in på registerservern.
registryServer	string	Registrets URL. Om det utelämnas är standardvärdet "docker.io".
username	string	Användarnamnet för att logga in på registerservern.

ContainerType

Containertekniken som ska användas.

Name	Type	Description
dockerCompatible	string	En Docker-kompatibel containerteknik används för att starta containrarna.

ContainerWorkingDirectory

Platsen för containerns arbetskatalog för uppgift.

Name	Type	Description
containerImageDefault	string	Använd arbetskatalogen som definierats i containern Avbildning. Se upp för att den här katalogen inte innehåller de resursfiler som laddats ned av Batch.
taskWorkingDirectory	string	Använd arbetskatalogen för Batch-tjänstens standardtjänst, som innehåller de aktivitetsresursfiler som fylls i av Batch.

DataDisk

Inställningar som ska användas av de datadiskar som är associerade med beräkningsnoder i poolen. När du använder anslutna datadiskar måste du montera och formatera diskarna inifrån en virtuell dator för att kunna använda dem.

Name	Type	Description
caching	CachingType	Den typ av cachelagring som ska aktiveras för datadiskarna. Standardvärdet för cachelagring är skrivskyddat. Information om alternativen för cachelagring finns i: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
diskSizeGB	integer	Den ursprungliga diskstorleken i gigabyte.
lun	integer	Det logiska enhetsnumret. Lun används för att unikt identifiera varje datadisk. Om du kopplar flera diskar bör var och en ha ett distinkt lun. Värdet måste vara mellan 0 och 63.
storageAccountType	StorageAccountType	Lagringskontotypen som ska användas för datadisken. Om det utelämnas är standardvärdet "standard_lrs".

DiffDiskPlacement

Anger den tillfälliga diskplaceringen för operativsystemdisken för alla beräkningsnoder (VIRTUELLA datorer) i poolen.

Name	Type	Description
CacheDisk	string	Den tillfälliga OS-disken lagras i den virtuella datorns cacheminne.

DiffDiskSettings

Anger den tillfälliga disken Inställningar för operativsystemdisken som används av beräkningsnoden (VM).

Name	Type	Description
placement	DiffDiskPlacement	Anger den tillfälliga diskplaceringen för operativsystemdisken för alla virtuella datorer i poolen. Den här egenskapen kan användas av användaren i begäran för att välja plats, t.ex. cachediskutrymme för tillfällig OS-disketablering. Mer information om krav för tillfällig os-diskstorlek finns i Krav på tillfällig OS-diskstorlek för Windows virtuella datorer på https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements och virtuella Linux-datorer på https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

DiskEncryptionConfiguration

Diskkrypteringskonfigurationen som tillämpas på beräkningsnoder i poolen. Konfiguration av diskkryptering stöds inte i En Linux-pool som skapats med Shared Image Gallery Image.

Name	Type	Description
targets	string[]	Listan över diskmål Batch Service krypterar på beräkningsnoden. Om det utelämnas krypteras inga diskar på beräkningsnoderna i poolen. I Linux-poolen stöds endast "TemporaryDisk". på Windows pool måste "OsDisk" och "TemporaryDisk" anges.

DynamicVNetAssignmentScope

Omfånget för dynamisk vnet-tilldelning.

Name	Type	Description
job	string	Dynamisk VNet-tilldelning görs per jobb.
none	string	Ingen dynamisk VNet-tilldelning är aktiverad.

ElevationLevel

Användarens höjdnivå.

Name	Type	Description
admin	string	Användaren är en användare med förhöjd åtkomst och fungerar med fullständiga administratörsbehörigheter.
nonadmin	string	Användaren är en standardanvändare utan förhöjd åtkomst.

EnvironmentSetting

En miljövariabel som ska anges i en uppgiftsprocess.

Name	Type	Description
name	string	Namnet på miljövariabeln.
value	string	Värdet för miljövariabeln.

ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch felsvar.

Name	Type	Description
lang	string	Språkkoden för felmeddelandet
value	string	Texten i meddelandet.

ImageReference

En referens till en Azure Virtual Machines Marketplace-avbildning eller en Shared Image Gallery image. Om du vill hämta en lista över alla Azure Marketplace Image-referenser som verifierats av Azure Batch läser du åtgärden "Lista över avbildningar som stöds".

Name	Type	Description
exactVersion	string	Den specifika versionen av plattformsbilden eller Marketplace-avbildningen som används för att skapa noden. Det här skrivskyddade fältet skiljer sig endast från "version" om värdet som angavs för "version" när poolen skapades var "senaste".
offer	string	Erbjudandetypen för Azure Virtual Machines Marketplace-avbildningen. Till exempel UbuntuServer eller WindowsServer.
publisher	string	Utgivaren av Azure Virtual Machines Marketplace-avbildningen. Till exempel Canonical eller MicrosoftWindowsServer.
sku	string	SKU:n för Azure Virtual Machines Marketplace-avbildningen. Till exempel 18.04-LTS eller 2019-Datacenter.
version	string	Versionen av Azure Virtual Machines Marketplace-avbildningen. Du kan ange värdet "senaste" för att välja den senaste versionen av en avbildning. Om det utelämnas är standardvärdet "senaste".
virtualMachineImageId	string	ARM-resursidentifieraren för Shared Image Gallery Image. Beräkningsnoder i poolen skapas med det här avbildnings-ID:t. Detta är av formatet /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} eller /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} för att alltid ha den senaste avbildningsversionen som standard. Den här egenskapen är ömsesidigt uteslutande med andra ImageReference-egenskaper. Shared Image Gallery Image måste ha repliker i samma region och måste finnas i samma prenumeration som Azure Batch-kontot. Om avbildningsversionen inte anges i imageId används den senaste versionen. Information om brandväggsinställningarna för Batch Compute Node-agenten som ska kommunicera med Batch-tjänsten finns https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configurationi .

InboundEndpointProtocol

Protokollet för slutpunkten.

Name	Type	Description
tcp	string	Använd TCP för slutpunkten.
udp	string	Använd UDP för slutpunkten.

InboundNATPool

En inkommande NAT-pool som kan användas för att adressera specifika portar på beräkningsnoder i en Batch-pool externt.

Name	Type	Description
backendPort	integer	Portnumret på beräkningsnoden. Detta måste vara unikt i en Batch-pool. Godtagbara värden är mellan 1 och 65535 förutom för 22, 3389, 29876 och 29877 eftersom dessa är reserverade. Om några reserverade värden anges misslyckas begäran med HTTP-statuskod 400.
frontendPortRangeEnd	integer	Det sista portnumret i intervallet för externa portar som ska användas för att ge inkommande åtkomst till backendPort på enskilda beräkningsnoder. Acceptabla värden sträcker sig mellan 1 och 65534 utom portar från 50000 till 55000 som är reserverade av Batch-tjänsten. Alla intervall i en pool måste vara distinkta och får inte överlappa varandra. Varje intervall måste innehålla minst 40 portar. Om några reserverade eller överlappande värden tillhandahålls misslyckas begäran med HTTP-statuskod 400.
frontendPortRangeStart	integer	Det första portnumret i intervallet för externa portar som ska användas för att ge inkommande åtkomst till backendPort på enskilda beräkningsnoder. Godtagbara värden sträcker sig mellan 1 och 65534 utom portar från 50000 till 55000 som är reserverade. Alla intervall i en pool måste vara distinkta och får inte överlappa varandra. Varje intervall måste innehålla minst 40 portar. Om några reserverade eller överlappande värden tillhandahålls misslyckas begäran med HTTP-statuskod 400.
name	string	Namnet på slutpunkten. Namnet måste vara unikt i en Batch-pool, kan innehålla bokstäver, siffror, understreck, punkter och bindestreck. Namn måste börja med en bokstav eller ett tal, måste sluta med en bokstav, ett tal eller ett understreck och får inte överstiga 77 tecken. Om ogiltiga värden anges misslyckas begäran med HTTP-statuskod 400.
networkSecurityGroupRules	NetworkSecurityGroupRule[]	En lista över regler för nätverkssäkerhetsgrupper som ska tillämpas på slutpunkten. Det maximala antalet regler som kan anges för alla slutpunkter i en Batch-pool är 25. Om inga regler för nätverkssäkerhetsgrupper anges skapas en standardregel som tillåter inkommande åtkomst till den angivna backendPort. Om det maximala antalet regler för nätverkssäkerhetsgrupper överskrids misslyckas begäran med HTTP-statuskod 400.
protocol	InboundEndpointProtocol	Protokollet för slutpunkten.

IPAddressProvisioningType

Etableringstypen för offentliga IP-adresser för poolen.

Name	Type	Description
batchmanaged	string	En offentlig IP-adress skapas och hanteras av Batch. Det kan finnas flera offentliga IP-adresser beroende på poolens storlek.
nopublicipaddresses	string	Ingen offentlig IP-adress skapas.
usermanaged	string	Offentliga IP-adresser tillhandahålls av användaren och används för att etablera beräkningsnoderna.

LinuxUserConfiguration

Egenskaper som används för att skapa ett användarkonto på en Linux-beräkningsnod.

Name	Type	Description
gid	integer	Grupp-ID för användarkontot. Egenskaperna uid och gid måste anges tillsammans eller inte alls. Om det inte anges väljer det underliggande operativsystemet gid.
sshPrivateKey	string	Den privata SSH-nyckeln för användarkontot. Den privata nyckeln får inte vara lösenordsskyddad. Den privata nyckeln används för att automatiskt konfigurera asymmetrisk nyckelbaserad autentisering för SSH mellan beräkningsnoder i en Linux-pool när poolens enableInterNodeCommunication-egenskap är sann (den ignoreras om enableInterNodeCommunication är falskt). Det gör det genom att placera nyckelparet i användarens .ssh-katalog. Om inget anges konfigureras inte lösenordsfri SSH mellan beräkningsnoder (ingen ändring av användarens .ssh-katalog görs).
uid	integer	Användar-ID för användarkontot. Egenskaperna uid och gid måste anges tillsammans eller inte alls. Om det inte anges väljer det underliggande operativsystemet uid.

LoginMode

Inloggningsläget för användaren

Name	Type	Description
batch	string	Inloggningsläget LOGON32_LOGON_BATCH Win32. Batchinloggningsläget rekommenderas för långvariga parallella processer.
interactive	string	Inloggningsläget LOGON32_LOGON_INTERACTIVE Win32. UAC är aktiverat på Windows VirtualMachineConfiguration Pools. Om det här alternativet används med en upphöjd användaridentitet i en Windows VirtualMachineConfiguration-pool, höjs inte användarsessionen såvida inte programmet som körs av kommandoraden Aktivitet har konfigurerats för att alltid kräva administrativ behörighet eller att alltid kräva maximal behörighet.

MetadataItem

Ett namn/värde-par som är associerat med en Batch-tjänstresurs.

Name	Type	Description
name	string	Namnet på metadataobjektet.
value	string	Värdet för metadataobjektet.

MountConfiguration

Filsystemet som ska monteras på varje nod.

Name	Type	Description
azureBlobFileSystemConfiguration	AzureBlobFileSystemConfiguration	Den Azure Storage container som ska monteras med blob-FUSE på varje nod. Den här egenskapen är ömsesidigt uteslutande med alla andra egenskaper.
azureFileShareConfiguration	AzureFileShareConfiguration	Azure-filresursen som ska monteras på varje nod. Den här egenskapen är ömsesidigt uteslutande med alla andra egenskaper.
cifsMountConfiguration	CIFSMountConfiguration	CIFS/SMB-filsystemet som ska monteras på varje nod. Den här egenskapen är ömsesidigt uteslutande med alla andra egenskaper.
nfsMountConfiguration	NFSMountConfiguration	NFS-filsystemet som ska monteras på varje nod. Den här egenskapen är ömsesidigt uteslutande med alla andra egenskaper.

NetworkConfiguration

Nätverkskonfigurationen för en pool.

Name	Type	Description
dynamicVNetAssignmentScope	DynamicVNetAssignmentScope	Omfånget för dynamisk vnet-tilldelning.
endpointConfiguration	PoolEndpointConfiguration	Konfigurationen för slutpunkter på beräkningsnoder i Batch-poolen. Konfiguration av poolslutpunkt stöds bara på pooler med egenskapen virtualMachineConfiguration.
publicIPAddressConfiguration	PublicIPAddressConfiguration	Den offentliga IPAddress-konfigurationen för beräkningsnoder i Batch-poolen. Egenskapen offentlig IP-konfiguration stöds bara i pooler med egenskapen virtualMachineConfiguration.
subnetId	string	ARM-resursidentifieraren för det virtuella nätverkets undernät som poolens beräkningsnoder ansluts till. Detta är av formatet /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. Det virtuella nätverket måste finnas i samma region och prenumeration som Azure Batch-kontot. Det angivna undernätet ska ha tillräckligt med lediga IP-adresser för att hantera antalet beräkningsnoder i poolen. Om undernätet inte har tillräckligt med lediga IP-adresser allokerar poolen delvis noder och ett storleksändringsfel uppstår. Tjänstens huvudnamn för MicrosoftAzureBatch måste ha rollen "Klassisk virtuell datordeltagare" Role-Based Access Control (RBAC) för det angivna virtuella nätverket. Det angivna undernätet måste tillåta kommunikation från Azure Batch-tjänsten för att kunna schemalägga aktiviteter på noderna. Detta kan verifieras genom att kontrollera om det angivna virtuella nätverket har några associerade nätverkssäkerhetsgrupper (NSG). Om kommunikationen till noderna i det angivna undernätet nekas av en NSG anger Batch-tjänsten beräkningsnodernas tillstånd till oanvändbart. För pooler som skapats med virtualMachineConfiguration stöds endast virtuella ARM-nätverk ("Microsoft.Network/virtualNetworks") men för pooler som skapats med cloudServiceConfiguration stöds både ARM och klassiska virtuella nätverk. Om det angivna virtuella nätverket har associerade nätverkssäkerhetsgrupper (NSG) måste ett par reserverade systemportar vara aktiverade för inkommande kommunikation. Aktivera portarna 29876 och 29877 samt port 22 för Linux och port 3389 för Windows för Pooler som skapats med en konfiguration av virtuella datorer. För Pooler som skapats med en molntjänstkonfiguration aktiverar du portarna 10100, 20100 och 30100. Aktivera även utgående anslutningar för att Azure Storage på port 443. Mer information finns i: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

En regel för nätverkssäkerhetsgrupp som ska tillämpas på en inkommande slutpunkt.

Name	Type	Description
access	NetworkSecurityGroupRuleAccess	Den åtgärd som ska vidtas för en angiven IP-adress, ett undernätsintervall eller en tagg.
priority	integer	Prioriteten för den här regeln. Prioriteringarna i en pool måste vara unika och utvärderas i prioritetsordning. Desto lägre är talet, desto högre prioritet. Regler kan till exempel anges med ordernummer 150, 250 och 350. Regeln med ordernumret 150 har företräde framför regeln som har en ordning på 250. Tillåtna prioriteringar är mellan 150 och 4 096. Om några reserverade eller duplicerade värden anges misslyckas begäran med HTTP-statuskod 400.
sourceAddressPrefix	string	Källadressprefixet eller taggen som ska matchas för regeln. Giltiga värden är en enskild IP-adress (dvs. 10.10.10.10), IP-undernät (dvs. 192.168.1.0/24), standardtagg eller * (för alla adresser). Om andra värden anges misslyckas begäran med HTTP-statuskod 400.
sourcePortRanges	string[]	Källportintervallen som ska matchas för regeln. Giltiga värden är "" (för alla portar 0–65535), en specifik port (dvs. 22) eller ett portintervall (dvs. 100–200). Portarna måste vara mellan 0 och 65535. Varje post i den här samlingen får inte överlappa någon annan post (antingen ett intervall eller en enskild port). Om andra värden anges misslyckas begäran med HTTP-statuskod 400. Standardvärdet är ''.

NetworkSecurityGroupRuleAccess

Den åtgärd som ska vidtas för en angiven IP-adress, ett undernätsintervall eller en tagg.

Name	Type	Description
allow	string	Tillåt åtkomst.
deny	string	Neka åtkomst.

NFSMountConfiguration

Information som används för att ansluta till ett NFS-filsystem.

Name	Type	Description
mountOptions	string	Ytterligare kommandoradsalternativ för att skicka till monteringskommandot. Det här är alternativ för "net use" i Windows- och "mount"-alternativ i Linux.
relativeMountPath	string	Den relativa sökvägen på beräkningsnoden där filsystemet ska monteras Alla filsystem monteras i förhållande till katalogen Batch-monteringar som är tillgängliga via AZ_BATCH_NODE_MOUNTS_DIR miljövariabeln.
source	string	URI:n för filsystemet som ska monteras.

NodePlacementConfiguration

Konfiguration av nodplacering för en pool.

Name	Type	Description
policy	NodePlacementPolicyType	Nodplacering Principtyp i Batch-pooler. Allokeringsprincip som används av Batch-tjänsten för att etablera noderna. Om det inte anges använder Batch regionalprincipen.

NodePlacementPolicyType

Placeringsprincipen för allokering av noder i poolen.

Name	Type	Description
regional	string	Alla noder i poolen allokeras i samma region.
zonal	string	Noder i poolen kommer att spridas över olika tillgänglighetszoner med bästa möjliga balansering.

OSDisk

Inställningar för operativsystemdisken på beräkningsnoden (VM).

Name	Type	Description
ephemeralOSDiskSettings	DiffDiskSettings	Anger den tillfälliga disken Inställningar för operativsystemdisken som används av beräkningsnoden (VM).

PoolAddParameter

En pool i Azure Batch-tjänsten som ska läggas till.

Name	Type	Description
applicationLicenses	string[]	Listan över programlicenser som Batch-tjänsten gör tillgängliga på varje beräkningsnod i poolen. Listan över programlicenser måste vara en delmängd av tillgängliga Batch-tjänstprogramlicenser. Om en licens begärs som inte stöds misslyckas skapandet av poolen.
applicationPackageReferences	ApplicationPackageReference[]	Listan över paket som ska installeras på varje beräkningsnod i poolen. Ändringar av paketreferenser påverkar alla nya noder som ansluter till poolen, men påverkar inte beräkningsnoder som redan finns i poolen förrän de startas om eller avfinns på nytt. Det finns högst 10 paketreferenser i en viss pool.
autoScaleEvaluationInterval	string	Det tidsintervall då poolstorleken ska justeras automatiskt enligt autoskalningsformeln. Standardvärdet är 15 minuter. Det minsta och högsta värdet är 5 minuter respektive 168 timmar. Om du anger ett värde som är mindre än 5 minuter eller större än 168 timmar returnerar Batch-tjänsten ett fel. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran).
autoScaleFormula	string	En formel för önskat antal beräkningsnoder i poolen. Den här egenskapen får inte anges om enableAutoScale är inställt på false. Det krävs om enableAutoScale är inställt på true. Formeln kontrolleras för giltighet innan poolen skapas. Om formeln inte är giltig avvisar Batch-tjänsten begäran med detaljerad felinformation. Mer information om hur du anger den här formeln finns i Skala beräkningsnoder automatiskt i en Azure Batch pool (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).
certificateReferences	CertificateReference[]	Listan över certifikat som ska installeras på varje beräkningsnod i poolen. För Windows-noder installerar Batch-tjänsten certifikaten till det angivna certifikatarkivet och platsen. För Linux-beräkningsnoder lagras certifikaten i en katalog i arbetskatalogen Aktivitet och en miljövariabel AZ_BATCH_CERTIFICATES_DIR anges till uppgiften för att fråga efter den här platsen. För certifikat med synligheten "remoteUser" skapas en "certs"-katalog i användarens hemkatalog (t.ex. /home/{user-name}/certs) och certifikat placeras i den katalogen.
cloudServiceConfiguration	CloudServiceConfiguration	Molntjänstkonfigurationen för poolen. Den här egenskapen och virtualMachineConfiguration är ömsesidigt uteslutande och en av egenskaperna måste anges. Det går inte att ange den här egenskapen om Batch-kontot har skapats med egenskapen poolAllocationMode inställd på UserSubscription.
displayName	string	Visningsnamnet för poolen. Visningsnamnet behöver inte vara unikt och kan innehålla unicode-tecken upp till en maximal längd på 1 024.
enableAutoScale	boolean	Om poolstorleken ska justeras automatiskt över tid. Om värdet är falskt måste minst en av targetDedicatedNodes och targetLowPriorityNodes anges. Om det är sant krävs egenskapen autoScaleFormula och poolen ändras automatiskt enligt formeln. Standardvärdet är false.
enableInterNodeCommunication	boolean	Om poolen tillåter direkt kommunikation mellan beräkningsnoder. Om kommunikation mellan noder aktiveras begränsas poolens maximala storlek på grund av distributionsbegränsningar för poolens beräkningsnoder. Detta kan leda till att poolen inte når önskad storlek. Standardvärdet är false.
id	string	En sträng som unikt identifierar poolen i kontot. ID:t kan innehålla valfri kombination av alfanumeriska tecken, inklusive bindestreck och understreck, och får inte innehålla fler än 64 tecken. ID:t är skiftlägesbevarande och skiftlägesokänsligt (dvs. du kanske inte har två pool-ID:n inom ett konto som endast skiljer sig från fall till fall).
metadata	MetadataItem[]	En lista över namn/värde-par som är associerade med poolen som metadata. Batch-tjänsten tilldelar ingen mening till metadata. endast för användning av användarkod.
mountConfiguration	MountConfiguration[]	Montera lagring med angivet filsystem under hela poolens livslängd. Montera lagringen med hjälp av Azure-filresurs-, NFS-, CIFS- eller Blobfuse-baserat filsystem.
networkConfiguration	NetworkConfiguration	Nätverkskonfigurationen för poolen. Nätverkskonfigurationen för en pool.
resizeTimeout	string	Tidsgränsen för allokering av beräkningsnoder till poolen. Den här tidsgränsen gäller endast för manuell skalning. det har ingen effekt när enableAutoScale är inställt på sant. Standardvärdet är 15 minuter. Det minsta värdet är 5 minuter. Om du anger ett värde som är mindre än 5 minuter returnerar Batch-tjänsten ett fel. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran).
startTask	StartTask	En uppgift som har angetts för att köras på varje beräkningsnod när den ansluter till poolen. Aktiviteten körs när beräkningsnoden läggs till i poolen eller när beräkningsnoden startas om.
targetDedicatedNodes	integer	Önskat antal dedikerade beräkningsnoder i poolen. Den här egenskapen får inte anges om enableAutoScale har angetts till true. Om enableAutoScale är inställt på false måste du ange antingen targetDedicatedNodes, targetLowPriorityNodes eller båda.
targetLowPriorityNodes	integer	Önskat antal beräkningsnoder med oanvänd kapacitet/låg prioritet i poolen. Den här egenskapen får inte anges om enableAutoScale har angetts till true. Om enableAutoScale är inställt på false måste du ange antingen targetDedicatedNodes, targetLowPriorityNodes eller båda.
taskSchedulingPolicy	TaskSchedulingPolicy	Hur uppgifter distribueras mellan beräkningsnoder i en pool. Om inget anges är standardvärdet utspritt.
taskSlotsPerNode	integer	Antalet aktivitetsplatser som kan användas för att köra samtidiga aktiviteter på en enda beräkningsnod i poolen. Standardvärdet är 1. Det maximala värdet är mindre än 4 gånger antalet kärnor i vmSize för poolen eller 256.
userAccounts	UserAccount[]	Listan över användarkonton som ska skapas på varje beräkningsnod i poolen.
virtualMachineConfiguration	VirtualMachineConfiguration	Konfigurationen av den virtuella datorn för poolen. Den här egenskapen och cloudServiceConfiguration är ömsesidigt uteslutande och en av egenskaperna måste anges.
vmSize	string	Storleken på virtuella datorer i poolen. Alla virtuella datorer i en pool har samma storlek. Information om tillgängliga storlekar på virtuella datorer för Cloud Services pooler (pooler som skapats med cloudServiceConfiguration) finns i Storlekar för Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch stöder alla Cloud Services VM-storlekar utom ExtraSmall, A1V2 och A2V2. Information om tillgängliga VM-storlekar för pooler som använder avbildningar från Virtual Machines Marketplace (pooler som skapats med virtualMachineConfiguration) finns i Storlekar för Virtual Machines (Linux) () ellerhttps://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/ Storlekar för Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch stöder alla storlekar på virtuella Azure-datorer utom STANDARD_A0 och de med Premium Storage (STANDARD_GS, STANDARD_DS och STANDARD_DSV2-serien).

PoolEndpointConfiguration

Slutpunktskonfigurationen för en pool.

Name	Type	Description
inboundNATPools	InboundNATPool[]	En lista över inkommande NAT-pooler som kan användas för att adressera specifika portar på en enskild beräkningsnod externt. Det maximala antalet inkommande NAT-pooler per batchpool är 5. Om det maximala antalet inkommande NAT-pooler överskrids misslyckas begäran med HTTP-statuskod 400. Det går inte att ange detta om IPAddressProvisioningType är NoPublicIPAddresses.

PublicIPAddressConfiguration

Den offentliga IP-adresskonfigurationen för nätverkskonfigurationen för en pool.

Name	Type	Description
ipAddressIds	string[]	Listan över offentliga IP-adresser som Batch-tjänsten ska använda vid etablering av beräkningsnoder. Antalet IP-adresser som anges här begränsar den maximala storleken för poolen – 100 dedikerade noder eller 100 noder med oanvänd kapacitet/låg prioritet kan allokeras för varje offentlig IP-adress. Till exempel skulle en pool som behöver 250 dedikerade virtuella datorer behöva minst 3 offentliga IP-adresser angivna. Varje element i den här samlingen är av formatet: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.
provision	IPAddressProvisioningType	Etableringstypen för offentliga IP-adresser för poolen. Standardvärdet är BatchManaged.

ResourceFile

En enskild fil eller flera filer som ska laddas ned till en beräkningsnod.

Name	Type	Description
autoStorageContainerName	string	Namnet på lagringscontainern i det automatiska lagringskontot. Egenskaperna autoStorageContainerName, storageContainerUrl och httpUrl är ömsesidigt uteslutande och en av dem måste anges.
blobPrefix	string	Blobprefixet som ska användas vid nedladdning av blobar från en Azure Storage container. Endast de blobar vars namn börjar med det angivna prefixet laddas ned. Egenskapen är endast giltig när autoStorageContainerName eller storageContainerUrl används. Det här prefixet kan vara ett partiellt filnamn eller en underkatalog. Om inget prefix har angetts laddas alla filer i containern ned.
fileMode	string	Attributet för filbehörighetsläge i oktalt format. Den här egenskapen gäller endast för filer som laddas ned till Linux-beräkningsnoder. Den ignoreras om den anges för en resourceFile som laddas ned till en Windows beräkningsnod. Om den här egenskapen inte har angetts för en Linux-beräkningsnod tillämpas standardvärdet 0770 på filen.
filePath	string	Platsen på beräkningsnoden som filen eller filerna ska laddas ned till i förhållande till aktivitetens arbetskatalog. Om egenskapen httpUrl anges krävs filePath och beskriver sökvägen som filen ska laddas ned till, inklusive filnamnet. Om egenskapen autoStorageContainerName eller storageContainerUrl anges är filePath valfritt och är den katalog som filerna ska laddas ned till. Om filePath används som en katalog behålls alla katalogstrukturer som redan är associerade med indata i sin helhet och läggs till i den angivna filePath-katalogen. Den angivna relativa sökvägen kan inte bryta sig ut från aktivitetens arbetskatalog (till exempel med hjälp av ..).
httpUrl	string	URL:en för filen som ska laddas ned. Egenskaperna autoStorageContainerName, storageContainerUrl och httpUrl är ömsesidigt uteslutande och en av dem måste anges. Om URL:en pekar på Azure Blob Storage måste den vara läsbar från beräkningsnoder. Det finns tre sätt att hämta en sådan URL för en blob i Azure Storage: inkludera en signatur för delad åtkomst (SAS) som beviljar läsbehörigheter för bloben, använda en hanterad identitet med läsbehörighet eller ange ACL för bloben eller dess container för att tillåta offentlig åtkomst.
identityReference	ComputeNodeIdentityReference	Referensen till den användartilldelade identitet som ska användas för att komma åt Azure Blob Storage som anges av storageContainerUrl eller httpUrl Referensen till en användartilldelad identitet som är associerad med batchpoolen som en beräkningsnod ska använda.
storageContainerUrl	string	URL:en för blobcontainern i Azure Blob Storage. Egenskaperna autoStorageContainerName, storageContainerUrl och httpUrl är ömsesidigt uteslutande och en av dem måste anges. Den här URL:en måste vara läsbar och listbar från beräkningsnoder. Det finns tre sätt att hämta en sådan URL för en container i Azure Storage: inkludera en signatur för delad åtkomst (SAS) som beviljar läs- och listbehörigheter för containern, använder en hanterad identitet med läs- och listbehörigheter eller anger ACL för containern så att den tillåter offentlig åtkomst.

StartTask

En aktivitet som körs när en nod ansluter till en pool i Azure Batch-tjänsten, eller när beräkningsnoden startas om eller omskapas.

Name	Type	Description
commandLine	string	Kommandoraden i StartTask. Kommandoraden körs inte under ett gränssnitt och kan därför inte dra nytta av gränssnittsfunktioner som expansion av miljövariabler. Om du vill dra nytta av sådana funktioner bör du anropa gränssnittet på kommandoraden, till exempel med hjälp av "cmd /c MyCommand" i Windows eller "/bin/sh -c MyCommand" i Linux. Om kommandoraden refererar till filsökvägar bör den använda en relativ sökväg (i förhållande till arbetskatalogen Uppgift) eller använda miljövariabeln som tillhandahålls av Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
containerSettings	TaskContainerSettings	Inställningarna för containern under vilken StartTask körs. När detta anges mappas alla kataloger rekursivt under AZ_BATCH_NODE_ROOT_DIR (roten för Azure Batch kataloger på noden) till containern, alla miljövariabler för aktivitet mappas till containern och kommandoraden Task körs i containern. Filer som skapas i containern utanför AZ_BATCH_NODE_ROOT_DIR kanske inte återspeglas på värddisken, vilket innebär att Api:er för Batch-filer inte kan komma åt dessa filer.
environmentSettings	EnvironmentSetting[]	En lista över miljövariabelinställningar för StartTask.
maxTaskRetryCount	integer	Det maximala antalet gånger som aktiviteten kan försökas igen. Batch-tjänsten försöker utföra en aktivitet igen om slutkoden inte är noll. Observera att det här värdet specifikt styr antalet återförsök. Batch-tjänsten provar uppgiften en gång och kan sedan försöka igen upp till den här gränsen. Om det maximala antalet återförsök till exempel är 3 försöker Batch aktiviteten upp till 4 gånger (ett första försök och 3 återförsök). Om det maximala antalet återförsök är 0 försöker Inte Batch-tjänsten uppgiften igen. Om det maximala antalet återförsök är -1 försöker Batch-tjänsten aktiviteten utan begränsning igen, men detta rekommenderas inte för en startaktivitet eller någon aktivitet. Standardvärdet är 0 (inga återförsök)
resourceFiles	ResourceFile[]	En lista över filer som Batch-tjänsten laddar ned till beräkningsnoden innan du kör kommandoraden. Det finns en maximal storlek för listan över resursfiler. När maxstorleken överskrids misslyckas begäran och svarsfelkoden är RequestEntityTooLarge. Om detta inträffar måste mängden ResourceFiles minskas i storlek. Detta kan uppnås med hjälp av .zip filer, programpaket eller Docker-containrar. Filer som anges under det här elementet finns i arbetskatalogen för aktiviteten.
userIdentity	UserIdentity	Användaridentiteten som StartTask körs under. Om den utelämnas körs aktiviteten som en icke-administrativ användare som är unik för aktiviteten.
waitForSuccess	boolean	Om Batch-tjänsten ska vänta tills StartTask har slutförts (d.v.s. avsluta med slutkod 0) innan du schemalägger aktiviteter på beräkningsnoden. Om true och StartTask misslyckas på en nod försöker Batch-tjänsten starta om StartTask upp till det maximala antalet återförsök (maxTaskRetryCount). Om aktiviteten fortfarande inte har slutförts efter alla återförsök markerar Batch-tjänsten noden som oanvändbar och schemalägger inte aktiviteter till den. Det här villkoret kan identifieras via information om beräkningsnodens tillstånd och felinformation. Om värdet är falskt väntar inte Batch-tjänsten på att StartTask ska slutföras. I det här fallet kan andra uppgifter börja köras på beräkningsnoden medan StartTask fortfarande körs. och även om StartTask misslyckas fortsätter nya aktiviteter att schemaläggas på beräkningsnoden. Standardvärdet är true.

StorageAccountType

Lagringskontotypen som ska användas för att skapa datadiskar.

Name	Type	Description
premium_lrs	string	Datadisken bör använda premium lokalt redundant lagring.
standard_lrs	string	Datadisken bör använda lokalt redundant standardlagring.

TaskContainerSettings

Containerinställningarna för en aktivitet.

Name	Type	Description
containerRunOptions	string	Ytterligare alternativ för kommandot container create. Dessa ytterligare alternativ anges som argument till kommandot "docker create", utöver de som styrs av Batch-tjänsten.
imageName	string	Avbildningen som ska användas för att skapa containern där aktiviteten ska köras. Det här är den fullständiga avbildningsreferensen, som skulle anges till "docker pull". Om ingen tagg anges som en del av avbildningsnamnet används taggen ":latest" som standard.
registry	ContainerRegistry	Det privata registret som innehåller containern Image. Den här inställningen kan utelämnas om den redan angavs när poolen skapades.
workingDirectory	ContainerWorkingDirectory	Platsen för containerns arbetskatalog för uppgift. Standardvärdet är "taskWorkingDirectory".

TaskSchedulingPolicy

Anger hur aktiviteter ska distribueras mellan beräkningsnoder.

Name	Type	Description
nodeFillType	ComputeNodeFillType	Hur uppgifter distribueras mellan beräkningsnoder i en pool. Om inget anges är standardvärdet utspritt.

UserAccount

Egenskaper som används för att skapa en användare som används för att köra uppgifter på en Azure Batch beräkningsnod.

Name	Type	Description
elevationLevel	ElevationLevel	Behörighetsnivån för användarkontot. Standardvärdet är nonAdmin.
linuxUserConfiguration	LinuxUserConfiguration	Den Linux-specifika användarkonfigurationen för användarkontot. Den här egenskapen ignoreras om den anges i en Windows pool. Om inget anges skapas användaren med standardalternativen.
name	string	Namnet på användarkontot.
password	string	Lösenordet för användarkontot.
windowsUserConfiguration	WindowsUserConfiguration	Den Windows specifika användarkonfigurationen för användarkontot. Den här egenskapen kan bara anges om användaren finns i en Windows pool. Om det inte anges och i en Windows pool skapas användaren med standardalternativen.

UserIdentity

Definitionen av den användaridentitet som aktiviteten körs under.

Name	Type	Description
autoUser	AutoUserSpecification	Den automatiska användare som aktiviteten körs under. Egenskaperna userName och autoUser är ömsesidigt uteslutande. du måste ange en men inte båda.
username	string	Namnet på den användaridentitet som aktiviteten körs under. Egenskaperna userName och autoUser är ömsesidigt uteslutande. du måste ange en men inte båda.

VirtualMachineConfiguration

Konfigurationen för beräkningsnoder i en pool baserat på Azure Virtual Machines-infrastrukturen.

Name	Type	Description
containerConfiguration	ContainerConfiguration	Containerkonfigurationen för poolen. Om detta anges utförs konfigurationen på varje beräkningsnod i poolen så att aktiviteter kan köras i containrar. Alla vanliga aktiviteter och Job Manager-uppgifter som körs på den här poolen måste ange egenskapen containerSettings och alla andra aktiviteter kan ange den.
dataDisks	DataDisk[]	Konfigurationen för datadiskar som är anslutna till beräkningsnoderna i poolen. Den här egenskapen måste anges om beräkningsnoderna i poolen måste ha tomma datadiskar anslutna till sig. Det går inte att uppdatera detta. Varje beräkningsnod får en egen disk (disken är inte en filresurs). Det går inte att ansluta befintliga diskar. Varje ansluten disk är tom. När beräkningsnoden tas bort från poolen tas även disken och alla data som är associerade med den bort. Disken är inte formaterad efter att den har anslutits, den måste formateras före användning – mer information finns i https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux och https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.
diskEncryptionConfiguration	DiskEncryptionConfiguration	Diskkrypteringskonfigurationen för poolen. Om det anges utförs kryptering på varje nod i poolen under nodetablering.
extensions	VMExtension[]	Tillägget för den virtuella datorn för poolen. Om det anges installeras tilläggen som nämns i den här konfigurationen på varje nod.
imageReference	ImageReference	En referens till Azure Virtual Machines Marketplace-avbildningen eller den anpassade avbildningen av den virtuella datorn som ska användas.
licenseType	string	Den typ av lokal licens som ska användas vid distribution av operativsystemet. Detta gäller endast avbildningar som innehåller Windows operativsystem och bör endast användas när du har giltiga lokala licenser för beräkningsnoderna som ska distribueras. Om detta utelämnas tillämpas ingen lokal licensrabatt. Värdena är: Windows_Server – Den lokala licensen gäller för Windows Server. Windows_Client – Den lokala licensen gäller för Windows Client.
nodeAgentSKUId	string	SKU:n för Batch Compute Node-agenten som ska etableras på beräkningsnoder i poolen. Batch Compute Node-agenten är ett program som körs på varje beräkningsnod i poolen och tillhandahåller kommando- och kontrollgränssnittet mellan beräkningsnoden och Batch-tjänsten. Det finns olika implementeringar av Compute Node-agenten, som kallas SKU:er, för olika operativsystem. Du måste ange en Compute Node-agent-SKU som matchar den valda avbildningsreferensen. Information om hur du hämtar listan över SKU:er för Compute Node-agenten som stöds tillsammans med deras lista över verifierade avbildningsreferenser finns i åtgärden "List supported Compute Node agent SKUs" (Lista över SKU:er för Beräkningsnodagent som stöds).
nodePlacementConfiguration	NodePlacementConfiguration	Nodplaceringskonfigurationen för poolen. Den här konfigurationen anger regler för hur noder i poolen ska allokeras fysiskt.
osDisk	OSDisk	Inställningar för den virtuella datorns operativsystemdisk.
windowsConfiguration	WindowsConfiguration	Windows operativsysteminställningar på den virtuella datorn. Den här egenskapen får inte anges om egenskapen imageReference anger en Linux OS-avbildning.

VMExtension

Konfigurationen för tillägg för virtuella datorer.

Name	Type	Description
autoUpgradeMinorVersion	boolean	Anger om tillägget ska använda en nyare delversion om en är tillgänglig vid distributionen. När tillägget har distribuerats uppgraderas dock inte mindre versioner om de inte distribueras om, även om den här egenskapen är inställd på true.
name	string	Namnet på tillägget för den virtuella datorn.
protectedSettings	object	Tillägget kan innehålla antingen protectedSettings eller protectedSettingsFromKeyVault eller inga skyddade inställningar alls.
provisionAfterExtensions	string[]	Samlingen med tilläggsnamn. Samling med tilläggsnamn varefter det här tillägget måste etableras.
publisher	string	Namnet på tilläggshanterarutgivaren.
settings	object	JSON-formaterade offentliga inställningar för tillägget.
type	string	Typ av tillägg.
typeHandlerVersion	string	Skripthanterarens version.

WindowsConfiguration

Windows operativsysteminställningar som ska tillämpas på den virtuella datorn.

Name	Type	Description
enableAutomaticUpdates	boolean	Om automatiska uppdateringar är aktiverade på den virtuella datorn. Om det utelämnas är standardvärdet sant.

WindowsUserConfiguration

Egenskaper som används för att skapa ett användarkonto på en Windows beräkningsnod.

Name	Type	Description
loginMode	LoginMode	Inloggningsläget för användaren Standardvärdet för VirtualMachineConfiguration Pools är "batch" och för CloudServiceConfiguration Pools är "interaktivt".