Pool class

Pacote:: @azure/batch

Classe que representa um Pool.

Construtores

Crie um pool.

Métodos

add(PoolAddParameter, PoolAddOptionalParams)	Ao nomear Pools, evite incluir informações confidenciais, como nomes de usuários ou nomes de projetos secretos. Essas informações podem aparecer em logs de telemetria acessíveis aos engenheiros de suporte da Microsoft.
add(PoolAddParameter, PoolAddOptionalParams, ServiceCallback<void>)
add(PoolAddParameter, ServiceCallback<void>)
deleteMethod(string, PoolDeleteMethodOptionalParams)	Quando você solicita que um Pool seja excluído, as seguintes ações ocorrem: o estado do Pool é definido como exclusão; qualquer operação de redimensionamento em curso no Pool é interrompida; o serviço de lote começa a redimensionar o pool para zero nós de computação; todas as tarefas em execução em nós de computação existentes são encerradas e colocadas novamente na fila (como se uma operação de pool de redimensionamento tivesse sido solicitada com a opção de refila padrão); finalmente, o Pool é removido do sistema. Como as Tarefas em execução são enfileiradas novamente, o usuário pode executar novamente essas Tarefas atualizando seu Trabalho para direcionar um Pool diferente. As Tarefas podem ser executadas no novo Pool. Se quiser substituir o comportamento de refila de reenfileiramento, chame o Pool de redimensionamento explicitamente para reduzir o Pool para o tamanho zero antes de excluí-lo. Se você chamar uma API de Atualização, Patch ou Exclusão em um Pool no estado de exclusão, ela falhará com o código de status HTTP 409 com o código de erro 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)	Não é possível habilitar o dimensionamento automático em um Pool se uma operação de redimensionamento estiver em andamento no Pool. Se o dimensionamento automático do Pool estiver desabilitado no momento, você deverá especificar uma fórmula de dimensionamento automático válida como parte da solicitação. Se o dimensionamento automático do Pool já estiver habilitado, você poderá especificar uma nova fórmula de dimensionamento automático e/ou um novo intervalo de avaliação. Não é possível chamar essa API para o mesmo Pool mais de uma vez a cada 30 segundos.
enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams, ServiceCallback<void>)
enableAutoScale(string, PoolEnableAutoScaleParameter, ServiceCallback<void>)
evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams)	Esta API destina-se principalmente a validar uma fórmula de escala automática, uma vez que simplesmente devolve o resultado sem aplicar a fórmula ao Pool. O Pool deve ter o dimensionamento automático habilitado para avaliar uma fórmula.
evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams, ServiceCallback<AutoScaleRun>)
evaluateAutoScale(string, string, ServiceCallback<AutoScaleRun>)
exists(string, PoolExistsOptionalParams)	Obtém propriedades básicas de um Pool.
exists(string, PoolExistsOptionalParams, ServiceCallback<boolean>)
exists(string, ServiceCallback<boolean>)
get(string, PoolGetOptionalParams)	Obtém informações sobre o Pool especificado.
get(string, PoolGetOptionalParams, ServiceCallback<CloudPool>)
get(string, ServiceCallback<CloudPool>)
getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams)	As estatísticas são agregadas em todos os Pools que já existiram na Conta, desde a criação da Conta até a hora da última atualização das estatísticas. As estatísticas podem não estar imediatamente disponíveis. O serviço Batch executa o roll-up periódico de estatísticas. O atraso típico é de cerca de 30 minutos.
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 você não especificar uma cláusula $filter incluindo um poolId, a resposta incluirá todos os Pools que existiam na Conta no intervalo de tempo dos intervalos de agregação retornados. Se você não especificar uma cláusula $filter incluindo startTime ou endTime, esses filtros serão padronizados para as horas de início e término do último intervalo de agregação atualmente disponível; ou seja, apenas o último intervalo de agregação é retornado.
listUsageMetrics(PoolListUsageMetricsOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)
listUsageMetrics(ServiceCallback<PoolListUsageMetricsResult>)
listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams)	Se você não especificar uma cláusula $filter incluindo um poolId, a resposta incluirá todos os Pools que existiam na Conta no intervalo de tempo dos intervalos de agregação retornados. Se você não especificar uma cláusula $filter incluindo startTime ou endTime, esses filtros serão padronizados para as horas de início e término do último intervalo de agregação atualmente disponível; ou seja, apenas o último intervalo de agregação é retornado.
listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)
listUsageMetricsNext(string, ServiceCallback<PoolListUsageMetricsResult>)
patch(string, PoolPatchParameter, PoolPatchOptionalParams)	Isso substitui apenas as propriedades do Pool especificadas na solicitação. Por exemplo, se o Pool tiver um StartTask associado a ele e uma solicitação não especificar um elemento StartTask, o Pool manterá o StartTask existente.
patch(string, PoolPatchParameter, PoolPatchOptionalParams, ServiceCallback<void>)
patch(string, PoolPatchParameter, ServiceCallback<void>)
removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams)	Essa operação só pode ser executada quando o estado de alocação do Pool estiver estável. Quando essa operação é executada, o estado de alocação muda de estável para redimensionamento.
removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams, ServiceCallback<void>)
removeNodes(string, NodeRemoveParameter, ServiceCallback<void>)
resize(string, PoolResizeParameter, PoolResizeOptionalParams)	Você só pode redimensionar um Pool quando seu estado de alocação estiver estável. Se o Pool já estiver redimensionando, a solicitação falhará com o código de status 409. Quando você redimensiona um Pool, o estado de alocação do Pool muda de estável para redimensionamento. Não é possível redimensionar pools configurados para dimensionamento automático. Se você tentar fazer isso, o serviço de lote retorna um erro 409. Se você redimensionar um pool para baixo, o serviço de lote escolhe quais nós de computação remover. Para remover nós de computação específicos, use a API de remoção de nós de computação do pool.
resize(string, PoolResizeParameter, PoolResizeOptionalParams, ServiceCallback<void>)
resize(string, PoolResizeParameter, ServiceCallback<void>)
stopResize(string, PoolStopResizeOptionalParams)	Isso não restaura o Pool ao seu estado anterior antes da operação de redimensionamento: ele apenas interrompe quaisquer outras alterações que estão sendo feitas, e o Pool mantém seu estado atual. Após a parada, o Pool se estabiliza no número de nós de computação em que estava quando a operação de parada foi concluída. Durante a operação stop, o estado de alocação do Pool muda primeiro para parar e depois para estável. Uma operação de redimensionamento não precisa ser uma solicitação explícita de redimensionamento de pool; essa API também pode ser usada para interromper o dimensionamento inicial do Pool quando ele é criado.
stopResize(string, PoolStopResizeOptionalParams, ServiceCallback<void>)
stopResize(string, ServiceCallback<void>)
updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams)	Isso substitui totalmente todas as propriedades atualizáveis do Pool. Por exemplo, se o Pool tiver um StartTask associado a ele e se StartTask não for especificado com essa solicitação, o serviço em lote removerá o StartTask existente.
updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams, ServiceCallback<void>)
updateProperties(string, PoolUpdatePropertiesParameter, ServiceCallback<void>)

