Job Schedule - List

Service:

Batch Service

API Version:

2023-11-01.18.0

Lista todas as Agendas de Trabalho na Conta especificada.

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

With optional parameters:

GET {batchUrl}/jobschedules?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&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.
api-version	query	True	string	Versão da API do cliente.
$expand	query		string	Uma cláusula de $expand OData.
$filter	query		string	Uma cláusula de $filter OData. Para obter mais informações sobre como construir esse filtro, consulte https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules.
$select	query		string	Uma cláusula de $select OData.
maxresults	query		integer int32	O número máximo de itens a serem retornados na resposta. Um máximo de 1000 Agendas de Trabalho pode ser retornado.
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 de solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se o servidor deve retornar a 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.

Respostas

Nome	Tipo	Description
200 OK	CloudJobScheduleListResult	Uma resposta que contém a lista de Agendas de Trabalho. 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

JobSchedule list

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "jobSchedule1",
      "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule1",
      "eTag": "0x8D40FFD2E10996A",
      "lastModified": "2016-11-18T21:52:24.0064874Z",
      "creationTime": "2016-11-18T21:52:22.5431125Z",
      "state": "active",
      "stateTransitionTime": "2016-11-18T21:52:24.0064874Z",
      "previousState": "disabled",
      "previousStateTransitionTime": "2016-11-18T21:52:23.6471782Z",
      "jobSpecification": {
        "priority": 0,
        "maxParallelTasks": -1,
        "allowTaskPreemption": false,
        "usesTaskDependencies": false,
        "onAllTasksComplete": "noaction",
        "onTaskFailure": "noaction",
        "constraints": {
          "maxWallClockTime": "P10675199DT2H48M5.4775807S",
          "maxTaskRetryCount": 0
        },
        "poolInfo": {
          "poolId": "poolId"
        }
      },
      "executionInfo": {
        "recentJob": {
          "url": "https://account.region.batch.azure.com/jobs/jobSchedule1:job-1",
          "id": "jobSchedule1:job-1"
        }
      }
    },
    {
      "id": "jobSchedule2",
      "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule2",
      "eTag": "0x8D40FFCFF760B51",
      "lastModified": "2016-11-18T21:51:05.8184017Z",
      "creationTime": "2016-11-18T21:51:05.8184017Z",
      "state": "active",
      "stateTransitionTime": "2016-11-18T21:51:05.8184017Z",
      "schedule": {
        "doNotRunUntil": "2020-01-01T12:30:00Z"
      },
      "jobSpecification": {
        "priority": 0,
        "maxParallelTasks": -1,
        "usesTaskDependencies": false,
        "onAllTasksComplete": "noaction",
        "onTaskFailure": "noaction",
        "constraints": {
          "maxWallClockTime": "P10675199DT2H48M5.4775807S",
          "maxTaskRetryCount": 0
        },
        "poolInfo": {
          "poolId": "testPool2"
        }
      },
      "executionInfo": {
        "nextRunTime": "2020-01-01T12:30:00Z"
      }
    }
  ]
}

Definições

Nome	Description
AccessScope	Os recursos do Lote aos quais o token concede acesso.
ApplicationPackageReference	Uma referência a um pacote a ser implantado em nós de computação.
AuthenticationTokenSettings	As configurações de um token de autenticação que a Tarefa pode usar para executar operações de serviço do Lote.
AutoPoolSpecification	Especifica características para um 'pool automático' temporário. O serviço lote criará esse pool automático quando o trabalho for enviado.
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.
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.
CloudJobSchedule	Um Agendamento de Trabalhos que permite trabalhos recorrentes especificando quando executar Trabalhos e uma especificação usada para criar cada Trabalho.
CloudJobScheduleListResult	O resultado da listagem dos Agendamentos de Trabalho em uma Conta.
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.
HttpHeader	Um par nome-valor de cabeçalho HTTP
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.
JobConstraints	As restrições de execução para um Trabalho.
JobManagerTask	Especifica os detalhes de uma tarefa do Gerenciador de Trabalhos.
JobNetworkConfiguration	A configuração de rede para o Trabalho.
JobPreparationTask	Uma Tarefa de Preparação de Trabalho a ser executada antes de qualquer Tarefa do Trabalho em qualquer nó de computação especificado.
JobReleaseTask	Uma tarefa de liberação de trabalho a ser executada na conclusão do trabalho em qualquer nó de computação em que o trabalho foi executado.
JobScheduleExecutionInformation	Contém informações sobre trabalhos que foram e serão executados em uma Agenda de Trabalho.
JobScheduleState	O estado da Agenda de Trabalho.
JobScheduleStatistics	Estatísticas de uso de recursos para uma Agenda de Trabalho.
JobSpecification	Especifica detalhes dos Trabalhos a serem criados em um agendamento.
LinuxUserConfiguration	Propriedades usadas para criar uma conta de usuário em um nó de computação do Linux.
LoginMode	O modo de logon do usuário
ManagedDisk
MetadataItem	Um par nome-valor associado a um recurso de serviço do Lote.
MountConfiguration	O sistema de arquivos a ser montado em cada nó.
NetworkConfiguration	A configuração de rede 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, intervalo de sub-rede ou marca especificado.
NFSMountConfiguration	Informações usadas para se conectar a um sistema de arquivos NFS.
NodeCommunicationMode	Determina como um pool se comunica com o serviço do Lote.
NodePlacementConfiguration	Configuração de posicionamento de nó para um pool.
NodePlacementPolicyType	A política de posicionamento para alocar nós no pool.
OnAllTasksComplete	A ação que o serviço lote deve executar quando todas as Tarefas no Trabalho estão no estado concluído.
OnTaskFailure	A ação que o serviço do Lote deve executar quando qualquer Tarefa no Trabalho falhar.
OSDisk	Configurações para o disco do sistema operacional do nó de computação (VM).
OutputFile	Uma especificação para carregar arquivos de um nó de computação Lote do Azure para outro local depois que o serviço do Lote terminar de executar o processo de Tarefa.
OutputFileBlobContainerDestination	Especifica um destino de upload de arquivo em um contêiner de armazenamento de blobs do Azure.
OutputFileDestination	O destino para o qual um arquivo deve ser carregado.
OutputFileUploadCondition	As condições sob as quais um arquivo de saída da Tarefa ou um conjunto de arquivos devem ser carregados.
OutputFileUploadOptions	Detalhes sobre uma operação de carregamento de arquivo de saída, inclusive sob quais condições executar o upload.
PoolEndpointConfiguration	A configuração do ponto de extremidade para um pool.
PoolInformation	Especifica como um trabalho deve ser atribuído a um pool.
PoolLifetimeOption	O tempo de vida mínimo dos Pools automáticos criados e como vários Trabalhos em um agendamento são atribuídos aos Pools.
PoolSpecification	Especificação para criar um novo Pool.
PublicIPAddressConfiguration	A configuração de endereço IP público da configuração de rede de um pool.
RecentJob	Informações sobre o trabalho mais recente a ser executado na Agenda de Trabalho.
ResourceFile	Um único arquivo ou vários arquivos a serem baixados em um Nó de Computação.
Schedule	O agendamento de acordo com o qual os Trabalhos serão criados. Todas as horas são fixas respectivamente para UTC e não são afetadas pelo horário de verão.
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 recriado.
StorageAccountType	O tipo de conta de armazenamento para uso na criação de discos de dados ou disco do sistema operacional.
TaskConstraints	Restrições de execução a serem aplicadas a uma Tarefa.
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.
UserAccount	Propriedades usadas para criar um usuário usado para executar Tarefas em um nó de computação Lote do Azure.
UserIdentity	A definição da identidade do usuário sob a qual a Tarefa é executada.
VirtualMachineConfiguration	A configuração para nós de computação em um pool com base na infraestrutura de Máquinas Virtuais do Azure.
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.

