Pool class

Crie um pool.

new Pool(client: BatchServiceClientContext)

Parâmetros

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

Devoluções

Modelos de Promessa.PoolAddResponse<>

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

Parâmetros

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

Parâmetros

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

Devoluções

Modelos de promessa.PoolDeleteResponse<>

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

Parâmetros

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

Parâmetros

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

Parâmetros

Devoluções

Modelos de promessa.PoolDisableAutoScaleResponse<>

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

Parâmetros

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

Parâmetros

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

Devoluções

Modelos de promessa.PoolEnableAutoScaleResponse<>

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

Parâmetros

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

Parâmetros

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

Devoluções

Modelos de promessa.PoolEvaluateAutoScaleResponse<>

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

Parâmetros

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

Parâmetros

Obtém propriedades básicas de um Pool.

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

Parâmetros

Devoluções

Modelos de Promessa.PoolExistsResponse<>

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

Parâmetros

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

Parâmetros

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

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

Parâmetros

Devoluções

Modelos de promessa.PoolGetResponse<>

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

Parâmetros

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

Parâmetros

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

Devoluções

Modelos de promessa.PoolGetAllLifetimeStatisticsResponse<>

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

Parâmetros

function getAllLifetimeStatistics(callback: ServiceCallback<PoolStatistics>)

Parâmetros

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

Parâmetros

Devoluções

Prometa<> Models.PoolListResponse

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

Parâmetros

function list(callback: ServiceCallback<CloudPoolListResult>)

Parâmetros

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

Parâmetros

Devoluções

Prometa<> Models.PoolListResponse

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

Parâmetros

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

Parâmetros

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

Devoluções

Prometa<Models.PoolListUsageMetricsResponse>

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

Parâmetros

function listUsageMetrics(callback: ServiceCallback<PoolListUsageMetricsResult>)

Parâmetros

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 listUsageMetricsNext(nextPageLink: string, options?: PoolListUsageMetricsNextOptionalParams): Promise<PoolListUsageMetricsResponse>

Parâmetros

Devoluções

Prometa<Models.PoolListUsageMetricsResponse>

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

Parâmetros

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

Parâmetros

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

Devoluções

Modelos de promessa.PoolPatchResponse<>

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

Parâmetros

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

Parâmetros

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

Devoluções

Modelos de promessa.PoolRemoveNodesResponse<>

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

Parâmetros

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

Parâmetros

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

Devoluções

Modelos de promessa.PoolResizeResponse<>

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

Parâmetros

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

Parâmetros

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

Devoluções

Prometa<Models.PoolStopResizeResponse>

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

Parâmetros

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

Parâmetros

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

Devoluções

Modelos de promessa.PoolUpdatePropertiesResponse<>

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

Parâmetros

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

Parâmetros