Job - Update
Uppdateringar egenskaperna för det angivna jobbet.
Detta ersätter helt alla uppdateringsbara egenskaper för jobbet. Om jobbet till exempel har begränsningar kopplade till sig och om begränsningar inte har angetts med den här begäran, tar Batch-tjänsten bort de befintliga begränsningarna.
PUT {batchUrl}/jobs/{jobId}?api-version=2023-11-01.18.0
PUT {batchUrl}/jobs/{jobId}?timeout={timeout}&api-version=2023-11-01.18.0
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
batch
|
path | True |
string |
Bas-URL:en för alla Azure Batch tjänstbegäranden. |
job
|
path | True |
string |
ID för jobbet vars egenskaper du vill uppdatera. |
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 | 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 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. |
|
If-Match |
string |
Ett ETag-värde som är associerat med den version av resursen som klienten känner till. Åtgärden utförs endast om resursens aktuella ETag i tjänsten exakt matchar det värde som anges av klienten. |
|
If-None-Match |
string |
Ett ETag-värde som är associerat med den version av resursen som klienten känner till. Åtgärden utförs endast om resursens aktuella ETag i tjänsten inte matchar det värde som anges av klienten. |
|
If-Modified-Since |
string date-time-rfc1123 |
En tidsstämpel som anger den senaste ändringstiden för resursen som klienten känner till. Åtgärden utförs endast om resursen i tjänsten har ändrats sedan den angivna tiden. |
|
If-Unmodified-Since |
string date-time-rfc1123 |
En tidsstämpel som anger den senaste ändringstiden för resursen som klienten känner till. Åtgärden utförs endast om resursen i tjänsten inte har ändrats sedan den angivna tiden. |
Begärandetext
Media Types: "application/json; odata=minimalmetadata"
Name | Obligatorisk | Typ | Description |
---|---|---|---|
poolInfo | True |
Poolen där Batch-tjänsten kör jobbets uppgifter. |
|
allowTaskPreemption |
boolean |
Om aktiviteter i det här jobbet kan förhindras av andra jobb med hög prioritet |
|
constraints |
Körningsbegränsningarna för jobbet. |
||
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. |
||
onAllTasksComplete |
Åtgärden som Batch-tjänsten ska vidta när alla aktiviteter i jobbet är i slutfört tillstånd. |
||
priority |
integer |
Jobbets prioritet. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Begäran till Batch-tjänsten lyckades. Sidhuvuden
|
|
Other Status Codes |
Felet från Batch-tjänsten. |
Säkerhet
azure_auth
Microsoft Entra OAuth 2.0-autentiseringskodflöde
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
Job update
Exempelbegäran
PUT account.region.batch.azure.com/jobs/jobId?api-version=2023-11-01.18.0
{
"priority": 100,
"constraints": {
"maxWallClockTime": "PT1H",
"maxTaskRetryCount": -1
},
"poolInfo": {
"poolId": "poolId"
}
}
Exempelsvar
Definitioner
Name | Description |
---|---|
Application |
En referens till ett paket som ska distribueras till beräkningsnoder. |
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 aktivitet 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 |
Typen 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. |
Cloud |
Konfigurationen för beräkningsnoder i en pool baserat på Azure Cloud Services-plattformen. |
Compute |
Hur aktiviteter distribueras mellan beräkningsnoder i en pool. |
Compute |
Referensen till en användartilldelad identitet som är associerad med den Batch-pool som en beräkningsnod ska använda. |
Container |
Konfigurationen för containeraktiverade pooler. |
Container |
Ett privat containerregister. |
Container |
Containertekniken 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 kopplade till 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. |
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. Konfiguration av diskkryptering 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 i en uppgiftsprocess. |
Error |
Ett felmeddelande som tas emot i ett Azure Batch felsvar. |
Image |
En referens till en Azure Virtual Machines Marketplace-avbildning eller en Azure Compute Gallery-avbildning. 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". |
Inbound |
Slutpunktens protokoll. |
Inbound |
En inkommande NAT-pool som kan användas för att adressera specifika portar på beräkningsnoder i en Batch-pool externt. |
IPAddress |
Etableringstypen för offentliga IP-adresser för poolen. |
Job |
Körningsbegränsningarna för ett jobb. |
Job |
Den uppsättning ändringar som ska göras i ett jobb. |
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, ett undernätsintervall eller en 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 |
Åtgärden som Batch-tjänsten ska vidta när alla aktiviteter i jobbet är i slutfört tillstånd. |
OSDisk |
Inställningar för operativsystemdisken för beräkningsnoden (VM). |
Pool |
Slutpunktskonfigurationen för en pool. |
Pool |
Anger hur ett jobb ska tilldelas till en pool. |
Pool |
Minsta livslängd 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 enskild fil eller flera filer som ska laddas ned till en beräkningsnod. |
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 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. |
Storage |
Lagringskontotypen som används för att skapa datadiskar eller OS-diskar. |
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. |
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 beräkningsnod. |
User |
Definitionen av den användaridentitet som aktiviteten körs under. |
Virtual |
Konfigurationen för beräkningsnoder i en pool baserat på Azure Virtual Machines-infrastrukturen. |
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. |
ApplicationPackageReference
En referens till ett paket som ska distribueras till beräkningsnoder.
Name | Typ | 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. |
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 upphör att gälla. |
pool |
Poolspecifikationen för den automatiska poolen. |
|
poolLifetimeOption |
Minsta livslängd 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 aktivitet i Batch-tjänsten.
Name | Typ | Description |
---|---|---|
elevationLevel |
Höjdnivån för den automatiska användaren. |
|
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 container. |
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
Typen 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 de användarkonton där användare fjärråtkomst till beräkningsnoden. |
starttask |
string |
Certifikatet ska vara synligt för användarkontot under vilket StartTask körs. Observera att om autoanvändaromfå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 de användarkonton under vilka jobbuppgifter 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. |
CloudServiceConfiguration
Konfigurationen för beräkningsnoder i en pool baserat på Azure Cloud Services-plattformen.
Name | Typ | Description |
---|---|---|
osFamily |
string |
Den Azure-gästoperativsystemfamilj som ska installeras på de virtuella datorerna i poolen. |
osVersion |
string |
Den Azure-gästoperativsystemversion som ska installeras på de virtuella datorerna i poolen. |
ComputeNodeFillType
Hur aktiviteter distribueras mellan beräkningsnoder i en pool.
Name | Typ | 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 den Batch-pool 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 |
Containertekniken som ska användas. |
ContainerRegistry
Ett privat containerregister.
Name | Typ | Description |
---|---|---|
identityReference |
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. |
|
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
Containertekniken 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 Avbildning. Se till 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 kopplade till 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 | 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 |
Lagringskontotypen 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. Konfiguration av diskkryptering 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ä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 | Typ | Description |
---|---|---|
name |
string |
Namnet på miljövariabeln. |
value |
string |
Värdet för miljövariabeln. |
ErrorMessage
Ett felmeddelande som tas emot i ett Azure Batch felsvar.
Name | Typ | 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 Azure Compute Gallery-avbildning. 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 | Typ | 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. |
publisher |
string |
Utgivaren av Azure Virtual Machines Marketplace-avbildningen. |
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-avbildningen. 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. |
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 adressera 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 |
Protokollet för slutpunkten. |
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. |
JobConstraints
Körningsbegränsningarna för ett jobb.
Name | Typ | Description |
---|---|---|
maxTaskRetryCount |
integer |
Det maximala antalet gånger som varje aktivitet 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 förflutna tiden som jobbet kan köras, mätt från den tidpunkt då jobbet skapas. |
JobUpdateParameter
Den uppsättning ändringar som ska göras i ett jobb.
Name | Typ | Standardvärde | Description |
---|---|---|---|
allowTaskPreemption |
boolean |
Om aktiviteter i det här jobbet kan förhindras av andra jobb med hög prioritet |
|
constraints |
Körningsbegränsningarna för jobbet. |
||
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. |
||
onAllTasksComplete |
Åtgärden som Batch-tjänsten ska vidta när alla aktiviteter i jobbet är i slutfört tillstånd. |
||
poolInfo |
Poolen där Batch-tjänsten kör jobbets uppgifter. |
||
priority |
integer |
Jobbets prioritet. |
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 |
LOGON32_LOGON_BATCH Win32-inloggningsläge. Batchinloggningsläget rekommenderas för långvariga parallella processer. |
interactive |
string |
LOGON32_LOGON_INTERACTIVE Win32-inloggningsläge. UAC är aktiverat på Windows VirtualMachineConfiguration Pools. Om det här alternativet används med en förhöjd användaridentitet i en Windows VirtualMachineConfiguration-pool kommer användarsessionen inte att utökas om inte programmet som körs av kommandoraden Aktivitet är konfigurerat för att alltid kräva administratörsbehörighet eller alltid kräver maximal behörighet. |
ManagedDisk
Name | Typ | Description |
---|---|---|
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 |
Azure-filresursen 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, ett undernätsintervall eller en 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, ett undernätsintervall eller en 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 |
Nodplacering Principtyp 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
Åtgärden som Batch-tjänsten ska vidta när alla aktiviteter 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". |
OSDisk
Inställningar för operativsystemdisken 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. |
PoolEndpointConfiguration
Slutpunktskonfigurationen för en pool.
Name | Typ | Description |
---|---|---|
inboundNATPools |
En lista över inkommande NAT-pooler som kan användas för att adressera 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
Minsta livslängd 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 jobbschemats livslängd. 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 |
---|---|---|
applicationLicenses |
string[] |
Listan över programlicenser som Batch-tjänsten gör tillgängliga på varje beräkningsnod i poolen. |
applicationPackageReferences |
Listan över paket som ska installeras på varje beräkningsnod i poolen. |
|
autoScaleEvaluationInterval |
string |
Det tidsintervall 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. |
|
cloudServiceConfiguration |
Molntjänstkonfigurationen för poolen. |
|
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 aktivitet 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 |
Hur uppgifter distribueras mellan beräkningsnoder i en pool. |
|
taskSlotsPerNode |
integer |
Antalet aktivitetsplatser som kan användas för att köra samtidiga aktiviteter på en enda beräkningsnod i 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 enskild 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 blobbar 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 att komma åt Azure Blob Storage som anges av storageContainerUrl eller httpUrl |
|
storageContainerUrl |
string |
URL:en för blobcontainern i Azure Blob Storage. |
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 kryptering för alla diskar, inklusive resurs-/tempdisk på själva värden. |
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 |
---|---|---|
trustedLaunch |
string |
Betrodd start skyddar mot avancerade och beständiga angreppstekniker. |
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 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 | Typ | Description |
---|---|---|
commandLine |
string |
Kommandoraden i StartTask. |
containerSettings |
Inställningarna för containern som StartTask körs under. |
|
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 är RequestEntityTooLarge. Om detta inträffar måste samlingen 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. avslutas med slutkod 0) innan aktiviteter schemaläggs på beräkningsnoden. |
StorageAccountType
Lagringskontotypen som används för att skapa datadiskar eller OS-diskar.
Name | Typ | Description |
---|---|---|
premium_lrs |
string |
Datadisken/OS-disken bör använda lokalt redundant premiumlagring. |
standard_lrs |
string |
Datadisken/OS-disken bör använda lokalt redundant standardlagring. |
standardssd_lrs |
string |
Datadisken/OS-disken bör använda lokalt redundant standard-SSD-lagring. |
TaskContainerSettings
Containerinställningarna för en aktivitet.
Name | Typ | Description |
---|---|---|
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 containern Image. |
|
workingDirectory |
Platsen för containerns arbetskatalog för uppgift. |
TaskSchedulingPolicy
Anger hur aktiviteter ska distribueras mellan beräkningsnoder.
Name | Typ | Description |
---|---|---|
nodeFillType |
Hur aktiviteter distribueras 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. |
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 | 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 den användaridentitet som aktiviteten körs under.
Name | Typ | Description |
---|---|---|
autoUser |
Den automatiska användare som aktiviteten körs under. |
|
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 avbildningen av den virtuella datorn 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-operativsystemet på den virtuella datorn. |
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 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. |
enableAutomaticUpgrade |
boolean |
Anger om tillägget ska uppgraderas automatiskt av plattformen om det finns en nyare version av tillägget. |
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äggshanterarutgivaren. |
settings |
object |
JSON-formaterade offentliga inställningar för tillägget. |
type |
string |
Typ av tillägg. |
typeHandlerVersion |
string |
Skripthanterarens version. |
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 |