AccessScope

Os recursos do Lote aos quais o token concede acesso.

Nome	Tipo	Description
job	string	Concede acesso para executar todas as operações no trabalho que contém a Tarefa.

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.

AuthenticationTokenSettings

As configurações de um token de autenticação que a Tarefa pode usar para executar operações de serviço do Lote.

Nome	Tipo	Description
access	AccessScope[]	Os recursos do Lote aos quais o token concede acesso. O token de autenticação concede acesso a um conjunto limitado de operações de serviço do Lote. Atualmente, o único valor com suporte para a propriedade de acesso é 'job', que concede acesso a todas as operações relacionadas ao Trabalho que contém a Tarefa.

AutoPoolSpecification

Especifica características para um 'pool automático' temporário. O serviço lote criará esse pool automático quando o trabalho for enviado.

Nome	Tipo	Description
autoPoolIdPrefix	string	Um prefixo a ser adicionado ao identificador exclusivo quando um Pool é criado automaticamente. O serviço lote atribui a cada pool automático um identificador exclusivo na criação. Para distinguir entre pools criados para fins diferentes, você pode especificar esse elemento para adicionar um prefixo à ID atribuída. O prefixo pode ter até 20 caracteres.
keepAlive	boolean	Se um pool automático deve ser mantido vivo após a expiração de seu tempo de vida. Se for falso, o serviço lote excluirá o Pool depois que seu tempo de vida (conforme determinado pela configuração poolLifetimeOption) expirar; ou seja, quando o Agendamento de Trabalho ou Trabalho for concluído. Se for true, o serviço do Lote não excluirá o Pool automaticamente. Cabe ao usuário excluir pools automáticos criados com essa opção.
pool	PoolSpecification	A especificação pool para o pool automático.
poolLifetimeOption	PoolLifetimeOption	O tempo de vida mínimo dos Pools automáticos criados e como vários Trabalhos em um agendamento são atribuídos aos Pools.

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.

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.

CloudJobSchedule

Um Agendamento de Trabalhos que permite trabalhos recorrentes especificando quando executar Trabalhos e uma especificação usada para criar cada Trabalho.

Nome	Tipo	Description
creationTime	string	A hora de criação da Agenda de Trabalho.
displayName	string	O nome de exibição do agendamento.
eTag	string	A ETag da Agenda de Trabalho. Essa é uma cadeia de caracteres opaca. Você pode usá-lo para detectar se a Agenda de Trabalho foi alterada entre as solicitações. Em particular, você pode passar a ETag com uma solicitação de Agendamento de Trabalho de Atualização para especificar que suas alterações devem entrar em vigor somente se ninguém mais tiver modificado o agendamento enquanto isso.
executionInfo	JobScheduleExecutionInformation	Informações sobre trabalhos que foram e serão executados sob esse agendamento.
id	string	Uma cadeia de caracteres que identifica exclusivamente o agendamento dentro da Conta.
jobSpecification	JobSpecification	Os detalhes dos Trabalhos a serem criados nessa agenda.
lastModified	string	A hora da última modificação da Agenda de Trabalho. Esta é a última vez em que os dados de nível de agendamento, como a especificação do trabalho ou as informações de recorrência, foram alterados. Isso não leva em conta alterações no nível do trabalho, como novos Trabalhos sendo criados ou Trabalhos alterando o estado.
metadata	MetadataItem[]	Uma lista de pares nome-valor associados ao agendamento como metadados. O serviço do Lote não atribui nenhum significado aos metadados; ele é apenas para o uso do código do usuário.
previousState	JobScheduleState	O estado anterior da Agenda de Trabalho. Essa propriedade não estará presente se a Agenda de Trabalho estiver em seu estado ativo inicial.
previousStateTransitionTime	string	A hora em que o Agendamento de Trabalho inseriu seu estado anterior. Essa propriedade não estará presente se a Agenda de Trabalho estiver em seu estado ativo inicial.
schedule	Schedule	O agendamento de acordo com o qual os Trabalhos serão criados. Todas as horas são fixas respectivamente para UTC e não são afetadas pelo horário de verão.
state	JobScheduleState	O estado atual da Agenda de Trabalho.
stateTransitionTime	string	A hora em que a Agenda de Trabalho inseriu o estado atual.
stats	JobScheduleStatistics	As estatísticas de uso do recurso de tempo de vida para a Agenda de Trabalho. As estatísticas podem não estar disponíveis imediatamente. O serviço lote executa um roll-up periódico de estatísticas. O atraso típico é de cerca de 30 minutos.
url	string	A URL da Agenda de Trabalho.

CloudJobScheduleListResult

O resultado da listagem dos Agendamentos de Trabalho em uma Conta.

Nome	Tipo	Description
odata.nextLink	string	A URL para obter o próximo conjunto de resultados.
value	CloudJobSchedule[]	A lista de Agendas de Trabalho.

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 SO 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 de Administrador completas.
nonadmin	string	O usuário é um usuário padrão sem acesso elevado.

EnvironmentSetting

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

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

ErrorMessage

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

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

HttpHeader

Um par nome-valor de cabeçalho HTTP

Nome	Tipo	Description
name	string	O nome que não diferencia maiúsculas de minúsculas do cabeçalho a ser usado durante o carregamento de arquivos de saída
value	string	O valor do cabeçalho a ser usado durante o carregamento de arquivos de saída

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 do Lote é 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 backendPort especificado. Se o número máximo de regras do 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.

JobConstraints

As restrições de execução para um Trabalho.

Nome	Tipo	Description
maxTaskRetryCount	integer	O número máximo de vezes que cada 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á cada 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á uma 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 lote não repetirá Tarefas. Se a contagem máxima de repetições for -1, o serviço do Lote repetirá Tarefas sem limite. O valor padrão é 0 (sem novas tentativas).
maxWallClockTime	string	O tempo máximo decorrido que o Trabalho pode executar, medido a partir do momento em que o Trabalho é criado. Se o Trabalho não for concluído dentro do limite de tempo, o serviço do Lote o encerrará e todas as Tarefas que ainda estiverem em execução. Nesse caso, o motivo da terminação será MaxWallClockTimeExpiry. Se essa propriedade não for especificada, não haverá nenhum limite de tempo para que o Trabalho possa ser executado.

JobManagerTask

Especifica os detalhes de uma tarefa do Gerenciador de Trabalhos.

