Pool - Update Properties
Uppdateringar egenskaperna för den angivna poolen.
Detta ersätter alla uppdateringsbara egenskaper för poolen. Om poolen till exempel har en StartTask associerad med den och om StartTask inte har angetts med den här begäran, tar Batch-tjänsten bort den befintliga StartTask.
POST {batchUrl}/pools/{poolId}/updateproperties?api-version=2023-11-01.18.0
POST {batchUrl}/pools/{poolId}/updateproperties?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. |
pool
|
path | True |
string |
ID:t för poolen som ska uppdateras. |
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. |
Begärandetext
Media Types: "application/json; odata=minimalmetadata"
Name | Obligatorisk | Typ | Description |
---|---|---|---|
applicationPackageReferences | True |
Listan över programpaket som ska installeras på varje beräkningsnod i poolen. |
|
certificateReferences | True |
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. |
|
metadata | True |
En lista över namn/värde-par som är associerade med poolen som metadata. |
|
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. |
||
targetNodeCommunicationMode |
Önskat nodkommunikationsläge för poolen. |
Svar
Name | Typ | Description |
---|---|---|
204 No Content |
Begäran till Batch-tjänsten lyckades. Headers
|
|
Other Status Codes |
Felet från Batch-tjänsten. |
Säkerhet
azure_auth
Microsoft Entra OAuth 2.0-autentiseringskodflöde
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Personifiera ditt användarkonto |
Authorization
Type:
apiKey
In:
header
Exempel
Pool update
Sample Request
POST account.region.batch.azure.com/pools/poolId/updateproperties?api-version=2023-11-01.18.0
{
"startTask": {
"commandLine": "/bin/bash -c 'echo start task'"
},
"certificateReferences": [],
"applicationPackageReferences": [],
"metadata": []
}
Sample Response
Definitioner
Name | Description |
---|---|
Application |
En referens till ett paket som ska distribueras till beräkningsnoder. |
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. |
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. |
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. |
Compute |
Referensen till en användartilldelad identitet som är associerad med den Batch-pool som en beräkningsnod ska använda. |
Container |
Ett privat containerregister. |
Container |
Platsen för containerns arbetskatalog för uppgift. |
Elevation |
Användarens höjdnivå. |
Environment |
En miljövariabel som ska anges för en uppgiftsprocess. |
Error |
Ett felmeddelande som tas emot i ett Azure Batch felsvar. |
Metadata |
Ett namn/värde-par som är associerat med en Batch-tjänstresurs. |
Node |
Avgör hur en pool kommunicerar med Batch-tjänsten. |
Pool |
Den uppsättning ändringar som ska göras i en pool. |
Resource |
En enda fil eller flera filer som ska laddas ned till en beräkningsnod. |
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. |
Task |
Containerinställningarna för en aktivitet. |
User |
Definitionen av den användaridentitet som aktiviteten körs under. |
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. |
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 |
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. |
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 arkivet CurrentUser Certificate. |
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 under vilka användare fjärråtkomst till beräkningsnoden. |
starttask |
string |
Certifikatet ska vara synligt för det användarkonto som StartTask körs under. Observera att om AutoUser-omfånget är pool för både StartTask och en aktivitet, kommer även det här certifikatet att vara synligt för aktiviteten. |
task |
string |
Certifikatet ska vara synligt för de användarkonton under vilka jobbaktiviteter körs. |
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. |
ContainerRegistry
Ett privat containerregister.
Name | Typ | Description |
---|---|---|
identityReference |
Referensen till den användartilldelade identiteten som ska användas för att få åtkomst till 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. |
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. |
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 för 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. |
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. |
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. |
PoolUpdatePropertiesParameter
Den uppsättning ändringar som ska göras i en pool.
Name | Typ | Description |
---|---|---|
applicationPackageReferences |
Listan över programpaket som ska installeras på varje beräkningsnod 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. |
|
metadata |
En lista över namn/värde-par som är associerade med poolen som metadata. |
|
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. |
|
targetNodeCommunicationMode |
Önskat nodkommunikationsläge 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/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. |
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. |
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. |
UserIdentity
Definitionen av den användaridentitet 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. |