Pool - Add

Service:

Batch Service

API Version:

2023-11-01.18.0

Adiciona um Conjunto à Conta especificada.
Ao atribuir nomes a Conjuntos, evite incluir informações confidenciais, como nomes de utilizadores ou nomes de projetos secretos. Estas informações podem aparecer em registos de telemetria acessíveis a engenheiros Suporte da Microsoft.

POST {batchUrl}/pools?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools?timeout={timeout}&api-version=2023-11-01.18.0

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
batchUrl	path	True	string	O URL base para todos os pedidos de serviço Azure Batch.
api-version	query	True	string	Versão da API de Cliente.
timeout	query		integer int32	O tempo máximo que o servidor pode gastar a processar o pedido, em segundos. A predefinição é 30 segundos.

Cabeçalho do Pedido

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

Name	Necessário	Tipo	Description
client-request-id		string uuid	A identidade do pedido gerado pelo autor da chamada, sob a forma de um GUID sem decoração, como chavetas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se o servidor deve devolver o client-request-id na resposta.
ocp-date		string date-time-rfc1123	A hora em que o pedido foi emitido. Normalmente, as bibliotecas de cliente definem isto como a hora atual do relógio do sistema; defina-a explicitamente se estiver a chamar a API REST diretamente.

Corpo do Pedido

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

Name	Necessário	Tipo	Description
id	True	string	Uma cadeia que identifica exclusivamente o Conjunto na Conta. O ID pode conter qualquer combinação de carateres alfanuméricos, incluindo hífenes e carateres de sublinhado, e não pode conter mais de 64 carateres. O ID é de preservação de maiúsculas e minúsculas (ou seja, pode não ter dois IDs de Conjunto numa Conta que diferem apenas por maiúsculas e minúsculas).
vmSize	True	string	O tamanho das máquinas virtuais no Conjunto. Todas as máquinas virtuais num Conjunto têm o mesmo tamanho. Para obter informações sobre os tamanhos disponíveis das máquinas virtuais para conjuntos de Serviços Cloud (conjuntos criados com cloudServiceConfiguration), veja Tamanhos para Serviços Cloud (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). O Batch suporta todos os Serviços Cloud tamanhos de VM, exceto ExtraSmall, A1V2 e A2V2. Para obter informações sobre os tamanhos de VM disponíveis para Conjuntos com Imagens do Máquinas Virtuais Marketplace (conjuntos criados com virtualMachineConfiguration), consulte Tamanhos para Máquinas Virtuais (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) ou Tamanhos para Máquinas Virtuais (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). O Batch suporta todos os tamanhos de VM do Azure, exceto STANDARD_A0 e os que têm armazenamento premium (STANDARD_GS, STANDARD_DS e séries de STANDARD_DSV2).
applicationLicenses		string[]	A lista de licenças de aplicações que o serviço Batch disponibilizará em cada Nó de Computação no Conjunto. A lista de licenças de aplicações tem de ser um subconjunto de licenças de aplicações de serviço do Batch disponíveis. Se for pedida uma licença que não é suportada, a criação do Conjunto falhará.
applicationPackageReferences		ApplicationPackageReference[]	A lista de Pacotes a instalar em cada Nó de Computação no Conjunto. Ao criar um conjunto, o ID de aplicação do pacote tem de ser completamente qualificado (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). As alterações às Referências de pacotes afetam todos os novos Nós que se associam ao Conjunto, mas não afetam os Nós de Computação que já se encontram no Conjunto até serem reiniciados ou recriados. Existe um máximo de 10 Referências de pacotes em qualquer Conjunto especificado.
autoScaleEvaluationInterval		string	O intervalo de tempo no qual ajustar automaticamente o tamanho do Conjunto de acordo com a fórmula de dimensionamento automático. O valor predefinido é 15 minutos. O valor mínimo e máximo são 5 minutos e 168 horas, respetivamente. Se especificar um valor inferior a 5 minutos ou superior a 168 horas, o serviço Batch devolve um erro; se estiver a chamar a API REST diretamente, o código de estado HTTP é 400 (Pedido Incorreto).
autoScaleFormula		string	Uma fórmula para o número pretendido de Nós de Computação no Conjunto. Esta propriedade não pode ser especificada se enableAutoScale estiver definido como falso. É necessário se enableAutoScale estiver definido como verdadeiro. A fórmula é verificada quanto à validade antes de o Conjunto ser criado. Se a fórmula não for válida, o serviço Batch rejeita o pedido com informações de erro detalhadas. Para obter mais informações sobre como especificar esta fórmula, veja "Dimensionar automaticamente Nós de Computação num Conjunto de Azure Batch" (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).
certificateReferences		CertificateReference[]	A lista de Certificados a instalar em cada Nó de Computação no Conjunto. Para Nós do Windows, o serviço Batch instala os Certificados no arquivo e localização de Certificados especificados. Para Nós de Computação do Linux, os Certificados são armazenados num diretório dentro do diretório de trabalho de tarefas e é fornecida uma variável de ambiente AZ_BATCH_CERTIFICATES_DIR à Tarefa para consultar esta localização. Para Certificados com visibilidade de "remoteUser", é criado um diretório "certificados" no diretório raiz do utilizador (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 alternativa, utilize a Extensão Azure KeyVault .
cloudServiceConfiguration		CloudServiceConfiguration	A configuração do serviço cloud para o Conjunto. Esta propriedade e virtualMachineConfiguration são mutuamente exclusivas e uma das propriedades tem de ser especificada. Não é possível especificar esta propriedade se a Conta do Batch tiver sido criada com a respetiva propriedade poolAllocationMode definida como "UserSubscription".
displayName		string	O nome a apresentar do Conjunto. O nome a apresentar não tem de ser exclusivo e pode conter carateres Unicode até um comprimento máximo de 1024.
enableAutoScale		boolean	Se o tamanho do Conjunto deve ser ajustado automaticamente ao longo do tempo. Se for falso, tem de ser especificado pelo menos um dos targetDedicatedNodes e targetLowPriorityNodes. Se for verdadeiro, a propriedade autoScaleFormula é necessária e o Conjunto é redimensionado automaticamente de acordo com a fórmula. O valor predefinido é false.
enableInterNodeCommunication		boolean	Se o Conjunto permite a comunicação direta entre Nós de Computação. Ativar a comunicação entre nós limita o tamanho máximo do Conjunto devido a restrições de implementação nos Nós de Computação do Conjunto. Isto pode fazer com que o Conjunto não atinja o tamanho pretendido. O valor predefinido é false.
metadata		MetadataItem[]	Uma lista de pares nome-valor associados ao Conjunto como metadados. O serviço Batch não atribui qualquer significado aos metadados; destina-se apenas à utilização de código de utilizador.
mountConfiguration		MountConfiguration[]	Monte o armazenamento com o sistema de ficheiros especificado durante toda a duração do conjunto. Monte o armazenamento com o sistema de ficheiros baseado em Azure, NFS, CIFS ou Blobfuse.
networkConfiguration		NetworkConfiguration	A configuração de rede para o Conjunto. A configuração de rede de um Conjunto.
resizeTimeout		string	O tempo limite para a alocação de Nós de Computação no Conjunto. Este tempo limite aplica-se apenas ao dimensionamento manual; não tem qualquer efeito quando enableAutoScale está definido como verdadeiro. O valor predefinido é 15 minutos. O valor mínimo é 5 minutos. Se especificar um valor inferior a 5 minutos, o serviço Batch devolve um erro; se estiver a chamar a API REST diretamente, o código de estado HTTP é 400 (Pedido Incorreto).
resourceTags		object	As etiquetas especificadas pelo utilizador associadas ao conjunto. As etiquetas definidas pelo utilizador a serem associadas ao Conjunto de Azure Batch. Quando especificado, estas etiquetas são propagadas para os recursos do Azure de apoio associados ao conjunto. Esta propriedade só pode ser especificada quando a conta do 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 associa ao Conjunto. A Tarefa é executada quando o Nó de Computação é adicionado ao Conjunto ou quando o Nó de Computação é reiniciado.
targetDedicatedNodes		integer	O número pretendido de Nós de Computação dedicados no Conjunto. Esta propriedade não pode ser especificada se enableAutoScale estiver definido como verdadeiro. Se enableAutoScale estiver definido como falso, tem de definir targetDedicatedNodes, targetLowPriorityNodes ou ambos.
targetLowPriorityNodes		integer	O número pretendido de Nós de Computação Spot/Low-priority no Conjunto. Esta propriedade não pode ser especificada se enableAutoScale estiver definido como verdadeiro. Se enableAutoScale estiver definido como falso, tem de definir targetDedicatedNodes, targetLowPriorityNodes ou ambos.
targetNodeCommunicationMode		NodeCommunicationMode	O modo de comunicação do nó pretendido para o conjunto. Se for omitido, o valor predefinido é Predefinido.
taskSchedulingPolicy		TaskSchedulingPolicy	Como as Tarefas são distribuídas pelos Nós de Computação num Conjunto. Se não for especificado, a predefinição é propagada.
taskSlotsPerNode		integer	O número de blocos de tarefas que podem ser utilizados para executar tarefas simultâneas num único nó de computação no conjunto. O valor predefinido é 1. O valor máximo é o menor de 4 vezes o número de núcleos do vmSize do conjunto ou 256.
userAccounts		UserAccount[]	A lista de Contas de utilizador a criar em cada Nó de Computação no Conjunto.
virtualMachineConfiguration		VirtualMachineConfiguration	A configuração da máquina virtual para o Conjunto. Esta propriedade e cloudServiceConfiguration são mutuamente exclusivas e uma das propriedades tem de ser especificada.

Respostas

Name	Tipo	Description
201 Created		O pedido para o serviço Batch foi efetuado com êxito. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	O erro do serviço Batch.

Segurança

azure_auth

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

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Representar a sua conta de utilizador

Authorization

Type: apiKey
In: header

Exemplos

Add a CloudServiceConfiguration pool

Add a pool with accelerated networking

Add a pool with mount drive specified

Add a pool with SecurityProfile

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 CloudServiceConfiguration pool

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.0



{
  "id": "poolId",
  "vmSize": "small",
  "cloudServiceConfiguration": {
    "osFamily": "4"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Sample Response

Status code:

201

Add a pool with accelerated networking

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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
  }
}

Sample Response

Status code:

201

Add a pool with mount drive specified

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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
}