Detalhes do Construtor

Pool(BatchServiceClientContext)

Crie um pool.

new Pool(client: BatchServiceClientContext)

Parâmetros

client: BatchServiceClientContext

Referência ao cliente do serviço.

Detalhes de Método

add(PoolAddParameter, PoolAddOptionalParams)

Ao nomear Pools, evite incluir informações confidenciais, como nomes de usuários ou nomes de projetos secretos. Essas informações podem aparecer em logs de telemetria acessíveis aos engenheiros de suporte da Microsoft.

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

Parâmetros

pool: PoolAddParameter

O Pool a ser adicionado.

options: PoolAddOptionalParams

Os parâmetros opcionais

Devoluções

Promise<PoolAddResponse>

Modelos de Promessa.PoolAddResponse<>

add(PoolAddParameter, PoolAddOptionalParams, ServiceCallback<void>)

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

Parâmetros

pool: PoolAddParameter

O Pool a ser adicionado.

options: PoolAddOptionalParams

Os parâmetros opcionais

callback: ServiceCallback<void>

O retorno de chamada

add(PoolAddParameter, ServiceCallback<void>)

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

Parâmetros

pool: PoolAddParameter

O Pool a ser adicionado.

callback: ServiceCallback<void>

O retorno de chamada

deleteMethod(string, PoolDeleteMethodOptionalParams)

