Pool - Add

Serviço:

Batch Service

Versão da API:

2024-07-01.20.0

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

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
batchUrl	path	True	string	A URL base para todas as solicitações de serviço do Lote do Azure.
api-version	query	True	string	Versão da API do cliente.
timeout	query		integer int32	O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. Se o valor for maior que 30, o padrão será usado.

Cabeçalho do Pedido

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

Name	Necessário	Tipo	Description
client-request-id		string uuid	A identidade de solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves encaracoladas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se o servidor deve retornar o client-request-id na resposta.
ocp-date		string date-time-rfc1123	A hora em que o pedido foi emitido. As bibliotecas de cliente normalmente definem isso para a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Corpo do Pedido

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

Name	Necessário	Tipo	Description
id	True	string	Uma cadeia de caracteres que identifica exclusivamente o Pool dentro da Conta. O ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hífenes e sublinhados, e não pode conter mais de 64 caracteres. O ID preserva maiúsculas e minúsculas e não diferencia maiúsculas de minúsculas (ou seja, você não pode ter dois IDs de Pool em uma Conta que diferem apenas por maiúsculas e minúsculas).
vmSize	True	string	O tamanho das máquinas virtuais no Pool. Todas as máquinas virtuais em um Pool têm o mesmo tamanho. Para obter informações sobre tamanhos de VM disponíveis, consulte Tamanhos para máquinas virtuais (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) ou Tamanhos para máquinas virtuais (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). O Batch dá suporte a todos os tamanhos de VM do Azure, exceto STANDARD_A0 e aqueles com armazenamento premium (STANDARD_GS, STANDARD_DS e STANDARD_DSV2 séries).
applicationPackageReferences		ApplicationPackageReference[]	A lista de pacotes a serem instalados em cada nó de computação no pool. Ao criar um pool, a ID do aplicativo do pacote deve ser totalmente qualificada (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). As alterações nas referências de Pacote afetam todos os novos Nós que ingressam no Pool, mas não afetam os Nós de Computação que já estão no Pool até que sejam reinicializados ou recriados com imagem. Há um máximo de 10 referências de pacote em qualquer pool.
autoScaleEvaluationInterval		string	O intervalo de tempo no qual ajustar automaticamente o tamanho do Pool de acordo com a fórmula de dimensionamento automático. O valor padrão é 15 minutos. O valor mínimo e máximo são de 5 minutos e 168 horas, respectivamente. Se você especificar um valor inferior a 5 minutos ou superior a 168 horas, o serviço em 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 deve ser especificada se enableAutoScale estiver definido como false. É necessário se enableAutoScale estiver definido como true. A validade da fórmula é verificada antes da criação do Pool. Se a fórmula não for válida, o serviço Lote rejeitará a solicitação com informações de erro detalhadas. Para obter mais informações sobre como especificar essa fórmula, consulte 'Dimensionar automaticamente nós de computação em um pool de lotes do Azure' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).
certificateReferences		CertificateReference[]	A lista de certificados a serem instalados em cada nó de computação no pool. Para nós do Windows, o serviço em lote instala os certificados no armazenamento de certificados e no local especificados. Para nós de computação Linux, os certificados são armazenados em um diretório dentro do diretório de trabalho Tarefa e uma variável de ambiente AZ_BATCH_CERTIFICATES_DIR é fornecida à tarefa para consultar esse local. Para Certificados com visibilidade de 'remoteUser', um diretório 'certs' é criado no diretório base do usuário (por exemplo, /home/{user-name}/certs) e os Certificados são colocados nesse diretório. Aviso: Esta propriedade foi preterida e será removida após fevereiro de 2024. Em vez disso, use o Azure KeyVault Extension.
displayName		string	O nome para exibição do Pool. O nome para exibição não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024.
enableAutoScale		boolean	Se o tamanho do Pool deve ser ajustado automaticamente ao longo do tempo. Se false, pelo menos um dos targetDedicatedNodes e targetLowPriorityNodes deve ser especificado. Se true, a propriedade autoScaleFormula é necessária e o Pool é redimensionado automaticamente de acordo com a fórmula. O valor padrão é false.
enableInterNodeCommunication		boolean	Se o Pool permite a 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. Isto pode fazer com que a Piscina não atinja o tamanho desejado. O valor padrão é false.
metadata		MetadataItem[]	Uma lista de pares nome-valor associados ao Pool como metadados. O serviço Batch não atribui qualquer significado aos metadados; é exclusivamente para o uso do código de usuário.
mountConfiguration		MountConfiguration[]	Monte o armazenamento usando o sistema de arquivos especificado durante toda a vida útil do pool. Monte o armazenamento usando o sistema de arquivos baseado em compartilhamento de arquivos, NFS, CIFS ou Blobfuse do Azure.
networkConfiguration		NetworkConfiguration	A configuração de rede para o Pool. A configuração de rede para um Pool.
resizeTimeout		string	O tempo limite para alocação de nós de computação para o pool. Este tempo limite aplica-se apenas ao dimensionamento manual; ele não tem efeito quando enableAutoScale é definido como true. O valor padrão é 15 minutos. O valor mínimo é de 5 minutos. Se você especificar um valor inferior a 5 minutos, o serviço de lote retornará um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação incorreta).
resourceTags		object	As tags especificadas pelo usuário associadas ao pool. As marcas definidas pelo usuário a serem associadas ao Pool de Lotes do Azure. Quando especificadas, essas marcas são propagadas para os recursos do Azure de suporte associados ao pool. Essa propriedade só pode ser especificada quando a conta Batch foi criada com a propriedade poolAllocationMode definida como 'UserSubscription'.
startTask		StartTask	Uma Tarefa especificada para ser executada em cada Nó de Computação à medida que se junta ao Pool. A Tarefa é executada quando o Nó de Computação é adicionado ao Pool ou quando o Nó de Computação é reiniciado.
targetDedicatedNodes		integer	O número desejado de nós de computação dedicados no pool. Essa propriedade não deve ser especificada se enableAutoScale estiver definido como true. Se enableAutoScale estiver definido como false, você deverá definir targetDedicatedNodes, targetLowPriorityNodes, ou ambos.
targetLowPriorityNodes		integer	O número desejado de nós de computação spot/de baixa prioridade no pool. Essa propriedade não deve ser especificada se enableAutoScale estiver definido como true. Se enableAutoScale estiver definido como false, você deverá definir targetDedicatedNodes, targetLowPriorityNodes, ou ambos.
targetNodeCommunicationMode		NodeCommunicationMode	O modo de comunicação de nó desejado para o pool. Se omitido, o valor padrão é Default.
taskSchedulingPolicy		TaskSchedulingPolicy	Como as tarefas são distribuídas entre nós de computação em um pool. Se não for especificado, o padrão será spread.
taskSlotsPerNode		integer	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		UpgradePolicy	A política de atualização para o Pool. Descreve uma política de atualização - automática, manual ou rolante.
userAccounts		UserAccount[]	A lista de Contas de usuário a serem criadas em cada Nó de Computação no Pool.
virtualMachineConfiguration		VirtualMachineConfiguration	A configuração da máquina virtual para o Pool. Esta propriedade deve ser especificada.

Respostas

Name	Tipo	Description
201 Created		A solicitação para o serviço de lote foi bem-sucedida. Cabeçalhos client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	O erro do serviço de lote.

Segurança

azure_auth

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

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

Âmbitos

Name	Description
user_impersonation	Personificar a sua conta de utilizador

Authorization

Tipo: apiKey
Em: header

Exemplos

Add a pool with accelerated networking

Add a pool with mount drive specified

Add a pool with SecurityProfile

Add a pool with UpgradePolicy

Add a simple pool with resourceTags

Add a VirtualMachineConfiguration pool

Add a VirtualMachineConfiguration pool with containers

Add a VirtualMachineConfiguration pool with extensions

Add a VirtualMachineConfiguration pool with OS disk

Add a VirtualMachineConfiguration pool with ServiceArtifactReference

Add a pool with accelerated networking

Pedido de amostra

HTTP

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



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

Resposta da amostra

Código de estado:

201

Add a pool with mount drive specified

Pedido de amostra

HTTP

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


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

Resposta da amostra

Código de estado:

201

Add a pool with SecurityProfile

Pedido de amostra

HTTP

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



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

Resposta da amostra

Código de estado:

201

Add a pool with UpgradePolicy

Pedido de amostra

HTTP

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



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

Resposta da amostra

Código de estado:

201

Add a simple pool with resourceTags

Pedido de amostra

HTTP

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



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

Resposta da amostra

Código de estado:

201

Add a VirtualMachineConfiguration pool

Pedido de amostra

HTTP

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



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

Resposta da amostra

Código de estado:

201

Add a VirtualMachineConfiguration pool with containers

Pedido de amostra

HTTP

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



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

Resposta da amostra

Código de estado:

201

Add a VirtualMachineConfiguration pool with extensions

Pedido de amostra

HTTP

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



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

Resposta da amostra

Código de estado:

201

Add a VirtualMachineConfiguration pool with OS disk

Pedido de amostra

HTTP

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



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

Resposta da amostra

Código de estado:

201

Add a VirtualMachineConfiguration pool with ServiceArtifactReference

Pedido de amostra

HTTP

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



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

Resposta da amostra

Código de estado:

201

Definições

Name	Description
ApplicationPackageReference	Uma referência a um pacote a ser implantado em nós de computação.
AutomaticOSUpgradePolicy	Os parâmetros de configuração usados para executar a atualização automática do sistema operacional.
AutoUserScope	O escopo para o usuário automático
AutoUserSpecification	Especifica os parâmetros para o usuário automático que executa uma tarefa no serviço em lote.
AzureBlobFileSystemConfiguration	Informações usadas para se conectar a um Contêiner de Armazenamento do Azure usando Blobfuse.
AzureFileShareConfiguration	Informações usadas para se conectar a um compartilhamento de arquivos do Azure.
BatchError	Uma resposta de erro recebida do serviço Batch do Azure.
BatchErrorDetail	Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.
CachingType	O tipo de cache a ser habilitado para o disco.
CertificateReference	Uma referência a um certificado a ser instalado em nós de computação em um pool.
CertificateStoreLocation	O local do armazenamento de certificados no nó de computação no qual instalar o certificado.
CertificateVisibility	Quais Contas de usuário no Nó de Computação devem ter acesso aos dados privados do Certificado.
CIFSMountConfiguration	Informações usadas para se conectar a um sistema de arquivos CIFS.
ComputeNodeFillType	Como as tarefas são distribuídas entre nós de computação em um pool.
ComputeNodeIdentityReference	A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará.
ContainerConfiguration	A configuração para pools habilitados para contêiner.
ContainerHostBatchBindMountEntry	A entrada do caminho e do modo de montagem que você deseja montar no contêiner de tarefas.
ContainerHostDataPath	Os caminhos que serão montados no contêiner da tarefa do contêiner.
ContainerRegistry	Um registro de contêiner privado.
ContainerType	A tecnologia de contentores a utilizar.
ContainerWorkingDirectory	O local do diretório de trabalho da tarefa do contêiner.
DataDisk	Configurações que serão usadas pelos discos de dados associados aos nós de computação no pool. Ao usar discos de dados anexados, você precisa montar e formatar os discos de dentro de uma VM para usá-los.
DiffDiskPlacement	Especifica o posicionamento efêmero do disco do sistema operacional para todos os nós de computação (VMs) no pool.
DiffDiskSettings	Especifica as configurações de disco efêmeras para o disco do sistema operacional usado pelo nó de computação (VM).
DiskEncryptionConfiguration	A configuração de criptografia de disco aplicada em nós de computação no pool. A configuração de criptografia de disco não é suportada no pool Linux criado com a Imagem da Galeria de Computação do Azure.
DiskEncryptionTarget	A lista de destinos de disco do Serviço em Lote será criptografada no nó de computação.
DynamicVNetAssignmentScope	O escopo da atribuição dinâmica de vnet.
ElevationLevel	O nível de elevação do usuário.
EnvironmentSetting	Uma variável de ambiente a ser definida em um processo Task.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
ImageReference	Uma referência a uma Imagem do Azure Virtual Machines Marketplace 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 suportadas'.
InboundEndpointProtocol	O protocolo do ponto de extremidade.
InboundNATPool	Um pool NAT de entrada que pode ser usado para endereçar portas específicas em nós de computação em um pool de lotes externamente.
IPAddressProvisioningType	O tipo de provisionamento para endereços IP públicos para o pool.
LinuxUserConfiguration	Propriedades usadas para criar uma conta de usuário em um nó de computação Linux.
LoginMode	O modo de login para o usuário
ManagedDisk
MetadataItem	Um par nome-valor associado a um recurso de serviço em lote.
MountConfiguration	O sistema de arquivos a ser montado em cada nó.
NetworkConfiguration	A configuração de rede para um Pool.
NetworkSecurityGroupRule	Uma regra de grupo de segurança de rede a ser aplicada a um ponto de extremidade de entrada.
NetworkSecurityGroupRuleAccess	A ação que deve ser tomada para um endereço IP, intervalo de sub-rede ou tag especificado.
NFSMountConfiguration	Informações usadas para se conectar a um sistema de arquivos NFS.
NodeCommunicationMode	Determina como um pool se comunica com o serviço de lote.
NodePlacementConfiguration	Configuração de posicionamento de nó para um pool.
NodePlacementPolicyType	A política de posicionamento para alocar nós no pool.
OSDisk	Configurações para o disco do sistema operacional do nó de computação (VM).
PoolAddParameter	Um Pool no serviço de Lote do Azure para adicionar.
PoolEndpointConfiguration	A configuração do ponto de extremidade para um Pool.
PublicIPAddressConfiguration	A configuração de endereço IP público da configuração de rede de um pool.
ResourceFile	Um único arquivo ou vários arquivos a serem baixados para um nó de computação.
RollingUpgradePolicy	Os parâmetros de configuração usados durante a execução de uma atualização contínua.
SecurityEncryptionTypes	Especifica o EncryptionType do disco gerenciado. Ele é definido como VMGuestStateOnly para criptografia apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado do firmware no blob VMGuestState. Nota: Ele pode ser definido apenas para VMs confidenciais e é necessário ao usar VMs confidenciais.
SecurityProfile	Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquina virtual.
SecurityTypes	Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings.
ServiceArtifactReference	Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de escala ao usar a versão de imagem 'mais recente'.
StartTask	Uma Tarefa que é executada quando um Nó ingressa em um Pool no serviço Lote do Azure ou quando o Nó de Computação é reinicializado ou recriado.
StorageAccountType	O tipo de conta de armazenamento para uso na criação de discos de dados ou disco do sistema operacional.
TaskContainerSettings	As configurações de contêiner para uma Tarefa.
TaskSchedulingPolicy	Especifica como as tarefas devem ser distribuídas entre nós de computação.
UefiSettings	Especifica as configurações de segurança, como inicialização segura e vTPM, usadas durante a criação da máquina virtual.
UpgradeMode	Especifica o modo de uma atualização para máquinas virtuais no conjunto de escala. Os valores possíveis são: Manual - Você controla a aplicação de atualizações para máquinas virtuais no conjunto de escala. Para fazer isso, use a ação manualUpgrade. automático - Todas as máquinas virtuais no conjunto de escala são atualizadas automaticamente ao mesmo tempo. Rolling - O conjunto de escalas executa atualizações em lotes com um tempo de pausa opcional no meio.
UpgradePolicy	Descreve uma política de atualização - automática, manual ou rolante.
UserAccount	Propriedades usadas para criar um usuário usado para executar Tarefas em um Nó de Computação em Lote do Azure.
UserIdentity	A definição da identidade do usuário sob a qual a Tarefa é executada.
VirtualMachineConfiguration	A configuração para nós de computação em um pool com base na infraestrutura de máquinas virtuais do Azure.
VMDiskSecurityProfile	Especifica as configurações de perfil de segurança para o disco gerenciado. Nota: Ele só pode ser definido para VMs confidenciais e necessário ao usar VMs confidenciais.
VMExtension	A configuração para extensões de máquina virtual.
WindowsConfiguration	Configurações do sistema operacional Windows a serem aplicadas à máquina virtual.
WindowsUserConfiguration	Propriedades usadas para criar uma conta de usuário em um nó de computação do Windows.

ApplicationPackageReference

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

