Pool - Get

Service:

Batch Service

API Version:

2023-11-01.18.0

Obtém informações sobre o Pool especificado.

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

With optional parameters:

GET {batchUrl}/pools/{poolId}?$select={$select}&$expand={$expand}&timeout={timeout}&api-version=2023-11-01.18.0

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
batchUrl	path	True	string	A URL base para todas as solicitações de serviço Lote do Azure.
poolId	path	True	string	A ID do pool a ser obtido.
api-version	query	True	string	Versão da API do cliente.
$expand	query		string	Uma cláusula OData $expand.
$select	query		string	Uma cláusula OData $select.
timeout	query		integer int32	O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos.

Cabeçalho da solicitação

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

Nome	Obrigatório	Tipo	Description
client-request-id		string uuid	A identidade da solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se o servidor deve retornar o client-request-id na resposta.
ocp-date		string date-time-rfc1123	A hora em que a solicitação foi emitida. As bibliotecas de cliente normalmente definem isso como a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.
If-Match		string	Um valor ETag associado à versão do recurso conhecido pelo cliente. A operação será executada somente se a ETag atual do recurso no serviço corresponder exatamente ao valor especificado pelo cliente.
If-None-Match		string	Um valor ETag associado à versão do recurso conhecido pelo cliente. A operação será executada somente se a ETag atual do recurso no serviço não corresponder ao valor especificado pelo cliente.
If-Modified-Since		string date-time-rfc1123	Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço tiver sido modificado desde a hora especificada.
If-Unmodified-Since		string date-time-rfc1123	Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço não tiver sido modificado desde o horário especificado.

Respostas

Nome	Tipo	Description
200 OK	CloudPool	Uma resposta que contém o Pool. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	O erro do serviço do Lote.

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

Nome	Description
user_impersonation	Representar sua conta de usuário

Authorization

Type: apiKey
In: header

Exemplos

Add a VirtualMachineConfiguration pool with OS disk

Get a pool with AcceleratedNetworking

Get a VirtualMachineConfiguration pool with extensions

Get a VirtualMachineConfiguration pool with SecurityProfile

Get a VirtualMachineConfiguration pool with ServiceArtifactReference

Pool get

Add a VirtualMachineConfiguration pool with OS disk

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "id": "mypool001",
  "url": "http://localhost:20302/testaccount1tls/pools/mypool001",
  "eTag": "0x8DBA3B4E91CD7B7",
  "lastModified": "2023-08-23T08:42:40.3479479Z",
  "creationTime": "2023-08-23T08:42:40.3479479Z",
  "state": "active",
  "stateTransitionTime": "2023-08-23T08:42:40.3479479Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2023-08-23T08:42:53.8587829Z",
  "vmSize": "standard_d2s_v3",
  "resizeTimeout": "PT15M",
  "currentDedicatedNodes": 1,
  "targetDedicatedNodes": 1,
  "currentLowPriorityNodes": 0,
  "targetLowPriorityNodes": 0,
  "enableAutoScale": false,
  "enableInterNodeCommunication": false,
  "taskSlotsPerNode": 1,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts",
      "version": "latest"
    },
    "osDisk": {
      "ephemeralOSDiskSettings": {
        "placement": "CacheDisk"
      },
      "managedDisk": {
        "storageAccountType": "standardssd_lrs"
      },
      "diskSizeGB": 100,
      "caching": "readwrite"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "currentNodeCommunicationMode": "classic"
}

Get a pool with AcceleratedNetworking

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "id": "pool",
  "url": "https://account.region.batch.azure.com/pools/pool",
  "eTag": "0x8DB4792BE8566A2",
  "lastModified": "2023-04-28T02:46:19.0268066Z",
  "creationTime": "2023-04-28T02:46:19.0268066Z",
  "state": "active",
  "stateTransitionTime": "2023-04-28T02:46:19.0268066Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2023-04-28T02:47:17.9169655Z",
  "vmSize": "standard_d1_v2",
  "resizeTimeout": "PT15M",
  "currentDedicatedNodes": 2,
  "targetDedicatedNodes": 2,
  "currentLowPriorityNodes": 0,
  "targetLowPriorityNodes": 0,
  "enableAutoScale": false,
  "enableInterNodeCommunication": false,
  "taskSlotsPerNode": 1,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2016-datacenter-smalldisk",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "networkConfiguration": {
    "dynamicVNetAssignmentScope": "none",
    "enableAcceleratedNetworking": true
  },
  "currentNodeCommunicationMode": "classic"
}

Get a VirtualMachineConfiguration pool with extensions

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "id": "pool",
  "url": "https://account.region.batch.azure.com/pools/pool",
  "eTag": "0x8D413091E739A56",
  "lastModified": "2016-11-22T18:55:25.2608598Z",
  "creationTime": "2016-11-22T18:55:24.2632496Z",
  "state": "active",
  "stateTransitionTime": "2016-11-22T18:55:24.2632496Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z",
  "vmSize": "standard_a1",
  "resizeTimeout": "PT15M",
  "currentDedicatedNodes": 0,
  "currentLowPriorityNodes": 0,
  "targetDedicatedNodes": 0,
  "targetLowPriorityNodes": 0,
  "enableAutoScale": false,
  "enableInterNodeCommunication": false,
  "startTask": {
    "commandLine": "/bin/bash -c 'echo start task'",
    "userIdentity": {
      "autoUser": {
        "scope": "task",
        "elevationLevel": "nonadmin"
      }
    },
    "maxTaskRetryCount": 0,
    "waitForSuccess": false
  },
  "taskSlotsPerNode": 1,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts",
      "version": "latest"
    },
    "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\"}"
      }
    ]
  },
  "targetNodeCommunicationMode": "classic",
  "currentNodeCommunicationMode": "classic"
}

Get a VirtualMachineConfiguration pool with SecurityProfile

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "id": "mypool001",
  "url": "https://account.region.batch.azure.com/pools/pool",
  "eTag": "0x8DB6CA2DFF530D1",
  "lastModified": "2023-06-14T06:45:00.0946897Z",
  "creationTime": "2023-06-14T06:45:00.0946897Z",
  "state": "active",
  "stateTransitionTime": "2023-06-14T06:45:00.0946897Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2023-06-14T06:45:59.4770341Z",
  "vmSize": "standard_dc2s_v2",
  "resizeTimeout": "PT15M",
  "currentDedicatedNodes": 1,
  "targetDedicatedNodes": 1,
  "currentLowPriorityNodes": 0,
  "targetLowPriorityNodes": 0,
  "enableAutoScale": false,
  "enableInterNodeCommunication": false,
  "taskSlotsPerNode": 1,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "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
      }
    }
  },
  "currentNodeCommunicationMode": "classic"
}

