Partilhar via

Microsoft.Batch batchAccounts/pools 2018-12-01

  • Artigo

Definição de recursos do bíceps

O tipo de recurso batchAccounts/pools pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Batch/batchAccounts/pools, adicione o seguinte Bíceps ao seu modelo.

resource symbolicname 'Microsoft.Batch/batchAccounts/pools@2018-12-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    applicationLicenses: [
      'string'
    ]
    applicationPackages: [
      {
        id: 'string'
        version: 'string'
      }
    ]
    certificates: [
      {
        id: 'string'
        storeLocation: 'string'
        storeName: 'string'
        visibility: [
          'string'
        ]
      }
    ]
    deploymentConfiguration: {
      cloudServiceConfiguration: {
        osFamily: 'string'
        osVersion: 'string'
      }
      virtualMachineConfiguration: {
        containerConfiguration: {
          containerImageNames: [
            'string'
          ]
          containerRegistries: [
            {
              password: 'string'
              registryServer: 'string'
              username: 'string'
            }
          ]
          type: 'DockerCompatible'
        }
        dataDisks: [
          {
            caching: 'string'
            diskSizeGB: int
            lun: int
            storageAccountType: 'string'
          }
        ]
        imageReference: {
          id: 'string'
          offer: 'string'
          publisher: 'string'
          sku: 'string'
          version: 'string'
        }
        licenseType: 'string'
        nodeAgentSkuId: 'string'
        windowsConfiguration: {
          enableAutomaticUpdates: bool
        }
      }
    }
    displayName: 'string'
    interNodeCommunication: 'string'
    maxTasksPerNode: int
    metadata: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    networkConfiguration: {
      endpointConfiguration: {
        inboundNatPools: [
          {
            backendPort: int
            frontendPortRangeEnd: int
            frontendPortRangeStart: int
            name: 'string'
            networkSecurityGroupRules: [
              {
                access: 'string'
                priority: int
                sourceAddressPrefix: 'string'
              }
            ]
            protocol: 'string'
          }
        ]
      }
      subnetId: 'string'
    }
    scaleSettings: {
      autoScale: {
        evaluationInterval: 'string'
        formula: 'string'
      }
      fixedScale: {
        nodeDeallocationOption: 'string'
        resizeTimeout: 'string'
        targetDedicatedNodes: int
        targetLowPriorityNodes: int
      }
    }
    startTask: {
      commandLine: 'string'
      containerSettings: {
        containerRunOptions: 'string'
        imageName: 'string'
        registry: {
          password: 'string'
          registryServer: 'string'
          username: 'string'
        }
      }
      environmentSettings: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      maxTaskRetryCount: int
      resourceFiles: [
        {
          autoStorageContainerName: 'string'
          blobPrefix: 'string'
          fileMode: 'string'
          filePath: 'string'
          httpUrl: 'string'
          storageContainerUrl: 'string'
        }
      ]
      userIdentity: {
        autoUser: {
          elevationLevel: 'string'
          scope: 'string'
        }
        userName: 'string'
      }
      waitForSuccess: bool
    }
    taskSchedulingPolicy: {
      nodeFillType: 'string'
    }
    userAccounts: [
      {
        elevationLevel: 'string'
        linuxUserConfiguration: {
          gid: int
          sshPrivateKey: 'string'
          uid: int
        }
        name: 'string'
        password: 'string'
        windowsUserConfiguration: {
          loginMode: 'string'
        }
      }
    ]
    vmSize: 'string'
  }
}

Valores de propriedade

ApplicationPackageReference

Designação Descrição Valor
ID A ID do pacote de aplicativo a ser instalado. Isso deve estar dentro da mesma conta de lote que o pool. Isso pode ser uma referência a uma versão específica ou a versão padrão, se existir. string (obrigatório)
Versão Se isso for omitido e nenhuma versão padrão for especificada para este aplicativo, a solicitação falhará com o código de erro InvalidApplicationPackageReferences. Se você estiver chamando a API REST diretamente, o código de status HTTP será 409. string

AutoScaleSettings

Designação Descrição Valor
avaliaçãoIntervalo Se omitido, o valor padrão é 15 minutos (PT15M). string
fórmula Uma fórmula para o número desejado de nós de computação no pool. string (obrigatório)

AutoUserSpecification

Designação Descrição Valor
elevaçãoNível nonAdmin - O usuário automático é um usuário padrão sem acesso elevado. admin - O usuário automático é um usuário com acesso elevado e opera com permissões totais de administrador. O valor padrão é nonAdmin. 'Administrador'
'Não administrador'
Âmbito de aplicação O valor padrão é task. 'Piscina'
'Tarefa'

CertificadoReferência

Designação Descrição Valor
ID A ID totalmente qualificada do certificado a ser instalado no pool. Isso deve estar dentro da mesma conta de lote que o pool. string (obrigatório)
storeLocalização O valor padrão é currentUser. Essa propriedade é aplicável somente para pools configurados com nós do Windows (ou seja, criados com cloudServiceConfiguration ou com virtualMachineConfiguration usando uma referência de imagem do Windows). Para nós de computação do Linux, os certificados são armazenados em um diretório dentro do diretório de trabalho da 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 inicial do usuário (por exemplo, /home/{user-name}/certs) e os certificados são colocados nesse diretório. 'CurrentUser'
'LocalMachine'
nome_da_loja Essa propriedade é aplicável somente para pools configurados com nós do Windows (ou seja, criados com cloudServiceConfiguration ou com virtualMachineConfiguration usando uma referência de imagem do Windows). Os nomes de armazenamento comuns incluem: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, mas qualquer nome de loja personalizado também pode ser usado. O valor padrão é My. string
Visibilidade Quais contas de usuário no nó de computação devem ter acesso aos dados privados do certificado. Matriz de cadeia de caracteres contendo qualquer uma das:
'RemoteUser'
'StartTask'
'Tarefa'

CloudServiceConfiguration

Designação Descrição Valor
osFamília Os valores possíveis são: 2 - OS Family 2, equivalente ao Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalente ao Windows Server 2012. 4 - Família OS 4, equivalente ao Windows Server 2012 R2. 5 - Família OS 5, equivalente ao Windows Server 2016. Para obter mais informações, consulte Versões do SO convidado do Azure (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). string (obrigatório)
osVersão O valor padrão é *, que especifica a versão mais recente do sistema operacional para a família de sistemas operacionais especificada. string

ContainerConfiguration

Designação Descrição Valor
containerImageNames Esta é a referência de imagem completa, como seria especificado para "docker pull". Uma imagem será originada do registro padrão do Docker, a menos que a imagem seja totalmente qualificada com um registro alternativo. string[]
contentoresRegistos Se alguma imagem deve ser baixada de um registro privado que requer credenciais, então essas credenciais devem ser fornecidas aqui. ContainerRegistry[]
tipo A tecnologia de contentores a utilizar. 'DockerCompatible' (obrigatório)

ContainerRegistry

Designação Descrição Valor
palavra-passe A palavra-passe para iniciar sessão no servidor de registo. string (obrigatório)
registryServer [en] Se omitido, o padrão é "docker.io". string
nome de utilizador O nome de utilizador para iniciar sessão no servidor de registo. string (obrigatório)

Disco de dados

Designação Descrição Valor
armazenamento em cache Os valores são:

none - O modo de cache para o disco não está ativado.
readOnly - O modo de cache do disco é somente leitura.
readWrite - O modo de cache para o disco é leitura e gravação.

O valor padrão para cache é none. Para obter informações sobre as opções de cache, consulte: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.		 'Nenhuma'
'Somente leitura'
'ReadWrite'
diskSizeGB O tamanho inicial do disco em GB ao criar um novo disco de dados. int (obrigatório)
LUN O lun é usado para identificar exclusivamente cada disco de dados. Se anexar vários discos, cada um deve ter um lun distinto. int (obrigatório)
storageAccountType Se omitido, o padrão é "Standard_LRS". Os valores são:

Standard_LRS - O disco de dados deve usar armazenamento padrão localmente redundante.
Premium_LRS - O disco de dados deve usar armazenamento redundante local premium.		 'Premium_LRS'
'Standard_LRS'

DeploymentConfiguration

Designação Descrição Valor
cloudServiceConfiguration 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 Batch foi criada com sua propriedade poolAllocationMode definida como 'UserSubscription'. CloudServiceConfiguration
virtualMachineConfiguration Esta propriedade e cloudServiceConfiguration são mutuamente exclusivas e uma das propriedades deve ser especificada. VirtualMachineConfiguration

AmbienteConfiguração

Designação Descrição Valor
Designação O nome da variável de ambiente. string (obrigatório)
valor O valor da variável de ambiente. string

FixedScaleSettings

Designação Descrição Valor
nodeDeallocationOption Se omitido, o valor padrão é Requeue. 'Refila de espera'
'Dados retidos'
'Conclusão de tarefas'
'Terminar'
redimensionarTimeout O valor padrão é 15 minutos. Os valores de tempo limite usam o formato ISO 8601. Por exemplo, use PT10M por 10 minutos. O valor mínimo é de 5 minutos. Se você especificar um valor inferior a 5 minutos, o serviço em lote rejeitará a solicitação com um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação incorreta). string
targetDedicatedNodes Pelo menos um dos nós targetDedicatedNodes, targetLowPriority deve ser definido. Int
targetLowPriorityNodes Pelo menos um dos nós targetDedicatedNodes, targetLowPriority deve ser definido. Int

ImageReference

Designação Descrição Valor
ID Esta propriedade é mutuamente exclusiva com outras propriedades. A imagem da máquina virtual deve estar na mesma região e assinatura que a conta do Lote do Azure. Para obter informações sobre as configurações de firewall para o agente do nó em lote se comunicar com o serviço em lote, consulte /azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration . string
oferta Por exemplo, UbuntuServer ou WindowsServer. string
editora Por exemplo, Canonical ou MicrosoftWindowsServer. string
SKU Por exemplo, 14.04.0-LTS ou 2012-R2-Datacenter. string
Versão Um valor de 'mais recente' pode ser especificado para selecionar a versão mais recente de uma imagem. Se omitido, o padrão é 'mais recente'. string

InboundNatPool

