Job Schedule - List

Lista todos os agendamentos de trabalho na conta especificada.

GET {batchUrl}/jobschedules?api-version=2022-01-01.15.0
GET {batchUrl}/jobschedules?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&timeout={timeout}&api-version=2022-01-01.15.0

Parâmetros de URI

Name In Required Type 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 OData $expand.

$filter
query
  • string

Uma cláusula OData $filter. 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 OData $select.

maxresults
query
  • integer
int32

O número máximo de itens a serem retornados na resposta. Um máximo de 1000 agendamentos de trabalho podem ser retornados.

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"

Name Required Type Description
client-request-id
  • string
uuid

A identidade da solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id
  • boolean

Se o servidor deve retornar a ID de solicitação do cliente 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 do relógio do sistema atual; defina-o explicitamente se você estiver chamando a API REST diretamente.

Respostas

Name Type Description
200 OK

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

O erro do serviço lote.

Segurança

azure_auth

Flow Azure Active Directory OAuth2

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

Scopes

Name Description
user_impersonation Representar sua conta de usuário

Authorization

Type: apiKey
In: header

Exemplos

JobSchedule list

Sample Request

GET account.region.batch.azure.com/jobschedules?api-version=2022-01-01.15.0


Sample Response

{
  "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

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 as características de 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.

CIFSMountConfiguration

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

CloudJobSchedule

Um Agendamento de Trabalho 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êiner.

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 usados 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 o disco efêmero Configurações para o disco do sistema operacional usado pela VM (nó de computação).

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 Galeria de Imagens Compartilhadas Image.

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 Galeria de Imagens Compartilhadas. Para obter a lista de todas as referências de imagem Azure Marketplace verificadas pelo 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 abordar portas específicas em Nós de Computação em um Pool de Lotes externamente.

IPAddressProvisioningType

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

JobConstraints

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

JobManagerTask

Especifica os detalhes de uma tarefa do Gerenciador de Trabalho.

JobNetworkConfiguration

A configuração de rede do Trabalho.

JobPreparationTask

Uma tarefa de preparação de trabalho a ser executada antes de qualquer tarefa do trabalho em qualquer nó de computação determinado.

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 um agendamento 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

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 de um pool.

NetworkSecurityGroupRule

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

NetworkSecurityGroupRuleAccess

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

NFSMountConfiguration

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

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 estiverem no estado concluído.

OnTaskFailure

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

OSDisk

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

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

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 a 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 em UTC e não são afetadas pelo horário de verão.

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

StorageAccountType

O tipo de conta de armazenamento para uso na criação de discos de dados.

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.

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

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

WindowsUserConfiguration

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

ApplicationPackageReference

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

Name Type Description
applicationId
  • string

A ID do aplicativo a ser implantado.

version
  • string

A versão do aplicativo a ser implantado. Se omitida, a versão padrão será implantada.
Se isso for omitido em um pool e nenhuma versão padrão for especificada para este aplicativo, a solicitação falhará com o código de erro InvalidApplicationPackageReferences e o código de status HTTP 409. Se isso for omitido em uma Tarefa e nenhuma versão padrão for especificada para este aplicativo, a Tarefa falhará com um erro de pré-processamento.

AuthenticationTokenSettings

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

Name Type Description
access
  • string[]

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 as características de um "pool automático" temporário. O serviço Lote criará esse pool automático quando o trabalho for enviado.

Name Type 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 diferentes finalidades, 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 a Agenda de Trabalho ou Trabalho for concluída. 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

A especificação do Pool para o pool automático.

poolLifetimeOption

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

AutoUserScope

O escopo do usuário automático

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

Name Type Description
elevationLevel

O nível de elevação do usuário automático.
O valor padrão é nonAdmin.

scope

O escopo do usuário automático
O valor padrão é pool. Se o pool estiver em execução Windows um valor de Tarefa deverá ser especificado se um isolamento mais rigoroso entre as tarefas for necessário. Por exemplo, se a tarefa alterar o registro de uma forma 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.

Name Type 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 para passar para o comando de montagem.
Essas são opções de 'uso líquido' em opções de Windows e 'montagem' no Linux.

containerName
  • string

O nome do contêiner Armazenamento de Blobs do Azure.

identityReference

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 de montagens do Lote, acessível por meio da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.

sasKey
  • string

O token SAS Armazenamento do Azure.
Essa propriedade é mutuamente exclusiva com accountKey e identidade; exatamente um deve ser especificado.

AzureFileShareConfiguration

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

Name Type Description
accountKey
  • string

A chave de conta de Armazenamento do Microsoft Azure.

accountName
  • string

O nome da conta Armazenamento do Azure.

azureFileUrl
  • string

A URL Arquivos do Azure.
Isso é do formulário 'https://{account}.file.core.windows.net/'.

mountOptions
  • string

Opções de linha de comando adicionais para passar para o comando de montagem.
Essas são opções de "uso líquido" em opções de Windows e '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 de montagem 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.

Name Type Description
code
  • string

Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.

message

Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.

values

Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

BatchErrorDetail

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

Name Type Description
key
  • string

Um identificador que especifica o significado da propriedade Value.

value
  • string

As informações adicionais incluídas com a resposta de erro.

CachingType

O tipo de cache a ser habilitado para o disco.

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

Name Type Description
storeLocation

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 Windows Nós de Computação (ou seja, criados com cloudServiceConfiguration ou com virtualMachineConfiguration usando uma referência de imagem Windows). Para nós de computação do Linux, os Certificados são armazenados em um diretório dentro do diretório de trabalho da 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 inicial do usuário (por exemplo, /home/{user-name}/certs) e 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 Windows Nós de Computação (ou seja, criados com cloudServiceConfiguration ou com virtualMachineConfiguration usando uma referência de imagem Windows). Nomes comuns de 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 é My.

thumbprint
  • string

A impressão digital do Certificado.

thumbprintAlgorithm
  • string

O algoritmo com o qual a impressão digital está associada. Deve ser sha1.

visibility
  • string[]

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.

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

CIFSMountConfiguration

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

Name Type Description
mountOptions
  • string

Opções de linha de comando adicionais para passar para o comando de montagem.
Essas são opções de "uso líquido" em opções de Windows e '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 de montagem 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 Trabalho que permite trabalhos recorrentes especificando quando executar Trabalhos e uma especificação usada para criar cada Trabalho.

Name Type Description
creationTime
  • string

A hora de criação da Agenda de Trabalho.

displayName
  • string

O nome de exibição da agenda.

eTag
  • string

A ETag da Agenda de Trabalho.
Esta é uma cadeia de caracteres opaca. Você pode usá-lo para detectar se a Agenda de Trabalho foi alterada entre 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 a agenda enquanto isso.

executionInfo

Informações sobre trabalhos que foram e serão executados nessa agenda.

id
  • string

Uma cadeia de caracteres que identifica exclusivamente o agendamento dentro da Conta.

jobSpecification

Os detalhes dos trabalhos a serem criados nessa agenda.

lastModified
  • string

A última hora modificada 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 que estão sendo criados ou trabalhos mudando de estado.

metadata

Uma lista de pares nome-valor associados ao agendamento como metadados.
O serviço do Lote não atribui nenhum significado aos metadados; ela é exclusivamente para o uso do código do usuário.

previousState

O estado anterior da Agenda de Trabalho.
Essa propriedade não estará presente se o Agendamento de Trabalho estiver em seu estado ativo inicial.

previousStateTransitionTime
  • string

A hora em que a Agenda de Trabalho inseriu seu estado anterior.
Essa propriedade não estará presente se o Agendamento de Trabalho estiver em seu estado ativo inicial.

schedule

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

state

O estado atual da Agenda de Trabalho.

stateTransitionTime
  • string

A hora em que a Agenda de Trabalho inseriu o estado atual.

stats

As estatísticas de uso de recursos de tempo de vida para a Agenda de Trabalho. As estatísticas podem não estar disponíveis imediatamente. O serviço do Lote executa um cumulativo 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.

Name Type Description
odata.nextLink
  • string

A URL para obter o próximo conjunto de resultados.

value

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.

Name Type Description
osFamily
  • string

A família do sistema operacional 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 a Windows Server 2008 R2 SP1. 3 – Família 3 do sistema operacional, equivalente a Windows Server 2012. 4 – Família do SISTEMA Operacional 4, equivalente a Windows Server 2012 R2. 5 – Família 5 do sistema operacional, equivalente a Windows Server 2016. 6 – Família do SISTEMA Operacional 6, equivalente a Windows Server 2019. Para obter mais informações, consulte as 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 so especificada.

ComputeNodeFillType

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

Name Type 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á.

Name Type 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êiner.

Name Type Description
containerImageNames
  • string[]

A coleção de nomes de imagem de 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

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

A tecnologia de contêiner a ser usada.

ContainerRegistry

Um registro de contêiner privado.

Name Type Description
identityReference

A referência à identidade atribuída pelo usuário a ser usada para acessar um Registro de Contêiner do Azure em vez de nome de usuário e senha.
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 a fazer logon no servidor do Registro.

ContainerType

A tecnologia de contêiner a ser usada.

Name Type Description
dockerCompatible
  • string

Uma tecnologia de contêiner compatível com o Docker será usada para iniciar os contêineres.

ContainerWorkingDirectory

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

Name Type 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 usados pelos discos de dados associados aos Nós de Computação no Pool. Ao usar discos de dados anexados, você precisa montar e formatar os discos de dentro de uma VM para usá-los.

Name Type Description
caching

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 deve ter um lun distinto. O valor deve estar entre 0 e 63, inclusive.

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.

Name Type Description
CacheDisk
  • string

O Disco do SO Efêmero é armazenado no cache da VM.

DiffDiskSettings

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

Name Type Description
placement

Especifica o posicionamento de disco efêmero para o disco do sistema operacional para todas as VMs no pool.
Essa propriedade pode ser usada pelo usuário na solicitação para escolher o local, por exemplo, armazenar espaço em disco em cache para provisionamento de disco do sistema operacional efêmero. Para obter mais informações sobre os requisitos de tamanho do disco do sistema operacional efêmero, consulte os requisitos de tamanho do disco do sistema operacional efêmero para Windows VMs em https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements VMs linux e 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 Galeria de Imagens Compartilhadas Image.

Name Type Description
targets
  • string[]

A lista de destinos de disco do 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 de Windows, "OsDisk" e "TemporaryDisk" devem ser especificados.

DynamicVNetAssignmentScope

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

Name Type Description
job
  • string

A atribuição de VNet dinâmica é feita por trabalho.

none
  • string

Nenhuma atribuição de VNet dinâmica está habilitada.

ElevationLevel

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

Name Type Description
admin
  • string

O usuário é um usuário com acesso elevado e opera com permissões completas de Administrador.

nonadmin
  • string

O usuário é um usuário padrão sem acesso elevado.

EnvironmentSetting

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

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

Name Type 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

Name Type 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 Galeria de Imagens Compartilhadas. Para obter a lista de todas as referências de imagem Azure Marketplace verificadas pelo Lote do Azure, consulte a operação 'Listar Imagens Com Suporte'.

Name Type 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 difere de 'version' somente se o valor especificado para 'version' quando o pool foi criado for 'latest'.

offer
  • string

O tipo de oferta do Azure Máquinas Virtuais Marketplace Image.
Por exemplo, UbuntuServer ou WindowsServer.

publisher
  • string

O editor do Azure Máquinas Virtuais Marketplace Image.
Por exemplo, Canonical ou MicrosoftWindowsServer.

sku
  • string

A SKU da imagem do Azure Máquinas Virtuais Marketplace.
Por exemplo, 18.04-LTS ou 2019-Datacenter.

version
  • string

A versão do Azure Máquinas Virtuais Marketplace Image.
Um valor "mais recente" pode ser especificado para selecionar a versão mais recente de uma Imagem. Se omitido, o padrão será 'mais recente'.

virtualMachineImageId
  • string

O identificador de recurso do ARM da imagem Galeria de Imagens Compartilhadas. 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 de imagem mais recente.
Essa propriedade é mutuamente exclusiva com outras propriedades ImageReference. A imagem de Galeria de Imagens Compartilhadas 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 de Nó de Computação em Lote para se comunicar com o serviço 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.

Name Type 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 abordar portas específicas em Nós de Computação em um Pool de Lotes externamente.

Name Type Description
backendPort
  • integer

O número da porta no Nó de Computação.
Isso deve ser exclusivo em um Pool de Lotes. Os valores aceitáveis estão entre 1 e 65535, exceto para 22, 3389, 29876 e 29877, pois são reservados. Se algum valor reservado for fornecido, a solicitação falhará com o código de status HTTP 400.

frontendPortRangeEnd
  • integer

O último número de porta no intervalo de portas externas que será usado para fornecer acesso de entrada ao back-endPort em nós de computação individuais.
Os valores aceitáveis variam entre 1 e 65534, exceto portas de 50000 a 55000 que são 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 o código de status HTTP 400.

frontendPortRangeStart
  • integer

O primeiro número de porta no intervalo de portas externas que serão usadas para fornecer acesso de entrada ao back-endPort em nós de computação individuais.
Os valores aceitáveis variam entre 1 e 65534, exceto portas de 50000 a 55000 que são reservadas. Todos os intervalos dentro de um pool devem ser distintos e não podem se sobrepor. Cada intervalo deve conter pelo menos 40 portas. Se quaisquer valores reservados ou sobrepostos forem fornecidos, a solicitação falhará com o código de status HTTP 400.

name
  • string

O nome do ponto de extremidade.
O nome deve ser exclusivo em um Pool de Lotes, pode conter letras, números, sublinhados, períodos e hífens. Os nomes devem começar com uma letra ou número, devem terminar com uma letra, número ou sublinhado e não podem exceder 77 caracteres. Se algum valor inválido for fornecido, a solicitação falhará com o código de status HTTP 400.

networkSecurityGroupRules

Uma lista de regras de grupo de segurança de rede que serão aplicadas ao ponto de extremidade.
O número máximo de regras que podem ser especificadas em todos os pontos de extremidade em um Pool de Lotes é 25. Se nenhuma regra de grupo de segurança de rede for especificada, uma regra padrão será criada para permitir o acesso de entrada ao back-endPort especificado. Se o número máximo de regras de grupo de segurança de rede for excedido, a solicitação falhará com o código de status HTTP 400.

protocol

O protocolo do ponto de extremidade.

IPAddressProvisioningType

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

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

Name Type Description
maxTaskRetryCount
  • integer

O número máximo de vezes que cada Tarefa pode ser repetida. O serviço Lote tentará novamente uma Tarefa se o código de saída não for zero.
Observe que esse valor controla especificamente o número de 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ção for 3, o Lote tentará uma Tarefa até 4 vezes (uma tentativa inicial e três tentativas). Se a contagem máxima de repetição for 0, o serviço lote não repetirá Tarefas. Se a contagem máxima de repetição 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 repetições)

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 quaisquer Tarefas que ainda estejam em execução. Nesse caso, o motivo da terminação será MaxWallClockTimeExpiry. Se essa propriedade não for especificada, não haverá um limite de tempo em quanto tempo o Trabalho pode ser executado.

