Pool - Add

Adiciona um pool à conta especificada.
Ao nomear Pools, evite incluir informações confidenciais, como nomes de usuário ou nomes de projeto secretos. Essas informações podem aparecer em logs de telemetria acessíveis aos engenheiros de suporte da Microsoft.

POST {batchUrl}/pools?api-version=2024-07-01.20.0
POST {batchUrl}/pools?timeout={timeout}&api-version=2024-07-01.20.0

Parâmetros de URI

Nome Em Obrigatório Tipo Description
batchUrl
path True

string

A URL base para todas as solicitações de serviço do Lote do Azure.

api-version
query True

string

Versão da API do cliente.

timeout
query

integer

int32

O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. Se o valor for maior que 30, o padrão será usado.

Cabeçalho da solicitação

Media Types: "application/json; odata=minimalmetadata"

Nome Obrigatório Tipo Description
client-request-id

string

uuid

A identidade da solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Se o servidor deve retornar a ID de solicitação do cliente na resposta.

ocp-date

string

date-time-rfc1123

A hora em que a solicitação foi emitida. As bibliotecas de cliente normalmente definem isso como a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Corpo da solicitação

Media Types: "application/json; odata=minimalmetadata"

Nome Obrigatório Tipo Description
id True

string

Uma cadeia de caracteres que identifica exclusivamente o pool na Conta.
A ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hifens e sublinhados, e não pode conter mais de 64 caracteres. A ID não diferencia maiúsculas de minúsculas e maiúsculas de minúsculas (ou seja, você pode não ter duas IDs de pool em uma conta que diferem apenas por caso).

vmSize True

string

O tamanho das máquinas virtuais no Pool. Todas as máquinas virtuais em um Pool têm o mesmo tamanho.
Para obter informações sobre tamanhos de VM disponíveis, 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 Lote dá suporte a todos os tamanhos de VM do Azure, exceto STANDARD_A0 e aqueles com armazenamento premium (séries STANDARD_GS, STANDARD_DS e STANDARD_DSV2).

applicationPackageReferences

ApplicationPackageReference[]

A lista de pacotes a serem instalados em cada Nó de Computação no Pool.
Ao criar um pool, a ID do aplicativo do pacote deve ser totalmente qualificada (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). As alterações nas referências de pacote afetam todos os novos nós que ingressam no Pool, mas não afetam nós de computação que já estão no Pool até que sejam reinicializados ou reimageados. Há um máximo de 10 referências de pacote em um determinado pool.

autoScaleEvaluationInterval

string

O intervalo de tempo no qual ajustar automaticamente o tamanho do Pool de acordo com a fórmula de dimensionamento automático.
O valor padrão é 15 minutos. O valor mínimo e máximo é de 5 minutos e 168 horas, respectivamente. Se você especificar um valor menor que 5 minutos ou maior que 168 horas, o serviço do Lote retornará um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação Incorreta).

autoScaleFormula

string

Uma fórmula para o número desejado de Nós de Computação no Pool.
Essa propriedade não deverá ser especificada se enableAutoScale for definido como false. Ele será necessário se enableAutoScale estiver definido como true. A fórmula é verificada quanto à validade antes da criação do Pool. Se a fórmula não for válida, o serviço do Lote rejeitará a solicitação com informações detalhadas de erro. Para obter mais informações sobre como especificar essa fórmula, consulte "Dimensionar automaticamente nós de computação em um pool de lote do Azure" (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).

certificateReferences

CertificateReference[]

A lista de certificados a serem instalados em cada Nó de Computação no Pool.
Para nós do Windows, o serviço Lote instala os Certificados no repositório e local de certificados 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 base do usuário (por exemplo, /home/{user-name}/certs) e certificados são colocados nesse diretório.

Aviso: essa propriedade foi preterida e será removida após fevereiro de 2024. Em vez disso, use o de Extensão do Azure KeyVault .

displayName

string

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

enableAutoScale

boolean

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

enableInterNodeCommunication

boolean

Se o Pool permite comunicação direta entre nós de computação.
Habilitar a comunicação entre nós limita o tamanho máximo do pool devido a restrições de implantação nos nós de computação do pool. Isso pode fazer com que o Pool não atinja o tamanho desejado. O valor padrão é false.

metadata

MetadataItem[]

Uma lista de pares nome-valor associados ao Pool como metadados.
O serviço do Lote não atribui nenhum significado aos metadados; é apenas para o uso do código do usuário.

mountConfiguration

MountConfiguration[]

Monte o armazenamento usando o sistema de arquivos especificado durante todo o tempo de vida do pool.
Monte o armazenamento usando o compartilhamento de arquivos do Azure, NFS, CIFS ou sistema de arquivos baseado em Blobfuse.

networkConfiguration

NetworkConfiguration

A configuração de rede do Pool.
A configuração de rede de um pool.

resizeTimeout

string

O tempo limite para alocação de nós de computação para o pool.
Esse tempo limite se aplica apenas ao dimensionamento manual; ele não tem efeito quando enableAutoScale é definido como true. O valor padrão é 15 minutos. O valor mínimo é 5 minutos. Se você especificar um valor menor que 5 minutos, o serviço do Lote retornará um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação Incorreta).

resourceTags

object

As marcas especificadas pelo usuário associadas ao pool.
As marcas definidas pelo usuário a serem associadas ao Pool de Lotes do Azure. Quando especificadas, essas marcas são propagadas para os recursos do Azure de suporte associados ao pool. Essa propriedade só pode ser especificada quando a conta do Lote foi criada com a propriedade poolAllocationMode definida como 'UserSubscription'.

startTask

StartTask

Uma tarefa especificada para ser executada em cada Nó de Computação à medida que ele ingressa no pool.
A Tarefa é executada quando o Nó de Computação é adicionado ao Pool ou quando o Nó de Computação é reiniciado.

targetDedicatedNodes

integer

O número desejado de nós de computação dedicados no pool.
Essa propriedade não deve ser especificada se enableAutoScale estiver definido como true. Se enableAutoScale for definido como false, você deverá definir targetDedicatedNodes, targetLowPriorityNodes ou ambos.

targetLowPriorityNodes

integer

O número desejado de nós de computação spot/de baixa prioridade no pool.
Essa propriedade não deve ser especificada se enableAutoScale estiver definido como true. Se enableAutoScale for definido como false, você deverá definir targetDedicatedNodes, targetLowPriorityNodes ou ambos.

targetNodeCommunicationMode

NodeCommunicationMode

O modo de comunicação de nó desejado para o pool.
Se omitido, o valor padrão será Default.

taskSchedulingPolicy

TaskSchedulingPolicy

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

taskSlotsPerNode

integer

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

upgradePolicy

UpgradePolicy

A política de atualização do Pool.
Descreve uma política de atualização – automática, manual ou sem interrupção.

userAccounts

UserAccount[]

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

virtualMachineConfiguration

VirtualMachineConfiguration

A configuração da máquina virtual para o Pool.
Essa propriedade deve ser especificada.

Respostas

Nome Tipo Description
201 Created

A solicitação para o serviço do Lote foi bem-sucedida.

Cabeçalhos

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

O erro do serviço do Lote.

Segurança

azure_auth

Fluxo de código de autenticação do Microsoft Entra OAuth 2.0

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation Representar sua conta de usuário

Authorization

Tipo: apiKey
Em: header

Exemplos

Add a pool with accelerated networking
Add a pool with mount drive specified
Add a pool with SecurityProfile
Add a pool with UpgradePolicy
Add a simple pool with resourceTags
Add a VirtualMachineConfiguration pool
Add a VirtualMachineConfiguration pool with containers
Add a VirtualMachineConfiguration pool with extensions
Add a VirtualMachineConfiguration pool with OS disk
Add a VirtualMachineConfiguration pool with ServiceArtifactReference

Add a pool with accelerated networking

Solicitação de exemplo

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "mypool01",
  "vmSize": "Standard_D1_v2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2016-datacenter-smalldisk",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 2,
  "networkConfiguration": {
    "enableAcceleratedNetworking": true
  }
}

Resposta de exemplo

Add a pool with mount drive specified

Solicitação de exemplo

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0


{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "20_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "mountConfiguration": [
    {
      "azureBlobFileSystemConfiguration": {
        "accountName": "accountName",
        "containerName": "blobContainerName",
        "accountKey": "accountKey",
        "relativeMountPath": "bfusepath"
      }
    },
    {
      "azureFileShareConfiguration": {
        "accountName": "accountName",
        "azureFileUrl": "https://myaccount.file.core.windows.net/fileshare",
        "accountKey": "accountKey",
        "relativeMountPath": "filesharepath",
        "mountOptions": "mount options ver=1.0"
      }
    },
    {
      "nfsMountConfiguration": {
        "source": "somesource nfs url",
        "relativeMountPath": "mountpath",
        "mountOptions": "mount options ver=1.0"
      }
    },
    {
      "cifsMountConfiguration": {
        "username": "accountName",
        "password": "password",
        "source": "//myaccount.file.core.windows.net/file",
        "relativeMountPath": "mountpath",
        "mountOptions": "mount options ver=1.0"
      }
    }
  ],
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false
}

Resposta de exemplo

Add a pool with SecurityProfile

Solicitação de exemplo

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "mypool001",
  "vmSize": "STANDARD_DC2s_V2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "18_04-lts-gen2",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 18.04",
    "securityProfile": {
      "securityType": "trustedLaunch",
      "encryptionAtHost": true,
      "uefiSettings": {
        "secureBootEnabled": false,
        "vTpmEnabled": null
      }
    }
  },
  "targetDedicatedNodes": 1
}

Resposta de exemplo

Add a pool with UpgradePolicy