Nome	Tipo	Description
allowLowPriorityNode	boolean	Se a Tarefa Gerenciador de Trabalhos pode ser executada em um nó de computação spot/de baixa prioridade. O valor padrão é true.
applicationPackageReferences	ApplicationPackageReference[]	Uma lista de Pacotes de Aplicativos que o serviço do Lote implantará no Nó de Computação antes de executar a linha de comando. Os Pacotes de Aplicativos são baixados e implantados em um diretório compartilhado, não no diretório de trabalho tarefa. Portanto, se um Pacote de Aplicativo referenciado já estiver no Nó de Computação e estiver atualizado, ele não será baixado novamente; a cópia existente no Nó de Computação é usada. Se um Pacote de Aplicativo referenciado não puder ser instalado, por exemplo, porque o pacote foi excluído ou porque o download falhou, a Tarefa falhará.
authenticationTokenSettings	AuthenticationTokenSettings	As configurações de um token de autenticação que a Tarefa pode usar para executar operações de serviço do Lote. Se essa propriedade for definida, o serviço do Lote fornecerá à Tarefa um token de autenticação que pode ser usado para autenticar operações de serviço do Lote sem a necessidade de uma chave de acesso da conta. O token é fornecido por meio da variável de ambiente AZ_BATCH_AUTHENTICATION_TOKEN. As operações que a Tarefa pode executar usando o token dependem das configurações. Por exemplo, uma Tarefa pode solicitar permissões de Trabalho para adicionar outras Tarefas ao Trabalho ou marcar o status do Trabalho ou de outras Tarefas no Trabalho.
commandLine	string	A linha de comando da Tarefa Gerenciador de Trabalhos. A linha de comando não é executada em um shell e, portanto, não pode aproveitar os recursos do shell, como expansão de variável de ambiente. Se 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).
constraints	TaskConstraints	Restrições que se aplicam à Tarefa Gerenciador de Trabalhos.
containerSettings	TaskContainerSettings	As configurações do contêiner no qual a Tarefa Gerenciador de Trabalhos é executada. Se o Pool que executará essa Tarefa tiver containerConfiguration definido, isso também deverá ser definido. Se o Pool que executará essa Tarefa não tiver containerConfiguration definido, isso não deverá ser definido. 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 task são mapeadas para o contêiner e a linha de comando Task é 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.
displayName	string	O nome de exibição da Tarefa Gerenciador de Trabalhos. Ele não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024.
environmentSettings	EnvironmentSetting[]	Uma lista de configurações de variável de ambiente para a Tarefa Gerenciador de Trabalhos.
id	string	Uma cadeia de caracteres que identifica exclusivamente a Tarefa gerenciador de trabalhos dentro do trabalho. A ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hifens e sublinhados, e não pode conter mais de 64 caracteres.
killJobOnCompletion	boolean	Se a conclusão da Tarefa gerenciador de trabalho significa a conclusão de todo o Trabalho. Se for true, quando a Tarefa gerenciador de trabalhos for concluída, o serviço do Lote marcará o Trabalho como concluído. Se alguma Tarefa ainda estiver em execução no momento (diferente da Versão do Trabalho), essas Tarefas serão encerradas. Se for false, a conclusão da Tarefa Gerenciador de Trabalhos não afetará a status trabalho. Nesse caso, você deve usar o atributo onAllTasksComplete para encerrar o Trabalho ou fazer com que um cliente ou usuário encerre o trabalho explicitamente. Um exemplo disso é se o Gerenciador de Trabalho cria um conjunto de Tarefas, mas não assume mais nenhuma função em sua execução. O valor padrão é true. Se você estiver usando os atributos onAllTasksComplete e onTaskFailure para controlar o tempo de vida do trabalho e usar a Tarefa do Gerenciador de Trabalhos apenas para criar as Tarefas para o Trabalho (não para monitorar o progresso), é importante definir killJobOnCompletion como false.
outputFiles	OutputFile[]	Uma lista de arquivos que o serviço do Lote carregará do Nó de Computação depois de executar a linha de comando. Para tarefas de várias instâncias, os arquivos serão carregados somente do Nó de Computação no qual a Tarefa primária é executada.
requiredSlots	integer	O número de slots de agendamento necessários para execução da Tarefa. O padrão é 1. Uma Tarefa só poderá ser agendada para ser executada em um nó de computação se o nó tiver slots de agendamento gratuitos suficientes disponíveis. Para tarefas de várias instâncias, essa propriedade não tem suporte e não deve ser especificada.
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. Os arquivos listados sob esse elemento estão localizados no diretório de trabalho da Tarefa. 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.
runExclusive	boolean	Se a Tarefa Gerenciador de Trabalhos requer o uso exclusivo do Nó de Computação em que ele é executado. Se for true, nenhuma outra Tarefa será executada no mesmo nó enquanto o Gerenciador de Trabalhos estiver em execução. Se for falso, outras Tarefas poderão ser executadas simultaneamente com o Gerenciador de Trabalhos em um Nó de Computação. A Tarefa Gerenciador de Trabalhos conta normalmente em relação ao limite de Tarefas simultâneas do Nó de Computação, portanto, isso só será relevante se o Nó de Computação permitir várias Tarefas Simultâneas. O valor padrão é true.
userIdentity	UserIdentity	A identidade do usuário na qual a Tarefa Gerenciador de Trabalhos é executada. Se omitido, a Tarefa será executada como um usuário não administrativo exclusivo da Tarefa.

JobNetworkConfiguration

A configuração de rede para o Trabalho.