Quando você solicita que um Pool seja excluído, as seguintes ações ocorrem: o estado do Pool é definido como exclusão; qualquer operação de redimensionamento em curso no Pool é interrompida; o serviço de lote começa a redimensionar o pool para zero nós de computação; todas as tarefas em execução em nós de computação existentes são encerradas e colocadas novamente na fila (como se uma operação de pool de redimensionamento tivesse sido solicitada com a opção de refila padrão); finalmente, o Pool é removido do sistema. Como as Tarefas em execução são enfileiradas novamente, o usuário pode executar novamente essas Tarefas atualizando seu Trabalho para direcionar um Pool diferente. As Tarefas podem ser executadas no novo Pool. Se quiser substituir o comportamento de refila de reenfileiramento, chame o Pool de redimensionamento explicitamente para reduzir o Pool para o tamanho zero antes de excluí-lo. Se você chamar uma API de Atualização, Patch ou Exclusão em um Pool no estado de exclusão, ela falhará com o código de status HTTP 409 com o código de erro PoolBeingDeleted.

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

Parâmetros

poolId: string

A ID do Pool a ser excluído.

options: PoolDeleteMethodOptionalParams

Os parâmetros opcionais

Devoluções

Promise<PoolDeleteResponse>

Modelos de promessa.PoolDeleteResponse<>

deleteMethod(string, PoolDeleteMethodOptionalParams, ServiceCallback<void>)

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

Parâmetros

poolId: string

A ID do Pool a ser excluído.

options: PoolDeleteMethodOptionalParams

Os parâmetros opcionais

callback: ServiceCallback<void>

O retorno de chamada

deleteMethod(string, ServiceCallback<void>)

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

Parâmetros

poolId: string

A ID do Pool a ser excluído.

callback: ServiceCallback<void>

O retorno de chamada

disableAutoScale(string, PoolDisableAutoScaleOptionalParams)

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

Parâmetros

poolId: string

A ID do Pool no qual desativar o dimensionamento automático.

options: PoolDisableAutoScaleOptionalParams

Os parâmetros opcionais

Devoluções

Promise<PoolDisableAutoScaleResponse>

Modelos de promessa.PoolDisableAutoScaleResponse<>

disableAutoScale(string, PoolDisableAutoScaleOptionalParams, ServiceCallback<void>)

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

Parâmetros

poolId: string

A ID do Pool no qual desativar o dimensionamento automático.

options: PoolDisableAutoScaleOptionalParams

Os parâmetros opcionais

callback: ServiceCallback<void>

O retorno de chamada

disableAutoScale(string, ServiceCallback<void>)

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

Parâmetros

poolId: string

A ID do Pool no qual desativar o dimensionamento automático.

callback: ServiceCallback<void>

O retorno de chamada

enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams)

Não é possível habilitar o dimensionamento automático em um Pool se uma operação de redimensionamento estiver em andamento no Pool. Se o dimensionamento automático do Pool estiver desabilitado no momento, você deverá especificar uma fórmula de dimensionamento automático válida como parte da solicitação. Se o dimensionamento automático do Pool já estiver habilitado, você poderá especificar uma nova fórmula de dimensionamento automático e/ou um novo intervalo de avaliação. Não é possível chamar essa API para o mesmo Pool mais de uma vez a cada 30 segundos.

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

Parâmetros

poolId: string

A ID do Pool no qual habilitar o dimensionamento automático.

poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter

Os parâmetros para a solicitação.

options: PoolEnableAutoScaleOptionalParams

Os parâmetros opcionais

Devoluções

Promise<PoolEnableAutoScaleResponse>

Modelos de promessa.PoolEnableAutoScaleResponse<>

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

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

Parâmetros

poolId: string

A ID do Pool no qual habilitar o dimensionamento automático.

poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter

Os parâmetros para a solicitação.

options: PoolEnableAutoScaleOptionalParams

Os parâmetros opcionais

callback: ServiceCallback<void>

O retorno de chamada

enableAutoScale(string, PoolEnableAutoScaleParameter, ServiceCallback<void>)

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

Parâmetros

poolId: string

A ID do Pool no qual habilitar o dimensionamento automático.

poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter

Os parâmetros para a solicitação.

callback: ServiceCallback<void>

O retorno de chamada

evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams)