Sample Response

Status code:

201

Add a pool with SecurityProfile

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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
      }
    }
  },
  "targetDedicatedNodes": 1
}

Sample Response

Status code:

201

Add a simple pool with resourceTags

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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"
  }
}

Sample Response

Status code:

201

Add a VirtualMachineConfiguration pool

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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"
    }
  ]
}

Sample Response

Status code:

201

Add a VirtualMachineConfiguration pool with containers

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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
}

Sample Response

Status code:

201

Add a VirtualMachineConfiguration pool with extensions

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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"
}

Sample Response

Status code:

201

Add a VirtualMachineConfiguration pool with OS disk

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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
}

Sample Response

Status code:

201

Add a VirtualMachineConfiguration pool with ServiceArtifactReference

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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
}

Sample Response

Status code:

201

Definições

Name	Description
ApplicationPackageReference	Uma referência a um Pacote a ser implementado em Nós de Computação.
AutoUserScope	O âmbito do utilizador automático
AutoUserSpecification	Especifica os parâmetros para o utilizador automático que executa uma Tarefa no serviço Batch.
AzureBlobFileSystemConfiguration	Informações utilizadas para ligar a um Contentor de Armazenamento do Azure com o Blobfuse.
AzureFileShareConfiguration	Informações utilizadas para ligar a uma Partilha de Ficheiros do Azure.
BatchError	Uma resposta de erro recebida do serviço Azure Batch.
BatchErrorDetail	Um item de informações adicionais incluídas numa resposta de erro Azure Batch.
CachingType	O tipo de colocação em cache a ativar para o disco.
CertificateReference	Uma referência a um Certificado a ser instalado em Nós de Computação num Conjunto.
CertificateStoreLocation	A localização do Arquivo de certificados no Nó de Computação no qual instalar o Certificado.
CertificateVisibility	Que utilizador As Contas no Nó de Computação devem ter acesso aos dados privados do Certificado.
CIFSMountConfiguration	Informações utilizadas para ligar a um sistema de ficheiros CIFS.
CloudServiceConfiguration	A configuração para Nós de Computação num Conjunto com base na plataforma Serviços Cloud do Azure.
ComputeNodeFillType	Como as Tarefas são distribuídas pelos Nós de Computação num Conjunto.
ComputeNodeIdentityReference	A referência a uma identidade atribuída pelo utilizador associada ao conjunto do Batch que um nó de computação irá utilizar.
ContainerConfiguration	A configuração para Conjuntos preparados para contentores.
ContainerRegistry	Um registo de contentor privado.
ContainerType	A tecnologia de contentor a utilizar.
ContainerWorkingDirectory	A localização do diretório de trabalho da Tarefa de contentor.
DataDisk	Definições que serão utilizadas pelos discos de dados associados aos Nós de Computação no Conjunto. Ao utilizar discos de dados anexados, tem de montar e formatar os discos a partir de uma VM para os utilizar.
DiffDiskPlacement	Especifica a colocação do disco efémero para o disco do sistema operativo para todos os nós de computação (VMs) no conjunto.
DiffDiskSettings	Especifica as Definições de Disco Efémero para o disco do sistema operativo utilizado pelo nó de computação (VM).
DiskEncryptionConfiguration	A configuração de encriptação de disco aplicada nos nós de computação no conjunto. A configuração da encriptação de disco não é suportada no conjunto linux criado com a Imagem da Galeria de Computação do Azure.
DiskEncryptionTarget	A lista de destinos de disco do Serviço Batch será encriptada no nó de computação.
DynamicVNetAssignmentScope	O âmbito da atribuição de vnet dinâmica.
ElevationLevel	O nível de elevação do utilizador.
EnvironmentSetting	Uma variável de ambiente a definir num processo de Tarefa.
ErrorMessage	Uma mensagem de erro recebida numa resposta de erro Azure Batch.
ImageReference	Uma referência a uma Imagem do Marketplace do Azure Máquinas Virtuais ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências da imagem Azure Marketplace verificadas por Azure Batch, veja a operação "Listar Imagens Suportadas".
InboundEndpointProtocol	O protocolo do ponto final.
InboundNATPool	Um Conjunto NAT de entrada que pode ser utilizado para abordar portas específicas em Nós de Computação num Conjunto do Batch externamente.
IPAddressProvisioningType	O tipo de aprovisionamento para Endereços IP Públicos para o Conjunto.
LinuxUserConfiguration	Propriedades utilizadas para criar uma Conta de utilizador num Nó de Computação do Linux.
LoginMode	O modo de início de sessão do utilizador
ManagedDisk
MetadataItem	Um par name-value associado a um recurso do serviço Batch.
MountConfiguration	O sistema de ficheiros a montar em cada nó.
NetworkConfiguration	A configuração de rede de um Conjunto.
NetworkSecurityGroupRule	Uma regra de grupo de segurança de rede a aplicar a um ponto final de entrada.
NetworkSecurityGroupRuleAccess	A ação que deve ser efetuada para um endereço IP especificado, intervalo de sub-rede ou etiqueta.
NFSMountConfiguration	Informações utilizadas para ligar a um sistema de ficheiros NFS.
NodeCommunicationMode	Determina a forma como um conjunto comunica com o serviço Batch.
NodePlacementConfiguration	Configuração de colocação de nós para um conjunto.
NodePlacementPolicyType	A política de colocação para alocar nós no conjunto.
OSDisk	Definições para o disco do sistema operativo do nó de computação (VM).
PoolAddParameter	Um Conjunto no serviço Azure Batch a adicionar.
PoolEndpointConfiguration	A configuração do ponto final para um Conjunto.
PublicIPAddressConfiguration	A configuração do Endereço IP público da configuração de rede de um Conjunto.
ResourceFile	Um único ficheiro ou vários ficheiros a transferir para um Nó de Computação.
SecurityProfile	Especifica as definições do perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais.
SecurityTypes	Especifica o SecurityType da máquina virtual. Tem de ser definido para qualquer valor especificado para ativar UefiSettings.
ServiceArtifactReference	Especifica o ID de referência do artefacto de serviço utilizado para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de dimensionamento ao utilizar a versão de imagem "mais recente".
StartTask	Uma Tarefa que é executada quando um Nó associa um Conjunto no serviço Azure Batch ou quando o Nó de Computação é reiniciado ou reproduzido.
StorageAccountType	O tipo de Conta de armazenamento para utilização na criação de discos de dados ou disco do SO.
TaskContainerSettings	As definições de contentor para uma Tarefa.
TaskSchedulingPolicy	Especifica como as Tarefas devem ser distribuídas pelos Nós de Computação.
UefiSettings	Especifica as definições de segurança, como o arranque seguro e o vTPM utilizados ao criar a máquina virtual.
UserAccount	Propriedades utilizadas para criar um utilizador utilizado para executar Tarefas num Nó de Computação Azure Batch.
UserIdentity	A definição da identidade de utilizador na qual a Tarefa é executada.
VirtualMachineConfiguration	A configuração para Nós de Computação num Conjunto com base na infraestrutura de Máquinas Virtuais do Azure.
VMExtension	A configuração para extensões de máquinas virtuais.
WindowsConfiguration	Definições do sistema operativo Windows a aplicar à máquina virtual.
WindowsUserConfiguration	Propriedades utilizadas para criar uma Conta de utilizador num Nó de Computação do Windows.

ApplicationPackageReference

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