JobManagerTask

Especifica os detalhes de uma tarefa do Gerenciador de Trabalho.

Name Type 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

Uma lista de Pacotes de Aplicativos que o serviço 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 da 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

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 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 realizar usando o token dependem das configurações. Por exemplo, uma Tarefa pode solicitar permissões de trabalho para adicionar outras Tarefas ao Trabalho ou verificar o status do Trabalho ou de outras Tarefas no Trabalho.

commandLine
  • string

A linha de comando da Tarefa Gerenciador de Trabalho.
A linha de comando não é executada em um shell e, portanto, não pode aproveitar os recursos do shell, como a expansão da variável de ambiente. Se você quiser aproveitar esses recursos, invoque o shell na linha de comando, por exemplo, usando "cmd /c MyCommand" em 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 da 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

Restrições que se aplicam à Tarefa Gerenciador de Trabalhos.

containerSettings

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 de tarefa são mapeadas para o contêiner e a linha de comando Tarefa é executada no contêiner. Os arquivos produzidos no contêiner fora do AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos no disco host, o que significa que as APIs de arquivo do Lote não poderão acessar esses arquivos.

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

Uma lista de configurações de variáveis de ambiente para a Tarefa Gerenciador de Trabalhos.

id
  • string

Uma cadeia de caracteres que identifica exclusivamente a Tarefa Gerenciador de Trabalhos 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.

