Job - Add
Lägger till ett jobb i det angivna kontot.
Batch-tjänsten stöder två sätt att styra det arbete som utförs som en del av ett jobb. I den första metoden anger användaren en Job Manager-uppgift. Batch-tjänsten startar den här uppgiften när den är redo att starta jobbet. Job Manager-aktiviteten styr alla andra aktiviteter som körs under det här jobbet med hjälp av aktivitets-API:erna. I den andra metoden styr användaren direkt körningen av Uppgifter under ett aktivt jobb med hjälp av aktivitets-API:erna. Observera också: När du namnger jobb 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}/jobs?api-version=2024-07-01.20.0
POST {batchUrl}/jobs?timeout={timeout}&api-version=2024-07-01.20.0
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
batch
|
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. Om värdet är större än 30 används standardvärdet i stället. |
Begärandehuvud
Media Types: "application/json; odata=minimalmetadata"
Name | Obligatorisk | Typ | 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 klient-request-id i svaret. |
|
ocp-date |
string date-time-rfc1123 |
Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det explicit om du anropar REST-API:et direkt. |
Begärandetext
Media Types: "application/json; odata=minimalmetadata"
Name | Obligatorisk | Typ | Description |
---|---|---|---|
id | True |
string |
En sträng som unikt identifierar jobbet i kontot. |
poolInfo | True |
Den pool där Batch-tjänsten kör jobbets uppgifter. |
|
allowTaskPreemption |
boolean |
Om uppgifter i det här jobbet kan föregripas av andra högprioriterade jobb |
|
commonEnvironmentSettings |
Listan över vanliga miljövariabler. Dessa miljövariabler har angetts för alla aktiviteter i jobbet (inklusive Jobbhanteraren, Jobbförberedelse och Jobbpubliceringsuppgifter). |
||
constraints |
Körningsbegränsningarna för ett jobb. |
||
displayName |
string |
Visningsnamnet för jobbet. |
|
jobManagerTask |
Information om en Job Manager-uppgift som ska startas när jobbet startas. |
||
jobPreparationTask |
Jobbförberedelseaktiviteten. |
||
jobReleaseTask |
Jobbpubliceringsaktiviteten. |
||
maxParallelTasks |
integer |
Det maximala antalet aktiviteter som kan köras parallellt för jobbet. |
|
metadata |
En lista över namn/värde-par som är associerade med jobbet som metadata. |
||
networkConfiguration |
Nätverkskonfigurationen för jobbet. |
||
onAllTasksComplete |
Den åtgärd som Batch-tjänsten ska vidta när alla uppgifter i jobbet är i slutfört tillstånd. |
||
onTaskFailure |
Den åtgärd som Batch-tjänsten ska vidta när en aktivitet i jobbet misslyckas. |
||
priority |
integer |
Jobbets prioritet. |
|
usesTaskDependencies |
boolean |
Om Uppgifter i jobbet kan definiera beroenden för varandra. Standardvärdet är falskt. |
Svar
Name | Typ | Description |
---|---|---|
201 Created |
Begäran till Batch-tjänsten lyckades. Sidhuvuden
|
|
Other Status Codes |
Felet från Batch-tjänsten. |
Säkerhet
azure_auth
Autentiseringskodflöde för Microsoft Entra OAuth 2.0
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | Personifiera ditt användarkonto |
Authorization
Typ:
apiKey
I:
header
Exempel
Add a basic job |
Add a complex job |
Add a basic job
Exempelbegäran
POST account.region.batch.azure.com/jobs?api-version=2024-07-01.20.0
{
"id": "jobId",
"priority": 0,
"poolInfo": {
"poolId": "poolId"
}
}
Exempelsvar
Add a complex job
Exempelbegäran
POST account.region.batch.azure.com/jobs?api-version=2024-07-01.20.0
{
"id": "jobId",
"priority": 100,
"constraints": {
"maxWallClockTime": "PT1H",
"maxTaskRetryCount": -1
},
"jobManagerTask": {
"id": "taskId",
"commandLine": "myprogram.exe",
"resourceFiles": [
{
"httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas",
"filePath": "myprogram.exe"
},
{
"storageContainerUrl": "http://mystorage1.blob.core.windows.net/data?sas",
"filePath": "datafolder"
}
],
"environmentSettings": [
{
"name": "myvariable",
"value": "myvalue"
}
],
"constraints": {
"maxWallClockTime": "PT1H",
"maxTaskRetryCount": 0,
"retentionTime": "PT1H"
},
"requiredSlots": 2,
"killJobOnCompletion": false,
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "admin"
}
},
"runExclusive": true
},
"poolInfo": {
"autoPoolSpecification": {
"autoPoolIdPrefix": "mypool",
"poolLifetimeOption": "job",
"pool": {
"vmSize": "STANDARD_D2S_V3",
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2016-datacenter-smalldisk",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.windows amd64",
"windowsConfiguration": {
"enableAutomaticUpdates": false
},
"nodePlacementConfiguration": {
"policy": "zonal"
}
},
"resizeTimeout": "PT15M",
"targetDedicatedNodes": 3,
"targetLowPriorityNodes": 0,
"taskSlotsPerNode": 2,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"enableAutoScale": false,
"enableInterNodeCommunication": true,
"startTask": {
"commandLine": "myprogram2.exe",
"resourceFiles": [
{
"httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas",
"filePath": "myprogram2.exe"
}
],
"environmentSettings": [
{
"name": "myvariable",
"value": "myvalue"
}
],
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "admin"
}
},
"maxTaskRetryCount": 2,
"waitForSuccess": true
},
"certificateReferences": [
{
"thumbprint": "0123456789abcdef0123456789abcdef01234567",
"thumbprintAlgorithm": "sha1",
"storeLocation": "localmachine",
"storeName": "Root",
"visibility": [
"task"
]
}
],
"metadata": [
{
"name": "myproperty",
"value": "myvalue"
}
],
"targetNodeCommunicationMode": "default"
}
}
},
"metadata": [
{
"name": "myproperty",
"value": "myvalue"
}
]
}
Exempelsvar
Definitioner
Name | Description |
---|---|
Access |
De Batch-resurser som token ger åtkomst till. |
Application |
En referens till ett paket som ska distribueras till beräkningsnoder. |
Authentication |
Inställningarna för en autentiseringstoken som aktiviteten kan använda för att utföra Batch-tjänståtgärder. |
Automatic |
De konfigurationsparametrar som används för att utföra automatisk operativsystemuppgradering. |
Auto |
Anger egenskaper för en tillfällig "automatisk pool". Batch-tjänsten skapar den här automatiska poolen när jobbet skickas. |
Auto |
Omfånget för den automatiska användaren |
Auto |
Anger parametrarna för den automatiska användare som kör en uppgift i Batch-tjänsten. |
Azure |
Information som används för att ansluta till en Azure Storage-container med blobfuse. |
Azure |
Information som används för att ansluta till en Azure Fileshare. |
Batch |
Ett felsvar som tagits emot från Azure Batch-tjänsten. |
Batch |
Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar. |
Caching |
Typ av cachelagring som ska aktiveras för disken. |
Certificate |
En referens till ett certifikat som ska installeras på beräkningsnoder i en pool. |
Certificate |
Platsen för certifikatarkivet på beräkningsnoden där certifikatet ska installeras. |
Certificate |
Vilka användarkonton på beräkningsnoden ska ha åtkomst till certifikatets privata data. |
CIFSMount |
Information som används för att ansluta till ett CIFS-filsystem. |
Compute |
Så här distribueras uppgifter mellan beräkningsnoder i en pool. |
Compute |
Referensen till en användartilldelad identitet som är associerad med Batch-poolen som en beräkningsnod ska använda. |
Container |
Konfigurationen för containeraktiverade pooler. |
Container |
Posten för sökvägen och monteringsläget som du vill montera i aktivitetscontainern. |
Container |
Sökvägarna som ska monteras på containeraktivitetens container. |
Container |
Ett privat containerregister. |
Container |
Den containerteknik som ska användas. |
Container |
Platsen för containerns arbetskatalog för uppgift. |
Data |
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 från en virtuell dator för att kunna använda dem. |
Diff |
Anger den tillfälliga diskplaceringen för operativsystemdisken för alla beräkningsnoder (VM) i poolen. |
Diff |
Anger tillfälliga diskinställningar för operativsystemdisken som används av beräkningsnoden (VM). |
Disk |
Diskkrypteringskonfigurationen som tillämpas på beräkningsnoder i poolen. Diskkrypteringskonfiguration stöds inte i Linux-pool som skapats med Azure Compute Gallery Image. |
Disk |
Listan över diskmål Batch Service krypterar på beräkningsnoden. |
Dynamic |
Omfånget för dynamisk vnet-tilldelning. |
Elevation |
Användarens höjdnivå. |
Environment |
En miljövariabel som ska anges för en aktivitetsprocess. |
Error |
Ett felmeddelande som togs emot i ett Azure Batch-felsvar. |
Http |
Ett HTTP-huvudnamn/värde-par |
Image |
En referens till en Azure Virtual Machines Marketplace-avbildning eller en Azure Compute Gallery-avbildning. Om du vill hämta listan över alla Azure Marketplace-avbildningsreferenser som verifierats av Azure Batch läser du åtgärden "Lista avbildningar som stöds". |
Inbound |
Slutpunktens protokoll. |
Inbound |
En inkommande NAT-pool som kan användas för att hantera specifika portar på beräkningsnoder i en Batch-pool externt. |
IPAddress |
Etableringstypen för offentliga IP-adresser för poolen. |
Job |
Ett Azure Batch-jobb att lägga till. |
Job |
Körningsbegränsningarna för ett jobb. |
Job |
Anger information om en Job Manager-uppgift. |
Job |
Nätverkskonfigurationen för jobbet. |
Job |
En jobbförberedelseaktivitet som ska köras före aktiviteter i jobbet på en viss beräkningsnod. |
Job |
En jobbversionsaktivitet som ska köras när jobbet har slutförts på en beräkningsnod där jobbet har körts. |
Linux |
Egenskaper som används för att skapa ett användarkonto på en Linux-beräkningsnod. |
Login |
Inloggningsläget för användaren |
Managed |
|
Metadata |
Ett namn/värde-par som är associerat med en Batch-tjänstresurs. |
Mount |
Filsystemet som ska monteras på varje nod. |
Network |
Nätverkskonfigurationen för en pool. |
Network |
En regel för nätverkssäkerhetsgrupp som ska tillämpas på en inkommande slutpunkt. |
Network |
Den åtgärd som ska vidtas för en angiven IP-adress, undernätsintervall eller tagg. |
NFSMount |
Information som används för att ansluta till ett NFS-filsystem. |
Node |
Avgör hur en pool kommunicerar med Batch-tjänsten. |
Node |
Konfiguration av nodplacering för en pool. |
Node |
Placeringsprincipen för allokering av noder i poolen. |
On |
Den åtgärd som Batch-tjänsten ska vidta när alla uppgifter i jobbet är i slutfört tillstånd. |
On |
Den åtgärd som Batch-tjänsten ska vidta när en aktivitet i jobbet misslyckas. |
OSDisk |
Inställningar för operativsystemets disk för beräkningsnoden (VM). |
Output |
En specifikation för att ladda upp filer från en Azure Batch Compute-nod till en annan plats när Batch-tjänsten har slutfört körningen av aktivitetsprocessen. |
Output |
Anger ett filuppladdningsmål i en Azure Blob Storage-container. |
Output |
Målet som en fil ska laddas upp till. |
Output |
De villkor under vilka en aktivitetsutdatafil eller uppsättning filer ska laddas upp. |
Output |
Information om en uppladdningsåtgärd för utdatafiler, inklusive under vilka villkor uppladdningen ska utföras. |
Pool |
Slutpunktskonfigurationen för en pool. |
Pool |
Anger hur ett jobb ska tilldelas till en pool. |
Pool |
Den minsta livslängden för skapade automatiska pooler och hur flera jobb enligt ett schema tilldelas till pooler. |
Pool |
Specifikation för att skapa en ny pool. |
Public |
Den offentliga IP-adresskonfigurationen för nätverkskonfigurationen för en pool. |
Resource |
En enda fil eller flera filer som ska laddas ned till en beräkningsnod. |
Rolling |
De konfigurationsparametrar som används vid löpande uppgradering. |
Security |
Anger EncryptionType för den hanterade disken. Den är inställd på VMGuestStateOnly för kryptering av bara VMGuestState-bloben och NonPersistedTPM för att inte bevara tillståndet för inbyggd programvara i VMGuestState-bloben. Obs: Det kan endast anges för konfidentiella virtuella datorer och krävs när du använder konfidentiella virtuella datorer. |
Security |
Anger säkerhetsprofilinställningarna för den virtuella datorn eller vm-skalningsuppsättningen. |
Security |
Anger SecurityType för den virtuella datorn. Det måste anges till ett angivet värde för att aktivera UefiSettings. |
Service |
Anger tjänstartefaktreferens-ID:t som används för att ange samma avbildningsversion för alla virtuella datorer i skalningsuppsättningen när du använder den senaste avbildningsversionen. |
Start |
En uppgift 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. |
Storage |
Lagringskontotypen som ska användas för att skapa datadiskar eller OS-diskar. |
Task |
Körningsbegränsningar som ska gälla för en aktivitet. |
Task |
Containerinställningarna för en aktivitet. |
Task |
Anger hur Aktiviteter ska distribueras mellan beräkningsnoder. |
Uefi |
Anger de säkerhetsinställningar som säker start och vTPM som används när den virtuella datorn skapas. |
Upgrade |
Anger läget för en uppgradering till virtuella datorer i skalningsuppsättningen. |
Upgrade |
Beskriver en uppgraderingsprincip – automatisk, manuell eller rullande. |
User |
Egenskaper som används för att skapa en användare som används för att köra uppgifter på en Azure Batch Compute-nod. |
User |
Definitionen av användaridentiteten som aktiviteten körs under. |
Virtual |
Konfigurationen för beräkningsnoder i en pool baserat på Azure Virtual Machines-infrastrukturen. |
VMDisk |
Anger säkerhetsprofilinställningarna för den hanterade disken. Obs: Det kan bara anges för konfidentiella virtuella datorer och krävs när du använder konfidentiella virtuella datorer. |
VMExtension |
Konfigurationen för tillägg för virtuella datorer. |
Windows |
Inställningar för Windows-operativsystem som ska tillämpas på den virtuella datorn. |
Windows |
Egenskaper som används för att skapa ett användarkonto på en Windows-beräkningsnod. |
AccessScope
De Batch-resurser som token ger åtkomst till.
Name | Typ | Description |
---|---|---|
job |
string |
Ger åtkomst till att utföra alla åtgärder i jobbet som innehåller uppgiften. |
ApplicationPackageReference
En referens till ett paket som ska distribueras till beräkningsnoder.
Name | Typ | Description |
---|---|---|
applicationId |
string |
ID:t för programmet som ska distribueras. |
version |
string |
Den version av programmet som ska distribueras. Om den utelämnas distribueras standardversionen. |
AuthenticationTokenSettings
Inställningarna för en autentiseringstoken som aktiviteten kan använda för att utföra Batch-tjänståtgärder.
Name | Typ | Description |
---|---|---|
access |
De Batch-resurser som token ger åtkomst till. |
AutomaticOSUpgradePolicy
De konfigurationsparametrar som används för att utföra automatisk operativsystemuppgradering.
Name | Typ | Description |
---|---|---|
disableAutomaticRollback |
boolean |
Om funktionen för återställning av os-avbildning ska inaktiveras. |
enableAutomaticOSUpgrade |
boolean |
Anger om OS-uppgraderingar automatiskt ska tillämpas på skalningsuppsättningsinstanser på ett löpande sätt när en nyare version av OS-avbildningen blir tillgänglig. |
osRollingUpgradeDeferral |
boolean |
Skjut upp OS-uppgraderingar på TV-datorerna om de kör uppgifter. |
useRollingUpgradePolicy |
boolean |
Anger om principen för löpande uppgradering ska användas under automatisk operativsystemuppgradering. Automatisk os-uppgradering återgår till standardprincipen om ingen princip har definierats på VMSS. |
AutoPoolSpecification
Anger egenskaper för en tillfällig "automatisk pool". Batch-tjänsten skapar den här automatiska poolen när jobbet skickas.
Name | Typ | Description |
---|---|---|
autoPoolIdPrefix |
string |
Ett prefix som ska läggas till i den unika identifieraren när en pool skapas automatiskt. |
keepAlive |
boolean |
Om du vill hålla en automatisk pool vid liv när dess livslängd har upphört att gälla. |
pool |
Poolspecifikationen för den automatiska poolen. |
|
poolLifetimeOption |
Den minsta livslängden för skapade automatiska pooler och hur flera jobb enligt ett schema tilldelas till pooler. |
AutoUserScope
Omfånget för den automatiska användaren
Name | Typ | 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 uppgift i Batch-tjänsten.
Name | Typ | Description |
---|---|---|
elevationLevel |
Den automatiska användarens höjdnivå. |
|
scope |
Omfånget för den automatiska användaren |
AzureBlobFileSystemConfiguration
Information som används för att ansluta till en Azure Storage-container med blobfuse.
Name | Typ | Description |
---|---|---|
accountKey |
string |
Azure Storage-kontonyckeln. |
accountName |
string |
Namnet på Azure Storage-kontot. |
blobfuseOptions |
string |
Ytterligare kommandoradsalternativ för att skicka till monteringskommandot. |
containerName |
string |
Namnet på Azure Blob Storage-containern. |
identityReference |
Referensen till den användartilldelade identitet som ska användas för att komma åt containerName |
|
relativeMountPath |
string |
Den relativa sökvägen på beräkningsnoden där filsystemet ska monteras |
sasKey |
string |
Sas-token för Azure Storage. |
AzureFileShareConfiguration
Information som används för att ansluta till en Azure Fileshare.
Name | Typ | Description |
---|---|---|
accountKey |
string |
Azure Storage-kontonyckeln. |
accountName |
string |
Namnet på Azure Storage-kontot. |
azureFileUrl |
string |
Url:en för Azure Files. |
mountOptions |
string |
Ytterligare kommandoradsalternativ för att skicka till monteringskommandot. |
relativeMountPath |
string |
Den relativa sökvägen på beräkningsnoden där filsystemet ska monteras |
BatchError
Ett felsvar som tagits emot från Azure Batch-tjänsten.
Name | Typ | Description |
---|---|---|
code |
string |
En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt. |
message |
Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt. |
|
values |
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 | Typ | Description |
---|---|---|
key |
string |
En identifierare som anger innebörden av egenskapen Value. |
value |
string |
Den ytterligare information som ingår i felsvaret. |
CachingType
Typ av cachelagring som ska aktiveras för disken.
Name | Typ | 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 | Typ | Description |
---|---|---|
storeLocation |
Platsen för certifikatarkivet på beräkningsnoden där certifikatet ska installeras. |
|
storeName |
string |
Namnet på certifikatarkivet på beräkningsnoden som certifikatet ska installeras i. |
thumbprint |
string |
Certifikatets tumavtryck. |
thumbprintAlgorithm |
string |
Algoritmen som tumavtrycket är associerat med. Det här måste vara sha1. |
visibility |
Vilka användarkonton på beräkningsnoden ska ha åtkomst till certifikatets privata data. |
CertificateStoreLocation
Platsen för certifikatarkivet på beräkningsnoden där certifikatet ska installeras.
Name | Typ | Description |
---|---|---|
currentuser |
string |
Certifikat ska installeras i CurrentUser-certifikatarkivet. |
localmachine |
string |
Certifikat ska installeras i LocalMachine-certifikatarkivet. |
CertificateVisibility
Vilka användarkonton på beräkningsnoden ska ha åtkomst till certifikatets privata data.
Name | Typ | Description |
---|---|---|
remoteuser |
string |
Certifikatet ska vara synligt för användarkontona under vilka användare fjärransluter till beräkningsnoden. |
starttask |
string |
Certifikatet ska vara synligt för användarkontot där StartTask körs. Observera att om AutoUser-omfånget är Pool för både StartTask och en aktivitet visas även det här certifikatet för aktiviteten. |
task |
string |
Certifikatet ska vara synligt för användarkontona under vilka Jobbaktiviteter körs. |
CIFSMountConfiguration
Information som används för att ansluta till ett CIFS-filsystem.
Name | Typ | Description |
---|---|---|
mountOptions |
string |
Ytterligare kommandoradsalternativ för att skicka till monteringskommandot. |
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 |
source |
string |
URI:n för filsystemet som ska monteras. |
username |
string |
Användaren som ska användas för autentisering mot CIFS-filsystemet. |
ComputeNodeFillType
Så här distribueras uppgifter mellan beräkningsnoder i en pool.
Name | Typ | Description |
---|---|---|
pack |
string |
Så många aktiviteter som möjligt (taskSlotsPerNode) ska 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 Batch-poolen som en beräkningsnod ska använda.
Name | Typ | Description |
---|---|---|
resourceId |
string |
ARM-resurs-ID för den användartilldelade identiteten. |
ContainerConfiguration
Konfigurationen för containeraktiverade pooler.
Name | Typ | Description |
---|---|---|
containerImageNames |
string[] |
Samlingen med containeravbildningsnamn. |
containerRegistries |
Ytterligare privata register från vilka containrar kan hämtas. |
|
type |
Den containerteknik som ska användas. |
ContainerHostBatchBindMountEntry
Posten för sökvägen och monteringsläget som du vill montera i aktivitetscontainern.
Name | Typ | Description |
---|---|---|
isReadOnly |
boolean |
Montera den här källsökvägen som skrivskyddat läge eller inte. Standardvärdet är falskt (läs-/skrivläge). |
source |
Sökvägen som monteras på containerkund kan välja. |
ContainerHostDataPath
Sökvägarna som ska monteras på containeraktivitetens container.
Name | Typ | Description |
---|---|---|
Applications |
string |
Programsökvägen. |
JobPrep |
string |
Jobbförberedelseaktivitetssökvägen. |
Shared |
string |
Sökvägen för uppgift för flera instanser att dela sina filer. |
Startup |
string |
Sökvägen för startaktiviteten. |
Task |
string |
Aktivitetssökvägen. |
VfsMounts |
string |
Sökvägen innehåller alla virtuella filsystem som är monterade på den här noden. |
ContainerRegistry
Ett privat containerregister.
Name | Typ | Description |
---|---|---|
identityReference |
Referensen till den användartilldelade identitet som ska användas för att komma åt ett Azure Container Registry i stället för användarnamn och lösenord. |
|
password |
string |
Lösenordet för att logga in på registerservern. |
registryServer |
string |
Registrets URL. |
username |
string |
Användarnamnet för att logga in på registerservern. |
ContainerType
Den containerteknik som ska användas.
Name | Typ | Description |
---|---|---|
criCompatible |
string |
En CRI-baserad teknik kommer att användas för att starta containrarna. |
dockerCompatible |
string |
En Docker-kompatibel containerteknik används för att starta containrarna. |
ContainerWorkingDirectory
Platsen för containerns arbetskatalog för uppgift.
Name | Typ | Description |
---|---|---|
containerImageDefault |
string |
Använd arbetskatalogen som definierats i containern Image. Se upp för att den här katalogen inte innehåller de resursfiler som laddats ned av Batch. |
taskWorkingDirectory |
string |
Använd standardarbetskatalogen för Batch-tjänsten, som innehåller aktivitetsresursfilerna 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 från en virtuell dator för att kunna använda dem.
Name | Typ | Description |
---|---|---|
caching |
Den typ av cachelagring som ska aktiveras för datadiskarna. |
|
diskSizeGB |
integer |
Den ursprungliga diskstorleken i gigabyte. |
lun |
integer |
Det logiska enhetsnumret. |
storageAccountType |
Den lagringskontotyp som ska användas för datadisken. |
DiffDiskPlacement
Anger den tillfälliga diskplaceringen för operativsystemdisken för alla beräkningsnoder (VM) i poolen.
Name | Typ | Description |
---|---|---|
CacheDisk |
string |
Den tillfälliga OS-disken lagras i den virtuella datorns cacheminne. |
DiffDiskSettings
Anger tillfälliga diskinställningar för operativsystemdisken som används av beräkningsnoden (VM).
Name | Typ | Description |
---|---|---|
placement |
Anger den tillfälliga diskplaceringen för operativsystemdisken för alla virtuella datorer i poolen. |
DiskEncryptionConfiguration
Diskkrypteringskonfigurationen som tillämpas på beräkningsnoder i poolen. Diskkrypteringskonfiguration stöds inte i Linux-pool som skapats med Azure Compute Gallery Image.
Name | Typ | Description |
---|---|---|
targets |
Listan över diskmål Batch Service krypterar på beräkningsnoden. |
DiskEncryptionTarget
Listan över diskmål Batch Service krypterar på beräkningsnoden.
Name | Typ | Description |
---|---|---|
osdisk |
string |
OS-disken på beräkningsnoden är krypterad. |
temporarydisk |
string |
Den tillfälliga disken på beräkningsnoden krypteras. I Linux gäller den här krypteringen för andra partitioner (till exempel de på monterade datadiskar) när kryptering sker vid start. |
DynamicVNetAssignmentScope
Omfånget för dynamisk vnet-tilldelning.
Name | Typ | Description |
---|---|---|
job |
string |
Dynamisk VNet-tilldelning görs per jobb. |
none |
string |
Ingen dynamisk VNet-tilldelning är aktiverad. |
ElevationLevel
Användarens höjdnivå.
Name | Typ | Description |
---|---|---|
admin |
string |
Användaren är en användare med förhöjd åtkomst och fungerar med fullständig administratörsbehörighet. |
nonadmin |
string |
Användaren är en standardanvändare utan förhöjd åtkomst. |
EnvironmentSetting
En miljövariabel som ska anges för en aktivitetsprocess.
Name | Typ | 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 | Typ | Description |
---|---|---|
lang |
string |
Språkkoden för felmeddelandet |
value |
string |
Texten i meddelandet. |
HttpHeader
Ett HTTP-huvudnamn/värde-par
Name | Typ | Description |
---|---|---|
name |
string |
Det skiftlägeskänsliga namnet på rubriken som ska användas vid uppladdning av utdatafiler |
value |
string |
Värdet för rubriken som ska användas vid uppladdning av utdatafiler |
ImageReference
En referens till en Azure Virtual Machines Marketplace-avbildning eller en Azure Compute Gallery-avbildning. Om du vill hämta listan över alla Azure Marketplace-avbildningsreferenser som verifierats av Azure Batch läser du åtgärden "Lista avbildningar som stöds".
Name | Typ | Description |
---|---|---|
communityGalleryImageId |
string |
Unik identifierare för communitygalleribilden |
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 Image. |
publisher |
string |
Utgivaren av Azure Virtual Machines Marketplace Image. |
sharedGalleryImageId |
string |
Unik identifierare för den delade galleribilden |
sku |
string |
SKU:n för Azure Virtual Machines Marketplace-avbildningen. |
version |
string |
Versionen av Azure Virtual Machines Marketplace-avbildningen. |
virtualMachineImageId |
string |
ARM-resursidentifieraren för Azure Compute Gallery Image. Beräkningsnoder i poolen skapas med det här avbildnings-ID:t. Det här är formuläret /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 vara standard för den senaste avbildningsversionen. |
InboundEndpointProtocol
Slutpunktens protokoll.
Name | Typ | 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 hantera specifika portar på beräkningsnoder i en Batch-pool externt.
Name | Typ | Description |
---|---|---|
backendPort |
integer |
Portnumret på beräkningsnoden. |
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. |
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. |
name |
string |
Namnet på slutpunkten. |
networkSecurityGroupRules |
En lista över regler för nätverkssäkerhetsgrupper som ska tillämpas på slutpunkten. |
|
protocol |
Slutpunktens protokoll. |
IPAddressProvisioningType
Etableringstypen för offentliga IP-adresser för poolen.
Name | Typ | 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. |
JobAddParameter
Ett Azure Batch-jobb att lägga till.
Name | Typ | Standardvärde | Description |
---|---|---|---|
allowTaskPreemption |
boolean |
Om uppgifter i det här jobbet kan föregripas av andra högprioriterade jobb |
|
commonEnvironmentSettings |
Listan över vanliga miljövariabler. Dessa miljövariabler har angetts för alla aktiviteter i jobbet (inklusive Jobbhanteraren, Jobbförberedelse och Jobbpubliceringsuppgifter). |
||
constraints |
Körningsbegränsningarna för ett jobb. |
||
displayName |
string |
Visningsnamnet för jobbet. |
|
id |
string |
En sträng som unikt identifierar jobbet i kontot. |
|
jobManagerTask |
Information om en Job Manager-uppgift som ska startas när jobbet startas. |
||
jobPreparationTask |
Jobbförberedelseaktiviteten. |
||
jobReleaseTask |
Jobbpubliceringsaktiviteten. |
||
maxParallelTasks |
integer |
-1 |
Det maximala antalet aktiviteter som kan köras parallellt för jobbet. |
metadata |
En lista över namn/värde-par som är associerade med jobbet som metadata. |
||
networkConfiguration |
Nätverkskonfigurationen för jobbet. |
||
onAllTasksComplete |
Den åtgärd som Batch-tjänsten ska vidta när alla uppgifter i jobbet är i slutfört tillstånd. |
||
onTaskFailure |
Den åtgärd som Batch-tjänsten ska vidta när en aktivitet i jobbet misslyckas. |
||
poolInfo |
Den pool där Batch-tjänsten kör jobbets uppgifter. |
||
priority |
integer |
Jobbets prioritet. |
|
usesTaskDependencies |
boolean |
Om Uppgifter i jobbet kan definiera beroenden för varandra. Standardvärdet är falskt. |
JobConstraints
Körningsbegränsningarna för ett jobb.
Name | Typ | Description |
---|---|---|
maxTaskRetryCount |
integer |
Det maximala antalet gånger varje aktivitet kan göras om. Batch-tjänsten försöker utföra en aktivitet igen om slutkoden inte är noll. |
maxWallClockTime |
string |
Den maximala förflutna tiden som jobbet kan köras, mätt från den tidpunkt då jobbet skapas. |
JobManagerTask
Anger information om en Job Manager-uppgift.
Name | Typ | Description |
---|---|---|
allowLowPriorityNode |
boolean |
Om Job Manager-aktiviteten kan köras på en skalningsnod med oanvänd kapacitet/låg prioritet. |
applicationPackageReferences |
En lista över programpaket som Batch-tjänsten distribuerar till beräkningsnoden innan kommandoraden körs. |
|
authenticationTokenSettings |
Inställningarna för en autentiseringstoken som aktiviteten kan använda för att utföra Batch-tjänståtgärder. |
|
commandLine |
string |
Kommandoraden för Job Manager-uppgiften. |
constraints |
Begränsningar som gäller för Job Manager-aktiviteten. |
|
containerSettings |
Inställningarna för containern under vilken Job Manager-aktiviteten körs. |
|
displayName |
string |
Visningsnamnet för Job Manager-aktiviteten. |
environmentSettings |
En lista över miljövariabelinställningar för Job Manager-aktiviteten. |
|
id |
string |
En sträng som unikt identifierar jobbhanterarens uppgift i jobbet. |
killJobOnCompletion |
boolean |
Om slutförandet av Job Manager-uppgiften innebär att hela jobbet har slutförts. |
outputFiles |
En lista över filer som Batch-tjänsten laddar upp från beräkningsnoden när kommandoraden har körts. |
|
requiredSlots |
integer |
Antalet schemaläggningsplatser som aktiviteten kräver för att köras. |
resourceFiles |
En lista över filer som Batch-tjänsten laddar ned till beräkningsnoden innan du kör kommandoraden. |
|
runExclusive |
boolean |
Om Job Manager-aktiviteten kräver exklusiv användning av beräkningsnoden där den körs. |
userIdentity |
Användaridentiteten som Jobbhanterarens uppgift körs under. |
JobNetworkConfiguration
Nätverkskonfigurationen för jobbet.
Name | Typ | Description |
---|---|---|
skipWithdrawFromVNet |
boolean |
Om du vill dra tillbaka beräkningsnoder från det virtuella nätverket till DNC när jobbet avslutas eller tas bort. |
subnetId |
string |
ARM-resursidentifieraren för det virtuella nätverksundernätet som beräkningsnoder som kör aktiviteter från jobbet ansluter under aktivitetens varaktighet. |
JobPreparationTask
En jobbförberedelseaktivitet som ska köras före aktiviteter i jobbet på en viss beräkningsnod.
Name | Typ | Description |
---|---|---|
commandLine |
string |
Kommandoraden för jobbförberedelseaktiviteten. |
constraints |
Begränsningar som gäller för jobbförberedelseaktiviteten. |
|
containerSettings |
Inställningarna för containern under vilken jobbförberedelseaktiviteten körs. |
|
environmentSettings |
En lista över miljövariabelinställningar för jobbförberedelseaktiviteten. |
|
id |
string |
En sträng som unikt identifierar jobbförberedelseaktiviteten i jobbet. |
rerunOnNodeRebootAfterSuccess |
boolean |
Om Batch-tjänsten ska köra jobbförberedelseaktiviteten igen när en beräkningsnod startas om. |
resourceFiles |
En lista över filer som Batch-tjänsten laddar ned till beräkningsnoden innan du kör kommandoraden. |
|
userIdentity |
Användaridentiteten under vilken jobbförberedelseaktiviteten körs. |
|
waitForSuccess |
boolean |
Om Batch-tjänsten ska vänta tills jobbförberedelseaktiviteten har slutförts innan du schemalägger andra uppgifter i jobbet på beräkningsnoden. En jobbförberedelseaktivitet har slutförts om den avslutas med slutkod 0. |
JobReleaseTask
En jobbversionsaktivitet som ska köras när jobbet har slutförts på en beräkningsnod där jobbet har körts.
Name | Typ | Description |
---|---|---|
commandLine |
string |
Kommandoraden för jobbpubliceringsaktiviteten. |
containerSettings |
Inställningarna för containern under vilken jobbpubliceringsaktiviteten körs. |
|
environmentSettings |
En lista över miljövariabelinställningar för jobbpubliceringsaktiviteten. |
|
id |
string |
En sträng som unikt identifierar jobbfrigöringsaktiviteten i jobbet. |
maxWallClockTime |
string |
Den maximala förflutna tiden som jobbfrigöringsaktiviteten kan köras på en viss beräkningsnod, mätt från den tidpunkt då aktiviteten startar. Om aktiviteten inte slutförs inom tidsgränsen avslutar Batch-tjänsten den. Standardvärdet är 15 minuter. Du kanske inte anger en tidsgräns som är längre än 15 minuter. Om du gör det avvisar Batch-tjänsten det med ett fel. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran). |
resourceFiles |
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 requestEntityTooLarge. Om detta inträffar måste samlingen av ResourceFiles minskas i storlek. Detta kan uppnås med hjälp av .zip filer, programpaket eller Docker-containrar. |
|
retentionTime |
string |
Den minsta tiden för att behålla aktivitetskatalogen för jobbpubliceringsaktiviteten på beräkningsnoden. Efter den här tiden kan Batch-tjänsten ta bort aktivitetskatalogen och allt dess innehåll. |
userIdentity |
Användaridentiteten som jobbfrigöringsaktiviteten körs under. |
LinuxUserConfiguration
Egenskaper som används för att skapa ett användarkonto på en Linux-beräkningsnod.
Name | Typ | Description |
---|---|---|
gid |
integer |
Grupp-ID för användarkontot. |
sshPrivateKey |
string |
Den privata SSH-nyckeln för användarkontot. |
uid |
integer |
Användar-ID för användarkontot. |
LoginMode
Inloggningsläget för användaren
Name | Typ | 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 i Windows-pooler. Om det här alternativet används med en upphöjd användaridentitet i en Windows-pool utökas inte användarsessionen såvida inte programmet som körs av kommandoraden Aktivitet har konfigurerats för att alltid kräva administratörsbehörighet eller att alltid kräva maximal behörighet. |
ManagedDisk
Name | Typ | Description |
---|---|---|
securityProfile |
Anger säkerhetsprofilinställningarna för den hanterade disken. |
|
storageAccountType |
Lagringskontotypen för hanterad disk. |
MetadataItem
Ett namn/värde-par som är associerat med en Batch-tjänstresurs.
Name | Typ | Description |
---|---|---|
name |
string |
Namnet på metadataobjektet. |
value |
string |
Värdet för metadataobjektet. |
MountConfiguration
Filsystemet som ska monteras på varje nod.
Name | Typ | Description |
---|---|---|
azureBlobFileSystemConfiguration |
Azure Storage-containern som ska monteras med blob-FUSE på varje nod. |
|
azureFileShareConfiguration |
Den Azure-filresurs som ska monteras på varje nod. |
|
cifsMountConfiguration |
CIFS/SMB-filsystemet som ska monteras på varje nod. |
|
nfsMountConfiguration |
NFS-filsystemet som ska monteras på varje nod. |
NetworkConfiguration
Nätverkskonfigurationen för en pool.
Name | Typ | Description |
---|---|---|
dynamicVNetAssignmentScope |
Omfånget för dynamisk vnet-tilldelning. |
|
enableAcceleratedNetworking |
boolean |
Om den här poolen ska aktivera accelererat nätverk. |
endpointConfiguration |
Konfigurationen för slutpunkter på beräkningsnoder i Batch-poolen. |
|
publicIPAddressConfiguration |
Den offentliga IPAddress-konfigurationen för beräkningsnoder i Batch-poolen. |
|
subnetId |
string |
ARM-resursidentifieraren för det virtuella nätverksundernätet som poolens beräkningsnoder ansluter till. Det här är formuläret /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. |
NetworkSecurityGroupRule
En regel för nätverkssäkerhetsgrupp som ska tillämpas på en inkommande slutpunkt.
Name | Typ | Description |
---|---|---|
access |
Den åtgärd som ska vidtas för en angiven IP-adress, undernätsintervall eller tagg. |
|
priority |
integer |
Prioriteten för den här regeln. |
sourceAddressPrefix |
string |
Källadressprefixet eller taggen som ska matchas för regeln. |
sourcePortRanges |
string[] |
Källportintervallen som ska matchas för regeln. |
NetworkSecurityGroupRuleAccess
Den åtgärd som ska vidtas för en angiven IP-adress, undernätsintervall eller tagg.
Name | Typ | Description |
---|---|---|
allow |
string |
Tillåt åtkomst. |
deny |
string |
Neka åtkomst. |
NFSMountConfiguration
Information som används för att ansluta till ett NFS-filsystem.
Name | Typ | Description |
---|---|---|
mountOptions |
string |
Ytterligare kommandoradsalternativ för att skicka till monteringskommandot. |
relativeMountPath |
string |
Den relativa sökvägen på beräkningsnoden där filsystemet ska monteras |
source |
string |
URI:n för filsystemet som ska monteras. |
NodeCommunicationMode
Avgör hur en pool kommunicerar med Batch-tjänsten.
Name | Typ | Description |
---|---|---|
classic |
string |
Noder som använder det klassiska kommunikationsläget kräver inkommande TCP-kommunikation på portarna 29876 och 29877 från "BatchNodeManagement. {region}"-tjänsttagg och utgående TCP-kommunikation på port 443 till "Storage.region" och "BatchNodeManagement. {region}" tjänsttaggar. |
default |
string |
Nodkommunikationsläget anges automatiskt av Batch-tjänsten. |
simplified |
string |
Noder som använder det förenklade kommunikationsläget kräver utgående TCP-kommunikation på port 443 till "BatchNodeManagement. {region}" tjänsttagg. Inga öppna inkommande portar krävs. |
NodePlacementConfiguration
Konfiguration av nodplacering för en pool.
Name | Typ | Description |
---|---|---|
policy |
Principtyp för nodplacering i Batch-pooler. |
NodePlacementPolicyType
Placeringsprincipen för allokering av noder i poolen.
Name | Typ | 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. |
OnAllTasksComplete
Den åtgärd som Batch-tjänsten ska vidta när alla uppgifter i jobbet är i slutfört tillstånd.
Name | Typ | Description |
---|---|---|
noaction |
string |
Gör ingenting. Jobbet förblir aktivt om det inte avslutas eller inaktiveras på något annat sätt. |
terminatejob |
string |
Avsluta jobbet. Jobbets terminateReason är inställt på "AllTasksComplete". |
OnTaskFailure
Den åtgärd som Batch-tjänsten ska vidta när en aktivitet i jobbet misslyckas.
Name | Typ | Description |
---|---|---|
noaction |
string |
Gör ingenting. Jobbet förblir aktivt om det inte avslutas eller inaktiveras på något annat sätt. |
performexitoptionsjobaction |
string |
Vidta åtgärden som är associerad med villkoret Aktivitetsavslut i aktivitetens exitConditions-samling. (Detta kan fortfarande leda till att inga åtgärder vidtas, om det är vad uppgiften anger.) |
OSDisk
Inställningar för operativsystemets disk för beräkningsnoden (VM).
Name | Typ | Description |
---|---|---|
caching |
Anger cachelagringskraven. Möjliga värden är: None, ReadOnly, ReadWrite. Standardvärdena är: Ingen för standardlagring. ReadOnly för Premium Storage. |
|
diskSizeGB |
integer |
Den ursprungliga diskstorleken i GB när du skapar en ny OS-disk. |
ephemeralOSDiskSettings |
Anger tillfälliga diskinställningar för operativsystemdisken som används av beräkningsnoden (VM). |
|
managedDisk |
Parametrarna för hanterade diskar. |
|
writeAcceleratorEnabled |
boolean |
Anger om writeAccelerator ska aktiveras eller inaktiveras på disken. |
OutputFile
En specifikation för att ladda upp filer från en Azure Batch Compute-nod till en annan plats när Batch-tjänsten har slutfört körningen av aktivitetsprocessen.
Name | Typ | Description |
---|---|---|
destination |
Målet för utdatafilerna. |
|
filePattern |
string |
Ett mönster som anger vilka filer som ska laddas upp. |
uploadOptions |
Ytterligare alternativ för uppladdningsåtgärden, inklusive under vilka villkor som ska utföra uppladdningen. |
OutputFileBlobContainerDestination
Anger ett filuppladdningsmål i en Azure Blob Storage-container.
Name | Typ | Description |
---|---|---|
containerUrl |
string |
URL:en för containern i Azure Blob Storage som filen eller filerna ska laddas upp till. |
identityReference |
Referensen till den användartilldelade identitet som ska användas för åtkomst till Azure Blob Storage som anges av containerUrl |
|
path |
string |
Målbloben eller den virtuella katalogen i Azure Storage-containern. |
uploadHeaders |
En lista över namn/värde-par för rubriker som ska användas vid uppladdning av utdatafiler |
OutputFileDestination
Målet som en fil ska laddas upp till.
Name | Typ | Description |
---|---|---|
container |
En plats i Azure Blob Storage som filer laddas upp till. |
OutputFileUploadCondition
De villkor under vilka en aktivitetsutdatafil eller uppsättning filer ska laddas upp.
Name | Typ | Description |
---|---|---|
taskcompletion |
string |
Ladda upp filen eller filerna efter att aktivitetsprocessen har avslutats, oavsett vilken slutkod det var. |
taskfailure |
string |
Ladda upp filen eller filerna först när aktivitetsprocessen avslutas med en icke-nollavslutskod. |
tasksuccess |
string |
Ladda upp filen eller filerna först när aktivitetsprocessen avslutas med en slutkod på 0. |
OutputFileUploadOptions
Information om en uppladdningsåtgärd för utdatafiler, inklusive under vilka villkor uppladdningen ska utföras.
Name | Typ | Description |
---|---|---|
uploadCondition |
De villkor under vilka aktivitetsutdatafilen eller uppsättningen filer ska laddas upp. |
PoolEndpointConfiguration
Slutpunktskonfigurationen för en pool.
Name | Typ | Description |
---|---|---|
inboundNATPools |
En lista över inkommande NAT-pooler som kan användas för att hantera specifika portar på en enskild beräkningsnod externt. |
PoolInformation
Anger hur ett jobb ska tilldelas till en pool.
Name | Typ | Description |
---|---|---|
autoPoolSpecification |
Egenskaper för en tillfällig "automatisk pool". Batch-tjänsten skapar den här automatiska poolen när jobbet skickas. |
|
poolId |
string |
ID för en befintlig pool. Alla uppgifter i jobbet körs på den angivna poolen. |
PoolLifetimeOption
Den minsta livslängden för skapade automatiska pooler och hur flera jobb enligt ett schema tilldelas till pooler.
Name | Typ | Description |
---|---|---|
job |
string |
Poolen finns under hela jobbets livslängd som den är dedikerad till. Batch-tjänsten skapar poolen när den skapar jobbet. Om alternativet "jobb" tillämpas på ett jobbschema skapar Batch-tjänsten en ny automatisk pool för varje jobb som skapas enligt schemat. |
jobschedule |
string |
Poolen finns under hela jobbschemat. Batch-tjänsten skapar poolen när den skapar det första jobbet enligt schemat. Du kan endast använda det här alternativet för jobbscheman, inte jobb. |
PoolSpecification
Specifikation för att skapa en ny pool.
Name | Typ | Description |
---|---|---|
applicationPackageReferences |
Listan över paket som ska installeras på varje beräkningsnod i poolen. |
|
autoScaleEvaluationInterval |
string |
Tidsintervallet då poolstorleken ska justeras automatiskt enligt autoskalningsformeln. |
autoScaleFormula |
string |
Formeln för önskat antal beräkningsnoder i poolen. |
certificateReferences |
En lista över certifikat som ska installeras på varje beräkningsnod i poolen. Varning! Den här egenskapen är inaktuell och tas bort efter februari 2024. Använd Azure KeyVault-tillägget i stället. |
|
displayName |
string |
Visningsnamnet för poolen. |
enableAutoScale |
boolean |
Om poolstorleken ska justeras automatiskt över tid. |
enableInterNodeCommunication |
boolean |
Om poolen tillåter direkt kommunikation mellan beräkningsnoder. |
metadata |
En lista över namn/värde-par som är associerade med poolen som metadata. |
|
mountConfiguration |
En lista över filsystem som ska monteras på varje nod i poolen. |
|
networkConfiguration |
Nätverkskonfigurationen för poolen. |
|
resizeTimeout |
string |
Tidsgränsen för allokering av beräkningsnoder till poolen. |
resourceTags |
object |
De användardefinierade taggarna som är associerade med poolen. |
startTask |
En uppgift som ska 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. |
targetLowPriorityNodes |
integer |
Önskat antal beräkningsnoder med oanvänd kapacitet/låg prioritet i poolen. |
targetNodeCommunicationMode |
Önskat nodkommunikationsläge för poolen. |
|
taskSchedulingPolicy |
Så här distribueras uppgifter mellan beräkningsnoder i en pool. |
|
taskSlotsPerNode |
integer |
Antalet aktivitetsfack som kan användas för att köra samtidiga uppgifter på en enda beräkningsnod i poolen. |
upgradePolicy |
Uppgraderingsprincipen för poolen. |
|
userAccounts |
Listan över användarkonton som ska skapas på varje beräkningsnod i poolen. |
|
virtualMachineConfiguration |
Konfigurationen av den virtuella datorn för poolen. |
|
vmSize |
string |
Storleken på de virtuella datorerna i poolen. Alla virtuella datorer i en pool har samma storlek. |
PublicIPAddressConfiguration
Den offentliga IP-adresskonfigurationen för nätverkskonfigurationen för en pool.
Name | Typ | Description |
---|---|---|
ipAddressIds |
string[] |
Listan över offentliga IP-adresser som Batch-tjänsten ska använda vid etablering av beräkningsnoder. |
provision |
Etableringstypen för offentliga IP-adresser för poolen. |
ResourceFile
En enda fil eller flera filer som ska laddas ned till en beräkningsnod.
Name | Typ | Description |
---|---|---|
autoStorageContainerName |
string |
Namnet på lagringscontainern i det automatiska lagringskontot. |
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. |
fileMode |
string |
Attributet för filbehörighetsläge i oktalt format. |
filePath |
string |
Platsen på beräkningsnoden som filen eller filerna ska laddas ned till i förhållande till aktivitetens arbetskatalog. |
httpUrl |
string |
URL:en för filen som ska laddas ned. |
identityReference |
Referensen till den användartilldelade identitet som ska användas för åtkomst till Azure Blob Storage som anges av storageContainerUrl eller httpUrl |
|
storageContainerUrl |
string |
URL:en för blobcontainern i Azure Blob Storage. |
RollingUpgradePolicy
De konfigurationsparametrar som används vid löpande uppgradering.
Name | Typ | Description |
---|---|---|
enableCrossZoneUpgrade |
boolean |
Tillåt ATT VMSS ignorerar AZ-gränser när du skapar uppgraderingsbatch. Ta hänsyn till uppdateringsdomänen och maxBatchInstancePercent för att fastställa batchstorleken. Det här fältet kan endast anges till sant eller falskt när nodePlacementConfiguration används som zonindelning. |
maxBatchInstancePercent |
integer |
Den maximala procentandelen av de totala virtuella datorinstanserna som uppgraderas samtidigt av den löpande uppgraderingen i en batch. Eftersom detta är ett maximalt antal felaktiga instanser i tidigare eller framtida batchar kan procentandelen instanser i en batch minska för att säkerställa högre tillförlitlighet. Värdet för det här fältet ska vara mellan 5 och 100, inklusive. Om både maxBatchInstancePercent och maxUnhealthyInstancePercent tilldelas med värde bör värdet för maxBatchInstancePercent inte vara mer än maxUnhealthyInstancePercent. |
maxUnhealthyInstancePercent |
integer |
Den maximala procentandelen av de totala virtuella datorinstanserna i skalningsuppsättningen som kan vara felfritt samtidigt, antingen till följd av uppgraderingen eller genom att hittas i ett feltillstånd av hälsokontrollerna för den virtuella datorn innan den löpande uppgraderingen avbryts. Den här begränsningen kontrolleras innan någon batch startas. Värdet för det här fältet ska vara mellan 5 och 100, inklusive. Om både maxBatchInstancePercent och maxUnhealthyInstancePercent tilldelas med värde bör värdet för maxBatchInstancePercent inte vara mer än maxUnhealthyInstancePercent. |
maxUnhealthyUpgradedInstancePercent |
integer |
Den maximala procentandelen uppgraderade virtuella datorinstanser som kan konstateras vara i ett feltillstånd. Den här kontrollen sker när varje batch har uppgraderats. Om den här procentandelen någonsin överskrids avbryts den löpande uppdateringen. Värdet för det här fältet ska vara mellan 0 och 100, inklusive. |
pauseTimeBetweenBatches |
string |
Väntetiden mellan att slutföra uppdateringen för alla virtuella datorer i en batch och starta nästa batch. Varaktigheten ska anges i ISO 8601-format. |
prioritizeUnhealthyInstances |
boolean |
Uppgradera alla instanser med feltillstånd i en skalningsuppsättning före eventuella felfria instanser. |
rollbackFailedInstancesOnPolicyBreach |
boolean |
Återställningen misslyckades för instanser till en tidigare modell om principen för löpande uppgradering överträds. |
SecurityEncryptionTypes
Anger EncryptionType för den hanterade disken. Den är inställd på VMGuestStateOnly för kryptering av bara VMGuestState-bloben och NonPersistedTPM för att inte bevara tillståndet för inbyggd programvara i VMGuestState-bloben. Obs: Det kan endast anges för konfidentiella virtuella datorer och krävs när du använder konfidentiella virtuella datorer.
Name | Typ | Description |
---|---|---|
NonPersistedTPM |
string |
|
VMGuestStateOnly |
string |
SecurityProfile
Anger säkerhetsprofilinställningarna för den virtuella datorn eller vm-skalningsuppsättningen.
Name | Typ | Description |
---|---|---|
encryptionAtHost |
boolean |
Den här egenskapen kan användas av användaren i begäran för att aktivera eller inaktivera värdkryptering för den virtuella datorn eller vm-skalningsuppsättningen. Detta aktiverar krypteringen för alla diskar, inklusive resurs/temp-disk på själva värden. Mer information om kryptering vid värdkrav finns i https://video2.skills-academy.com/azure/virtual-machines/disk-encryption#supported-vm-sizes. |
securityType |
Anger SecurityType för den virtuella datorn. Det måste anges till ett angivet värde för att aktivera UefiSettings. |
|
uefiSettings |
Anger de säkerhetsinställningar som säker start och vTPM som används när den virtuella datorn skapas. |
SecurityTypes
Anger SecurityType för den virtuella datorn. Det måste anges till ett angivet värde för att aktivera UefiSettings.
Name | Typ | Description |
---|---|---|
confidentialVM |
string |
Konfidentiell databehandling i Azure erbjuder konfidentiella virtuella datorer för klienter med höga krav på säkerhet och konfidentialitet. Dessa virtuella datorer tillhandahåller en stark, maskinvarubaserad gräns som hjälper dig att uppfylla dina säkerhetsbehov. Du kan använda konfidentiella virtuella datorer för migreringar utan att göra ändringar i koden, där plattformen skyddar den virtuella datorns tillstånd från att läsas eller ändras. |
trustedLaunch |
string |
Betrodd start skyddar mot avancerade och beständiga attacktekniker. |
ServiceArtifactReference
Anger tjänstartefaktreferens-ID:t som används för att ange samma avbildningsversion för alla virtuella datorer i skalningsuppsättningen när du använder den senaste avbildningsversionen.
Name | Typ | Description |
---|---|---|
id |
string |
Tjänstartefaktens referens-ID för ServiceArtifactReference |
StartTask
En uppgift 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 | Typ | Description |
---|---|---|
commandLine |
string |
Kommandoraden i StartTask. |
containerSettings |
Inställningarna för containern under vilken StartTask körs. |
|
environmentSettings |
En lista över miljövariabelinställningar för StartTask. |
|
maxTaskRetryCount |
integer |
Det maximala antalet gånger som aktiviteten kan försökas igen. |
resourceFiles |
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 requestEntityTooLarge. Om detta inträffar måste samlingen av ResourceFiles minskas i storlek. Detta kan uppnås med hjälp av .zip filer, programpaket eller Docker-containrar. |
|
userIdentity |
Användaridentiteten som StartTask körs under. |
|
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. |
StorageAccountType
Lagringskontotypen som ska användas för att skapa datadiskar eller OS-diskar.
Name | Typ | Description |
---|---|---|
premium_lrs |
string |
Datadisken/OS-disken bör använda premium lokalt redundant lagring. |
standard_lrs |
string |
Datadisken/OS-disken bör använda lokalt redundant standardlagring. |
standardssd_lrs |
string |
Datadisken/OS-disken ska använda standardlagring med lokalt redundant SSD. |
TaskConstraints
Körningsbegränsningar som ska gälla för en aktivitet.
Name | Typ | Description |
---|---|---|
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. |
maxWallClockTime |
string |
Den maximala tiden som aktiviteten kan köras, mätt från den tidpunkt då aktiviteten startar. Om aktiviteten inte slutförs inom tidsgränsen avslutar Batch-tjänsten den. |
retentionTime |
string |
Den minsta tiden för att behålla aktivitetskatalogen på den beräkningsnod där den kördes, från den tidpunkt då körningen slutfördes. Efter den här tiden kan Batch-tjänsten ta bort aktivitetskatalogen och allt dess innehåll. |
TaskContainerSettings
Containerinställningarna för en aktivitet.
Name | Typ | Description |
---|---|---|
containerHostBatchBindMounts |
Sökvägarna som du vill montera på containeraktiviteten. |
|
containerRunOptions |
string |
Ytterligare alternativ för kommandot container create. |
imageName |
string |
Avbildningen som ska användas för att skapa containern där aktiviteten ska köras. |
registry |
Det privata registret som innehåller containeravbildningen. |
|
workingDirectory |
Platsen för containerns arbetskatalog för uppgift. |
TaskSchedulingPolicy
Anger hur Aktiviteter ska distribueras mellan beräkningsnoder.
Name | Typ | Description |
---|---|---|
nodeFillType |
Så här distribueras uppgifter mellan beräkningsnoder i en pool. |
UefiSettings
Anger de säkerhetsinställningar som säker start och vTPM som används när den virtuella datorn skapas.
Name | Typ | Description |
---|---|---|
secureBootEnabled |
boolean |
Anger om säker start ska aktiveras på den virtuella datorn. |
vTpmEnabled |
boolean |
Anger om vTPM ska aktiveras på den virtuella datorn. |
UpgradeMode
Anger läget för en uppgradering till virtuella datorer i skalningsuppsättningen.
Möjliga värden är:
Manuell – Du styr programmet för uppdateringar av virtuella datorer i skalningsuppsättningen. Du gör detta med hjälp av åtgärden manualUpgrade.
Automatisk – Alla virtuella datorer i skalningsuppsättningen uppdateras automatiskt samtidigt.
Rullande – Skalningsuppsättningen utför uppdateringar i batchar med en valfri paustid däremellan.
Name | Typ | Description |
---|---|---|
automatic |
string |
Alla virtuella datorer i skalningsuppsättningen uppdateras automatiskt samtidigt. |
manual |
string |
Du styr programmet för uppdateringar av virtuella datorer i skalningsuppsättningen. Du gör detta med hjälp av åtgärden manualUpgrade. |
rolling |
string |
De befintliga instanserna i en skalningsuppsättning tas ned i batchar som ska uppgraderas. När den uppgraderade batchen är klar börjar instanserna ta trafik igen och nästa batch börjar. Detta fortsätter tills alla instanser har up-to-date. |
UpgradePolicy
Beskriver en uppgraderingsprincip – automatisk, manuell eller rullande.
Name | Typ | Description |
---|---|---|
automaticOSUpgradePolicy |
Konfigurationsparametrar som används för att utföra automatisk operativsystemuppgradering. |
|
mode |
Anger läget för en uppgradering till virtuella datorer i skalningsuppsättningen. |
|
rollingUpgradePolicy |
De konfigurationsparametrar som används vid löpande uppgradering. |
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 Compute-nod.
Name | Typ | Description |
---|---|---|
elevationLevel |
Behörighetsnivån för användarkontot. |
|
linuxUserConfiguration |
Den Linux-specifika användarkonfigurationen för användarkontot. |
|
name |
string |
Namnet på användarkontot. Namn kan innehålla alla Unicode-tecken upp till en maximal längd på 20. |
password |
string |
Lösenordet för användarkontot. |
windowsUserConfiguration |
Den Windows-specifika användarkonfigurationen för användarkontot. |
UserIdentity
Definitionen av användaridentiteten som aktiviteten körs under.
Name | Typ | Description |
---|---|---|
autoUser |
Den automatiska användare under vilken aktiviteten körs. |
|
username |
string |
Namnet på den användaridentitet som aktiviteten körs under. |
VirtualMachineConfiguration
Konfigurationen för beräkningsnoder i en pool baserat på Azure Virtual Machines-infrastrukturen.
Name | Typ | Description |
---|---|---|
containerConfiguration |
Containerkonfigurationen för poolen. |
|
dataDisks |
Data |
Konfigurationen för datadiskar som är anslutna till beräkningsnoderna i poolen. |
diskEncryptionConfiguration |
Diskkrypteringskonfigurationen för poolen. |
|
extensions |
Tillägget för den virtuella datorn för poolen. |
|
imageReference |
En referens till Azure Virtual Machines Marketplace-avbildningen eller den anpassade virtual machine-avbildningen som ska användas. |
|
licenseType |
string |
Den typ av lokal licens som ska användas vid distribution av operativsystemet. Windows_Server – Den lokala licensen gäller för Windows Server. Windows_Client – Den lokala licensen gäller för Windows-klienten. |
nodeAgentSKUId |
string |
SKU:n för Batch Compute Node-agenten som ska etableras på beräkningsnoder i poolen. |
nodePlacementConfiguration |
Nodplaceringskonfigurationen för poolen. |
|
osDisk |
Inställningar för den virtuella datorns operativsystemdisk. |
|
securityProfile |
Anger säkerhetsprofilinställningarna för den virtuella datorn eller vm-skalningsuppsättningen. |
|
serviceArtifactReference |
Anger tjänstartefaktreferens-ID:t som används för att ange samma avbildningsversion för alla virtuella datorer i skalningsuppsättningen när du använder den senaste avbildningsversionen. |
|
windowsConfiguration |
Inställningar för Windows-operativsystem på den virtuella datorn. |
VMDiskSecurityProfile
Anger säkerhetsprofilinställningarna för den hanterade disken. Obs: Det kan bara anges för konfidentiella virtuella datorer och krävs när du använder konfidentiella virtuella datorer.
Name | Typ | Description |
---|---|---|
securityEncryptionType |
Anger EncryptionType för den hanterade disken. Den är inställd på VMGuestStateOnly för kryptering av bara VMGuestState-bloben och NonPersistedTPM för att inte bevara tillståndet för inbyggd programvara i VMGuestState-bloben. Obs: Det kan endast anges för konfidentiella virtuella datorer och krävs när du använder konfidentiella virtuella datorer. |
VMExtension
Konfigurationen för tillägg för virtuella datorer.
Name | Typ | Description |
---|---|---|
autoUpgradeMinorVersion |
boolean |
Anger om tillägget ska använda en nyare delversion om en är tillgänglig vid distributionstillfället. När tillägget har distribuerats uppgraderas dock inte mindre versioner om de inte distribueras om, även med den här egenskapen inställd på true. |
enableAutomaticUpgrade |
boolean |
Anger om tillägget ska uppgraderas automatiskt av plattformen om det finns en nyare version av tillägget tillgängligt. |
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. |
publisher |
string |
Namnet på tilläggshanterarens utgivare. |
settings |
object |
JSON-formaterade offentliga inställningar för tillägget. |
type |
string |
Typ av tillägg. |
typeHandlerVersion |
string |
Versionen av skripthanteraren. |
WindowsConfiguration
Inställningar för Windows-operativsystem som ska tillämpas på den virtuella datorn.
Name | Typ | Description |
---|---|---|
enableAutomaticUpdates |
boolean |
Om automatiska uppdateringar är aktiverade på den virtuella datorn. |
WindowsUserConfiguration
Egenskaper som används för att skapa ett användarkonto på en Windows-beräkningsnod.
Name | Typ | Description |
---|---|---|
loginMode |
Inloggningsläget för användaren |