Solicitação de exemplo

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "mypool001",
  "vmSize": "Standard_A1_v2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2016-datacenter-smalldisk",
      "version": "latest"
    },
    "windowsConfiguration": {
      "enableAutomaticUpdates": false
    },
    "nodePlacementConfiguration": {
      "policy": "zonal"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 2,
  "upgradePolicy": {
    "mode": "automatic",
    "automaticOSUpgradePolicy": {
      "disableAutomaticRollback": true,
      "enableAutomaticOSUpgrade": true,
      "useRollingUpgradePolicy": true,
      "osRollingUpgradeDeferral": true
    },
    "rollingUpgradePolicy": {
      "enableCrossZoneUpgrade": true,
      "maxBatchInstancePercent": 20,
      "maxUnhealthyInstancePercent": 20,
      "maxUnhealthyUpgradedInstancePercent": 20,
      "pauseTimeBetweenBatches": "PT0S",
      "prioritizeUnhealthyInstances": false,
      "rollbackFailedInstancesOnPolicyBreach": false
    }
  }
}

Resposta de exemplo

Add a simple pool with resourceTags

Solicitação de exemplo

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "mypool001",
  "vmSize": "STANDARD_DC2s_V2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "18_04-lts-gen2",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 18.04"
  },
  "targetDedicatedNodes": 1,
  "resourceTags": {
    "TagName1": "TagValue1",
    "TagName2": "TagValue2"
  }
}

Resposta de exemplo

Add a VirtualMachineConfiguration pool

Solicitação de exemplo

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Resposta de exemplo

Add a VirtualMachineConfiguration pool with containers

Solicitação de exemplo

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "120_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04",
    "containerConfiguration": {
      "type": "dockerCompatible",
      "containerImageNames": [
        "busybox"
      ]
    }
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false
}

Resposta de exemplo

Add a VirtualMachineConfiguration pool with extensions

Solicitação de exemplo

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04",
    "extensions": [
      {
        "name": "batchextension1",
        "type": "KeyVaultForLinux",
        "publisher": "Microsoft.Azure.KeyVault",
        "typeHandlerVersion": "2.0",
        "autoUpgradeMinorVersion": true,
        "enableAutomaticUpgrade": true,
        "settings": "{\"secretsManagementSettingsKey\":\"secretsManagementSettingsValue\",\"authenticationSettingsKey\":\"authenticationSettingsValue\"}"
      }
    ]
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ],
  "targetNodeCommunicationMode": "simplified"
}

Resposta de exemplo

Add a VirtualMachineConfiguration pool with OS disk

Solicitação de exemplo

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "mypool001",
  "vmSize": "standard_d2s_v3",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts"
    },
    "osDisk": {
      "diskSizeGB": 100,
      "managedDisk": {
        "storageAccountType": "standardssd_lrs"
      },
      "caching": "readwrite",
      "ephemeralOSDiskSettings": {
        "placement": "CacheDisk"
      }
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 1,
  "enableAutoScale": false
}

Resposta de exemplo

Add a VirtualMachineConfiguration pool with ServiceArtifactReference

Solicitação de exemplo

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "mypool002",
  "vmSize": "Standard_A1_v2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2016-datacenter-smalldisk",
      "version": "latest"
    },
    "windowsConfiguration": {
      "enableAutomaticUpdates": false
    },
    "serviceArtifactReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 2,
  "upgradePolicy": {
    "mode": "automatic",
    "automaticOSUpgradePolicy": {
      "enableAutomaticOSUpgrade": true
    }
  }
}

Resposta de exemplo

Definições

Nome Description
ApplicationPackageReference

Uma referência a um pacote a ser implantado em Nós de Computação.

AutomaticOSUpgradePolicy

Os parâmetros de configuração usados para executar a atualização automática do sistema operacional.

AutoUserScope

O escopo do usuário automático

AutoUserSpecification

Especifica os parâmetros para o usuário automático que executa uma Tarefa no serviço do Lote.

AzureBlobFileSystemConfiguration

Informações usadas para se conectar a um Contêiner de Armazenamento do Azure usando Blobfuse.

AzureFileShareConfiguration

Informações usadas para se conectar a um compartilhamento de arquivos do Azure.

BatchError

Uma resposta de erro recebida do serviço do Lote do Azure.

BatchErrorDetail

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.

CachingType

O tipo de cache a ser habilitado para o disco.

CertificateReference

Uma referência a um certificado a ser instalado em nós de computação em um pool.

CertificateStoreLocation

O local do repositório de certificados no Nó de Computação no qual instalar o Certificado.

CertificateVisibility

Quais contas de usuário no Nó de Computação devem ter acesso aos dados privados do Certificado.

CIFSMountConfiguration

Informações usadas para se conectar a um sistema de arquivos CIFS.

ComputeNodeFillType

Como as tarefas são distribuídas entre nós de computação em um pool.

ComputeNodeIdentityReference

A referência a uma identidade atribuída pelo usuário associada ao pool do Lote que um nó de computação usará.

ContainerConfiguration

A configuração para pools habilitados para contêineres.

ContainerHostBatchBindMountEntry

A entrada do caminho e do modo de montagem que você deseja montar no contêiner de tarefas.

ContainerHostDataPath

Os caminhos que serão montados no contêiner da tarefa de contêiner.

ContainerRegistry

Um registro de contêiner privado.

ContainerType

A tecnologia de contêiner a ser usada.

ContainerWorkingDirectory

O local do diretório de trabalho da Tarefa de contêiner.

DataDisk

Configurações que serão usadas pelos discos de dados associados aos Nós de Computação no Pool. Ao usar discos de dados anexados, você precisa montar e formatar os discos de dentro de uma VM para usá-los.

DiffDiskPlacement

Especifica o posicionamento de disco efêmero para o disco do sistema operacional para todos os nós de computação (VMs) no pool.

DiffDiskSettings

Especifica as Configurações de Disco efêmero para o disco do sistema operacional usado pela VM (nó de computação).

DiskEncryptionConfiguration

A configuração de criptografia de disco aplicada em nós de computação no pool. Não há suporte para a configuração de criptografia de disco no pool do Linux criado com a Imagem da Galeria de Computação do Azure.

DiskEncryptionTarget

A lista de destinos de disco do Serviço de Lote será criptografada no nó de computação.

DynamicVNetAssignmentScope

O escopo da atribuição de vnet dinâmica.

ElevationLevel

O nível de elevação do usuário.

EnvironmentSetting

Uma variável de ambiente a ser definida em um processo de tarefa.

ErrorMessage

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.

ImageReference

Uma referência a uma imagem do Marketplace de Máquinas Virtuais do Azure ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de imagem do Azure Marketplace verificadas pelo Lote do Azure, consulte a operação 'Listar Imagens Com Suporte'.

InboundEndpointProtocol

O protocolo do ponto de extremidade.

InboundNATPool

Um pool nat de entrada que pode ser usado para abordar portas específicas em nós de computação em um pool de lote externamente.

IPAddressProvisioningType

O tipo de provisionamento para endereços IP públicos para o pool.

LinuxUserConfiguration

Propriedades usadas para criar uma conta de usuário em um Nó de Computação do Linux.

LoginMode

O modo de logon do usuário

ManagedDisk
MetadataItem

Um par nome-valor associado a um recurso de serviço do Lote.

MountConfiguration

O sistema de arquivos a ser montado em cada nó.

NetworkConfiguration

A configuração de rede de um pool.

NetworkSecurityGroupRule

Uma regra de grupo de segurança de rede a ser aplicada a um ponto de extremidade de entrada.

NetworkSecurityGroupRuleAccess

A ação que deve ser tomada para um endereço IP especificado, intervalo de sub-rede ou marca.

NFSMountConfiguration

Informações usadas para se conectar a um sistema de arquivos NFS.

NodeCommunicationMode

Determina como um pool se comunica com o serviço do Lote.

NodePlacementConfiguration

Configuração de posicionamento do nó para um pool.

NodePlacementPolicyType

A política de posicionamento para alocar nós no pool.

OSDisk

Configurações do disco do sistema operacional do nó de computação (VM).

PoolAddParameter

Um pool no serviço lote do Azure a ser adicionado.

PoolEndpointConfiguration

A configuração do ponto de extremidade para um pool.

PublicIPAddressConfiguration

A configuração de endereço IP público da configuração de rede de um pool.

ResourceFile

Um único arquivo ou vários arquivos a serem baixados em um Nó de Computação.

RollingUpgradePolicy

Os parâmetros de configuração usados durante a execução de uma atualização sem interrupção.

SecurityEncryptionTypes

Especifica o EncryptionType do disco gerenciado. Ele é definido como VMGuestStateOnly para criptografia apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado de firmware no blob VMGuestState. Observação: ele pode ser definido apenas para VMs confidenciais e é necessário ao usar VMs confidenciais.

SecurityProfile

Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais.

SecurityTypes

Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings.

ServiceArtifactReference

Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de dimensionamento ao usar a versão de imagem 'mais recente'.

StartTask

Uma tarefa que é executada quando um nó ingressa em um pool no serviço do Lote do Azure ou quando o Nó de Computação é reinicializado ou reimageado.

StorageAccountType

O tipo de conta de armazenamento para uso na criação de discos de dados ou disco do sistema operacional.

TaskContainerSettings

As configurações de contêiner de uma Tarefa.

TaskSchedulingPolicy

Especifica como as tarefas devem ser distribuídas entre nós de computação.

UefiSettings

Especifica as configurações de segurança, como inicialização segura e vTPM usadas durante a criação da máquina virtual.

UpgradeMode

Especifica o modo de uma atualização para máquinas virtuais no conjunto de dimensionamento.

Os valores possíveis são:

Manual – você controla a aplicação de atualizações para máquinas virtuais no conjunto de dimensionamento. Faça isso usando a ação manualUpgrade.

automático – todas as máquinas virtuais no conjunto de dimensionamento são atualizadas automaticamente ao mesmo tempo.

Rolling – O conjunto de dimensionamento executa atualizações em lotes com um tempo de pausa opcional no meio.

UpgradePolicy