Name	Tipo	Description
applicationId	string	O ID da aplicação a implementar. Ao criar um conjunto, o ID da aplicação do pacote tem de ser completamente qualificado (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	A versão da aplicação a implementar. Se omitido, a versão predefinida é implementada. Se for omitido num Conjunto e não for especificada nenhuma versão predefinida para esta aplicação, o pedido falhará com o código de erro InvalidApplicationPackageReferences e o código de estado HTTP 409. Se isto for omitido numa Tarefa e não for especificada nenhuma versão predefinida para esta aplicação, a Tarefa falha com um erro de pré-processamento.

AutoUserScope

O âmbito do utilizador automático

Name	Tipo	Description
pool	string	Especifica que a Tarefa é executada como a Conta de utilizador automático comum que é criada em todos os Nós de Computação num Conjunto.
task	string	Especifica que o serviço deve criar um novo utilizador para a Tarefa.

AutoUserSpecification

Especifica os parâmetros para o utilizador automático que executa uma Tarefa no serviço Batch.

Name	Tipo	Description
elevationLevel	ElevationLevel	O nível de elevação do utilizador automático. O valor predefinido não éAdmin.
scope	AutoUserScope	O âmbito do utilizador automático O valor predefinido é conjunto. Se o conjunto estiver a executar o Windows, deve ser especificado um valor de Tarefa se for necessário um isolamento mais rigoroso entre as tarefas. Por exemplo, se a tarefa mudar o registo de uma forma que possa afetar outras tarefas ou se os certificados tiverem sido especificados no conjunto que não devem ser acessíveis por tarefas normais, mas devem ser acessíveis por StartTasks.

AzureBlobFileSystemConfiguration

Informações utilizadas para ligar a um Contentor de Armazenamento do Azure com o Blobfuse.

Name	Tipo	Description
accountKey	string	A chave da Conta de Armazenamento do Azure. Esta propriedade é mutuamente exclusiva com sasKey e identidade; tem de especificar exatamente um.
accountName	string	O nome da Conta de Armazenamento do Azure.
blobfuseOptions	string	Opções adicionais da linha de comandos para passar para o comando de montagem. Estas são opções de "utilização líquida" no Windows e opções de "montagem" no Linux.
containerName	string	O Armazenamento de Blobs do Azure Nome do contentor.
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída pelo utilizador a utilizar para aceder ao containerName Esta propriedade é mutuamente exclusiva com accountKey e sasKey; tem de especificar exatamente um.
relativeMountPath	string	O caminho relativo no nó de computação onde o sistema de ficheiros será montado Todos os sistemas de ficheiros são montados em relação ao diretório de montagem do Batch, acessível através da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.
sasKey	string	O token de SAS do Armazenamento do Microsoft Azure. Esta propriedade é mutuamente exclusiva com accountKey e identidade; tem de especificar exatamente um.

AzureFileShareConfiguration

Informações utilizadas para ligar a uma Partilha de Ficheiros do Azure.

Name	Tipo	Description
accountKey	string	A chave da conta de Armazenamento do Azure.
accountName	string	O nome da conta de Armazenamento do Azure.
azureFileUrl	string	O URL do Ficheiros do Azure. Este é do formulário "https://{account}.file.core.windows.net/".
mountOptions	string	Opções adicionais da linha de comandos para passar para o comando de montagem. Estas são opções de "utilização líquida" no Windows e opções de "montagem" no Linux.
relativeMountPath	string	O caminho relativo no nó de computação onde o sistema de ficheiros será montado Todos os sistemas de ficheiros são montados em relação ao diretório de montagem do Batch, acessível através da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.

BatchError

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

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 que descreve o erro, destinada a ser adequada para ser apresentada numa interface de utilizador.
values	BatchErrorDetail[]	Uma coleção de pares chave-valor que contém detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluídas numa resposta de erro Azure Batch.

Name	Tipo	Description
key	string	Um identificador que especifica o significado da propriedade Valor.
value	string	As informações adicionais incluídas na resposta do erro.

CachingType

O tipo de colocação em cache a ativar para o disco.

Name	Tipo	Description
none	string	O modo de colocação em cache do disco não está ativado.
readonly	string	O modo de colocação em cache do disco é só de leitura.
readwrite	string	O modo de colocação em cache do disco é lido e escrito.

CertificateReference

Uma referência a um Certificado a ser instalado em Nós de Computação num Conjunto.

Name	Tipo	Description
storeLocation	CertificateStoreLocation	A localização do Arquivo de certificados no Nó de Computação no qual pretende instalar o Certificado. O valor predefinido é currentuser. Esta propriedade é aplicável apenas a Conjuntos configurados com Nós de Computação do Windows (ou seja, criados com cloudServiceConfiguration ou com virtualMachineConfiguration com uma referência de Imagem do Windows). Para Nós de Computação do Linux, os Certificados são armazenados num diretório dentro do diretório de trabalho de tarefas e é fornecida uma variável de ambiente AZ_BATCH_CERTIFICATES_DIR à Tarefa para consultar esta localização. Para Certificados com visibilidade de "remoteUser", é criado um diretório "certificados" no diretório principal do utilizador (por exemplo, /home/{user-name}/certs) e os Certificados são colocados nesse diretório.
storeName	string	O nome do Arquivo de certificados no Nó de Computação no qual pretende instalar o Certificado. Esta propriedade é aplicável apenas a Conjuntos configurados com Nós de Computação do Windows (ou seja, criados com cloudServiceConfiguration ou com virtualMachineConfiguration com uma referência de Imagem do Windows). Os nomes de arquivo comuns incluem: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, mas também pode ser utilizado qualquer nome de arquivo personalizado. O valor predefinido é O Meu.
thumbprint	string	O thumbprint do Certificado.
thumbprintAlgorithm	string	O algoritmo com o qual o thumbprint está associado. Tem de ser sha1.
visibility	CertificateVisibility[]	Que contas de utilizador no Nó de Computação devem ter acesso aos dados privados do Certificado. Pode especificar mais do que uma visibilidade nesta coleção. A predefinição é todas as Contas.

CertificateStoreLocation

A localização do Arquivo de certificados no Nó de Computação no qual instalar o Certificado.

Name	Tipo	Description
currentuser	string	Os certificados devem ser instalados no arquivo de Certificados CurrentUser.
localmachine	string	Os certificados devem ser instalados no arquivo de Certificados LocalMachine.

CertificateVisibility

Que utilizador As Contas 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 utilizador nas quais os utilizadores acedem remotamente ao Nó de Computação.
starttask	string	O Certificado deve estar visível para a conta de utilizador na qual o StartTask é executado. Tenha em atenção que, se o Âmbito do AutoUser for Conjunto para o StartTask e uma Tarefa, este certificado também estará visível para a Tarefa.
task	string	O Certificado deve estar visível para as contas de utilizador nas quais as Tarefas de Trabalho são executadas.

CIFSMountConfiguration

Informações utilizadas para ligar a um sistema de ficheiros CIFS.

Name	Tipo	Description
mountOptions	string	Opções adicionais da linha de comandos para passar para o comando de montagem. Estas são opções de "utilização líquida" no Windows e opções de "montagem" no Linux.
password	string	A palavra-passe a utilizar para autenticação no sistema de ficheiros CIFS.
relativeMountPath	string	O caminho relativo no nó de computação onde o sistema de ficheiros será montado Todos os sistemas de ficheiros são montados em relação ao diretório de montagem do Batch, acessível através da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.
source	string	O URI do sistema de ficheiros a montar.
username	string	O utilizador a utilizar para autenticação no sistema de ficheiros CIFS.

CloudServiceConfiguration

A configuração para Nós de Computação num Conjunto com base na plataforma Serviços Cloud do Azure.

Name	Tipo	Description
osFamily	string	A família de SO Convidado do Azure a instalar nas máquinas virtuais do Conjunto. Os valores possíveis são: 2 - Família 2 do SO, equivalente ao Windows Server 2008 R2 SP1. 3 - Família do SO 3, equivalente a Windows Server 2012. 4 - Família do SO 4, equivalente a Windows Server 2012 R2. 5 - Família do SO 5, equivalente a Windows Server 2016. 6 - Família do SO 6, equivalente ao Windows Server 2019. Para obter mais informações, veja Lançamentos do SO Convidado do Azure (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).
osVersion	string	A versão do SO Convidado do Azure a instalar nas máquinas virtuais do Conjunto. O valor predefinido é * que especifica a versão mais recente do sistema operativo para a família de SO especificada.

ComputeNodeFillType

Como as Tarefas são distribuídas pelos Nós de Computação num Conjunto.

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 Conjunto antes de quaisquer Tarefas serem atribuídas ao próximo Nó de Computação no Conjunto.
spread	string	As tarefas devem ser atribuídas uniformemente em todos os Nós de Computação no Conjunto.

ComputeNodeIdentityReference

A referência a uma identidade atribuída pelo utilizador associada ao conjunto do Batch que um nó de computação irá utilizar.

Name	Tipo	Description
resourceId	string	O ID de recurso do ARM da identidade atribuída pelo utilizador.

ContainerConfiguration

A configuração para Conjuntos preparados para contentores.

Name	Tipo	Description
containerImageNames	string[]	A coleção de nomes de imagens de contentor. Esta é a referência de Imagem completa, tal como seria especificada para "docker pull". Uma Imagem será proveniente do registo predefinido do Docker, a menos que a Imagem esteja completamente qualificada com um registo alternativo.
containerRegistries	ContainerRegistry[]	Registos privados adicionais a partir dos quais os contentores podem ser extraídos. Se alguma Imagem tiver de ser transferida a partir de um registo privado que necessite de credenciais, essas credenciais têm de ser fornecidas aqui.
type	ContainerType	A tecnologia de contentor a utilizar.

ContainerRegistry

Um registo de contentor privado.

Name	Tipo	Description
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída pelo utilizador a utilizar para aceder a um Azure Container Registry em vez de nome de utilizador e palavra-passe. A referência a uma identidade atribuída pelo utilizador associada ao conjunto do Batch que um nó de computação irá utilizar.
password	string	A palavra-passe para iniciar sessão no servidor de registo.
registryServer	string	O URL do registo. Se for omitido, a predefinição é "docker.io".
username	string	O nome de utilizador a iniciar sessão no servidor de registo.

ContainerType

A tecnologia de contentor a utilizar.

Name	Tipo	Description
criCompatible	string	Será utilizada uma tecnologia baseada em CRI para iniciar os contentores.
dockerCompatible	string	Será utilizada uma tecnologia de contentor compatível com o Docker para iniciar os contentores.

ContainerWorkingDirectory

A localização do diretório de trabalho da Tarefa de contentor.

Name	Tipo	Description
containerImageDefault	string	Utilize o diretório de trabalho definido no contentor Imagem. Tenha em atenção que este diretório não conterá os Ficheiros de Recursos transferidos pelo Batch.
taskWorkingDirectory	string	Utilize o diretório de trabalho da Tarefa do serviço Batch padrão, que irá conter os Ficheiros de Recursos de Tarefa preenchidos pelo Batch.

DataDisk

Definições que serão utilizadas pelos discos de dados associados aos Nós de Computação no Conjunto. Ao utilizar discos de dados anexados, tem de montar e formatar os discos a partir de uma VM para os utilizar.

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

DiffDiskPlacement

Especifica a colocação do disco efémero para o disco do sistema operativo para todos os nós de computação (VMs) no conjunto.

Name	Tipo	Description
CacheDisk	string	O Disco de SO Efémero é armazenado na cache da VM.

DiffDiskSettings

Especifica as Definições de Disco Efémero para o disco do sistema operativo utilizado pelo nó de computação (VM).

Name	Tipo	Description
placement	DiffDiskPlacement	Especifica o posicionamento do disco efémero para o disco do sistema operativo para todas as VMs no conjunto. Esta propriedade pode ser utilizada pelo utilizador no pedido para escolher a localização, por exemplo, colocar espaço em disco em cache para o aprovisionamento de discos de SO Efémero. Para obter mais informações sobre os requisitos de tamanho do disco do SO efémero, veja Requisitos de tamanho de disco do SO efémero para VMs do Windows em https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e VMs do Linux em https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

DiskEncryptionConfiguration

A configuração de encriptação de disco aplicada nos nós de computação no conjunto. A configuração da encriptação de disco não é suportada no conjunto linux criado com a Imagem da Galeria de Computação do Azure.

Name	Tipo	Description
targets	DiskEncryptionTarget[]	A lista de destinos de disco do Batch Service será encriptada no nó de computação. Se omitido, nenhum disco nos nós de computação no conjunto será encriptado. No conjunto do Linux, apenas é suportado o "TemporaryDisk"; no conjunto do Windows, têm de ser especificados "OsDisk" e "TemporaryDisk".

DiskEncryptionTarget

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

Name	Tipo	Description
osdisk	string	O Disco do SO no nó de computação é encriptado.
temporarydisk	string	O disco temporário no nó de computação é encriptado. No Linux, esta encriptação aplica-se a outras partições (como as que estão em discos de dados montados) quando a encriptação ocorre no momento do arranque.

DynamicVNetAssignmentScope

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

Name	Tipo	Description
job	string	A atribuição de VNet dinâmica é efetuada por trabalho.
none	string	Não está ativada nenhuma atribuição de VNet dinâmica.

ElevationLevel

O nível de elevação do utilizador.

Name	Tipo	Description
admin	string	O utilizador é um utilizador com acesso elevado e funciona com permissões de Administrador completas.
nonadmin	string	O utilizador é um utilizador padrão sem acesso elevado.

EnvironmentSetting

Uma variável de ambiente a definir num processo de Tarefa.

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 numa resposta de erro Azure Batch.

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 Marketplace do Azure Máquinas Virtuais ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências da imagem Azure Marketplace verificadas por Azure Batch, veja a operação "Listar Imagens Suportadas".

Name	Tipo	Description
exactVersion	string	A versão específica da imagem da plataforma ou imagem do marketplace utilizada para criar o nó. Este campo só de leitura só difere de "versão" se o valor especificado para "versão" quando o conjunto foi criado for "mais recente".
offer	string	O tipo de oferta da Imagem do Azure Máquinas Virtuais Marketplace. Por exemplo, UbuntuServer ou WindowsServer.
publisher	string	O publicador da Imagem do Azure Máquinas Virtuais Marketplace. Por exemplo, Canonical ou MicrosoftWindowsServer.
sku	string	O SKU da Imagem do Azure Máquinas Virtuais Marketplace. Por exemplo, 18.04-LTS ou 2019-Datacenter.
version	string	A versão da Imagem do Azure Máquinas Virtuais Marketplace. Pode especificar um valor "mais recente" para selecionar a versão mais recente de uma Imagem. Se omitido, a predefinição é "mais recente".
virtualMachineImageId	string	O identificador de recursos do ARM da Imagem da Galeria de Computação do Azure. Os Nós de Computação no Conjunto serão criados com este ID de Imagem. Este é o formulário /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} ou /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} para predefinir sempre a versão mais recente da imagem. Esta propriedade é mutuamente exclusiva com outras propriedades ImageReference. A Imagem da Galeria de Computação do Azure tem de ter réplicas na mesma região e tem de estar na mesma subscrição que a conta Azure Batch. Se a versão da imagem não for especificada no imageId, será utilizada a versão mais recente. Para obter informações sobre as definições de firewall do agente do Nó de Computação do Batch para comunicar com o serviço Batch, consulte https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