killJobOnCompletion
  • boolean

Se a conclusão da Tarefa do Gerenciador de Trabalho significa a conclusão de todo o Trabalho.
Se for true, quando a Tarefa Gerenciador de Trabalho for concluída, o serviço do Lote marcará o Trabalho como concluído. Se alguma tarefa ainda estiver em execução no momento (além da Versão do Trabalho), essas tarefas serão encerradas. Se for falso, a conclusão da Tarefa gerenciador de trabalhos não afetará o status do 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 nenhuma função adicional 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 usando 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

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

Uma lista de arquivos que o serviço do Lote baixará no 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 recursos. Quando o tamanho máximo for excedido, a solicitação falhará e o código de erro de resposta será RequestEntityTooLarge. Se isso ocorrer, a coleção de ResourceFiles deverá ser reduzida em tamanho. Isso pode ser obtido usando .zip arquivos, pacotes de aplicativos ou contêineres do Docker.

runExclusive
  • boolean

Se a Tarefa Gerenciador de Trabalho requer o uso exclusivo do Nó de Computação em que ela é executada.
Se for verdadeiro, nenhuma outra Tarefa será executada no mesmo nó enquanto o Gerenciador de Trabalho estiver em execução. Se for falso, outras tarefas poderão ser executadas simultaneamente com o Gerenciador de Trabalho em um Nó de Computação. A Tarefa Gerenciador de Trabalhos conta normalmente em relação ao limite de tarefa simultânea 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

