CloudPool interface

Pacote:

@azure/batch

Uma interface que representa o CloudPool.

Propriedades

allocationState	Se o Pool está redimensionando. Os valores possíveis incluem: 'steady', 'resdimensioning', 'stopping'
allocationStateTransitionTime	O momento em que o Pool entrou em seu estado de alocação atual.
applicationLicenses	A lista de licenças de aplicativos que o serviço Batch disponibilizará em cada Nó de Computação no Pool. A lista de licenças de aplicativo deve ser um subconjunto de licenças de aplicativo de serviço em lote disponíveis. Se for solicitada uma licença que não é suportada, a criação do Pool falhará.
applicationPackageReferences	A lista de pacotes a serem instalados em cada nó de computação no pool. As alterações nas referências de Pacote afetam todos os novos Nós que ingressam no Pool, mas não afetam os Nós de Computação que já estão no Pool até que sejam reinicializados ou recriados com imagem. Há um máximo de 10 referências de pacote em qualquer pool.
autoScaleEvaluationInterval	O intervalo de tempo no qual ajustar automaticamente o tamanho do Pool de acordo com a fórmula de dimensionamento automático. Essa propriedade é definida somente se o Pool for dimensionado automaticamente, ou seja, enableAutoScale for true.
autoScaleFormula	Uma fórmula para o número desejado de nós de computação no pool. Essa propriedade é definida somente se o Pool for dimensionado automaticamente, ou seja, enableAutoScale for true.
autoScaleRun	Os resultados e erros da última execução da fórmula de escala automática. Essa propriedade é definida somente se o Pool for dimensionado automaticamente, ou seja, enableAutoScale for true.
certificateReferences	A lista de certificados a serem instalados em cada nó de computação no pool. Para nós do Windows, o serviço em lote instala os certificados no armazenamento de certificados e no local especificados. Para nós de computação Linux, os certificados são armazenados em um diretório dentro do diretório de trabalho Tarefa e uma variável de ambiente AZ_BATCH_CERTIFICATES_DIR é fornecida à tarefa para consultar esse local. Para Certificados com visibilidade de 'remoteUser', um diretório 'certs' é criado no diretório base do usuário (por exemplo, /home/{user-name}/certs) e os Certificados são colocados nesse diretório.
cloudServiceConfiguration	A configuração do serviço de nuvem para o Pool. Essa propriedade e virtualMachineConfiguration são mutuamente exclusivas e uma das propriedades deve ser especificada. Esta propriedade não pode ser especificada se a conta em lote foi criada com sua propriedade poolAllocationMode definida como 'UserSubscription'.
creationTime	O tempo de criação da Piscina.
currentDedicatedNodes	O número de nós de computação dedicados atualmente no pool.
currentLowPriorityNodes	O número de nós de computação de baixa prioridade atualmente no pool. Os nós de computação de baixa prioridade que foram antecipados estão incluídos nesta contagem.
displayName	O nome para exibição do Pool. O nome para exibição não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024.
enableAutoScale	Se o tamanho do Pool deve ser ajustado automaticamente ao longo do tempo. Se false, pelo menos um dos targetDedicateNodes e targetLowPriorityNodes deve ser especificado. Se true, a propriedade autoScaleFormula é necessária e o Pool é redimensionado automaticamente de acordo com a fórmula. O valor padrão é false.
enableInterNodeCommunication	Se o Pool permite a comunicação direta entre nós de computação. Isso impõe restrições sobre quais nós de computação podem ser atribuídos ao pool. Especificar esse valor pode reduzir a chance de o número solicitado de nós de computação ser alocado no pool.
eTag	O ETag do Pool. Esta é uma cadeia de caracteres opaca. Você pode usá-lo para detetar se o Pool foi alterado entre as solicitações. Em particular, você pode passar o ETag ao atualizar um Pool para especificar que suas alterações devem entrar em vigor somente se ninguém mais tiver modificado o Pool entretanto.
id	Uma cadeia de caracteres que identifica exclusivamente o Pool dentro da Conta. O ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hífenes e sublinhados, e não pode conter mais de 64 caracteres. O ID preserva maiúsculas e minúsculas (ou seja, você não pode ter dois IDs em uma Conta que diferem apenas por maiúsculas e minúsculas).
lastModified	A última hora modificada do Pool. Esta é a última vez em que os dados no nível do pool, como as configurações targetDedicatedNodes ou enableAutoscale, foram alterados. Ele não leva em consideração alterações no nível do nó, como um estado de alteração do nó de computação.
metadata	Uma lista de pares nome-valor associados ao Pool como metadados.
mountConfiguration	Uma lista de sistemas de arquivos a serem montados em cada nó do pool. Isso dá suporte a Arquivos do Azure, NFS, CIFS/SMB e Blobfuse.
networkConfiguration	A configuração de rede para o Pool.
resizeErrors	Uma lista de erros encontrados ao executar o último redimensionamento no pool. Essa propriedade é definida somente se um ou mais erros ocorreram durante o último redimensionamento do Pool e somente quando o Pool allocationState for Steady.
resizeTimeout	O tempo limite para alocação de nós de computação para o pool. Este é o tempo limite para a operação de redimensionamento mais recente. (O dimensionamento inicial quando o Pool é criado conta como um redimensionamento.) O valor padrão é 15 minutos.
startTask	Uma Tarefa especificada para ser executada em cada Nó de Computação à medida que se junta ao Pool.
state	O estado atual do pool. Os valores possíveis incluem: 'ativo', 'excluindo'
stateTransitionTime	A hora em que o Pool entrou em seu estado atual.
stats	Estatísticas de utilização e utilização de recursos durante todo o tempo de vida do Pool. Esta propriedade é preenchida somente se o CloudPool foi recuperado com uma cláusula de expansão incluindo o atributo 'stats'; caso contrário, é nulo. 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.
targetDedicatedNodes	O número desejado de nós de computação dedicados no pool.
targetLowPriorityNodes	O número desejado de nós de computação de baixa prioridade no pool.
taskSchedulingPolicy	Como as tarefas são distribuídas entre nós de computação em um pool. Se não for especificado, o padrão será spread.
taskSlotsPerNode	O número de slots de tarefas que podem ser usados para executar tarefas simultâneas em um único nó de computação no pool. O valor padrão é 1. O valor máximo é o menor de 4 vezes o número de núcleos do vmSize do pool ou 256.
url	A URL do pool.
userAccounts	A lista de Contas de usuário a serem criadas em cada Nó de Computação no Pool.
virtualMachineConfiguration	A configuração da máquina virtual para o Pool. Esta propriedade e cloudServiceConfiguration são mutuamente exclusivas e uma das propriedades deve ser especificada.
vmSize	O tamanho das máquinas virtuais no Pool. Todas as máquinas virtuais em um Pool têm o mesmo tamanho. Para obter informações sobre tamanhos disponíveis de máquinas virtuais em Pools, consulte Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

