Pools - Create Pool
Cria um Pool para a 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 {endpoint}/pools?api-version=2025-06-01
POST {endpoint}/pools?api-version=2025-06-01&timeOut={timeOut}
Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Ponto de extremidade da conta do Lote (por exemplo: https://batchaccount.eastus2.batch.azure.com). |
|
api-version
|
query | True |
string minLength: 1 |
A versão da API a ser usada para esta operação. |
|
time
|
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 em seu lugar.". |
Cabeçalho da solicitação
Media Types: "application/json; odata=minimalmetadata"
| Nome | Obrigatório | Tipo | Description |
|---|---|---|---|
| client-request-id |
string |
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-rfc7231) |
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 os tamanhos de VM disponíveis para pools usando imagens do Marketplace de Máquinas Virtuais (pools criados com virtualMachineConfiguration), consulte Tamanhos para máquinas virtuais no Azure (https://v4.hkg1.meaqua.org/azure/virtual-machines/sizes/overview). 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 |
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 (duration) |
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://v4.hkg1.meaqua.org/azure/batch/batch-automatic-scaling). |
|
| 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 |
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 |
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 |
A configuração de rede do Pool. |
||
| resizeTimeout |
string (duration) |
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). |
|
| 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 (int32) |
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 (int32) |
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. |
|
| 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 (int32) |
O número de slots de tarefas que podem ser usados para executar tarefas simultâneas em um único nó de computação no pool. O valor padrão é 1. O valor máximo é o menor de 4 vezes o número de núcleos do vmSize do pool ou 256. |
|
| upgradePolicy |
A política de atualização do Pool. Descreve uma política de atualização – automática, manual ou sem interrupção. |
||
| userAccounts |
A lista de contas de usuário a serem criadas em cada Nó de Computação no Pool. |
||
| virtualMachineConfiguration |
A configuração da máquina virtual para o Pool. Essa propriedade deve ser especificada. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 201 Created |
A solicitação foi bem-sucedida e um novo recurso foi criado como resultado. Cabeçalhos
|
|
| Other Status Codes |
Uma resposta de erro inesperada. |
Segurança
OAuth2Auth
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Escopos
| Nome | Description |
|---|---|
| https://batch.core.windows.net//.default |
Exemplos
Creates a pool with accelerated networking
Solicitação de exemplo
POST {endpoint}/pools?api-version=2025-06-01
{
"id": "mypool01",
"vmSize": "Standard_D1_v2",
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2025-datacenter-smalldisk",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.windows amd64"
},
"targetDedicatedNodes": 2,
"networkConfiguration": {
"enableAcceleratedNetworking": true
}
}
Resposta de exemplo
Creates a pool with confidential disk encryption set for user subscription accounts
Solicitação de exemplo
POST {endpoint}/pools?api-version=2025-06-01
{
"id": "pool",
"vmSize": "Standard_DC2as_v5",
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2019-datacenter-core-g2",
"version": "latest"
},
"osDisk": {
"managedDisk": {
"storageAccountType": "standard_lrs",
"diskEncryptionSet": {
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
},
"securityProfile": {
"securityEncryptionType": "DiskWithVMGuestState"
}
}
},
"dataDisks": [
{
"lun": 0,
"diskSizeGB": 1024,
"managedDisk": {
"storageAccountType": "standard_lrs",
"diskEncryptionSet": {
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
}
}
}
],
"securityProfile": {
"securityType": "confidentialvm",
"uefiSettings": {
"vTpmEnabled": true,
"secureBootEnabled": true
}
},
"nodeAgentSKUId": "batch.node.windows amd64"
},
"targetDedicatedNodes": 1
}
Resposta de exemplo
Creates a pool with disk encryption set for user subscription accounts
Solicitação de exemplo
POST {endpoint}/pools?api-version=2025-06-01
{
"id": "pool",
"vmSize": "Standard_D2ds_v5",
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2019-datacenter-core-g2",
"version": "latest"
},
"osDisk": {
"managedDisk": {
"storageAccountType": "standard_lrs",
"diskEncryptionSet": {
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
}
}
},
"dataDisks": [
{
"lun": 0,
"diskSizeGB": 1024,
"managedDisk": {
"storageAccountType": "standard_lrs",
"diskEncryptionSet": {
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
}
}
}
],
"nodeAgentSKUId": "batch.node.windows amd64"
},
"targetDedicatedNodes": 1
}
Resposta de exemplo
Creates a pool with dual stack networking
Solicitação de exemplo
POST {endpoint}/pools?api-version=2025-06-01
{
"id": "dualstackpool",
"vmSize": "Standard_D2ds_v5",
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "ubuntu-24_04-lts",
"sku": "server"
},
"nodeAgentSKUId": "batch.node.ubuntu 20.04"
},
"networkConfiguration": {
"publicIPAddressConfiguration": {
"ipFamilies": [
"IPv4",
"IPv6"
]
},
"endpointConfiguration": {
"inboundNATPools": [
{
"backendPort": 22,
"frontendPortRangeStart": 40000,
"frontendPortRangeEnd": 40500,
"name": "sshpool",
"protocol": "tcp",
"networkSecurityGroupRules": [
{
"access": "allow",
"priority": 1000,
"sourceAddressPrefix": "*",
"sourcePortRanges": [
"*"
]
}
]
}
]
}
},
"resizeTimeout": "PT15M",
"targetDedicatedNodes": 1,
"targetLowPriorityNodes": 0
}
Resposta de exemplo
Creates a pool with mount drive specified
Solicitação de exemplo
POST {endpoint}/pools?api-version=2025-06-01
{
"id": "pool2",
"vmSize": "Standard_D4d_v5",
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "ubuntu-24_04-lts",
"sku": "server"
},
"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
Creates a pool with SecurityProfile
Solicitação de exemplo
POST {endpoint}/pools?api-version=2025-06-01
{
"id": "mypool001",
"vmSize": "STANDARD_DC2s_V2",
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "ubuntu-24_04-lts",
"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
Creates a VirtualMachineConfiguration pool
Solicitação de exemplo
POST {endpoint}/pools?api-version=2025-06-01
{
"id": "pool2",
"vmSize": "Standard_D4d_v5",
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "ubuntu-24_04-lts",
"sku": "server"
},
"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
Creates a VirtualMachineConfiguration pool with containers
Solicitação de exemplo
POST {endpoint}/pools?api-version=2025-06-01
{
"id": "pool2",
"vmSize": "Standard_D4d_v5",
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "ubuntu-24_04-lts",
"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
Creates a VirtualMachineConfiguration pool with extensions
Solicitação de exemplo
POST {endpoint}/pools?api-version=2025-06-01
{
"id": "pool2",
"vmSize": "Standard_D4d_v5",
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "ubuntu-24_04-lts",
"sku": "server"
},
"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"
}
]
}
Resposta de exemplo
Creates a VirtualMachineConfiguration pool with OS disk
Solicitação de exemplo
POST {endpoint}/pools?api-version=2025-06-01
{
"id": "mypool001",
"vmSize": "Standard_D2ds_v5",
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "ubuntu-24_04-lts",
"sku": "server"
},
"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
Creates a VirtualMachineConfiguration pool with ServiceArtifactReference
Solicitação de exemplo
POST {endpoint}/pools?api-version=2025-06-01
{
"id": "mypool002",
"vmSize": "Standard_D4d_v5",
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2025-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
}
Resposta de exemplo
Definições
| Nome | Description |
|---|---|
|
Automatic |
Os parâmetros de configuração usados para executar a atualização automática do sistema operacional. |
|
Auto |
Enums AutoUserScope |
|
Auto |
Especifica as opções para o usuário automático que executa uma Tarefa do Lote do Azure. |
|
Azure |
Informações usadas para se conectar a um Contêiner de Armazenamento do Azure usando Blobfuse. |
|
Azure |
Informações usadas para se conectar a um compartilhamento de arquivos do Azure. |
|
Batch |
Uma referência a um pacote a ser implantado em Nós de Computação. |
|
Batch |
A configuração para pools habilitados para contêineres. |
|
Batch |
Especifica as Configurações de Disco efêmero para o disco do sistema operacional usado pela VM (nó de computação). |
|
Batch |
Uma resposta de erro recebida do serviço do Lote do Azure. |
|
Batch |
Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure. |
|
Batch |
Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure. |
|
Batch |
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. |
|
Batch |
Enums BatchJobDefaultOrder |
|
Batch |
O serviço do Lote não atribui nenhum significado a esses metadados; é apenas para o uso do código do usuário. |
|
Batch |
Enums BatchNodeFillType |
|
Batch |
A referência a uma identidade atribuída pelo usuário associada ao pool do Lote que um nó de computação usará. |
|
Batch |
Para posicionamento regional, os nós no pool serão alocados na mesma região. Para o posicionamento zonal, os nós no pool serão distribuídos entre diferentes zonas com melhor balanceamento de esforço. |
|
Batch |
Emums BatchNodePlacementPolicyType |
|
Batch |
Configurações do disco do sistema operacional do nó de computação (VM). |
|
Batch |
Parâmetros para criar um Pool de Lotes do Azure. |
|
Batch |
A configuração do ponto de extremidade para um pool. |
|
Batch |
A referência de uma das identidades do pool para criptografar o disco. Essa identidade será usada para acessar o cofre de chaves. |
|
Batch |
A configuração de endereço IP público da configuração de rede de um pool. |
|
Batch |
O Lote tentará novamente tarefas quando uma operação de recuperação for disparada em um nó. Exemplos de operações de recuperação incluem (mas não se limitam a) quando um nó não íntegro é reinicializado ou um Nó de Computação desapareceu devido a uma falha de host. As novas tentativas devido às operações de recuperação são independentes e não são contadas em relação ao maxTaskRetryCount. Mesmo que o maxTaskRetryCount seja 0, uma repetição interna devido a uma operação de recuperação poderá ocorrer. Por isso, todas as tarefas devem ser idempotentes. Isso significa que as tarefas precisam tolerar ser interrompidas e reiniciadas sem causar dados corrompidos ou duplicados. A melhor prática para tarefas de execução longa é usar alguma forma de ponto de verificação. Em alguns casos, o StartTask pode ser executado novamente, mesmo que o Nó de Computação não tenha sido reinicializado. Deve-se tomar cuidado especial para evitar StartTasks que criam o processo de separação ou instalam/iniciam serviços do diretório de trabalho StartTask, pois isso impedirá que o Lote seja capaz de executar novamente o StartTask. |
|
Batch |
As configurações de contêiner de uma Tarefa. |
|
Batch |
Especifica como as tarefas devem ser distribuídas entre nós de computação. |
|
Batch |
Especifica as configurações de segurança, como inicialização segura e vTPM usadas durante a criação da máquina virtual. |
|
Batch |
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. |
|
Batch |
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'. |
|
Caching |
Enums CachingType |
|
Cifs |
Informações usadas para se conectar a um sistema de arquivos CIFS. |
|
Container |
A entrada do caminho e do modo de montagem que você deseja montar no contêiner de tarefas. |
|
Container |
Os caminhos que serão montados no contêiner da tarefa de contêiner. |
|
Container |
Um registro de contêiner privado. |
|
Container |
Enums ContainerType |
|
Container |
ContainerWorkingDirectory enums |
|
Data |
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. |
|
Diff |
Especifica a posição efêmera do disco do sistema operacional para todos os nós de computação (VMs) do pool. Essa propriedade pode ser usada pelo usuário na solicitação para escolher em qual local o sistema operacional deve estar. Por exemplo, armazene espaço em disco em cache para provisionamento de disco do sistema operacional efêmero. Para mais informações sobre requisitos de tamanho de disco do Sistema Operacional Efemero, consulte os requisitos de tamanho de disco para VMs Windows em https://v4.hkg1.meaqua.org/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e VMs Linux em https://v4.hkg1.meaqua.org/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements |
|
Disk |
A referência de Chave Gerenciada pelo Cliente para criptografar o Disco. |
|
Disk |
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. |
|
Disk |
A ID do recurso ARM do conjunto de criptografia de disco. |
|
Disk |
Enums DiskEncryptionTarget |
|
Dynamic |
DynamicVNetAssignmentScope enums |
|
Elevation |
Enums de Elevação |
|
Environment |
Uma variável de ambiente a ser definida em um processo de tarefa. |
|
Host |
Especifica configurações específicas do ponto de extremidade do host. |
|
Host |
HostEndpointSettingsModeTypes enums |
|
Inbound |
InboundEndpointProtocol enums |
|
Ip |
IPAddressProvisioningType enums |
| IPFamily |
As famílias de IP usadas para especificar as versões de IP disponíveis para o pool. |
| IPTag |
Contém a marca IP associada ao endereço IP público. |
|
Linux |
Propriedades usadas para criar uma conta de usuário em um Nó de Computação do Linux. |
|
Login |
Enums LoginMode |
|
Managed |
Os parâmetros de disco gerenciado. |
|
Mount |
O sistema de arquivos a ser montado em cada nó. |
|
Network |
A configuração de rede de um pool. |
|
Network |
Uma regra de grupo de segurança de rede a ser aplicada a um ponto de extremidade de entrada. |
|
Network |
NetworkSecurityGroupRuleAccess enums |
|
Nfs |
Informações usadas para se conectar a um sistema de arquivos NFS. |
|
Proxy |
Especifica as configurações de ProxyAgent ao criar a máquina virtual. |
|
Resource |
Um único arquivo ou vários arquivos a serem baixados em um Nó de Computação. |
|
Rolling |
Os parâmetros de configuração usados durante a execução de uma atualização sem interrupção. |
|
Security |
Enums SecurityEncryptionTypes |
|
Security |
Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais. |
|
Security |
Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings. |
|
Service |
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'. |
|
Storage |
Enumerações StorageAccountType |
|
Upgrade |
Enums UpgradeMode |
|
Upgrade |
Descreve uma política de atualização – automática, manual ou sem interrupção. |
|
User |
Propriedades usadas para criar um usuário usado para executar Tarefas em um Nó de Computação em Lote do Azure. |
|
User |
A definição da identidade do usuário na qual a Tarefa é executada. Especifique a propriedade userName ou autoUser, mas não ambas. |
|
Virtual |
A configuração para nós de computação em um pool com base na infraestrutura de Máquinas Virtuais do Azure. |
| VMExtension |
A configuração para extensões de máquina virtual. |
|
Windows |
Configurações do sistema operacional Windows a serem aplicadas à máquina virtual. |
|
Windows |
Propriedades usadas para criar uma conta de usuário em um Nó de Computação do Windows. |
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. |
| 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
Enums AutoUserScope
| Valor | Description |
|---|---|
| task |
Especifica que o serviço deve criar um novo usuário para a Tarefa. |
| pool |
Especifica que a Tarefa roda como a conta de usuário automático comum, criada em cada Nó de Computação em um Pool. |
AutoUserSpecification
Especifica as opções para o usuário automático que executa uma Tarefa do Lote do Azure.
| Nome | Tipo | Description |
|---|---|---|
| elevationLevel |
O nível de elevação do usuário automático. O valor padrão é nonAdmin. |
|
| scope |
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 forma que possa afetar outras tarefas. |
AzureBlobFileSystemConfiguration
Informações usadas para se conectar a um Contêiner de Armazenamento do Azure usando Blobfuse.
| Nome | Tipo | Description |
|---|---|---|
| accountKey |
string (password) |
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 |
A referência à identidade atribuída pelo usuário para usar para acessar o ContainerName. Essa propriedade é mutuamente exclusiva com accountKey e sasKey; exatamente um deve ser especificado. |
|
| relativeMountPath |
string |
O caminho relativo no nó de computação onde 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 (password) |
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 (password) |
A chave da conta de Armazenamento do Azure. |
| accountName |
string |
O nome da conta de Armazenamento do Azure. |
| azureFileUrl |
string (uri) |
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 onde 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. |
BatchApplicationPackageReference
Uma referência a um pacote a ser implantado em Nós de Computação.
| Nome | Tipo | Description |
|---|---|---|
| applicationId |
string |
O 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 esta aplicação, a solicitação falha 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 essa aplicação, a tarefa falha com um erro de pré-processamento. |
BatchContainerConfiguration
A configuração para pools habilitados para contêineres.
| Nome | Tipo | Description |
|---|---|---|
| containerImageNames |
string[] |
A coleção de nomes de imagens dos contêineres. Esta é a referência completa da Imagem, conforme especificado para "docker pull". Uma Imagem será obtida a partir do registro padrão do Docker, a menos que a Imagem esteja totalmente qualificada em um registro alternativo. |
| containerRegistries |
Registros privados adicionais dos quais os contêineres podem ser extraídos. Se alguma Imagem precisa ser baixada de um registro privado que exige credenciais, então essas credenciais devem ser fornecidas aqui. |
|
| type |
A tecnologia de contêiner a ser usada. |
BatchDiffDiskSettings
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 |
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://v4.hkg1.meaqua.org/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e Linux em https://v4.hkg1.meaqua.org/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. |
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 |
Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário. |
|
| values |
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. |
BatchErrorMessage
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. |
BatchInboundNatPool
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 (int32) |
O número da porta no Nó de Computação. Isso deve ser único dentro de um Batch Pool. Os valores aceitáveis estão entre 1 e 65535, exceto 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 (int32) |
O último número de porta na faixa 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 pelo serviço do Lote. Todos os intervalos dentro de um Pool devem ser distintos e não podem se sobrepor. Cada faixa 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 (int32) |
O primeiro número de porta na faixa 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 dentro de um Pool devem ser distintos e não podem se sobrepor. Cada faixa 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 único dentro de um Batch Pool, podendo conter letras, números, sublinhatões, pontos e hífens. 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 |
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 endpoints de um Batch Pool é 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 |
O protocolo do ponto de extremidade. |
BatchJobDefaultOrder
Enums BatchJobDefaultOrder
| Valor | Description |
|---|---|
| none |
As tarefas devem ser agendadas uniformemente a partir de todos os trabalhos de prioridade igual para o pool. |
| creationtime |
Se os trabalhos têm prioridade igual, tarefas de cargos criados anteriormente devem ser agendadas primeiro. |
BatchMetadataItem
O serviço do Lote não atribui nenhum significado a esses metadados; é apenas para o uso do código do usuário.
| Nome | Tipo | Description |
|---|---|---|
| name |
string |
O nome do item de metadados. |
| value |
string |
O valor do item de metadados. |
BatchNodeFillType
Enums BatchNodeFillType
| Valor | Description |
|---|---|
| spread |
As tarefas devem ser distribuídas de forma uniforme entre todos os Nós de Computação do Pool. |
| pack |
O maior número possível de Tarefas (taskSlotsPerNode) deve ser atribuído a cada Nó de Computação do Pool antes que qualquer Tarefa seja atribuída ao próximo Nó de Computação do Pool. |
BatchNodeIdentityReference
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 (arm-id) |
A ID de recurso do ARM da identidade atribuída pelo usuário. |
BatchNodePlacementConfiguration
Para posicionamento regional, os nós no pool serão alocados na mesma região. Para o posicionamento zonal, os nós no pool serão distribuídos entre diferentes zonas com melhor balanceamento de esforço.
| Nome | Tipo | Description |
|---|---|---|
| policy |
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. |
BatchNodePlacementPolicyType
Emums BatchNodePlacementPolicyType
| Valor | Description |
|---|---|
| regional |
Todos os nós no pool serão alocados na mesma região. |
| zonal |
Os nós do pool estarão espalhados por diferentes zonas de disponibilidade com melhor equilíbrio de esforço. |
BatchOsDisk
Configurações do disco do sistema operacional do nó de computação (VM).
| Nome | Tipo | Description |
|---|---|---|
| caching |
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. |
|
| diskSizeGB |
integer (int32) |
O tamanho inicial do disco em GB ao criar um novo disco do sistema operacional. |
| ephemeralOSDiskSettings |
Especifica as Configurações de Disco efêmero para o disco do sistema operacional usado pela VM (nó de computação). |
|
| managedDisk |
Os parâmetros de disco gerenciado. |
|
| writeAcceleratorEnabled |
boolean |
Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco. |
BatchPoolCreateOptions
Parâmetros para criar um Pool de Lotes do Azure.
| Nome | Tipo | Description |
|---|---|---|
| applicationPackageReferences |
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 (duration) |
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://v4.hkg1.meaqua.org/azure/batch/batch-automatic-scaling). |
| 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 |
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 |
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 |
A configuração de rede do Pool. |
|
| resizeTimeout |
string (duration) |
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). |
| 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 (int32) |
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 (int32) |
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. |
| 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 (int32) |
O número de slots de tarefas que podem ser usados para executar tarefas simultâneas em um único nó de computação no pool. O valor padrão é 1. O valor máximo é o menor de 4 vezes o número de núcleos do vmSize do pool ou 256. |
| upgradePolicy |
A política de atualização do Pool. Descreve uma política de atualização – automática, manual ou sem interrupção. |
|
| userAccounts |
A lista de contas de usuário a serem criadas em cada Nó de Computação no Pool. |
|
| virtualMachineConfiguration |
A configuração da máquina virtual para o Pool. 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 os tamanhos de VM disponíveis para pools usando imagens do Marketplace de Máquinas Virtuais (pools criados com virtualMachineConfiguration), consulte Tamanhos para máquinas virtuais no Azure (https://v4.hkg1.meaqua.org/azure/virtual-machines/sizes/overview). 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). |
BatchPoolEndpointConfiguration
A configuração do ponto de extremidade para um pool.
| Nome | Tipo | Description |
|---|---|---|
| inboundNATPools |
Uma lista de NAT Pools de entrada que podem ser usados para endereçar portas específicas em um Nó de Computação individual externamente. O número máximo de NAT Pools de entrada por Batch Pool é 5. Se o número máximo de NAT Pools de entrada for ultrapassado, a solicitação falha com o código de status HTTP 400. Isso não poderá ser especificado se o IPAddressProvisioningType for NoPublicIPAddresses. |
BatchPoolIdentityReference
A referência de uma das identidades do pool para criptografar o disco. Essa identidade será usada para acessar o cofre de chaves.
| Nome | Tipo | Description |
|---|---|---|
| resourceId |
string (arm-id) |
A ID de recurso do ARM da identidade atribuída pelo usuário. Essa referência deve ser incluída nas identidades do pool. |
BatchPublicIpAddressConfiguration
A configuração de endereço IP público da configuração de rede de um pool.
| Nome | Tipo | Description |
|---|---|---|
| ipAddressIds |
string[] (arm-id) |
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}. |
| ipFamilies |
IPFamily[] |
As famílias de IP usadas para especificar as versões de IP disponíveis para o pool. As famílias de IP são usadas para determinar pools de pilha única ou dupla. Para pilha única, o valor esperado é IPv4. Para pilha dupla, os valores esperados são IPv4 e IPv6. |
| ipTags |
IPTag[] |
Uma lista de marcas IP associadas aos endereços IP públicos do Pool. As tags IP são usadas para categorizar e filtrar endereços IP públicos para fins de cobrança e gerenciamento. |
| provision |
O tipo de provisionamento para endereços IP públicos para o pool. O valor padrão é BatchManaged. |
BatchStartTask
O Lote tentará novamente tarefas quando uma operação de recuperação for disparada em um nó. Exemplos de operações de recuperação incluem (mas não se limitam a) quando um nó não íntegro é reinicializado ou um Nó de Computação desapareceu devido a uma falha de host. As novas tentativas devido às operações de recuperação são independentes e não são contadas em relação ao maxTaskRetryCount. Mesmo que o maxTaskRetryCount seja 0, uma repetição interna devido a uma operação de recuperação poderá ocorrer. Por isso, todas as tarefas devem ser idempotentes. Isso significa que as tarefas precisam tolerar ser interrompidas e reiniciadas sem causar dados corrompidos ou duplicados. A melhor prática para tarefas de execução longa é usar alguma forma de ponto de verificação. Em alguns casos, o StartTask pode ser executado novamente, mesmo que o Nó de Computação não tenha sido reinicializado. Deve-se tomar cuidado especial para evitar StartTasks que criam o processo de separação ou instalam/iniciam serviços do diretório de trabalho StartTask, pois isso impedirá que o Lote seja capaz de executar novamente o StartTask.
| 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://v4.hkg1.meaqua.org/azure/batch/batch-compute-node-environment-variables). |
| containerSettings |
As configurações do contêiner sob o qual o StartTask roda. Quando isso é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios Batch do Azure no nó) são mapeados no contêiner, todas as variáveis do ambiente Tarefa são mapeadas no contêiner, e a linha de comando Tarefa é executada no contêiner. Arquivos produzidos no contêiner fora do AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos no disco hospedeiro, o que significa que APIs de arquivos Batch não conseguirão acessar esses arquivos. |
|
| environmentSettings |
Uma lista de configurações de variável de ambiente para o StartTask. |
|
| maxTaskRetryCount |
integer (int32) |
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 |
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 |
A identidade do usuário sob a qual o StartTask é executado. Se omitida, a Tarefa roda como um usuário não administrativo exclusivo da 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. |
BatchTaskContainerSettings
As configurações de contêiner de uma Tarefa.
| Nome | Tipo | Description |
|---|---|---|
| containerHostBatchBindMounts |
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 onde a tarefa será executada. Esta é a referência completa da Imagem, conforme especificado para "docker pull". Se nenhuma tag for fornecida como parte do nome da Imagem, a tag ":latest" é usada como padrão. |
| registry |
O registro privado que contém a imagem do contêiner. Essa configuração pode ser omitida se já foi fornecida na criação do Pool. |
|
| workingDirectory |
A localização do diretório de trabalho Container Task. O padrão é 'taskWorkingDirectory'. |
BatchTaskSchedulingPolicy
Especifica como as tarefas devem ser distribuídas entre nós de computação.
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| jobDefaultOrder | none |
A ordem para agendar tarefas de diferentes trabalhos com a mesma prioridade. Se não for especificado, o padrão será nenhum. |
|
| nodeFillType |
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. |
BatchUefiSettings
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. |
BatchVmDiskSecurityProfile
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 |
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. |
BatchVmImageReference
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 |
A imagem da galeria comunitária identificador único. 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 difere de 'versão' apenas se o valor especificado para 'versão' quando o pool foi criado fosse 'mais recente'. |
| offer |
string |
O tipo de oferta da Imagem do Marketplace de Máquinas Virtuais Azure. Por exemplo, UbuntuServer ou WindowsServer. |
| publisher |
string |
A editora da Azure Virtual Machines Marketplace Image. Por exemplo, Canonical ou MicrosoftWindowsServer. |
| sharedGalleryImageId |
string |
Identificador único 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 |
O SKU da Imagem do Azure Virtual Machines Marketplace. 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 de 'mais recente' pode ser especificado para selecionar a versão mais recente de uma Imagem. Se omitido, o padrão será 'latest'. |
| virtualMachineImageId |
string (arm-id) |
O identificador de recurso do ARM da Imagem da Galeria de Computação do Azure. Os Nós de Computação no Pool serão criados usando este ID de Imagem. Isso é da forma /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 do ImageReference. A Imagem da Galeria de Computação do Azure deve ter réplicas na mesma região e estar na mesma assinatura da conta Batch do Azure. Se a versão da imagem não for especificada no imageId, a versão mais recente será usada. Para informações sobre as configurações do firewall para o agente do Nó de Computação Batch para se comunicar com o serviço Batch, veja https://v4.hkg1.meaqua.org/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration. |
CachingType
Enums CachingType
| Valor | Description |
|---|---|
| none |
O modo de cache do disco não está habilitado. |
| readonly |
O modo de cache do disco é somente leitura. |
| readwrite |
O modo de cache do disco é leitura e gravação. |
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 (password) |
A senha a ser usada para autenticação no sistema de arquivos CIFS. |
| relativeMountPath |
string |
O caminho relativo no nó de computação onde 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. |
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 |
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.
| Valor | Description |
|---|---|
| Shared |
O caminho para a tarefa de várias instâncias compartilhar seus arquivos. |
| Startup |
O caminho para iniciar a tarefa. |
| VfsMounts |
O caminho contém todos os sistemas de arquivos virtuais montados neste nó. |
| Task |
O caminho da tarefa. |
| JobPrep |
O caminho da tarefa de preparação do trabalho. |
| Applications |
O caminho dos aplicativos. |
ContainerRegistryReference
Um registro de contêiner privado.
| Nome | Tipo | Description |
|---|---|---|
| identityReference |
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. |
|
| password |
string (password) |
A senha para fazer logon no servidor do Registro. |
| registryServer |
string (uri) |
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
Enums ContainerType
| Valor | Description |
|---|---|
| dockerCompatible |
Uma tecnologia de contêiner compatível com o Docker será usada para iniciar os contêineres. |
| criCompatible |
Uma tecnologia baseada em CRI será usada para iniciar os contêineres. |
ContainerWorkingDirectory
ContainerWorkingDirectory enums
| Valor | Description |
|---|---|
| taskWorkingDirectory |
Use o diretório padrão de trabalho de Tarefas do serviço Batch, que conterá os Arquivos de Recursos de Tarefas preenchidos por Batch. |
| containerImageDefault |
Use o diretório de trabalho definido na imagem do contêiner. Atenção, este diretório não conterá os Arquivos de Recursos baixados pelo Batch. |
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 |
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 (int32) |
O tamanho inicial do disco em gigabytes. |
| lun |
integer (int32) |
O número da unidade lógica. O logicalUnitNumber é usado para identificar exclusivamente cada disco de dados. Se estiver anexando vários discos, cada um deve ter um logicalUnitNumber distinto. O valor deve estar entre 0 e 63, inclusive. |
| managedDisk |
Os parâmetros de disco gerenciado. |
|
| 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 a posição efêmera do disco do sistema operacional para todos os nós de computação (VMs) do pool. Essa propriedade pode ser usada pelo usuário na solicitação para escolher em qual local o sistema operacional deve estar. Por exemplo, armazene espaço em disco em cache para provisionamento de disco do sistema operacional efêmero. Para mais informações sobre requisitos de tamanho de disco do Sistema Operacional Efemero, consulte os requisitos de tamanho de disco para VMs Windows em https://v4.hkg1.meaqua.org/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e VMs Linux em https://v4.hkg1.meaqua.org/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements
| Valor | Description |
|---|---|
| cachedisk |
O Disco do SO Efêmero é armazenado no cache da VM. |
DiskCustomerManagedKey
A referência de Chave Gerenciada pelo Cliente para criptografar o Disco.
| Nome | Tipo | Description |
|---|---|---|
| identityReference |
A referência de uma das identidades do pool para criptografar o disco. Essa identidade será usada para acessar o KeyVault. |
|
| keyUrl |
string |
Url de chave totalmente com versão apontando para uma chave no KeyVault. O segmento de versão da URL é necessário independentemente do valor rotationToLatestKeyVersionEnabled. |
| rotationToLatestKeyVersionEnabled |
boolean |
Defina esse sinalizador como true para habilitar a atualização automática da Criptografia de Disco para a versão mais recente da chave. O padrão é false. |
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 |
|---|---|---|
| customerManagedKey |
A referência de Chave Gerenciada pelo Cliente para criptografar o disco do sistema operacional. A Chave Gerenciada pelo Cliente criptografará o disco do sistema operacional por EncryptionAtRest e, por padrão, também criptografaremos o disco de dados. Ele só pode ser usado quando o pool está configurado com uma identidade e o OsDisk está definido como um dos destinos do DiskEncryption. |
|
| targets |
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. |
DiskEncryptionSetParameters
A ID do recurso ARM do conjunto de criptografia de disco.
| Nome | Tipo | Description |
|---|---|---|
| id |
string (arm-id) |
A ID do recurso ARM do conjunto de criptografia de disco. O recurso deve estar na mesma assinatura que a conta do Lote. |
DiskEncryptionTarget
Enums DiskEncryptionTarget
| Valor | Description |
|---|---|
| osdisk |
O disco do sistema operacional no nó de computação é criptografado. |
| temporarydisk |
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
DynamicVNetAssignmentScope enums
| Valor | Description |
|---|---|
| none |
Nenhuma atribuição de VNet dinâmica está habilitada. |
| job |
A atribuição de VNet dinâmica é feita por trabalho. |
ElevationLevel
Enums de Elevação
| Valor | Description |
|---|---|
| nonadmin |
O usuário é um usuário padrão sem acesso elevado. |
| admin |
O usuário é um usuário com acesso elevado e opera com permissões de Administrador completas. |
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. |
HostEndpointSettings
Especifica configurações específicas do ponto de extremidade do host.
| Nome | Tipo | Description |
|---|---|---|
| inVMAccessControlProfileReferenceId |
string |
Especifica a referência à ID do recurso InVMAccessControlProfileVersion na forma de /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}. |
| mode |
Especifica o modo de execução da política de controle de acesso. |
HostEndpointSettingsModeTypes
HostEndpointSettingsModeTypes enums
| Valor | Description |
|---|---|
| Audit |
No modo auditoria, o sistema atua como se estivesse impondo a política de controle de acesso, incluindo a emissão de entradas de negação de acesso nos logs, mas não nega nenhuma solicitação para hospedar pontos de extremidade. |
| Enforce |
O modo de aplicação é o modo de operação recomendado e o sistema irá aplicar a política de controle de acesso. Essa propriedade não pode ser usada junto com 'inVMAccessControlControlProfileReferenceId'. |
InboundEndpointProtocol
InboundEndpointProtocol enums
| Valor | Description |
|---|---|
| tcp |
Use TCP para o ponto de extremidade. |
| udp |
Use UDP para o ponto de extremidade. |
IpAddressProvisioningType
IPAddressProvisioningType enums
| Valor | Description |
|---|---|
| batchmanaged |
Um IP público será criado e gerenciado pelo Lote. Pode haver vários IPs públicos dependendo do tamanho do pool. |
| usermanaged |
Os IPs públicos são fornecidos pelo usuário e serão usados para provisionar os Nós de Computação. |
| nopublicipaddresses |
Nenhum endereço IP público será criado. |
IPFamily
As famílias de IP usadas para especificar as versões de IP disponíveis para o pool.
| Valor | Description |
|---|---|
| IPv4 |
IPv4 está disponível para o pool. |
| IPv6 |
IPv6 está disponível para o pool. |
IPTag
Contém a marca IP associada ao endereço IP público.
| Nome | Tipo | Description |
|---|---|---|
| ipTagType |
string |
O tipo de tag IP. Exemplo: FirstPartyUsage. |
| tag |
string |
O valor da marca IP associada ao IP público. Exemplo: SQL. |
LinuxUserConfiguration
Propriedades usadas para criar uma conta de usuário em um Nó de Computação do Linux.
| Nome | Tipo | Description |
|---|---|---|
| gid |
integer (int32) |
O ID do grupo para a conta do 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 (password) |
A chave privada SSH para a conta do 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 Linux quando a propriedade enableInterNodeCommunication do Pool é verdadeira (ela é ignorada se o enableInterNodeCommunication for falso). Ele faz isso colocando o par de chaves no diretório .ssh do usuário. Se não especificado, o SSH sem senha não é configurado entre os Nós de Computação (nenhuma modificação do diretório .ssh do usuário é feita). |
| uid |
integer (int32) |
O ID de usuário da conta do 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
Enums LoginMode
| Valor | Description |
|---|---|
| batch |
O LOGON32_LOGON_BATCH modo de logon do Win32. O modo de logon em lote é recomendado para processos paralelos de execução prolongada. |
| interactive |
O LOGON32_LOGON_INTERACTIVE modo de logon do Win32. O UAC está ativado nos Pools de Configuração de Máquinas Virtuais do Windows. Se essa opção for usada com uma identidade de usuário elevada em um Pool de Configuração de Máquina Virtual 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 para sempre exigir privilégio máximo. |
ManagedDisk
Os parâmetros de disco gerenciado.
| Nome | Tipo | Description |
|---|---|---|
| diskEncryptionSet |
Especifica a ID do recurso do conjunto de criptografia de disco gerenciado pelo cliente para o disco gerenciado. Ele só pode ser definido no modo UserSubscription. |
|
| securityProfile |
Especifica as configurações de perfil de segurança para o disco gerenciado. |
|
| storageAccountType |
O tipo de conta de armazenamento do disco gerenciado. |
MountConfiguration
O sistema de arquivos a ser montado em cada nó.
| Nome | Tipo | Description |
|---|---|---|
| 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 |
O Compartilhamento de Arquivos do Azure a ser montado em cada nó. Essa propriedade é mutuamente exclusiva com todas as outras propriedades. |
|
| cifsMountConfiguration |
O sistema de arquivos CIFS/SMB a ser montado em cada nó. Essa propriedade é mutuamente exclusiva com todas as outras propriedades. |
|
| 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 |
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://v4.hkg1.meaqua.org/azure/virtual-network/accelerated-networking-overview. |
| endpointConfiguration |
A configuração para endpoints em nós de computação no Batch Pool. |
|
| publicIPAddressConfiguration |
A configuração de IPAddress público para nós de computação no Pool de Lotes. |
|
| subnetId |
string |
O identificador de recurso ARM da sub-rede virtual que os Nós de Computação do Pool irão se juntar. 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 livres suficientes para acomodar o número de Nós de Computação no Pool. Se a sub-rede não tiver endereços IP livres suficientes, o pool vai alocar parcialmente os nós e um erro de redimensionamento ocorre. 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 a comunicação do serviço Batch do Azure para que seja possível 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. Apenas redes virtuais ARM ('Microsoft.Network/virtualNetworks') são suportadas. Se o VNet especificado tiver algum Agrupamento de Segurança de Rede (NSG) associado, então algumas portas reservadas do sistema devem ser habilitadas para comunicação de entrada, incluindo as portas 29876 e 29877. Habilite também conexões de saída para o Armazenamento do Azure na porta 443. Para obter mais detalhes, consulte: https://v4.hkg1.meaqua.org/azure/batch/nodes-and-pools#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 |
A ação que deve ser tomada para um endereço IP especificado, intervalo de sub-rede ou marca. |
|
| priority |
integer (int32) |
A prioridade dessa regra. Prioridades dentro de um Pool devem ser únicas e 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. Valores válidos são '' (para todas as portas de 0 a 65535), uma porta específica (ou seja, 22) ou um intervalo de portas (ex. 100-200). As portas devem estar na faixa de 0 a 65535. Cada entrada nesta coleção não deve sobrepor-se a nenhuma outra entrada (seja um intervalo ou uma porta individual). Se outros valores forem fornecidos, a solicitação falha com o código de status HTTP 400. O valor padrão é ''. |
NetworkSecurityGroupRuleAccess
NetworkSecurityGroupRuleAccess enums
| Valor | Description |
|---|---|
| allow |
Permitir acesso. |
| deny |
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 onde 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. |
ProxyAgentSettings
Especifica as configurações de ProxyAgent ao criar a máquina virtual.
| Nome | Tipo | Description |
|---|---|---|
| enabled |
boolean |
Especifica se o recurso Protocolo de Segurança de Metadados deve ser habilitado na máquina virtual ou no conjunto de dimensionamento de máquinas virtuais. O padrão é False. |
| imds |
Configurações para o ponto de extremidade do IMDS. |
|
| wireServer |
Configurações do ponto de extremidade WireServer. |
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 container de armazenamento está 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 apenas a arquivos sendo baixados para os 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 Linux, então um valor padrão de 0770 é aplicado ao arquivo. |
| filePath |
string |
A localização no Nó de Computação para onde baixar o(s) arquivo(s), relativa 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 (uri) |
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 |
A referência à identidade atribuída pelo usuário para usar para acessar o Azure Blob Storage especificada por storageContainerUrl ou httpUrl. |
|
| storageContainerUrl |
string (uri) |
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 (int32) |
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 (int32) |
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 (int32) |
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 (duration) |
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
Enums SecurityEncryptionTypes
| Valor | Description |
|---|---|
| DiskWithVMGuestState |
EncryptionType do disco gerenciado é definido como DiskWithVMGuestState para criptografia do disco gerenciado junto com o blob VMGuestState. Não é suportado em discos de dados. |
| NonPersistedTPM |
EncryptionType do disco gerenciado é definido como NonPersistedTPM para não persistir o estado do firmware no blob VMGuestState. |
| VMGuestStateOnly |
EncryptionType do disco gerenciado é definido como VMGuestStateOnly para criptografia apenas do blob VMGuestState. |
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://v4.hkg1.meaqua.org/azure/virtual-machines/disk-encryption#supported-vm-sizes. |
| proxyAgentSettings |
Especifica as configurações de ProxyAgent ao criar a máquina virtual. |
|
| securityType |
Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar 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.
| Valor | Description |
|---|---|
| trustedLaunch |
O início confiável protege contra técnicas de ataque avançadas e persistentes. |
| confidentialvm |
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 sobre 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. |
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 |
O ID de referência do artefato de serviço 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} |
StorageAccountType
Enumerações StorageAccountType
| Valor | Description |
|---|---|
| standard_lrs |
O disco de dados deve usar armazenamento com redundância local padrão. |
| premium_lrs |
O disco de dados deve usar armazenamento com redundância local premium. |
| standardssd_lrs |
O disco de dados/disco do sistema operacional deve usar o armazenamento com redundância local do SSD padrão. |
UpgradeMode
Enums UpgradeMode
| Valor | Description |
|---|---|
| automatic |
Todas as máquinas virtuais no conjunto de dimensionamento são atualizadas automaticamente ao mesmo tempo. |
| 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. |
| rolling |
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 |
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 |
Especifica o modo de uma atualização para máquinas virtuais no conjunto de dimensionamento. |
|
| rollingUpgradePolicy |
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 |
O nível de elevação da conta do usuário. O valor padrão é nonAdmin. |
|
| linuxUserConfiguration |
A configuração específica do usuário Linux para a Conta de usuário. Essa propriedade é ignorada se especificada em um Windows Pool. 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 (password) |
A senha da conta de usuário. |
| windowsUserConfiguration |
A configuração específica do usuário do Windows para a Conta de usuário. Essa propriedade só pode ser especificada se o usuário estiver em um Windows Pool. Se não for especificado e estiver em um Windows Pool, o usuário é criado com as opções padrão. |
UserIdentity
A definição da identidade do usuário na qual a Tarefa é executada. Especifique a propriedade userName ou autoUser, mas não ambas.
| Nome | Tipo | Description |
|---|---|---|
| autoUser |
O usuário automático sob o 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 sob a 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 |
A configuração do contêiner para o Pool. Se especificado, a configuração é realizada em cada Nó de Computação do Pool para permitir que as Tarefas sejam executadas em containers. Todas as Tarefas normais e Tarefas do Gerenciador de Jobs rodadas neste Pool devem especificar a propriedade containerSettings, e todas as outras Tarefas podem especificá-la. |
|
| dataDisks |
Data |
A configuração para discos de dados conectados aos Nós de Computação no Pool. Essa propriedade deve ser especificada caso os Nós de Computação do Pool precisem ter discos de dados vazios conectados a eles. Isso não pode ser atualizado. Cada Nó de Computação recebe seu próprio disco (o disco não é um compartilhamento de arquivos). Discos existentes não podem ser conectados, cada disco conectado 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 acoplado, deve ser formatado antes do uso - para mais informações, veja https://v4.hkg1.meaqua.org/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux e https://v4.hkg1.meaqua.org/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. |
| 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 |
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 |
Uma referência à imagem do Marketplace de Máquinas Virtuais do Azure ou à imagem de máquina virtual personalizada a ser usada. |
|
| licenseType |
string |
Isso só se aplica a Imagens que contenham o sistema operacional Windows, e só deve ser usado quando você possui licenças on-premises 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 |
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 |
Configurações do disco do sistema operacional da Máquina Virtual. |
|
| securityProfile |
Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais. |
|
| 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 |
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 Linux OS. |
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 |
O modo de login para o usuário. O padrão é 'batch'. |