Pool - Update Properties
Aggiorna le proprietà del pool specificato.
In questo modo tutte le proprietà aggiornabili del pool vengono sostituite completamente. Ad esempio, se al pool è associato startTask e se StartTask non è specificato con questa richiesta, il servizio Batch rimuoverà l'oggetto StartTask esistente.
POST {batchUrl}/pools/{poolId}/updateproperties?api-version=2024-07-01.20.0
POST {batchUrl}/pools/{poolId}/updateproperties?timeout={timeout}&api-version=2024-07-01.20.0
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
batch
|
path | True |
string |
URL di base per tutte le richieste del servizio Azure Batch. |
pool
|
path | True |
string |
ID del pool da aggiornare. |
api-version
|
query | True |
string |
Versione dell'API client. |
timeout
|
query |
integer int32 |
Tempo massimo di elaborazione della richiesta da parte del server, espresso in secondi. Il valore predefinito è 30 secondi. Se il valore è maggiore di 30, verrà usato il valore predefinito. |
Intestazione della richiesta
Media Types: "application/json; odata=minimalmetadata"
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
client-request-id |
string uuid |
Identità della richiesta generata dal chiamante, sotto forma di GUID senza decorazioni come parentesi graffe, ad esempio 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Indica se il server deve restituire l'ID richiesta client nella risposta. |
|
ocp-date |
string date-time-rfc1123 |
Ora di emissione della richiesta. Le librerie client in genere impostano questo valore sull'ora corrente dell'orologio di sistema; impostarla in modo esplicito se si chiama direttamente l'API REST. |
Corpo della richiesta
Media Types: "application/json; odata=minimalmetadata"
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
applicationPackageReferences | True |
Elenco dei pacchetti dell'applicazione da installare in ogni nodo di calcolo nel pool. |
|
certificateReferences | True |
Elenco di certificati da installare in ogni nodo di calcolo nel pool. Avviso: questa proprietà è deprecata e verrà rimossa dopo febbraio 2024. Usare invece 'estensione Azure KeyVault. |
|
metadata | True |
Elenco di coppie nome-valore associate al pool come metadati. |
|
startTask |
Un'attività da eseguire in ogni nodo di calcolo quando viene aggiunto al pool. L'attività viene eseguita quando il nodo di calcolo viene aggiunto al pool o quando il nodo di calcolo viene riavviato. |
||
targetNodeCommunicationMode |
Modalità di comunicazione del nodo desiderata per il pool. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
204 No Content |
La richiesta al servizio Batch ha avuto esito positivo. Intestazioni
|
|
Other Status Codes |
Errore del servizio Batch. |
Sicurezza
azure_auth
Flusso del codice di autenticazione di Microsoft Entra OAuth 2.0
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
Nome | Descrizione |
---|---|
user_impersonation | Rappresentare l'account utente |
Authorization
Tipo:
apiKey
In:
header
Esempio
Pool update
Esempio di richiesta
POST account.region.batch.azure.com/pools/poolId/updateproperties?api-version=2024-07-01.20.0
{
"startTask": {
"commandLine": "/bin/bash -c 'echo start task'"
},
"certificateReferences": [],
"applicationPackageReferences": [],
"metadata": []
}
Risposta di esempio
Definizioni
Nome | Descrizione |
---|---|
Application |
Riferimento a un pacchetto da distribuire nei nodi di calcolo. |
Auto |
Ambito dell'utente automatico |
Auto |
Specifica i parametri per l'utente automatico che esegue un'attività nel servizio Batch. |
Batch |
Risposta di errore ricevuta dal servizio Azure Batch. |
Batch |
Elemento di informazioni aggiuntive incluse in una risposta di errore di Azure Batch. |
Certificate |
Riferimento a un certificato da installare nei nodi di calcolo in un pool. |
Certificate |
Percorso dell'archivio certificati nel nodo di calcolo in cui installare il certificato. |
Certificate |
Quali account utente nel nodo di calcolo devono avere accesso ai dati privati del certificato. |
Compute |
Riferimento a un'identità assegnata dall'utente associata al pool di Batch che verrà usato da un nodo di calcolo. |
Container |
Voce di percorso e modalità di montaggio da montare nel contenitore di attività. |
Container |
Percorsi che verranno montati nel contenitore dell'attività contenitore. |
Container |
Registro contenitori privato. |
Container |
Percorso della directory di lavoro dell'attività del contenitore. |
Elevation |
Livello di elevazione dell'utente. |
Environment |
Variabile di ambiente da impostare in un processo task. |
Error |
Messaggio di errore ricevuto in una risposta di errore di Azure Batch. |
Metadata |
Coppia nome-valore associata a una risorsa del servizio Batch. |
Node |
Determina il modo in cui un pool comunica con il servizio Batch. |
Pool |
Set di modifiche da apportare a un pool. |
Resource |
Un singolo file o più file da scaricare in un nodo di calcolo. |
Start |
Attività eseguita quando un nodo viene aggiunto a un pool nel servizio Azure Batch o quando il nodo di calcolo viene riavviato o ricreato l'immagine. |
Task |
Impostazioni del contenitore per un'attività. |
User |
Definizione dell'identità utente in cui viene eseguita l'attività. |
ApplicationPackageReference
Riferimento a un pacchetto da distribuire nei nodi di calcolo.
Nome | Tipo | Descrizione |
---|---|---|
applicationId |
string |
ID dell'applicazione da distribuire. |
version |
string |
Versione dell'applicazione da distribuire. Se omesso, viene distribuita la versione predefinita. |
AutoUserScope
Ambito dell'utente automatico
Nome | Tipo | Descrizione |
---|---|---|
pool |
string |
Specifica che l'attività viene eseguita come account utente automatico comune creato in ogni nodo di calcolo in un pool. |
task |
string |
Specifica che il servizio deve creare un nuovo utente per l'attività. |
AutoUserSpecification
Specifica i parametri per l'utente automatico che esegue un'attività nel servizio Batch.
Nome | Tipo | Descrizione |
---|---|---|
elevationLevel |
Livello di elevazione dell'utente automatico. |
|
scope |
Ambito dell'utente automatico |
BatchError
Risposta di errore ricevuta dal servizio Azure Batch.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice. |
message |
Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente. |
|
values |
Raccolta di coppie chiave-valore contenenti dettagli aggiuntivi sull'errore. |
BatchErrorDetail
Elemento di informazioni aggiuntive incluse in una risposta di errore di Azure Batch.
Nome | Tipo | Descrizione |
---|---|---|
key |
string |
Identificatore che specifica il significato della proprietà Value. |
value |
string |
Informazioni aggiuntive incluse nella risposta di errore. |
CertificateReference
Riferimento a un certificato da installare nei nodi di calcolo in un pool.
Nome | Tipo | Descrizione |
---|---|---|
storeLocation |
Percorso dell'archivio certificati nel nodo di calcolo in cui installare il certificato. |
|
storeName |
string |
Nome dell'archivio certificati nel nodo di calcolo in cui installare il certificato. |
thumbprint |
string |
Identificazione personale del certificato. |
thumbprintAlgorithm |
string |
Algoritmo a cui è associata l'identificazione personale. Deve essere sha1. |
visibility |
Quali account utente nel nodo di calcolo devono avere accesso ai dati privati del certificato. |
CertificateStoreLocation
Percorso dell'archivio certificati nel nodo di calcolo in cui installare il certificato.
Nome | Tipo | Descrizione |
---|---|---|
currentuser |
string |
I certificati devono essere installati nell'archivio certificati CurrentUser. |
localmachine |
string |
I certificati devono essere installati nell'archivio certificati LocalMachine. |
CertificateVisibility
Quali account utente nel nodo di calcolo devono avere accesso ai dati privati del certificato.
Nome | Tipo | Descrizione |
---|---|---|
remoteuser |
string |
Il certificato deve essere visibile agli account utente in cui gli utenti accedono in remoto al nodo di calcolo. |
starttask |
string |
Il certificato deve essere visibile all'account utente in cui viene eseguito StartTask. Si noti che se l'ambito dell'utente automatico è Pool sia per StartTask che per un'attività, questo certificato sarà visibile anche all'attività. |
task |
string |
Il certificato deve essere visibile agli account utente in cui vengono eseguite le attività di processo. |
ComputeNodeIdentityReference
Riferimento a un'identità assegnata dall'utente associata al pool di Batch che verrà usato da un nodo di calcolo.
Nome | Tipo | Descrizione |
---|---|---|
resourceId |
string |
ID risorsa ARM dell'identità assegnata dall'utente. |
ContainerHostBatchBindMountEntry
Voce di percorso e modalità di montaggio da montare nel contenitore di attività.
Nome | Tipo | Descrizione |
---|---|---|
isReadOnly |
boolean |
Montare o meno questo percorso di origine come modalità di sola lettura. Il valore predefinito è false (modalità lettura/scrittura). |
source |
Il percorso che può essere montato nel cliente del contenitore può selezionare. |
ContainerHostDataPath
Percorsi che verranno montati nel contenitore dell'attività contenitore.
Nome | Tipo | Descrizione |
---|---|---|
Applications |
string |
Percorso delle applicazioni. |
JobPrep |
string |
Percorso dell'attività di preparazione del processo. |
Shared |
string |
Percorso dell'attività a più istanze in cui condividere i propri file. |
Startup |
string |
Percorso dell'attività di avvio. |
Task |
string |
Percorso dell'attività. |
VfsMounts |
string |
Il percorso contiene tutti i file system virtuali montati in questo nodo. |
ContainerRegistry
Registro contenitori privato.
Nome | Tipo | Descrizione |
---|---|---|
identityReference |
Riferimento all'identità assegnata dall'utente da usare per accedere a un Registro Azure Container invece di nome utente e password. |
|
password |
string |
Password per accedere al server del Registro di sistema. |
registryServer |
string |
URL del Registro di sistema. |
username |
string |
Nome utente per accedere al server del Registro di sistema. |
ContainerWorkingDirectory
Percorso della directory di lavoro dell'attività del contenitore.
Nome | Tipo | Descrizione |
---|---|---|
containerImageDefault |
string |
Usare la directory di lavoro definita nell'immagine del contenitore. Tenere presente che questa directory non conterrà i file di risorse scaricati da Batch. |
taskWorkingDirectory |
string |
Usare la directory di lavoro dell'attività del servizio Batch standard, che conterrà i file di risorse attività popolati da Batch. |
ElevationLevel
Livello di elevazione dell'utente.
Nome | Tipo | Descrizione |
---|---|---|
admin |
string |
L'utente è un utente con accesso con privilegi elevati e opera con autorizzazioni di amministratore complete. |
nonadmin |
string |
L'utente è un utente standard senza accesso con privilegi elevati. |
EnvironmentSetting
Variabile di ambiente da impostare in un processo task.
Nome | Tipo | Descrizione |
---|---|---|
name |
string |
Nome della variabile di ambiente. |
value |
string |
Valore della variabile di ambiente. |
ErrorMessage
Messaggio di errore ricevuto in una risposta di errore di Azure Batch.
Nome | Tipo | Descrizione |
---|---|---|
lang |
string |
Codice linguistico del messaggio di errore |
value |
string |
Testo del messaggio. |
MetadataItem
Coppia nome-valore associata a una risorsa del servizio Batch.
Nome | Tipo | Descrizione |
---|---|---|
name |
string |
Nome dell'elemento di metadati. |
value |
string |
Valore dell'elemento di metadati. |
NodeCommunicationMode
Determina il modo in cui un pool comunica con il servizio Batch.
Nome | Tipo | Descrizione |
---|---|---|
classic |
string |
I nodi che usano la modalità di comunicazione classica richiedono la comunicazione TCP in ingresso sulle porte 29876 e 29877 da "BatchNodeManagement. Tag del servizio {region}" e comunicazione TCP in uscita sulla porta 443 per "Storage.region" e "BatchNodeManagement. Tag del servizio {region}". |
default |
string |
La modalità di comunicazione del nodo viene impostata automaticamente dal servizio Batch. |
simplified |
string |
I nodi che usano la modalità di comunicazione semplificata richiedono la comunicazione TCP in uscita sulla porta 443 a "BatchNodeManagement. Tag del servizio {region}". Non sono necessarie porte in ingresso aperte. |
PoolUpdatePropertiesParameter
Set di modifiche da apportare a un pool.
Nome | Tipo | Descrizione |
---|---|---|
applicationPackageReferences |
Elenco dei pacchetti dell'applicazione da installare in ogni nodo di calcolo nel pool. |
|
certificateReferences |
Elenco di certificati da installare in ogni nodo di calcolo nel pool. Avviso: questa proprietà è deprecata e verrà rimossa dopo febbraio 2024. Usare invece 'estensione Azure KeyVault. |
|
metadata |
Elenco di coppie nome-valore associate al pool come metadati. |
|
startTask |
Un'attività da eseguire in ogni nodo di calcolo quando viene aggiunto al pool. L'attività viene eseguita quando il nodo di calcolo viene aggiunto al pool o quando il nodo di calcolo viene riavviato. |
|
targetNodeCommunicationMode |
Modalità di comunicazione del nodo desiderata per il pool. |
ResourceFile
Un singolo file o più file da scaricare in un nodo di calcolo.
Nome | Tipo | Descrizione |
---|---|---|
autoStorageContainerName |
string |
Nome del contenitore di archiviazione nell'account di archiviazione automatico. |
blobPrefix |
string |
Prefisso BLOB da usare durante il download di BLOB da un contenitore di Archiviazione di Azure. Verranno scaricati solo i BLOB i cui nomi iniziano con il prefisso specificato. |
fileMode |
string |
Attributo della modalità di autorizzazione file in formato ottale. |
filePath |
string |
Percorso nel nodo di calcolo in cui scaricare i file rispetto alla directory di lavoro dell'attività. |
httpUrl |
string |
URL del file da scaricare. |
identityReference |
Riferimento all'identità assegnata dall'utente da usare per accedere all'archiviazione BLOB di Azure specificata da storageContainerUrl o httpUrl |
|
storageContainerUrl |
string |
URL del contenitore BLOB all'interno di Archiviazione BLOB di Azure. |
StartTask
Attività eseguita quando un nodo viene aggiunto a un pool nel servizio Azure Batch o quando il nodo di calcolo viene riavviato o ricreato l'immagine.
Nome | Tipo | Descrizione |
---|---|---|
commandLine |
string |
Riga di comando di StartTask. |
containerSettings |
Impostazioni per il contenitore in cui viene eseguito StartTask. |
|
environmentSettings |
Elenco delle impostazioni delle variabili di ambiente per StartTask. |
|
maxTaskRetryCount |
integer |
Numero massimo di tentativi dell'attività. |
resourceFiles |
Elenco di file scaricati dal servizio Batch nel nodo di calcolo prima di eseguire la riga di comando. È prevista una dimensione massima per l'elenco dei file di risorse. Quando viene superata la dimensione massima, la richiesta avrà esito negativo e il codice di errore della risposta sarà RequestEntityTooLarge. In questo caso, la raccolta di ResourceFiles deve essere ridotta di dimensioni. A tale scopo, è possibile usare .zip file, pacchetti di applicazioni o contenitori Docker. |
|
userIdentity |
Identità utente con cui viene eseguito StartTask. |
|
waitForSuccess |
boolean |
Indica se il servizio Batch deve attendere il completamento di StartTask( ovvero uscire con il codice di uscita 0) prima di pianificare qualsiasi attività nel nodo di calcolo. |
TaskContainerSettings
Impostazioni del contenitore per un'attività.
Nome | Tipo | Descrizione |
---|---|---|
containerHostBatchBindMounts |
Percorsi da montare nell'attività contenitore. |
|
containerRunOptions |
string |
Opzioni aggiuntive per il comando create del contenitore. |
imageName |
string |
Immagine da usare per creare il contenitore in cui verrà eseguita l'attività. |
registry |
Registro privato che contiene l'immagine del contenitore. |
|
workingDirectory |
Percorso della directory di lavoro dell'attività del contenitore. |
UserIdentity
Definizione dell'identità utente in cui viene eseguita l'attività.
Nome | Tipo | Descrizione |
---|---|---|
autoUser |
Utente automatico con cui viene eseguita l'attività. |
|
username |
string |
Nome dell'identità utente con cui viene eseguita l'attività. |