Descreve uma política de atualização – automática, manual ou sem interrupção.

UserAccount

Propriedades usadas para criar um usuário usado para executar Tarefas em um Nó de Computação em Lote do Azure.

UserIdentity

A definição da identidade do usuário na qual a Tarefa é executada.

VirtualMachineConfiguration

A configuração para nós de computação em um pool com base na infraestrutura de Máquinas Virtuais do Azure.

VMDiskSecurityProfile

Especifica as configurações de perfil de segurança para o disco gerenciado. Observação: ele só pode ser definido para VMs confidenciais e necessário ao usar VMs confidenciais.

VMExtension

A configuração para extensões de máquina virtual.

WindowsConfiguration

Configurações do sistema operacional Windows a serem aplicadas à máquina virtual.

WindowsUserConfiguration

Propriedades usadas para criar uma conta de usuário em um Nó de Computação do Windows.

ApplicationPackageReference

Uma referência a um pacote a ser implantado em Nós de Computação.

Nome Tipo Description
applicationId

string

A ID do aplicativo a ser implantado.
Ao criar um pool, a ID do aplicativo do pacote deve ser totalmente qualificada (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).

version

string

A versão do aplicativo a ser implantado. Se omitida, a versão padrão será implantada.
Se isso for omitido em um Pool e nenhuma versão padrão for especificada para este aplicativo, a solicitação falhará com o código de erro InvalidApplicationPackageReferences e o código de status HTTP 409. Se isso for omitido em uma Tarefa e nenhuma versão padrão for especificada para este aplicativo, a Tarefa falhará com um erro de pré-processamento.

AutomaticOSUpgradePolicy

Os parâmetros de configuração usados para executar a atualização automática do sistema operacional.

Nome Tipo Description
disableAutomaticRollback

boolean

Se o recurso de reversão de imagem do sistema operacional deve ser desabilitado.

enableAutomaticOSUpgrade

boolean

Indica se as atualizações do sistema operacional devem ser aplicadas automaticamente às instâncias do conjunto de dimensionamento de forma sem interrupção quando uma versão mais recente da imagem do sistema operacional estiver disponível.

Se isso for definido como true para pools baseados no Windows, WindowsConfiguration.enableAutomaticUpdates não poderá ser definido como true.

osRollingUpgradeDeferral

boolean

Adie as atualizações do sistema operacional nos TVMs se elas estiverem executando tarefas.

useRollingUpgradePolicy

boolean

Indica se a política de atualização sem interrupção deve ser usada durante a Atualização automática do sistema operacional. A atualização automática do sistema operacional fará fallback para a política padrão se nenhuma política for definida no VMSS.

AutoUserScope

O escopo do usuário automático

Nome Tipo Description
pool

string

Especifica que a Tarefa é executada como a conta de usuário automático comum que é criada em cada nó de computação em um pool.

task

string

Especifica que o serviço deve criar um novo usuário para a Tarefa.

AutoUserSpecification

Especifica os parâmetros para o usuário automático que executa uma Tarefa no serviço do Lote.

Nome Tipo Description
elevationLevel

ElevationLevel

O nível de elevação do usuário automático.
O valor padrão é nonAdmin.

scope

AutoUserScope

O escopo do usuário automático
O valor padrão é pool. Se o pool estiver executando o Windows, um valor de Tarefa deverá ser especificado se for necessário um isolamento mais rigoroso entre as tarefas. Por exemplo, se a tarefa alterar o registro de uma maneira que possa afetar outras tarefas ou se os certificados tiverem sido especificados no pool, que não devem ser acessíveis por tarefas normais, mas devem ser acessíveis pelo StartTasks.

AzureBlobFileSystemConfiguration

Informações usadas para se conectar a um Contêiner de Armazenamento do Azure usando Blobfuse.

Nome Tipo Description
accountKey

string

A chave da Conta de Armazenamento do Azure.
Essa propriedade é mutuamente exclusiva com sasKey e identidade; exatamente um deve ser especificado.

accountName

string

O nome da Conta de Armazenamento do Azure.

blobfuseOptions

string

Opções de linha de comando adicionais para passar para o comando de montagem.
Estas são opções de "uso líquido" no Windows e opções de "montagem" no Linux.

containerName

string

O nome do Contêiner de Armazenamento de Blobs do Azure.

identityReference

ComputeNodeIdentityReference

A referência à identidade atribuída pelo usuário a ser usada para acessar containerName
Essa propriedade é mutuamente exclusiva com accountKey e sasKey; exatamente um deve ser especificado.

relativeMountPath

string

O caminho relativo no nó de computação em que o sistema de arquivos será montado
Todos os sistemas de arquivos são montados em relação ao diretório de montagens do Lote, acessível por meio da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.

sasKey

string

O token SAS do Armazenamento do Azure.
Essa propriedade é mutuamente exclusiva com accountKey e identidade; exatamente um deve ser especificado.

AzureFileShareConfiguration

Informações usadas para se conectar a um compartilhamento de arquivos do Azure.

Nome Tipo Description
accountKey

string

A chave da conta de Armazenamento do Azure.

accountName

string

O nome da conta de Armazenamento do Azure.

azureFileUrl

string

A URL de Arquivos do Azure.
Isso é do formulário 'https://{account}.file.core.windows.net/'.

mountOptions

string

Opções de linha de comando adicionais para passar para o comando de montagem.
Estas são opções de "uso líquido" no Windows e opções de "montagem" no Linux.

relativeMountPath

string

O caminho relativo no nó de computação em que o sistema de arquivos será montado
Todos os sistemas de arquivos são montados em relação ao diretório de montagens do Lote, acessível por meio da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.

BatchError

Uma resposta de erro recebida do serviço do Lote do Azure.

Nome Tipo Description
code

string

Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.

message

ErrorMessage

Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.

values

BatchErrorDetail[]

Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.

Nome Tipo Description
key

string

Um identificador que especifica o significado da propriedade Value.

value

string

As informações adicionais incluídas na resposta de erro.

CachingType

O tipo de cache a ser habilitado para o disco.

Nome Tipo Description
none

string

O modo de cache do disco não está habilitado.

readonly

string

O modo de cache do disco é somente leitura.

readwrite

string

O modo de cache do disco é leitura e gravação.

CertificateReference

Uma referência a um certificado a ser instalado em nós de computação em um pool.

Nome Tipo Description
storeLocation

CertificateStoreLocation

O local do repositório de certificados no Nó de Computação no qual instalar o Certificado.
O valor padrão é currentuser. Essa propriedade é aplicável somente para pools configurados com nós de computação 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 base do usuário (por exemplo, /home/{user-name}/certs) e certificados são colocados nesse diretório.

storeName

string

O nome do repositório de certificados no Nó de Computação no qual instalar o Certificado.
Essa propriedade é aplicável somente para pools configurados com nós de computação do Windows. Nomes comuns de repositório incluem: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, mas qualquer nome de repositório personalizado também pode ser usado. O valor padrão é My.

thumbprint

string

A impressão digital do Certificado.

thumbprintAlgorithm

string

O algoritmo com o qual a impressão digital está associada. Isso deve ser sha1.

visibility

CertificateVisibility[]

Quais contas de usuário no Nó de Computação devem ter acesso aos dados privados do Certificado.
Você pode especificar mais de uma visibilidade nesta coleção. O padrão é todas as Contas.

CertificateStoreLocation

O local do repositório de certificados no Nó de Computação no qual instalar o Certificado.

Nome Tipo Description
currentuser

string

Os certificados devem ser instalados no repositório de certificados currentUser.

localmachine

string

Os certificados devem ser instalados no repositório de certificados LocalMachine.

CertificateVisibility

Quais contas de usuário no Nó de Computação devem ter acesso aos dados privados do Certificado.

Nome Tipo Description
remoteuser

string

O Certificado deve estar visível para as contas de usuário nas quais os usuários acessam remotamente o Nó de Computação.

starttask

string

O Certificado deve estar visível para a conta de usuário na qual o StartTask é executado. Observe que, se o Escopo do AutoUser for Pool para o StartTask e uma Tarefa, esse certificado também ficará visível para a Tarefa.

task

string

O Certificado deve estar visível para as contas de usuário nas quais as Tarefas de Trabalho são executadas.

CIFSMountConfiguration

Informações usadas para se conectar a um sistema de arquivos CIFS.

Nome Tipo Description
mountOptions

string

Opções de linha de comando adicionais para passar para o comando de montagem.
Estas são opções de "uso líquido" no Windows e opções de "montagem" no Linux.

password

string

A senha a ser usada para autenticação no sistema de arquivos CIFS.

relativeMountPath

string

O caminho relativo no nó de computação em que o sistema de arquivos será montado
Todos os sistemas de arquivos são montados em relação ao diretório de montagens do Lote, acessível por meio da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.

source

string

O URI do sistema de arquivos a ser montado.

username

string

O usuário a ser usado para autenticação no sistema de arquivos CIFS.

ComputeNodeFillType

Como as tarefas são distribuídas entre nós de computação em um pool.

Nome Tipo Description
pack

string

O maior número possível de tarefas (taskSlotsPerNode) deve ser atribuído a cada nó de computação no pool antes que as tarefas sejam atribuídas ao próximo Nó de Computação no Pool.

spread

string

As tarefas devem ser atribuídas uniformemente em todos os Nós de Computação no Pool.

ComputeNodeIdentityReference

A referência a uma identidade atribuída pelo usuário associada ao pool do Lote que um nó de computação usará.

Nome Tipo Description
resourceId

string

A ID de recurso do ARM da identidade atribuída pelo usuário.

ContainerConfiguration

A configuração para pools habilitados para contêineres.

Nome Tipo Description
containerImageNames

string[]

A coleção de nomes de imagem de contêiner.
Essa é a referência de imagem completa, como seria especificado para "docker pull". Uma imagem será originada do registro do Docker padrão, a menos que a imagem seja totalmente qualificada com um registro alternativo.