A identidade do usuário sob a qual a Tarefa Gerenciador de Trabalho é executada.
Se omitida, a Tarefa será executada como um usuário não administrativo exclusivo para a Tarefa.

JobNetworkConfiguration

A configuração de rede do Trabalho.

Name Type Description
subnetId
  • string

O identificador de recurso do ARM da sub-rede de rede virtual que 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 de 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 Role-Based Controle de Acesso de máquina virtual clássica) 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) associados. Se a comunicação com os Nós na sub-rede especificada for negada por um NSG, o serviço lote definirá o estado dos Nós de Computação como inutilizáveis. Isso é do formulário /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 é necessária para estar aberta para conexões de saída para comunicações com o Azure Armazenamento. 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 determinado.

Name Type Description
commandLine
  • string

A linha de comando da Tarefa preparação do trabalho.
A linha de comando não é executada em um shell e, portanto, não pode tirar proveito de recursos de 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" em 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 da 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

Restrições que se aplicam à Tarefa preparação do trabalho.

containerSettings

As configurações do contêiner no qual a Tarefa preparação do 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 de tarefa são mapeadas para o contêiner e a linha de comando Tarefa é executada no contêiner. Os arquivos produzidos no contêiner fora do AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos no disco host, o que significa que as APIs de arquivo do Lote não poderão acessar esses arquivos.

environmentSettings

Uma lista de configurações de variáveis de ambiente para a Tarefa 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 de Trabalho após uma reinicialização de nó de computação.
A Tarefa preparação do trabalho sempre será executada novamente se um nó de computação for reimagem ou se a Tarefa preparação do trabalho não tiver sido concluída (por exemplo, porque a reinicialização ocorreu durante a execução da Tarefa). Portanto, você deve sempre 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

Uma lista de arquivos que o serviço do Lote baixará no 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 recursos. Quando o tamanho máximo for excedido, a solicitação falhará e o código de erro de resposta será RequestEntityTooLarge. Se isso ocorrer, a coleção de ResourceFiles deverá ser reduzida em tamanho. Isso pode ser obtido usando .zip arquivos, pacotes de aplicativos ou contêineres do Docker.

userIdentity

A identidade do usuário sob a qual a Tarefa preparação do trabalho é executada.
Se omitida, a Tarefa será executada como um usuário não administrativo exclusivo para a Tarefa em nós de computação Windows ou um usuário não administrativo exclusivo para o Pool em Nós de Computação linux.

waitForSuccess
  • boolean

Se o serviço do Lote deve aguardar a conclusão da Tarefa de Preparação do Trabalho com êxito 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 ela sair com o código de saída 0.
Se true e a Tarefa preparação do trabalho falharem em um nó, o serviço do Lote tentará novamente a Tarefa preparação do trabalho até sua contagem máxima de repetição (conforme especificado no elemento de restrições). 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 falso, 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 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.

Name Type Description
commandLine
  • string

A linha de comando da Tarefa de Liberação de Trabalho.
A linha de comando não é executada em um shell e, portanto, não pode tirar proveito de recursos de 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" em 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 da 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

As configurações do 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 de tarefa são mapeadas para o contêiner e a linha de comando Tarefa é executada no contêiner. Os arquivos produzidos no contêiner fora do AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos no disco host, o que significa que as APIs de arquivo do Lote não poderão acessar esses arquivos.

environmentSettings

Uma lista de configurações de variáveis 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 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 '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 Liberação de 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 o encerrará. O valor padrão é 15 minutos. Talvez você não especifique um tempo limite de mais de 15 minutos. Se você fizer isso, o serviço do 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

Uma lista de arquivos que o serviço do Lote baixará no Nó de Computação antes de executar a linha de comando. Há um tamanho máximo para a lista de arquivos de recursos. Quando o tamanho máximo for excedido, a solicitação falhará e o código de erro de resposta será RequestEntityTooLarge. Se isso ocorrer, a coleção de ResourceFiles deverá ser reduzida em tamanho. Isso pode ser obtido usando .zip arquivos, 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 tempo, o serviço do Lote poderá excluir o diretório da Tarefa 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

A identidade do usuário sob a qual a Tarefa de Liberação de Trabalho é executada.
Se omitida, a Tarefa será executada como um usuário não administrativo exclusivo para a Tarefa.

JobScheduleExecutionInformation

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

Name Type Description
endTime
  • string

A hora em que a agenda terminou.
Essa propriedade será definida somente se o Agendamento de Trabalho estiver no estado concluído.

nextRunTime
  • string

A 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 a hora chegar. Por exemplo, se o agendamento estiver desabilitado, nenhum trabalho será criado no nextRunTime, a menos que o trabalho esteja habilitado antes disso.

recentJob

Informações sobre o trabalho mais recente na Agenda de Trabalho.
Essa propriedade só estará presente se pelo menos um trabalho tiver sido executado na agenda.

JobScheduleState

O estado da Agenda de Trabalho.

Name Type Description
active
  • string