Get a VirtualMachineConfiguration pool with ServiceArtifactReference

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "id": "pool",
  "url": "https://account.region.batch.azure.com/pools/pool",
  "eTag": "0x8DB51F652DFC78F",
  "lastModified": "2023-05-11T08:04:19.7259151Z",
  "creationTime": "2023-05-11T08:04:19.7259151Z",
  "state": "active",
  "stateTransitionTime": "2023-05-11T08:04:19.7259151Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2023-05-11T08:05:22.0020052Z",
  "vmSize": "standard_a1_v2",
  "resizeTimeout": "PT15M",
  "currentDedicatedNodes": 2,
  "targetDedicatedNodes": 2,
  "currentLowPriorityNodes": 0,
  "targetLowPriorityNodes": 0,
  "enableAutoScale": false,
  "enableInterNodeCommunication": false,
  "taskSlotsPerNode": 1,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2016-datacenter-smalldisk",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.windows amd64",
    "windowsConfiguration": {
      "enableAutomaticUpdates": false
    },
    "serviceArtifactReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile"
    }
  },
  "currentNodeCommunicationMode": "classic"
}

Pool get

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "id": "pool",
  "url": "https://account.region.batch.azure.com/pools/pool",
  "eTag": "0x8D413091E739A56",
  "lastModified": "2016-11-22T18:55:25.2608598Z",
  "creationTime": "2016-11-22T18:55:24.2632496Z",
  "state": "active",
  "stateTransitionTime": "2016-11-22T18:55:24.2632496Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z",
  "vmSize": "standard_a1",
  "resizeTimeout": "PT15M",
  "currentDedicatedNodes": 0,
  "currentLowPriorityNodes": 0,
  "targetDedicatedNodes": 0,
  "targetLowPriorityNodes": 0,
  "enableAutoScale": false,
  "enableInterNodeCommunication": false,
  "startTask": {
    "commandLine": "/bin/bash -c 'echo start task'",
    "userIdentity": {
      "autoUser": {
        "scope": "task",
        "elevationLevel": "nonadmin"
      }
    },
    "maxTaskRetryCount": 0,
    "waitForSuccess": false
  },
  "taskSlotsPerNode": 1,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  }
}

Definições

Nome	Description
AllocationState	Se o Pool está redimensionando.
ApplicationPackageReference	Uma referência a um pacote a ser implantado em nós de computação.
AutoScaleRun	Os resultados e erros de uma execução de uma fórmula de dimensionamento automático do Pool.
AutoScaleRunError	Um erro que ocorreu ao executar ou avaliar uma fórmula de dimensionamento automático do Pool.
AutoUserScope	O escopo do usuário automático
AutoUserSpecification	Especifica os parâmetros para o usuário automático que executa uma Tarefa no serviço do Lote.
AzureBlobFileSystemConfiguration	Informações usadas para se conectar a um Contêiner de Armazenamento do Azure usando o Blobfuse.
AzureFileShareConfiguration	Informações usadas para se conectar a um compartilhamento de arquivos do Azure.
BatchError	Uma resposta de erro recebida do serviço Lote do Azure.
BatchErrorDetail	Um item de informações adicionais incluído em uma resposta de erro Lote do Azure.
BatchPoolIdentity	A identidade do pool do Lote, se configurada.
CachingType	O tipo de cache a ser habilitado para o disco.
CertificateReference	Uma referência a um certificado a ser instalado em nós de computação em um pool.
CertificateStoreLocation	O local do repositório de certificados no Nó de Computação no qual instalar o Certificado.
CertificateVisibility	Quais contas de usuário no nó de computação devem ter acesso aos dados privados do Certificado.
CIFSMountConfiguration	Informações usadas para se conectar a um sistema de arquivos CIFS.
CloudPool	Um pool no serviço Lote do Azure.
CloudServiceConfiguration	A configuração para nós de computação em um pool com base na plataforma Serviços de Nuvem do Azure.
ComputeNodeFillType	Como as Tarefas são distribuídas entre nós de computação em um pool.
ComputeNodeIdentityReference	A referência a uma identidade atribuída pelo usuário associada ao pool do Lote que um nó de computação usará.
ContainerConfiguration	A configuração para pools habilitados para contêineres.
ContainerRegistry	Um registro de contêiner privado.
ContainerType	A tecnologia de contêiner a ser usada.
ContainerWorkingDirectory	O local do diretório de trabalho da Tarefa de contêiner.
DataDisk	Configurações que serão usadas pelos discos de dados associados aos Nós de Computação no Pool. Ao usar discos de dados anexados, você precisa montar e formatar os discos de dentro de uma VM para usá-los.
DiffDiskPlacement	Especifica o posicionamento de disco efêmero para o disco do sistema operacional para todos os nós de computação (VMs) no pool.
DiffDiskSettings	Especifica as Configurações de Disco efêmero para o disco do sistema operacional usado pelo nó de computação (VM).
DiskEncryptionConfiguration	A configuração de criptografia de disco aplicada em nós de computação no pool. Não há suporte para a configuração de criptografia de disco no pool do Linux criado com a Imagem da Galeria de Computação do Azure.
DiskEncryptionTarget	A lista de destinos de disco serviço de lote criptografará no nó de computação.
DynamicVNetAssignmentScope	O escopo da atribuição de vnet dinâmica.
ElevationLevel	O nível de elevação do usuário.
EnvironmentSetting	Uma variável de ambiente a ser definida em um processo de tarefa.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro Lote do Azure.
ImageReference	Uma referência a uma imagem do Azure Máquinas Virtuais Marketplace ou a uma imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de imagem Azure Marketplace verificadas por Lote do Azure, consulte a operação 'Listar Imagens Com Suporte'.
InboundEndpointProtocol	O protocolo do ponto de extremidade.
InboundNATPool	Um pool nat de entrada que pode ser usado para lidar com portas específicas em nós de computação em um pool de lote externamente.
IPAddressProvisioningType	O tipo de provisionamento para endereços IP públicos para o pool.
LinuxUserConfiguration	Propriedades usadas para criar uma conta de usuário em um nó de computação do Linux.
LoginMode	O modo de logon para o usuário
ManagedDisk
MetadataItem	Um par nome-valor associado a um recurso de serviço do Lote.
MountConfiguration	O sistema de arquivos a ser montado em cada nó.
NameValuePair	Representa um par nome-valor.
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 executada para um endereço IP especificado, intervalo de sub-rede ou marca.
NFSMountConfiguration	Informações usadas para se conectar a um sistema de arquivos NFS.
NodeCommunicationMode	Determina como um pool se comunica com o serviço do Lote.
NodePlacementConfiguration	Configuração de posicionamento 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).
PoolEndpointConfiguration	A configuração do ponto de extremidade para um Pool.
PoolIdentityType	A identidade do pool do Lote, se configurada.
PoolState	O estado atual do Pool.
PoolStatistics	Contém estatísticas de utilização e uso de recursos para o tempo de vida de um pool.
PublicIPAddressConfiguration	A configuração de endereço IP público da configuração de rede de um Pool.
ResizeError	Um erro que ocorreu ao redimensionar um Pool.
ResourceFile	Um único arquivo ou vários arquivos a serem baixados em um Nó de Computação.
ResourceStatistics	Estatísticas relacionadas ao consumo de recursos por nós de computação em um pool.
SecurityProfile	Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais.
SecurityTypes	Especifica o SecurityType da máquina virtual. Ele precisa ser definido como qualquer valor especificado para habilitar UefiSettings.
ServiceArtifactReference	Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de dimensionamento ao usar a versão de imagem 'mais recente'.
StartTask	Uma Tarefa que é executada quando um Nó ingressa em um Pool no serviço Lote do Azure ou quando o Nó de Computação é reinicializado ou reimagem.
StorageAccountType	O tipo de conta de armazenamento para uso na criação de discos de dados ou disco do sistema operacional.
TaskContainerSettings	As configurações de contêiner de uma Tarefa.
TaskSchedulingPolicy	Especifica como as Tarefas devem ser distribuídas entre nós de computação.
UefiSettings	Especifica as configurações de segurança, como inicialização segura e vTPM usadas durante a criação da máquina virtual.
UsageStatistics	Estatísticas relacionadas às informações de uso do pool.
UserAccount	Propriedades usadas para criar um usuário usado para executar Tarefas em um nó de computação Lote do Azure.
UserAssignedIdentity	A identidade atribuída pelo usuário
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.
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.