Detalhes de Propriedade

allocationState

Se o Pool está redimensionando. Os valores possíveis incluem: 'steady', 'resdimensioning', 'stopping'

allocationState?: AllocationState

Valor de Propriedade

AllocationState

allocationStateTransitionTime

O momento em que o Pool entrou em seu estado de alocação atual.

allocationStateTransitionTime?: Date

Valor de Propriedade

Date

applicationLicenses

A lista de licenças de aplicativos que o serviço Batch disponibilizará em cada Nó de Computação no Pool. A lista de licenças de aplicativo deve ser um subconjunto de licenças de aplicativo de serviço em lote disponíveis. Se for solicitada uma licença que não é suportada, a criação do Pool falhará.

applicationLicenses?: string[]

Valor de Propriedade

string[]

applicationPackageReferences

A lista de pacotes a serem instalados em cada nó de computação no pool. As alterações nas referências de Pacote afetam todos os novos Nós que ingressam no Pool, mas não afetam os Nós de Computação que já estão no Pool até que sejam reinicializados ou recriados com imagem. Há um máximo de 10 referências de pacote em qualquer pool.

applicationPackageReferences?: ApplicationPackageReference[]

Valor de Propriedade

ApplicationPackageReference[]

autoScaleEvaluationInterval

O intervalo de tempo no qual ajustar automaticamente o tamanho do Pool de acordo com a fórmula de dimensionamento automático. Essa propriedade é definida somente se o Pool for dimensionado automaticamente, ou seja, enableAutoScale for true.