O Agendamento de Trabalho está ativo 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á novos trabalhos para este Agendamento de Trabalho e excluirá quaisquer trabalhos e tarefas existentes na Agenda de Trabalho, incluindo qualquer trabalho ativo. O Agendamento de Trabalho será excluído quando todos os Trabalhos e Tarefas sob a Agenda de Trabalho tiverem sido excluídos.

disabled
  • string

O usuário desabilitou a Agenda de Trabalho. O agendador não iniciará nenhum novo trabalho neste cronograma, mas qualquer trabalho ativo existente continuará a ser executado.

terminating
  • string

A Agenda de Trabalho não tem mais trabalho a ser feito ou foi explicitamente encerrada pelo usuário, mas a operação de encerramento ainda está em andamento. O agendador não iniciará novos trabalhos para este Agendamento de Trabalho, nem nenhum trabalho existente está ativo.

JobScheduleStatistics

Estatísticas de uso de recursos para um agendamento de trabalho.

Name Type Description
kernelCPUTime
  • string

O tempo total de CPU do modo kernel (resumido em todos os núcleos e todos os Nós de Computação) consumidos 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 na agenda. Uma Tarefa falhará se esgotar sua contagem máxima de repetição 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 na agenda. 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 determinado 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 (resumido em todos os núcleos e todos os Nós de Computação) consumidos por todas as tarefas em todos os trabalhos criados na agenda.

waitTime
  • string

O tempo total de espera de todas as tarefas em todos os trabalhos criados na agenda. 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; 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 é a hora decorrido de quando a Tarefa começou a ser executada em um Nó de Computação até quando terminou (ou até a última vez em que as estatísticas foram atualizadas, se a Tarefa não tivesse sido concluída até então). Se uma Tarefa foi repetida, isso inclui a hora do relógio de parede de todas as tentativas da 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 em disco feitas por todas as Tarefas em todos os trabalhos criados na agenda.

JobSpecification

Especifica detalhes dos trabalhos a serem criados em um agendamento.

Name Type Default Value Description
allowTaskPreemption
  • boolean

Se as tarefas neste trabalho podem ser preempidas 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

Uma lista de configurações de variáveis de ambiente comuns. Essas variáveis de ambiente são definidas para todas as Tarefas em Trabalhos criadas nessa agenda (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

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

Os detalhes de uma Tarefa do Gerenciador de Trabalho 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

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

A Tarefa de Liberação de Trabalho para Trabalhos criada nessa agenda.
A principal finalidade da Tarefa de Liberação de Trabalho é desfazer alterações em nós feitas pela Tarefa preparação do trabalho. As atividades de exemplo incluem excluir arquivos locais ou desligar 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 ao mesmo tempo. Você pode atualizar maxParallelTasks de um trabalho depois de ele ter sido criado usando a API de trabalho de atualização.

metadata

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

A configuração de rede do Trabalho.

onAllTasksComplete

A ação que o serviço lote deve executar quando todas as tarefas em um trabalho criado sob esse agendamento estiverem 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 a serem definidas emAllTasksComplete para encerrar o trabalho depois de terminar de adicionar Tarefas. O padrão é noaction.

onTaskFailure

A ação que o serviço do Lote deve executar quando qualquer Tarefa falhar em um trabalho criado nessa agenda. Considera-se que uma tarefa falhou se tiver falhado se houver uma falhaInfo. Um failureInfo será definido se a Tarefa for concluída com um código de saída não zero depois de esgotar sua contagem de repetição ou se houve um erro ao iniciar a Tarefa, por exemplo, devido a um erro de download de arquivo de recurso.
O padrão é noaction.

poolInfo

O pool no qual o serviço Lote executa as Tarefas de Trabalhos criadas nesse agendamento.

priority
  • integer

A prioridade dos trabalhos criados nessa agenda.
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 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 o uso da 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.

Name Type 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 falsa). 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á a uid.

LoginMode

O modo de logon do usuário

Name Type Description
batch
  • string

O modo de logon LOGON32_LOGON_BATCH Win32. O modo de logon em lote é recomendado para processos paralelos de execução longa.

interactive
  • string

O modo de logon LOGON32_LOGON_INTERACTIVE Win32. O UAC está habilitado em pools Windows VirtualMachineConfiguration. Se essa opção for usada com uma identidade de usuário elevada em um pool de Windows VirtualMachineConfiguration, a sessão do usuário não será elevada, a menos que o aplicativo executado pela linha de comando da Tarefa esteja configurado para sempre exigir privilégio administrativo ou sempre exigir privilégio máximo.

MetadataItem

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

Name Type Description
name
  • string

O nome do item de metadados.

value
  • string

O valor do item de metadados.

MountConfiguration

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

Name Type Description
azureBlobFileSystemConfiguration

O Contêiner Armazenamento do Azure a ser montado usando o FUSE do blob em cada nó.
Essa propriedade é mutuamente exclusiva com todas as outras propriedades.

azureFileShareConfiguration

O Compartilhamento de Arquivos do Azure a ser montado em cada nó.
Essa propriedade é mutuamente exclusiva com todas as outras propriedades.

cifsMountConfiguration

O sistema de arquivos CIFS/SMB a ser montado em cada nó.
Essa propriedade é mutuamente exclusiva com todas as outras propriedades.

nfsMountConfiguration

O sistema de arquivos NFS a ser montado em cada nó.
Essa propriedade é mutuamente exclusiva com todas as outras propriedades.

NetworkConfiguration

A configuração de rede de um pool.

Name Type Description
dynamicVNetAssignmentScope

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

endpointConfiguration

A configuração para pontos de extremidade em Nós de Computação no Pool de Lotes.
A configuração do ponto de extremidade do pool só tem suporte em Pools com a propriedade virtualMachineConfiguration.

publicIPAddressConfiguration

A configuração de IPAddress público para nós de computação no Pool de Lotes.
A propriedade de configuração de IP público só tem suporte em Pools com a propriedade virtualMachineConfiguration.