Name	Tipo	Description
applicationId	string	A ID do aplicativo a ser implantado. Ao criar um pool, a ID do aplicativo do pacote deve ser totalmente qualificada (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	A versão do aplicativo a ser implantado. Se omitida, a versão padrão será implantada. Se isso for omitido em um pool e nenhuma versão padrão for especificada para este aplicativo, a solicitação falhará com o código de erro InvalidApplicationPackageReferences e o código de status HTTP 409. Se isso for omitido em uma Tarefa e nenhuma versão padrão for especificada para este aplicativo, a Tarefa falhará com um erro de pré-processamento.

AutomaticOSUpgradePolicy

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

Name	Tipo	Description
disableAutomaticRollback	boolean	Se o recurso de reversão de imagem do sistema operacional deve ser desativado.
enableAutomaticOSUpgrade	boolean	Indica se as atualizações do sistema operacional devem ser aplicadas automaticamente para dimensionar instâncias do conjunto de forma contínua quando uma versão mais recente da imagem do sistema operacional estiver disponível. Se isso for definido como true para pools baseados no Windows, WindowsConfiguration.enableAutomaticUpdates não pode ser definido como true.
osRollingUpgradeDeferral	boolean	Adie as atualizações do sistema operacional nos TVMs se eles estiverem executando tarefas.
useRollingUpgradePolicy	boolean	Indica se a política de atualização contínua deve ser usada durante a Atualização Automática do SO. A Atualização Automática do SO retornará à política padrão se nenhuma política for definida no VMSS.

AutoUserScope

O escopo para o usuário automático

Name	Tipo	Description
pool	string	Especifica que a Tarefa é executada como a Conta de usuário automático comum que é criada em cada Nó de Computação em um Pool.
task	string	Especifica que o serviço deve criar um novo usuário para a Tarefa.

AutoUserSpecification

Especifica os parâmetros para o usuário automático que executa uma tarefa no serviço em lote.

Name	Tipo	Description
elevationLevel	ElevationLevel	O nível de elevação do usuário automático. O valor padrão é nonAdmin.
scope	AutoUserScope	O escopo para o usuário automático O valor padrão é pool. Se o pool estiver executando o Windows, um valor de Task deverá ser especificado se for necessário um isolamento mais rigoroso entre as tarefas. Por exemplo, se a tarefa muta o registro de uma forma que pode afetar outras tarefas, ou se certificados foram especificados no pool que não deve ser acessível por tarefas normais, mas deve ser acessível por StartTasks.

AzureBlobFileSystemConfiguration

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

Name	Tipo	Description
accountKey	string	A chave da Conta de Armazenamento do Azure. Esta 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 mount. Estas são opções de 'net use' no Windows e opções de 'mount' no Linux.
containerName	string	O nome do Contêiner de Armazenamento de Blob do Azure.
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída ao usuário a ser usada para acessar containerName Esta 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 Batch mounts, acessível através da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.
sasKey	string	O token SAS do Armazenamento do Azure. Esta propriedade é mutuamente exclusiva com accountKey e identity; exatamente um deve ser especificado.

AzureFileShareConfiguration

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

Name	Tipo	Description
accountKey	string	A chave da conta do Armazenamento do Azure.
accountName	string	O nome da conta de Armazenamento do Azure.
azureFileUrl	string	A URL dos Arquivos do Azure. Este é o formato 'https://{account}.file.core.windows.net/'.
mountOptions	string	Opções de linha de comando adicionais para passar para o comando mount. Estas são opções de 'net use' no Windows e opções de 'mount' 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 Batch mounts, acessível através da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.

BatchError

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

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	ErrorMessage	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
values	BatchErrorDetail[]	Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

BatchErrorDetail

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

Name	Tipo	Description
key	string	Um identificador que especifica o significado da propriedade Value.
value	string	As informações adicionais incluídas com a resposta de erro.

CachingType

O tipo de cache a ser habilitado para o disco.

Name	Tipo	Description
none	string	O modo de cache para o disco não está habilitado.
readonly	string	O modo de cache para o disco é somente leitura.
readwrite	string	O modo de cache para o disco é leitura e gravação.

CertificateReference

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

Name	Tipo	Description
storeLocation	CertificateStoreLocation	O local do armazenamento de certificados no nó de computação no qual instalar o certificado. O valor padrão é currentuser. Esta propriedade é aplicável somente para pools configurados com nós de computação do Windows. Para nós de computação Linux, os certificados são armazenados em um diretório dentro do diretório de trabalho Tarefa e uma variável de ambiente AZ_BATCH_CERTIFICATES_DIR é fornecida à tarefa para consultar esse local. Para Certificados com visibilidade de 'remoteUser', um diretório 'certs' é criado no diretório base do usuário (por exemplo, /home/{user-name}/certs) e os Certificados são colocados nesse diretório.
storeName	string	O nome do armazenamento de certificados no nó de computação no qual instalar o certificado. Esta propriedade é aplicável somente para pools configurados com nós de computação do Windows. Os nomes de armazenamento comuns incluem: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, mas qualquer nome de loja personalizado também pode ser usado. O valor padrão é My.
thumbprint	string	A impressão digital do Certificado.
thumbprintAlgorithm	string	O algoritmo ao qual a impressão digital está associada. Isso deve ser sha1.
visibility	CertificateVisibility[]	Quais Contas de usuário no Nó de Computação devem ter acesso aos dados privados do Certificado. Você pode especificar mais de uma visibilidade nesta coleção. O padrão é todas as contas.

CertificateStoreLocation

O local do armazenamento de certificados no nó de computação no qual instalar o certificado.

Name	Tipo	Description
currentuser	string	Os certificados devem ser instalados no repositório de certificados CurrentUser.
localmachine	string	Os certificados devem ser instalados no armazenamento de certificados LocalMachine.

CertificateVisibility

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

Name	Tipo	Description
remoteuser	string	O Certificado deve estar visível para as contas de usuário sob as quais os usuários acessam remotamente o Nó de Computação.
starttask	string	O certificado deve estar visível para a conta de usuário sob a qual o StartTask é executado. Observe que, se o Escopo do Usuário Automático for Pool para StartTask e uma Tarefa, esse certificado também ficará visível para a Tarefa.
task	string	O Certificado deve estar visível para as contas de usuário sob as quais as Tarefas de Trabalho são executadas.

CIFSMountConfiguration

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

Name	Tipo	Description
mountOptions	string	Opções de linha de comando adicionais para passar para o comando mount. Estas são opções de 'net use' no Windows e opções de 'mount' no Linux.
password	string	A senha a ser usada para autenticação no sistema de arquivos CIFS.
relativeMountPath	string	O caminho relativo no nó de computação onde o sistema de arquivos será montado Todos os sistemas de arquivos são montados em relação ao diretório Batch mounts, acessível através da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.
source	string	O URI do sistema de arquivos a ser montado.
username	string	O usuário a ser usado para autenticação no sistema de arquivos CIFS.

ComputeNodeFillType

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

Name	Tipo	Description
pack	string	O maior número possível de Tarefas (taskSlotsPerNode) deve ser atribuído a cada Nó de Computação no Pool antes que qualquer Tarefa seja atribuída ao próximo Nó de Computação no Pool.
spread	string	As tarefas devem ser atribuídas uniformemente em todos os nós de computação no pool.

ComputeNodeIdentityReference

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

Name	Tipo	Description
resourceId	string	O ID de recurso ARM da identidade atribuída ao usuário.

ContainerConfiguration

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

Name	Tipo	Description
containerImageNames	string[]	A coleção de nomes de imagem de contêiner. Esta é a referência completa da imagem, como seria especificado para "docker pull". Uma Imagem será originada do registro padrão do Docker, a menos que a Imagem esteja totalmente qualificada com um registro alternativo.
containerRegistries	ContainerRegistry[]	Registos privados adicionais dos quais os contentores podem ser retirados. Se alguma Imagem tiver de ser transferida a partir de um registo privado que exija credenciais, então essas credenciais devem ser fornecidas aqui.
type	ContainerType	A tecnologia de contentores a utilizar.

ContainerHostBatchBindMountEntry

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

Name	Tipo	Description
isReadOnly	boolean	Monte esse caminho de origem como modo somente leitura ou não. O valor padrão é false (modo de leitura/gravação). Para 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, 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 modificá-lo.
source	ContainerHostDataPath	O caminho que ser montado para o cliente de contêiner pode selecionar.

ContainerHostDataPath

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

Name	Tipo	Description
Applications	string	O caminho dos aplicativos.
JobPrep	string	O caminho da tarefa de preparação para o trabalho.
Shared	string	O caminho para a tarefa de várias instâncias compartilhar seus arquivos.
Startup	string	O caminho para iniciar a tarefa.
Task	string	O caminho da tarefa.
VfsMounts	string	O caminho contém todos os sistemas de arquivos virtuais montados neste nó.

ContainerRegistry

Um registro de contêiner privado.

Name	Tipo	Description
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída ao usuário a ser usada para acessar um Registro de Contêiner do Azure em vez de nome de usuário e senha. A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará.
password	string	A palavra-passe para iniciar sessão no servidor de registo.
registryServer	string	O URL do registo. Se omitido, o padrão é "docker.io".
username	string	O nome de utilizador para iniciar sessão no servidor de registo.

ContainerType

A tecnologia de contentores a utilizar.

Name	Tipo	Description
criCompatible	string	Uma tecnologia baseada em CRI será usada para lançar os contêineres.
dockerCompatible	string	Uma tecnologia de contêiner compatível com Docker será usada para iniciar os contêineres.

ContainerWorkingDirectory

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

Name	Tipo	Description
containerImageDefault	string	Use o diretório de trabalho definido na imagem do contêiner. Tenha cuidado que este diretório não conterá os arquivos de recursos baixados pelo lote.
taskWorkingDirectory	string	Use o diretório de trabalho padrão Tarefa do serviço em lote, que conterá os arquivos de recursos da tarefa preenchidos por lote.

DataDisk

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

Name	Tipo	Description
caching	CachingType	O tipo de cache a ser habilitado para os discos de dados. O valor padrão para cache é readwrite. Para obter informações sobre as opções de cache, consulte: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
diskSizeGB	integer	O tamanho inicial do disco em gigabytes.
lun	integer	O número da unidade lógica. O lun é usado para identificar exclusivamente cada disco de dados. Se anexar vários discos, cada um deve ter um lun distinto. O valor deve estar entre 0 e 63, inclusive.
storageAccountType	StorageAccountType	O tipo de conta de armazenamento a ser usado para o disco de dados. Se omitido, o padrão é "standard_lrs".

DiffDiskPlacement

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

Name	Tipo	Description
CacheDisk	string	O disco do sistema operacional efêmero é armazenado no cache da VM.

DiffDiskSettings

Especifica as configurações de disco efêmeras para o disco do sistema operacional usado pelo nó de computação (VM).

Name	Tipo	Description
placement	DiffDiskPlacement	Especifica o posicionamento efêmero do 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, espaço em disco de cache para provisionamento de disco do sistema operacional efêmero. Para obter mais informações sobre os requisitos de tamanho de disco do sistema operacional efêmero, consulte Requisitos de tamanho de disco do sistema operacional efêmero para VMs do Windows em https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e VMs do Linux em https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

DiskEncryptionConfiguration

A configuração de criptografia de disco aplicada em nós de computação no pool. A configuração de criptografia de disco não é suportada no pool Linux criado com a Imagem da Galeria de Computação do Azure.

Name	Tipo	Description
targets	DiskEncryptionTarget[]	A lista de destinos de disco do Serviço em Lote será criptografada no nó de computação. A lista de destinos de disco do Serviço em Lote será criptografada no nó de computação.

DiskEncryptionTarget

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

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

DynamicVNetAssignmentScope

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

Name	Tipo	Description
job	string	A atribuição de VNet dinâmica é feita por trabalho.
none	string	Nenhuma atribuição de VNet dinâmica está habilitada.

ElevationLevel

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

Name	Tipo	Description
admin	string	O usuário é um usuário com acesso elevado e opera com permissões completas de administrador.
nonadmin	string	O usuário é um usuário padrão sem acesso elevado.

EnvironmentSetting

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

Name	Tipo	Description
name	string	O nome da variável de ambiente.
value	string	O valor da variável de ambiente.

ErrorMessage

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

Name	Tipo	Description
lang	string	O código de idioma da mensagem de erro
value	string	O texto da mensagem.

ImageReference

Uma referência a uma Imagem do Azure Virtual Machines Marketplace 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 suportadas'.

Name	Tipo	Description
communityGalleryImageId	string	O identificador exclusivo da imagem da galeria da comunidade Esta propriedade é mutuamente exclusiva com outras propriedades e pode ser obtida na chamada GET da galeria da comunidade.
exactVersion	string	A versão específica da imagem da plataforma ou imagem do mercado usada para criar o nó. Este campo somente leitura difere de 'version' somente se o valor especificado para 'version' quando o pool foi criado era 'mais recente'.
offer	string	O tipo de oferta da Imagem do Azure Virtual Machines Marketplace. Por exemplo, UbuntuServer ou WindowsServer.
publisher	string	O editor da Imagem do Azure Virtual Machines Marketplace. Por exemplo, Canonical ou MicrosoftWindowsServer.
sharedGalleryImageId	string	O identificador exclusivo da imagem da galeria compartilhada Esta propriedade é mutuamente exclusiva com outras propriedades e pode ser obtida a partir da chamada GET da imagem da galeria partilhada.
sku	string	A SKU da imagem do Azure Virtual Machines Marketplace. Por exemplo, 18.04-LTS ou 2019-Datacenter.
version	string	A versão da Imagem do Azure Virtual Machines Marketplace. Um valor de 'mais recente' pode ser especificado para selecionar a versão mais recente de uma imagem. Se omitido, o padrão é 'mais recente'.
virtualMachineImageId	string	O identificador de recurso ARM da Imagem da Galeria de Computação do Azure. Os nós de computação no pool serão criados usando essa ID de imagem. Este é o formato /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 padronizar a versão de imagem mais recente. Esta propriedade é mutuamente exclusiva com outras propriedades ImageReference. A Imagem da Galeria de Computação do Azure deve ter réplicas na mesma região e deve estar na mesma assinatura que a conta do Lote do Azure. Se a versão da imagem não for especificada no imageId, a versão mais recente será usada. Para obter informações sobre as configurações de firewall para o agente Batch Compute Node se comunicar com o serviço Batch, consulte https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

InboundEndpointProtocol

O protocolo do ponto de extremidade.

Name	Tipo	Description
tcp	string	Use TCP para o ponto de extremidade.
udp	string	Use UDP para o ponto de extremidade.

InboundNATPool

Um pool NAT de entrada que pode ser usado para endereçar portas específicas em nós de computação em um pool de lotes externamente.

Name	Tipo	Description
backendPort	integer	O número da porta no nó de computação. Isso deve ser exclusivo dentro de um pool de lotes. Os valores aceitáveis situam-se entre 1 e 65535, exceto para 22, 3389, 29876 e 29877, uma vez que estes são reservados. Se algum valor reservado for fornecido, a solicitação falhará com o código de status HTTP 400.
frontendPortRangeEnd	integer	O último número de porta no intervalo de portas externas que serão usadas para fornecer acesso de entrada à porta de back-end 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 de lote. Todos os intervalos dentro de um Pool devem ser distintos e não podem se sobrepor. Cada intervalo deve conter pelo menos 40 portas. Se algum valor reservado ou sobreposto for fornecido, a solicitação falhará com o código de status HTTP 400.
frontendPortRangeStart	integer	O primeiro número de porta no intervalo de portas externas que serão usadas para fornecer acesso de entrada à porta de back-end 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 intervalo deve conter pelo menos 40 portas. Se algum valor reservado ou sobreposto for fornecido, a solicitação falhará com o código de status HTTP 400.
name	string	O nome do ponto de extremidade. O nome deve ser exclusivo dentro de um pool de lotes, pode conter letras, números, sublinhados, pontos e hífenes. Os nomes devem começar com uma letra ou número, devem terminar com uma letra, número ou sublinhado e não podem exceder 77 caracteres. Se algum valor inválido for fornecido, a solicitação falhará com o código de status HTTP 400.
networkSecurityGroupRules	NetworkSecurityGroupRule[]	Uma lista de regras de grupo de segurança de rede que serão aplicadas ao ponto de extremidade. O número máximo de regras que podem ser especificadas em todos os pontos de extremidade em um pool de lotes é 25. Se nenhuma regra de grupo de segurança de rede for especificada, uma regra padrão será criada para permitir o acesso de entrada à porta de back-end especificada. Se o número máximo de regras de grupo de segurança de rede for excedido, a solicitação falhará com o código de status HTTP 400.
protocol	InboundEndpointProtocol	O protocolo do ponto de extremidade.

IPAddressProvisioningType

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

Name	Tipo	Description
batchmanaged	string	Um IP público será criado e gerenciado pelo Batch. Pode haver vários IPs públicos, dependendo do tamanho do Pool.
nopublicipaddresses	string	Nenhum endereço IP público será criado.
usermanaged	string	IPs públicos são fornecidos pelo usuário e serão usados para provisionar os nós de computação.

LinuxUserConfiguration

Propriedades usadas para criar uma conta de usuário em um nó de computação Linux.

Name	Tipo	Description
gid	integer	O ID de grupo para a conta de usuário. As propriedades uid e gid devem ser especificadas juntas ou não devem ser especificadas de todo. Se não for especificado, o sistema operacional subjacente seleciona o gid.
sshPrivateKey	string	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 é true (ela é ignorada se enableInterNodeCommunication for false). Ele faz isso colocando o par de chaves no diretório .ssh do usuário. Se não for especificado, o SSH sem senha não será configurado entre nós de computação (nenhuma modificação do diretório .ssh do usuário será feita).
uid	integer	O ID de usuário da conta de usuário. As propriedades uid e gid devem ser especificadas juntas ou não devem ser especificadas de todo. Se não for especificado, o sistema operacional subjacente seleciona o uid.

LoginMode

O modo de login para o usuário

Name	Tipo	Description
batch	string	O LOGON32_LOGON_BATCH modo de login do Win32. O modo de login em lote é recomendado para processos paralelos de longa execução.
interactive	string	O LOGON32_LOGON_INTERACTIVE modo de login do Win32. O UAC está habilitado em Pools do Windows. Se essa opção for usada com uma identidade de usuário elevada em um Pool do Windows, a sessão do usuário não será elevada, a menos que o aplicativo executado pela linha de comando Tarefa esteja configurado para sempre exigir privilégio administrativo ou sempre exigir privilégio máximo.

ManagedDisk

Name	Tipo	Description
securityProfile	VMDiskSecurityProfile	Especifica as configurações de perfil de segurança para o disco gerenciado. Especifica as configurações de perfil de segurança para o disco gerenciado. Nota: Ele só pode ser definido para VMs confidenciais e necessário ao usar VMs confidenciais.
storageAccountType	StorageAccountType	O tipo de conta de armazenamento para disco gerenciado.

MetadataItem

Um par nome-valor associado a um recurso de serviço em lote.

Name	Tipo	Description
name	string	O nome do item de metadados.
value	string	O valor do item de metadados.

MountConfiguration

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

Name	Tipo	Description
azureBlobFileSystemConfiguration	AzureBlobFileSystemConfiguration	O Contêiner de Armazenamento do Azure a ser montado usando o blob FUSE em cada nó. Esta propriedade é mutuamente exclusiva com todas as outras propriedades.
azureFileShareConfiguration	AzureFileShareConfiguration	O Compartilhamento de Arquivos do Azure a ser montado em cada nó. Esta propriedade é mutuamente exclusiva com todas as outras propriedades.
cifsMountConfiguration	CIFSMountConfiguration	O sistema de arquivos CIFS/SMB a ser montado em cada nó. Esta propriedade é mutuamente exclusiva com todas as outras propriedades.
nfsMountConfiguration	NFSMountConfiguration	O sistema de arquivos NFS a ser montado em cada nó. Esta propriedade é mutuamente exclusiva com todas as outras propriedades.

NetworkConfiguration

A configuração de rede para um Pool.

Name	Tipo	Description
dynamicVNetAssignmentScope	DynamicVNetAssignmentScope	O escopo da atribuição dinâmica de vnet.
enableAcceleratedNetworking	boolean	Se esse pool deve permitir a rede acelerada. A rede acelerada permite a virtualização de E/S de raiz única (SR-IOV) para uma VM, o que pode levar a um melhor desempenho de rede. Para mais informações, consultar: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.
endpointConfiguration	PoolEndpointConfiguration	A configuração para pontos de extremidade em nós de computação no pool de lotes.
publicIPAddressConfiguration	PublicIPAddressConfiguration	A configuração de endereço IPAddress público para nós de computação no pool de lotes. A configuração de endereço IP público da configuração de rede de um pool.
subnetId	string	O identificador de recurso ARM da sub-rede de rede virtual à qual os nós de computação do pool entrarão. Este é o formato /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. A rede virtual deve estar na mesma região e assinatura que a Conta em 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 alocará parcialmente os nós e ocorrerá um erro de redimensionamento. A entidade de serviço 'MicrosoftAzureBatch' deve ter a função 'Colaborador de Máquina Virtual Clássica' Role-Based Controle de Acesso (RBAC) para a VNet especificada. A sub-rede especificada deve permitir a comunicação do serviço Lote do Azure para poder agendar Tarefas nos Nós. Isso pode ser verificado verificando se a rede virtual especificada tem algum NSG (Network Security Groups) associado. Se a comunicação com os nós na sub-rede especificada for negada por um NSG, o serviço em lote definirá o estado dos nós de computação como inutilizável. Apenas redes virtuais ARM ('Microsoft.Network/virtualNetworks') são suportadas. Se a VNet especificada tiver algum NSG (Network Security Groups) associado, algumas portas de sistema reservadas deverão ser habilitadas para comunicação de entrada. Habilite as portas 29876 e 29877, bem como a porta 22 para Linux e a porta 3389 para Windows. Habilite também as conexões de saída para o Armazenamento do Azure na porta 443. Para mais pormenores, consultar: https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

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

Name	Tipo	Description
access	NetworkSecurityGroupRuleAccess	A ação que deve ser tomada para um endereço IP, intervalo de sub-rede ou tag especificado.
priority	integer	A prioridade para esta regra. As prioridades dentro de um Pool devem ser únicas e são avaliadas por ordem de prioridade. Quanto menor o número, maior a prioridade. Por exemplo, as regras podem ser especificadas com números de ordem de 150, 250 e 350. A regra com o número de ordem 150 tem precedência sobre a regra que tem uma ordem de 250. As prioridades permitidas são de 150 a 4096. Se algum valor reservado ou duplicado for fornecido, a solicitação falhará com o código de status HTTP 400.
sourceAddressPrefix	string	O prefixo do endereço de origem ou a tag a ser correspondida para a 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), tag padrão ou * (para todos os endereços). Se quaisquer outros valores forem fornecidos, a solicitação falhará com o código de status HTTP 400.
sourcePortRanges	string[]	A porta de origem varia para corresponder à regra. Os valores válidos são '' (para todas as portas 0 - 65535), uma porta específica (ou seja, 22) ou um intervalo de portas (ou seja, 100-200). As portas devem estar no intervalo de 0 a 65535. Cada entrada nesta coleção não deve sobrepor-se a nenhuma outra entrada (um intervalo ou uma porta individual). Se quaisquer outros valores forem fornecidos, a solicitação falhará com o código de status HTTP 400. O valor padrão é ''.

