PoolOperations Classe
Operações poolOperations.
Não deve instanciar diretamente esta classe, mas criar uma instância de Cliente que irá criá-la e anexá-la como atributo.
- Herança
-
builtins.objectPoolOperations
Construtor
PoolOperations(client, config, serializer, deserializer)Parâmetros
- client
Cliente para pedidos de serviço.
- config
Configuração do cliente de serviço.
- serializer
Um serializador de modelo de objeto.
- deserializer
Um desserializador de modelo de objeto.
Variáveis
- api_version
A versão da API a utilizar para o pedido. Valor constante: "2023-05-01.17.0".
Métodos
| add |
Adiciona um Conjunto à Conta especificada. Ao atribuir nomes a Conjuntos, evite incluir informações confidenciais, como nomes de utilizadores ou nomes de projetos secretos. Estas informações podem aparecer em registos de telemetria acessíveis a engenheiros Suporte da Microsoft. |
| delete |
Elimina um Conjunto da Conta especificada. Quando pede que um Conjunto seja eliminado, ocorrem as seguintes ações: o estado do conjunto está definido como eliminação; todas as operações de redimensionamento em curso no Conjunto são paradas; o serviço Batch começa a redimensionar o Conjunto para zero Nós de Computação; quaisquer Tarefas em execução nos Nós de Computação existentes são encerradas e recoduídas (como se tivesse sido pedida uma operação de redimensionamento do Conjunto com a opção de repetição predefinida); por fim, o Conjunto é removido do sistema. Uma vez que a execução de Tarefas é reativada, o utilizador pode executar novamente estas Tarefas ao atualizar a respetiva Tarefa para direcionar um Conjunto diferente. Em seguida, as Tarefas podem ser executadas no novo Conjunto. Se quiser substituir o comportamento de repetição, deve chamar o Conjunto de redimensionamento explicitamente para reduzir o Tamanho zero do Conjunto antes de eliminar o Conjunto. Se chamar uma API de Atualização, Patch ou Eliminação num Conjunto no estado de eliminação, esta falhará com o código de estado HTTP 409 com o código de erro PoolBeingDeleted. |
| disable_auto_scale |
Desativa o dimensionamento automático para um Conjunto. |
| enable_auto_scale |
Ativa o dimensionamento automático para um Conjunto. Não pode ativar o dimensionamento automático num Conjunto se uma operação de redimensionamento estiver em curso no Conjunto. Se o dimensionamento automático do Conjunto estiver atualmente desativado, tem de especificar uma fórmula de dimensionamento automático válida como parte do pedido. Se o dimensionamento automático do Conjunto já estiver ativado, poderá especificar uma nova fórmula de dimensionamento automático e/ou um novo intervalo de avaliação. Não pode chamar esta API para o mesmo Conjunto mais do que 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 Conjunto. Esta API destina-se principalmente à validação de uma fórmula de dimensionamento automático, uma vez que devolve simplesmente o resultado sem aplicar a fórmula ao Conjunto. O Conjunto tem de ter o dimensionamento automático ativado para avaliar uma fórmula. |
| exists |
Obtém propriedades básicas de um Conjunto. |
| get |
Obtém informações sobre o Conjunto especificado. |
| list |
Lista todos os Conjuntos na Conta especificada. |
| list_usage_metrics |
Lista as métricas de utilização, agregadas por Conjunto em intervalos de tempo individuais, para a Conta especificada. Se não especificar uma cláusula de $filter, incluindo um poolId, a resposta inclui todos os Conjuntos que existiam na Conta no intervalo de tempo dos intervalos de agregação devolvidos. Se não especificar uma cláusula $filter, incluindo startTime ou endTime, estes filtros são predefinidos para as horas de início e de fim do último intervalo de agregação atualmente disponível; ou seja, apenas é devolvido o último intervalo de agregação. |
| patch |
Atualizações as propriedades do Conjunto especificado. Esta ação substitui apenas as propriedades do Conjunto especificadas no pedido. Por exemplo, se o Conjunto tiver uma StartTask associada e um pedido não especificar um elemento StartTask, o Conjunto mantém o StartTask existente. |
| remove_nodes |
Remove Os Nós de Computação do Conjunto especificado. Esta operação só pode ser executada quando o estado de alocação do Conjunto estiver estável. Quando esta operação é executada, o estado de alocação muda de estável para redimensionamento. Cada pedido pode remover até 100 nós. |
| resize |
Altera o número de Nós de Computação atribuídos a um Conjunto. Só pode redimensionar um Conjunto quando o respetivo estado de alocação estiver estável. Se o Conjunto já estiver a ser redimensionado, o pedido falhará com o código de estado 409. Quando redimensiona um Conjunto, o estado de alocação do Conjunto muda de estável para redimensionamento. Não é possível redimensionar conjuntos configurados para dimensionamento automático. Se tentar fazê-lo, o serviço Batch devolve um erro 409. Se redimensionar um Conjunto para baixo, o serviço Batch escolhe os Nós de Computação a remover. Para remover nós de computação específicos, utilize a API Remover Nós de Computação. |
| stop_resize |
Para uma operação de redimensionamento contínua no Conjunto. Isto não restaura o Conjunto para o estado anterior antes da operação de redimensionamento: apenas impede que sejam efetuadas quaisquer alterações adicionais e o Conjunto mantém o estado atual. Depois de parar, o Conjunto estabiliza com o número de Nós de Computação em que estava quando a operação de paragem foi concluída. Durante a operação de paragem, o estado de alocação do conjunto muda primeiro para parar e, em seguida, para estável. Uma operação de redimensionamento não tem de ser um pedido de redimensionamento explícito do Conjunto; esta API também pode ser utilizada para parar o dimensionamento inicial do Conjunto quando é criado. |
| update_properties |
Atualizações as propriedades do Conjunto especificado. Esta ação substitui totalmente todas as propriedades atualizáveis do Conjunto. Por exemplo, se o Conjunto tiver um StartTask associado ao mesmo e se StartTask não for especificado com este pedido, o serviço Batch removerá o StartTask existente. |
add
Adiciona um Conjunto à Conta especificada.
Ao atribuir nomes a Conjuntos, evite incluir informações confidenciais, como nomes de utilizadores ou nomes de projetos secretos. Estas informações podem aparecer em registos de telemetria acessíveis a engenheiros Suporte da Microsoft.
add(pool, pool_add_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Nenhum ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
delete
Elimina um Conjunto da Conta especificada.
Quando pede que um Conjunto seja eliminado, ocorrem as seguintes ações: o estado do conjunto está definido como eliminação; todas as operações de redimensionamento em curso no Conjunto são paradas; o serviço Batch começa a redimensionar o Conjunto para zero Nós de Computação; quaisquer Tarefas em execução nos Nós de Computação existentes são encerradas e recoduídas (como se tivesse sido pedida uma operação de redimensionamento do Conjunto com a opção de repetição predefinida); por fim, o Conjunto é removido do sistema. Uma vez que a execução de Tarefas é reativada, o utilizador pode executar novamente estas Tarefas ao atualizar a respetiva Tarefa para direcionar um Conjunto diferente. Em seguida, as Tarefas podem ser executadas no novo Conjunto. Se quiser substituir o comportamento de repetição, deve chamar o Conjunto de redimensionamento explicitamente para reduzir o Tamanho zero do Conjunto antes de eliminar o Conjunto. Se chamar uma API de Atualização, Patch ou Eliminação num Conjunto no estado de eliminação, esta falhará com o código de estado HTTP 409 com o código de erro PoolBeingDeleted.
delete(pool_id, pool_delete_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Nenhum ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
disable_auto_scale
Desativa o dimensionamento automático para um Conjunto.
disable_auto_scale(pool_id, pool_disable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- pool_disable_auto_scale_options
- PoolDisableAutoScaleOptions
Parâmetros adicionais para a operação
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Nenhum ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
enable_auto_scale
Ativa o dimensionamento automático para um Conjunto.
Não pode ativar o dimensionamento automático num Conjunto se uma operação de redimensionamento estiver em curso no Conjunto. Se o dimensionamento automático do Conjunto estiver atualmente desativado, tem de especificar uma fórmula de dimensionamento automático válida como parte do pedido. Se o dimensionamento automático do Conjunto já estiver ativado, poderá especificar uma nova fórmula de dimensionamento automático e/ou um novo intervalo de avaliação. Não pode chamar esta API para o mesmo Conjunto mais do que 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
- auto_scale_formula
- str
A fórmula é verificada quanto à validade antes de ser aplicada ao Conjunto. Se a fórmula não for válida, o serviço Batch rejeita o pedido com informações de erro detalhadas. Para obter mais informações sobre como especificar esta fórmula, veja Dimensionar automaticamente Os Nós de Computação num Conjunto de Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
- auto_scale_evaluation_interval
- <xref:timedelta>
O valor predefinido é 15 minutos. O valor mínimo e máximo são 5 minutos e 168 horas, respetivamente. Se especificar um valor inferior a 5 minutos ou superior a 168 horas, o serviço Batch rejeita o pedido com um erro de valor de propriedade inválido; se estiver a chamar a API REST diretamente, o código de estado HTTP é 400 (Pedido Incorreto). Se especificar um novo intervalo, a agenda de avaliação de dimensionamento automático existente será interrompida e será iniciada uma nova agenda de avaliação de dimensionamento automático, sendo que a hora de início é a hora em que este pedido foi emitido.
- pool_enable_auto_scale_options
- PoolEnableAutoScaleOptions
Parâmetros adicionais para a operação
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Nenhum ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
evaluate_auto_scale
Obtém o resultado da avaliação de uma fórmula de dimensionamento automático no Conjunto.
Esta API destina-se principalmente à validação de uma fórmula de dimensionamento automático, uma vez que devolve simplesmente o resultado sem aplicar a fórmula ao Conjunto. O Conjunto tem de ter o dimensionamento automático ativado 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
- auto_scale_formula
- str
A fórmula é validada e os resultados calculados, mas não é aplicada ao Conjunto. Para aplicar a fórmula ao Conjunto, "Ativar o dimensionamento automático num Conjunto". Para obter mais informações sobre como especificar esta fórmula, veja Dimensionar automaticamente Os Nós de Computação num Conjunto de Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
- pool_evaluate_auto_scale_options
- PoolEvaluateAutoScaleOptions
Parâmetros adicionais para a operação
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
AutoScaleRun ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
exists
Obtém propriedades básicas de um Conjunto.
exists(pool_id, pool_exists_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
bool ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
get
Obtém informações sobre o Conjunto especificado.
get(pool_id, pool_get_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
CloudPool ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
list
Lista todos os Conjuntos na Conta especificada.
list(pool_list_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Um iterador como a instância do CloudPool
Tipo de retorno
Exceções
list_usage_metrics
Lista as métricas de utilização, agregadas por Conjunto em intervalos de tempo individuais, para a Conta especificada.
Se não especificar uma cláusula de $filter, incluindo um poolId, a resposta inclui todos os Conjuntos que existiam na Conta no intervalo de tempo dos intervalos de agregação devolvidos. Se não especificar uma cláusula $filter, incluindo startTime ou endTime, estes filtros são predefinidos para as horas de início e de fim do último intervalo de agregação atualmente disponível; ou seja, apenas é devolvido o último intervalo de agregação.
list_usage_metrics(pool_list_usage_metrics_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- pool_list_usage_metrics_options
- PoolListUsageMetricsOptions
Parâmetros adicionais para a operação
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Um iterador como a instância de PoolUsageMetrics
Tipo de retorno
Exceções
patch
Atualizações as propriedades do Conjunto especificado.
Esta ação substitui apenas as propriedades do Conjunto especificadas no pedido. Por exemplo, se o Conjunto tiver uma StartTask associada e um pedido não especificar um elemento StartTask, o Conjunto mantém o StartTask existente.
patch(pool_id, pool_patch_parameter, pool_patch_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Nenhum ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
remove_nodes
Remove Os Nós de Computação do Conjunto especificado.
Esta operação só pode ser executada quando o estado de alocação do Conjunto estiver estável. Quando esta operação é executada, o estado de alocação muda de estável para redimensionamento. Cada pedido 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_remove_nodes_options
- PoolRemoveNodesOptions
Parâmetros adicionais para a operação
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Nenhum ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
resize
Altera o número de Nós de Computação atribuídos a um Conjunto.
Só pode redimensionar um Conjunto quando o respetivo estado de alocação estiver estável. Se o Conjunto já estiver a ser redimensionado, o pedido falhará com o código de estado 409. Quando redimensiona um Conjunto, o estado de alocação do Conjunto muda de estável para redimensionamento. Não é possível redimensionar conjuntos configurados para dimensionamento automático. Se tentar fazê-lo, o serviço Batch devolve um erro 409. Se redimensionar um Conjunto para baixo, o serviço Batch escolhe os Nós de Computação a remover. Para remover nós de computação específicos, utilize a API Remover Nós de Computação.
resize(pool_id, pool_resize_parameter, pool_resize_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Nenhum ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
stop_resize
Para uma operação de redimensionamento contínua no Conjunto.
Isto não restaura o Conjunto para o estado anterior antes da operação de redimensionamento: apenas impede que sejam efetuadas quaisquer alterações adicionais e o Conjunto mantém o estado atual. Depois de parar, o Conjunto estabiliza com o número de Nós de Computação em que estava quando a operação de paragem foi concluída. Durante a operação de paragem, o estado de alocação do conjunto muda primeiro para parar e, em seguida, para estável. Uma operação de redimensionamento não tem de ser um pedido de redimensionamento explícito do Conjunto; esta API também pode ser utilizada para parar o dimensionamento inicial do Conjunto quando é criado.
stop_resize(pool_id, pool_stop_resize_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- pool_stop_resize_options
- PoolStopResizeOptions
Parâmetros adicionais para a operação
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Nenhum ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
update_properties
Atualizações as propriedades do Conjunto especificado.
Esta ação substitui totalmente todas as propriedades atualizáveis do Conjunto. Por exemplo, se o Conjunto tiver um StartTask associado ao mesmo e se StartTask não for especificado com este pedido, o serviço Batch 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_update_properties_options
- PoolUpdatePropertiesOptions
Parâmetros adicionais para a operação
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Nenhum ou ClientRawResponse se raw=true
Tipo de retorno
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'>
Azure SDK for Python