containerRegistries

ContainerRegistry[]

Registros privados adicionais dos quais os contêineres podem ser extraídos.
Se alguma imagem precisar ser baixada de um registro privado que exija credenciais, essas credenciais deverão ser fornecidas aqui.

type

ContainerType

A tecnologia de contêiner a ser usada.

ContainerHostBatchBindMountEntry

A entrada do caminho e do modo de montagem que você deseja montar no contêiner de tarefas.

Nome Tipo Description
isReadOnly

boolean

Monte esse caminho de origem como modo somente leitura ou não. O valor padrão é falso (modo de leitura/gravação).
Para o Linux, se você montar esse caminho como um modo de leitura/gravação, isso não significa que todos os usuários no contêiner tenham o acesso de leitura/gravação para o caminho, isso depende do acesso na VM do host. Se esse caminho for montado somente leitura, todos os usuários dentro do contêiner não poderão modificar o caminho.

source

ContainerHostDataPath

O caminho que será montado no cliente do contêiner pode ser selecionado.

ContainerHostDataPath

Os caminhos que serão montados no contêiner da tarefa de contêiner.

Nome Tipo Description
Applications

string

O caminho dos aplicativos.

JobPrep

string

O caminho da tarefa de preparação do trabalho.

Shared

string

O caminho para a tarefa de várias instâncias compartilhar seus arquivos.

Startup

string

O caminho para iniciar a tarefa.

Task

string

O caminho da tarefa.

VfsMounts

string

O caminho contém todos os sistemas de arquivos virtuais montados neste nó.

ContainerRegistry

Um registro de contêiner privado.

Nome Tipo Description
identityReference

ComputeNodeIdentityReference

A referência à identidade atribuída pelo usuário a ser usada para acessar um Registro de Contêiner do Azure em vez de nome de usuário e senha.
A referência a uma identidade atribuída pelo usuário associada ao pool do Lote que um nó de computação usará.

password

string

A senha para fazer logon no servidor do Registro.

registryServer

string

A URL do Registro.
Se omitido, o padrão será "docker.io".

username

string

O nome de usuário a ser conectado ao servidor do Registro.

ContainerType

A tecnologia de contêiner a ser usada.

Nome Tipo Description
criCompatible

string

Uma tecnologia baseada em CRI será usada para iniciar os contêineres.

dockerCompatible

string

Uma tecnologia de contêiner compatível com o Docker será usada para iniciar os contêineres.

ContainerWorkingDirectory

O local do diretório de trabalho da Tarefa de contêiner.

Nome Tipo Description
containerImageDefault

string

Use o diretório de trabalho definido na imagem do contêiner. Cuidado para que esse diretório não contenha os Arquivos de Recursos baixados pelo Lote.

taskWorkingDirectory

string

Use o diretório de trabalho da Tarefa de Serviço do Lote padrão, que conterá os Arquivos de Recurso de Tarefa preenchidos pelo Lote.

DataDisk

Configurações que serão usadas pelos discos de dados associados aos Nós de Computação no Pool. Ao usar discos de dados anexados, você precisa montar e formatar os discos de dentro de uma VM para usá-los.

Nome Tipo Description
caching

CachingType

O tipo de cache a ser habilitado para os discos de dados.
O valor padrão para o cache é readwrite. 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/.

diskSizeGB

integer

O tamanho inicial do disco em gigabytes.

lun

integer

O número da unidade lógica.
O lun é usado para identificar exclusivamente cada disco de dados. Se estiver anexando vários discos, cada um deverá ter um lun distinto. O valor deve estar entre 0 e 63, inclusive.

storageAccountType

StorageAccountType

O tipo de conta de armazenamento a ser usado para o disco de dados.
Se omitido, o padrão será "standard_lrs".

DiffDiskPlacement

Especifica o posicionamento de disco efêmero para o disco do sistema operacional para todos os nós de computação (VMs) no pool.

Nome Tipo Description
CacheDisk

string

O Disco do SO Efêmero é armazenado no cache da VM.

DiffDiskSettings

Especifica as Configurações de Disco efêmero para o disco do sistema operacional usado pela VM (nó de computação).

Nome Tipo Description
placement

DiffDiskPlacement

Especifica o posicionamento de disco efêmero para o disco do sistema operacional para todas as VMs no pool.
Essa propriedade pode ser usada pelo usuário na solicitação para escolher o local, por exemplo, armazenar espaço em disco em cache para provisionamento de disco do sistema operacional efêmero. Para obter mais informações sobre os requisitos de tamanho do disco do sistema operacional efêmero, consulte os requisitos de tamanho de disco do sistema operacional efêmero para VMs windows em VMs https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e Linux em https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

DiskEncryptionConfiguration

A configuração de criptografia de disco aplicada em nós de computação no pool. Não há suporte para a configuração de criptografia de disco no pool do Linux criado com a Imagem da Galeria de Computação do Azure.

Nome Tipo Description
targets

DiskEncryptionTarget[]

A lista de destinos de disco do Serviço de Lote será criptografada no nó de computação.
A lista de destinos de disco do Serviço de Lote será criptografada no nó de computação.

DiskEncryptionTarget

A lista de destinos de disco do Serviço de Lote será criptografada no nó de computação.

Nome Tipo Description
osdisk

string

O disco do sistema operacional no nó de computação é criptografado.

temporarydisk

string

O disco temporário no nó de computação é criptografado. No Linux, essa criptografia se aplica a outras partições (como aquelas em discos de dados montados) quando a criptografia ocorre no momento da inicialização.

DynamicVNetAssignmentScope

O escopo da atribuição de vnet dinâmica.

Nome Tipo Description
job

string

A atribuição de VNet dinâmica é feita por trabalho.

none

string

Nenhuma atribuição de VNet dinâmica está habilitada.

ElevationLevel

O nível de elevação do usuário.

Nome Tipo Description
admin

string

O usuário é um usuário com acesso elevado e opera com permissões de Administrador completas.

nonadmin

string

O usuário é um usuário padrão sem acesso elevado.

EnvironmentSetting

Uma variável de ambiente a ser definida em um processo de tarefa.

Nome Tipo Description
name

string

O nome da variável de ambiente.

value

string

O valor da variável de ambiente.

ErrorMessage

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.

Nome Tipo Description
lang

string

O código de idioma da mensagem de erro

value

string

O texto da mensagem.

ImageReference

Uma referência a uma imagem do Marketplace de Máquinas Virtuais do Azure ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de imagem do Azure Marketplace verificadas pelo Lote do Azure, consulte a operação 'Listar Imagens Com Suporte'.

Nome Tipo Description
communityGalleryImageId

string

O identificador exclusivo da imagem da galeria da comunidade
Essa propriedade é mutuamente exclusiva com outras propriedades e pode ser buscada na chamada GET da imagem da galeria da comunidade.

exactVersion

string

A versão específica da imagem da plataforma ou da imagem do marketplace usada para criar o nó. Esse campo somente leitura será diferente de "version" somente se o valor especificado para 'version' quando o pool foi criado for 'latest'.

offer

string

O tipo de oferta da Imagem do Marketplace de Máquinas Virtuais do Azure.
Por exemplo, UbuntuServer ou WindowsServer.

publisher

string

O editor da Imagem do Marketplace de Máquinas Virtuais do Azure.
Por exemplo, Canonical ou MicrosoftWindowsServer.

sharedGalleryImageId

string

O identificador exclusivo da imagem da galeria compartilhada
Essa propriedade é mutuamente exclusiva com outras propriedades e pode ser buscada na chamada GET da imagem da galeria compartilhada.

sku

string

A SKU da imagem do Marketplace de Máquinas Virtuais do Azure.
Por exemplo, 18.04-LTS ou 2019-Datacenter.

version

string

A versão da Imagem do Marketplace de Máquinas Virtuais do Azure.
Um valor 'mais recente' pode ser especificado para selecionar a versão mais recente de uma Imagem. Se omitido, o padrão será 'latest'.

virtualMachineImageId

string

O identificador de recurso do ARM da Imagem da Galeria de Computação do Azure. Nós de computação no pool serão criados usando essa ID de imagem. Isso é do formulário /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} ou /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} para sempre usar a versão mais recente da imagem.
Essa propriedade é mutuamente exclusiva com outras propriedades ImageReference. A Imagem da Galeria de Computação do Azure deve ter réplicas na mesma região e deve estar na mesma assinatura da conta do Lote do Azure. Se a versão da imagem não for especificada na imageId, a versão mais recente será usada. Para obter informações sobre as configurações de firewall do agente do Nó de Computação em Lote para se comunicar com o serviço do Lote, consulte https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

InboundEndpointProtocol

O protocolo do ponto de extremidade.

Nome Tipo Description
tcp

string

Use TCP para o ponto de extremidade.

udp

string

Use UDP para o ponto de extremidade.

InboundNATPool

Um pool nat de entrada que pode ser usado para abordar portas específicas em nós de computação em um pool de lote externamente.

Nome Tipo Description
backendPort

integer

O número da porta no Nó de Computação.
Isso deve ser exclusivo em um Pool de Lotes. Os valores aceitáveis estão entre 1 e 65535, exceto 22, 3389, 29876 e 29877, pois são reservados. Se quaisquer valores reservados forem fornecidos, a solicitação falhará com o código de status HTTP 400.

frontendPortRangeEnd

integer

O último número de porta no intervalo de portas externas que serão usadas para fornecer acesso de entrada ao back-endPort em nós de computação individuais.
Os valores aceitáveis variam entre 1 e 65534, exceto as portas de 50000 a 55000 que são reservadas pelo serviço do Lote. Todos os intervalos em um pool devem ser distintos e não podem se sobrepor. Cada intervalo deve conter pelo menos 40 portas. Se quaisquer valores reservados ou sobrepostos forem fornecidos, a solicitação falhará com o código de status HTTP 400.

frontendPortRangeStart