Esta API destina-se principalmente a validar uma fórmula de escala automática, uma vez que simplesmente devolve o resultado sem aplicar a fórmula ao Pool. O Pool deve ter o dimensionamento automático habilitado para avaliar uma fórmula.

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

Parâmetros

poolId: string

A ID do Pool no qual avaliar a fórmula de dimensionamento automático.

autoScaleFormula: string

A fórmula para o número desejado de nós de computação no pool. A fórmula é validada e seus resultados calculados, mas não é aplicada ao Pool. Para aplicar a fórmula ao Pool, 'Ativar dimensionamento automático em um Pool'. Para obter mais informações sobre como especificar essa fórmula, consulte Dimensionar automaticamente nós de computação em um pool de lotes do Azure (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

options: PoolEvaluateAutoScaleOptionalParams

Os parâmetros opcionais

Devoluções

Promise<PoolEvaluateAutoScaleResponse>

Modelos de promessa.PoolEvaluateAutoScaleResponse<>

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

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

Parâmetros

poolId: string

A ID do Pool no qual avaliar a fórmula de dimensionamento automático.

autoScaleFormula: string

options: PoolEvaluateAutoScaleOptionalParams

Os parâmetros opcionais

callback: ServiceCallback<AutoScaleRun>

O retorno de chamada

evaluateAutoScale(string, string, ServiceCallback<AutoScaleRun>)

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

Parâmetros

poolId: string

A ID do Pool no qual avaliar a fórmula de dimensionamento automático.

autoScaleFormula: string

callback: ServiceCallback<AutoScaleRun>

O retorno de chamada

exists(string, PoolExistsOptionalParams)

Obtém propriedades básicas de um Pool.

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

Parâmetros

poolId: string

A ID do Pool a ser obtida.

options: PoolExistsOptionalParams

Os parâmetros opcionais

Devoluções

Promise<PoolExistsResponse>

Modelos de Promessa.PoolExistsResponse<>

exists(string, PoolExistsOptionalParams, ServiceCallback<boolean>)

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

Parâmetros

poolId: string

A ID do Pool a ser obtida.

options: PoolExistsOptionalParams

Os parâmetros opcionais

callback: ServiceCallback<boolean>

O retorno de chamada

exists(string, ServiceCallback<boolean>)

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

Parâmetros

poolId: string

A ID do Pool a ser obtida.

callback: ServiceCallback<boolean>

O retorno de chamada

get(string, PoolGetOptionalParams)

Obtém informações sobre o Pool especificado.

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

Parâmetros

poolId: string

A ID do Pool a ser obtida.

options: PoolGetOptionalParams

Os parâmetros opcionais

Devoluções

Promise<PoolGetResponse>

Modelos de promessa.PoolGetResponse<>

get(string, PoolGetOptionalParams, ServiceCallback<CloudPool>)

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

Parâmetros

poolId: string

A ID do Pool a ser obtida.

options: PoolGetOptionalParams

Os parâmetros opcionais

callback: ServiceCallback<CloudPool>

O retorno de chamada

get(string, ServiceCallback<CloudPool>)

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

Parâmetros

poolId: string

A ID do Pool a ser obtida.

callback: ServiceCallback<CloudPool>

O retorno de chamada

getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams)

As estatísticas são agregadas em todos os Pools que já existiram na Conta, desde a criação da Conta até a hora da última atualização das estatísticas. As estatísticas podem não estar imediatamente disponíveis. O serviço Batch executa o roll-up periódico de estatísticas. O atraso típico é de cerca de 30 minutos.

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

Parâmetros

options: PoolGetAllLifetimeStatisticsOptionalParams

Os parâmetros opcionais

Devoluções

Promise<PoolGetAllLifetimeStatisticsResponse>

Modelos de promessa.PoolGetAllLifetimeStatisticsResponse<>

getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams, ServiceCallback<PoolStatistics>)

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

Parâmetros

options: PoolGetAllLifetimeStatisticsOptionalParams

Os parâmetros opcionais

callback: ServiceCallback<PoolStatistics>

O retorno de chamada

getAllLifetimeStatistics(ServiceCallback<PoolStatistics>)

function getAllLifetimeStatistics(callback: ServiceCallback<PoolStatistics>)

Parâmetros

callback: ServiceCallback<PoolStatistics>

O retorno de chamada

list(PoolListOptionalParams)

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

Parâmetros

options: PoolListOptionalParams