NetworkSecurityGroupRuleAccess

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

Name	Tipo	Description
allow	string	Permitir acesso.
deny	string	Negar acesso.

NFSMountConfiguration

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

Name	Tipo	Description
mountOptions	string	Opções de linha de comando adicionais para passar para o comando mount. Estas são opções de 'net use' no Windows e opções de 'mount' 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 Batch mounts, acessível através da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.
source	string	O URI do sistema de arquivos a ser montado.

NodeCommunicationMode

Determina como um pool se comunica com o serviço de lote.

Name	Tipo	Description
classic	string	Os nós que usam o modo de comunicação clássico exigem comunicação TCP de entrada nas portas 29876 e 29877 do "BatchNodeManagement. {region}" e comunicação TCP de saída na porta 443 para "Storage.region" e "BatchNodeManagement. {region}" tags de serviço.
default	string	O modo de comunicação do nó é definido automaticamente pelo serviço Batch.
simplified	string	Os nós que usam o modo de comunicação simplificado requerem comunicação TCP de saída na porta 443 para o "BatchNodeManagement. {region}" etiqueta de serviço. Não são necessárias portas de entrada abertas.

NodePlacementConfiguration

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

Name	Tipo	Description
policy	NodePlacementPolicyType	Tipo de política de posicionamento de nó em Batch Pools. Política de alocação usada pelo Batch Service para provisionar os nós. Se não for especificado, o Batch usará a política regional.