integer

O primeiro número de porta no intervalo de portas externas que serão usadas para fornecer acesso de entrada ao backendPort em nós de computação individuais.
Os valores aceitáveis variam entre 1 e 65534, exceto as portas de 50000 a 55000 que são reservadas. Todos os intervalos em um pool devem ser distintos e não podem se sobrepor. Cada intervalo deve conter pelo menos 40 portas. Se quaisquer valores reservados ou sobrepostos forem fornecidos, a solicitação falhará com o código de status HTTP 400.

name

string

O nome do ponto de extremidade.
O nome deve ser exclusivo em um Pool de Lotes, pode conter letras, números, sublinhados, períodos e hifens. Os nomes devem começar com uma letra ou número, devem terminar com uma letra, um número ou um sublinhado e não podem exceder 77 caracteres. Se quaisquer valores inválidos forem fornecidos, a solicitação falhará com o código de status HTTP 400.

networkSecurityGroupRules

NetworkSecurityGroupRule[]

Uma lista de regras de grupo de segurança de rede que serão aplicadas ao ponto de extremidade.
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 ao back-endPort especificado. Se o número máximo de regras do grupo de segurança de rede for excedido, a solicitação falhará com o código de status HTTP 400.

protocol

InboundEndpointProtocol

O protocolo do ponto de extremidade.

IPAddressProvisioningType

O tipo de provisionamento para endereços IP públicos para o pool.

Nome Tipo Description
batchmanaged

string

Um IP público será criado e gerenciado pelo Lote. Pode haver vários IPs públicos dependendo do tamanho do pool.

nopublicipaddresses

string

Nenhum endereço IP público será criado.

usermanaged

string

Os IPs públicos são fornecidos pelo usuário e serão usados para provisionar os Nós de Computação.

LinuxUserConfiguration

Propriedades usadas para criar uma conta de usuário em um Nó de Computação do Linux.

Nome Tipo Description
gid

integer

A ID do grupo para a conta de usuário.
As propriedades uid e gid devem ser especificadas juntas ou não. Se não for especificado, o sistema operacional subjacente escolherá o gid.

sshPrivateKey

string

A chave privada SSH para a conta de usuário.
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 de computação em um pool do Linux quando a propriedade enableInterNodeCommunication do Pool for verdadeira (ela será 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 de computação (nenhuma modificação do diretório .ssh do usuário é feita).

uid

integer

A ID de usuário da conta de usuário.
As propriedades uid e gid devem ser especificadas juntas ou não. Se não for especificado, o sistema operacional subjacente escolherá a uid.

LoginMode

O modo de logon do usuário

Nome Tipo Description
batch

string

O LOGON32_LOGON_BATCH modo de logon do Win32. O modo de logon em lote é recomendado para processos paralelos de execução prolongada.

interactive

string

O LOGON32_LOGON_INTERACTIVE modo de logon do Win32. O UAC está habilitado em Pools do Windows. Se essa opção for usada com uma identidade de usuário elevada em um Pool do Windows, a sessão do usuário não será elevada, a menos que o aplicativo executado pela linha de comando tarefa esteja configurado para sempre exigir privilégio administrativo ou sempre exigir privilégio máximo.

ManagedDisk

Nome Tipo Description
securityProfile

VMDiskSecurityProfile

Especifica as configurações de perfil de segurança para o disco gerenciado.
Especifica as configurações de perfil de segurança para o disco gerenciado. Observação: ele só pode ser definido para VMs confidenciais e necessário ao usar VMs confidenciais.

storageAccountType

StorageAccountType

O tipo de conta de armazenamento do disco gerenciado.

MetadataItem

Um par nome-valor associado a um recurso de serviço do Lote.

Nome Tipo Description
name

string

O nome do item de metadados.

value

string

O valor do item de metadados.

MountConfiguration

O sistema de arquivos a ser montado em cada nó.

Nome Tipo Description
azureBlobFileSystemConfiguration

AzureBlobFileSystemConfiguration

O Contêiner de Armazenamento do Azure a ser montado usando o FUSE de blob em cada nó.
Essa propriedade é mutuamente exclusiva com todas as outras propriedades.

azureFileShareConfiguration

AzureFileShareConfiguration

O Compartilhamento de Arquivos do Azure a ser montado em cada nó.
Essa propriedade é mutuamente exclusiva com todas as outras propriedades.

cifsMountConfiguration

CIFSMountConfiguration

O sistema de arquivos CIFS/SMB a ser montado em cada nó.
Essa propriedade é mutuamente exclusiva com todas as outras propriedades.

nfsMountConfiguration

NFSMountConfiguration

O sistema de arquivos NFS a ser montado em cada nó.
Essa propriedade é mutuamente exclusiva com todas as outras propriedades.

NetworkConfiguration

A configuração de rede de um pool.

Nome Tipo Description
dynamicVNetAssignmentScope

DynamicVNetAssignmentScope

O escopo da atribuição de vnet dinâmica.

enableAcceleratedNetworking

boolean

Se esse pool deve habilitar a rede acelerada.
A rede acelerada permite a virtualização de E/S raiz única (SR-IOV) para uma VM, o que pode levar a um melhor desempenho de rede. Para obter mais detalhes, consulte: https://video2.skills-academy.com/azure/virtual-network/accelerated-networking-overview.

endpointConfiguration

PoolEndpointConfiguration

A configuração para pontos de extremidade em Nós de Computação no Pool de Lotes.

publicIPAddressConfiguration

PublicIPAddressConfiguration

A configuração de IPAddress público para nós de computação no Pool de Lotes.
A configuração de endereço IP público da configuração de rede de um pool.

subnetId

string

O identificador de recurso arm da sub-rede de rede virtual à qual os Nós de Computação do Pool ingressarão. Isso é do formulário /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.
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 gratuitos suficientes para acomodar o número de nós de computação no pool. Se a sub-rede não tiver endereços IP gratuitos suficientes, o Pool alocará parcialmente nós 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 RBAC (Controle de Acesso) para a VNet especificada. A sub-rede especificada deve permitir que a comunicação do serviço do Lote do Azure seja capaz de agendar tarefas nos nós. Isso pode ser verificado verificando se a VNet especificada tem algum NSG (Grupos de Segurança de Rede) associados. Se a comunicação com os Nós na sub-rede especificada for negada por um NSG, o serviço lote definirá o estado dos Nós de Computação como inutilizável. Há suporte apenas para redes virtuais arm ('Microsoft.Network/virtualNetworks'). Se a VNet especificada tiver nenhum NSG (Grupos de Segurança de Rede) associado, algumas portas reservadas do sistema deverão ser habilitadas para comunicação de entrada. Habilite as portas 29876 e 29877, bem como a porta 22 para Linux e a porta 3389 para Windows. Habilite também conexões de saída para o Armazenamento do Azure na porta 443. Para obter mais detalhes, consulte: https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Uma regra de grupo de segurança de rede a ser aplicada a um ponto de extremidade de entrada.

Nome Tipo Description
access

NetworkSecurityGroupRuleAccess

A ação que deve ser tomada para um endereço IP especificado, intervalo de sub-rede ou marca.

priority

integer

A prioridade dessa regra.
As prioridades em um pool devem ser exclusivas e são avaliadas em ordem de prioridade. Quanto menor o número, maior a prioridade. Por exemplo, as regras podem ser especificadas com números de pedidos 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 4096. Se quaisquer valores reservados ou duplicados forem fornecidos, a solicitação falhará com o código de status HTTP 400.

sourceAddressPrefix

string

O prefixo ou marca de endereço de origem a ser correspondente à regra.
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), marca 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.

sourcePortRanges

string[]

Os intervalos de porta de origem a serem correspondentes à regra.
Os valores válidos são '' (para todas as portas 0 a 65535), uma porta específica (ou seja, 22) ou um intervalo de porta (ou seja, 100-200). As portas devem estar no intervalo de 0 a 65535. Cada entrada nesta coleção não deve se sobrepor a nenhuma outra entrada (um intervalo ou uma porta individual). Se quaisquer outros valores forem fornecidos, a solicitação falhará com o código de status HTTP 400. O valor padrão é ''.

NetworkSecurityGroupRuleAccess

A ação que deve ser tomada para um endereço IP especificado, intervalo de sub-rede ou marca.

Nome Tipo Description
allow

string

Permitir acesso.

deny

string

Negar acesso.

NFSMountConfiguration

Informações usadas para se conectar a um sistema de arquivos NFS.

Nome Tipo Description
mountOptions

string

Opções de linha de comando adicionais para passar para o comando de montagem.
Estas são opções de "uso líquido" no Windows e opções de "montagem" no Linux.

relativeMountPath

string

O caminho relativo no nó de computação em que o sistema de arquivos será montado
Todos os sistemas de arquivos são montados em relação ao diretório de montagens do Lote, acessível por meio da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.

source

string

O URI do sistema de arquivos a ser montado.

NodeCommunicationMode

Determina como um pool se comunica com o serviço do Lote.

Nome Tipo Description
classic

string

Os nós que usam o modo de comunicação clássico exigem comunicação TCP de entrada nas portas 29876 e 29877 do "BatchNodeManagement. {region}" marca de serviço e comunicação TCP de saída na porta 443 para "Storage.region" e "BatchNodeManagement. Marcas de serviço {region}".

default

string

O modo de comunicação do nó é definido automaticamente pelo serviço do Lote.

simplified

string

Os nós que usam o modo de comunicação simplificado exigem comunicação TCP de saída na porta 443 para o "BatchNodeManagement. {region}" marca de serviço. Não são necessárias portas de entrada abertas.

NodePlacementConfiguration

Configuração de posicionamento do nó para um pool.

Nome Tipo Description
policy

NodePlacementPolicyType

Tipo de política de posicionamento de nó em pools de lote.
Política de alocação usada pelo Serviço de Lote para provisionar os nós. Se não for especificado, o Lote usará a política regional.

