Condividi tramite

Pool class

  • Riferimento
Pacchetto:
@azure/batch

Classe che rappresenta un pool.

Costruttori

Pool(BatchServiceClientContext)

Creare un pool.

Metodi

add(PoolAddParameter, PoolAddOptionalParams)

Quando si assegnano nomi ai pool, evitare di includere informazioni riservate, ad esempio nomi utente o nomi di progetto segreti. Queste informazioni possono essere visualizzate nei log di telemetria accessibili ai tecnici del supporto Tecnico Microsoft.
add(PoolAddParameter, PoolAddOptionalParams, ServiceCallback<void>)
add(PoolAddParameter, ServiceCallback<void>)
deleteMethod(string, PoolDeleteMethodOptionalParams)

Quando si richiede l'eliminazione di un pool, si verificano le azioni seguenti: lo stato pool è impostato per l'eliminazione; tutte le operazioni di ridimensionamento in corso sul pool vengono arrestate; il servizio Batch avvia il ridimensionamento del pool a zero nodi di calcolo; qualsiasi attività in esecuzione su nodi di calcolo esistenti viene terminata e accodata (come se fosse stata richiesta un'operazione di ridimensionamento del pool con l'opzione di accodamento predefinita); infine, il pool viene rimosso dal sistema. Poiché l'esecuzione di attività viene riquedata, l'utente può rieseguire queste attività aggiornando il processo in modo che venga usata come destinazione un pool diverso. Le attività possono quindi essere eseguite nel nuovo pool. Se si vuole eseguire l'override del comportamento di accodamento, è necessario chiamare ridimensionare il pool in modo esplicito per ridurre le dimensioni del pool a zero prima di eliminare il pool. Se si chiama un'API Update, Patch o Delete in un pool nello stato di eliminazione, l'operazione avrà esito negativo con codice di stato HTTP 409 con codice di errore PoolBeingDeleted.
deleteMethod(string, PoolDeleteMethodOptionalParams, ServiceCallback<void>)
deleteMethod(string, ServiceCallback<void>)
disableAutoScale(string, PoolDisableAutoScaleOptionalParams)
disableAutoScale(string, PoolDisableAutoScaleOptionalParams, ServiceCallback<void>)
disableAutoScale(string, ServiceCallback<void>)
enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams)

Non è possibile abilitare il ridimensionamento automatico in un pool se è in corso un'operazione di ridimensionamento nel pool. Se il ridimensionamento automatico del pool è attualmente disabilitato, è necessario specificare una formula di scalabilità automatica valida come parte della richiesta. Se la scalabilità automatica del pool è già abilitata, è possibile specificare una nuova formula di scalabilità automatica e/o un nuovo intervallo di valutazione. Non è possibile chiamare questa API per lo stesso pool più di una volta ogni 30 secondi.
enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams, ServiceCallback<void>)
enableAutoScale(string, PoolEnableAutoScaleParameter, ServiceCallback<void>)
evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams)

Questa API è principalmente per convalidare una formula di scalabilità automatica, perché restituisce semplicemente il risultato senza applicare la formula al pool. Per valutare una formula, è necessario che il ridimensionamento automatico del pool sia abilitato.
evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams, ServiceCallback<AutoScaleRun>)
evaluateAutoScale(string, string, ServiceCallback<AutoScaleRun>)
exists(string, PoolExistsOptionalParams)

Ottiene le proprietà di base di un pool.
exists(string, PoolExistsOptionalParams, ServiceCallback<boolean>)
exists(string, ServiceCallback<boolean>)
get(string, PoolGetOptionalParams)

Ottiene informazioni sul pool specificato.
get(string, PoolGetOptionalParams, ServiceCallback<CloudPool>)
get(string, ServiceCallback<CloudPool>)
getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams)

Le statistiche vengono aggregate in tutti i pool mai esistenti nell'account, dalla creazione dell'account all'ora dell'ultimo aggiornamento delle statistiche. Le statistiche potrebbero non essere immediatamente disponibili. Il servizio Batch esegue un rollup periodico delle statistiche. Il ritardo tipico è di circa 30 minuti.
getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams, ServiceCallback<PoolStatistics>)
getAllLifetimeStatistics(ServiceCallback<PoolStatistics>)
list(PoolListOptionalParams)
list(PoolListOptionalParams, ServiceCallback<CloudPoolListResult>)
list(ServiceCallback<CloudPoolListResult>)
listNext(string, PoolListNextOptionalParams)
listNext(string, PoolListNextOptionalParams, ServiceCallback<CloudPoolListResult>)
listNext(string, ServiceCallback<CloudPoolListResult>)
listUsageMetrics(PoolListUsageMetricsOptionalParams)