Designação Descrição Valor
backendPort Isso deve ser exclusivo dentro de um pool de lotes. Os valores aceitáveis situam-se entre 1 e 65535, exceto para 22, 3389, 29876 e 29877, uma vez que estes são reservados. Se algum valor reservado for fornecido, a solicitação falhará com o código de status HTTP 400. int (obrigatório)
frontendPortRangeEnd Os valores aceitáveis variam entre 1 e 65534, exceto as portas de 50000 a 55000 que são reservadas pelo serviço de lote. Todos os intervalos dentro de um pool devem ser distintos e não podem se sobrepor. Se algum valor reservado ou sobreposto for fornecido, a solicitação falhará com o código de status HTTP 400. int (obrigatório)
frontendPortRangeStart Os valores aceitáveis variam entre 1 e 65534, exceto as portas de 50000 a 55000 que são reservadas. Todos os intervalos dentro de um pool devem ser distintos e não podem se sobrepor. Se algum valor reservado ou sobreposto for fornecido, a solicitação falhará com o código de status HTTP 400. int (obrigatório)
Designação O nome deve ser exclusivo dentro de um pool de lotes, pode conter letras, números, sublinhados, pontos e hífenes. Os nomes devem começar com uma letra ou número, devem terminar com uma letra, número ou sublinhado e não podem exceder 77 caracteres. Se algum valor inválido for fornecido, a solicitação falhará com o código de status HTTP 400. string (obrigatório)
networkSecurityGroupRules O número máximo de regras que podem ser especificadas em todos os pontos de extremidade em um pool de lotes é 25. Se nenhuma regra de grupo de segurança de rede for especificada, uma regra padrão será criada para permitir o acesso de entrada à porta de back-end especificada. Se o número máximo de regras de grupo de segurança de rede for excedido, a solicitação falhará com o código de status HTTP 400. NetworkSecurityGroupRule[]
protocolo O protocolo do ponto de extremidade. 'TCP'
'UDP' (obrigatório)

LinuxUserConfiguration

Designação Descrição Valor
GID As propriedades uid e gid devem ser especificadas juntas ou não devem ser especificadas de todo. Se não for especificado, o sistema operacional subjacente seleciona o gid. Int
sshPrivateKey A chave privada não deve ser protegida por senha. A chave privada é usada para configurar automaticamente a autenticação baseada em chave assimétrica para SSH entre nós em um pool Linux quando a propriedade enableInterNodeCommunication do pool é true (ela é ignorada se enableInterNodeCommunication for false). Ele faz isso colocando o par de chaves no diretório .ssh do usuário. Se não for especificado, o SSH sem senha não será configurado entre nós (nenhuma modificação do diretório .ssh do usuário será feita). string
UID As propriedades uid e gid devem ser especificadas juntas ou não devem ser especificadas de todo. Se não for especificado, o sistema operacional subjacente seleciona o uid. Int

MetadataItem

Designação Descrição Valor
Designação O nome do item de metadados. string (obrigatório)
valor O valor do item de metadados. string (obrigatório)

Microsoft.Batch/batchAccounts/pools

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[a-zA-Z0-9_-]+$ (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.		 Nome simbólico para recurso do tipo: batchAccounts
propriedades As propriedades associadas ao pool. PoolProperties

Configuração de rede

Designação Descrição Valor
endpointConfiguration A configuração do ponto de extremidade do pool só é suportada em pools com a propriedade virtualMachineConfiguration. PoolEndpointConfiguration
subnetId A rede virtual deve estar na mesma região e assinatura que a conta do Lote do Azure. A sub-rede especificada deve ter endereços IP livres suficientes para acomodar o número de nós no pool. Se a sub-rede não tiver endereços IP livres suficientes, o pool alocará parcialmente os nós de computação e ocorrerá um erro de redimensionamento. A entidade de serviço 'MicrosoftAzureBatch' deve ter a função 'Colaborador de Máquina Virtual Clássica' Role-Based Controle de Acesso (RBAC) para a VNet especificada. A sub-rede especificada deve permitir a comunicação do serviço Lote do Azure para poder agendar tarefas nos nós de computação. Isso pode ser verificado verificando se a rede virtual especificada tem algum NSG (Network Security Groups) associado. Se a comunicação com os nós de computação na sub-rede especificada for negada por um NSG, o serviço em lote definirá o estado dos nós de computação como inutilizável. Para pools criados via virtualMachineConfiguration, a conta Batch deve ter poolAllocationMode userSubscription para usar uma VNet. Se a VNet especificada tiver algum NSG (Network Security Groups) associado, algumas portas de sistema reservadas deverão ser habilitadas para comunicação de entrada. Para pools criados com uma configuração de máquina virtual, habilite as portas 29876 e 29877, bem como a porta 22 para Linux e a porta 3389 para Windows. Para pools criados com uma configuração de serviço de nuvem, habilite as portas 10100, 20100 e 30100. Habilite também as conexões de saída para o Armazenamento do Azure na porta 443. Para obter mais detalhes, consulte: /azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration string

NetworkSecurityGroupRule

Designação Descrição Valor
Acesso A ação que deve ser tomada para um endereço IP, intervalo de sub-rede ou tag especificado. 'Permitir'
'Negar' (obrigatório)
prioridade As prioridades dentro de um pool devem ser únicas e são avaliadas por ordem de prioridade. Quanto menor o número, maior a prioridade. Por exemplo, as regras podem ser especificadas com números de ordem de 150, 250 e 350. A regra com o número de ordem 150 tem precedência sobre a regra que tem uma ordem de 250. As prioridades permitidas são de 150 a 3500. Se algum valor reservado ou duplicado for fornecido, a solicitação falhará com o código de status HTTP 400. int (obrigatório)
sourceAddressPrefix Os valores válidos são um único endereço IP (ou seja, 10.10.10.10), sub-rede IP (ou seja, 192.168.1.0/24), tag padrão ou * (para todos os endereços). Se quaisquer outros valores forem fornecidos, a solicitação falhará com o código de status HTTP 400. string (obrigatório)

PoolEndpointConfiguration

Designação Descrição Valor
inboundNatPools O número máximo de pools de NAT de entrada por pool de lotes é 5. Se o número máximo de pools NAT de entrada for excedido, a solicitação falhará com o código de status HTTP 400. InboundNatPool[] (obrigatório)

PoolProperties

Designação Descrição Valor
applicationLicenses 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á. string[]
applicationPackages As alterações nos pacotes de aplicativos afetam todos os novos nós de computação 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. ApplicationPackageReference []
Certificados Para nós de computação do Windows, o serviço Batch instala os certificados no armazenamento de certificados e no local especificados. Para nós de computação do Linux, os certificados são armazenados em um diretório dentro do diretório de trabalho da 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 inicial do usuário (por exemplo, /home/{user-name}/certs) e os certificados são colocados nesse diretório. CertificateReference[]
deploymentConfiguration Usar CloudServiceConfiguration especifica que os nós devem ser criados usando os Serviços de Nuvem do Azure (PaaS), enquanto VirtualMachineConfiguration usa Máquinas Virtuais do Azure (IaaS). DeploymentConfiguration
displayName O nome para exibição não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024. string
interNodeCommunication Isso impõe restrições sobre quais nós podem ser atribuídos ao pool. Habilitar esse valor pode reduzir a chance de o número solicitado de nós ser alocado no pool. Se não for especificado, o padrão desse valor será 'Desativado'. 'Desativado'
'Habilitado'
maxTasksPerNode O número máximo de tarefas que podem ser executadas simultaneamente em um único nó de computação no pool. Int
metadados O serviço Batch não atribui qualquer significado aos metadados; é exclusivamente para o uso do código de usuário. MetadataItem []
networkConfiguration A configuração de rede para um pool. NetworkConfiguration
scaleSettings Define o tamanho desejado do pool. Isso pode ser 'fixedScale', onde o targetDedicatedNodes solicitado é especificado, ou 'autoScale', que define uma fórmula que é reavaliada periodicamente. Se essa propriedade não for especificada, o pool terá uma escala fixa com 0 targetDedicatedNodes. ScaleSettings
startTask Em uma operação PATCH (atualização), essa propriedade pode ser definida como um objeto vazio para remover a tarefa inicial do pool. StartTask
taskSchedulingPolicy Especifica como as tarefas devem ser distribuídas entre nós de computação. TaskSchedulingPolicy
userContas A lista de contas de usuário a serem criadas em cada nó do pool. Conta de Utilizador[]
vmTamanho Para obter informações sobre tamanhos disponíveis de máquinas virtuais para pools de Serviços de Nuvem (pools criados com cloudServiceConfiguration), consulte Tamanhos para Serviços de Nuvem (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). O Batch suporta todos os tamanhos de VM dos Serviços de Nuvem, exceto o ExtraSmall. Para obter informações sobre tamanhos de VM disponíveis para pools usando imagens do Virtual Machines Marketplace (pools criados com virtualMachineConfiguration), consulte Tamanhos para máquinas virtuais (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) ou Tamanhos para máquinas virtuais (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). O Batch dá suporte a todos os tamanhos de VM do Azure, exceto STANDARD_A0 e aqueles com armazenamento premium (STANDARD_GS, STANDARD_DS e STANDARD_DSV2 séries). string

Ficheiro de Recursos

Designação Descrição Valor
autoStorageContainerName As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. string
blobPrefix A propriedade é válida somente quando autoStorageContainerName ou storageContainerUrl é usado. Esse prefixo pode ser um nome de arquivo parcial ou um subdiretório. Se um prefixo não for especificado, todos os arquivos no contêiner serão baixados. string
fileMode Esta propriedade aplica-se apenas a arquivos que estão sendo baixados para nós de computação do Linux. Ele será ignorado se for especificado para um resourceFile que será baixado para um nó do Windows. Se essa propriedade não for especificada para um nó Linux, um valor padrão de 0770 será aplicado ao arquivo. string
filePath Se a propriedade httpUrl for especificada, o filePath será necessário e descreverá o caminho para o qual o arquivo será baixado, incluindo o nome do arquivo. Caso contrário, se a propriedade autoStorageContainerName ou storageContainerUrl for especificada, filePath será opcional e será o diretório para o qual os arquivos serão baixados. No caso em que filePath é usado como um diretório, qualquer estrutura de diretório já associada aos dados de entrada será mantida na íntegra e anexada ao diretório filePath especificado. O caminho relativo especificado não pode sair do diretório de trabalho da tarefa (por exemplo, usando '..'). string
httpUrl As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Se a URL for Armazenamento de Blob do Azure, ela deverá ser legível usando acesso anônimo; ou seja, o serviço Batch não apresenta nenhuma credencial ao baixar o blob. Há duas maneiras de obter essa URL para um blob no armazenamento do Azure: incluir uma SAS (Assinatura de Acesso Compartilhado) concedendo permissões de leitura no blob ou definir a ACL para o blob ou seu contêiner para permitir acesso público. string
storageContainerUrl As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Este URL deve ser legível e listável usando acesso anônimo; ou seja, o serviço Batch não apresenta nenhuma credencial ao baixar o blob. Há duas maneiras de obter essa URL para um blob no armazenamento do Azure: incluir uma Assinatura de Acesso Compartilhado (SAS) concedendo permissões de leitura e lista no blob ou definir a ACL para o blob ou seu contêiner para permitir acesso público. string

Configurações de escala

Designação Descrição Valor
autoDimensionamento Esta propriedade e fixedScale são mutuamente exclusivas e uma das propriedades deve ser especificada. AutoScaleSettings
escala fixa Esta propriedade e autoScale são mutuamente exclusivas e uma das propriedades deve ser especificada. FixedScaleSettings

IniciarTarefa

Designação Descrição Valor
linha de comando A linha de comando não é executada sob um shell e, portanto, não pode aproveitar os recursos do shell, como a expansão da variável de ambiente. Se você quiser aproveitar esses recursos, você deve invocar o shell na linha de comando, por exemplo, usando "cmd /c MyCommand" no Windows ou "/bin/sh -c MyCommand" no Linux. Obrigatório se quaisquer outras propriedades do startTask forem especificadas. string
containerSettings Quando isso é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios do Lote do Azure no nó) são mapeados no contêiner, todas as variáveis de ambiente de tarefa são mapeadas no contêiner e a linha de comando da tarefa é executada no contêiner. TaskContainerSettings
ambienteConfigurações Uma lista de configurações de variáveis de ambiente para a tarefa iniciar. EnvironmentSetting[]
maxTaskRetryCount O serviço de lote tenta novamente uma tarefa se seu código de saída for diferente de zero. Observe que esse valor controla especificamente o número de tentativas. O serviço de lote tentará a tarefa uma vez e, em seguida, poderá tentar novamente até esse limite. Por exemplo, se a contagem máxima de tentativas for 3, o Batch tentará a tarefa até 4 vezes (uma tentativa inicial e 3 tentativas). Se a contagem máxima de tentativas for 0, o serviço Batch não repetirá a tarefa. Se a contagem máxima de tentativas for -1, o serviço em lote repetirá a tarefa sem limite. Int
resourceFiles Uma lista de arquivos que o serviço Batch baixará para o nó de computação antes de executar a linha de comando. ResourceFile []
userIdentity Se omitida, a tarefa é executada como um usuário não administrativo exclusivo para a tarefa. UserIdentity
waitForSuccess Se true e a tarefa inicial falhar em um nó de computação, o serviço Batch tentará novamente a tarefa inicial até sua contagem máxima de tentativas (maxTaskRetryCount). Se a tarefa ainda não tiver sido concluída com êxito após todas as tentativas, o serviço em lote marcará o nó de computação como inutilizável e não agendará tarefas para ele. Esta condição pode ser detetada através do estado do nó e detalhes do erro de agendamento. Se false, o serviço Batch não aguardará a conclusão da tarefa inicial. Nesse caso, outras tarefas podem começar a ser executadas no nó de computação enquanto a tarefa inicial ainda está em execução; E mesmo que a tarefa Iniciar falhe, novas tarefas continuarão a ser agendadas no nó. O padrão é false. Bool