Nome	Tipo	Description
subnetId	string	O identificador de recurso arm da sub-rede de rede virtual na qual os Nós de Computação que executam Tarefas do Trabalho ingressarão durante a Tarefa. Isso só funcionará com um Pool virtualMachineConfiguration. A rede virtual deve estar na mesma região e assinatura que a conta do Lote do Azure. A sub-rede especificada deve ter endereços IP gratuitos suficientes para acomodar o número de nós de computação que executarão Tarefas do Trabalho. Isso pode ser até o número de nós de computação no pool. A entidade de serviço 'MicrosoftAzureBatch' deve ter a função RBAC (Colaborador da Máquina Virtual Clássica Role-Based Controle de Acesso' para a VNet especificada para que Lote do Azure serviço possa agendar Tarefas nos Nós. Isso pode ser verificado verificando se a VNet especificada tem algum NSG (Grupos de Segurança de Rede) associado. 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. Isso é do formato /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. Se a VNet especificada tiver algum NSG (Grupos de Segurança de Rede) associado, algumas portas reservadas do sistema deverão ser habilitadas para comunicação de entrada do serviço Lote do Azure. 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. A porta 443 também precisa estar aberta para conexões de saída para comunicações com o Armazenamento do Azure. Para obter mais detalhes, confira: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

JobPreparationTask

Uma Tarefa de Preparação de Trabalho a ser executada antes de qualquer Tarefa do Trabalho em qualquer nó de computação especificado.

Nome	Tipo	Description
commandLine	string	A linha de comando da Tarefa de Preparação do Trabalho. A linha de comando não é executada em um shell e, portanto, não pode aproveitar os recursos do shell, como expansão de variável de ambiente. Se 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).
constraints	TaskConstraints	Restrições que se aplicam à Tarefa de Preparação de Trabalho.
containerSettings	TaskContainerSettings	As configurações do contêiner no qual a Tarefa de Preparação de Trabalho é executada. 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 task são mapeadas para o contêiner e a linha de comando Task é 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 a Tarefa de Preparação do Trabalho.
id	string	Uma cadeia de caracteres que identifica exclusivamente a Tarefa de Preparação de Trabalho dentro do Trabalho. A ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hifens e sublinhados, e não pode conter mais de 64 caracteres. Se você não especificar essa propriedade, o serviço lote atribuirá um valor padrão de 'jobpreparation'. Nenhuma outra Tarefa no Trabalho pode ter a mesma ID que a Tarefa de Preparação do Trabalho. Se você tentar enviar uma Tarefa com a mesma ID, o serviço do Lote rejeitará a solicitação com o código de erro TaskIdSameAsJobPreparationTask; se você estiver chamando a API REST diretamente, o código de status HTTP será 409 (Conflito).
rerunOnNodeRebootAfterSuccess	boolean	Se o serviço do Lote deve executar novamente a Tarefa de Preparação do Trabalho após a reinicialização de um Nó de Computação. A Tarefa de Preparação do Trabalho sempre será executada novamente se um Nó de Computação for recriado ou se a Tarefa de Preparação do Trabalho não tiver sido concluída (por exemplo, porque a reinicialização ocorreu enquanto a Tarefa estava em execução). Portanto, você sempre deve escrever uma Tarefa de Preparação de Trabalho para ser idempotente e se comportar corretamente se for executada várias vezes. O valor padrão é true.
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. Os arquivos listados sob esse elemento estão localizados no diretório de trabalho da Tarefa. 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.
userIdentity	UserIdentity	A identidade do usuário na qual a Tarefa de Preparação de Trabalho é executada. Se omitido, a Tarefa será executada como um usuário não administrativo exclusivo para a Tarefa em Nós de Computação do Windows ou um usuário não administrativo exclusivo para o Pool em Nós de Computação do Linux.
waitForSuccess	boolean	Se o serviço do Lote deve aguardar a conclusão bem-sucedida da Tarefa de Preparação do Trabalho antes de agendar outras Tarefas do Trabalho no Nó de Computação. Uma Tarefa de Preparação de Trabalho foi concluída com êxito se for encerrada com o código de saída 0. Se true e a Tarefa de Preparação do Trabalho falharem em um nó, o serviço do Lote tentará novamente a Tarefa de Preparação de Trabalho até sua contagem máxima de repetição (conforme especificado no elemento constraints). Se a Tarefa ainda não tiver sido concluída com êxito após todas as novas tentativas, o serviço do Lote não agendará Tarefas do Trabalho para o Nó. O Nó permanece ativo e qualificado para executar Tarefas de outros Trabalhos. Se for false, o serviço do Lote não aguardará a conclusão da Tarefa de Preparação do Trabalho. Nesse caso, outras Tarefas do Trabalho podem começar a ser executadas no Nó de Computação enquanto a Tarefa de Preparação do Trabalho ainda estiver em execução; e mesmo que a Tarefa de Preparação do Trabalho falhe, novas Tarefas continuarão a ser agendadas no Nó de Computação. O valor padrão é true.

JobReleaseTask

Uma tarefa de liberação de trabalho a ser executada na conclusão do trabalho em qualquer nó de computação em que o trabalho foi executado.

Nome	Tipo	Description
commandLine	string	A linha de comando da Tarefa Liberação do Trabalho. A linha de comando não é executada em um shell e, portanto, não pode aproveitar os recursos do shell, como expansão de variável de ambiente. Se 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 para o contêiner no qual a Tarefa de Liberação de Trabalho é executada. 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 task são mapeadas para o contêiner e a linha de comando Task é 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 a Tarefa de Liberação de Trabalho.
id	string	Uma cadeia de caracteres que identifica exclusivamente a Tarefa de Liberação de Trabalho no Trabalho. A ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hifens e sublinhados, e não pode conter mais de 64 caracteres. Se você não especificar essa propriedade, o serviço lote atribuirá um valor padrão de 'jobrelease'. Nenhuma outra Tarefa no Trabalho pode ter a mesma ID que a Tarefa de Liberação de Trabalho. Se você tentar enviar uma Tarefa com a mesma ID, o serviço do Lote rejeitará a solicitação com o código de erro TaskIdSameAsJobReleaseTask; se você estiver chamando a API REST diretamente, o código de status HTTP será 409 (Conflito).
maxWallClockTime	string	O tempo máximo decorrido que a Tarefa de Versão do Trabalho pode executar em um determinado Nó de Computação, medido a partir do momento em que a Tarefa é iniciada. Se a Tarefa não for concluída dentro do limite de tempo, o serviço do Lote a encerrará. O valor padrão é 15 minutos. Você não pode especificar um tempo limite superior a 15 minutos. Se você fizer isso, o serviço lote o rejeitará com um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação Incorreta).
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.
retentionTime	string	O tempo mínimo para manter o diretório Tarefa para a Tarefa de Liberação de Trabalho no Nó de Computação. Após esse período, o serviço lote poderá excluir o diretório Task e todo o seu conteúdo. O padrão é 7 dias, ou seja, o diretório Tarefa será mantido por 7 dias, a menos que o Nó de Computação seja removido ou o Trabalho seja excluído.
userIdentity	UserIdentity	A identidade do usuário na qual a Tarefa de Liberação de Trabalho é executada. Se omitido, a Tarefa será executada como um usuário não administrativo exclusivo da Tarefa.

JobScheduleExecutionInformation

Contém informações sobre trabalhos que foram e serão executados em uma Agenda de Trabalho.

Nome	Tipo	Description
endTime	string	A hora em que o agendamento terminou. Essa propriedade será definida somente se a Agenda de Trabalho estiver no estado concluído.
nextRunTime	string	Na próxima vez em que um Trabalho será criado sob esse agendamento. Essa propriedade só será significativa se o agendamento estiver no estado ativo quando chegar a hora. Por exemplo, se o agendamento estiver desabilitado, nenhum Trabalho será criado em nextRunTime, a menos que o Trabalho esteja habilitado antes disso.
recentJob	RecentJob	Informações sobre o trabalho mais recente na Agenda de Trabalho. Essa propriedade estará presente somente se pelo menos um Trabalho tiver sido executado de acordo com o agendamento.

JobScheduleState

O estado da Agenda de Trabalho.

Nome	Tipo	Description
active	string	A Agenda de Trabalhos está ativa e criará Trabalhos de acordo com sua agenda.
completed	string	O Agendamento de Trabalho foi encerrado, atingindo sua hora de término ou pelo usuário encerrando-o explicitamente.
deleting	string	O usuário solicitou que a Agenda de Trabalho fosse excluída, mas a operação de exclusão ainda está em andamento. O agendador não iniciará nenhum novo Trabalho para este Agendamento de Trabalho e excluirá trabalhos e tarefas existentes na Agenda de Trabalho, incluindo qualquer trabalho ativo. O Agendamento do Trabalho será excluído quando todos os Trabalhos e Tarefas na Agenda de Trabalho tiverem sido excluídos.
disabled	string	O usuário desabilitou a Agenda de Trabalho. O agendador não iniciará novos trabalhos neste agendamento, mas qualquer trabalho ativo existente continuará a ser executado.
terminating	string	A Agenda de Trabalho não tem mais trabalho a fazer ou foi explicitamente encerrada pelo usuário, mas a operação de encerramento ainda está em andamento. O agendador não iniciará nenhum novo Trabalho para esta Agenda de Trabalho, nem nenhum trabalho existente está ativo.