Se non si specifica una clausola $filter che include un poolId, la risposta include tutti i pool presenti nell'account nell'intervallo di tempo degli intervalli di aggregazione restituiti. Se non si specifica una clausola $filter che include un valore startTime o endTime, questi filtri vengono usati per impostazione predefinita per l'ora di inizio e di fine dell'ultimo intervallo di aggregazione attualmente disponibile; ovvero viene restituito solo l'ultimo intervallo di aggregazione.
listUsageMetrics(PoolListUsageMetricsOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)
listUsageMetrics(ServiceCallback<PoolListUsageMetricsResult>)
listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams)

Se non si specifica una clausola $filter che include un poolId, la risposta include tutti i pool presenti nell'account nell'intervallo di tempo degli intervalli di aggregazione restituiti. Se non si specifica una clausola $filter che include un valore startTime o endTime, questi filtri vengono usati per impostazione predefinita per l'ora di inizio e di fine dell'ultimo intervallo di aggregazione attualmente disponibile; ovvero viene restituito solo l'ultimo intervallo di aggregazione.
listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)
listUsageMetricsNext(string, ServiceCallback<PoolListUsageMetricsResult>)
patch(string, PoolPatchParameter, PoolPatchOptionalParams)

Questa operazione sostituisce solo le proprietà del pool specificate nella richiesta. Ad esempio, se al pool è associato un oggetto StartTask e una richiesta non specifica un elemento StartTask, il pool mantiene startTask esistente.
patch(string, PoolPatchParameter, PoolPatchOptionalParams, ServiceCallback<void>)
patch(string, PoolPatchParameter, ServiceCallback<void>)
removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams)

Questa operazione può essere eseguita solo quando lo stato di allocazione del pool è costante. Quando questa operazione viene eseguita, lo stato di allocazione passa dal ridimensionamento costante al ridimensionamento.
removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams, ServiceCallback<void>)
removeNodes(string, NodeRemoveParameter, ServiceCallback<void>)
resize(string, PoolResizeParameter, PoolResizeOptionalParams)

È possibile ridimensionare un pool solo quando lo stato di allocazione è costante. Se il ridimensionamento del pool è già in corso, la richiesta ha esito negativo con codice di stato 409. Quando si ridimensiona un pool, lo stato di allocazione del pool passa dal ridimensionamento costante al ridimensionamento. Non è possibile ridimensionare i pool configurati per il ridimensionamento automatico. Se si tenta di eseguire questa operazione, il servizio Batch restituisce un errore 409. Se si ridimensiona un pool verso il basso, il servizio Batch sceglie i nodi di calcolo da rimuovere. Per rimuovere nodi di calcolo specifici, usare invece l'API Nodi di calcolo per rimuovere i nodi di calcolo.
resize(string, PoolResizeParameter, PoolResizeOptionalParams, ServiceCallback<void>)
resize(string, PoolResizeParameter, ServiceCallback<void>)
stopResize(string, PoolStopResizeOptionalParams)

In questo modo il pool non viene ripristinato allo stato precedente prima dell'operazione di ridimensionamento: interrompe solo eventuali ulteriori modifiche e il pool mantiene lo stato corrente. Dopo l'arresto, il pool si stabilizza al numero di nodi di calcolo in corrispondenza del quale è stata eseguita l'operazione di arresto. Durante l'operazione di arresto, lo stato di allocazione pool passa prima all'arresto e quindi alla costante. Un'operazione di ridimensionamento non deve essere una richiesta esplicita del pool di ridimensionamento; questa API può essere usata anche per interrompere il ridimensionamento iniziale del pool al momento della creazione.
stopResize(string, PoolStopResizeOptionalParams, ServiceCallback<void>)
stopResize(string, ServiceCallback<void>)
updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams)

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.
updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams, ServiceCallback<void>)
updateProperties(string, PoolUpdatePropertiesParameter, ServiceCallback<void>)

Dettagli costruttore

Pool(BatchServiceClientContext)

Creare un pool.

new Pool(client: BatchServiceClientContext)

Parametri

client
BatchServiceClientContext

Riferimento al client del servizio.