AllocationState

Se o Pool está redimensionando.

Nome	Tipo	Description
resizing	string	O pool está redimensionando; ou seja, nós de computação estão sendo adicionados ou removidos do pool.
steady	string	O Pool não está redimensionando. Não há alterações no número de nós de computação no pool em andamento. Um Pool entra nesse estado quando é criado e quando nenhuma operação está sendo executada no Pool para alterar o número de Nós de Computação.
stopping	string	O Pool estava redimensionando, mas o usuário solicitou que o redimensionamento fosse interrompido, mas a solicitação de parada ainda não foi concluída.

ApplicationPackageReference

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

Nome	Tipo	Description
applicationId	string	A ID do aplicativo a ser implantado. Ao criar um pool, a ID do aplicativo do pacote deve ser totalmente qualificada (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	A versão do aplicativo a ser implantado. Se omitida, a versão padrão será implantada. Se isso for omitido em um Pool e nenhuma versão padrão for especificada para este aplicativo, a solicitação falhará com o código de erro InvalidApplicationPackageReferences e http status código 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.

AutoScaleRun

Os resultados e erros de uma execução de uma fórmula de dimensionamento automático do Pool.

Nome	Tipo	Description
error	AutoScaleRunError	Detalhes do erro encontrado avaliando a fórmula de dimensionamento automático no Pool, se a avaliação não tiver sido bem-sucedida.
results	string	Os valores finais de todas as variáveis usadas na avaliação da fórmula de dimensionamento automático. Cada valor de variável é retornado no formulário $variable=value e as variáveis são separadas por ponto-e-vírgula.
timestamp	string	A hora em que a fórmula de dimensionamento automático foi avaliada pela última vez.

AutoScaleRunError

Um erro que ocorreu ao executar ou avaliar uma fórmula de dimensionamento automático do Pool.

Nome	Tipo	Description
code	string	Um identificador para o erro de dimensionamento automático. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	string	Uma mensagem que descreve o erro de dimensionamento automático, destinada a ser adequada para exibição em uma interface do usuário.
values	NameValuePair[]	Uma lista de detalhes de erro adicionais relacionados ao erro de dimensionamento automático.

AutoUserScope

O escopo do usuário automático

Nome	Tipo	Description
pool	string	Especifica que a Tarefa é executada como a conta de usuário automático comum que é criada em cada nó de computação em um pool.
task	string	Especifica que o serviço deve criar um novo usuário para a Tarefa.

AutoUserSpecification

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

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

AzureBlobFileSystemConfiguration

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

Nome	Tipo	Description
accountKey	string	A chave da Conta de Armazenamento do Azure. Essa propriedade é mutuamente exclusiva com sasKey e identidade; exatamente um deve ser especificado.
accountName	string	O nome da Conta de Armazenamento do Azure.
blobfuseOptions	string	Opções de linha de comando adicionais a serem passadas para o comando de montagem. Essas são opções de 'net use' no Windows e opções de 'montagem' no Linux.
containerName	string	O nome do contêiner Armazenamento de Blobs do Azure.
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída pelo usuário a ser usada para acessar containerName Essa propriedade é mutuamente exclusiva com accountKey e sasKey; exatamente um deve ser especificado.
relativeMountPath	string	O caminho relativo no nó de computação em que o sistema de arquivos será montado Todos os sistemas de arquivos são montados em relação ao diretório montagens do Lote, acessível por meio da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.
sasKey	string	O token SAS do Armazenamento do Azure. Essa propriedade é mutuamente exclusiva com accountKey e identity; exatamente um deve ser especificado.

AzureFileShareConfiguration

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

Nome	Tipo	Description
accountKey	string	A chave de conta de Armazenamento do Microsoft Azure.
accountName	string	O nome da conta do Armazenamento do Azure.
azureFileUrl	string	A URL do Arquivos do Azure. Este é do formato 'https://{account}.file.core.windows.net/'.
mountOptions	string	Opções de linha de comando adicionais a serem passadas para o comando de montagem. Essas são opções de 'net use' no Windows e opções de 'montagem' no Linux.
relativeMountPath	string	O caminho relativo no nó de computação em que o sistema de arquivos será montado Todos os sistemas de arquivos são montados em relação ao diretório montagens do Lote, acessível por meio da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.

BatchError

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

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

BatchErrorDetail

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

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

BatchPoolIdentity

A identidade do pool do Lote, se configurada.

Nome	Tipo	Description
type	PoolIdentityType	A identidade do pool do Lote, se configurada. A lista de identidades de usuário associadas ao pool do Lote. As referências de chave de dicionário de identidade do usuário serão IDs de recurso do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
userAssignedIdentities	UserAssignedIdentity[]	A lista de identidades de usuário associadas à conta do Lote. As referências de chave de dicionário de identidade do usuário serão IDs de recurso do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

CachingType

O tipo de cache a ser habilitado para o disco.

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

CertificateReference

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

Nome	Tipo	Description
storeLocation	CertificateStoreLocation	O local do repositório de certificados no Nó de Computação no qual instalar o Certificado. O valor padrão é currentuser. Essa propriedade é aplicável somente para Pools configurados com nós de computação do Windows (ou seja, criados com cloudServiceConfiguration ou com virtualMachineConfiguration usando uma referência de Imagem do Windows). Para nós de computação do Linux, os Certificados são armazenados em um diretório dentro do diretório de trabalho 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 repositório de certificados no Nó de Computação no qual instalar o Certificado. Essa propriedade é aplicável somente para Pools configurados com nós de computação do Windows (ou seja, criados com cloudServiceConfiguration ou com virtualMachineConfiguration usando uma referência de Imagem do Windows). Os nomes comuns do repositório incluem: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, mas qualquer nome de repositório personalizado também pode ser usado. O valor padrão é 65536.
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 repositório de certificados no Nó de Computação no qual instalar o Certificado.

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

CertificateVisibility

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

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

CIFSMountConfiguration

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

Nome	Tipo	Description
mountOptions	string	Opções de linha de comando adicionais a serem passadas para o comando de montagem. Essas são opções de 'net use' no Windows e opções de 'montagem' no Linux.
password	string	A senha a ser usada para autenticação no sistema de arquivos CIFS.
relativeMountPath	string	O caminho relativo no nó de computação em que o sistema de arquivos será montado Todos os sistemas de arquivos são montados em relação ao diretório montagens do Lote, acessível por meio da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.
source	string	O URI do sistema de arquivos a ser montado.
username	string	O usuário a ser usado para autenticação no sistema de arquivos CIFS.

CloudPool

Um pool no serviço Lote do Azure.

Nome	Tipo	Description
allocationState	AllocationState	Se o Pool está redimensionando.
allocationStateTransitionTime	string	A hora em que o Pool entrou em seu estado de alocação atual.
applicationLicenses	string[]	A lista de licenças de aplicativo que o serviço do Lote disponibilizará em cada Nó de Computação no Pool. A lista de licenças de aplicativo deve ser um subconjunto de licenças de aplicativo de serviço do Lote disponíveis. Se uma licença for solicitada, o que não tem suporte, a criação do pool falhará.
applicationPackageReferences	ApplicationPackageReference[]	A lista de pacotes a serem instalados em cada nó de computação no pool. 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. Há no máximo 10 referências de pacote em qualquer pool específico.
autoScaleEvaluationInterval	string	O intervalo de tempo no qual ajustar automaticamente o tamanho do pool de acordo com a fórmula de dimensionamento automático. Essa propriedade será definida somente se o Pool for dimensionado automaticamente, ou seja, enableAutoScale for true.
autoScaleFormula	string	Uma fórmula para o número desejado de nós de computação no pool. Essa propriedade será definida somente se o Pool for dimensionado automaticamente, ou seja, enableAutoScale for true.
autoScaleRun	AutoScaleRun	Os resultados e erros da última execução da fórmula de dimensionamento automático. Essa propriedade será definida somente se o Pool for dimensionado automaticamente, ou seja, enableAutoScale for true.
certificateReferences	CertificateReference[]	A lista de certificados a serem instalados em cada nó de computação no pool. Para nós do Windows, o serviço lote instala os Certificados no repositório de certificados e no local especificados. Para nós de computação do Linux, os Certificados são armazenados em um diretório dentro do diretório de trabalho 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: essa propriedade foi preterida e será removida após fevereiro de 2024. Em vez disso, use a Extensão do Azure KeyVault .
cloudServiceConfiguration	CloudServiceConfiguration	A configuração do serviço de nuvem para o Pool. Essa propriedade e virtualMachineConfiguration são mutuamente exclusivas e uma das propriedades deve ser especificada. Essa propriedade não poderá ser especificada se a Conta do Lote foi criada com sua propriedade poolAllocationMode definida como 'UserSubscription'.
creationTime	string	A hora de criação do Pool.
currentDedicatedNodes	integer	O número de nós de computação dedicados atualmente no pool.
currentLowPriorityNodes	integer	O número de nós de computação spot/de baixa prioridade atualmente no pool. Os nós de computação spot/de baixa prioridade que foram preemptos estão incluídos nessa contagem.
currentNodeCommunicationMode	NodeCommunicationMode	O estado atual do modo de comunicação do pool.
displayName	string	O nome de exibição do Pool. O nome de exibição não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024.
eTag	string	A ETag do Pool. Essa é uma cadeia de caracteres opaca. Você pode usá-lo para detectar se o pool foi alterado entre solicitações. Em particular, você pode passar a ETag ao atualizar um Pool para especificar que suas alterações devem entrar em vigor somente se ninguém mais tiver modificado o Pool enquanto isso.
enableAutoScale	boolean	Se o tamanho do pool deve ser ajustado automaticamente ao longo do tempo. Se for false, pelo menos um dos targetDedicatedNodes e targetLowPriorityNodes deverá ser especificado. Se for true, a propriedade autoScaleFormula será necessária e o Pool será redimensionado automaticamente de acordo com a fórmula. O valor padrão é false.
enableInterNodeCommunication	boolean	Se o pool permite comunicação direta entre nós de computação. Isso impõe restrições sobre quais nós de computação podem ser atribuídos ao pool. Especificar esse valor pode reduzir a chance de o número solicitado de Nós de Computação ser alocado no pool.
id	string	Uma cadeia de caracteres que identifica exclusivamente o pool dentro da Conta. A ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hifens e sublinhados, e não pode conter mais de 64 caracteres. A ID não diferencia maiúsculas de minúsculas e diferencia maiúsculas de minúsculas (ou seja, você pode não ter duas IDs em uma Conta que diferem apenas por caso).
identity	BatchPoolIdentity	A identidade do pool do Lote, se configurada. A lista de identidades de usuário associadas ao pool do Lote. As referências de chave de dicionário de identidade do usuário serão IDs de recurso do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
lastModified	string	A hora da última modificação do pool. Esta é a última vez em que os dados no nível do pool, como as configurações targetDedicatedNodes ou enableAutoscale, foram alterados. Ele não leva em conta alterações no nível do nó, como um estado de alteração de nó de computação.
metadata	MetadataItem[]	Uma lista de pares nome-valor associados ao Pool como metadados.
mountConfiguration	MountConfiguration[]	Uma lista de sistemas de arquivos a serem montados em cada nó no pool. Isso dá suporte a Arquivos do Azure, NFS, CIFS/SMB e Blobfuse.
networkConfiguration	NetworkConfiguration	A configuração de rede para o Pool. A configuração de rede para um pool.
resizeErrors	ResizeError[]	Uma lista de erros encontrados ao executar o último redimensionamento no Pool. Essa propriedade será definida somente se um ou mais erros ocorreram durante o último redimensionamento do pool e somente quando o Pool allocationState for Steady.
resizeTimeout	string	O tempo limite para alocação de nós de computação para o pool. Esse é o tempo limite para a operação de redimensionamento mais recente. (O dimensionamento inicial quando o pool é criado conta como um redimensionamento.) O valor padrão é 15 minutos.
resourceTags	object	As marcas especificadas pelo usuário associadas ao pool. As marcas definidas pelo usuário a serem associadas ao pool de Lote do Azure. Quando especificadas, essas marcas são propagadas para os recursos do Azure de suporte associados ao pool. Essa propriedade só pode ser especificada quando a conta do Lote foi criada com a propriedade poolAllocationMode definida como 'UserSubscription'.
startTask	StartTask	Uma Tarefa especificada para ser executada em cada Nó de Computação à medida que ele ingressa no pool. O Lote repetirá Tarefas quando uma operação de recuperação for disparada em um Nó. Exemplos de operações de recuperação incluem (mas não se limitam a) quando um nó não íntegro é reinicializado ou um Nó de Computação desapareceu devido a uma falha no host. As novas tentativas devido a operações de recuperação são independentes de e não são contadas em relação a maxTaskRetryCount. Mesmo que maxTaskRetryCount seja 0, poderá ocorrer uma repetição interna devido a uma operação de recuperação. Por isso, todas as Tarefas devem ser idempotentes. Isso significa que as tarefas precisam tolerar que sejam interrompidas e reiniciadas sem causar dados corrompidos ou duplicados. A melhor prática para tarefas de execução prolongada é usar alguma forma de ponto de verificação. Em alguns casos, o StartTask pode ser executado novamente, mesmo que o Nó de Computação não tenha sido reinicializado. Deve-se tomar cuidado especial para evitar StartTasks que criam processos de separação ou serviços de instalação/inicialização do diretório de trabalho StartTask, pois isso impedirá que o Lote seja capaz de executar novamente o StartTask.
state	PoolState	O estado atual do Pool.
stateTransitionTime	string	A hora em que o Pool entrou em seu estado atual.
stats	PoolStatistics	Estatísticas de utilização e uso de recursos durante todo o tempo de vida do pool. Essa propriedade será preenchida somente se o CloudPool tiver sido recuperado com uma cláusula de expansão, incluindo o atributo 'stats'; caso contrário, será nulo. As estatísticas podem não estar disponíveis imediatamente. O serviço lote executa um acúmulo periódico de estatísticas. O atraso típico é de cerca de 30 minutos.
targetDedicatedNodes	integer	O número desejado de nós de computação dedicados no pool.
targetLowPriorityNodes	integer	O número desejado de nós de computação spot/de baixa prioridade no pool.
targetNodeCommunicationMode	NodeCommunicationMode	O modo de comunicação de nó desejado para o pool. Se omitido, o valor padrão será Default.
taskSchedulingPolicy	TaskSchedulingPolicy	Como as Tarefas são distribuídas entre nós de computação em um pool. Se não for especificado, o padrão será 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.
url	string	A URL do pool.
userAccounts	UserAccount[]	A lista de contas de usuário a serem criadas em cada nó de computação no pool.
virtualMachineConfiguration	VirtualMachineConfiguration	A configuração da máquina virtual para o Pool. Essa propriedade e cloudServiceConfiguration são mutuamente exclusivas e uma das propriedades deve ser especificada.
vmSize	string	O tamanho das máquinas virtuais no pool. Todas as máquinas virtuais em um pool têm o mesmo tamanho. Para obter informações sobre os tamanhos disponíveis de máquinas virtuais em Pools, consulte Escolher um tamanho de VM para nós de computação em um pool de Lote do Azure (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

CloudServiceConfiguration

A configuração para nós de computação em um pool com base na plataforma Serviços de Nuvem do Azure.

Nome	Tipo	Description
osFamily	string	A família de so convidado do Azure a ser instalada nas máquinas virtuais no Pool. Os valores possíveis são: 2 – Família do sistema operacional 2, equivalente ao Windows Server 2008 R2 SP1. 3 – Família do sistema operacional 3, equivalente a Windows Server 2012. 4 – Família do sistema operacional 4, equivalente a Windows Server 2012 R2. 5 – Família do sistema operacional 5, equivalente a Windows Server 2016. 6 – Família do sistema operacional 6, equivalente ao Windows Server 2019. Para obter mais informações, consulte Versões do sistema operacional convidado do Azure (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).
osVersion	string	A versão do sistema operacional convidado do Azure a ser instalada nas máquinas virtuais no Pool. O valor padrão é * que especifica a versão mais recente do sistema operacional para a família de sistemas operacionais especificada.

ComputeNodeFillType

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

Nome	Tipo	Description
pack	string	O maior número possível de tarefas (taskSlotsPerNode) deve ser atribuído a cada nó de computação no pool antes que 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 pelo usuário associada ao pool do Lote que um nó de computação usará.

Nome	Tipo	Description
resourceId	string	A ID de recurso do ARM da identidade atribuída pelo usuário.

ContainerConfiguration

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

Nome	Tipo	Description
containerImageNames	string[]	A coleção de nomes de imagem do contêiner. Essa é a referência de imagem completa, como seria especificado para "docker pull". Uma imagem será originada do registro padrão do Docker, a menos que a Imagem seja totalmente qualificada com um registro alternativo.
containerRegistries	ContainerRegistry[]	Registros privados adicionais dos quais os contêineres podem ser extraídos. Se alguma imagem precisar ser baixada de um registro privado que exija credenciais, essas credenciais deverão ser fornecidas aqui.
type	ContainerType	A tecnologia de contêiner a ser usada.

ContainerRegistry

Um registro de contêiner privado.

Nome	Tipo	Description
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída pelo usuário a ser usada para acessar um Registro de Contêiner do Azure em vez de nome de usuário e senha. A referência a uma identidade atribuída pelo usuário associada ao pool do Lote que um nó de computação usará.
password	string	A senha para fazer logon no servidor do Registro.
registryServer	string	A URL do registro. Se omitido, o padrão será "docker.io".
username	string	O nome de usuário para fazer logon no servidor do Registro.

ContainerType

A tecnologia de contêiner a ser usada.

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

ContainerWorkingDirectory

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

Nome	Tipo	Description
containerImageDefault	string	Use o diretório de trabalho definido na Imagem do contêiner. Cuidado para que esse diretório não contenha os Arquivos de Recursos baixados pelo Lote.
taskWorkingDirectory	string	Use o diretório de trabalho da Tarefa de Serviço do Lote padrão, que conterá os Arquivos de Recurso de Tarefa preenchidos pelo Lote.

DataDisk

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

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

DiffDiskPlacement

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

Nome	Tipo	Description
CacheDisk	string	O Disco do SISTEMA Operacional Efêmero é armazenado no cache da VM.

DiffDiskSettings

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

Nome	Tipo	Description
placement	DiffDiskPlacement	Especifica o posicionamento de disco efêmero para o disco do sistema operacional para todas as VMs no pool. Essa propriedade pode ser usada pelo usuário na solicitação para escolher o local, por exemplo, espaço em disco em cache para provisionamento de disco do so efêmero. Para obter mais informações sobre os requisitos de tamanho do disco do so efêmero, consulte Requisitos de tamanho de disco do sistema operacional 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 criptografia de disco aplicada em nós de computação no pool. Não há suporte para a configuração de criptografia de disco no pool do Linux criado com a Imagem da Galeria de Computação do Azure.

Nome	Tipo	Description
targets	DiskEncryptionTarget[]	A lista de destinos de disco Serviço de Lote será criptografada no nó de computação. Se omitido, nenhum disco nos nós de computação no pool será criptografado. No pool do Linux, há suporte apenas para "TemporaryDisk"; no pool do Windows, "OsDisk" e "TemporaryDisk" devem ser especificados.

DiskEncryptionTarget

A lista de destinos de disco serviço de lote criptografará no nó de computação.

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

DynamicVNetAssignmentScope

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

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

ElevationLevel

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

Nome	Tipo	Description
admin	string	O usuário é um usuário com acesso elevado e opera com permissões 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 de tarefa.

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

ErrorMessage

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

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

ImageReference

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

Nome	Tipo	Description
exactVersion	string	A versão específica da imagem da plataforma ou da imagem do marketplace usada para criar o nó. Esse campo somente leitura será diferente de "version" somente se o valor especificado para 'version' quando o pool foi criado for 'latest'.
offer	string	O tipo de oferta da Imagem do Azure Máquinas Virtuais Marketplace. Por exemplo, UbuntuServer ou WindowsServer.
publisher	string	O editor 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. Um valor "mais recente" pode ser especificado para selecionar a versão mais recente de uma Imagem. Se omitido, o padrão será 'latest'.
virtualMachineImageId	string	O identificador de recurso do ARM da Imagem da Galeria de Computação do Azure. Nós de computação no pool serão criados usando essa ID de imagem. Isso é do formulário /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} ou /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} para sempre usar a versão mais recente da imagem. Essa propriedade é mutuamente exclusiva com outras propriedades ImageReference. A Imagem da Galeria de Computação do Azure deve ter réplicas na mesma região e deve estar na mesma assinatura que a conta Lote do Azure. Se a versão da imagem não for especificada na imageId, a versão mais recente será usada. Para obter informações sobre as configurações de firewall do agente do Nó de Computação em Lote para se comunicar com o serviço do Lote, consulte https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