NodePlacementPolicyType

A política de posicionamento para alocar nós no pool.

Nome Tipo Description
regional

string

Todos os nós no pool serão alocados na mesma região.

zonal

string

Nós no pool serão distribuídos entre diferentes zonas de disponibilidade com melhor balanceamento de esforço.

OSDisk

Configurações do disco do sistema operacional do nó de computação (VM).

Nome Tipo Description
caching

CachingType

Especifica os requisitos de cache. Os valores possíveis são: None, ReadOnly, ReadWrite. Os valores padrão são: Nenhum para armazenamento Standard. ReadOnly para armazenamento Premium.
O valor padrão para cache é nenhum. 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/.

diskSizeGB

integer

O tamanho inicial do disco em GB ao criar um novo disco do sistema operacional.

ephemeralOSDiskSettings

DiffDiskSettings

Especifica as Configurações de Disco efêmero para o disco do sistema operacional usado pela VM (nó de computação).

managedDisk

ManagedDisk

Os parâmetros de disco gerenciado.

writeAcceleratorEnabled

boolean

Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco.

PoolAddParameter

Um pool no serviço lote do Azure a ser adicionado.

Nome Tipo Description
applicationPackageReferences

ApplicationPackageReference[]

A lista de pacotes a serem instalados em cada Nó de Computação no Pool.
Ao criar um pool, a ID do aplicativo do pacote deve ser totalmente qualificada (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). As alterações nas referências de pacote afetam todos os novos nós que ingressam no Pool, mas não afetam nós de computação que já estão no Pool até que sejam reinicializados ou reimageados. Há um máximo de 10 referências de pacote em um determinado pool.

autoScaleEvaluationInterval

string

O intervalo de tempo no qual ajustar automaticamente o tamanho do Pool de acordo com a fórmula de dimensionamento automático.
O valor padrão é 15 minutos. O valor mínimo e máximo é de 5 minutos e 168 horas, respectivamente. Se você especificar um valor menor que 5 minutos ou maior que 168 horas, o serviço do Lote retornará um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação Incorreta).

autoScaleFormula

string

Uma fórmula para o número desejado de Nós de Computação no Pool.
Essa propriedade não deverá ser especificada se enableAutoScale for definido como false. Ele será necessário se enableAutoScale estiver definido como true. A fórmula é verificada quanto à validade antes da criação do Pool. Se a fórmula não for válida, o serviço do Lote rejeitará a solicitação com informações detalhadas de erro. Para obter mais informações sobre como especificar essa fórmula, consulte "Dimensionar automaticamente nós de computação em um pool de lote do Azure" (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).

certificateReferences

CertificateReference[]

A lista de certificados a serem instalados em cada Nó de Computação no Pool.
Para nós do Windows, o serviço Lote instala os Certificados no repositório e local de certificados 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 base do usuário (por exemplo, /home/{user-name}/certs) e certificados são colocados nesse diretório.

Aviso: essa propriedade foi preterida e será removida após fevereiro de 2024. Em vez disso, use o de Extensão do Azure KeyVault .

displayName

string

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

enableAutoScale

boolean

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

enableInterNodeCommunication

boolean

Se o Pool permite comunicação direta entre nós de computação.
Habilitar a comunicação entre nós limita o tamanho máximo do pool devido a restrições de implantação nos nós de computação do pool. Isso pode fazer com que o Pool não atinja o tamanho desejado. O valor padrão é false.

id

string

Uma cadeia de caracteres que identifica exclusivamente o pool na Conta.
A ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hifens e sublinhados, e não pode conter mais de 64 caracteres. A ID não diferencia maiúsculas de minúsculas e maiúsculas de minúsculas (ou seja, você pode não ter duas IDs de pool em uma conta que diferem apenas por caso).

metadata

MetadataItem[]

Uma lista de pares nome-valor associados ao Pool como metadados.
O serviço do Lote não atribui nenhum significado aos metadados; é apenas para o uso do código do usuário.

mountConfiguration

MountConfiguration[]

Monte o armazenamento usando o sistema de arquivos especificado durante todo o tempo de vida do pool.
Monte o armazenamento usando o compartilhamento de arquivos do Azure, NFS, CIFS ou sistema de arquivos baseado em Blobfuse.

networkConfiguration

NetworkConfiguration

A configuração de rede do Pool.
A configuração de rede de um pool.

resizeTimeout

string

O tempo limite para alocação de nós de computação para o pool.
Esse tempo limite se aplica apenas ao dimensionamento manual; ele não tem efeito quando enableAutoScale é definido como true. O valor padrão é 15 minutos. O valor mínimo é 5 minutos. Se você especificar um valor menor que 5 minutos, o serviço do Lote retornará um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação Incorreta).

resourceTags

object

As marcas especificadas pelo usuário associadas ao pool.
As marcas definidas pelo usuário a serem associadas ao Pool de Lotes do Azure. Quando especificadas, essas marcas são propagadas para os recursos do Azure de suporte associados ao pool. Essa propriedade só pode ser especificada quando a conta do Lote foi criada com a propriedade poolAllocationMode definida como 'UserSubscription'.

startTask

StartTask

Uma tarefa especificada para ser executada em cada Nó de Computação à medida que ele ingressa no pool.
A Tarefa é executada quando o Nó de Computação é adicionado ao Pool ou quando o Nó de Computação é reiniciado.

targetDedicatedNodes

integer

O número desejado de nós de computação dedicados no pool.
Essa propriedade não deve ser especificada se enableAutoScale estiver definido como true. Se enableAutoScale for definido como false, você deverá definir targetDedicatedNodes, targetLowPriorityNodes ou ambos.

targetLowPriorityNodes

integer

O número desejado de nós de computação spot/de baixa prioridade no pool.
Essa propriedade não deve ser especificada se enableAutoScale estiver definido como true. Se enableAutoScale for definido como false, você deverá definir targetDedicatedNodes, targetLowPriorityNodes ou ambos.

targetNodeCommunicationMode

NodeCommunicationMode

O modo de comunicação de nó desejado para o pool.
Se omitido, o valor padrão será Default.

taskSchedulingPolicy

TaskSchedulingPolicy

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

taskSlotsPerNode

integer

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

upgradePolicy

UpgradePolicy

A política de atualização do Pool.
Descreve uma política de atualização – automática, manual ou sem interrupção.

userAccounts

UserAccount[]

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

virtualMachineConfiguration

VirtualMachineConfiguration

A configuração da máquina virtual para o Pool.
Essa propriedade deve ser especificada.

vmSize

string

O tamanho das máquinas virtuais no Pool. Todas as máquinas virtuais em um Pool têm o mesmo tamanho.
Para obter informações sobre tamanhos de VM disponíveis, 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 Lote dá suporte a todos os tamanhos de VM do Azure, exceto STANDARD_A0 e aqueles com armazenamento premium (séries STANDARD_GS, STANDARD_DS e STANDARD_DSV2).

PoolEndpointConfiguration

A configuração do ponto de extremidade para um pool.

Nome Tipo Description
inboundNATPools

InboundNATPool[]

Uma lista de pools NAT de entrada que podem ser usados para abordar portas específicas em um nó de computação individual externamente.
O número máximo de pools 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. Isso não poderá ser especificado se o IPAddressProvisioningType for NoPublicIPAddresses.

PublicIPAddressConfiguration

A configuração de endereço IP público da configuração de rede de um pool.

Nome Tipo Description
ipAddressIds

string[]

A lista de IPs públicos que o serviço do Lote usará ao provisionar nós de computação.
O número de IPs especificado aqui limita o tamanho máximo do Pool – 100 nós dedicados ou 100 nós spot/de baixa prioridade podem ser alocados para cada IP público. Por exemplo, um pool que precisa de 250 VMs dedicadas precisaria de pelo menos três IPs públicos especificados. Cada elemento dessa coleção é do formulário: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

provision

IPAddressProvisioningType

O tipo de provisionamento para endereços IP públicos para o pool.
O valor padrão é BatchManaged.

ResourceFile

Um único arquivo ou vários arquivos a serem baixados em um Nó de Computação.

Nome Tipo Description
autoStorageContainerName

string

O nome do contêiner de armazenamento na Conta de armazenamento automático.
As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada.

blobPrefix

string

O prefixo de blob a ser usado ao baixar blobs de um contêiner do Armazenamento do Azure. Somente os blobs cujos nomes começam com o prefixo especificado serão baixados.
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.

fileMode

string

O atributo de modo de permissão de arquivo no formato octal.
Essa propriedade se aplica somente aos 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 em um Nó de Computação do Windows. Se essa propriedade não for especificada para um Nó de Computação do Linux, um valor padrão de 0770 será aplicado ao arquivo.

filePath

string

O local no Nó de Computação para o qual baixar os arquivos em relação ao diretório de trabalho da Tarefa.
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 baixar os arquivos. No caso em que o filePath é usado como um diretório, qualquer estrutura de diretório já associada aos dados de entrada será retida na íntegra e acrescentada ao diretório filePath especificado. O caminho relativo especificado não pode sair do diretório de trabalho da Tarefa (por exemplo, usando '..').

httpUrl

string

A URL do arquivo a ser baixado.
As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Se a URL apontar para o Armazenamento de Blobs do Azure, ela deverá ser legível de nós de computação. Há três 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, usar uma identidade gerenciada com permissão de leitura ou definir a ACL para o blob ou seu contêiner para permitir acesso público.

identityReference

ComputeNodeIdentityReference

A referência à identidade atribuída pelo usuário a ser usada para acessar o Armazenamento de Blobs do Azure especificado por storageContainerUrl ou httpUrl
A referência a uma identidade atribuída pelo usuário associada ao pool do Lote que um nó de computação usará.

storageContainerUrl

string

