Compartilhar via


PoolOperations Classe

Operações de PoolOperations.

Você não deve instanciar diretamente essa classe, mas criar uma instância do Cliente que a criará para você e a anexará como atributo.

Herança
builtins.object
PoolOperations

Construtor

PoolOperations(client, config, serializer, deserializer)

Parâmetros

client
Obrigatório

Cliente para solicitações de serviço.

config
Obrigatório

Configuração do cliente de serviço.

serializer
Obrigatório

Um serializador de modelo de objeto.

deserializer
Obrigatório

Um desserializador de modelo de objeto.

Variáveis

api_version

A versão da API a ser usada para a solicitação. Valor constante: "2023-05-01.17.0".

Métodos

add

Adiciona um Pool à Conta especificada.

Ao nomear Pools, evite incluir informações confidenciais, como nomes de usuário ou nomes de projeto secretos. Essas informações podem ser exibidas nos logs de telemetria acessíveis a engenheiros de Suporte da Microsoft.

delete

Exclui um Pool da Conta especificada.

Quando você solicita que um Pool seja excluído, as seguintes ações ocorrem: o estado do pool está definido como exclusão; todas as operações de redimensionamento em andamento no Pool são interrompidas; o serviço 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 requeadas (como se uma operação de pool de redimensionamento tivesse sido solicitada com a opção de remoção padrão); por fim, o Pool é removido do sistema. Como a execução de Tarefas é requeuída, o usuário pode executar novamente essas Tarefas atualizando seu Trabalho para direcionar a um pool diferente. Em seguida, as Tarefas podem ser executadas no novo pool. Se você quiser substituir o comportamento de substituição, chame o pool de redimensionamento explicitamente para reduzir o pool para tamanho zero antes de excluir o Pool. Se você chamar uma API Atualizar, Patch ou Excluir em um Pool no estado de exclusão, ela falhará com HTTP status código 409 com o código de erro PoolBeingDeleted.

disable_auto_scale

Desabilita o dimensionamento automático para um Pool.

enable_auto_scale

Habilita o dimensionamento automático para um Pool.

Você não poderá 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. Você não pode chamar essa API para o mesmo pool mais de uma vez a cada 30 segundos.

evaluate_auto_scale

Obtém o resultado da avaliação de uma fórmula de dimensionamento automático no Pool.

Essa API destina-se principalmente à validação de uma fórmula de dimensionamento automático, pois ela simplesmente retorna o resultado sem aplicar a fórmula ao Pool. O Pool deve ter o dimensionamento automático habilitado para avaliar uma fórmula.

exists

Obtém as propriedades básicas de um Pool.

get

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

list

Lista todos os Pools na Conta especificada.

list_usage_metrics

Lista as métricas de uso, agregadas por Pool em intervalos de tempo individuais, para a Conta especificada.

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 padrão serão os horários de início e término do último intervalo de agregação disponível no momento; ou seja, apenas o último intervalo de agregação é retornado.

patch

Atualizações as propriedades do Pool especificado.

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.

remove_nodes

Remove nós de computação do pool especificado.

Essa operação só pode ser executada quando o estado de alocação do pool é estável. Quando essa operação é executada, o estado de alocação muda de estável para redimensionamento. Cada solicitação pode remover até 100 nós.

resize

Altera o número de nós de computação atribuídos a um pool.

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 status código 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 lote retornará um erro 409. Se você redimensionar um Pool para baixo, o serviço lote escolherá quais nós de computação remover. Para remover nós de computação específicos, use a API Pool remove Compute Nodes.

stop_resize

Interrompe uma operação de redimensionamento contínua no pool.

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

update_properties

Atualizações as propriedades do Pool especificado.

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 do Lote removerá o StartTask existente.

add

Adiciona um Pool à Conta especificada.

Ao nomear Pools, evite incluir informações confidenciais, como nomes de usuário ou nomes de projeto secretos. Essas informações podem ser exibidas nos logs de telemetria acessíveis a engenheiros de Suporte da Microsoft.