InboundEndpointProtocol

O protocolo do ponto de extremidade.

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

InboundNATPool

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

Nome	Tipo	Description
backendPort	integer	O número da porta no Nó de Computação. Isso deve ser exclusivo em um Pool do Lote. Os valores aceitáveis estão entre 1 e 65535, exceto 22, 3389, 29876 e 29877, pois são reservados. Se algum valor reservado for fornecido, a solicitação falhará com HTTP status código 400.
frontendPortRangeEnd	integer	O último número da porta no intervalo de portas externas que será usado 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 55.000 reservadas pelo serviço 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 quaisquer valores reservados ou sobrepostos forem fornecidos, a solicitação falhará com HTTP status código 400.
frontendPortRangeStart	integer	O primeiro número da porta no intervalo de portas externas que será usado 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 55.000 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 quaisquer valores reservados ou sobrepostos forem fornecidos, a solicitação falhará com HTTP status código 400.
name	string	O nome do ponto de extremidade. O nome deve ser exclusivo em um Pool do Lote, pode conter letras, números, sublinhados, pontos e hifens. 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 forem fornecidos valores inválidos, a solicitação falhará com HTTP status código 400.
networkSecurityGroupRules	NetworkSecurityGroupRule[]	Uma lista de regras de grupo de segurança de rede que serão aplicadas ao ponto de extremidade. O número máximo de regras que podem ser especificadas em todos os pontos de extremidade em um Pool de Lotes é 25. Se nenhuma regra de grupo de segurança de rede for especificada, uma regra padrão será criada para permitir o acesso de entrada ao back-endPort especificado. Se o número máximo de regras de grupo de segurança de rede for excedido, a solicitação falhará com HTTP status código 400.
protocol	InboundEndpointProtocol	O protocolo do ponto de extremidade.