A URL do contêiner de blob no Armazenamento de Blobs do Azure.
As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Essa URL deve ser legível e listável de nós de computação. Há três maneiras de obter essa URL para um contêiner no armazenamento do Azure: incluir uma SAS (Assinatura de Acesso Compartilhado) concedendo permissões de leitura e lista no contêiner, usar uma identidade gerenciada com permissões de leitura e lista ou definir a ACL para o contêiner para permitir acesso público.

RollingUpgradePolicy

Os parâmetros de configuração usados durante a execução de uma atualização sem interrupção.

Nome Tipo Description
enableCrossZoneUpgrade

boolean

Permitir que o VMSS ignore os limites do AZ ao construir lotes de atualização. Leve em consideração o Domínio de Atualização e maxBatchInstancePercent para determinar o tamanho do lote. Esse campo pode ser definido como true ou false somente ao usar NodePlacementConfiguration como Zonal.

maxBatchInstancePercent

integer

A porcentagem máxima do total de instâncias de máquina virtual que serão atualizadas simultaneamente pela atualização sem interrupção em um lote. Como isso é um máximo, instâncias não íntegras em lotes anteriores ou futuros podem fazer com que o percentual de instâncias em um lote diminua para garantir maior confiabilidade. O valor desse campo deve estar entre 5 e 100, inclusive. Se maxBatchInstancePercent e maxUnhealthyInstancePercent forem atribuídos com valor, o valor de maxBatchInstancePercent não deverá ser maior que maxUnhealthyInstancePercent.

maxUnhealthyInstancePercent

integer

O percentual máximo do total de instâncias de máquina virtual no conjunto de dimensionamento que pode ser simultaneamente não íntegro, seja como resultado da atualização ou por ser encontrado em um estado não íntegro pelas verificações de integridade da máquina virtual antes que a atualização sem interrupção seja anulada. Essa restrição será verificada antes de iniciar qualquer lote. O valor desse campo deve estar entre 5 e 100, inclusive. Se maxBatchInstancePercent e maxUnhealthyInstancePercent forem atribuídos com valor, o valor de maxBatchInstancePercent não deverá ser maior que maxUnhealthyInstancePercent.

maxUnhealthyUpgradedInstancePercent

integer

O percentual máximo de instâncias de máquina virtual atualizadas que podem ser encontradas em um estado não íntegro. Essa verificação ocorrerá depois que cada lote for atualizado. Se esse percentual for excedido, a atualização sem interrupção será anulada. O valor desse campo deve estar entre 0 e 100, inclusive.

pauseTimeBetweenBatches

string

O tempo de espera entre concluir a atualização de todas as máquinas virtuais em um lote e iniciar o próximo lote. A duração do tempo deve ser especificada no formato ISO 8601.

prioritizeUnhealthyInstances

boolean

Atualize todas as instâncias não íntegras em um conjunto de dimensionamento antes de qualquer instância íntegra.

rollbackFailedInstancesOnPolicyBreach

boolean

Reverter instâncias com falha para o modelo anterior se a política de Atualização Sem Interrupção for violada.

SecurityEncryptionTypes

Especifica o EncryptionType do disco gerenciado. Ele é definido como VMGuestStateOnly para criptografia apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado de firmware no blob VMGuestState. Observação: ele pode ser definido apenas para VMs confidenciais e é necessário ao usar VMs confidenciais.

Nome Tipo Description
NonPersistedTPM

string

VMGuestStateOnly

string

SecurityProfile

Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais.

Nome Tipo Description
encryptionAtHost

boolean

Essa propriedade pode ser usada pelo usuário na solicitação para habilitar ou desabilitar a Criptografia de Host para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais. Isso habilitará a criptografia para todos os discos, incluindo o disco Resource/Temp no próprio host. Para obter mais informações sobre criptografia nos requisitos de host, consulte https://video2.skills-academy.com/azure/virtual-machines/disk-encryption#supported-vm-sizes.

securityType

SecurityTypes

Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings.

uefiSettings

UefiSettings

Especifica as configurações de segurança, como inicialização segura e vTPM usadas durante a criação da máquina virtual.
Especifica as configurações de segurança, como inicialização segura e vTPM usadas durante a criação da máquina virtual.

SecurityTypes

Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings.

Nome Tipo Description
confidentialVM

string

A computação confidencial do Azure oferece VMs confidenciais para locatários com requisitos de alta segurança e confidencialidade. Essas VMs fornecem um limite forte e imposto por hardware para ajudar a atender às suas necessidades de segurança. Você pode usar VMs confidenciais para migrações sem fazer alterações no código, com a plataforma protegendo o estado da VM de ser lida ou modificada.

trustedLaunch

string

O inicialização confiável protege contra técnicas de ataque avançadas e persistentes.

ServiceArtifactReference

Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de dimensionamento ao usar a versão de imagem 'mais recente'.

Nome Tipo Description
id

string

A ID de referência do artefato de serviço de ServiceArtifactReference
A ID de referência do artefato de serviço na forma de /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

StartTask

Uma tarefa que é executada quando um nó ingressa em um pool no serviço do Lote do Azure ou quando o Nó de Computação é reinicializado ou reimageado.

Nome Tipo Description
commandLine

string

A linha de comando do StartTask.
A linha de comando não é executada em um shell e, portanto, não pode aproveitar os recursos do shell, como expansão de variável de ambiente. Se quiser aproveitar esses recursos, invoque o shell na linha de comando, por exemplo, usando "cmd /c MyCommand" no Windows ou "/bin/sh -c MyCommand" no Linux. Se a linha de comando se referir a caminhos de arquivo, ela deverá usar um caminho relativo (relativo ao diretório de trabalho da Tarefa) ou usar a variável de ambiente fornecida pelo Lote (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).

containerSettings

TaskContainerSettings

As configurações do contêiner no qual o StartTask é executado.
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 para o contêiner, todas as variáveis de ambiente de tarefa são mapeadas para o contêiner e a linha de comando Tarefa é executada no contêiner. Os arquivos produzidos no contêiner fora de AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos no disco do host, o que significa que as APIs de arquivo do Lote não poderão acessar esses arquivos.

environmentSettings

EnvironmentSetting[]

Uma lista de configurações de variável de ambiente para o StartTask.

maxTaskRetryCount

integer

O número máximo de vezes que a Tarefa pode ser repetida.
O serviço do Lote tentará novamente uma Tarefa se o código de saída não for zero. Observe que esse valor controla especificamente o número de repetições. O serviço lote tentará a Tarefa uma vez e poderá tentar novamente até esse limite. Por exemplo, se a contagem máxima de repetição for 3, o Lote tentará a Tarefa até 4 vezes (uma tentativa inicial e três tentativas). Se a contagem máxima de repetição for 0, o serviço do Lote não tentará novamente a Tarefa. Se a contagem máxima de repetição for -1, o serviço do Lote repetirá a Tarefa sem limite, no entanto, isso não é recomendado para uma tarefa inicial ou qualquer tarefa. O valor padrão é 0 (sem novas tentativas).

resourceFiles

ResourceFile[]

Uma lista de arquivos que o serviço do Lote baixará no Nó de Computação antes de executar a linha de comando. Há um tamanho máximo para a lista de arquivos de recurso. Quando o tamanho máximo for excedido, a solicitação falhará e o código de erro de resposta será RequestEntityTooLarge. Se isso ocorrer, a coleção de ResourceFiles deverá ser reduzida em tamanho. Isso pode ser feito usando arquivos .zip, pacotes de aplicativos ou contêineres do Docker.
Os arquivos listados sob esse elemento estão localizados no diretório de trabalho da Tarefa.

userIdentity

UserIdentity

A identidade do usuário na qual o StartTask é executado.
Se omitido, a Tarefa será executada como um usuário não administrativo exclusivo para a Tarefa.

waitForSuccess

boolean

Se o serviço do Lote deve aguardar a conclusão do StartTask com êxito (ou seja, sair com o código de saída 0) antes de agendar tarefas no Nó de Computação.
Se true e o StartTask falharem em um nó, o serviço do Lote tentará novamente o StartTask até sua contagem máxima de repetição (maxTaskRetryCount). Se a Tarefa ainda não tiver sido concluída com êxito após todas as novas tentativas, o serviço do Lote marcará o nó inutilizável e não agendará Tarefas para ela. Essa condição pode ser detectada por meio do estado do Nó de Computação e dos detalhes das informações de falha. Se for falso, o serviço do Lote não aguardará a conclusão do StartTask. Nesse caso, outras tarefas podem começar a ser executadas no Nó de Computação enquanto o StartTask ainda estiver em execução; e mesmo que o StartTask falhe, novas tarefas continuarão a ser agendadas no Nó de Computação. O padrão é verdadeiro.

StorageAccountType

O tipo de conta de armazenamento para uso na criação de discos de dados ou disco do sistema operacional.

Nome Tipo Description
premium_lrs

string

O disco de dados/disco do sistema operacional deve usar o armazenamento premium com redundância local.

standard_lrs

string

O disco de dados/disco do sistema operacional deve usar o armazenamento padrão com redundância local.

standardssd_lrs

string

O disco de dados/disco do sistema operacional deve usar o armazenamento com redundância local do SSD padrão.

TaskContainerSettings

As configurações de contêiner de uma Tarefa.

Nome Tipo Description
containerHostBatchBindMounts

ContainerHostBatchBindMountEntry[]

Os caminhos que você deseja montar na tarefa de contêiner.
Se essa matriz for nula ou não estiver presente, a tarefa de contêiner montará toda a unidade de disco temporária no Windows (ou AZ_BATCH_NODE_ROOT_DIR no Linux). Ele não montará nenhum caminho de dados no contêiner se essa matriz estiver definida como vazia.

containerRunOptions

string

Opções adicionais para o comando de criação de contêiner.
Essas opções adicionais são fornecidas como argumentos para o comando "docker create", além das controladas pelo Serviço de Lote.

imageName

string