subnetId
  • string

O identificador de recurso arm da sub-rede de rede virtual à qual os Nós de Computação do Pool ingressarão. Isso é do formulário /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.
A rede virtual deve estar na mesma região e assinatura que a conta Lote do Azure. A sub-rede especificada deve ter endereços IP gratuitos suficientes para acomodar o número de nós de computação no pool. Se a sub-rede não tiver endereços IP gratuitos suficientes, o Pool alocará parcialmente nós e ocorrerá um erro de redimensionamento. A entidade de serviço 'MicrosoftAzureBatch' deve ter a função RBAC (Colaborador de Máquina Virtual Clássica Role-Based Controle de Acesso' para a VNet especificada. A sub-rede especificada deve permitir que a comunicação do serviço Lote do Azure possa agendar tarefas nos nós. Isso pode ser verificado verificando se a VNet especificada tem algum NSG (Grupos de Segurança de Rede) associados. Se a comunicação com os Nós na sub-rede especificada for negada por um NSG, o serviço do 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 Azure Armazenamento na porta 443. Para obter mais detalhes, consulte: 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.

Name Type Description
access

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

priority
  • integer

A prioridade para essa regra.
As prioridades em um pool devem ser exclusivas e são avaliadas em ordem de prioridade. Quanto menor o número, maior a prioridade. Por exemplo, as regras podem ser especificadas com números de pedidos de 150, 250 e 350. A regra com o número de ordem de 150 tem precedência sobre a regra que tem uma ordem de 250. As prioridades permitidas são de 150 a 4096. Se algum valor reservado ou duplicado for fornecido, a solicitação falhará com o código de status HTTP 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 o código de status HTTP 400.

sourcePortRanges
  • string[]

Os intervalos de porta de origem a serem correspondentes à regra.
Os valores válidos são '' (para todas as portas 0 a 65535), uma porta específica (ou seja, 22) ou um intervalo de portas (ou seja, 100-200). As portas devem estar no intervalo de 0 a 65535. Cada entrada nesta coleção não deve se sobrepor a nenhuma outra entrada (um intervalo ou uma porta individual). Se outros valores forem fornecidos, a solicitação falhará com o código de status HTTP 400. O valor padrão é ''.

NetworkSecurityGroupRuleAccess

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

Name Type Description
allow
  • string

Permitir o acesso.

deny
  • string

Nega o acesso.

NFSMountConfiguration

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

Name Type Description
mountOptions
  • string

Opções de linha de comando adicionais para passar para o comando de montagem.
Essas são opções de "uso líquido" em opções de Windows e '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 de montagem 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.

NodePlacementConfiguration

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

Name Type Description
policy

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

NodePlacementPolicyType

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

Name Type 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 melhor balanceamento de esforço.

OnAllTasksComplete

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

Name Type 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. O TerminateReason do trabalho está definido como 'AllTasksComplete'.

OnTaskFailure

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

Name Type 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 executada, se isso for o que a Tarefa especifica.)

OSDisk

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

Name Type Description
ephemeralOSDiskSettings

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

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.

Name Type Description
destination

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 da Tarefa. Há suporte para os seguintes curingas: * corresponde a 0 ou mais caracteres (por exemplo, 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, exceto a, b ou c). Se um nome de arquivo começar com "." ele é ignorado por padrão, mas pode ser correspondido especificando-o explicitamente (por exemplo ,.gif não corresponderá a .a.gif, mas ..gif irá). Um exemplo simples: ***.txt corresponde a qualquer arquivo que não comece em '.' e termina com .txt no diretório de trabalho da Tarefa ou em qualquer subdiretório. Se o nome de 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 em Windows, mas somente /está no Linux. As variáveis de ambiente (%var% em Windows ou $var no Linux) são expandidas antes da aplicação do padrão.

uploadOptions

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.

Name Type Description
containerUrl
  • string

A URL do contêiner dentro 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

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 diretório virtual dentro do contêiner Armazenamento do Azure.
Se filePattern se referir a um arquivo específico (ou seja, não contém curingas), 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 é pré-acrescentado a cada nome de blob) para o qual carregar os arquivos. Se omitido, os arquivos serão carregados na raiz do contêiner com um nome de blob correspondente ao nome do arquivo.

uploadHeaders

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 Azure Armazenamento. Para obter mais informações, consulte Cabeçalhos de solicitação (todos os tipos de blob).

OutputFileDestination

O destino para o qual um arquivo deve ser carregado.

Name Type Description
container

Um local no armazenamento de blobs do Azure no qual os arquivos são carregados.

OutputFileUploadCondition

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

Name Type Description
taskcompletion
  • string

Upload os arquivos após a saída do processo de tarefa, independentemente do código de saída.

taskfailure
  • string

Upload os arquivos somente depois que o processo de Tarefa for encerrado com um código de saída não zero.

tasksuccess
  • string

Upload 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 carregamento.

Name Type Description
uploadCondition

As condições sob as quais o arquivo de saída da tarefa ou o conjunto de arquivos devem ser carregados.
O padrão é a tarefa.

PoolEndpointConfiguration

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

Name Type Description
inboundNATPools

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

PoolInformation

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

Name Type Description
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 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 a pools.

Name Type 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 "trabalho" 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.

Name Type Description
applicationLicenses
  • string[]

A lista de licenças de aplicativo que o serviço 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

A lista de pacotes a serem instalados em cada Nó de Computação no Pool.
As alterações nas referências de pacote afetam todos os novos nós que ingressam no Pool, mas não afetam nós de computação que já estão no Pool até que sejam reinicializados ou reimageados. Há no máximo 10 referências de pacote em qualquer pool fornecido.

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 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 de status HTTP 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. 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 de erro detalhadas.

certificateReferences