JobScheduleStatistics

Estatísticas de uso de recursos para uma Agenda de Trabalho.

Nome	Tipo	Description
kernelCPUTime	string	O tempo total de CPU do modo kernel (somado em todos os núcleos e todos os Nós de Computação) consumido por todas as Tarefas em todos os Trabalhos criados na agenda.
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.
numFailedTasks	integer	O número total de Tarefas que falharam durante o intervalo de tempo determinado em Trabalhos criados de acordo com o agendamento. Uma Tarefa falhará se esgotar sua contagem máxima de repetições sem retornar o código de saída 0.
numSucceededTasks	integer	O número total de Tarefas concluídas com êxito durante o intervalo de tempo determinado em Trabalhos criados de acordo com o agendamento. Uma Tarefa será concluída com êxito se retornar o código de saída 0.
numTaskRetries	integer	O número total de repetições durante o intervalo de tempo especificado em todas as Tarefas em todos os Trabalhos criados na agenda.
readIOGiB	number	O total de gibibytes lidos do disco por todas as Tarefas em todos os Trabalhos criados na agenda.
readIOps	integer	O número total de operações de leitura de disco feitas por todas as Tarefas em todos os Trabalhos criados na agenda.
startTime	string	A hora de início do intervalo de tempo coberto pelas estatísticas.
url	string	A URL das estatísticas.
userCPUTime	string	O tempo total de CPU do modo de usuário (somado em todos os núcleos e todos os Nós de Computação) consumido por todas as Tarefas em todos os Trabalhos criados na agenda.
waitTime	string	O tempo de espera total de todas as Tarefas em todos os Trabalhos criados de acordo com o agendamento. O tempo de espera para uma Tarefa é definido como o tempo decorrido entre a criação da Tarefa e o início da execução da Tarefa. (Se a Tarefa for repetida devido a falhas, o tempo de espera será o tempo para a execução mais recente da Tarefa.) Esse valor só é relatado nas estatísticas de tempo de vida da conta; ele não está incluído nas estatísticas de trabalho.
wallClockTime	string	O tempo total do relógio de parede de todas as Tarefas em todos os Trabalhos criados na agenda. A hora do relógio de parede é o tempo decorrido de quando a Tarefa começou a ser executada em um Nó de Computação até quando foi concluída (ou até a última vez em que as estatísticas foram atualizadas, se a Tarefa não tiver sido concluída até então). Se uma Tarefa foi repetida, isso incluirá a hora do relógio de parede de todas as tentativas de Tarefa.
writeIOGiB	number	O total de gibibytes gravados em disco por todas as Tarefas em todos os Trabalhos criados na agenda.
writeIOps	integer	O número total de operações de gravação de disco feitas por todas as Tarefas em todos os Trabalhos criados na agenda.

JobSpecification

Especifica detalhes dos Trabalhos a serem criados em um agendamento.

Nome	Tipo	Valor padrão	Description
allowTaskPreemption	boolean		Se as tarefas neste trabalho podem ser preempcionadas por outros trabalhos de alta prioridade Se o valor for definido como True, outros trabalhos de alta prioridade enviados ao sistema terão precedência e poderão redirecionar tarefas desse trabalho. Você pode atualizar o allowTaskPreemption de um trabalho depois que ele for criado usando a API de trabalho de atualização.
commonEnvironmentSettings	EnvironmentSetting[]		Uma lista de configurações comuns de variáveis de ambiente. Essas variáveis de ambiente são definidas para todas as Tarefas em Trabalhos criadas sob esse agendamento (incluindo as Tarefas de Preparação de Trabalho, Preparação de Trabalho e Liberação de Trabalho). Tarefas individuais podem substituir uma configuração de ambiente especificada aqui especificando o mesmo nome de configuração com um valor diferente.
constraints	JobConstraints		As restrições de execução para trabalhos criados nessa agenda.
displayName	string		O nome de exibição para Trabalhos criados nessa agenda. O nome não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024.
jobManagerTask	JobManagerTask		Os detalhes de uma Tarefa do Gerenciador de Trabalhos a ser iniciada quando um trabalho é iniciado nessa agenda. Se o Trabalho não especificar uma Tarefa do Gerenciador de Trabalhos, o usuário deverá adicionar explicitamente Tarefas ao Trabalho usando a API de Tarefa. Se o Trabalho especificar uma Tarefa do Gerenciador de Trabalhos, o serviço do Lote criará a Tarefa Gerenciador de Trabalhos quando o Trabalho for criado e tentará agendar a Tarefa do Gerenciador de Trabalhos antes de agendar outras Tarefas no Trabalho.
jobPreparationTask	JobPreparationTask		A Tarefa de Preparação de Trabalho para Trabalhos criada neste agendamento. Se um trabalho tiver uma tarefa de preparação de trabalho, o serviço do Lote executará a Tarefa de Preparação de Trabalho em um Nó antes de iniciar qualquer Tarefa desse trabalho nesse nó de computação.
jobReleaseTask	JobReleaseTask		A Tarefa de Liberação de Trabalho para Trabalhos criada neste agendamento. A principal finalidade da Tarefa de Liberação de Trabalho é desfazer alterações em nós feitas pela Tarefa de Preparação de Trabalho. As atividades de exemplo incluem a exclusão de arquivos locais ou o desligamento de serviços que foram iniciados como parte da preparação do trabalho. Uma Tarefa de Liberação de Trabalho não pode ser especificada sem especificar também uma Tarefa de Preparação de Trabalho para o Trabalho. O serviço lote executa a Tarefa de Liberação de Trabalho nos Nós de Computação que executaram a Tarefa de Preparação de Trabalho.
maxParallelTasks	integer	-1	O número máximo de tarefas que podem ser executadas em paralelo para o trabalho. O valor de maxParallelTasks deve ser -1 ou maior que 0, se especificado. Se não for especificado, o valor padrão será -1, o que significa que não há limite para o número de tarefas que podem ser executadas de uma só vez. Você pode atualizar maxParallelTasks de um trabalho depois que ele for criado usando a API de trabalho de atualização.
metadata	MetadataItem[]		Uma lista de pares nome-valor associados a cada Trabalho criado nessa agenda como metadados. O serviço lote não atribui nenhum significado aos metadados; é exclusivamente para o uso do código do usuário.
networkConfiguration	JobNetworkConfiguration		A configuração de rede para o Trabalho.
onAllTasksComplete	OnAllTasksComplete		A ação que o serviço do Lote deve executar quando todas as Tarefas em um Trabalho criado sob esse agendamento estão no estado concluído. Observe que, se um trabalho não contiver Tarefas, todas as Tarefas serão consideradas concluídas. Essa opção é, portanto, mais comumente usada com uma tarefa do Gerenciador de Trabalhos; se você quiser usar a rescisão automática de trabalho sem um Gerenciador de Trabalhos, inicialmente deverá definir onAllTasksComplete como noaction e atualizar as propriedades de trabalho para definir onAllTasksComplete para terminatejob depois de terminar de adicionar Tarefas. O padrão é noaction.
onTaskFailure	OnTaskFailure		A ação que o serviço lote deve executar quando qualquer Tarefa falha em um trabalho criado sob esse agendamento. Considera-se que uma Tarefa falhou se falhou se tiver um failureInfo. Um failureInfo será definido se a Tarefa for concluída com um código de saída diferente de zero depois de esgotar sua contagem de repetições ou se houver um erro ao iniciar a Tarefa, por exemplo, devido a um erro de download de arquivo de recurso. O padrão é noaction.
poolInfo	PoolInformation		O pool no qual o serviço do Lote executa as Tarefas de Trabalhos criadas neste agendamento.
priority	integer		A prioridade dos Trabalhos criados neste agendamento. Valores de prioridade podem variar de -1000 a 1000,-1000 sendo a prioridade mais baixa e 1000 a prioridade mais alta. O valor padrão é 0. Essa prioridade é usada como o padrão para todos os trabalhos na Agenda de Trabalho. Você pode atualizar a prioridade de um trabalho depois que ele tiver sido criado usando a API de trabalho de atualização.
usesTaskDependencies	boolean		Se Tarefas no Trabalho podem definir dependências entre si. O padrão é false.

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 do usuário