IPAddressProvisioningType

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

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

LinuxUserConfiguration

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

Nome	Tipo	Description
gid	integer	A ID do grupo para a Conta de usuário. As propriedades uid e gid devem ser especificadas juntas ou não. Se não for especificado, o sistema operacional subjacente escolherá o gid.
sshPrivateKey	string	A chave privada SSH para a conta de usuário. A chave privada não deve ser protegida por senha. A chave privada é usada para configurar automaticamente a autenticação baseada em chave assimétrica para SSH entre nós de computação em um pool do Linux quando a propriedade enableInterNodeCommunication do pool for verdadeira (ela será ignorada se enableInterNodeCommunication for false). Ele faz isso colocando o par de chaves no diretório .ssh do usuário. Se não for especificado, o SSH sem senha não será configurado entre nós de computação (nenhuma modificação do diretório .ssh do usuário é feita).
uid	integer	A ID de usuário da conta de usuário. As propriedades uid e gid devem ser especificadas juntas ou não. Se não for especificado, o sistema operacional subjacente escolherá o uid.

LoginMode

O modo de logon para o usuário

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

ManagedDisk

Nome	Tipo	Description
storageAccountType	StorageAccountType	O tipo de conta de armazenamento para disco gerenciado.

MetadataItem

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

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

MountConfiguration

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

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