Os parâmetros opcionais

Devoluções

Promise<PoolListResponse>

Prometa<> Models.PoolListResponse

list(PoolListOptionalParams, ServiceCallback<CloudPoolListResult>)

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

Parâmetros

options: PoolListOptionalParams

Os parâmetros opcionais

callback: ServiceCallback<CloudPoolListResult>

O retorno de chamada

list(ServiceCallback<CloudPoolListResult>)

function list(callback: ServiceCallback<CloudPoolListResult>)

Parâmetros

callback: ServiceCallback<CloudPoolListResult>

O retorno de chamada

listNext(string, PoolListNextOptionalParams)

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

Parâmetros

nextPageLink: string

O NextLink da operação anterior de chamada bem-sucedida para List.

options: PoolListNextOptionalParams

Os parâmetros opcionais

Devoluções

Promise<PoolListResponse>

Prometa<> Models.PoolListResponse

listNext(string, PoolListNextOptionalParams, ServiceCallback<CloudPoolListResult>)

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

Parâmetros

nextPageLink: string

O NextLink da operação anterior de chamada bem-sucedida para List.

options: PoolListNextOptionalParams

Os parâmetros opcionais

callback: ServiceCallback<CloudPoolListResult>

O retorno de chamada

listNext(string, ServiceCallback<CloudPoolListResult>)

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

Parâmetros

nextPageLink: string

O NextLink da operação anterior de chamada bem-sucedida para List.

callback: ServiceCallback<CloudPoolListResult>

O retorno de chamada

listUsageMetrics(PoolListUsageMetricsOptionalParams)

Se você não especificar uma cláusula $filter incluindo um poolId, a resposta incluirá todos os Pools que existiam na Conta no intervalo de tempo dos intervalos de agregação retornados. Se você não especificar uma cláusula $filter incluindo startTime ou endTime, esses filtros serão padronizados para as horas de início e término do último intervalo de agregação atualmente disponível; ou seja, apenas o último intervalo de agregação é retornado.

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

Parâmetros

options: PoolListUsageMetricsOptionalParams

Os parâmetros opcionais

Devoluções

Promise<PoolListUsageMetricsResponse>

Prometa<Models.PoolListUsageMetricsResponse>

listUsageMetrics(PoolListUsageMetricsOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)

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

Parâmetros

options: PoolListUsageMetricsOptionalParams

Os parâmetros opcionais

callback: ServiceCallback<PoolListUsageMetricsResult>

O retorno de chamada

listUsageMetrics(ServiceCallback<PoolListUsageMetricsResult>)

function listUsageMetrics(callback: ServiceCallback<PoolListUsageMetricsResult>)

Parâmetros

callback: ServiceCallback<PoolListUsageMetricsResult>

O retorno de chamada

listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams)

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

Parâmetros

nextPageLink: string

O NextLink da operação anterior de chamada bem-sucedida para List.

options: PoolListUsageMetricsNextOptionalParams

Os parâmetros opcionais

Devoluções

Promise<PoolListUsageMetricsResponse>

Prometa<Models.PoolListUsageMetricsResponse>

listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)

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

Parâmetros

nextPageLink: string

O NextLink da operação anterior de chamada bem-sucedida para List.

options: PoolListUsageMetricsNextOptionalParams

Os parâmetros opcionais

callback: ServiceCallback<PoolListUsageMetricsResult>

O retorno de chamada

listUsageMetricsNext(string, ServiceCallback<PoolListUsageMetricsResult>)

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

Parâmetros

nextPageLink: string

O NextLink da operação anterior de chamada bem-sucedida para List.

callback: ServiceCallback<PoolListUsageMetricsResult>

O retorno de chamada

patch(string, PoolPatchParameter, PoolPatchOptionalParams)

Isso substitui apenas as propriedades do Pool especificadas na solicitação. Por exemplo, se o Pool tiver um StartTask associado a ele e uma solicitação não especificar um elemento StartTask, o Pool manterá o StartTask existente.

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

Parâmetros

poolId: string

A ID do Pool a ser atualizado.

poolPatchParameter: PoolPatchParameter

Os parâmetros para a solicitação.

options: PoolPatchOptionalParams

Os parâmetros opcionais

Devoluções

Promise<PoolPatchResponse>

Modelos de promessa.PoolPatchResponse<>

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

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