NodePlacementPolicyType

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

Name	Tipo	Description
regional	string	Todos os nós no pool serão alocados na mesma região.
zonal	string	Os nós no pool serão distribuídos por diferentes zonas de disponibilidade com o melhor balanceamento de esforço.

OSDisk

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

Name	Tipo	Description
caching	CachingType	Especifica os requisitos de cache. Os valores possíveis são: None, ReadOnly, ReadWrite. Os valores padrão são: Nenhum para armazenamento padrão. ReadOnly para armazenamento Premium. O valor padrão para cache é none. Para obter informações sobre as opções de cache, consulte: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
diskSizeGB	integer	O tamanho inicial do disco em GB ao criar um novo disco do sistema operacional.
ephemeralOSDiskSettings	DiffDiskSettings	Especifica as configurações de disco efêmeras para o disco do sistema operacional usado pelo nó de computação (VM).
managedDisk	ManagedDisk	Os parâmetros do disco gerenciado.
writeAcceleratorEnabled	boolean	Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco.

PoolAddParameter

Um Pool no serviço de Lote do Azure para adicionar.

Name	Tipo	Description
applicationPackageReferences	ApplicationPackageReference[]	A lista de pacotes a serem instalados em cada nó de computação no pool. Ao criar um pool, a ID do aplicativo do pacote deve ser totalmente qualificada (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). As alterações nas referências de Pacote afetam todos os novos Nós que ingressam no Pool, mas não afetam os Nós de Computação que já estão no Pool até que sejam reinicializados ou recriados com imagem. Há um máximo de 10 referências de pacote em qualquer pool.
autoScaleEvaluationInterval	string	O intervalo de tempo no qual ajustar automaticamente o tamanho do Pool de acordo com a fórmula de dimensionamento automático. O valor padrão é 15 minutos. O valor mínimo e máximo são de 5 minutos e 168 horas, respectivamente. Se você especificar um valor inferior a 5 minutos ou superior a 168 horas, o serviço em 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 deve ser especificada se enableAutoScale estiver definido como false. É necessário se enableAutoScale estiver definido como true. A validade da fórmula é verificada antes da criação do Pool. Se a fórmula não for válida, o serviço Lote rejeitará a solicitação com informações de erro detalhadas. Para obter mais informações sobre como especificar essa fórmula, consulte 'Dimensionar automaticamente nós de computação em um pool de lotes do Azure' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).
certificateReferences	CertificateReference[]	A lista de certificados a serem instalados em cada nó de computação no pool. Para nós do Windows, o serviço em lote instala os certificados no armazenamento de certificados e no local especificados. Para nós de computação Linux, os certificados são armazenados em um diretório dentro do diretório de trabalho Tarefa e uma variável de ambiente AZ_BATCH_CERTIFICATES_DIR é fornecida à tarefa para consultar esse local. Para Certificados com visibilidade de 'remoteUser', um diretório 'certs' é criado no diretório base do usuário (por exemplo, /home/{user-name}/certs) e os Certificados são colocados nesse diretório. Aviso: Esta propriedade foi preterida e será removida após fevereiro de 2024. Em vez disso, use o Azure KeyVault Extension.
displayName	string	O nome para exibição do Pool. O nome para exibição não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024.
enableAutoScale	boolean	Se o tamanho do Pool deve ser ajustado automaticamente ao longo do tempo. Se false, pelo menos um dos targetDedicatedNodes e targetLowPriorityNodes deve ser especificado. Se true, a propriedade autoScaleFormula é necessária e o Pool é redimensionado automaticamente de acordo com a fórmula. O valor padrão é false.
enableInterNodeCommunication	boolean	Se o Pool permite a 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. Isto pode fazer com que a Piscina não atinja o tamanho desejado. O valor padrão é false.
id	string	Uma cadeia de caracteres que identifica exclusivamente o Pool dentro da Conta. O ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hífenes e sublinhados, e não pode conter mais de 64 caracteres. O ID preserva maiúsculas e minúsculas e não diferencia maiúsculas de minúsculas (ou seja, você não pode ter dois IDs de Pool em uma Conta que diferem apenas por maiúsculas e minúsculas).
metadata	MetadataItem[]	Uma lista de pares nome-valor associados ao Pool como metadados. O serviço Batch não atribui qualquer significado aos metadados; é exclusivamente para o uso do código de usuário.
mountConfiguration	MountConfiguration[]	Monte o armazenamento usando o sistema de arquivos especificado durante toda a vida útil do pool. Monte o armazenamento usando o sistema de arquivos baseado em compartilhamento de arquivos, NFS, CIFS ou Blobfuse do Azure.
networkConfiguration	NetworkConfiguration	A configuração de rede para o Pool. A configuração de rede para um Pool.
resizeTimeout	string	O tempo limite para alocação de nós de computação para o pool. Este tempo limite aplica-se apenas ao dimensionamento manual; ele não tem efeito quando enableAutoScale é definido como true. O valor padrão é 15 minutos. O valor mínimo é de 5 minutos. Se você especificar um valor inferior a 5 minutos, o serviço de lote retornará um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação incorreta).
resourceTags	object	As tags especificadas pelo usuário associadas ao pool. As marcas definidas pelo usuário a serem associadas ao Pool de Lotes do Azure. Quando especificadas, essas marcas são propagadas para os recursos do Azure de suporte associados ao pool. Essa propriedade só pode ser especificada quando a conta Batch foi criada com a propriedade poolAllocationMode definida como 'UserSubscription'.
startTask	StartTask	Uma Tarefa especificada para ser executada em cada Nó de Computação à medida que se junta ao Pool. A Tarefa é executada quando o Nó de Computação é adicionado ao Pool ou quando o Nó de Computação é reiniciado.
targetDedicatedNodes	integer	O número desejado de nós de computação dedicados no pool. Essa propriedade não deve ser especificada se enableAutoScale estiver definido como true. Se enableAutoScale estiver definido como false, você deverá definir targetDedicatedNodes, targetLowPriorityNodes, ou ambos.
targetLowPriorityNodes	integer	O número desejado de nós de computação spot/de baixa prioridade no pool. Essa propriedade não deve ser especificada se enableAutoScale estiver definido como true. Se enableAutoScale estiver definido como false, você deverá definir targetDedicatedNodes, targetLowPriorityNodes, ou ambos.
targetNodeCommunicationMode	NodeCommunicationMode	O modo de comunicação de nó desejado para o pool. Se omitido, o valor padrão é Default.
taskSchedulingPolicy	TaskSchedulingPolicy	Como as tarefas são distribuídas entre nós de computação em um pool. Se não for especificado, o padrão será spread.
taskSlotsPerNode	integer	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	UpgradePolicy	A política de atualização para o Pool. Descreve uma política de atualização - automática, manual ou rolante.
userAccounts	UserAccount[]	A lista de Contas de usuário a serem criadas em cada Nó de Computação no Pool.
virtualMachineConfiguration	VirtualMachineConfiguration	A configuração da máquina virtual para o Pool. Esta propriedade deve ser especificada.
vmSize	string	O tamanho das máquinas virtuais no Pool. Todas as máquinas virtuais em um Pool têm o mesmo tamanho. Para obter informações sobre tamanhos de VM disponíveis, consulte Tamanhos para máquinas virtuais (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) ou Tamanhos para máquinas virtuais (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). O Batch dá suporte a todos os tamanhos de VM do Azure, exceto STANDARD_A0 e aqueles com armazenamento premium (STANDARD_GS, STANDARD_DS e STANDARD_DSV2 séries).