InboundEndpointProtocol

O protocolo do ponto final.

Name	Tipo	Description
tcp	string	Utilize o TCP para o ponto final.
udp	string	Utilize o UDP para o ponto final.

InboundNATPool

Um Conjunto NAT de entrada que pode ser utilizado para abordar portas específicas em Nós de Computação num Conjunto do Batch externamente.

Name	Tipo	Description
backendPort	integer	O número da porta no Nó de Computação. Isto tem de ser exclusivo num Conjunto de Lotes. Os valores aceitáveis estão entre 1 e 65535, exceto 22, 3389, 29876 e 29877, uma vez que estes são reservados. Se forem fornecidos valores reservados, o pedido falhará com o código de estado HTTP 400.
frontendPortRangeEnd	integer	O último número de porta no intervalo de portas externas que serão utilizadas para fornecer acesso de entrada ao backendPort em Nós de Computação individuais. Os valores aceitáveis variam entre 1 e 65534, exceto as portas de 50000 a 55000 reservadas pelo serviço Batch. Todos os intervalos dentro de um Conjunto têm de ser distintos e não podem sobrepor-se. Cada intervalo tem de conter, pelo menos, 40 portas. Se forem fornecidos valores reservados ou sobrepostos, o pedido falhará com o código de estado HTTP 400.
frontendPortRangeStart	integer	O primeiro número de porta no intervalo de portas externas que será utilizado para fornecer acesso de entrada ao backendPort em Nós de Computação individuais. Os valores aceitáveis variam entre 1 e 65534, exceto as portas de 50000 a 55000 reservadas. Todos os intervalos dentro de um Conjunto têm de ser distintos e não podem sobrepor-se. Cada intervalo tem de conter, pelo menos, 40 portas. Se forem fornecidos valores reservados ou sobrepostos, o pedido falhará com o código de estado HTTP 400.
name	string	O nome do ponto final. O nome tem de ser exclusivo num Conjunto do Batch, pode conter letras, números, carateres de sublinhado, períodos e hífenes. Os nomes têm de começar com uma letra ou número, têm de terminar com uma letra, número ou caráter de sublinhado e não podem exceder os 77 carateres. Se forem fornecidos valores inválidos, o pedido falha com o código de estado HTTP 400.
networkSecurityGroupRules	NetworkSecurityGroupRule[]	Uma lista de regras do grupo de segurança de rede que serão aplicadas ao ponto final. O número máximo de regras que podem ser especificadas em todos os pontos finais de um Conjunto de Lotes é 25. Se não forem especificadas regras de grupo de segurança de rede, será criada uma regra predefinida para permitir o acesso de entrada ao backendPort especificado. Se o número máximo de regras do grupo de segurança de rede for excedido, o pedido falhará com o código de estado HTTP 400.
protocol	InboundEndpointProtocol	O protocolo do ponto final.