Parâmetros

poolId: string

A ID do Pool a ser atualizado.

poolPatchParameter: PoolPatchParameter

Os parâmetros para a solicitação.

options: PoolPatchOptionalParams

Os parâmetros opcionais

callback: ServiceCallback<void>

O retorno de chamada

patch(string, PoolPatchParameter, ServiceCallback<void>)

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

Parâmetros

poolId: string

A ID do Pool a ser atualizado.

poolPatchParameter: PoolPatchParameter

Os parâmetros para a solicitação.

callback: ServiceCallback<void>

O retorno de chamada

removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams)

Essa operação só pode ser executada quando o estado de alocação do Pool estiver estável. Quando essa operação é executada, o estado de alocação muda de estável para redimensionamento.

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

Parâmetros

poolId: string

A ID do Pool do qual você deseja remover nós de computação.

nodeRemoveParameter: NodeRemoveParameter

Os parâmetros para a solicitação.

options: PoolRemoveNodesOptionalParams

Os parâmetros opcionais

Devoluções

Promise<PoolRemoveNodesResponse>

Modelos de promessa.PoolRemoveNodesResponse<>

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

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

Parâmetros

poolId: string

A ID do Pool do qual você deseja remover nós de computação.

nodeRemoveParameter: NodeRemoveParameter

Os parâmetros para a solicitação.

options: PoolRemoveNodesOptionalParams

Os parâmetros opcionais

callback: ServiceCallback<void>

O retorno de chamada

removeNodes(string, NodeRemoveParameter, ServiceCallback<void>)

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

Parâmetros

poolId: string

A ID do Pool do qual você deseja remover nós de computação.

nodeRemoveParameter: NodeRemoveParameter

Os parâmetros para a solicitação.

callback: ServiceCallback<void>

O retorno de chamada

resize(string, PoolResizeParameter, PoolResizeOptionalParams)

Você só pode redimensionar um Pool quando seu estado de alocação estiver estável. Se o Pool já estiver redimensionando, a solicitação falhará com o código de status 409. Quando você redimensiona um Pool, o estado de alocação do Pool muda de estável para redimensionamento. Não é possível redimensionar pools configurados para dimensionamento automático. Se você tentar fazer isso, o serviço de lote retorna um erro 409. Se você redimensionar um pool para baixo, o serviço de lote escolhe quais nós de computação remover. Para remover nós de computação específicos, use a API de remoção de nós de computação do pool.

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

Parâmetros

poolId: string

A ID do Pool a ser redimensionado.

poolResizeParameter: PoolResizeParameter

Os parâmetros para a solicitação.

options: PoolResizeOptionalParams

Os parâmetros opcionais

Devoluções

Promise<PoolResizeResponse>

Modelos de promessa.PoolResizeResponse<>

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

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

Parâmetros

poolId: string

A ID do Pool a ser redimensionado.

poolResizeParameter: PoolResizeParameter

Os parâmetros para a solicitação.

options: PoolResizeOptionalParams

Os parâmetros opcionais

callback: ServiceCallback<void>

O retorno de chamada

resize(string, PoolResizeParameter, ServiceCallback<void>)

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

Parâmetros

poolId: string

A ID do Pool a ser redimensionado.

poolResizeParameter: PoolResizeParameter

Os parâmetros para a solicitação.

callback: ServiceCallback<void>

O retorno de chamada

stopResize(string, PoolStopResizeOptionalParams)

Isso não restaura o Pool ao seu estado anterior antes da operação de redimensionamento: ele apenas interrompe quaisquer outras alterações que estão sendo feitas, e o Pool mantém seu estado atual. Após a parada, o Pool se estabiliza no número de nós de computação em que estava quando a operação de parada foi concluída. Durante a operação stop, o estado de alocação do Pool muda primeiro para parar e depois para estável. Uma operação de redimensionamento não precisa ser uma solicitação explícita de redimensionamento de pool; essa API também pode ser usada para interromper o dimensionamento inicial do Pool quando ele é criado.

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

Parâmetros

poolId: string

A ID do Pool cujo redimensionamento você deseja parar.

options: PoolStopResizeOptionalParams

Os parâmetros opcionais

Devoluções

Promise<PoolStopResizeResponse>

Prometa<Models.PoolStopResizeResponse>