NameValuePair

Representa um par nome-valor.

Nome	Tipo	Description
name	string	O nome no par nome-valor.
value	string	O valor no par nome-valor.

NetworkConfiguration

A configuração de rede para um Pool.

Nome	Tipo	Description
dynamicVNetAssignmentScope	DynamicVNetAssignmentScope	O escopo da atribuição de vnet dinâmica.
enableAcceleratedNetworking	boolean	Se esse pool deve habilitar a rede acelerada. A rede acelerada permite a virtualização de E/S de raiz única (SR-IOV) para uma VM, o que pode levar a um melhor desempenho de rede. Para obter mais informações, confira: 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. A configuração do ponto de extremidade do pool só tem suporte em Pools com a propriedade virtualMachineConfiguration.
publicIPAddressConfiguration	PublicIPAddressConfiguration	A configuração de IPAddress público para nós de computação no Pool de Lotes. A propriedade de configuração de IP público só tem suporte em Pools com a propriedade virtualMachineConfiguration.
subnetId	string	O identificador de recurso arm da sub-rede de rede virtual à qual os Nós de Computação do Pool ingressarão. Isso é do formulário /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. A rede virtual deve estar na mesma região e assinatura que a conta Lote do Azure. A sub-rede especificada deve ter endereços IP gratuitos suficientes para acomodar o número de nós de computação no pool. Se a sub-rede não tiver endereços IP gratuitos suficientes, o Pool alocará parcialmente nós e ocorrerá um erro de redimensionamento. A entidade de serviço 'MicrosoftAzureBatch' deve ter a função 'Colaborador de Máquina Virtual Clássica' Role-Based 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 VNet especificada tem algum NSG (Grupos de Segurança de Rede) associados. Se a comunicação com os Nós na sub-rede especificada for negada por um NSG, o serviço lote definirá o estado dos Nós de Computação como inutilizável. Para Pools criados com virtualMachineConfiguration, há suporte apenas para redes virtuais arm ('Microsoft.Network/virtualNetworks'), mas para Pools criados com cloudServiceConfiguration, tanto o ARM quanto as redes virtuais clássicas têm suporte. Se a VNet especificada tiver grupos de segurança de rede (NSG) associados, algumas portas reservadas do sistema devem ser habilitadas para comunicação de entrada. Para Pools criados com uma configuração de máquina virtual, habilite as portas 29876 e 29877, bem como a porta 22 para Linux e a porta 3389 para Windows. Para Pools criados com uma configuração de serviço de nuvem, habilite as portas 10100, 20100 e 30100. Habilite também conexões de saída para o Armazenamento do Azure na porta 443. Para obter mais detalhes, confira: 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 ser aplicada a um ponto de extremidade de entrada.

Nome	Tipo	Description
access	NetworkSecurityGroupRuleAccess	A ação que deve ser executada para um endereço IP especificado, intervalo de sub-rede ou marca.
priority	integer	A prioridade para essa regra. As prioridades em um pool devem ser exclusivas e são avaliadas em ordem de prioridade. Quanto menor o número, maior a prioridade. Por exemplo, as regras podem ser especificadas com números de pedidos de 150, 250 e 350. A regra com o número de ordem de 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 HTTP status código 400.
sourceAddressPrefix	string	O prefixo de endereço de origem ou a marca 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), marca padrão ou * (para todos os endereços). Se outros valores forem fornecidos, a solicitação falhará com HTTP status código 400.
sourcePortRanges	string[]	Os intervalos de porta de origem a serem correspondentes à regra. Os valores válidos são '' (para todas as portas 0 a 65535), uma porta específica (ou seja, 22) ou um intervalo de portas (ou seja, 100-200). As portas devem estar no intervalo de 0 a 65535. Cada entrada nesta coleção não deve se sobrepor a nenhuma outra entrada (um intervalo ou uma porta individual). Se outros valores forem fornecidos, a solicitação falhará com HTTP status código 400. O valor padrão é ''.

NetworkSecurityGroupRuleAccess

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

Nome	Tipo	Description
allow	string	Permitir o acesso.
deny	string	Nega o acesso.

NFSMountConfiguration

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