TaskContainerSettings

Designação Descrição Valor
containerRunOptions Essas opções adicionais são fornecidas como argumentos para o comando "docker create", além daquelas controladas pelo Batch Service. string
nome_da_imagem Esta é a referência de imagem completa, como seria especificado para "docker pull". Se nenhuma tag for fornecida como parte do nome da imagem, a tag ":latest" será usada como padrão. string (obrigatório)
registo Essa configuração pode ser omitida se já tiver sido fornecida na criação do pool. ContainerRegistry

TaskSchedulingPolicy

Designação Descrição Valor
nodeFillType Como as tarefas devem ser distribuídas entre nós de computação. 'Pacote'
'Spread' (obrigatório)

Conta de Utilizador

Designação Descrição Valor
elevaçãoNível nonAdmin - O usuário automático é um usuário padrão sem acesso elevado. admin - O usuário automático é um usuário com acesso elevado e opera com permissões totais de administrador. O valor padrão é nonAdmin. 'Administrador'
'Não administrador'
linuxUserConfiguration Esta propriedade é ignorada se especificada em um pool do Windows. Se não for especificado, o usuário será criado com as opções padrão. LinuxUserConfiguration
Designação O nome da conta de usuário. string (obrigatório)
palavra-passe A senha da conta de usuário. string (obrigatório)
windowsUserConfiguration Essa propriedade só pode ser especificada se o usuário estiver em um pool do Windows. Se não especificado e em um pool do Windows, o usuário é criado com as opções padrão. WindowsUserConfiguration

Identidade do usuário

Designação Descrição Valor
autoUsuário As propriedades userName e autoUser são mutuamente exclusivas; você deve especificar um, mas não ambos. AutoUserSpecification
nome de utilizador As propriedades userName e autoUser são mutuamente exclusivas; você deve especificar um, mas não ambos. string

VirtualMachineConfiguration

Designação Descrição Valor
containerConfiguration Se especificado, a configuração é executada em cada nó do pool para permitir que as tarefas sejam executadas em contêineres. Todas as tarefas regulares e tarefas do gerenciador de tarefas executadas nesse pool devem especificar a propriedade containerSettings e todas as outras tarefas podem especificá-la. ContainerConfiguration
dataDisks Essa propriedade deve ser especificada se os nós de computação no pool precisarem ter discos de dados vazios conectados a eles. DataDisk[]
imageReference Uma referência a uma imagem do Azure Virtual Machines Marketplace ou ao recurso Azure Image de uma Máquina Virtual personalizada. Para obter a lista de todas as imageReferences verificadas pelo Lote do Azure, consulte a operação 'Listar SKUs de agente de nó suportado'. ImageReference (obrigatório)
Tipo de licença Isso só se aplica a imagens que contêm o sistema operacional Windows e só deve ser usado quando você possui licenças locais válidas para os nós que serão implantados. Se omitido, nenhum desconto de licenciamento local será aplicado. Os valores são:

Windows_Server - A licença local é para o Windows Server.
Windows_Client - A licença local é para o Windows Client.		 string
nodeAgentSkuId O agente do nó Batch é um programa executado em cada nó do pool e fornece a interface de comando e controle entre o nó e o serviço Batch. Existem diferentes implementações do agente de nó, conhecido como SKUs, para diferentes sistemas operacionais. Você deve especificar uma SKU do agente de nó que corresponda à referência de imagem selecionada. Para obter a lista de SKUs de agente de nó suportados, juntamente com sua lista de referências de imagem verificadas, consulte a operação 'Listar SKUs de agente de nó suportados'. string (obrigatório)
windowsConfiguração Essa propriedade não deve ser especificada se imageReference especificar uma imagem do sistema operacional Linux. WindowsConfiguration

WindowsConfiguration

Designação Descrição Valor
enableAutomaticUpdates Se omitido, o valor padrão é true. Bool

WindowsUserConfiguration

Designação Descrição Valor
loginMode Especifica o modo de login para o usuário. O valor padrão para pools VirtualMachineConfiguration é o modo interativo e para os pools CloudServiceConfiguration é o modo em lote. 'Lote'
'Interativo'

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
pool de lotes do Azure sem endereços IP públicos Este modelo cria o pool de comunicação de nó simplificado do Lote do Azure sem endereços IP públicos.

Definição de recurso de modelo ARM

O tipo de recurso batchAccounts/pools pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Batch/batchAccounts/pools, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.Batch/batchAccounts/pools",
  "apiVersion": "2018-12-01",
  "name": "string",
  "properties": {
    "applicationLicenses": [ "string" ],
    "applicationPackages": [
      {
        "id": "string",
        "version": "string"
      }
    ],
    "certificates": [
      {
        "id": "string",
        "storeLocation": "string",
        "storeName": "string",
        "visibility": [ "string" ]
      }
    ],
    "deploymentConfiguration": {
      "cloudServiceConfiguration": {
        "osFamily": "string",
        "osVersion": "string"
      },
      "virtualMachineConfiguration": {
        "containerConfiguration": {
          "containerImageNames": [ "string" ],
          "containerRegistries": [
            {
              "password": "string",
              "registryServer": "string",
              "username": "string"
            }
          ],
          "type": "DockerCompatible"
        },
        "dataDisks": [
          {
            "caching": "string",
            "diskSizeGB": "int",
            "lun": "int",
            "storageAccountType": "string"
          }
        ],
        "imageReference": {
          "id": "string",
          "offer": "string",
          "publisher": "string",
          "sku": "string",
          "version": "string"
        },
        "licenseType": "string",
        "nodeAgentSkuId": "string",
        "windowsConfiguration": {
          "enableAutomaticUpdates": "bool"
        }
      }
    },
    "displayName": "string",
    "interNodeCommunication": "string",
    "maxTasksPerNode": "int",
    "metadata": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "networkConfiguration": {
      "endpointConfiguration": {
        "inboundNatPools": [
          {
            "backendPort": "int",
            "frontendPortRangeEnd": "int",
            "frontendPortRangeStart": "int",
            "name": "string",
            "networkSecurityGroupRules": [
              {
                "access": "string",
                "priority": "int",
                "sourceAddressPrefix": "string"
              }
            ],
            "protocol": "string"
          }
        ]
      },
      "subnetId": "string"
    },
    "scaleSettings": {
      "autoScale": {
        "evaluationInterval": "string",
        "formula": "string"
      },
      "fixedScale": {
        "nodeDeallocationOption": "string",
        "resizeTimeout": "string",
        "targetDedicatedNodes": "int",
        "targetLowPriorityNodes": "int"
      }
    },
    "startTask": {
      "commandLine": "string",
      "containerSettings": {
        "containerRunOptions": "string",
        "imageName": "string",
        "registry": {
          "password": "string",
          "registryServer": "string",
          "username": "string"
        }
      },
      "environmentSettings": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "maxTaskRetryCount": "int",
      "resourceFiles": [
        {
          "autoStorageContainerName": "string",
          "blobPrefix": "string",
          "fileMode": "string",
          "filePath": "string",
          "httpUrl": "string",
          "storageContainerUrl": "string"
        }
      ],
      "userIdentity": {
        "autoUser": {
          "elevationLevel": "string",
          "scope": "string"
        },
        "userName": "string"
      },
      "waitForSuccess": "bool"
    },
    "taskSchedulingPolicy": {
      "nodeFillType": "string"
    },
    "userAccounts": [
      {
        "elevationLevel": "string",
        "linuxUserConfiguration": {
          "gid": "int",
          "sshPrivateKey": "string",
          "uid": "int"
        },
        "name": "string",
        "password": "string",
        "windowsUserConfiguration": {
          "loginMode": "string"
        }
      }
    ],
    "vmSize": "string"
  }
}

Valores de propriedade

ApplicationPackageReference