IPAddressProvisioningType

O tipo de aprovisionamento para Endereços IP Públicos para o Conjunto.

Name	Tipo	Description
batchmanaged	string	Será criado e gerido um IP público pelo Batch. Podem existir vários IPs públicos consoante o tamanho do Conjunto.
nopublicipaddresses	string	Não será criado nenhum Endereço IP público.
usermanaged	string	Os IPs públicos são fornecidos pelo utilizador e serão utilizados para aprovisionar os Nós de Computação.

LinuxUserConfiguration

Propriedades utilizadas para criar uma Conta de utilizador num Nó de Computação do Linux.

Name	Tipo	Description
gid	integer	O ID de grupo da Conta de utilizador. As propriedades uid e gid têm de ser especificadas em conjunto ou não. Se não for especificado, o sistema operativo subjacente escolhe o gid.
sshPrivateKey	string	A chave privada SSH para a Conta de utilizador. A chave privada não pode ser protegida por palavra-passe. A chave privada é utilizada para configurar automaticamente a autenticação baseada em chave assimétrica para SSH entre Nós de Computação num Conjunto do Linux quando a propriedade enableInterNodeCommunication do Conjunto é verdadeira (é ignorada se enableInterNodeCommunication for falsa). Fá-lo ao colocar o par de chaves no diretório .ssh do utilizador. Se não for especificado, o SSH sem palavra-passe não está configurado entre Nós de Computação (não é efetuada nenhuma modificação do diretório .ssh do utilizador).
uid	integer	O ID de utilizador da Conta de utilizador. As propriedades uid e gid têm de ser especificadas em conjunto ou não. Se não for especificado, o sistema operativo subjacente escolhe o uid.

LoginMode

O modo de início de sessão do utilizador

Name	Tipo	Description
batch	string	O LOGON32_LOGON_BATCH modo de início de sessão win32. O modo de início de sessão em lote é recomendado para processos paralelos de execução prolongada.
interactive	string	O LOGON32_LOGON_INTERACTIVE modo de início de sessão win32. O UAC está ativado em Conjuntos Windows VirtualMachineConfiguration. Se esta opção for utilizada com uma identidade de utilizador elevada num Conjunto de VirtualMachineConfiguration do Windows, a sessão de utilizador não será elevada a menos que a aplicação executada pela linha de comandos Tarefa esteja configurada para exigir sempre privilégios administrativos ou para exigir sempre o máximo de privilégios.

ManagedDisk

Name	Tipo	Description
storageAccountType	StorageAccountType	O tipo de conta de armazenamento para o disco gerido.

MetadataItem

Um par name-value associado a um recurso do serviço Batch.

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

MountConfiguration

O sistema de ficheiros a montar em cada nó.

Name	Tipo	Description
azureBlobFileSystemConfiguration	AzureBlobFileSystemConfiguration	O Contentor de Armazenamento do Azure a montar com o FUSE de blobs em cada nó. Esta propriedade é mutuamente exclusiva com todas as outras propriedades.
azureFileShareConfiguration	AzureFileShareConfiguration	A Partilha de Ficheiros do Azure a montar em cada nó. Esta propriedade é mutuamente exclusiva com todas as outras propriedades.
cifsMountConfiguration	CIFSMountConfiguration	O sistema de ficheiros CIFS/SMB a montar em cada nó. Esta propriedade é mutuamente exclusiva com todas as outras propriedades.
nfsMountConfiguration	NFSMountConfiguration	O sistema de ficheiros NFS a montar em cada nó. Esta propriedade é mutuamente exclusiva com todas as outras propriedades.

NetworkConfiguration

A configuração de rede de um Conjunto.

Name	Tipo	Description
dynamicVNetAssignmentScope	DynamicVNetAssignmentScope	O âmbito da atribuição de vnet dinâmica.
enableAcceleratedNetworking	boolean	Se este conjunto deve ativar 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 desempenho de rede melhorado. Para obter mais detalhes, veja: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.
endpointConfiguration	PoolEndpointConfiguration	A configuração para pontos finais em Nós de Computação no Conjunto de Lotes. A configuração do ponto final do conjunto só é suportada em Conjuntos com a propriedade virtualMachineConfiguration.
publicIPAddressConfiguration	PublicIPAddressConfiguration	A configuração do IPAddress Público para Nós de Computação no Conjunto de Lotes. A propriedade de configuração de IP público só é suportada em Conjuntos com a propriedade virtualMachineConfiguration.
subnetId	string	O identificador de recursos do ARM da sub-rede de rede virtual a que os Nós de Computação do Conjunto serão associados. Este é do formulário /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. A rede virtual tem de estar na mesma região e subscrição que a Conta de Azure Batch. A sub-rede especificada deve ter endereços IP gratuitos suficientes para acomodar o número de Nós de Computação no Conjunto. Se a sub-rede não tiver endereços IP gratuitos suficientes, o Conjunto irá alocar parcialmente Nós e ocorrerá um erro de redimensionamento. O principal de serviço "MicrosoftAzureBatch" tem de ter a função "Contribuidor de Máquina Virtual Clássica" Role-Based Controlo de Acesso (RBAC) para a VNet especificada. A sub-rede especificada tem de permitir que a comunicação do serviço de Azure Batch possa agendar Tarefas nos Nós. Isto pode ser verificado ao verificar se a VNet especificada tem algum Grupo de Segurança de Rede (NSG) associado. Se a comunicação com os Nós na sub-rede especificada for negada por um NSG, o serviço Batch definirá o estado dos Nós de Computação como inutilizável. Para Conjuntos criados com virtualMachineConfiguration apenas são suportadas redes virtuais arm ('Microsoft.Network/virtualNetworks'), mas para Conjuntos criados com cloudServiceConfiguration, tanto o ARM como as redes virtuais clássicas são suportados. Se a VNet especificada tiver grupos de segurança de rede (NSG) associados, têm de ser ativadas algumas portas do sistema reservadas para a comunicação de entrada. Para Conjuntos criados com uma configuração de máquina virtual, ative as portas 29876 e 29877, bem como a porta 22 para Linux e a porta 3389 para Windows. Para Conjuntos criados com uma configuração de serviço cloud, ative as portas 10100, 20100 e 30100. Ative também as ligações de saída para o Armazenamento do Azure na porta 443. Para obter mais detalhes, veja: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Uma regra de grupo de segurança de rede a aplicar a um ponto final de entrada.

Name	Tipo	Description
access	NetworkSecurityGroupRuleAccess	A ação que deve ser efetuada para um endereço IP especificado, intervalo de sub-rede ou etiqueta.
priority	integer	A prioridade para esta regra. As prioridades num Conjunto têm de ser exclusivas e são avaliadas por ordem de prioridade. Quanto menor for o número, maior será a prioridade. Por exemplo, as regras podem ser especificadas com números de encomenda de 150, 250 e 350. A regra com o número de encomenda de 150 tem precedência sobre a regra que tem uma ordem de 250. As prioridades permitidas são de 150 a 4096. Se forem fornecidos valores reservados ou duplicados, o pedido falhará com o código de estado HTTP 400.
sourceAddressPrefix	string	O prefixo ou etiqueta do endereço de origem para corresponder à 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), etiqueta predefinida ou * (para todos os endereços). Se forem fornecidos outros valores, o pedido falhará com o código de estado HTTP 400.
sourcePortRanges	string[]	Os intervalos de portas de origem correspondem à 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 têm de estar entre 0 e 65535. Cada entrada nesta coleção não pode sobrepor-se a qualquer outra entrada (um intervalo ou uma porta individual). Se forem fornecidos outros valores, o pedido falhará com o código de estado HTTP 400. O valor predefinido é "".

NetworkSecurityGroupRuleAccess

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

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

NFSMountConfiguration

Informações utilizadas para ligar a um sistema de ficheiros NFS.

Name	Tipo	Description
mountOptions	string	Opções adicionais da linha de comandos para passar para o comando de montagem. Estas são opções de "utilização líquida" no Windows e opções de "montagem" no Linux.
relativeMountPath	string	O caminho relativo no nó de computação onde o sistema de ficheiros será montado Todos os sistemas de ficheiros são montados em relação ao diretório de montagem do Batch, acessível através da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.
source	string	O URI do sistema de ficheiros a montar.

NodeCommunicationMode

Determina a forma como um conjunto comunica com o serviço Batch.

Name	Tipo	Description
classic	string	Os nós que utilizam o modo de comunicação clássico requerem comunicação TCP de entrada nas portas 29876 e 29877 a partir do "BatchNodeManagement. {region}" etiqueta de serviço e comunicação TCP de saída na porta 443 para "Storage.region" e "BatchNodeManagement. {region}" etiquetas de serviço.
default	string	O modo de comunicação do nó é definido automaticamente pelo serviço Batch.
simplified	string	Os nós que utilizam 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 colocação de nós para um conjunto.