Dettagli metodo

add(PoolAddParameter, PoolAddOptionalParams)

Quando si assegnano nomi ai pool, evitare di includere informazioni riservate, ad esempio nomi utente o nomi di progetto segreti. Queste informazioni possono essere visualizzate nei log di telemetria accessibili ai tecnici del supporto Tecnico Microsoft.

function add(pool: PoolAddParameter, options?: PoolAddOptionalParams): Promise<PoolAddResponse>

Parametri

pool
PoolAddParameter

Pool da aggiungere.

options
PoolAddOptionalParams

Parametri facoltativi

Restituisce

Promise<PoolAddResponse>

Promise<Models.PoolAddResponse>

add(PoolAddParameter, PoolAddOptionalParams, ServiceCallback<void>) 

function add(pool: PoolAddParameter, options: PoolAddOptionalParams, callback: ServiceCallback<void>)

Parametri

pool
PoolAddParameter

Pool da aggiungere.

options
PoolAddOptionalParams

Parametri facoltativi

callback

ServiceCallback<void>

Callback

add(PoolAddParameter, ServiceCallback<void>) 

function add(pool: PoolAddParameter, callback: ServiceCallback<void>)

Parametri

pool
PoolAddParameter

Pool da aggiungere.

callback

ServiceCallback<void>

Callback

deleteMethod(string, PoolDeleteMethodOptionalParams)

Quando si richiede l'eliminazione di un pool, si verificano le azioni seguenti: lo stato pool è impostato per l'eliminazione; tutte le operazioni di ridimensionamento in corso sul pool vengono arrestate; il servizio Batch avvia il ridimensionamento del pool a zero nodi di calcolo; qualsiasi attività in esecuzione su nodi di calcolo esistenti viene terminata e accodata (come se fosse stata richiesta un'operazione di ridimensionamento del pool con l'opzione di accodamento predefinita); infine, il pool viene rimosso dal sistema. Poiché l'esecuzione di attività viene riquedata, l'utente può rieseguire queste attività aggiornando il processo in modo che venga usata come destinazione un pool diverso. Le attività possono quindi essere eseguite nel nuovo pool. Se si vuole eseguire l'override del comportamento di accodamento, è necessario chiamare ridimensionare il pool in modo esplicito per ridurre le dimensioni del pool a zero prima di eliminare il pool. Se si chiama un'API Update, Patch o Delete in un pool nello stato di eliminazione, l'operazione avrà esito negativo con codice di stato HTTP 409 con codice di errore PoolBeingDeleted.

function deleteMethod(poolId: string, options?: PoolDeleteMethodOptionalParams): Promise<PoolDeleteResponse>

Parametri

poolId

string

ID del pool da eliminare.

options
PoolDeleteMethodOptionalParams

Parametri facoltativi

Restituisce

Promise<PoolDeleteResponse>

Promise<Models.PoolDeleteResponse>

deleteMethod(string, PoolDeleteMethodOptionalParams, ServiceCallback<void>) 

function deleteMethod(poolId: string, options: PoolDeleteMethodOptionalParams, callback: ServiceCallback<void>)

Parametri

poolId

string

ID del pool da eliminare.

options
PoolDeleteMethodOptionalParams

Parametri facoltativi

callback

ServiceCallback<void>

Callback

deleteMethod(string, ServiceCallback<void>) 

function deleteMethod(poolId: string, callback: ServiceCallback<void>)

Parametri

poolId

string

ID del pool da eliminare.

callback

ServiceCallback<void>

Callback

disableAutoScale(string, PoolDisableAutoScaleOptionalParams) 

function disableAutoScale(poolId: string, options?: PoolDisableAutoScaleOptionalParams): Promise<PoolDisableAutoScaleResponse>

Parametri

poolId

string

ID del pool in cui disabilitare la scalabilità automatica.

options
PoolDisableAutoScaleOptionalParams

Parametri facoltativi

Restituisce

Promise<PoolDisableAutoScaleResponse>

Promise<Models.PoolDisableAutoScaleResponse>

disableAutoScale(string, PoolDisableAutoScaleOptionalParams, ServiceCallback<void>) 

function disableAutoScale(poolId: string, options: PoolDisableAutoScaleOptionalParams, callback: ServiceCallback<void>)

Parametri

poolId

string

ID del pool in cui disabilitare la scalabilità automatica.

options
PoolDisableAutoScaleOptionalParams