Designação Descrição Valor
ID A ID do pacote de aplicativo a ser instalado. Isso deve estar dentro da mesma conta de lote que o pool. Isso pode ser uma referência a uma versão específica ou a versão padrão, se existir. string (obrigatório)
Versão Se isso for omitido e nenhuma versão padrão for especificada para este aplicativo, a solicitação falhará com o código de erro InvalidApplicationPackageReferences. Se você estiver chamando a API REST diretamente, o código de status HTTP será 409. string

AutoScaleSettings

Designação Descrição Valor
avaliaçãoIntervalo Se omitido, o valor padrão é 15 minutos (PT15M). string
fórmula Uma fórmula para o número desejado de nós de computação no pool. string (obrigatório)

AutoUserSpecification

Designação Descrição Valor
elevaçãoNível nonAdmin - O usuário automático é um usuário padrão sem acesso elevado. admin - O usuário automático é um usuário com acesso elevado e opera com permissões totais de administrador. O valor padrão é nonAdmin. 'Administrador'
'Não administrador'
Âmbito de aplicação O valor padrão é task. 'Piscina'
'Tarefa'

CertificadoReferência

Designação Descrição Valor
ID A ID totalmente qualificada do certificado a ser instalado no pool. Isso deve estar dentro da mesma conta de lote que o pool. string (obrigatório)
storeLocalização O valor padrão é currentUser. Essa propriedade é aplicável somente para pools configurados com nós do Windows (ou seja, criados com cloudServiceConfiguration ou com virtualMachineConfiguration usando uma referência de imagem do Windows). Para nós de computação do Linux, os certificados são armazenados em um diretório dentro do diretório de trabalho da 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 inicial do usuário (por exemplo, /home/{user-name}/certs) e os certificados são colocados nesse diretório. 'CurrentUser'
'LocalMachine'
nome_da_loja Essa propriedade é aplicável somente para pools configurados com nós do Windows (ou seja, criados com cloudServiceConfiguration ou com virtualMachineConfiguration usando uma referência de imagem do Windows). Os nomes de armazenamento comuns incluem: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, mas qualquer nome de loja personalizado também pode ser usado. O valor padrão é My. string
Visibilidade Quais contas de usuário no nó de computação devem ter acesso aos dados privados do certificado. Matriz de cadeia de caracteres contendo qualquer uma das:
'RemoteUser'
'StartTask'
'Tarefa'

CloudServiceConfiguration

Designação Descrição Valor
osFamília Os valores possíveis são: 2 - OS Family 2, equivalente ao Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalente ao Windows Server 2012. 4 - Família OS 4, equivalente ao Windows Server 2012 R2. 5 - Família OS 5, equivalente ao Windows Server 2016. Para obter mais informações, consulte Versões do SO convidado do Azure (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). string (obrigatório)
osVersão O valor padrão é *, que especifica a versão mais recente do sistema operacional para a família de sistemas operacionais especificada. string

ContainerConfiguration

Designação Descrição Valor
containerImageNames Esta é a referência de imagem completa, como seria especificado para "docker pull". Uma imagem será originada do registro padrão do Docker, a menos que a imagem seja totalmente qualificada com um registro alternativo. string[]
contentoresRegistos Se alguma imagem deve ser baixada de um registro privado que requer credenciais, então essas credenciais devem ser fornecidas aqui. ContainerRegistry[]
tipo A tecnologia de contentores a utilizar. 'DockerCompatible' (obrigatório)

ContainerRegistry

Designação Descrição Valor
palavra-passe A palavra-passe para iniciar sessão no servidor de registo. string (obrigatório)
registryServer [en] Se omitido, o padrão é "docker.io". string
nome de utilizador O nome de utilizador para iniciar sessão no servidor de registo. string (obrigatório)

Disco de dados

Designação Descrição Valor
armazenamento em cache Os valores são:

none - O modo de cache para o disco não está ativado.
readOnly - O modo de cache do disco é somente leitura.
readWrite - O modo de cache para o disco é leitura e gravação.

O valor padrão para cache é none. Para obter informações sobre as opções de cache, consulte: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.		 'Nenhuma'
'Somente leitura'
'ReadWrite'
diskSizeGB O tamanho inicial do disco em GB ao criar um novo disco de dados. int (obrigatório)
LUN O lun é usado para identificar exclusivamente cada disco de dados. Se anexar vários discos, cada um deve ter um lun distinto. int (obrigatório)
storageAccountType Se omitido, o padrão é "Standard_LRS". Os valores são:

Standard_LRS - O disco de dados deve usar armazenamento padrão localmente redundante.
Premium_LRS - O disco de dados deve usar armazenamento redundante local premium.		 'Premium_LRS'
'Standard_LRS'

DeploymentConfiguration

Designação Descrição Valor
cloudServiceConfiguration 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 Batch foi criada com sua propriedade poolAllocationMode definida como 'UserSubscription'. CloudServiceConfiguration
virtualMachineConfiguration Esta propriedade e cloudServiceConfiguration são mutuamente exclusivas e uma das propriedades deve ser especificada. VirtualMachineConfiguration

AmbienteConfiguração

Designação Descrição Valor
Designação O nome da variável de ambiente. string (obrigatório)
valor O valor da variável de ambiente. string

FixedScaleSettings

Designação Descrição Valor
nodeDeallocationOption Se omitido, o valor padrão é Requeue. 'Refila de espera'
'Dados retidos'
'Conclusão de tarefas'
'Terminar'
redimensionarTimeout O valor padrão é 15 minutos. Os valores de tempo limite usam o formato ISO 8601. Por exemplo, use PT10M por 10 minutos. O valor mínimo é de 5 minutos. Se você especificar um valor inferior a 5 minutos, o serviço em lote rejeitará a solicitação com um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação incorreta). string
targetDedicatedNodes Pelo menos um dos nós targetDedicatedNodes, targetLowPriority deve ser definido. Int
targetLowPriorityNodes Pelo menos um dos nós targetDedicatedNodes, targetLowPriority deve ser definido. Int

ImageReference

Designação Descrição Valor
ID Esta propriedade é mutuamente exclusiva com outras propriedades. A imagem da máquina virtual deve estar na mesma região e assinatura que a conta do Lote do Azure. Para obter informações sobre as configurações de firewall para o agente do nó em lote se comunicar com o serviço em lote, consulte /azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration . string
oferta Por exemplo, UbuntuServer ou WindowsServer. string
editora Por exemplo, Canonical ou MicrosoftWindowsServer. string
SKU Por exemplo, 14.04.0-LTS ou 2012-R2-Datacenter. string
Versão Um valor de 'mais recente' pode ser especificado para selecionar a versão mais recente de uma imagem. Se omitido, o padrão é 'mais recente'. string

InboundNatPool

Designação Descrição Valor
backendPort Isso deve ser exclusivo dentro de um pool de lotes. Os valores aceitáveis situam-se entre 1 e 65535, exceto para 22, 3389, 29876 e 29877, uma vez que estes são reservados. Se algum valor reservado for fornecido, a solicitação falhará com o código de status HTTP 400. int (obrigatório)
frontendPortRangeEnd Os valores aceitáveis variam entre 1 e 65534, exceto as portas de 50000 a 55000 que são reservadas pelo serviço de lote. Todos os intervalos dentro de um pool devem ser distintos e não podem se sobrepor. Se algum valor reservado ou sobreposto for fornecido, a solicitação falhará com o código de status HTTP 400. int (obrigatório)
frontendPortRangeStart Os valores aceitáveis variam entre 1 e 65534, exceto as portas de 50000 a 55000 que são reservadas. Todos os intervalos dentro de um pool devem ser distintos e não podem se sobrepor. Se algum valor reservado ou sobreposto for fornecido, a solicitação falhará com o código de status HTTP 400. int (obrigatório)
Designação O nome deve ser exclusivo dentro de um pool de lotes, pode conter letras, números, sublinhados, pontos e hífenes. Os nomes devem começar com uma letra ou número, devem terminar com uma letra, número ou sublinhado e não podem exceder 77 caracteres. Se algum valor inválido for fornecido, a solicitação falhará com o código de status HTTP 400. string (obrigatório)
networkSecurityGroupRules O número máximo de regras que podem ser especificadas em todos os pontos de extremidade em um pool de lotes é 25. Se nenhuma regra de grupo de segurança de rede for especificada, uma regra padrão será criada para permitir o acesso de entrada à porta de back-end especificada. Se o número máximo de regras de grupo de segurança de rede for excedido, a solicitação falhará com o código de status HTTP 400. NetworkSecurityGroupRule[]
protocolo O protocolo do ponto de extremidade. 'TCP'
'UDP' (obrigatório)

LinuxUserConfiguration

Designação Descrição Valor
GID As propriedades uid e gid devem ser especificadas juntas ou não devem ser especificadas de todo. Se não for especificado, o sistema operacional subjacente seleciona o gid. Int
sshPrivateKey A chave privada não deve ser protegida por senha. A chave privada é usada para configurar automaticamente a autenticação baseada em chave assimétrica para SSH entre nós em um pool Linux quando a propriedade enableInterNodeCommunication do pool é true (ela é ignorada se enableInterNodeCommunication for false). Ele faz isso colocando o par de chaves no diretório .ssh do usuário. Se não for especificado, o SSH sem senha não será configurado entre nós (nenhuma modificação do diretório .ssh do usuário será feita). string
UID As propriedades uid e gid devem ser especificadas juntas ou não devem ser especificadas de todo. Se não for especificado, o sistema operacional subjacente seleciona o uid. Int

MetadataItem

Designação Descrição Valor
Designação O nome do item de metadados. string (obrigatório)
valor O valor do item de metadados. string (obrigatório)

Microsoft.Batch/batchAccounts/pools

Designação Descrição Valor
apiVersion A versão api '2018-12-01'
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[a-zA-Z0-9_-]+$ (obrigatório)
propriedades As propriedades associadas ao pool. PoolProperties
tipo O tipo de recurso 'Microsoft.Batch/batchAccounts/pools'

Configuração de rede