Nome	Tipo	Description
mountOptions	string	Opções de linha de comando adicionais a serem passadas para o comando de montagem. Essas são opções de 'net use' no Windows e opções de 'montagem' no Linux.
relativeMountPath	string	O caminho relativo no nó de computação em que o sistema de arquivos será montado Todos os sistemas de arquivos são montados em relação ao diretório montagens do Lote, acessível por meio da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.
source	string	O URI do sistema de arquivos a ser montado.

NodeCommunicationMode

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

Nome	Tipo	Description
classic	string	Os nós que usam o modo de comunicação clássico exigem comunicação TCP de entrada nas portas 29876 e 29877 do "BatchNodeManagement. {region}" marca de serviço e comunicação TCP de saída na porta 443 para "Storage.region" e "BatchNodeManagement. Marcas de serviço {region}".
default	string	O modo de comunicação do nó é definido automaticamente pelo serviço lote.
simplified	string	Os nós que usam o modo de comunicação simplificado exigem comunicação TCP de saída na porta 443 para o "BatchNodeManagement. Marca de serviço {region}". Nenhuma porta de entrada aberta é necessária.

NodePlacementConfiguration

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

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

NodePlacementPolicyType

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

Nome	Tipo	Description
regional	string	Todos os nós no pool serão alocados na mesma região.
zonal	string	Os nós no pool serão distribuídos em 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).

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

PoolEndpointConfiguration

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

Nome	Tipo	Description
inboundNATPools	InboundNATPool[]	Uma lista de pools NAT de entrada que podem ser usados para abordar portas específicas em um nó de computação individual externamente. O número máximo de pools NAT de entrada por Pool de Lote é 5. Se o número máximo de pools NAT de entrada for excedido, a solicitação falhará com HTTP status código 400. Isso não poderá ser especificado se o IPAddressProvisioningType for NoPublicIPAddresses.

PoolIdentityType

A identidade do pool do Lote, se configurada.

Nome	Tipo	Description
None	string	O pool do Lote não tem nenhuma identidade associada a ele. A configuração None no pool de atualizações removerá as identidades existentes.
UserAssigned	string	O pool do Lote tem identidades atribuídas pelo usuário com ele.

PoolState

O estado atual do Pool.

Nome	Tipo	Description
active	string	O Pool está disponível para executar Tarefas sujeitas à disponibilidade de Nós de Computação.
deleting	string	O usuário solicitou que o Pool fosse excluído, mas a operação de exclusão ainda não foi concluída.

PoolStatistics

Contém estatísticas de utilização e uso de recursos para o tempo de vida de um pool.

Nome	Tipo	Description
lastUpdateTime	string	A hora em que as estatísticas foram atualizadas pela última vez. Todas as estatísticas são limitadas ao intervalo entre startTime e lastUpdateTime.
resourceStats	ResourceStatistics	Estatísticas relacionadas ao consumo de recursos por nós de computação no pool.
startTime	string	A hora de início do intervalo de tempo coberto pelas estatísticas.
url	string	A URL das estatísticas.
usageStats	UsageStatistics	Estatísticas relacionadas ao uso do pool, como a quantidade de tempo principal usado.

PublicIPAddressConfiguration

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

Nome	Tipo	Description
ipAddressIds	string[]	A lista de IPs públicos que o serviço do Lote usará ao provisionar nós de computação. O número de IPs especificados aqui limita o tamanho máximo do Pool – 100 nós dedicados ou 100 nós spot/de baixa prioridade podem ser alocados para cada IP público. Por exemplo, um pool que precisa de 250 VMs dedicadas precisaria de pelo menos três IPs públicos especificados. Cada elemento dessa coleção é do 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.

ResizeError

Um erro que ocorreu ao redimensionar um Pool.

Nome	Tipo	Description
code	string	Um identificador para o erro de redimensionamento do Pool. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	string	Uma mensagem que descreve o erro de redimensionamento do Pool, destinada a ser adequada para exibição em uma interface do usuário.
values	NameValuePair[]	Uma lista de detalhes de erro adicionais relacionados ao erro de redimensionamento do Pool.

ResourceFile

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

Nome	Tipo	Description
autoStorageContainerName	string	O nome do contêiner de armazenamento na Conta de armazenamento automático. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada.
blobPrefix	string	O prefixo de blob a ser usado ao baixar blobs de um contêiner do Armazenamento do Azure. Somente os blobs cujos nomes começam com o prefixo especificado serão baixados. A propriedade é válida somente quando autoStorageContainerName ou storageContainerUrl é usado. Esse prefixo pode ser um nome de arquivo parcial ou um subdiretório. Se um prefixo não for especificado, todos os arquivos no contêiner serão baixados.
fileMode	string	O atributo de modo de permissão de arquivo no formato octal. Essa propriedade se aplica somente aos arquivos que estão sendo baixados para nós de computação do Linux. Ele será ignorado se for especificado para um resourceFile que será baixado 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 os arquivos, em relação ao diretório de trabalho da Tarefa. Se a propriedade httpUrl for especificada, o filePath será necessário e descreverá o caminho para o qual o arquivo será baixado, incluindo o nome do arquivo. Caso contrário, se a propriedade autoStorageContainerName ou storageContainerUrl for especificada, filePath será opcional e será o diretório para o qual baixar os arquivos. No caso em que filePath é usado como um diretório, qualquer estrutura de diretório já associada aos dados de entrada será mantida na íntegra e acrescentada ao diretório filePath especificado. O caminho relativo especificado não pode sair do diretório de trabalho da Tarefa (por exemplo, usando '..').
httpUrl	string	A URL do arquivo para download. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Se a URL apontar para Armazenamento de Blobs do Azure, ela deverá ser legível de nós de computação. Há três maneiras de obter essa URL para um blob no armazenamento do Azure: incluir uma SAS (Assinatura de Acesso Compartilhado) concedendo permissões de leitura no blob, usar uma identidade gerenciada com permissão de leitura ou definir a ACL para o blob ou seu contêiner para permitir o acesso público.
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída pelo usuário a ser usada para acessar Armazenamento de Blobs do Azure especificada por storageContainerUrl ou httpUrl A referência a uma identidade atribuída pelo usuário associada ao pool do Lote que um nó de computação usará.
storageContainerUrl	string	A URL do contêiner de blob no Armazenamento de Blobs do Azure. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Essa URL deve ser legível e listável de nós de computação. Há três maneiras de obter essa URL para um contêiner no armazenamento do Azure: incluir uma SAS (Assinatura de Acesso Compartilhado) concedendo permissões de leitura e lista no contêiner, usar uma identidade gerenciada com permissões de leitura e lista ou definir a ACL para o contêiner para permitir acesso público.

ResourceStatistics

Estatísticas relacionadas ao consumo de recursos por nós de computação em um pool.