Nome	Tipo	Description
batch	string	O LOGON32_LOGON_BATCH modo de logon do Win32. O modo de logon em lote é recomendado para processos paralelos de execução prolongada.
interactive	string	O LOGON32_LOGON_INTERACTIVE modo de logon do Win32. O UAC está habilitado no Windows VirtualMachineConfiguration Pools. Se essa opção for usada com uma identidade de usuário elevada em um Pool 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.

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 SR-IOV (virtualização de E/S de raiz única) para uma VM, o que pode levar a um desempenho de rede aprimorado. 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 do Lote. 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 do Lote. 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 formato /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. A rede virtual deve estar na mesma região e assinatura que a conta do Lote do Azure. A sub-rede especificada deve ter endereços IP gratuitos suficientes para acomodar o número de nós de computação no pool. Se a sub-rede não tiver endereços IP gratuitos suficientes, o Pool alocará parcialmente nós e ocorrerá um erro de redimensionamento. A entidade de serviço 'MicrosoftAzureBatch' deve ter a função rbac (colaborador de máquina virtual clássica) Role-Based Controle de Acesso 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) associado. 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, intervalo de sub-rede ou marca especificado.
priority	integer	A prioridade dessa regra. As prioridades em um pool devem ser exclusivas e são avaliadas em ordem de prioridade. Quanto menor o número, maior a prioridade. Por exemplo, as regras podem ser especificadas com números de pedidos de 150, 250 e 350. A regra com o número de ordem 150 tem precedência sobre a regra que tem uma ordem de 250. As prioridades permitidas são de 150 a 4096. Se qualquer 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 correspondidos para a 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, intervalo de sub-rede ou marca especificado.

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 do Lote.
simplified	string	Os nós que usam o modo de comunicação simplificado exigem comunicação TCP de saída na porta 443 para o "BatchNodeManagement. Marca de serviço {region}". Não são necessárias portas de entrada abertas.

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.

OnAllTasksComplete

A ação que o serviço lote deve executar quando todas as Tarefas no Trabalho estão no estado concluído.

Nome	Tipo	Description
noaction	string	Não fazer nada. O Trabalho permanece ativo, a menos que seja encerrado ou desabilitado por outros meios.
terminatejob	string	Encerre o trabalho. TerminateReason do trabalho é definido como 'AllTasksComplete'.

OnTaskFailure

A ação que o serviço do Lote deve executar quando qualquer Tarefa no Trabalho falhar.

Nome	Tipo	Description
noaction	string	Não fazer nada. O Trabalho permanece ativo, a menos que seja encerrado ou desabilitado por outros meios.
performexitoptionsjobaction	string	Execute a ação associada à condição De saída da tarefa na coleção ExitConditions da Tarefa. (Isso ainda pode resultar em nenhuma ação sendo tomada, se for isso que a Tarefa especifica.)

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.

OutputFile

Uma especificação para carregar arquivos de um nó de computação Lote do Azure para outro local depois que o serviço do Lote terminar de executar o processo de Tarefa.

Nome	Tipo	Description
destination	OutputFileDestination	O destino dos arquivos de saída.
filePattern	string	Um padrão que indica quais arquivos carregar. Há suporte para caminhos relativos e absolutos. Os caminhos relativos são relativos ao diretório de trabalho tarefa. Há suporte para os seguintes caracteres curinga: * corresponde a 0 ou mais caracteres (por exemplo, o padrão abc* corresponderia a abc ou abcdef), ** corresponde a qualquer diretório, ? corresponde a qualquer caractere único, [abc] corresponde a um caractere entre colchetes e [a-c] corresponde a um caractere no intervalo. Colchetes podem incluir uma negação para corresponder a qualquer caractere não especificado (por exemplo , [!abc] corresponde a qualquer caractere, mas a, b ou c). Se um nome de arquivo começar com "." ele será ignorado por padrão, mas poderá ser correspondido especificando-o explicitamente (por exemplo ,.gif não corresponderá a .a.gif, mas ..gif corresponderá). Um exemplo simples: ***.txt corresponde a qualquer arquivo que não seja iniciado em '.' e termina com .txt no diretório Trabalho da tarefa ou em qualquer subdiretório. Se o nome do arquivo contiver um caractere curinga, ele poderá ser escapado usando colchetes (por exemplo, abc[] corresponderia a um arquivo chamado abc). Observe que \ e / são tratados como separadores de diretório no Windows, mas apenas / está no Linux. As variáveis de ambiente (%var% no Windows ou $var no Linux) são expandidas antes da aplicação do padrão.
uploadOptions	OutputFileUploadOptions	Opções adicionais para a operação de upload, incluindo sob quais condições executar o upload.

OutputFileBlobContainerDestination

Especifica um destino de upload de arquivo em um contêiner de armazenamento de blobs do Azure.

Nome	Tipo	Description
containerUrl	string	A URL do contêiner dentro de Armazenamento de Blobs do Azure para a qual carregar os arquivos. Se não estiver usando uma identidade gerenciada, a URL deverá incluir uma SAS (Assinatura de Acesso Compartilhado) concedendo permissões de gravação ao contêiner.
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída pelo usuário a ser usada para acessar Armazenamento de Blobs do Azure especificada por containerUrl A identidade deve ter acesso de gravação ao contêiner Armazenamento de Blobs do Azure
path	string	O blob de destino ou o diretório virtual dentro do contêiner do Armazenamento do Azure. Se filePattern se referir a um arquivo específico (ou seja, não contiver caracteres curinga), o caminho será o nome do blob para o qual carregar esse arquivo. Se filePattern contiver um ou mais curingas (e, portanto, pode corresponder a vários arquivos), o caminho será o nome do diretório virtual do blob (que é anexado a cada nome de blob) para o qual carregar os arquivos. Se omitido, os arquivos são carregados na raiz do contêiner com um nome de blob que corresponde ao nome do arquivo.
uploadHeaders	HttpHeader[]	Uma lista de pares nome-valor para cabeçalhos a serem usados no carregamento de arquivos de saída Esses cabeçalhos serão especificados ao carregar arquivos no Armazenamento do Azure. Documento oficial sobre cabeçalhos permitidos ao carregar blobs: https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