Designação Descrição Valor
endpointConfiguration A configuração do ponto de extremidade do pool só é suportada em pools com a propriedade virtualMachineConfiguration. PoolEndpointConfiguration
subnetId A rede virtual deve estar na mesma região e assinatura que a conta do Lote do Azure. A sub-rede especificada deve ter endereços IP livres suficientes para acomodar o número de nós no pool. Se a sub-rede não tiver endereços IP livres suficientes, o pool alocará parcialmente os nós de computação e ocorrerá um erro de redimensionamento. A entidade de serviço 'MicrosoftAzureBatch' deve ter a função 'Colaborador de Máquina Virtual Clássica' Role-Based Controle de Acesso (RBAC) para a VNet especificada. A sub-rede especificada deve permitir a comunicação do serviço Lote do Azure para poder agendar tarefas nos nós de computação. Isso pode ser verificado verificando se a rede virtual especificada tem algum NSG (Network Security Groups) associado. Se a comunicação com os nós de computação na sub-rede especificada for negada por um NSG, o serviço em lote definirá o estado dos nós de computação como inutilizável. Para pools criados via virtualMachineConfiguration, a conta Batch deve ter poolAllocationMode userSubscription para usar uma VNet. Se a VNet especificada tiver algum NSG (Network Security Groups) associado, algumas portas de sistema reservadas deverão ser habilitadas para comunicação de entrada. Para pools criados com uma configuração de máquina virtual, habilite as portas 29876 e 29877, bem como a porta 22 para Linux e a porta 3389 para Windows. Para pools criados com uma configuração de serviço de nuvem, habilite as portas 10100, 20100 e 30100. Habilite também as conexões de saída para o Armazenamento do Azure na porta 443. Para obter mais detalhes, consulte: /azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration string

NetworkSecurityGroupRule

Designação Descrição Valor
Acesso A ação que deve ser tomada para um endereço IP, intervalo de sub-rede ou tag especificado. 'Permitir'
'Negar' (obrigatório)
prioridade As prioridades dentro de um pool devem ser únicas e são avaliadas por ordem de prioridade. Quanto menor o número, maior a prioridade. Por exemplo, as regras podem ser especificadas com números de ordem de 150, 250 e 350. A regra com o número de ordem 150 tem precedência sobre a regra que tem uma ordem de 250. As prioridades permitidas são de 150 a 3500. Se algum valor reservado ou duplicado for fornecido, a solicitação falhará com o código de status HTTP 400. int (obrigatório)
sourceAddressPrefix Os valores válidos são um único endereço IP (ou seja, 10.10.10.10), sub-rede IP (ou seja, 192.168.1.0/24), tag padrão ou * (para todos os endereços). Se quaisquer outros valores forem fornecidos, a solicitação falhará com o código de status HTTP 400. string (obrigatório)

PoolEndpointConfiguration

Designação Descrição Valor
inboundNatPools O número máximo de pools de NAT de entrada por pool de lotes é 5. Se o número máximo de pools NAT de entrada for excedido, a solicitação falhará com o código de status HTTP 400. InboundNatPool[] (obrigatório)

PoolProperties

Designação Descrição Valor
applicationLicenses 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á. string[]
applicationPackages As alterações nos pacotes de aplicativos afetam todos os novos nós de computação 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. ApplicationPackageReference []
Certificados Para nós de computação do Windows, o serviço Batch instala os certificados no armazenamento de certificados e no local especificados. Para nós de computação do Linux, os certificados são armazenados em um diretório dentro do diretório de trabalho da 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 inicial do usuário (por exemplo, /home/{user-name}/certs) e os certificados são colocados nesse diretório. CertificateReference[]
deploymentConfiguration Usar CloudServiceConfiguration especifica que os nós devem ser criados usando os Serviços de Nuvem do Azure (PaaS), enquanto VirtualMachineConfiguration usa Máquinas Virtuais do Azure (IaaS). DeploymentConfiguration
displayName O nome para exibição não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024. string
interNodeCommunication Isso impõe restrições sobre quais nós podem ser atribuídos ao pool. Habilitar esse valor pode reduzir a chance de o número solicitado de nós ser alocado no pool. Se não for especificado, o padrão desse valor será 'Desativado'. 'Desativado'
'Habilitado'
maxTasksPerNode O número máximo de tarefas que podem ser executadas simultaneamente em um único nó de computação no pool. Int
metadados O serviço Batch não atribui qualquer significado aos metadados; é exclusivamente para o uso do código de usuário. MetadataItem []
networkConfiguration A configuração de rede para um pool. NetworkConfiguration
scaleSettings Define o tamanho desejado do pool. Isso pode ser 'fixedScale', onde o targetDedicatedNodes solicitado é especificado, ou 'autoScale', que define uma fórmula que é reavaliada periodicamente. Se essa propriedade não for especificada, o pool terá uma escala fixa com 0 targetDedicatedNodes. ScaleSettings
startTask Em uma operação PATCH (atualização), essa propriedade pode ser definida como um objeto vazio para remover a tarefa inicial do pool. StartTask
taskSchedulingPolicy Especifica como as tarefas devem ser distribuídas entre nós de computação. TaskSchedulingPolicy
userContas A lista de contas de usuário a serem criadas em cada nó do pool. Conta de Utilizador[]
vmTamanho Para obter informações sobre tamanhos disponíveis de máquinas virtuais para pools de Serviços de Nuvem (pools criados com cloudServiceConfiguration), consulte Tamanhos para Serviços de Nuvem (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). O Batch suporta todos os tamanhos de VM dos Serviços de Nuvem, exceto o ExtraSmall. Para obter informações sobre tamanhos de VM disponíveis para pools usando imagens do Virtual Machines Marketplace (pools criados com virtualMachineConfiguration), consulte Tamanhos para máquinas virtuais (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) ou Tamanhos para máquinas virtuais (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). O Batch dá suporte a todos os tamanhos de VM do Azure, exceto STANDARD_A0 e aqueles com armazenamento premium (STANDARD_GS, STANDARD_DS e STANDARD_DSV2 séries). string

Ficheiro de Recursos

Designação Descrição Valor
autoStorageContainerName As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. string
blobPrefix A propriedade é válida somente quando autoStorageContainerName ou storageContainerUrl é usado. Esse prefixo pode ser um nome de arquivo parcial ou um subdiretório. Se um prefixo não for especificado, todos os arquivos no contêiner serão baixados. string
fileMode Esta propriedade aplica-se apenas a arquivos que estão sendo baixados para nós de computação do Linux. Ele será ignorado se for especificado para um resourceFile que será baixado para um nó do Windows. Se essa propriedade não for especificada para um nó Linux, um valor padrão de 0770 será aplicado ao arquivo. string
filePath Se a propriedade httpUrl for especificada, o filePath será necessário e descreverá o caminho para o qual o arquivo será baixado, incluindo o nome do arquivo. Caso contrário, se a propriedade autoStorageContainerName ou storageContainerUrl for especificada, filePath será opcional e será o diretório para o qual os arquivos serão baixados. No caso em que filePath é usado como um diretório, qualquer estrutura de diretório já associada aos dados de entrada será mantida na íntegra e anexada ao diretório filePath especificado. O caminho relativo especificado não pode sair do diretório de trabalho da tarefa (por exemplo, usando '..'). string
httpUrl As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Se a URL for Armazenamento de Blob do Azure, ela deverá ser legível usando acesso anônimo; ou seja, o serviço Batch não apresenta nenhuma credencial ao baixar o blob. Há duas maneiras de obter essa URL para um blob no armazenamento do Azure: incluir uma SAS (Assinatura de Acesso Compartilhado) concedendo permissões de leitura no blob ou definir a ACL para o blob ou seu contêiner para permitir acesso público. string
storageContainerUrl As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Este URL deve ser legível e listável usando acesso anônimo; ou seja, o serviço Batch não apresenta nenhuma credencial ao baixar o blob. Há duas maneiras de obter essa URL para um blob no armazenamento do Azure: incluir uma Assinatura de Acesso Compartilhado (SAS) concedendo permissões de leitura e lista no blob ou definir a ACL para o blob ou seu contêiner para permitir acesso público. string

Configurações de escala

Designação Descrição Valor
autoDimensionamento Esta propriedade e fixedScale são mutuamente exclusivas e uma das propriedades deve ser especificada. AutoScaleSettings
escala fixa Esta propriedade e autoScale são mutuamente exclusivas e uma das propriedades deve ser especificada. FixedScaleSettings

IniciarTarefa

Designação Descrição Valor
linha de comando A linha de comando não é executada sob um shell e, portanto, não pode aproveitar os recursos do shell, como a expansão da variável de ambiente. Se você quiser aproveitar esses recursos, você deve invocar o shell na linha de comando, por exemplo, usando "cmd /c MyCommand" no Windows ou "/bin/sh -c MyCommand" no Linux. Obrigatório se quaisquer outras propriedades do startTask forem especificadas. string
containerSettings Quando isso é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios do Lote do Azure no nó) são mapeados no contêiner, todas as variáveis de ambiente de tarefa são mapeadas no contêiner e a linha de comando da tarefa é executada no contêiner. TaskContainerSettings
ambienteConfigurações Uma lista de configurações de variáveis de ambiente para a tarefa iniciar. EnvironmentSetting[]
maxTaskRetryCount O serviço de lote tenta novamente uma tarefa se seu código de saída for diferente de zero. Observe que esse valor controla especificamente o número de tentativas. O serviço de lote tentará a tarefa uma vez e, em seguida, poderá tentar novamente até esse limite. Por exemplo, se a contagem máxima de tentativas for 3, o Batch tentará a tarefa até 4 vezes (uma tentativa inicial e 3 tentativas). Se a contagem máxima de tentativas for 0, o serviço Batch não repetirá a tarefa. Se a contagem máxima de tentativas for -1, o serviço em lote repetirá a tarefa sem limite. Int
resourceFiles Uma lista de arquivos que o serviço Batch baixará para o nó de computação antes de executar a linha de comando. ResourceFile []
userIdentity Se omitida, a tarefa é executada como um usuário não administrativo exclusivo para a tarefa. UserIdentity
waitForSuccess Se true e a tarefa inicial falhar em um nó de computação, o serviço Batch tentará novamente a tarefa inicial até sua contagem máxima de tentativas (maxTaskRetryCount). Se a tarefa ainda não tiver sido concluída com êxito após todas as tentativas, o serviço em lote marcará o nó de computação como inutilizável e não agendará tarefas para ele. Esta condição pode ser detetada através do estado do nó e detalhes do erro de agendamento. Se false, o serviço Batch não aguardará a conclusão da tarefa inicial. Nesse caso, outras tarefas podem começar a ser executadas no nó de computação enquanto a tarefa inicial ainda está em execução; E mesmo que a tarefa Iniciar falhe, novas tarefas continuarão a ser agendadas no nó. O padrão é false. Bool

TaskContainerSettings

Designação Descrição Valor
containerRunOptions Essas opções adicionais são fornecidas como argumentos para o comando "docker create", além daquelas controladas pelo Batch Service. string
nome_da_imagem Esta é a referência de imagem completa, como seria especificado para "docker pull". Se nenhuma tag for fornecida como parte do nome da imagem, a tag ":latest" será usada como padrão. string (obrigatório)
registo Essa configuração pode ser omitida se já tiver sido fornecida na criação do pool. ContainerRegistry