A imagem a ser usada para criar o contêiner no qual a Tarefa será executada.
Essa é a referência de imagem completa, como seria especificado para "docker pull". Se nenhuma marca for fornecida como parte do nome da imagem, a marca ":latest" será usada como padrão.

registry

ContainerRegistry

O registro privado que contém a imagem do contêiner.
Essa configuração poderá ser omitida se já tiver sido fornecida na criação do Pool.

workingDirectory

ContainerWorkingDirectory

O local do diretório de trabalho da Tarefa de contêiner.
O padrão é 'taskWorkingDirectory'.

TaskSchedulingPolicy

Especifica como as tarefas devem ser distribuídas entre nós de computação.

Nome Tipo Description
nodeFillType

ComputeNodeFillType

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

UefiSettings

Especifica as configurações de segurança, como inicialização segura e vTPM usadas durante a criação da máquina virtual.

Nome Tipo Description
secureBootEnabled

boolean

Especifica se a inicialização segura deve ser habilitada na máquina virtual.

vTpmEnabled

boolean

Especifica se o vTPM deve ser habilitado na máquina virtual.

UpgradeMode

Especifica o modo de uma atualização para máquinas virtuais no conjunto de dimensionamento.

Os valores possíveis são:

Manual – você controla a aplicação de atualizações para máquinas virtuais no conjunto de dimensionamento. Faça isso usando a ação manualUpgrade.

automático – todas as máquinas virtuais no conjunto de dimensionamento são atualizadas automaticamente ao mesmo tempo.

Rolling – O conjunto de dimensionamento executa atualizações em lotes com um tempo de pausa opcional no meio.

Nome Tipo Description
automatic

string

Todas as máquinas virtuais no conjunto de dimensionamento são atualizadas automaticamente ao mesmo tempo.

manual

string

Você controla a aplicação de atualizações para máquinas virtuais no conjunto de dimensionamento. Faça isso usando a ação manualUpgrade.

rolling

string

As instâncias existentes em um conjunto de dimensionamento são derrubadas em lotes a serem atualizados. Depois que o lote atualizado for concluído, as instâncias começarão a usar o tráfego novamente e o próximo lote será iniciado. Isso continua até que todas as instâncias sejam up-to-date.

UpgradePolicy

Descreve uma política de atualização – automática, manual ou sem interrupção.

Nome Tipo Description
automaticOSUpgradePolicy

AutomaticOSUpgradePolicy

Parâmetros de configuração usados para executar a atualização automática do sistema operacional.
Os parâmetros de configuração usados para executar a atualização automática do sistema operacional.

mode

UpgradeMode

Especifica o modo de uma atualização para máquinas virtuais no conjunto de dimensionamento.

Os valores possíveis são:

Manual – você controla a aplicação de atualizações para máquinas virtuais no conjunto de dimensionamento. Faça isso usando a ação manualUpgrade.

automático – todas as máquinas virtuais no conjunto de dimensionamento são atualizadas automaticamente ao mesmo tempo.

Rolling – O conjunto de dimensionamento executa atualizações em lotes com um tempo de pausa opcional no meio.

rollingUpgradePolicy

RollingUpgradePolicy

Os parâmetros de configuração usados durante a execução de uma atualização sem interrupção.
Os parâmetros de configuração usados durante a execução de uma atualização sem interrupção.

UserAccount

Propriedades usadas para criar um usuário usado para executar Tarefas em um Nó de Computação em Lote do Azure.

Nome Tipo Description
elevationLevel

ElevationLevel

O nível de elevação da conta de usuário.
O valor padrão é nonAdmin.

linuxUserConfiguration

LinuxUserConfiguration

A configuração de usuário específica do Linux para a conta de usuário.
Essa propriedade será ignorada se especificada em um Pool do Windows. Se não for especificado, o usuário será criado com as opções padrão.

name

string

O nome da conta de usuário. Os nomes podem conter caracteres Unicode até um comprimento máximo de 20.

password

string

A senha da conta de usuário.

windowsUserConfiguration

WindowsUserConfiguration

A configuração de usuário específica do Windows para a conta de usuário.
Essa propriedade só poderá ser especificada se o usuário estiver em um Pool do Windows. Se não for especificado e em um Pool do Windows, o usuário será criado com as opções padrão.

UserIdentity

A definição da identidade do usuário na qual a Tarefa é executada.

Nome Tipo Description
autoUser

AutoUserSpecification

O usuário automático no qual a Tarefa é executada.
As propriedades userName e autoUser são mutuamente exclusivas; você deve especificar um, mas não ambos.

username

string

O nome da identidade do usuário na qual a Tarefa é executada.
As propriedades userName e autoUser são mutuamente exclusivas; você deve especificar um, mas não ambos.

VirtualMachineConfiguration

A configuração para nós de computação em um pool com base na infraestrutura de Máquinas Virtuais do Azure.

Nome Tipo Description
containerConfiguration

ContainerConfiguration

A configuração do contêiner para o Pool.
Se especificado, a instalação é executada em cada Nó de Computação no Pool para permitir que tarefas sejam executadas em contêineres. Todas as tarefas regulares e tarefas do gerenciador de trabalho executadas neste pool devem especificar a propriedade containerSettings e todas as outras Tarefas podem especificá-la.

dataDisks

DataDisk[]

A configuração de discos de dados anexados aos Nós de Computação no Pool.
Essa propriedade deve ser especificada se os Nós de Computação no Pool precisarem ter discos de dados vazios anexados a eles. Isso não pode ser atualizado. Cada Nó de Computação obtém seu próprio disco (o disco não é um compartilhamento de arquivos). Os discos existentes não podem ser anexados, cada disco anexado está vazio. Quando o Nó de Computação é removido do Pool, o disco e todos os dados associados a ele também são excluídos. O disco não é formatado após ser anexado, ele deve ser formatado antes do uso – para obter mais informações, consulte https://docs.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux e https://docs.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.

diskEncryptionConfiguration

DiskEncryptionConfiguration

A configuração de criptografia de disco para o pool.
Se especificado, a criptografia é executada em cada nó no pool durante o provisionamento de nós.

extensions

VMExtension[]

A extensão da máquina virtual para o pool.
Se especificado, as extensões mencionadas nessa configuração serão instaladas em cada nó.

imageReference

ImageReference

Uma referência à imagem do Marketplace de Máquinas Virtuais do Azure ou à imagem de máquina virtual personalizada a ser usada.

licenseType

string

O tipo de licença local a ser usado ao implantar o sistema operacional.
Isso só se aplica a imagens que contêm o sistema operacional Windows e só deve ser usado quando você mantém licenças locais válidas para os Nós de Computação 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 Cliente Windows.

nodeAgentSKUId

string

A SKU do agente do Nó de Computação em Lote a ser provisionada em Nós de Computação no Pool.
O agente do Nó de Computação em Lote é um programa executado em cada Nó de Computação no Pool e fornece a interface de comando e controle entre o Nó de Computação e o serviço do Lote. Há diferentes implementações do agente do Nó de Computação, conhecido como SKUs, para sistemas operacionais diferentes. Você deve especificar um SKU do agente do Nó de Computação que corresponda à referência de imagem selecionada. Para obter a lista de SKUs de agente do Nó de Computação com suporte, juntamente com sua lista de referências de imagem verificadas, consulte a operação "Listar SKUs de agente de nó de computação com suporte".

nodePlacementConfiguration

NodePlacementConfiguration

A configuração de posicionamento do nó para o pool.
Essa configuração especificará regras sobre como os nós no pool serão alocados fisicamente.

osDisk

OSDisk

Configurações do disco do sistema operacional da Máquina Virtual.

securityProfile

SecurityProfile

Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais.
Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais.

serviceArtifactReference

ServiceArtifactReference

Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de dimensionamento ao usar a versão de imagem 'mais recente'.
A ID de referência do artefato de serviço na forma de /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

windowsConfiguration

WindowsConfiguration

Configurações do sistema operacional Windows na máquina virtual.
Essa propriedade não deve ser especificada se a propriedade imageReference especificar uma imagem do sistema operacional Linux.

VMDiskSecurityProfile

Especifica as configurações de perfil de segurança para o disco gerenciado. Observação: ele só pode ser definido para VMs confidenciais e necessário ao usar VMs confidenciais.

Nome Tipo Description
securityEncryptionType

SecurityEncryptionTypes

Especifica o EncryptionType do disco gerenciado. Ele é definido como VMGuestStateOnly para criptografia apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado de firmware no blob VMGuestState. Observação: ele pode ser definido apenas para VMs confidenciais e é necessário ao usar VMs confidenciais.

VMExtension

A configuração para extensões de máquina virtual.

Nome Tipo Description
autoUpgradeMinorVersion

boolean

Indica se a extensão deve usar uma versão secundária mais recente se uma estiver disponível no momento da implantação. Uma vez implantada, no entanto, a extensão não atualizará versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como true.

enableAutomaticUpgrade

boolean

Indica se a extensão deve ser atualizada automaticamente pela plataforma se houver uma versão mais recente da extensão disponível.

name

string

O nome da extensão da máquina virtual.

protectedSettings

object

A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida.

provisionAfterExtensions

string[]

A coleção de nomes de extensão.
Coleção de nomes de extensão após o qual essa extensão precisa ser provisionada.

publisher

string

O nome do editor do manipulador de extensão.

settings

object

Configurações públicas formatadas em JSON para a extensão.

type

string

O tipo da extensão.

typeHandlerVersion

string

A versão do manipulador de script.

WindowsConfiguration

Configurações do sistema operacional Windows a serem aplicadas à máquina virtual.

Nome Tipo Description
enableAutomaticUpdates

boolean

Se as atualizações automáticas estão habilitadas na máquina virtual.
Se omitido, o valor padrão será true.

WindowsUserConfiguration

Propriedades usadas para criar uma conta de usuário em um Nó de Computação do Windows.

Nome Tipo Description
loginMode

LoginMode

O modo de logon do usuário
O padrão é 'batch'.