Parametri facoltativi

callback

ServiceCallback<void>

Callback

disableAutoScale(string, ServiceCallback<void>) 

function disableAutoScale(poolId: string, callback: ServiceCallback<void>)

Parametri

poolId

string

ID del pool in cui disabilitare la scalabilità automatica.

callback

ServiceCallback<void>

Callback

enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams)

Non è possibile abilitare il ridimensionamento automatico in un pool se è in corso un'operazione di ridimensionamento nel pool. Se il ridimensionamento automatico del pool è attualmente disabilitato, è necessario specificare una formula di scalabilità automatica valida come parte della richiesta. Se la scalabilità automatica del pool è già abilitata, è possibile specificare una nuova formula di scalabilità automatica e/o un nuovo intervallo di valutazione. Non è possibile chiamare questa API per lo stesso pool più di una volta ogni 30 secondi.

function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, options?: PoolEnableAutoScaleOptionalParams): Promise<PoolEnableAutoScaleResponse>

Parametri

poolId

string

ID del pool in cui abilitare il ridimensionamento automatico.

poolEnableAutoScaleParameter
PoolEnableAutoScaleParameter

Parametri per la richiesta.

options
PoolEnableAutoScaleOptionalParams

Parametri facoltativi

Restituisce

Promise<PoolEnableAutoScaleResponse>

Promise<Models.PoolEnableAutoScaleResponse>

enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams, ServiceCallback<void>) 

function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, options: PoolEnableAutoScaleOptionalParams, callback: ServiceCallback<void>)

Parametri

poolId

string

ID del pool in cui abilitare il ridimensionamento automatico.

poolEnableAutoScaleParameter
PoolEnableAutoScaleParameter

Parametri per la richiesta.

options
PoolEnableAutoScaleOptionalParams

Parametri facoltativi

callback

ServiceCallback<void>

Callback

enableAutoScale(string, PoolEnableAutoScaleParameter, ServiceCallback<void>) 

function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, callback: ServiceCallback<void>)

Parametri

poolId

string

ID del pool in cui abilitare il ridimensionamento automatico.

poolEnableAutoScaleParameter
PoolEnableAutoScaleParameter

Parametri per la richiesta.

callback

ServiceCallback<void>

Callback

evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams)

Questa API è principalmente per convalidare una formula di scalabilità automatica, perché restituisce semplicemente il risultato senza applicare la formula al pool. Per valutare una formula, è necessario che il ridimensionamento automatico del pool sia abilitato.

function evaluateAutoScale(poolId: string, autoScaleFormula: string, options?: PoolEvaluateAutoScaleOptionalParams): Promise<PoolEvaluateAutoScaleResponse>

Parametri

poolId

string

ID del pool in cui valutare la formula di ridimensionamento automatico.

autoScaleFormula

string

Formula per il numero desiderato di nodi di calcolo nel pool. La formula viene convalidata e i relativi risultati vengono calcolati, ma non vengono applicati al pool. Per applicare la formula al pool, 'Abilitare il ridimensionamento automatico in un pool'. Per altre informazioni sulla specifica di questa formula, vedere Ridimensionare automaticamente i nodi di calcolo in un pool di Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

options
PoolEvaluateAutoScaleOptionalParams

Parametri facoltativi

Restituisce

Promise<PoolEvaluateAutoScaleResponse>

Promise<Models.PoolEvaluateAutoScaleResponse>

evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams, ServiceCallback<AutoScaleRun>) 

function evaluateAutoScale(poolId: string, autoScaleFormula: string, options: PoolEvaluateAutoScaleOptionalParams, callback: ServiceCallback<AutoScaleRun>)

Parametri

poolId

string

ID del pool in cui valutare la formula di ridimensionamento automatico.

autoScaleFormula

string

Formula per il numero desiderato di nodi di calcolo nel pool. La formula viene convalidata e i relativi risultati vengono calcolati, ma non vengono applicati al pool. Per applicare la formula al pool, 'Abilitare il ridimensionamento automatico in un pool'. Per altre informazioni sulla specifica di questa formula, vedere Ridimensionare automaticamente i nodi di calcolo in un pool di Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

options
PoolEvaluateAutoScaleOptionalParams

Parametri facoltativi

callback

ServiceCallback<AutoScaleRun>

Callback

evaluateAutoScale(string, string, ServiceCallback<AutoScaleRun>) 