PoolEndpointConfiguration

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

Name	Tipo	Description
inboundNATPools	InboundNATPool[]	Uma lista de pools NAT 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 pools NAT de entrada por pool de lotes é 5. Se o número máximo de pools NAT de entrada for excedido, a solicitação falhará com o código de status HTTP 400. Isso não pode ser especificado se o IPAddressProvisioningType for NoPublicIPAddresses.

PublicIPAddressConfiguration

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

Name	Tipo	Description
ipAddressIds	string[]	A lista de IPs públicos que o serviço de 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/Low-priority podem ser alocados para cada IP público. Por exemplo, um pool que precisa de 250 VMs dedicadas precisaria de pelo menos 3 IPs públicos especificados. Cada elemento desta coleção tem o formato: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.
provision	IPAddressProvisioningType	O tipo de provisionamento para endereços IP públicos para o pool. O valor padrão é BatchManaged.

ResourceFile

Um único arquivo ou vários arquivos a serem baixados para um nó de computação.

Name	Tipo	Description
autoStorageContainerName	string	O nome do contêiner de armazenamento na conta de armazenamento automático. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada.
blobPrefix	string	O prefixo de blob a ser usado ao baixar blobs de um contêiner de 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 file permission mode em formato octal. Esta propriedade aplica-se apenas a arquivos que estão sendo baixados para nós de computação do Linux. Ele será ignorado se for especificado para um resourceFile que será baixado para um nó de computação do Windows. Se essa propriedade não for especificada para um nó de computação do Linux, um valor padrão de 0770 será aplicado ao arquivo.
filePath	string	O local no nó de computação para o qual baixar o(s) arquivo(s), relativo 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 os arquivos serão baixados. No caso em que filePath é usado como um diretório, qualquer estrutura de diretório já associada aos dados de entrada será mantida na íntegra e anexada ao diretório filePath especificado. O caminho relativo especificado não pode sair do diretório de trabalho da Tarefa (por exemplo, usando '..').
httpUrl	string	O URL do ficheiro a transferir. 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 a partir dos nós de computação. Há três maneiras de obter essa URL para um blob no armazenamento do Azure: incluir uma Assinatura de Acesso Compartilhado (SAS) concedendo permissões de leitura no blob, usar uma identidade gerenciada com permissão de leitura ou definir a ACL para o blob ou seu contêiner para permitir acesso público.
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída ao usuário a ser usada para acessar o Armazenamento de Blob do Azure especificado por storageContainerUrl ou httpUrl A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará.
storageContainerUrl	string	A URL do contêiner de blob no Armazenamento de Blob do Azure. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Este URL deve ser legível e listável a partir 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 do contêiner para permitir acesso público.