O destino para o qual um arquivo deve ser carregado.

Nome	Tipo	Description
container	OutputFileBlobContainerDestination	Um local no armazenamento de blobs do Azure para o qual os arquivos são carregados.

OutputFileUploadCondition

As condições sob as quais um arquivo de saída da Tarefa ou um conjunto de arquivos devem ser carregados.

Nome	Tipo	Description
taskcompletion	string	Carregue os arquivos após a saída do processo de tarefa, independentemente do código de saída.
taskfailure	string	Carregue os arquivos somente depois que o processo de Tarefa for encerrado com um código de saída diferente de zero.
tasksuccess	string	Carregue os arquivos somente depois que o processo de Tarefa for encerrado com um código de saída 0.

OutputFileUploadOptions

Detalhes sobre uma operação de carregamento de arquivo de saída, inclusive sob quais condições executar o upload.

Nome	Tipo	Description
uploadCondition	OutputFileUploadCondition	As condições sob as quais o arquivo de saída da tarefa ou o conjunto de arquivos devem ser carregados. O padrão é taskcompletion.

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 lidar com 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.

PoolInformation

Especifica como um trabalho deve ser atribuído a um pool.

Nome	Tipo	Description
autoPoolSpecification	AutoPoolSpecification	Características de um 'pool automático' temporário. O serviço lote criará esse pool automático quando o Trabalho for enviado. Se a criação automática do pool falhar, o serviço do Lote moverá o Trabalho para um estado concluído e o erro de criação do pool será definido na propriedade de erro de agendamento do trabalho. O serviço lote gerencia o tempo de vida (criação e, a menos que keepAlive seja especificado, exclusão) do pool automático. Qualquer ação do usuário que afete o tempo de vida do pool automático enquanto o Trabalho estiver ativo resultará em um comportamento inesperado. Você deve especificar a ID do Pool ou a especificação do pool automático, mas não ambos.
poolId	string	A ID de um pool existente. Todas as Tarefas do Trabalho serão executadas no pool especificado. Você deve garantir que o Pool referenciado por essa propriedade exista. Se o Pool não existir no momento em que o serviço do Lote tentar agendar um Trabalho, nenhuma Tarefa para o Trabalho será executada até que você crie um Pool com essa ID. Observe que o serviço do Lote não rejeitará a solicitação de Trabalho; ele simplesmente não executará Tarefas até que o pool exista. Você deve especificar a ID do Pool ou a especificação do pool automático, mas não ambos.

PoolLifetimeOption

O tempo de vida mínimo dos Pools automáticos criados e como vários Trabalhos em um agendamento são atribuídos aos Pools.

Nome	Tipo	Description
job	string	O Pool existe para o tempo de vida do trabalho ao qual ele é dedicado. O serviço lote cria o Pool quando cria o Trabalho. Se a opção 'job' for aplicada a um Agendamento de Trabalho, o serviço do Lote criará um novo pool automático para cada trabalho criado na agenda.
jobschedule	string	O pool existe para o tempo de vida da Agenda de Trabalho. O Serviço de Lote cria o Pool quando cria o primeiro Trabalho na agenda. Você pode aplicar essa opção somente a Agendas de Trabalho, não a Trabalhos.

PoolSpecification

Especificação para criar um novo Pool.

Nome	Tipo	Description
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 sem suporte, a criação do pool falhará. As licenças permitidas disponíveis no Pool são 'maya', 'vray', '3dsmax', 'arnold'. Uma cobrança adicional se aplica a cada licença de aplicativo adicionada ao Pool.
applicationPackageReferences	ApplicationPackageReference[]	A lista de Pacotes a serem instalados em cada Nó de Computação no Pool. Ao criar um pool, a ID do aplicativo do pacote deve ser totalmente qualificada (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). As alterações nas referências de pacote afetam todos os novos nós que ingressam no Pool, mas não afetam os Nós de Computação que já estão no Pool até que sejam reinicializados ou reimagem. Há no máximo 10 referências de pacote em qualquer pool especificado.
autoScaleEvaluationInterval	string	O intervalo de tempo no qual ajustar automaticamente o tamanho do pool de acordo com a fórmula de dimensionamento automático. O valor padrão é 15 minutos. O valor mínimo e máximo são 5 minutos e 168 horas, respectivamente. Se você especificar um valor menor que 5 minutos ou superior a 168 horas, o serviço do Lote rejeitará a solicitação com um erro de valor de propriedade inválido; se você estiver chamando a API REST diretamente, o código http status será 400 (solicitação incorreta).
autoScaleFormula	string	A fórmula para o número desejado de Nós de Computação no Pool. Essa propriedade não deve ser especificada se enableAutoScale estiver definido como false. Ele será necessário se enableAutoScale estiver definido como true. A fórmula é verificada quanto à validade antes da criação do Pool. Se a fórmula não for válida, o serviço do Lote rejeitará a solicitação com informações detalhadas de erro.
certificateReferences	CertificateReference[]	Uma lista de Certificados a serem instalados em cada Nó de Computação no Pool. Para nós do Windows, o serviço lote instala os Certificados no repositório e local especificados do Certificado. 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 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 deverá ser especificada se o Pool precisar ser criado com VMs paaS do Azure. Essa propriedade e virtualMachineConfiguration são mutuamente exclusivas e uma das propriedades deve ser especificada. Se nenhum dos dois for especificado, o serviço do Lote retornará um erro; se você estiver chamando a API REST diretamente, o código http status será 400 (solicitação incorreta). Essa propriedade não poderá ser especificada se a Conta do Lote foi criada com sua propriedade poolAllocationMode definida como 'UserSubscription'.
displayName	string	O nome de exibição do Pool. O nome de exibição não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024.
enableAutoScale	boolean	Se o tamanho do Pool deve ser ajustado automaticamente ao longo do tempo. Se false, pelo menos um dos targetDedicatedNodes e targetLowPriorityNodes devem ser especificados. Se for true, o elemento autoScaleFormula será necessário. O Pool redimensiona automaticamente de acordo com a fórmula. O valor padrão é false.
enableInterNodeCommunication	boolean	Se o Pool permite comunicação direta entre nós de computação. Habilitar a comunicação entre nós limita o tamanho máximo do Pool devido a restrições de implantação nos Nós de Computação do Pool. Isso pode fazer com que o Pool não atinja o tamanho desejado. O valor padrão é false.
metadata	MetadataItem[]	Uma lista de pares nome-valor associados ao Pool como metadados. O serviço do Lote não atribui nenhum significado aos metadados; ele é apenas para o uso do código do usuário.
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.
resizeTimeout	string	O tempo limite para alocação de nós de computação para o pool. Esse tempo limite se aplica apenas ao dimensionamento manual; ele não tem efeito quando enableAutoScale é definido como true. O valor padrão é 15 minutos. O valor mínimo é 5 minutos. Se você especificar um valor menor que 5 minutos, o serviço do Lote rejeitará a solicitação com um erro; se você estiver chamando a API REST diretamente, o código http status será 400 (solicitação incorreta).
resourceTags	object	As marcas especificadas pelo usuário associadas ao pool. As marcas definidas pelo usuário a serem associadas ao pool de 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 a ser executada em cada Nó de Computação à medida que ele ingressa no Pool. A Tarefa é executada quando o Nó de Computação é adicionado ao Pool ou quando o Nó de Computação é reiniciado. 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 repetições 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, uma repetição interna devido a uma operação de recuperação poderá ocorrer. Por isso, todas as Tarefas devem ser idempotentes. Isso significa que as tarefas precisam tolerar a interrupção e a reinicialização 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. Cuidados especiais devem ser tomados 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 possa executar novamente o StartTask.
targetDedicatedNodes	integer	O número desejado de nós de computação dedicados no pool. Essa propriedade não deverá ser especificada se enableAutoScale estiver definido como true. Se enableAutoScale estiver definido como false, você deverá definir targetDedicatedNodes, targetLowPriorityNodes ou ambos.
targetLowPriorityNodes	integer	O número desejado de nós de computação spot/de baixa prioridade no pool. Essa propriedade não deverá ser especificada se enableAutoScale estiver definido como true. Se enableAutoScale estiver definido como false, você deverá definir targetDedicatedNodes, targetLowPriorityNodes ou ambos.
targetNodeCommunicationMode	NodeCommunicationMode	O modo de comunicação de nó desejado para o pool. Se omitido, o valor padrão será Default.
taskSchedulingPolicy	TaskSchedulingPolicy	Como as tarefas são distribuídas entre nós de computação em um pool. Se não for especificado, o padrão será distribuído.
taskSlotsPerNode	integer	O número de slots de 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.
userAccounts	UserAccount[]	A lista de contas de usuário a serem criadas em cada nó de computação no pool.
virtualMachineConfiguration	VirtualMachineConfiguration	A configuração da máquina virtual para o Pool. Essa propriedade deve ser especificada se o Pool precisar ser criado com VMs IaaS do Azure. Essa propriedade e cloudServiceConfiguration são mutuamente exclusivas e uma das propriedades deve ser especificada. Se nenhum dos dois for especificado, o serviço do Lote retornará um erro; se você estiver chamando a API REST diretamente, o código http status será 400 (solicitação incorreta).
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).

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.