function evaluateAutoScale(poolId: string, autoScaleFormula: string, callback: ServiceCallback<AutoScaleRun>)

Parametri

poolId

string

ID del pool in cui valutare la formula di ridimensionamento automatico.

autoScaleFormula

string

Formula per il numero desiderato di nodi di calcolo nel pool. La formula viene convalidata e i relativi risultati vengono calcolati, ma non vengono applicati al pool. Per applicare la formula al pool, 'Abilitare il ridimensionamento automatico in un pool'. Per altre informazioni sulla specifica di questa formula, vedere Ridimensionare automaticamente i nodi di calcolo in un pool di Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

callback

ServiceCallback<AutoScaleRun>

Callback

exists(string, PoolExistsOptionalParams)

Ottiene le proprietà di base di un pool.

function exists(poolId: string, options?: PoolExistsOptionalParams): Promise<PoolExistsResponse>

Parametri

poolId

string

ID del pool da ottenere.

options
PoolExistsOptionalParams

Parametri facoltativi

Restituisce

Promise<PoolExistsResponse>

Promise<Models.PoolExistsResponse>

exists(string, PoolExistsOptionalParams, ServiceCallback<boolean>) 

function exists(poolId: string, options: PoolExistsOptionalParams, callback: ServiceCallback<boolean>)

Parametri

poolId

string

ID del pool da ottenere.

options
PoolExistsOptionalParams

Parametri facoltativi

callback

ServiceCallback<boolean>

Callback

exists(string, ServiceCallback<boolean>) 

function exists(poolId: string, callback: ServiceCallback<boolean>)

Parametri

poolId

string

ID del pool da ottenere.

callback

ServiceCallback<boolean>

Callback

get(string, PoolGetOptionalParams)

Ottiene informazioni sul pool specificato.

function get(poolId: string, options?: PoolGetOptionalParams): Promise<PoolGetResponse>

Parametri

poolId

string

ID del pool da ottenere.

options
PoolGetOptionalParams

Parametri facoltativi

Restituisce

Promise<PoolGetResponse>

Promise<Models.PoolGetResponse>

get(string, PoolGetOptionalParams, ServiceCallback<CloudPool>) 

function get(poolId: string, options: PoolGetOptionalParams, callback: ServiceCallback<CloudPool>)

Parametri

poolId

string

ID del pool da ottenere.

options
PoolGetOptionalParams

Parametri facoltativi

callback

ServiceCallback<CloudPool>

Callback

get(string, ServiceCallback<CloudPool>) 

function get(poolId: string, callback: ServiceCallback<CloudPool>)

Parametri

poolId

string

ID del pool da ottenere.

callback

ServiceCallback<CloudPool>

Callback

getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams)

Le statistiche vengono aggregate in tutti i pool mai esistenti nell'account, dalla creazione dell'account all'ora dell'ultimo aggiornamento delle statistiche. Le statistiche potrebbero non essere immediatamente disponibili. Il servizio Batch esegue un rollup periodico delle statistiche. Il ritardo tipico è di circa 30 minuti.

function getAllLifetimeStatistics(options?: PoolGetAllLifetimeStatisticsOptionalParams): Promise<PoolGetAllLifetimeStatisticsResponse>

Parametri

options
PoolGetAllLifetimeStatisticsOptionalParams

Parametri facoltativi

Restituisce

Promise<PoolGetAllLifetimeStatisticsResponse>

Promise<Models.PoolGetAllLifetimeStatisticsResponse>

getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams, ServiceCallback<PoolStatistics>) 

function getAllLifetimeStatistics(options: PoolGetAllLifetimeStatisticsOptionalParams, callback: ServiceCallback<PoolStatistics>)

Parametri

options
PoolGetAllLifetimeStatisticsOptionalParams

Parametri facoltativi

callback

ServiceCallback<PoolStatistics>

Callback

getAllLifetimeStatistics(ServiceCallback<PoolStatistics>) 

function getAllLifetimeStatistics(callback: ServiceCallback<PoolStatistics>)

Parametri

callback

ServiceCallback<PoolStatistics>

Callback

list(PoolListOptionalParams) 

function list(options?: PoolListOptionalParams): Promise<PoolListResponse>

Parametri

options
PoolListOptionalParams

Parametri facoltativi

Restituisce

Promise<PoolListResponse>

Promise<Models.PoolListResponse>

list(PoolListOptionalParams, ServiceCallback<CloudPoolListResult>) 