autoScaleEvaluationInterval?: string

Valor de Propriedade

string

autoScaleFormula

Uma fórmula para o número desejado de nós de computação no pool. Essa propriedade é definida somente se o Pool for dimensionado automaticamente, ou seja, enableAutoScale for true.

autoScaleFormula?: string

Valor de Propriedade

string

autoScaleRun

Os resultados e erros da última execução da fórmula de escala automática. Essa propriedade é definida somente se o Pool for dimensionado automaticamente, ou seja, enableAutoScale for true.

autoScaleRun?: AutoScaleRun

Valor de Propriedade

AutoScaleRun

certificateReferences

A lista de certificados a serem instalados em cada nó de computação no pool. Para nós do Windows, o serviço em lote instala os certificados no armazenamento de certificados e no local especificados. Para nós de computação Linux, os certificados são armazenados em um diretório dentro do diretório de trabalho Tarefa e uma variável de ambiente AZ_BATCH_CERTIFICATES_DIR é fornecida à tarefa para consultar esse local. Para Certificados com visibilidade de 'remoteUser', um diretório 'certs' é criado no diretório base do usuário (por exemplo, /home/{user-name}/certs) e os Certificados são colocados nesse diretório.

certificateReferences?: CertificateReference[]

Valor de Propriedade

CertificateReference[]

cloudServiceConfiguration

A configuração do serviço de nuvem para o Pool. Essa propriedade e virtualMachineConfiguration são mutuamente exclusivas e uma das propriedades deve ser especificada. Esta propriedade não pode ser especificada se a conta em lote foi criada com sua propriedade poolAllocationMode definida como 'UserSubscription'.

cloudServiceConfiguration?: CloudServiceConfiguration

Valor de Propriedade

CloudServiceConfiguration

creationTime

O tempo de criação da Piscina.

creationTime?: Date

Valor de Propriedade

Date

currentDedicatedNodes

O número de nós de computação dedicados atualmente no pool.

currentDedicatedNodes?: number

Valor de Propriedade

number

currentLowPriorityNodes

O número de nós de computação de baixa prioridade atualmente no pool. Os nós de computação de baixa prioridade que foram antecipados estão incluídos nesta contagem.

currentLowPriorityNodes?: number

Valor de Propriedade

number

displayName

O nome para exibição do Pool. O nome para exibição não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024.

displayName?: string

Valor de Propriedade

string

enableAutoScale

Se o tamanho do Pool deve ser ajustado automaticamente ao longo do tempo. Se false, pelo menos um dos targetDedicateNodes e targetLowPriorityNodes deve ser especificado. Se true, a propriedade autoScaleFormula é necessária e o Pool é redimensionado automaticamente de acordo com a fórmula. O valor padrão é false.

enableAutoScale?: boolean

Valor de Propriedade

boolean

enableInterNodeCommunication

Se o Pool permite a comunicação direta entre nós de computação. Isso impõe restrições sobre quais nós de computação podem ser atribuídos ao pool. Especificar esse valor pode reduzir a chance de o número solicitado de nós de computação ser alocado no pool.

enableInterNodeCommunication?: boolean

Valor de Propriedade

boolean

eTag

O ETag do Pool. Esta é uma cadeia de caracteres opaca. Você pode usá-lo para detetar se o Pool foi alterado entre as solicitações. Em particular, você pode passar o ETag ao atualizar um Pool para especificar que suas alterações devem entrar em vigor somente se ninguém mais tiver modificado o Pool entretanto.

eTag?: string

Valor de Propriedade

string

id

Uma cadeia de caracteres que identifica exclusivamente o Pool dentro da Conta. O ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hífenes e sublinhados, e não pode conter mais de 64 caracteres. O ID preserva maiúsculas e minúsculas (ou seja, você não pode ter dois IDs em uma Conta que diferem apenas por maiúsculas e minúsculas).