Name	Tipo	Description
policy	NodePlacementPolicyType	Tipo de política de colocação de nós em Conjuntos do Batch. Política de alocação utilizada pelo Batch Service para aprovisionar os nós. Se não for especificado, o Batch utilizará a política regional.

NodePlacementPolicyType

A política de colocação para alocar nós no conjunto.

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

OSDisk

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

Name	Tipo	Description
caching	CachingType	Especifica os requisitos de colocação em cache. Os valores possíveis são: None, ReadOnly, ReadWrite. Os valores predefinidos são: Nenhum para armazenamento Standard. ReadOnly para armazenamento Premium. O valor predefinido para colocação em cache é nenhum. Para obter informações sobre as opções de colocação em cache, consulte: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
diskSizeGB	integer	O tamanho do disco inicial em GB ao criar um novo disco do SO.
ephemeralOSDiskSettings	DiffDiskSettings	Especifica as Definições de Disco Efémero para o disco do sistema operativo utilizado pelo nó de computação (VM).
managedDisk	ManagedDisk	Os parâmetros do disco gerido.
writeAcceleratorEnabled	boolean	Especifica se writeAccelerator deve ser ativado ou desativado no disco.

PoolAddParameter

Um Conjunto no serviço Azure Batch a adicionar.

Name	Tipo	Description
applicationLicenses	string[]	A lista de licenças de aplicação que o serviço Batch disponibilizará em cada Nó de Computação no Conjunto. A lista de licenças de aplicação tem de ser um subconjunto de licenças de aplicações do serviço Batch disponíveis. Se for pedida uma licença que não é suportada, a criação do Conjunto falhará.
applicationPackageReferences	ApplicationPackageReference[]	A lista de Pacotes a instalar em cada Nó de Computação no Conjunto. Ao criar um conjunto, o ID da aplicação do pacote tem de ser completamente qualificado (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). As alterações às referências de Pacotes afetam todos os novos Nós que associam o Conjunto, mas não afetam os Nós de Computação que já se encontram no Conjunto até serem reiniciados ou reimagedos. Existe um máximo de 10 Referências de pacotes em qualquer conjunto especificado.
autoScaleEvaluationInterval	string	O intervalo de tempo para ajustar automaticamente o tamanho do Conjunto de acordo com a fórmula de dimensionamento automático. O valor predefinido é 15 minutos. O valor mínimo e máximo são 5 minutos e 168 horas, respetivamente. Se especificar um valor inferior a 5 minutos ou superior a 168 horas, o serviço Batch devolve um erro; se estiver a chamar a API REST diretamente, o código de estado HTTP é 400 (Pedido Incorreto).
autoScaleFormula	string	Uma fórmula para o número pretendido de Nós de Computação no Conjunto. Esta propriedade não pode ser especificada se enableAutoScale estiver definido como falso. É necessário se enableAutoScale estiver definido como verdadeiro. A fórmula é verificada quanto à validade antes da criação do Conjunto. Se a fórmula não for válida, o serviço Batch rejeita o pedido com informações de erro detalhadas. Para obter mais informações sobre como especificar esta fórmula, veja "Dimensionar automaticamente Nós de Computação num Conjunto de Azure Batch" (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).
certificateReferences	CertificateReference[]	A lista de Certificados a instalar em cada Nó de Computação no Conjunto. Para Os Nós do Windows, o serviço Batch instala os Certificados no arquivo e localização de Certificados especificados. Para Nós de Computação do Linux, os Certificados são armazenados num diretório dentro do diretório de trabalho de tarefas e é fornecida uma variável de ambiente AZ_BATCH_CERTIFICATES_DIR à Tarefa para consultar esta localização. Para Certificados com visibilidade de "remoteUser", é criado um diretório "certificados" no diretório principal do utilizador (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 alternativa, utilize a Extensão Azure KeyVault .
cloudServiceConfiguration	CloudServiceConfiguration	A configuração do serviço cloud para o Conjunto. Esta propriedade e virtualMachineConfiguration são mutuamente exclusivas e uma das propriedades tem de ser especificada. Não é possível especificar esta propriedade se a Conta do Batch tiver sido criada com a respetiva propriedade poolAllocationMode definida como "UserSubscription".
displayName	string	O nome a apresentar do Conjunto. O nome a apresentar não tem de ser exclusivo e pode conter carateres Unicode até um comprimento máximo de 1024.
enableAutoScale	boolean	Se o tamanho do Conjunto deve ser ajustado automaticamente ao longo do tempo. Se for falso, tem de ser especificado pelo menos um dos targetDedicatedNodes e targetLowPriorityNodes. Se for verdadeiro, a propriedade autoScaleFormula é necessária e o Conjunto é redimensionado automaticamente de acordo com a fórmula. O valor predefinido é false.
enableInterNodeCommunication	boolean	Se o Conjunto permite a comunicação direta entre Nós de Computação. Ativar a comunicação entre nós limita o tamanho máximo do Conjunto devido a restrições de implementação nos Nós de Computação do Conjunto. Isto pode fazer com que o Conjunto não atinja o tamanho pretendido. O valor predefinido é false.
id	string	Uma cadeia que identifica exclusivamente o Conjunto na Conta. O ID pode conter qualquer combinação de carateres alfanuméricos, incluindo hífenes e carateres de sublinhado, e não pode conter mais de 64 carateres. O ID é de preservação de maiúsculas e minúsculas (ou seja, pode não ter dois IDs de Conjunto numa Conta que diferem apenas por maiúsculas e minúsculas).
metadata	MetadataItem[]	Uma lista de pares name-value associados ao Conjunto como metadados. O serviço Batch não atribui qualquer significado aos metadados; destina-se exclusivamente à utilização do código de utilizador.
mountConfiguration	MountConfiguration[]	Montar o armazenamento com o sistema de ficheiros especificado durante toda a duração do conjunto. Monte o armazenamento com o sistema de ficheiros baseado em Ficheiros do Azure, NFS, CIFS ou Blobfuse.
networkConfiguration	NetworkConfiguration	A configuração de rede do Conjunto. A configuração de rede de um Conjunto.
resizeTimeout	string	O tempo limite para a alocação de Nós de Computação no Conjunto. Este tempo limite aplica-se apenas ao dimensionamento manual; não tem qualquer efeito quando enableAutoScale está definido como verdadeiro. O valor predefinido é 15 minutos. O valor mínimo é 5 minutos. Se especificar um valor inferior a 5 minutos, o serviço Batch devolve um erro; se estiver a chamar a API REST diretamente, o código de estado HTTP é 400 (Pedido Incorreto).
resourceTags	object	As etiquetas especificadas pelo utilizador associadas ao conjunto. As etiquetas definidas pelo utilizador a serem associadas ao Conjunto de Azure Batch. Quando especificado, estas etiquetas são propagadas para os recursos do Azure de apoio associados ao conjunto. Esta propriedade só pode ser especificada quando a conta do 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 associa ao Conjunto. A Tarefa é executada quando o Nó de Computação é adicionado ao Conjunto ou quando o Nó de Computação é reiniciado.
targetDedicatedNodes	integer	O número pretendido de Nós de Computação dedicados no Conjunto. Esta propriedade não pode ser especificada se enableAutoScale estiver definido como verdadeiro. Se enableAutoScale estiver definido como falso, tem de definir targetDedicatedNodes, targetLowPriorityNodes ou ambos.
targetLowPriorityNodes	integer	O número pretendido de Nós de Computação Spot/Low-priority no Conjunto. Esta propriedade não pode ser especificada se enableAutoScale estiver definido como verdadeiro. Se enableAutoScale estiver definido como falso, tem de definir targetDedicatedNodes, targetLowPriorityNodes ou ambos.
targetNodeCommunicationMode	NodeCommunicationMode	O modo de comunicação de nó pretendido para o conjunto. Se omitido, o valor predefinido é Predefinido.
taskSchedulingPolicy	TaskSchedulingPolicy	Como as Tarefas são distribuídas pelos Nós de Computação num Conjunto. Se não for especificado, a predefinição é distribuída.
taskSlotsPerNode	integer	O número de blocos de tarefas que podem ser utilizados para executar tarefas simultâneas num único nó de computação no conjunto. O valor predefinido é 1. O valor máximo é o menor de 4 vezes o número de núcleos da vmSize do conjunto ou 256.
userAccounts	UserAccount[]	A lista de Contas de utilizador a criar em cada Nó de Computação no Conjunto.
virtualMachineConfiguration	VirtualMachineConfiguration	A configuração da máquina virtual para o Conjunto. Esta propriedade e cloudServiceConfiguration são mutuamente exclusivas e uma das propriedades tem de ser especificada.
vmSize	string	O tamanho das máquinas virtuais no Conjunto. Todas as máquinas virtuais num Conjunto têm o mesmo tamanho. Para obter informações sobre os tamanhos disponíveis das máquinas virtuais para conjuntos de Serviços Cloud (conjuntos criados com cloudServiceConfiguration), veja Tamanhos para Serviços Cloud (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). O Batch suporta todos os Serviços Cloud tamanhos de VM, exceto ExtraSmall, A1V2 e A2V2. Para obter informações sobre os tamanhos de VM disponíveis para Conjuntos com Imagens do Máquinas Virtuais Marketplace (conjuntos criados com virtualMachineConfiguration), consulte Tamanhos para Máquinas Virtuais (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) ou Tamanhos para Máquinas Virtuais (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). O Batch suporta todos os tamanhos de VM do Azure, exceto STANDARD_A0 e os que têm armazenamento premium (STANDARD_GS, STANDARD_DS e séries de STANDARD_DSV2).

PoolEndpointConfiguration

A configuração do ponto final para um Conjunto.

Name	Tipo	Description
inboundNATPools	InboundNATPool[]	Uma lista de Conjuntos NAT de entrada que podem ser utilizados para abordar portas específicas num Nó de Computação individual externamente. O número máximo de Conjuntos NAT de entrada por Conjunto do Batch é 5. Se o número máximo de Conjuntos NAT de entrada for excedido, o pedido falhará com o código de estado HTTP 400. Não é possível especificar esta opção se IPAddressProvisioningType for NoPublicIPAddresses.

PublicIPAddressConfiguration

A configuração do Endereço IP público da configuração de rede de um Conjunto.

Name	Tipo	Description
ipAddressIds	string[]	A lista de IPs públicos que o serviço Batch irá utilizar ao aprovisionar Nós de Computação. O número de IPs especificados aqui limita o tamanho máximo do Conjunto – podem ser alocados 100 nós dedicados ou 100 nós Spot/De baixa prioridade para cada IP público. Por exemplo, um conjunto que necessite de 250 VMs dedicadas precisaria de, pelo menos, 3 IPs públicos especificados. Cada elemento desta coleção é do formulário: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.
provision	IPAddressProvisioningType	O tipo de aprovisionamento para Endereços IP Públicos para o Conjunto. O valor predefinido é BatchManaged.

ResourceFile

Um único ficheiro ou vários ficheiros a transferir para um Nó de Computação.

Name	Tipo	Description
autoStorageContainerName	string	O nome do contentor de armazenamento na Conta de armazenamento automático. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas tem de ser especificada.
blobPrefix	string	O prefixo de blobs a utilizar ao transferir blobs a partir de um contentor do Armazenamento do Azure. Apenas os blobs cujos nomes começam com o prefixo especificado serão transferidos. A propriedade só é válida quando autoStorageContainerName ou storageContainerUrl é utilizado. Este prefixo pode ser um nome de ficheiro parcial ou um subdiretório. Se não for especificado um prefixo, todos os ficheiros no contentor serão transferidos.
fileMode	string	O atributo do modo de permissão de ficheiro no formato octal. Esta propriedade aplica-se apenas aos ficheiros que estão a ser transferidos para Nós de Computação do Linux. Será ignorado se for especificado para um resourceFile que será transferido para um Nó de Computação do Windows. Se esta propriedade não for especificada para um Nó de Computação do Linux, será aplicado um valor predefinido de 0770 ao ficheiro.
filePath	string	A localização no Nó de Computação para o qual transferir os ficheiros, relativamente ao diretório de trabalho da Tarefa. Se a propriedade httpUrl for especificada, o filePath é necessário e descreve o caminho para o qual o ficheiro será transferido, incluindo o nome do ficheiro. Caso contrário, se a propriedade autoStorageContainerName ou storageContainerUrl for especificada, filePath é opcional e é o diretório para o qual pretende transferir os ficheiros. No caso de filePath ser utilizado como um diretório, qualquer estrutura de diretório já associada aos dados de entrada será mantida na totalidade e anexada ao diretório filePath especificado. O caminho relativo especificado não consegue sair do diretório de trabalho da Tarefa (por exemplo, utilizando ".").
httpUrl	string	O URL do ficheiro a transferir. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas tem de ser especificada. Se o URL apontar para Armazenamento de Blobs do Azure, tem de ser legível a partir de nós de computação. Existem três formas de obter esse URL para um blob no armazenamento do Azure: incluir uma Assinatura de Acesso Partilhado (SAS) que concede permissões de leitura no blob, utilizar uma identidade gerida com permissão de leitura ou definir a ACL para o blob ou o respetivo contentor para permitir o acesso público.
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída pelo utilizador a utilizar para aceder a Armazenamento de Blobs do Azure especificado por storageContainerUrl ou httpUrl A referência a uma identidade atribuída pelo utilizador associada ao conjunto do Batch que um nó de computação irá utilizar.
storageContainerUrl	string	O URL do contentor de blobs no Armazenamento de Blobs do Azure. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas tem de ser especificada. Este URL tem de ser legível e listável a partir de nós de computação. Existem três formas de obter esse URL para um contentor no armazenamento do Azure: incluir uma Assinatura de Acesso Partilhado (SAS) que concede permissões de leitura e lista no contentor, utilizar uma identidade gerida com permissões de leitura e lista ou definir a ACL para o contentor para permitir o acesso público.

SecurityProfile

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

Name	Tipo	Description
encryptionAtHost	boolean	Esta propriedade pode ser utilizada pelo utilizador no pedido para ativar ou desativar a Encriptação de Anfitrião para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais. Isto irá ativar a encriptação para todos os discos, incluindo o disco Recurso/Temp no próprio anfitrião.
securityType	SecurityTypes	Especifica o SecurityType da máquina virtual. Tem de ser definido para qualquer valor especificado para ativar UefiSettings.
uefiSettings	UefiSettings	Especifica as definições de segurança, como o arranque seguro e o vTPM utilizados ao criar a máquina virtual. Especifica as definições de segurança, como o arranque seguro e o vTPM utilizados ao criar a máquina virtual.

SecurityTypes

Especifica o SecurityType da máquina virtual. Tem de ser definido para qualquer valor especificado para ativar UefiSettings.

Name	Tipo	Description
trustedLaunch	string	O lançamento fidedigno protege contra técnicas de ataque avançadas e persistentes.

ServiceArtifactReference

Especifica o ID de referência do artefacto de serviço utilizado para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de dimensionamento ao utilizar a versão de imagem "mais recente".

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

StartTask

Uma Tarefa que é executada quando um Nó associa um Conjunto no serviço Azure Batch ou quando o Nó de Computação é reiniciado ou reproduzido.

Name	Tipo	Description
commandLine	string	A linha de comandos do StartTask. A linha de comandos não é executada sob uma shell e, por conseguinte, não pode tirar partido das funcionalidades da shell, como a expansão da variável de ambiente. Se quiser tirar partido destas funcionalidades, deve invocar a shell na linha de comandos, por exemplo, utilizando "cmd /c MyCommand" no Windows ou "/bin/sh -c MyCommand" no Linux. Se a linha de comandos se referir a caminhos de ficheiro, deve utilizar um caminho relativo (relativamente ao diretório de trabalho da tarefa) ou utilizar a variável de ambiente fornecido pelo Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
containerSettings	TaskContainerSettings	As definições do contentor no qual o StartTask é executado. Quando for especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios Azure Batch no nó) são mapeados para o contentor, todas as variáveis de ambiente de tarefas são mapeadas para o contentor e a linha de comandos Tarefa é executada no contentor. Os ficheiros produzidos no contentor fora do AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos no disco anfitrião, o que significa que as APIs de ficheiro do Batch não poderão aceder a esses ficheiros.
environmentSettings	EnvironmentSetting[]	Uma lista de definiçõ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 Batch repetirá uma Tarefa se o código de saída não forzero. Tenha em atenção que este valor controla especificamente o número de tentativas. O serviço Batch tentará a Tarefa uma vez e, em seguida, poderá repetir até este limite. Por exemplo, se a contagem máxima de repetições for 3, o Batch tentará a Tarefa até 4 vezes (uma tentativa inicial e três repetições). Se a contagem máxima de repetições for 0, o serviço Batch não repetirá a Tarefa. Se a contagem máxima de repetições for -1, o serviço Batch repetirá a Tarefa sem limite, no entanto não é recomendado para uma tarefa de início ou qualquer tarefa. O valor predefinido é 0 (sem repetições).
resourceFiles	ResourceFile[]	Uma lista de ficheiros que o serviço Batch irá transferir para o Nó de Computação antes de executar a linha de comandos. Existe um tamanho máximo para a lista de ficheiros de recursos. Quando o tamanho máximo for excedido, o pedido falhará e o código de erro de resposta será RequestEntityTooLarge. Se isto ocorrer, a coleção de ResourceFiles tem de ser reduzida em tamanho. Isto pode ser conseguido com .zip ficheiros, Pacotes de Aplicações ou Contentores do Docker. Os ficheiros listados neste elemento estão localizados no diretório de trabalho da Tarefa.
userIdentity	UserIdentity	A identidade de utilizador na qual o StartTask é executado. Se omitido, a Tarefa é executada como um utilizador não administrativo exclusivo da Tarefa.
waitForSuccess	boolean	Se o serviço Batch deve aguardar que o StartTask seja concluído com êxito (ou seja, sair com o código de saída 0) antes de agendar quaisquer Tarefas no Nó de Computação. Se for verdadeiro e o StartTask falhar num Nó, o serviço Batch repete o StartTask até à contagem máxima de repetições (maxTaskRetryCount). Se a Tarefa ainda não tiver sido concluída com êxito após todas as repetições, o serviço Batch marca o Nó inutilizável e não agendará Tarefas para o mesmo. Esta condição pode ser detetada através do estado do Nó de Computação e dos detalhes das informações de falha. Se for falso, o serviço Batch não aguardará pela conclusão do StartTask. Neste 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, as novas Tarefas continuarão a ser agendadas no Nó de Computação. A predefinição é verdadeira.