TaskSchedulingPolicy

Designação Descrição Valor
nodeFillType Como as tarefas devem ser distribuídas entre nós de computação. 'Pacote'
'Spread' (obrigatório)

Conta de Utilizador

Designação Descrição Valor
elevaçãoNível nonAdmin - O usuário automático é um usuário padrão sem acesso elevado. admin - O usuário automático é um usuário com acesso elevado e opera com permissões totais de administrador. O valor padrão é nonAdmin. 'Administrador'
'Não administrador'
linuxUserConfiguration Esta propriedade é ignorada se especificada em um pool do Windows. Se não for especificado, o usuário será criado com as opções padrão. LinuxUserConfiguration
Designação O nome da conta de usuário. string (obrigatório)
palavra-passe A senha da conta de usuário. string (obrigatório)
windowsUserConfiguration Essa propriedade só pode ser especificada se o usuário estiver em um pool do Windows. Se não especificado e em um pool do Windows, o usuário é criado com as opções padrão. WindowsUserConfiguration

Identidade do usuário

Designação Descrição Valor
autoUsuário As propriedades userName e autoUser são mutuamente exclusivas; você deve especificar um, mas não ambos. AutoUserSpecification
nome de utilizador As propriedades userName e autoUser são mutuamente exclusivas; você deve especificar um, mas não ambos. string

VirtualMachineConfiguration

Designação Descrição Valor
containerConfiguration Se especificado, a configuração é executada em cada nó do pool para permitir que as tarefas sejam executadas em contêineres. Todas as tarefas regulares e tarefas do gerenciador de tarefas executadas nesse pool devem especificar a propriedade containerSettings e todas as outras tarefas podem especificá-la. ContainerConfiguration
dataDisks Essa propriedade deve ser especificada se os nós de computação no pool precisarem ter discos de dados vazios conectados a eles. DataDisk[]
imageReference Uma referência a uma imagem do Azure Virtual Machines Marketplace ou ao recurso Azure Image de uma Máquina Virtual personalizada. Para obter a lista de todas as imageReferences verificadas pelo Lote do Azure, consulte a operação 'Listar SKUs de agente de nó suportado'. ImageReference (obrigatório)
Tipo de licença Isso só se aplica a imagens que contêm o sistema operacional Windows e só deve ser usado quando você possui licenças locais válidas para os nós que serão implantados. Se omitido, nenhum desconto de licenciamento local será aplicado. Os valores são:

Windows_Server - A licença local é para o Windows Server.
Windows_Client - A licença local é para o Windows Client.		 string
nodeAgentSkuId O agente do nó Batch é um programa executado em cada nó do pool e fornece a interface de comando e controle entre o nó e o serviço Batch. Existem diferentes implementações do agente de nó, conhecido como SKUs, para diferentes sistemas operacionais. Você deve especificar uma SKU do agente de nó que corresponda à referência de imagem selecionada. Para obter a lista de SKUs de agente de nó suportados, juntamente com sua lista de referências de imagem verificadas, consulte a operação 'Listar SKUs de agente de nó suportados'. string (obrigatório)
windowsConfiguração Essa propriedade não deve ser especificada se imageReference especificar uma imagem do sistema operacional Linux. WindowsConfiguration

WindowsConfiguration

Designação Descrição Valor
enableAutomaticUpdates Se omitido, o valor padrão é true. Bool

WindowsUserConfiguration

Designação Descrição Valor
loginMode Especifica o modo de login para o usuário. O valor padrão para pools VirtualMachineConfiguration é o modo interativo e para os pools CloudServiceConfiguration é o modo em lote. 'Lote'
'Interativo'

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
pool de lotes do Azure sem endereços IP públicos

Implantar no Azure 		Este modelo cria o pool de comunicação de nó simplificado do Lote do Azure sem endereços IP públicos.

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso batchAccounts/pools pode ser implantado com operações que visam:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Batch/batchAccounts/pools, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Batch/batchAccounts/pools@2018-12-01"
  name = "string"
  body = jsonencode({
    properties = {
      applicationLicenses = [
        "string"
      ]
      applicationPackages = [
        {
          id = "string"
          version = "string"
        }
      ]
      certificates = [
        {
          id = "string"
          storeLocation = "string"
          storeName = "string"
          visibility = [
            "string"
          ]
        }
      ]
      deploymentConfiguration = {
        cloudServiceConfiguration = {
          osFamily = "string"
          osVersion = "string"
        }
        virtualMachineConfiguration = {
          containerConfiguration = {
            containerImageNames = [
              "string"
            ]
            containerRegistries = [
              {
                password = "string"
                registryServer = "string"
                username = "string"
              }
            ]
            type = "DockerCompatible"
          }
          dataDisks = [
            {
              caching = "string"
              diskSizeGB = int
              lun = int
              storageAccountType = "string"
            }
          ]
          imageReference = {
            id = "string"
            offer = "string"
            publisher = "string"
            sku = "string"
            version = "string"
          }
          licenseType = "string"
          nodeAgentSkuId = "string"
          windowsConfiguration = {
            enableAutomaticUpdates = bool
          }
        }
      }
      displayName = "string"
      interNodeCommunication = "string"
      maxTasksPerNode = int
      metadata = [
        {
          name = "string"
          value = "string"
        }
      ]
      networkConfiguration = {
        endpointConfiguration = {
          inboundNatPools = [
            {
              backendPort = int
              frontendPortRangeEnd = int
              frontendPortRangeStart = int
              name = "string"
              networkSecurityGroupRules = [
                {
                  access = "string"
                  priority = int
                  sourceAddressPrefix = "string"
                }
              ]
              protocol = "string"
            }
          ]
        }
        subnetId = "string"
      }
      scaleSettings = {
        autoScale = {
          evaluationInterval = "string"
          formula = "string"
        }
        fixedScale = {
          nodeDeallocationOption = "string"
          resizeTimeout = "string"
          targetDedicatedNodes = int
          targetLowPriorityNodes = int
        }
      }
      startTask = {
        commandLine = "string"
        containerSettings = {
          containerRunOptions = "string"
          imageName = "string"
          registry = {
            password = "string"
            registryServer = "string"
            username = "string"
          }
        }
        environmentSettings = [
          {
            name = "string"
            value = "string"
          }
        ]
        maxTaskRetryCount = int
        resourceFiles = [
          {
            autoStorageContainerName = "string"
            blobPrefix = "string"
            fileMode = "string"
            filePath = "string"
            httpUrl = "string"
            storageContainerUrl = "string"
          }
        ]
        userIdentity = {
          autoUser = {
            elevationLevel = "string"
            scope = "string"
          }
          userName = "string"
        }
        waitForSuccess = bool
      }
      taskSchedulingPolicy = {
        nodeFillType = "string"
      }
      userAccounts = [
        {
          elevationLevel = "string"
          linuxUserConfiguration = {
            gid = int
            sshPrivateKey = "string"
            uid = int
          }
          name = "string"
          password = "string"
          windowsUserConfiguration = {
            loginMode = "string"
          }
        }
      ]
      vmSize = "string"
    }
  })
}

Valores de propriedade

ApplicationPackageReference

Designação Descrição Valor
ID A ID do pacote de aplicativo a ser instalado. Isso deve estar dentro da mesma conta de lote que o pool. Isso pode ser uma referência a uma versão específica ou a versão padrão, se existir. string (obrigatório)
Versão Se isso for omitido e nenhuma versão padrão for especificada para este aplicativo, a solicitação falhará com o código de erro InvalidApplicationPackageReferences. Se você estiver chamando a API REST diretamente, o código de status HTTP será 409. string

AutoScaleSettings

Designação Descrição Valor
avaliaçãoIntervalo Se omitido, o valor padrão é 15 minutos (PT15M). string
fórmula Uma fórmula para o número desejado de nós de computação no pool. string (obrigatório)

AutoUserSpecification

Designação Descrição Valor
elevaçãoNível nonAdmin - O usuário automático é um usuário padrão sem acesso elevado. admin - O usuário automático é um usuário com acesso elevado e opera com permissões totais de administrador. O valor padrão é nonAdmin. 'Administrador'
'Não administrador'
Âmbito de aplicação O valor padrão é task. 'Piscina'
'Tarefa'

CertificadoReferência

Designação Descrição Valor
ID A ID totalmente qualificada do certificado a ser instalado no pool. Isso deve estar dentro da mesma conta de lote que o pool. string (obrigatório)
storeLocalização O valor padrão é currentUser. Essa propriedade é aplicável somente para pools configurados com nós do Windows (ou seja, criados com cloudServiceConfiguration ou com virtualMachineConfiguration usando uma referência de imagem do Windows). Para nós de computação do Linux, os certificados são armazenados em um diretório dentro do diretório de trabalho da 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 inicial do usuário (por exemplo, /home/{user-name}/certs) e os certificados são colocados nesse diretório. 'CurrentUser'
'LocalMachine'
nome_da_loja Essa propriedade é aplicável somente para pools configurados com nós do Windows (ou seja, criados com cloudServiceConfiguration ou com virtualMachineConfiguration usando uma referência de imagem do Windows). Os nomes de armazenamento comuns incluem: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, mas qualquer nome de loja personalizado também pode ser usado. O valor padrão é My. string
Visibilidade Quais contas de usuário no nó de computação devem ter acesso aos dados privados do certificado. Matriz de cadeia de caracteres contendo qualquer uma das:
'RemoteUser'
'StartTask'
'Tarefa'

CloudServiceConfiguration

Designação Descrição Valor
osFamília Os valores possíveis são: 2 - OS Family 2, equivalente ao Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalente ao Windows Server 2012. 4 - Família OS 4, equivalente ao Windows Server 2012 R2. 5 - Família OS 5, equivalente ao Windows Server 2016. Para obter mais informações, consulte Versões do SO convidado do Azure (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). string (obrigatório)
osVersão O valor padrão é *, que especifica a versão mais recente do sistema operacional para a família de sistemas operacionais especificada. string

ContainerConfiguration

Designação Descrição Valor
containerImageNames Esta é a referência de imagem completa, como seria especificado para "docker pull". Uma imagem será originada do registro padrão do Docker, a menos que a imagem seja totalmente qualificada com um registro alternativo. string[]
contentoresRegistos Se alguma imagem deve ser baixada de um registro privado que requer credenciais, então essas credenciais devem ser fornecidas aqui. ContainerRegistry[]
tipo A tecnologia de contentores a utilizar. 'DockerCompatible' (obrigatório)

ContainerRegistry

Designação Descrição Valor
palavra-passe A palavra-passe para iniciar sessão no servidor de registo. string (obrigatório)
registryServer [en] Se omitido, o padrão é "docker.io". string
nome de utilizador O nome de utilizador para iniciar sessão no servidor de registo. string (obrigatório)