RollingUpgradePolicy

Os parâmetros de configuração usados durante a execução de uma atualização contínua.

Name	Tipo	Description
enableCrossZoneUpgrade	boolean	Permita que o VMSS ignore os limites 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. Este campo pode ser definido como true ou false somente ao usar NodePlacementConfiguration como Zonal.
maxBatchInstancePercent	integer	A porcentagem máxima do total de instâncias de máquina virtual que serão atualizadas simultaneamente pela atualização sem interrupção em um lote. Como isso é máximo, instâncias não íntegras em lotes anteriores ou futuros podem fazer com que a porcentagem de instâncias em um lote diminua para garantir maior confiabilidade. O valor deste 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 superior a maxUnhealthyInstancePercent.
maxUnhealthyInstancePercent	integer	A porcentagem máxima do total de instâncias de máquina virtual no conjunto de escala que pode estar simultaneamente não íntegra, seja como resultado de ser atualizada ou por ser encontrada em um estado não íntegro pelas verificações de integridade da máquina virtual antes que a atualização contínua seja abortada. Esta restrição será verificada antes de iniciar qualquer lote. O valor deste 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 superior a maxUnhealthyInstancePercent.
maxUnhealthyUpgradedInstancePercent	integer	A porcentagem máxima de instâncias de máquina virtual atualizadas que podem ser encontradas em um estado não íntegro. Essa verificação acontecerá depois que cada lote for atualizado. Se essa porcentagem for excedida, a atualização contínua será anulada. O valor deste campo deve estar entre 0 e 100, inclusive.
pauseTimeBetweenBatches	string	O tempo de espera entre a conclusão da atualização para todas as máquinas virtuais em um lote e o início do 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 escala antes de quaisquer instâncias íntegras.
rollbackFailedInstancesOnPolicyBreach	boolean	Reversão de instâncias com falha para o modelo anterior se a política de Atualização Contínua for violada.

SecurityEncryptionTypes

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

Name	Tipo	Description
NonPersistedTPM	string
VMGuestStateOnly	string

SecurityProfile

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

Name	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áquina virtual. 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 do host, consulte https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes.
securityType	SecurityTypes	Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings.
uefiSettings	UefiSettings	Especifica as configurações de segurança, como inicialização segura e vTPM, usadas durante a criação da máquina virtual. Especifica as configurações de segurança, como inicialização segura e vTPM, usadas durante a criação da máquina virtual.

SecurityTypes

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

Name	Tipo	Description
confidentialVM	string	A computação confidencial do Azure oferece VMs confidenciais para locatários com altos requisitos de segurança e confidencialidade. Essas VMs fornecem um limite forte e imposto por hardware para ajudar a atender às suas necessidades de segurança. Você pode usar VMs confidenciais para migrações sem fazer alterações no código, com a plataforma protegendo o estado da VM de ser lido ou modificado.
trustedLaunch	string	O lançamento confiável protege contra técnicas de ataque avançadas e persistentes.

ServiceArtifactReference

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

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

StartTask

Uma Tarefa que é executada quando um Nó ingressa em um Pool no serviço Lote do Azure ou quando o Nó de Computação é reinicializado ou recriado.

Name	Tipo	Description
commandLine	string	A linha de comando do StartTask. A linha de comando não é executada sob um shell e, portanto, não pode aproveitar os recursos do shell, como a expansão da variável de ambiente. Se você quiser aproveitar esses recursos, você deve invocar o shell na linha de comando, por exemplo, usando "cmd /c MyCommand" no Windows ou "/bin/sh -c MyCommand" no Linux. Se a linha de comando se referir a caminhos de arquivo, ela deverá usar um caminho relativo (relativo ao diretório de trabalho Tarefa) ou usar a variável de ambiente Batch provided (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).
containerSettings	TaskContainerSettings	As configurações para o contêiner sob o qual o StartTask é executado. Quando isso é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios do Lote do Azure no nó) são mapeados no contêiner, todas as variáveis de ambiente de Tarefa são mapeadas no contêiner e a linha de comando Tarefa é executada no contêiner. Os arquivos produzidos no contêiner fora de AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos no disco host, o que significa que as APIs de arquivo em lote não poderão acessar esses arquivos.
environmentSettings	EnvironmentSetting[]	Uma lista de configurações de variáveis de ambiente para o StartTask.
maxTaskRetryCount	integer	O número máximo de vezes que a Tarefa pode ser repetida. O serviço de lote tenta novamente uma tarefa se seu código de saída for diferente de zero. Observe que esse valor controla especificamente o número de tentativas. O serviço de lote tentará a tarefa uma vez e, em seguida, poderá tentar novamente até esse limite. Por exemplo, se a contagem máxima de tentativas for 3, o Batch tentará a Tarefa até 4 vezes (uma tentativa inicial e 3 tentativas). Se a contagem máxima de tentativas for 0, o serviço Batch não repetirá a Tarefa. Se a contagem máxima de tentativas for -1, o serviço em lote repetirá a tarefa sem limite, no entanto, isso não é recomendado para uma tarefa inicial ou qualquer tarefa. O valor padrão é 0 (sem tentativas).
resourceFiles	ResourceFile[]	Uma lista de arquivos que o serviço em lote baixará para o nó de computação antes de executar a linha de comando. Há um tamanho máximo para a lista de arquivos de recursos. 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 deve ser reduzida em tamanho. Isso pode ser feito usando arquivos .zip, pacotes de aplicativos ou contêineres do Docker. Os arquivos listados sob este elemento estão localizados no diretório de trabalho da tarefa.
userIdentity	UserIdentity	A identidade do usuário sob a qual o StartTask é executado. Se omitida, a Tarefa é executada como um usuário não administrativo exclusivo para a Tarefa.
waitForSuccess	boolean	Se o serviço em lote deve aguardar a conclusão bem-sucedida do StartTask (ou seja, sair com o código de saída 0) antes de agendar quaisquer tarefas no nó de computação. Se true e o StartTask falhar em um nó, o serviço Batch tentará novamente o StartTask até sua contagem máxima de tentativas (maxTaskRetryCount). Se a Tarefa ainda não tiver sido concluída com êxito após todas as tentativas, o serviço Lote marcará o Nó como inutilizável e não agendará Tarefas para ele. Esta condição pode ser detetada através do estado do nó de computação e detalhes de informações de falha. Se false, o serviço Batch 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 está em execução; e mesmo que o StartTask falhe, novas tarefas continuarão a ser agendadas no nó de computação. O padrão é true.