function list(options: PoolListOptionalParams, callback: ServiceCallback<CloudPoolListResult>)

Parametri

options
PoolListOptionalParams

Parametri facoltativi

callback

ServiceCallback<CloudPoolListResult>

Callback

list(ServiceCallback<CloudPoolListResult>) 

function list(callback: ServiceCallback<CloudPoolListResult>)

Parametri

callback

ServiceCallback<CloudPoolListResult>

Callback

listNext(string, PoolListNextOptionalParams) 

function listNext(nextPageLink: string, options?: PoolListNextOptionalParams): Promise<PoolListResponse>

Parametri

nextPageLink

string

NextLink della precedente chiamata riuscita all'operazione List.

options
PoolListNextOptionalParams

Parametri facoltativi

Restituisce

Promise<PoolListResponse>

Promise<Models.PoolListResponse>

listNext(string, PoolListNextOptionalParams, ServiceCallback<CloudPoolListResult>) 

function listNext(nextPageLink: string, options: PoolListNextOptionalParams, callback: ServiceCallback<CloudPoolListResult>)

Parametri

nextPageLink

string

NextLink della precedente chiamata riuscita all'operazione List.

options
PoolListNextOptionalParams

Parametri facoltativi

callback

ServiceCallback<CloudPoolListResult>

Callback

listNext(string, ServiceCallback<CloudPoolListResult>) 

function listNext(nextPageLink: string, callback: ServiceCallback<CloudPoolListResult>)

Parametri

nextPageLink

string

NextLink della precedente chiamata riuscita all'operazione List.

callback

ServiceCallback<CloudPoolListResult>

Callback

listUsageMetrics(PoolListUsageMetricsOptionalParams)

Se non si specifica una clausola $filter che include un poolId, la risposta include tutti i pool presenti nell'account nell'intervallo di tempo degli intervalli di aggregazione restituiti. Se non si specifica una clausola $filter che include un valore startTime o endTime, questi filtri vengono usati per impostazione predefinita per l'ora di inizio e di fine dell'ultimo intervallo di aggregazione attualmente disponibile; ovvero viene restituito solo l'ultimo intervallo di aggregazione.

function listUsageMetrics(options?: PoolListUsageMetricsOptionalParams): Promise<PoolListUsageMetricsResponse>

Parametri

options
PoolListUsageMetricsOptionalParams

Parametri facoltativi

Restituisce

Promise<PoolListUsageMetricsResponse>

Promise<Models.PoolListUsageMetricsResponse>

listUsageMetrics(PoolListUsageMetricsOptionalParams, ServiceCallback<PoolListUsageMetricsResult>) 

function listUsageMetrics(options: PoolListUsageMetricsOptionalParams, callback: ServiceCallback<PoolListUsageMetricsResult>)

Parametri

options
PoolListUsageMetricsOptionalParams

Parametri facoltativi

callback

ServiceCallback<PoolListUsageMetricsResult>

Callback

listUsageMetrics(ServiceCallback<PoolListUsageMetricsResult>) 

function listUsageMetrics(callback: ServiceCallback<PoolListUsageMetricsResult>)

Parametri

callback

ServiceCallback<PoolListUsageMetricsResult>

Callback

listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams)

Se non si specifica una clausola $filter che include un poolId, la risposta include tutti i pool presenti nell'account nell'intervallo di tempo degli intervalli di aggregazione restituiti. Se non si specifica una clausola $filter che include un valore startTime o endTime, questi filtri vengono usati per impostazione predefinita per l'ora di inizio e di fine dell'ultimo intervallo di aggregazione attualmente disponibile; ovvero viene restituito solo l'ultimo intervallo di aggregazione.

function listUsageMetricsNext(nextPageLink: string, options?: PoolListUsageMetricsNextOptionalParams): Promise<PoolListUsageMetricsResponse>

Parametri

nextPageLink

string

NextLink della precedente chiamata riuscita all'operazione List.

options
PoolListUsageMetricsNextOptionalParams

Parametri facoltativi

Restituisce

Promise<PoolListUsageMetricsResponse>

Promise<Models.PoolListUsageMetricsResponse>

listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams, ServiceCallback<PoolListUsageMetricsResult>) 

function listUsageMetricsNext(nextPageLink: string, options: PoolListUsageMetricsNextOptionalParams, callback: ServiceCallback<PoolListUsageMetricsResult>)

Parametri

nextPageLink

string