RecentJob

Informações sobre o trabalho mais recente a ser executado na Agenda de Trabalho.

Nome	Tipo	Description
id	string	A ID do Trabalho.
url	string	A URL do Trabalho.

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.

Schedule

O agendamento de acordo com o qual os Trabalhos serão criados. Todas as horas são fixas respectivamente para UTC e não são afetadas pelo horário de verão.

Nome	Tipo	Description
doNotRunAfter	string	Um tempo após o qual nenhum trabalho será criado neste Agendamento de Trabalho. A agenda passará para o estado concluído assim que esse prazo for passado e não houver nenhum trabalho ativo nesta Agenda de Trabalho. Se você não especificar um horário doNotRunAfter e estiver criando uma Agenda de Trabalho recorrente, a Agenda de Trabalho permanecerá ativa até que você o encerre explicitamente.
doNotRunUntil	string	A hora mais antiga em que qualquer trabalho pode ser criado neste Agendamento de Trabalho. Se você não especificar um horário doNotRunUntil, o agendamento ficará pronto para criar trabalhos imediatamente.
recurrenceInterval	string	O intervalo de tempo entre os horários de início de dois trabalhos sucessivos na Agenda de Trabalho. Um Agendamento de Trabalho pode ter no máximo um trabalho ativo sob ele a qualquer momento. Como um Agendamento de Trabalho pode ter no máximo um trabalho ativo sob ele a qualquer momento, se for hora de criar um novo Trabalho em uma Agenda de Trabalho, mas o trabalho anterior ainda estiver em execução, o serviço do Lote não criará o novo Trabalho até que o trabalho anterior seja concluído. Se o trabalho anterior não for concluído dentro do período startWindow da nova recurrenceInterval, nenhum novo trabalho será agendado para esse intervalo. Para trabalhos recorrentes, normalmente você deve especificar um jobManagerTask no jobSpecification. Se você não usar jobManagerTask, precisará de um processo externo para monitorar quando trabalhos são criados, adicionar Tarefas aos Trabalhos e encerrar os Trabalhos prontos para a próxima recorrência. O padrão é que o agendamento não se repita: um trabalho é criado, dentro do startWindow após a hora doNotRunUntil e o agendamento é concluído assim que o trabalho é concluído. O valor mínimo é 1 minuto. Se você especificar um valor mais baixo, o serviço do Lote rejeitará o agendamento com um erro; se você estiver chamando a API REST diretamente, o código http status será 400 (solicitação incorreta).
startWindow	string	O intervalo de tempo, começando a partir do momento em que o agendamento indica que um Trabalho deve ser criado, no qual um trabalho deve ser criado. Se um trabalho não for criado dentro do intervalo startWindow, a 'oportunidade' será perdida; nenhum trabalho será criado até a próxima recorrência do agendamento. Se o agendamento for recorrente e o startWindow for maior que o intervalo de recorrência, isso será equivalente a um startWindow infinito, pois o trabalho 'devido' em uma recurrenceInterval não é levado adiante para o próximo intervalo de recorrência. O padrão é infinito. O valor mínimo é 1 minuto. Se você especificar um valor mais baixo, o serviço do Lote rejeitará o agendamento com um erro; se você estiver chamando a API REST diretamente, o código http status será 400 (solicitação incorreta).

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

Nome	Tipo	Description
commandLine	string	A linha de comando do StartTask. A linha de comando não é executada em um shell e, portanto, não pode aproveitar os recursos do shell, como expansão de variável de ambiente. Se 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 para o 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 task são mapeadas para o contêiner e a linha de comando Task é 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.

TaskConstraints

Restrições de execução a serem aplicadas a uma Tarefa.

Nome	Tipo	Description
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 repetições para o executável task devido a um código de saída diferente de zero. 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 após a primeira tentativa. 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).
maxWallClockTime	string	O tempo máximo decorrido que a Tarefa pode executar, medido a partir do momento em que a Tarefa é iniciada. Se a Tarefa não for concluída dentro do limite de tempo, o serviço do Lote a encerrará. Se isso não for especificado, não haverá nenhum limite de tempo para que a Tarefa possa ser executada.
retentionTime	string	O tempo mínimo para manter o diretório Task no Nó de Computação em que ele foi executado, a partir do momento em que ele conclui a execução. Após esse período, o serviço lote poderá excluir o diretório Task e todo o seu conteúdo. O padrão é 7 dias, ou seja, o diretório Tarefa será mantido por 7 dias, a menos que o Nó de Computação seja removido ou o Trabalho seja excluído.

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.

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.

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 de 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'.