stopResize(string, PoolStopResizeOptionalParams, ServiceCallback<void>)

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

Parâmetros

poolId: string

A ID do Pool cujo redimensionamento você deseja parar.

options: PoolStopResizeOptionalParams

Os parâmetros opcionais

callback: ServiceCallback<void>

O retorno de chamada

stopResize(string, ServiceCallback<void>)

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

Parâmetros

poolId: string

A ID do Pool cujo redimensionamento você deseja parar.

callback: ServiceCallback<void>

O retorno de chamada

updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams)

Isso substitui totalmente todas as propriedades atualizáveis do Pool. Por exemplo, se o Pool tiver um StartTask associado a ele e se StartTask não for especificado com essa solicitação, o serviço em lote removerá o StartTask existente.

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

Parâmetros

poolId: string

A ID do Pool a ser atualizado.

poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter

Os parâmetros para a solicitação.

options: PoolUpdatePropertiesOptionalParams

Os parâmetros opcionais

Devoluções

Promise<PoolUpdatePropertiesResponse>

Modelos de promessa.PoolUpdatePropertiesResponse<>

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

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

Parâmetros

poolId: string

A ID do Pool a ser atualizado.

poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter

Os parâmetros para a solicitação.

options: PoolUpdatePropertiesOptionalParams

Os parâmetros opcionais

callback: ServiceCallback<void>

O retorno de chamada

updateProperties(string, PoolUpdatePropertiesParameter, ServiceCallback<void>)

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

Parâmetros

poolId: string

A ID do Pool a ser atualizado.

poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter

Os parâmetros para a solicitação.

callback: ServiceCallback<void>

O retorno de chamada

Partilhar via

Pool class

Construtores

Métodos

Detalhes do Construtor

Pool(BatchServiceClientContext)

Parâmetros

Detalhes de Método

add(PoolAddParameter, PoolAddOptionalParams)

Parâmetros

Devoluções

add(PoolAddParameter, PoolAddOptionalParams, ServiceCallback<void>)

Parâmetros

add(PoolAddParameter, ServiceCallback<void>)

Parâmetros

deleteMethod(string, PoolDeleteMethodOptionalParams)

Parâmetros

Devoluções

deleteMethod(string, PoolDeleteMethodOptionalParams, ServiceCallback<void>)

Parâmetros

deleteMethod(string, ServiceCallback<void>)

Parâmetros

disableAutoScale(string, PoolDisableAutoScaleOptionalParams)

Parâmetros

Devoluções

disableAutoScale(string, PoolDisableAutoScaleOptionalParams, ServiceCallback<void>)

Parâmetros

disableAutoScale(string, ServiceCallback<void>)

Parâmetros

enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams)

Parâmetros

Devoluções

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

Parâmetros

enableAutoScale(string, PoolEnableAutoScaleParameter, ServiceCallback<void>)

Parâmetros

evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams)

Parâmetros

Devoluções

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

Parâmetros

evaluateAutoScale(string, string, ServiceCallback<AutoScaleRun>)

Parâmetros

exists(string, PoolExistsOptionalParams)

Parâmetros

Devoluções

exists(string, PoolExistsOptionalParams, ServiceCallback<boolean>)

Parâmetros

exists(string, ServiceCallback<boolean>)

Parâmetros

get(string, PoolGetOptionalParams)

Parâmetros

Devoluções

get(string, PoolGetOptionalParams, ServiceCallback<CloudPool>)

Parâmetros

get(string, ServiceCallback<CloudPool>)

Parâmetros

getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams)

Parâmetros

Devoluções

getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams, ServiceCallback<PoolStatistics>)

Parâmetros

getAllLifetimeStatistics(ServiceCallback<PoolStatistics>)

Parâmetros

list(PoolListOptionalParams)

Parâmetros

Devoluções

list(PoolListOptionalParams, ServiceCallback<CloudPoolListResult>)

Parâmetros

list(ServiceCallback<CloudPoolListResult>)

Parâmetros

listNext(string, PoolListNextOptionalParams)

Parâmetros

Devoluções

listNext(string, PoolListNextOptionalParams, ServiceCallback<CloudPoolListResult>)

Parâmetros

listNext(string, ServiceCallback<CloudPoolListResult>)

Parâmetros

listUsageMetrics(PoolListUsageMetricsOptionalParams)

Parâmetros