NextLink della precedente chiamata riuscita all'operazione List.

options
PoolListUsageMetricsNextOptionalParams

Parametri facoltativi

callback

ServiceCallback<PoolListUsageMetricsResult>

Callback

listUsageMetricsNext(string, ServiceCallback<PoolListUsageMetricsResult>) 

function listUsageMetricsNext(nextPageLink: string, callback: ServiceCallback<PoolListUsageMetricsResult>)

Parametri

nextPageLink

string

NextLink della precedente chiamata riuscita all'operazione List.

callback

ServiceCallback<PoolListUsageMetricsResult>

Callback

patch(string, PoolPatchParameter, PoolPatchOptionalParams)

Questa operazione sostituisce solo le proprietà del pool specificate nella richiesta. Ad esempio, se al pool è associato un oggetto StartTask e una richiesta non specifica un elemento StartTask, il pool mantiene startTask esistente.

function patch(poolId: string, poolPatchParameter: PoolPatchParameter, options?: PoolPatchOptionalParams): Promise<PoolPatchResponse>

Parametri

poolId

string

ID del pool da aggiornare.

poolPatchParameter
PoolPatchParameter

Parametri per la richiesta.

options
PoolPatchOptionalParams

Parametri facoltativi

Restituisce

Promise<PoolPatchResponse>

Promise<Models.PoolPatchResponse>

patch(string, PoolPatchParameter, PoolPatchOptionalParams, ServiceCallback<void>) 

function patch(poolId: string, poolPatchParameter: PoolPatchParameter, options: PoolPatchOptionalParams, callback: ServiceCallback<void>)

Parametri

poolId

string

ID del pool da aggiornare.

poolPatchParameter
PoolPatchParameter

Parametri per la richiesta.

options
PoolPatchOptionalParams

Parametri facoltativi

callback

ServiceCallback<void>

Callback

patch(string, PoolPatchParameter, ServiceCallback<void>) 

function patch(poolId: string, poolPatchParameter: PoolPatchParameter, callback: ServiceCallback<void>)

Parametri

poolId

string

ID del pool da aggiornare.

poolPatchParameter
PoolPatchParameter

Parametri per la richiesta.

callback

ServiceCallback<void>

Callback

removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams)

Questa operazione può essere eseguita solo quando lo stato di allocazione del pool è costante. Quando questa operazione viene eseguita, lo stato di allocazione passa dal ridimensionamento costante al ridimensionamento.

function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, options?: PoolRemoveNodesOptionalParams): Promise<PoolRemoveNodesResponse>

Parametri

poolId

string

ID del pool da cui si desidera rimuovere i nodi di calcolo.

nodeRemoveParameter
NodeRemoveParameter

Parametri per la richiesta.

options
PoolRemoveNodesOptionalParams

Parametri facoltativi

Restituisce

Promise<PoolRemoveNodesResponse>

Promise<Models.PoolRemoveNodesResponse>

removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams, ServiceCallback<void>) 

function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, options: PoolRemoveNodesOptionalParams, callback: ServiceCallback<void>)

Parametri

poolId

string

ID del pool da cui si desidera rimuovere i nodi di calcolo.

nodeRemoveParameter
NodeRemoveParameter

Parametri per la richiesta.

options
PoolRemoveNodesOptionalParams

Parametri facoltativi

callback

ServiceCallback<void>

Callback

removeNodes(string, NodeRemoveParameter, ServiceCallback<void>) 

function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, callback: ServiceCallback<void>)

Parametri

poolId

string

ID del pool da cui si desidera rimuovere i nodi di calcolo.

nodeRemoveParameter
NodeRemoveParameter

Parametri per la richiesta.

callback

ServiceCallback<void>

Callback

resize(string, PoolResizeParameter, PoolResizeOptionalParams)

È possibile ridimensionare un pool solo quando lo stato di allocazione è costante. Se il ridimensionamento del pool è già in corso, la richiesta ha esito negativo con codice di stato 409. Quando si ridimensiona un pool, lo stato di allocazione del pool passa dal ridimensionamento costante al ridimensionamento. Non è possibile ridimensionare i pool configurati per il ridimensionamento automatico. Se si tenta di eseguire questa operazione, il servizio Batch restituisce un errore 409. Se si ridimensiona un pool verso il basso, il servizio Batch sceglie i nodi di calcolo da rimuovere. Per rimuovere nodi di calcolo specifici, usare invece l'API Nodi di calcolo per rimuovere i nodi di calcolo.