id?: string

Valor de Propriedade

string

lastModified

A última hora modificada do Pool. Esta é a última vez em que os dados no nível do pool, como as configurações targetDedicatedNodes ou enableAutoscale, foram alterados. Ele não leva em consideração alterações no nível do nó, como um estado de alteração do nó de computação.

lastModified?: Date

Valor de Propriedade

Date

metadata

Uma lista de pares nome-valor associados ao Pool como metadados.

metadata?: MetadataItem[]

Valor de Propriedade

MetadataItem[]

mountConfiguration

Uma lista de sistemas de arquivos a serem montados em cada nó do pool. Isso dá suporte a Arquivos do Azure, NFS, CIFS/SMB e Blobfuse.

mountConfiguration?: MountConfiguration[]

Valor de Propriedade

MountConfiguration[]

networkConfiguration

A configuração de rede para o Pool.

networkConfiguration?: NetworkConfiguration

Valor de Propriedade

NetworkConfiguration

resizeErrors

Uma lista de erros encontrados ao executar o último redimensionamento no pool. Essa propriedade é definida somente se um ou mais erros ocorreram durante o último redimensionamento do Pool e somente quando o Pool allocationState for Steady.

resizeErrors?: ResizeError[]

Valor de Propriedade

ResizeError[]

resizeTimeout

O tempo limite para alocação de nós de computação para o pool. Este é o tempo limite para a operação de redimensionamento mais recente. (O dimensionamento inicial quando o Pool é criado conta como um redimensionamento.) O valor padrão é 15 minutos.

resizeTimeout?: string

Valor de Propriedade

string

startTask

Uma Tarefa especificada para ser executada em cada Nó de Computação à medida que se junta ao Pool.

startTask?: StartTask

Valor de Propriedade

StartTask

state

O estado atual do pool. Os valores possíveis incluem: 'ativo', 'excluindo'

state?: PoolState

Valor de Propriedade

PoolState

stateTransitionTime

A hora em que o Pool entrou em seu estado atual.

stateTransitionTime?: Date

Valor de Propriedade

Date

stats

Estatísticas de utilização e utilização de recursos durante todo o tempo de vida do Pool. Esta propriedade é preenchida somente se o CloudPool foi recuperado com uma cláusula de expansão incluindo o atributo 'stats'; caso contrário, é nulo. 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.

stats?: PoolStatistics

Valor de Propriedade

PoolStatistics

targetDedicatedNodes

O número desejado de nós de computação dedicados no pool.

targetDedicatedNodes?: number

Valor de Propriedade

number

targetLowPriorityNodes

O número desejado de nós de computação de baixa prioridade no pool.

targetLowPriorityNodes?: number

Valor de Propriedade

number

taskSchedulingPolicy

Como as tarefas são distribuídas entre nós de computação em um pool. Se não for especificado, o padrão será spread.

taskSchedulingPolicy?: TaskSchedulingPolicy

Valor de Propriedade

TaskSchedulingPolicy

taskSlotsPerNode

O número de slots de tarefas que podem ser usados para executar tarefas simultâneas em um único nó de computação no pool. O valor padrão é 1. O valor máximo é o menor de 4 vezes o número de núcleos do vmSize do pool ou 256.

taskSlotsPerNode?: number

Valor de Propriedade

number

url

A URL do pool.

url?: string

Valor de Propriedade

string

userAccounts

A lista de Contas de usuário a serem criadas em cada Nó de Computação no Pool.

userAccounts?: UserAccount[]

Valor de Propriedade

UserAccount[]

virtualMachineConfiguration

A configuração da máquina virtual para o Pool. Esta propriedade e cloudServiceConfiguration são mutuamente exclusivas e uma das propriedades deve ser especificada.

virtualMachineConfiguration?: VirtualMachineConfiguration

Valor de Propriedade

VirtualMachineConfiguration

vmSize

O tamanho das máquinas virtuais no Pool. Todas as máquinas virtuais em um Pool têm o mesmo tamanho. Para obter informações sobre tamanhos disponíveis de máquinas virtuais em Pools, consulte Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

vmSize?: string

Valor de Propriedade

string