StorageAccountType

O tipo de Conta de armazenamento para utilização na criação de discos de dados ou disco do SO.

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

TaskContainerSettings

As definições de contentor para uma Tarefa.

Name	Tipo	Description
containerRunOptions	string	Opções adicionais para o comando de criação de contentor. Estas opções adicionais são fornecidas como argumentos para o comando "docker create", além das que são controladas pelo Serviço Batch.
imageName	string	A Imagem a utilizar para criar o contentor no qual a Tarefa será executada. Esta é a referência de Imagem completa, tal como seria especificada para "docker pull". Se não for fornecida nenhuma etiqueta como parte do Nome da imagem, a etiqueta ":latest" é utilizada como predefinição.
registry	ContainerRegistry	O registo privado que contém o contentor Imagem. Esta definição pode ser omitida se já tiver sido fornecida na criação do Conjunto.
workingDirectory	ContainerWorkingDirectory	A localização do diretório de trabalho tarefa do contentor. A predefinição é "taskWorkingDirectory".

TaskSchedulingPolicy

Especifica como as Tarefas devem ser distribuídas pelos Nós de Computação.

Name	Tipo	Description
nodeFillType	ComputeNodeFillType	Como as Tarefas são distribuídas pelos Nós de Computação num Conjunto. Se não for especificado, a predefinição é distribuída.