Uma lista de certificados a serem instalados em cada nó de computação no pool.
Para nós Windows, o serviço lote instala os Certificados no repositório e local de certificados especificados. Para nós de computação do Linux, os Certificados são armazenados em um diretório dentro do diretório de trabalho da 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 inicial do usuário (por exemplo, /home/{user-name}/certs) e certificados são colocados nesse diretório.

cloudServiceConfiguration

A configuração do serviço de nuvem para o pool.
Essa propriedade deve ser especificada se o pool precisar ser criado com VMs de 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 de status HTTP 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 for falso, pelo menos um dos targetDedicatedNodes e targetLowPriorityNodes deverá ser especificado. 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 a comunicação direta entre nós de computação.
Habilitar a comunicação entre nós limita o tamanho máximo do pool devido a restrições de implantação nos nós de computação do pool. Isso pode fazer com que o Pool não atinja o tamanho desejado. O valor padrão é false.

metadata

Uma lista de pares nome-valor associados ao Pool como metadados.
O serviço do Lote não atribui nenhum significado aos metadados; ela é exclusivamente para o uso do código do usuário.

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

A configuração de rede do Pool.
A configuração de rede de 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; 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 de status HTTP será 400 (Solicitação Incorreta).

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 tentará novamente tarefas quando uma operação de recuperação for disparada em um nó. Exemplos de operações de recuperação incluem (mas não estão limitados a) quando um nó não íntegro é reinicializado ou um Nó de Computação desapareceu devido a uma falha no host. As novas tentativas devido às operações de recuperação são independentes e não são contadas em relação ao maxTaskRetryCount. Mesmo que o maxTaskRetryCount seja 0, poderá ocorrer uma nova tentativa interna devido a uma operação de recuperação. Por isso, todas as tarefas devem ser idempotentes. Isso significa que as tarefas precisam tolerar a interrupção e a reinicialização sem causar corrupção ou duplicar dados. A melhor prática para tarefas de execução longa é usar alguma forma de ponto de verificação. Em alguns casos, o StartTask pode ser executado novamente, embora o Nó de Computação não tenha sido reinicializado. Cuidados especiais devem ser tomados para evitar StartTasks que criam o processo de separação ou instalação/inicialização de serviços do diretório de trabalho StartTask, pois isso impedirá que o Lote seja capaz de executar novamente o StartTask.

targetDedicatedNodes
  • integer

O número desejado de nós de computação dedicados no pool.
Essa propriedade não deve ser especificada se enableAutoScale estiver definido como true. Se enableAutoScale for definido como false, você deverá definir targetDedicatedNodes, targetLowPriorityNodes ou ambos.

targetLowPriorityNodes
  • integer

O número desejado de nós de computação spot/de baixa prioridade no pool.
Essa propriedade não deve ser especificada se enableAutoScale estiver definido como true. Se enableAutoScale for definido como false, você deverá definir targetDedicatedNodes, targetLowPriorityNodes ou ambos.

taskSchedulingPolicy

Como as tarefas são distribuídas entre nós de computação em um pool.
Se não for especificado, o padrão será distribuído.

taskSlotsPerNode
  • integer

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

A lista de contas de usuário a serem criadas em cada Nó de Computação no Pool.

virtualMachineConfiguration

A configuração da máquina virtual para o Pool.
Essa propriedade deve ser especificada 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 de status HTTP 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.

Name Type 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 formulário: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

provision

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.

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

Name Type 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 Azure Armazenamento. 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 a arquivos que estão sendo baixados para Nós de Computação do Linux. Ele será ignorado se for especificado para um resourceFile que será baixado para um nó de computação Windows. Se essa propriedade não for especificada para um Nó de Computação 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á retida na íntegra e acrescentada ao diretório filePath especificado. O caminho relativo especificado não pode sair do diretório de trabalho da Tarefa (por exemplo, usando '..').

httpUrl
  • string

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

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 dentro de 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 o acesso público.

Schedule

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

Name Type 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 neste Agendamento de Trabalho.
Se você não especificar uma hora doNotRunAfter e estiver criando uma agenda de trabalho recorrente, o Agendamento de Trabalho permanecerá ativo 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 uma hora doNotRunUntil, a agenda ficará pronta 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 um agendamento 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 recorrênciaInterval, 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 os trabalhos forem 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 do DoNotRunUntil e a agenda é concluída assim que esse trabalho é concluído. O valor mínimo é 1 minuto. Se você especificar um valor menor, o serviço do Lote rejeitará a agenda com um erro; se você estiver chamando a API REST diretamente, o código de status HTTP 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 da agenda. 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 que é 'devido' em uma recorrênciaInterval 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 menor, o serviço do Lote rejeitará a agenda com um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação Incorreta).

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

Name Type Description
commandLine
  • string

A linha de comando do StartTask.
A linha de comando não é executada em um shell e, portanto, não pode tirar proveito de recursos de 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" em 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 da 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

As configurações do contêiner no qual o StartTask é executado.
Quando isso é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz de Lote do Azure diretórios no nó) são mapeados para o contêiner, todas as variáveis de ambiente de tarefa são mapeadas para o contêiner e a linha de comando Tarefa é executada no contêiner. Os arquivos produzidos no contêiner fora do AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos no disco host, o que significa que as APIs de arquivo do Lote não poderão acessar esses arquivos.

environmentSettings

Uma lista de configurações de variáveis de ambiente para o StartTask.

maxTaskRetryCount
  • integer

O número máximo de vezes que a Tarefa pode ser tentada novamente.
O serviço do Lote tentará novamente uma Tarefa se o código de saída não for zero. Observe que esse valor controla especificamente o número de tentativas. O serviço do Lote tentará a Tarefa uma vez e poderá tentar novamente até esse limite. Por exemplo, se a contagem máxima de repetição for 3, o Lote tentará a Tarefa até 4 vezes (uma tentativa inicial e três novas tentativas). Se a contagem máxima de repetição for 0, o serviço do Lote não tentará novamente a Tarefa. Se a contagem máxima de repetição for -1, o serviço do Lote 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