Disco de dados

Designação Descrição Valor
armazenamento em cache Os valores são:

none - O modo de cache para o disco não está ativado.
readOnly - O modo de cache do disco é somente leitura.
readWrite - O modo de cache para o disco é leitura e gravação.

O valor padrão para cache é none. Para obter informações sobre as opções de cache, consulte: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.		 'Nenhuma'
'Somente leitura'
'ReadWrite'
diskSizeGB O tamanho inicial do disco em GB ao criar um novo disco de dados. int (obrigatório)
LUN O lun é usado para identificar exclusivamente cada disco de dados. Se anexar vários discos, cada um deve ter um lun distinto. int (obrigatório)
storageAccountType Se omitido, o padrão é "Standard_LRS". Os valores são:

Standard_LRS - O disco de dados deve usar armazenamento padrão localmente redundante.
Premium_LRS - O disco de dados deve usar armazenamento redundante local premium.		 'Premium_LRS'
'Standard_LRS'

DeploymentConfiguration

Designação Descrição Valor
cloudServiceConfiguration 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 Batch foi criada com sua propriedade poolAllocationMode definida como 'UserSubscription'. CloudServiceConfiguration
virtualMachineConfiguration Esta propriedade e cloudServiceConfiguration são mutuamente exclusivas e uma das propriedades deve ser especificada. VirtualMachineConfiguration

AmbienteConfiguração

Designação Descrição Valor
Designação O nome da variável de ambiente. string (obrigatório)
valor O valor da variável de ambiente. string

FixedScaleSettings

Designação Descrição Valor
nodeDeallocationOption Se omitido, o valor padrão é Requeue. 'Refila de espera'
'Dados retidos'
'Conclusão de tarefas'
'Terminar'
redimensionarTimeout O valor padrão é 15 minutos. Os valores de tempo limite usam o formato ISO 8601. Por exemplo, use PT10M por 10 minutos. O valor mínimo é de 5 minutos. Se você especificar um valor inferior a 5 minutos, o serviço em lote rejeitará a solicitação com um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação incorreta). string
targetDedicatedNodes Pelo menos um dos nós targetDedicatedNodes, targetLowPriority deve ser definido. Int
targetLowPriorityNodes Pelo menos um dos nós targetDedicatedNodes, targetLowPriority deve ser definido. Int

ImageReference

Designação Descrição Valor
ID Esta propriedade é mutuamente exclusiva com outras propriedades. A imagem da máquina virtual deve estar na mesma região e assinatura que a conta do Lote do Azure. Para obter informações sobre as configurações de firewall para o agente do nó em lote se comunicar com o serviço em lote, consulte /azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration . string
oferta Por exemplo, UbuntuServer ou WindowsServer. string
editora Por exemplo, Canonical ou MicrosoftWindowsServer. string
SKU Por exemplo, 14.04.0-LTS ou 2012-R2-Datacenter. string
Versão Um valor de 'mais recente' pode ser especificado para selecionar a versão mais recente de uma imagem. Se omitido, o padrão é 'mais recente'. string

InboundNatPool

Designação Descrição Valor
backendPort Isso deve ser exclusivo dentro de um pool de lotes. Os valores aceitáveis situam-se entre 1 e 65535, exceto para 22, 3389, 29876 e 29877, uma vez que estes são reservados. Se algum valor reservado for fornecido, a solicitação falhará com o código de status HTTP 400. int (obrigatório)
frontendPortRangeEnd Os valores aceitáveis variam entre 1 e 65534, exceto as portas de 50000 a 55000 que são reservadas pelo serviço de lote. Todos os intervalos dentro de um pool devem ser distintos e não podem se sobrepor. Se algum valor reservado ou sobreposto for fornecido, a solicitação falhará com o código de status HTTP 400. int (obrigatório)
frontendPortRangeStart Os valores aceitáveis variam entre 1 e 65534, exceto as portas de 50000 a 55000 que são reservadas. Todos os intervalos dentro de um pool devem ser distintos e não podem se sobrepor. Se algum valor reservado ou sobreposto for fornecido, a solicitação falhará com o código de status HTTP 400. int (obrigatório)
Designação O nome deve ser exclusivo dentro de um pool de lotes, pode conter letras, números, sublinhados, pontos e hífenes. Os nomes devem começar com uma letra ou número, devem terminar com uma letra, número ou sublinhado e não podem exceder 77 caracteres. Se algum valor inválido for fornecido, a solicitação falhará com o código de status HTTP 400. string (obrigatório)
networkSecurityGroupRules O número máximo de regras que podem ser especificadas em todos os pontos de extremidade em um pool de lotes é 25. Se nenhuma regra de grupo de segurança de rede for especificada, uma regra padrão será criada para permitir o acesso de entrada à porta de back-end especificada. Se o número máximo de regras de grupo de segurança de rede for excedido, a solicitação falhará com o código de status HTTP 400. NetworkSecurityGroupRule[]
protocolo O protocolo do ponto de extremidade. 'TCP'
'UDP' (obrigatório)

LinuxUserConfiguration

Designação Descrição Valor
GID As propriedades uid e gid devem ser especificadas juntas ou não devem ser especificadas de todo. Se não for especificado, o sistema operacional subjacente seleciona o gid. Int
sshPrivateKey A chave privada não deve ser protegida por senha. A chave privada é usada para configurar automaticamente a autenticação baseada em chave assimétrica para SSH entre nós em um pool Linux quando a propriedade enableInterNodeCommunication do pool é true (ela é ignorada se enableInterNodeCommunication for false). Ele faz isso colocando o par de chaves no diretório .ssh do usuário. Se não for especificado, o SSH sem senha não será configurado entre nós (nenhuma modificação do diretório .ssh do usuário será feita). string
UID As propriedades uid e gid devem ser especificadas juntas ou não devem ser especificadas de todo. Se não for especificado, o sistema operacional subjacente seleciona o uid. Int

MetadataItem

Designação Descrição Valor
Designação O nome do item de metadados. string (obrigatório)
valor O valor do item de metadados. string (obrigatório)