UefiSettings

Especifica as definições de segurança, como o arranque seguro e o vTPM utilizados ao criar a máquina virtual.

Name	Tipo	Description
secureBootEnabled	boolean	Especifica se o arranque seguro deve ser ativado na máquina virtual.
vTpmEnabled	boolean	Especifica se o vTPM deve ser ativado na máquina virtual.

UserAccount

Propriedades utilizadas para criar um utilizador utilizado para executar Tarefas num Nó de Computação Azure Batch.

Name	Tipo	Description
elevationLevel	ElevationLevel	O nível de elevação da Conta de utilizador. O valor predefinido não éAdmin.
linuxUserConfiguration	LinuxUserConfiguration	A configuração de utilizador específica do Linux para a Conta de utilizador. Esta propriedade é ignorada se for especificada num Conjunto do Windows. Se não for especificado, o utilizador é criado com as opções predefinidas.
name	string	O nome da Conta de utilizador. Os nomes podem conter quaisquer carateres Unicode até um comprimento máximo de 20.
password	string	A palavra-passe da Conta de utilizador.
windowsUserConfiguration	WindowsUserConfiguration	A configuração de utilizador específica do Windows para a Conta de utilizador. Esta propriedade só pode ser especificada se o utilizador estiver num Conjunto do Windows. Se não for especificado e num Conjunto do Windows, o utilizador é criado com as opções predefinidas.

UserIdentity

A definição da identidade de utilizador na qual a Tarefa é executada.

Name	Tipo	Description
autoUser	AutoUserSpecification	O utilizador automático no qual a Tarefa é executada. As propriedades userName e autoUser são mutuamente exclusivas; tem de especificar um, mas não ambos.
username	string	O nome da identidade de utilizador na qual a Tarefa é executada. As propriedades userName e autoUser são mutuamente exclusivas; tem de especificar um, mas não ambos.

VirtualMachineConfiguration

A configuração para Nós de Computação num Conjunto com base na infraestrutura de Máquinas Virtuais do Azure.

Name	Tipo	Description
containerConfiguration	ContainerConfiguration	A configuração do contentor do Conjunto. Se especificado, a configuração é efetuada em cada Nó de Computação no Conjunto para permitir que as Tarefas sejam executadas em contentores. Todas as Tarefas regulares e Tarefas do Gestor de Tarefas executadas neste Conjunto têm de especificar a propriedade containerSettings e todas as outras Tarefas podem especificá-la.
dataDisks	DataDisk[]	A configuração dos discos de dados anexados aos Nós de Computação no Conjunto. Esta propriedade tem de ser especificada se os Nós de Computação no Conjunto precisarem de ter discos de dados vazios ligados aos mesmos. Não é possível atualizá-lo. Cada Nó de Computação obtém o seu próprio disco (o disco não é uma partilha de ficheiros). Não é possível anexar discos existentes, cada disco anexado está vazio. Quando o Nó de Computação é removido do Conjunto, o disco e todos os dados associados ao mesmo também são eliminados. O disco não está formatado depois de ser anexado, tem de ser formatado antes da utilização . Para obter mais informações, consulte https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux e https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.
diskEncryptionConfiguration	DiskEncryptionConfiguration	A configuração de encriptação do disco para o conjunto. Se especificado, a encriptação é efetuada em cada nó no conjunto durante o aprovisionamento de nós.
extensions	VMExtension[]	A extensão da máquina virtual para o conjunto. Se especificado, as extensões mencionadas nesta configuração serão instaladas em cada nó.
imageReference	ImageReference	Uma referência à Imagem do Azure Máquinas Virtuais Marketplace ou à Imagem de Máquina Virtual personalizada a utilizar.
licenseType	string	O tipo de licença no local a utilizar ao implementar o sistema operativo. Isto aplica-se apenas a Imagens que contenham o sistema operativo Windows e só devem ser utilizadas quando tiver licenças válidas no local para os Nós de Computação que serão implementados. Se omitido, não é aplicado nenhum desconto de licenciamento no local. Os valores são: Windows_Server – a licença no local destina-se ao Windows Server. Windows_Client – a licença no local destina-se ao Cliente Windows.
nodeAgentSKUId	string	O SKU do agente do Nó de Computação do Batch a aprovisionar em Nós de Computação no Conjunto. O agente do Nó de Computação do Batch é um programa que é executado em cada Nó de Computação no Conjunto e fornece a interface de comando e controlo entre o Nó de Computação e o serviço Batch. Existem diferentes implementações do agente de Nó de Computação, conhecido como SKUs, para diferentes sistemas operativos. Tem de especificar um SKU do agente de Nó de Computação que corresponda à referência de Imagem selecionada. Para obter a lista de SKUs do agente de Nós de Computação suportados juntamente com a lista de referências de Imagem verificadas, veja a operação "Lista suportada por SKUs do agente do Nó de Computação".
nodePlacementConfiguration	NodePlacementConfiguration	A configuração de colocação do nó para o conjunto. Esta configuração especificará regras sobre como os nós no conjunto serão fisicamente alocados.
osDisk	OSDisk	Definições para o disco do sistema operativo da Máquina Virtual.
securityProfile	SecurityProfile	Especifica as definições de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais. Especifica as definições de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais.
serviceArtifactReference	ServiceArtifactReference	Especifica o ID de referência do artefacto de serviço utilizado para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de dimensionamento ao utilizar a versão de imagem "mais recente". O ID de referência do artefacto de serviço na forma de /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}
windowsConfiguration	WindowsConfiguration	Definições do sistema operativo Windows na máquina virtual. Esta propriedade não pode ser especificada se a propriedade imageReference especificar uma Imagem do SO Linux.

VMExtension

A configuração para extensões de máquinas virtuais.

Name	Tipo	Description
autoUpgradeMinorVersion	boolean	Indica se a extensão deve utilizar uma versão secundária mais recente se uma estiver disponível no momento da implementação. No entanto, depois de implementada, a extensão não atualizará versões secundárias, a menos que seja reimplementada, mesmo com esta propriedade definida como verdadeira.
enableAutomaticUpgrade	boolean	Indica se a extensão deve ser atualizada automaticamente pela plataforma se existir 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 definição protegida.
provisionAfterExtensions	string[]	A coleção de nomes de extensões. Coleção de nomes de extensões após o qual esta extensão tem de ser aprovisionada.
publisher	string	O nome do editor do processador de extensões.
settings	object	Definições públicas formatadas por JSON para a extensão.
type	string	O tipo da extensão.
typeHandlerVersion	string	A versão do processador de scripts.

WindowsConfiguration

Definições do sistema operativo Windows a aplicar à máquina virtual.

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

WindowsUserConfiguration

Propriedades utilizadas para criar uma Conta de utilizador num Nó de Computação do Windows.

Name	Tipo	Description
loginMode	LoginMode	O modo de início de sessão do utilizador O valor predefinido para Conjuntos VirtualMachineConfiguration é "batch" e para CloudServiceConfiguration Pools é "interativo".