Uma lista de arquivos que o serviço do Lote baixará no Nó de Computação antes de executar a linha de comando. Há um tamanho máximo para a lista de arquivos de recursos. Quando o tamanho máximo for excedido, a solicitação falhará e o código de erro de resposta será RequestEntityTooLarge. Se isso ocorrer, a coleção de ResourceFiles deverá ser reduzida em tamanho. Isso pode ser obtido usando .zip arquivos, pacotes de aplicativos ou contêineres do Docker.
Os arquivos listados sob esse elemento estão localizados no diretório de trabalho da Tarefa.

userIdentity

A identidade do usuário sob a qual o StartTask é executado.
Se omitida, a Tarefa será executada como um usuário não administrativo exclusivo para a Tarefa.

waitForSuccess
  • boolean

Se o serviço do Lote deve aguardar a conclusão do StartTask com êxito (ou seja, sair com o código de saída 0) antes de agendar as Tarefas no Nó de Computação.
Se true e o StartTask falharem em um nó, o serviço do Lote tentará novamente o StartTask até sua contagem máxima de repetição (maxTaskRetryCount). Se a Tarefa ainda não tiver sido concluída com êxito após todas as novas tentativas, o serviço do Lote marcará o nó inutilizável e não agendará Tarefas para ela. Essa condição pode ser detectada por meio do estado do Nó de Computação e dos detalhes de informações de falha. Se for falso, o serviço do Lote não aguardará a conclusão do StartTask. Nesse caso, outras tarefas podem começar a ser executadas no Nó de Computação enquanto o StartTask ainda estiver em execução; e mesmo que o StartTask falhe, novas tarefas continuarão a ser agendadas no Nó de Computação. O padrão é true.

StorageAccountType

O tipo de conta de armazenamento para uso na criação de discos de dados.

Name Type Description
premium_lrs
  • string

O disco de dados deve usar o armazenamento premium com redundância local.

standard_lrs
  • string

O disco de dados deve usar o armazenamento padrão com redundância local.

TaskConstraints

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

Name Type Description
maxTaskRetryCount
  • integer

O número máximo de vezes que a Tarefa pode ser tentada novamente. O serviço do Lote tentará novamente uma Tarefa se o código de saída não for zero.
Observe que esse valor controla especificamente o número de repetições para o executável da Tarefa devido a um código de saída não zero. O serviço do Lote tentará a Tarefa uma vez e poderá tentar novamente até esse limite. Por exemplo, se a contagem máxima de repetição for 3, o Lote tentará a Tarefa até 4 vezes (uma tentativa inicial e três novas tentativas). Se a contagem máxima de repetição for 0, o serviço do Lote não tentará novamente a Tarefa após a primeira tentativa. Se a contagem máxima de repetição 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 o encerrará.
Se isso não for especificado, não haverá um limite de tempo para que a Tarefa possa ser executada.

retentionTime
  • string

O tempo mínimo para manter o diretório tarefa no Nó de Computação em que ele foi executado, a partir do momento em que ele conclui a execução. Após esse tempo, o serviço do Lote poderá excluir o diretório da Tarefa 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.

Name Type Description
containerRunOptions
  • string

Opções adicionais para o comando de criação de contêiner.
Essas opções adicionais são fornecidas como argumentos para o comando "docker create", além 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

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

O local do diretório de trabalho da Tarefa de contêiner.
O padrão é 'taskWorkingDirectory'.

TaskSchedulingPolicy

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

Name Type Description
nodeFillType

Como as tarefas são distribuídas entre nós de computação em um pool.
Se não for especificado, o padrão será distribuído.

UserAccount

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

Name Type Description
elevationLevel

O nível de elevação da conta de usuário.
O valor padrão é nonAdmin.

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

password
  • string

A senha da conta de usuário.

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 de Windows. Se não for especificado e em um pool de 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.

Name Type Description
autoUser

O usuário automático sob o qual a Tarefa é executada.
As propriedades userName e autoUser são mutuamente exclusivas; você deve especificar um, mas não ambos.

username
  • string

O nome da identidade do usuário sob a qual a Tarefa é executada.
As propriedades userName e autoUser são mutuamente exclusivas; você deve especificar um, mas não ambos.

VirtualMachineConfiguration

A configuração para nós de computação em um pool com base na infraestrutura de Máquinas Virtuais do Azure.

Name Type Description
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 especiá-la.

dataDisks

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

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

A extensão da máquina virtual para o pool.
Se especificado, as extensões mencionadas nessa configuração serão instaladas em cada nó.

imageReference

Uma referência à imagem do 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ê tiver 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 Windows Server. Windows_Client - A licença local é para Windows Client.

nodeAgentSKUId
  • string

A SKU do agente do Nó de Computação em Lote a ser provisionada em Nós de Computação no Pool.
O agente do Nó de Computação em Lote é um programa 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 do 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 de agente de nó de computação com suporte junto com sua lista de referências de imagem verificadas, consulte a operação "Listar SKUs do agente de nó de computação com suporte".

nodePlacementConfiguration

A configuração de posicionamento do nó para o pool.
Essa configuração especificará regras sobre como os nós no pool serão alocados fisicamente.

osDisk

Configurações para o disco do sistema operacional da Máquina Virtual.

windowsConfiguration

Windows configurações do sistema operacional 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.

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

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

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

Name Type Description
enableAutomaticUpdates
  • boolean

Se as atualizações automáticas estão habilitadas na máquina virtual.
Se omitido, o valor padrão será verdadeiro.

WindowsUserConfiguration

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

Name Type Description
loginMode

O modo de logon para o usuário
O valor padrão para Pools VirtualMachineConfiguration é 'batch' e para Pools CloudServiceConfiguration é 'interativo'.