function resize(poolId: string, poolResizeParameter: PoolResizeParameter, options?: PoolResizeOptionalParams): Promise<PoolResizeResponse>

Parametri

poolId

string

ID del pool da ridimensionare.

poolResizeParameter
PoolResizeParameter

Parametri per la richiesta.

options
PoolResizeOptionalParams

Parametri facoltativi

Restituisce

Promise<PoolResizeResponse>

Promise<Models.PoolResizeResponse>

resize(string, PoolResizeParameter, PoolResizeOptionalParams, ServiceCallback<void>) 

function resize(poolId: string, poolResizeParameter: PoolResizeParameter, options: PoolResizeOptionalParams, callback: ServiceCallback<void>)

Parametri

poolId

string

ID del pool da ridimensionare.

poolResizeParameter
PoolResizeParameter

Parametri per la richiesta.

options
PoolResizeOptionalParams

Parametri facoltativi

callback

ServiceCallback<void>

Callback

resize(string, PoolResizeParameter, ServiceCallback<void>) 

function resize(poolId: string, poolResizeParameter: PoolResizeParameter, callback: ServiceCallback<void>)

Parametri

poolId

string

ID del pool da ridimensionare.

poolResizeParameter
PoolResizeParameter

Parametri per la richiesta.

callback

ServiceCallback<void>

Callback

stopResize(string, PoolStopResizeOptionalParams)

In questo modo il pool non viene ripristinato allo stato precedente prima dell'operazione di ridimensionamento: interrompe solo eventuali ulteriori modifiche e il pool mantiene lo stato corrente. Dopo l'arresto, il pool si stabilizza al numero di nodi di calcolo in corrispondenza del quale è stata eseguita l'operazione di arresto. Durante l'operazione di arresto, lo stato di allocazione pool passa prima all'arresto e quindi alla costante. Un'operazione di ridimensionamento non deve essere una richiesta esplicita del pool di ridimensionamento; questa API può essere usata anche per interrompere il ridimensionamento iniziale del pool al momento della creazione.

function stopResize(poolId: string, options?: PoolStopResizeOptionalParams): Promise<PoolStopResizeResponse>

Parametri

poolId

string

ID del pool di cui si vuole arrestare il ridimensionamento.

options
PoolStopResizeOptionalParams

Parametri facoltativi

Restituisce

Promise<PoolStopResizeResponse>

Promise<Models.PoolStopResponse>

stopResize(string, PoolStopResizeOptionalParams, ServiceCallback<void>) 

function stopResize(poolId: string, options: PoolStopResizeOptionalParams, callback: ServiceCallback<void>)

Parametri

poolId

string

ID del pool di cui si vuole arrestare il ridimensionamento.

options
PoolStopResizeOptionalParams

Parametri facoltativi

callback

ServiceCallback<void>

Callback

stopResize(string, ServiceCallback<void>) 

function stopResize(poolId: string, callback: ServiceCallback<void>)

Parametri

poolId

string

ID del pool di cui si vuole arrestare il ridimensionamento.

callback

ServiceCallback<void>

Callback

updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams)

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.

function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, options?: PoolUpdatePropertiesOptionalParams): Promise<PoolUpdatePropertiesResponse>

Parametri

poolId

string

ID del pool da aggiornare.

poolUpdatePropertiesParameter
PoolUpdatePropertiesParameter

Parametri per la richiesta.

options
PoolUpdatePropertiesOptionalParams

Parametri facoltativi

Restituisce

Promise<PoolUpdatePropertiesResponse>

Promise<Models.PoolUpdatePropertiesResponse>

updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams, ServiceCallback<void>) 

function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, options: PoolUpdatePropertiesOptionalParams, callback: ServiceCallback<void>)

Parametri

poolId

string

ID del pool da aggiornare.

poolUpdatePropertiesParameter
PoolUpdatePropertiesParameter

Parametri per la richiesta.

options
PoolUpdatePropertiesOptionalParams

Parametri facoltativi

callback

ServiceCallback<void>

Callback

updateProperties(string, PoolUpdatePropertiesParameter, ServiceCallback<void>) 

function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, callback: ServiceCallback<void>)

Parametri

poolId

string

ID del pool da aggiornare.

poolUpdatePropertiesParameter
PoolUpdatePropertiesParameter

Parametri per la richiesta.

callback

ServiceCallback<void>

Callback