Microsoft.Batch/batchAccounts/pools

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[a-zA-Z0-9_-]+$ (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID do recurso do tipo: batchAccounts
propriedades As propriedades associadas ao pool. PoolProperties
tipo O tipo de recurso "Microsoft.Batch/batchAccounts/pools@2018-12-01"

Configuração de rede

Designação Descrição Valor
endpointConfiguration A configuração do ponto de extremidade do pool só é suportada em pools com a propriedade virtualMachineConfiguration. PoolEndpointConfiguration
subnetId A rede virtual deve estar na mesma região e assinatura que a conta do Lote do Azure. A sub-rede especificada deve ter endereços IP livres suficientes para acomodar o número de nós no pool. Se a sub-rede não tiver endereços IP livres suficientes, o pool alocará parcialmente os nós de computação e ocorrerá um erro de redimensionamento. A entidade de serviço 'MicrosoftAzureBatch' deve ter a função 'Colaborador de Máquina Virtual Clássica' Role-Based Controle de Acesso (RBAC) para a VNet especificada. A sub-rede especificada deve permitir a comunicação do serviço Lote do Azure para poder agendar tarefas nos nós de computação. Isso pode ser verificado verificando se a rede virtual especificada tem algum NSG (Network Security Groups) associado. Se a comunicação com os nós de computação na sub-rede especificada for negada por um NSG, o serviço em lote definirá o estado dos nós de computação como inutilizável. Para pools criados via virtualMachineConfiguration, a conta Batch deve ter poolAllocationMode userSubscription para usar uma VNet. Se a VNet especificada tiver algum NSG (Network Security Groups) associado, algumas portas de sistema reservadas deverão ser habilitadas para comunicação de entrada. Para pools criados com uma configuração de máquina virtual, habilite as portas 29876 e 29877, bem como a porta 22 para Linux e a porta 3389 para Windows. Para pools criados com uma configuração de serviço de nuvem, habilite as portas 10100, 20100 e 30100. Habilite também as conexões de saída para o Armazenamento do Azure na porta 443. Para obter mais detalhes, consulte: /azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration string

NetworkSecurityGroupRule

Designação Descrição Valor
Acesso A ação que deve ser tomada para um endereço IP, intervalo de sub-rede ou tag especificado. 'Permitir'
'Negar' (obrigatório)
prioridade As prioridades dentro de um pool devem ser únicas e são avaliadas por ordem de prioridade. Quanto menor o número, maior a prioridade. Por exemplo, as regras podem ser especificadas com números de ordem de 150, 250 e 350. A regra com o número de ordem 150 tem precedência sobre a regra que tem uma ordem de 250. As prioridades permitidas são de 150 a 3500. Se algum valor reservado ou duplicado for fornecido, a solicitação falhará com o código de status HTTP 400. int (obrigatório)
sourceAddressPrefix Os valores válidos são um único endereço IP (ou seja, 10.10.10.10), sub-rede IP (ou seja, 192.168.1.0/24), tag padrão ou * (para todos os endereços). Se quaisquer outros valores forem fornecidos, a solicitação falhará com o código de status HTTP 400. string (obrigatório)

PoolEndpointConfiguration

Designação Descrição Valor
inboundNatPools O número máximo de pools de NAT de entrada por pool de lotes é 5. Se o número máximo de pools NAT de entrada for excedido, a solicitação falhará com o código de status HTTP 400. InboundNatPool[] (obrigatório)

PoolProperties

Designação Descrição Valor
applicationLicenses 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á. string[]
applicationPackages As alterações nos pacotes de aplicativos afetam todos os novos nós de computação 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. ApplicationPackageReference []
Certificados Para nós de computação do Windows, o serviço Batch instala os certificados no armazenamento de certificados e no local especificados. Para nós de computação do Linux, os certificados são armazenados em um diretório dentro do diretório de trabalho da 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 inicial do usuário (por exemplo, /home/{user-name}/certs) e os certificados são colocados nesse diretório. CertificateReference[]
deploymentConfiguration Usar CloudServiceConfiguration especifica que os nós devem ser criados usando os Serviços de Nuvem do Azure (PaaS), enquanto VirtualMachineConfiguration usa Máquinas Virtuais do Azure (IaaS). DeploymentConfiguration
displayName O nome para exibição não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024. string
interNodeCommunication Isso impõe restrições sobre quais nós podem ser atribuídos ao pool. Habilitar esse valor pode reduzir a chance de o número solicitado de nós ser alocado no pool. Se não for especificado, o padrão desse valor será 'Desativado'. 'Desativado'
'Habilitado'
maxTasksPerNode O número máximo de tarefas que podem ser executadas simultaneamente em um único nó de computação no pool. Int
metadados O serviço Batch não atribui qualquer significado aos metadados; é exclusivamente para o uso do código de usuário. MetadataItem []
networkConfiguration A configuração de rede para um pool. NetworkConfiguration
scaleSettings Define o tamanho desejado do pool. Isso pode ser 'fixedScale', onde o targetDedicatedNodes solicitado é especificado, ou 'autoScale', que define uma fórmula que é reavaliada periodicamente. Se essa propriedade não for especificada, o pool terá uma escala fixa com 0 targetDedicatedNodes. ScaleSettings
startTask Em uma operação PATCH (atualização), essa propriedade pode ser definida como um objeto vazio para remover a tarefa inicial do pool. StartTask
taskSchedulingPolicy Especifica como as tarefas devem ser distribuídas entre nós de computação. TaskSchedulingPolicy
userContas A lista de contas de usuário a serem criadas em cada nó do pool. Conta de Utilizador[]
vmTamanho Para obter informações sobre tamanhos disponíveis de máquinas virtuais para pools de Serviços de Nuvem (pools criados com cloudServiceConfiguration), consulte Tamanhos para Serviços de Nuvem (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). O Batch suporta todos os tamanhos de VM dos Serviços de Nuvem, exceto o ExtraSmall. Para obter informações sobre tamanhos de VM disponíveis para pools usando imagens do Virtual Machines Marketplace (pools criados com virtualMachineConfiguration), consulte Tamanhos para máquinas virtuais (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) ou Tamanhos para máquinas virtuais (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). O Batch dá suporte a todos os tamanhos de VM do Azure, exceto STANDARD_A0 e aqueles com armazenamento premium (STANDARD_GS, STANDARD_DS e STANDARD_DSV2 séries). string

Ficheiro de Recursos

Designação Descrição Valor
autoStorageContainerName As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. string
blobPrefix A propriedade é válida somente quando autoStorageContainerName ou storageContainerUrl é usado. Esse prefixo pode ser um nome de arquivo parcial ou um subdiretório. Se um prefixo não for especificado, todos os arquivos no contêiner serão baixados. string
fileMode Esta propriedade aplica-se apenas a arquivos que estão sendo baixados para nós de computação do Linux. Ele será ignorado se for especificado para um resourceFile que será baixado para um nó do Windows. Se essa propriedade não for especificada para um nó Linux, um valor padrão de 0770 será aplicado ao arquivo. string
filePath Se a propriedade httpUrl for especificada, o filePath será necessário e descreverá o caminho para o qual o arquivo será baixado, incluindo o nome do arquivo. Caso contrário, se a propriedade autoStorageContainerName ou storageContainerUrl for especificada, filePath será opcional e será o diretório para o qual os arquivos serão baixados. No caso em que filePath é usado como um diretório, qualquer estrutura de diretório já associada aos dados de entrada será mantida na íntegra e anexada ao diretório filePath especificado. O caminho relativo especificado não pode sair do diretório de trabalho da tarefa (por exemplo, usando '..'). string
httpUrl As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Se a URL for Armazenamento de Blob do Azure, ela deverá ser legível usando acesso anônimo; ou seja, o serviço Batch não apresenta nenhuma credencial ao baixar o blob. Há duas maneiras de obter essa URL para um blob no armazenamento do Azure: incluir uma SAS (Assinatura de Acesso Compartilhado) concedendo permissões de leitura no blob ou definir a ACL para o blob ou seu contêiner para permitir acesso público. string
storageContainerUrl As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Este URL deve ser legível e listável usando acesso anônimo; ou seja, o serviço Batch não apresenta nenhuma credencial ao baixar o blob. Há duas maneiras de obter essa URL para um blob no armazenamento do Azure: incluir uma Assinatura de Acesso Compartilhado (SAS) concedendo permissões de leitura e lista no blob ou definir a ACL para o blob ou seu contêiner para permitir acesso público. string

Configurações de escala

Designação Descrição Valor
autoDimensionamento Esta propriedade e fixedScale são mutuamente exclusivas e uma das propriedades deve ser especificada. AutoScaleSettings
escala fixa Esta propriedade e autoScale são mutuamente exclusivas e uma das propriedades deve ser especificada. FixedScaleSettings

IniciarTarefa

Designação Descrição Valor
linha de comando A linha de comando não é executada sob um shell e, portanto, não pode aproveitar os recursos do shell, como a expansão da variável de ambiente. Se você quiser aproveitar esses recursos, você deve invocar o shell na linha de comando, por exemplo, usando "cmd /c MyCommand" no Windows ou "/bin/sh -c MyCommand" no Linux. Obrigatório se quaisquer outras propriedades do startTask forem especificadas. string
containerSettings Quando isso é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios do Lote do Azure no nó) são mapeados no contêiner, todas as variáveis de ambiente de tarefa são mapeadas no contêiner e a linha de comando da tarefa é executada no contêiner. TaskContainerSettings
ambienteConfigurações Uma lista de configurações de variáveis de ambiente para a tarefa iniciar. EnvironmentSetting[]
maxTaskRetryCount O serviço de lote tenta novamente uma tarefa se seu código de saída for diferente de zero. Observe que esse valor controla especificamente o número de tentativas. O serviço de lote tentará a tarefa uma vez e, em seguida, poderá tentar novamente até esse limite. Por exemplo, se a contagem máxima de tentativas for 3, o Batch tentará a tarefa até 4 vezes (uma tentativa inicial e 3 tentativas). Se a contagem máxima de tentativas for 0, o serviço Batch não repetirá a tarefa. Se a contagem máxima de tentativas for -1, o serviço em lote repetirá a tarefa sem limite. Int
resourceFiles Uma lista de arquivos que o serviço Batch baixará para o nó de computação antes de executar a linha de comando. ResourceFile []
userIdentity Se omitida, a tarefa é executada como um usuário não administrativo exclusivo para a tarefa. UserIdentity
waitForSuccess Se true e a tarefa inicial falhar em um nó de computação, o serviço Batch tentará novamente a tarefa inicial até sua contagem máxima de tentativas (maxTaskRetryCount). Se a tarefa ainda não tiver sido concluída com êxito após todas as tentativas, o serviço em lote marcará o nó de computação como inutilizável e não agendará tarefas para ele. Esta condição pode ser detetada através do estado do nó e detalhes do erro de agendamento. Se false, o serviço Batch não aguardará a conclusão da tarefa inicial. Nesse caso, outras tarefas podem começar a ser executadas no nó de computação enquanto a tarefa inicial ainda está em execução; E mesmo que a tarefa Iniciar falhe, novas tarefas continuarão a ser agendadas no nó. O padrão é false. Bool

TaskContainerSettings

Designação Descrição Valor
containerRunOptions Essas opções adicionais são fornecidas como argumentos para o comando "docker create", além daquelas controladas pelo Batch Service. string
nome_da_imagem Esta é a referência de imagem completa, como seria especificado para "docker pull". Se nenhuma tag for fornecida como parte do nome da imagem, a tag ":latest" será usada como padrão. string (obrigatório)
registo Essa configuração pode ser omitida se já tiver sido fornecida na criação do pool. ContainerRegistry

TaskSchedulingPolicy

Designação Descrição Valor
nodeFillType Como as tarefas devem ser distribuídas entre nós de computação. 'Pacote'
'Spread' (obrigatório)

Conta de Utilizador

Designação Descrição Valor
elevaçãoNível nonAdmin - O usuário automático é um usuário padrão sem acesso elevado. admin - O usuário automático é um usuário com acesso elevado e opera com permissões totais de administrador. O valor padrão é nonAdmin. 'Administrador'
'Não administrador'
linuxUserConfiguration Esta propriedade é ignorada se especificada em um pool do Windows. Se não for especificado, o usuário será criado com as opções padrão. LinuxUserConfiguration
Designação O nome da conta de usuário. string (obrigatório)
palavra-passe A senha da conta de usuário. string (obrigatório)
windowsUserConfiguration Essa propriedade só pode ser especificada se o usuário estiver em um pool do Windows. Se não especificado e em um pool do Windows, o usuário é criado com as opções padrão. WindowsUserConfiguration

Identidade do usuário

Designação Descrição Valor
autoUsuário As propriedades userName e autoUser são mutuamente exclusivas; você deve especificar um, mas não ambos. AutoUserSpecification
nome de utilizador As propriedades userName e autoUser são mutuamente exclusivas; você deve especificar um, mas não ambos. string

VirtualMachineConfiguration

Designação Descrição Valor
containerConfiguration Se especificado, a configuração é executada em cada nó do pool para permitir que as tarefas sejam executadas em contêineres. Todas as tarefas regulares e tarefas do gerenciador de tarefas executadas nesse pool devem especificar a propriedade containerSettings e todas as outras tarefas podem especificá-la. ContainerConfiguration
dataDisks Essa propriedade deve ser especificada se os nós de computação no pool precisarem ter discos de dados vazios conectados a eles. DataDisk[]
imageReference Uma referência a uma imagem do Azure Virtual Machines Marketplace ou ao recurso Azure Image de uma Máquina Virtual personalizada. Para obter a lista de todas as imageReferences verificadas pelo Lote do Azure, consulte a operação 'Listar SKUs de agente de nó suportado'. ImageReference (obrigatório)
Tipo de licença Isso só se aplica a imagens que contêm o sistema operacional Windows e só deve ser usado quando você possui licenças locais válidas para os nós que serão implantados. Se omitido, nenhum desconto de licenciamento local será aplicado. Os valores são:

Windows_Server - A licença local é para o Windows Server.
Windows_Client - A licença local é para o Windows Client.		 string
nodeAgentSkuId O agente do nó Batch é um programa executado em cada nó do pool e fornece a interface de comando e controle entre o nó e o serviço Batch. Existem diferentes implementações do agente de nó, conhecido como SKUs, para diferentes sistemas operacionais. Você deve especificar uma SKU do agente de nó que corresponda à referência de imagem selecionada. Para obter a lista de SKUs de agente de nó suportados, juntamente com sua lista de referências de imagem verificadas, consulte a operação 'Listar SKUs de agente de nó suportados'. string (obrigatório)
windowsConfiguração Essa propriedade não deve ser especificada se imageReference especificar uma imagem do sistema operacional Linux. WindowsConfiguration

WindowsConfiguration

Designação Descrição Valor
enableAutomaticUpdates Se omitido, o valor padrão é true. Bool

WindowsUserConfiguration

Designação Descrição Valor
loginMode Especifica o modo de login para o usuário. O valor padrão para pools VirtualMachineConfiguration é o modo interativo e para os pools CloudServiceConfiguration é o modo em lote. 'Lote'
'Interativo'