Nome	Tipo	Description
avgCPUPercentage	number	O uso médio da CPU em todos os nós de computação no pool (percentual por nó).
avgDiskGiB	number	O espaço em disco usado médio em GiB em todos os nós de computação no pool.
avgMemoryGiB	number	O uso médio de memória em GiB em todos os nós de computação no pool.
diskReadGiB	number	A quantidade total de dados em GiB de leituras de disco em todos os nós de computação no pool.
diskReadIOps	integer	O número total de operações de leitura de disco em todos os nós de computação no pool.
diskWriteGiB	number	A quantidade total de dados em GiB de gravações de disco em todos os nós de computação no pool.
diskWriteIOps	integer	O número total de operações de gravação de disco em todos os nós de computação no pool.
lastUpdateTime	string	A hora em que as estatísticas foram atualizadas pela última vez. Todas as estatísticas são limitadas ao intervalo entre startTime e lastUpdateTime.
networkReadGiB	number	A quantidade total de dados em GiB de leituras de rede em todos os nós de computação no pool.
networkWriteGiB	number	A quantidade total de dados em GiB de gravações de rede em todos os nós de computação no pool.
peakDiskGiB	number	O pico de espaço em disco usado em GiB em todos os nós de computação no pool.
peakMemoryGiB	number	O pico de uso de memória em GiB em todos os nós de computação no pool.
startTime	string	A hora de início do intervalo de tempo coberto pelas estatísticas.

SecurityProfile

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

Nome	Tipo	Description
encryptionAtHost	boolean	Essa propriedade pode ser usada pelo usuário na solicitação para habilitar ou desabilitar a Criptografia de Host para a máquina virtual ou conjunto de dimensionamento de máquinas virtuais. Isso habilitará a criptografia para todos os discos, incluindo o disco Resource/Temp no próprio host.
securityType	SecurityTypes	Especifica o SecurityType da máquina virtual. Ele precisa 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 precisa ser definido como qualquer valor especificado para habilitar UefiSettings.

Nome	Tipo	Description
trustedLaunch	string	O início confiável protege contra técnicas de ataque avançadas e persistentes.

ServiceArtifactReference

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

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

StartTask

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

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

Nome	Tipo	Description
premium_lrs	string	O disco de dados/disco do sistema operacional deve usar o armazenamento premium com redundância local.
standard_lrs	string	O disco de dados/disco do sistema operacional deve usar o armazenamento padrão com redundância local.
standardssd_lrs	string	O disco de dados/disco do sistema operacional deve usar o armazenamento com redundância local do SSD padrão.

TaskContainerSettings

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

Nome	Tipo	Description
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 Serviço de Lote.
imageName	string	A Imagem a ser usada para criar o contêiner no qual a Tarefa será executada. Essa é a referência de imagem completa, como seria especificado para "docker pull". Se nenhuma marca for fornecida como parte do nome da imagem, a marca ":latest" será usada como padrão.
registry	ContainerRegistry	O registro privado que contém a Imagem do contêiner. Essa configuração poderá ser omitida se já tiver sido fornecida na criação do pool.
workingDirectory	ContainerWorkingDirectory	O local do diretório de trabalho tarefa do contêiner. O padrão é 'taskWorkingDirectory'.

TaskSchedulingPolicy

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

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

UefiSettings

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

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

UsageStatistics

Estatísticas relacionadas às informações de uso do pool.

Nome	Tipo	Description
dedicatedCoreTime	string	O tempo agregado do relógio de parede dos núcleos de Nó de Computação dedicados que fazem parte do pool.
lastUpdateTime	string	A hora em que as estatísticas foram atualizadas pela última vez. Todas as estatísticas são limitadas ao intervalo entre startTime e lastUpdateTime.
startTime	string	A hora de início do intervalo de tempo coberto pelas estatísticas.

UserAccount

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

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

UserAssignedIdentity

A identidade atribuída pelo usuário

Nome	Tipo	Description
clientId	string	A ID do cliente da identidade atribuída pelo usuário.
principalId	string	A ID da entidade de segurança da identidade atribuída pelo usuário.
resourceId	string	A ID de recurso do ARM da identidade atribuída pelo usuário

UserIdentity

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

Nome	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.

Nome	Tipo	Description
containerConfiguration	ContainerConfiguration	A configuração do contêiner para o Pool. Se especificado, a instalação será executada em cada Nó de Computação no Pool para permitir que Tarefas sejam executadas em contêineres. Todas as tarefas regulares e tarefas do gerenciador de trabalho executadas neste pool devem especificar a propriedade containerSettings e todas as outras Tarefas podem especificá-la.
dataDisks	DataDisk[]	A configuração de discos de dados anexados aos Nós de Computação no Pool. Essa propriedade deve ser especificada se os Nós de Computação no Pool precisarem ter discos de dados vazios anexados a eles. Isso não pode ser atualizado. Cada Nó de Computação obtém seu próprio disco (o disco não é um compartilhamento de arquivos). Os discos existentes não podem ser anexados, cada disco anexado está vazio. Quando o Nó de Computação é removido do Pool, o disco e todos os dados associados a ele também são excluídos. O disco não é formatado após ser anexado, ele deve ser formatado antes do uso – para obter mais informações, consulte https://docs.microsoft.com/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 criptografia de disco para o pool. Se especificado, a criptografia é executada em cada nó no pool durante o provisionamento de nó.
extensions	VMExtension[]	A extensão da máquina virtual para o pool. Se especificado, as extensões mencionadas nessa configuração serão instaladas em cada nó.
imageReference	ImageReference	Uma referência à imagem do Azure Máquinas Virtuais 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ê mantém licenças locais válidas para os Nós de Computação que serão implantados. Se omitido, nenhum desconto de licenciamento local será aplicado. Os valores são: Windows_Server – a licença local é para o Windows Server. Windows_Client – a licença local é para o Cliente Windows.
nodeAgentSKUId	string	O SKU do agente do Nó de Computação em Lote a ser provisionado em Nós de Computação no Pool. O agente do Nó de Computação em Lote é 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 do Lote. Há diferentes implementações do agente de Nó de Computação, conhecido como SKUs, para sistemas operacionais diferentes. Você deve 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ó de Computação com suporte, juntamente com a lista de referências de imagem verificadas, consulte a operação 'Listar SKUs do agente de Nó de Computação com suporte'.
nodePlacementConfiguration	NodePlacementConfiguration	A configuração de posicionamento do nó para o pool. Essa configuração especificará regras sobre como os nós no pool serão 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áquinas virtuais. Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais.
serviceArtifactReference	ServiceArtifactReference	Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de dimensionamento ao usar a versão de imagem 'mais recente'. A ID de referência do artefato de serviço na forma de /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}
windowsConfiguration	WindowsConfiguration	Configurações do sistema operacional Windows na máquina virtual. Essa propriedade não deve ser especificada se a propriedade imageReference especificar uma imagem do sistema operacional Linux.

VMExtension

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

Nome	Tipo	Description
autoUpgradeMinorVersion	boolean	Indica se a extensão deve usar uma versão secundária mais recente se uma estiver disponível no momento da implantação. Após a implantação, no entanto, a extensão não atualizará as versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como verdadeira.
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 os quais essa extensão precisa ser provisionada.
publisher	string	O nome do editor do manipulador de extensão.
settings	object	Configurações públicas formatadas em JSON para a extensão.
type	string	O tipo da extensão.
typeHandlerVersion	string	A versão do manipulador de script.

WindowsConfiguration

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

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

WindowsUserConfiguration

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

Nome	Tipo	Description
loginMode	LoginMode	O modo de logon do usuário O valor padrão para Pools VirtualMachineConfiguration é 'batch' e para Pools CloudServiceConfiguration é 'interativo'.