add(pool, pool_add_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

pool
PoolAddParameter
Obrigatório

O pool a ser adicionado.

pool_add_options
PoolAddOptions
valor padrão: None

Parâmetros adicionais para a operação

custom_headers
dict
valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw
bool
valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config
Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

delete

Exclui um Pool da Conta especificada.

Quando você solicita que um Pool seja excluído, as seguintes ações ocorrem: o estado do pool está definido como exclusão; todas as operações de redimensionamento em andamento no Pool são interrompidas; o serviço 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 requeadas (como se uma operação de pool de redimensionamento tivesse sido solicitada com a opção de remoção padrão); por fim, o Pool é removido do sistema. Como a execução de Tarefas é requeuída, o usuário pode executar novamente essas Tarefas atualizando seu Trabalho para direcionar a um pool diferente. Em seguida, as Tarefas podem ser executadas no novo pool. Se você quiser substituir o comportamento de substituição, chame o pool de redimensionamento explicitamente para reduzir o pool para tamanho zero antes de excluir o Pool. Se você chamar uma API Atualizar, Patch ou Excluir em um Pool no estado de exclusão, ela falhará com HTTP status código 409 com o código de erro PoolBeingDeleted.

delete(pool_id, pool_delete_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

pool_id
str
Obrigatório

A ID do pool a ser excluído.

pool_delete_options
PoolDeleteOptions
valor padrão: None

Parâmetros adicionais para a operação

custom_headers
dict
valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw
bool
valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config
Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

disable_auto_scale

Desabilita o dimensionamento automático para um Pool.

disable_auto_scale(pool_id, pool_disable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

pool_id
str
Obrigatório

A ID do pool no qual desabilitar o dimensionamento automático.

pool_disable_auto_scale_options
PoolDisableAutoScaleOptions
valor padrão: None

Parâmetros adicionais para a operação

custom_headers
dict
valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw
bool
valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config
Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

enable_auto_scale

Habilita o dimensionamento automático para um Pool.

Você não poderá 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. Você não pode chamar essa API para o mesmo pool mais de uma vez a cada 30 segundos.

enable_auto_scale(pool_id, auto_scale_formula=None, auto_scale_evaluation_interval=None, pool_enable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

pool_id
str
Obrigatório

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

auto_scale_formula
str
valor padrão: None

A fórmula é verificada quanto à validade antes de ser aplicada ao Pool. Se a fórmula não for válida, o serviço do Lote rejeitará a solicitação com informações detalhadas de erro. Para obter mais informações sobre como especificar essa fórmula, consulte Dimensionar automaticamente nós de computação em um pool de Lote do Azure (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

auto_scale_evaluation_interval
<xref:timedelta>
valor padrão: None

O valor padrão é 15 minutos. O valor mínimo e máximo são 5 minutos e 168 horas, respectivamente. Se você especificar um valor menor que 5 minutos ou superior a 168 horas, o serviço do Lote rejeitará a solicitação com um erro de valor de propriedade inválido; se você estiver chamando a API REST diretamente, o código http status será 400 (solicitação incorreta). Se você especificar um novo intervalo, o agendamento de avaliação de dimensionamento automático existente será interrompido e um novo agendamento de avaliação de dimensionamento automático será iniciado, sendo a hora inicial em que essa solicitação foi emitida.

pool_enable_auto_scale_options
PoolEnableAutoScaleOptions
valor padrão: None

Parâmetros adicionais para a operação

custom_headers
dict
valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw
bool
valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config
Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

evaluate_auto_scale

Obtém o resultado da avaliação de uma fórmula de dimensionamento automático no Pool.

Essa API destina-se principalmente à validação de uma fórmula de dimensionamento automático, pois ela simplesmente retorna o resultado sem aplicar a fórmula ao Pool. O Pool deve ter o dimensionamento automático habilitado para avaliar uma fórmula.

evaluate_auto_scale(pool_id, auto_scale_formula, pool_evaluate_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

pool_id
str
Obrigatório

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

auto_scale_formula
str
Obrigatório

A fórmula é validada e seus resultados calculados, mas não é aplicada ao Pool. Para aplicar a fórmula ao Pool, "Habilitar o 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 Lote do Azure (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

pool_evaluate_auto_scale_options
PoolEvaluateAutoScaleOptions
valor padrão: None

Parâmetros adicionais para a operação

custom_headers
dict
valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw
bool
valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config
Obrigatório

Substituições de configuração de operação.

Retornos

AutoScaleRun ou ClientRawResponse se raw=true

Tipo de retorno

Exceções

exists

Obtém as propriedades básicas de um Pool.

exists(pool_id, pool_exists_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

pool_id
str
Obrigatório

A ID do pool a ser obtido.

pool_exists_options
PoolExistsOptions
valor padrão: None

Parâmetros adicionais para a operação

custom_headers
dict
valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw
bool
valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config
Obrigatório

Substituições de configuração de operação.

Retornos

bool ou ClientRawResponse se raw=true

Tipo de retorno

bool,

Exceções

get

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

get(pool_id, pool_get_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

pool_id
str
Obrigatório

A ID do pool a ser obtido.

pool_get_options
PoolGetOptions
valor padrão: None

Parâmetros adicionais para a operação

custom_headers
dict
valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw
bool
valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config
Obrigatório

Substituições de configuração de operação.

Retornos

CloudPool ou ClientRawResponse se raw=true

Tipo de retorno

Exceções

list

Lista todos os Pools na Conta especificada.

list(pool_list_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

pool_list_options
PoolListOptions
valor padrão: None

Parâmetros adicionais para a operação

custom_headers
dict
valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw
bool
valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config
Obrigatório

Substituições de configuração de operação.

Retornos

Um iterador como a instância do CloudPool

Tipo de retorno

Exceções

list_usage_metrics

Lista as métricas de uso, agregadas por Pool em intervalos de tempo individuais, para a Conta especificada.

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 padrão serão os horários de início e término do último intervalo de agregação disponível no momento; ou seja, apenas o último intervalo de agregação é retornado.

list_usage_metrics(pool_list_usage_metrics_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

pool_list_usage_metrics_options
PoolListUsageMetricsOptions
valor padrão: None

Parâmetros adicionais para a operação

custom_headers
dict
valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw
bool
valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config
Obrigatório

Substituições de configuração de operação.

Retornos

Um iterador como a instância do PoolUsageMetrics

Tipo de retorno

Exceções

patch

Atualizações as propriedades do Pool especificado.

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(pool_id, pool_patch_parameter, pool_patch_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

pool_id
str
Obrigatório

A ID do Pool a ser atualizada.

pool_patch_parameter
PoolPatchParameter
Obrigatório

Os parâmetros da solicitação.

pool_patch_options
PoolPatchOptions
valor padrão: None

Parâmetros adicionais para a operação

custom_headers
dict
valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw
bool
valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config
Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

remove_nodes

Remove nós de computação do pool especificado.

Essa operação só pode ser executada quando o estado de alocação do pool é estável. Quando essa operação é executada, o estado de alocação muda de estável para redimensionamento. Cada solicitação pode remover até 100 nós.

remove_nodes(pool_id, node_remove_parameter, pool_remove_nodes_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

pool_id
str
Obrigatório

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

node_remove_parameter
NodeRemoveParameter
Obrigatório

Os parâmetros da solicitação.

pool_remove_nodes_options
PoolRemoveNodesOptions
valor padrão: None

Parâmetros adicionais para a operação

custom_headers
dict
valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw
bool
valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config
Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

resize

Altera o número de nós de computação atribuídos a um pool.

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 status código 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 lote retornará um erro 409. Se você redimensionar um Pool para baixo, o serviço lote escolherá quais nós de computação remover. Para remover nós de computação específicos, use a API Pool remove Compute Nodes.

resize(pool_id, pool_resize_parameter, pool_resize_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

pool_id
str
Obrigatório

A ID do pool a ser redimensionado.

pool_resize_parameter
PoolResizeParameter
Obrigatório

Os parâmetros da solicitação.

pool_resize_options
PoolResizeOptions
valor padrão: None

Parâmetros adicionais para a operação

custom_headers
dict
valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw
bool
valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config
Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

stop_resize

Interrompe uma operação de redimensionamento contínua no pool.

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

stop_resize(pool_id, pool_stop_resize_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

pool_id
str
Obrigatório

A ID do Pool cujo redimensionamento você deseja parar.

pool_stop_resize_options
PoolStopResizeOptions
valor padrão: None

Parâmetros adicionais para a operação

custom_headers
dict
valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw
bool
valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config
Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

update_properties

Atualizações as propriedades do Pool especificado.

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 do Lote removerá o StartTask existente.

update_properties(pool_id, pool_update_properties_parameter, pool_update_properties_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

pool_id
str
Obrigatório

A ID do pool a ser atualizado.

pool_update_properties_parameter
PoolUpdatePropertiesParameter
Obrigatório

Os parâmetros da solicitação.

pool_update_properties_options
PoolUpdatePropertiesOptions
valor padrão: None

Parâmetros adicionais para a operação

custom_headers
dict
valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw
bool
valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config
Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

Atributos

models

models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>