StorageAccountType

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

Name	Tipo	Description
premium_lrs	string	O disco de dados / disco do sistema operacional deve usar armazenamento premium localmente redundante.
standard_lrs	string	O disco de dados / disco do sistema operacional deve usar armazenamento padrão localmente redundante.
standardssd_lrs	string	O disco de dados / disco do sistema operacional deve usar armazenamento padrão SSD localmente redundante.

TaskContainerSettings

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

Name	Tipo	Description
containerHostBatchBindMounts	ContainerHostBatchBindMountEntry[]	Os caminhos que você deseja montar para a 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 container create. Essas opções adicionais são fornecidas como argumentos para o comando "docker create", além daquelas controladas pelo Batch Service.
imageName	string	A Imagem a ser usada para criar o contêiner no qual a Tarefa será executada. Esta é a referência completa da imagem, como seria especificado para "docker pull". Se nenhuma tag for fornecida como parte do nome da imagem, a tag ":latest" será usada como padrão.
registry	ContainerRegistry	O registro privado que contém a imagem do contêiner. Essa configuração pode ser omitida se já tiver sido fornecida na criação do pool.
workingDirectory	ContainerWorkingDirectory	O local do diretório de trabalho da tarefa do contêiner. O padrão é 'taskWorkingDirectory'.

TaskSchedulingPolicy

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

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

UefiSettings

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

Name	Tipo	Description
secureBootEnabled	boolean	Especifica se a inicialização segura deve ser habilitada na máquina virtual.
vTpmEnabled	boolean	Especifica se o vTPM deve ser habilitado na máquina virtual.

UpgradeMode

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

Os valores possíveis são:

Manual - Você controla a aplicação de atualizações para máquinas virtuais no conjunto de escala. Para fazer isso, use a ação manualUpgrade.

automático - Todas as máquinas virtuais no conjunto de escala são atualizadas automaticamente ao mesmo tempo.

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

Name	Tipo	Description
automatic	string	Todas as máquinas virtuais no conjunto de escala são atualizadas automaticamente ao mesmo tempo.
manual	string	Você controla a aplicação de atualizações para máquinas virtuais no conjunto de escala. Para fazer isso, use a ação manualUpgrade.
rolling	string	As instâncias existentes em um conjunto de escala são reduzidas em lotes a serem atualizados. Quando o lote atualizado estiver concluído, as instâncias começarão a receber tráfego novamente e o próximo lote começará. Isso continua até que todas as instâncias sejam trazidas up-todata.

UpgradePolicy

Descreve uma política de atualização - automática, manual ou rolante.

Name	Tipo	Description
automaticOSUpgradePolicy	AutomaticOSUpgradePolicy	Parâmetros de configuração usados para executar a atualização automática do sistema operacional. Os parâmetros de configuração usados para executar a atualização automática do sistema operacional.
mode	UpgradeMode	Especifica o modo de uma atualização para máquinas virtuais no conjunto de escala. Os valores possíveis são: Manual - Você controla a aplicação de atualizações para máquinas virtuais no conjunto de escala. Para fazer isso, use a ação manualUpgrade. automático - Todas as máquinas virtuais no conjunto de escala são atualizadas automaticamente ao mesmo tempo. Rolling - O conjunto de escalas executa atualizações em lotes com um tempo de pausa opcional no meio.
rollingUpgradePolicy	RollingUpgradePolicy	Os parâmetros de configuração usados durante a execução de uma atualização contínua. Os parâmetros de configuração usados durante a execução de uma atualização contínua.

UserAccount

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

Name	Tipo	Description
elevationLevel	ElevationLevel	O nível de elevação da conta de usuário. O valor padrão é nonAdmin.
linuxUserConfiguration	LinuxUserConfiguration	A configuração de usuário específica do Linux para a conta de usuário. Esta propriedade é ignorada se especificada em um pool do Windows. Se não for especificado, o usuário será criado com as opções padrão.
name	string	O nome da conta de usuário. Os nomes podem conter caracteres Unicode até um comprimento máximo de 20.
password	string	A senha da conta de usuário.
windowsUserConfiguration	WindowsUserConfiguration	A configuração de usuário específica do Windows para a conta de usuário. Essa propriedade só pode ser especificada se o usuário estiver em um Pool do Windows. Se não especificado e em um pool do Windows, o usuário é criado com as opções padrão.

UserIdentity

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

Name	Tipo	Description
autoUser	AutoUserSpecification	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.

Name	Tipo	Description
containerConfiguration	ContainerConfiguration	A configuração do contêiner para o Pool. Se especificado, a configuração é executada em cada Nó de Computação no Pool para permitir que as Tarefas sejam executadas em contêineres. Todas as Tarefas regulares e as Tarefas do gerenciador de tarefas executadas neste Pool devem especificar a propriedade containerSettings e todas as outras Tarefas podem especificá-la.
dataDisks	DataDisk[]	A configuração para discos de dados anexados aos nós de computação no pool. Essa propriedade deve ser especificada se os nós de computação no pool precisarem ter discos de dados vazios 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). Os discos existentes não podem ser anexados, 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 depois de ser anexado, ele deve ser formatado antes do uso - para obter mais informações, consulte https://docs.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux e https://docs.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.
diskEncryptionConfiguration	DiskEncryptionConfiguration	A configuração de criptografia de disco para o pool. Se especificado, a criptografia é executada em cada nó do pool durante o provisionamento do nó.
extensions	VMExtension[]	A extensão de máquina virtual para o pool. Se especificado, as extensões mencionadas nesta configuração serão instaladas em cada nó.
imageReference	ImageReference	Uma referência à Imagem do Azure Virtual Machines Marketplace ou à Imagem de Máquina Virtual personalizada a ser usada.
licenseType	string	O tipo de licença local a ser usada ao implantar o sistema operacional. Isso só se aplica a Imagens que contêm o sistema operacional Windows e só deve ser usado quando você possui licenças locais válidas para os Nós de Computação que serão implantados. Se omitido, nenhum desconto de licenciamento local será aplicado. Os valores são: Windows_Server - A licença local é para o Windows Server. Windows_Client - A licença local é para o Windows Client.
nodeAgentSKUId	string	A SKU do agente do Nó de Computação em Lote a ser provisionado em Nós de Computação no Pool. O agente Batch Compute Node é um programa que é 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 Batch. Existem diferentes implementações do agente Compute Node, conhecido como SKUs, para diferentes sistemas operacionais. Você deve especificar uma SKU do agente do Nó de Computação que corresponda à referência de Imagem selecionada. Para obter a lista de SKUs de agente de nó de computação suportados, juntamente com sua lista de referências de imagem verificadas, consulte a operação 'Listar SKUs de agente de nó de computação suportados'.
nodePlacementConfiguration	NodePlacementConfiguration	A configuração de posicionamento do nó para o pool. Essa configuração especificará regras sobre como os nós no pool serão fisicamente alocados.
osDisk	OSDisk	Configurações para o disco do sistema operacional da máquina virtual.
securityProfile	SecurityProfile	Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquina virtual. Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquina virtual.
serviceArtifactReference	ServiceArtifactReference	Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de escala ao usar a versão de imagem 'mais recente'. A ID de referência do artefato de serviço na forma de /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}
windowsConfiguration	WindowsConfiguration	Configurações do sistema operacional Windows na máquina virtual. Essa propriedade não deve ser especificada se a propriedade imageReference especificar uma imagem do sistema operacional Linux.

VMDiskSecurityProfile

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

Name	Tipo	Description
securityEncryptionType	SecurityEncryptionTypes	Especifica o EncryptionType do disco gerenciado. Ele é definido como VMGuestStateOnly para criptografia apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado do firmware no blob VMGuestState. Nota: Ele pode ser definido apenas para VMs confidenciais e é necessário ao usar VMs confidenciais.

VMExtension

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

Name	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 a 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.

Name	Tipo	Description
enableAutomaticUpdates	boolean	Se as atualizações automáticas estão habilitadas na máquina virtual. Se omitido, o valor padrão é true.

WindowsUserConfiguration

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

Name	Tipo	Description
loginMode	LoginMode	O modo de login para o usuário O padrão é 'lote'.