Partilhar via


Jobs - Get Job

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

GET {endpoint}/jobs/{jobId}?api-version=2025-06-01
GET {endpoint}/jobs/{jobId}?api-version=2025-06-01&timeOut={timeOut}&$select={$select}&$expand={$expand}

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
path True

string (uri)

Ponto de extremidade da conta em lote (por exemplo: https://batchaccount.eastus2.batch.azure.com).

jobId
path True

string

A identificação do trabalho.

api-version
query True

string

minLength: 1

A versão da API a utilizar para esta operação.

$expand
query

string[]

Uma cláusula $expand OData.

$select
query

string[]

Uma cláusula OData $select.

timeOut
query

integer (int32)

O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. Se o valor for superior a 30, será usado o padrão em vez disso.".

Cabeçalho do Pedido

Name Necessário Tipo Description
client-request-id

string

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

return-client-request-id

boolean

Se o servidor deve retornar o client-request-id na resposta.

ocp-date

string (date-time-rfc7231)

A hora em que o pedido foi emitido. As bibliotecas de cliente normalmente definem isso para a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

If-Modified-Since

string (date-time-rfc7231)

Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço tiver sido modificado desde o tempo especificado.

If-Unmodified-Since

string (date-time-rfc7231)

Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço não tiver sido modificado desde o tempo especificado.

If-Match

string

Um valor ETag associado à versão do recurso conhecida pelo cliente. A operação será executada somente se o ETag atual do recurso no serviço corresponder exatamente ao valor especificado pelo cliente.

If-None-Match

string

Um valor ETag associado à versão do recurso conhecida pelo cliente. A operação será executada somente se a ETag atual do recurso no serviço não corresponder ao valor especificado pelo cliente.

Respostas

Name Tipo Description
200 OK

BatchJob

O pedido foi bem-sucedido.

Cabeçalhos

  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Uma resposta de erro inesperada.

Segurança

OAuth2Auth

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

Âmbitos

Name Description
https://batch.core.windows.net//.default

Exemplos

Job get

Pedido de amostra

GET {endpoint}/jobs/jobId?api-version=2025-06-01


Resposta da amostra

{
  "id": "jobId",
  "url": "https://account.region.batch.azure.com/jobs/jobId",
  "eTag": "0x8D4100FC49F0278",
  "lastModified": "2025-11-19T00:05:27.5391608Z",
  "creationTime": "2025-11-19T00:05:25.311915Z",
  "state": "completed",
  "stateTransitionTime": "2025-11-19T00:05:27.578581Z",
  "previousState": "active",
  "previousStateTransitionTime": "2025-11-19T00:05:27.2137716Z",
  "priority": 0,
  "maxParallelTasks": -1,
  "allowTaskPreemption": false,
  "usesTaskDependencies": false,
  "constraints": {
    "maxWallClockTime": "P10675199DT2H48M5.4775807S",
    "maxTaskRetryCount": 0
  },
  "poolInfo": {
    "poolId": "poolId"
  },
  "executionInfo": {
    "startTime": "2025-11-19T00:05:25.3309105Z",
    "endTime": "2025-11-19T00:05:27.578581Z",
    "poolId": "poolId",
    "terminateReason": "UserTerminate"
  },
  "onAllTasksComplete": "noaction",
  "onTaskFailure": "noaction"
}

Definições

Name Description
AuthenticationTokenSettings

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

AutomaticOsUpgradePolicy

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

AutoUserScope

Enums AutoUserScope

AutoUserSpecification

Especifica as opções para o usuário automático que executa uma Tarefa em Lote do Azure.

AzureBlobFileSystemConfiguration

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

AzureFileShareConfiguration

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

BatchAccessScope

Enums BatchAccessScope

BatchAllTasksCompleteMode

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

BatchApplicationPackageReference

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

BatchAutoPoolSpecification

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

BatchContainerConfiguration

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

BatchDiffDiskSettings

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

BatchError

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

BatchErrorDetail

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

BatchErrorMessage

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

BatchErrorSourceCategory

BatchErrorSourceCategory enums

BatchInboundNatPool

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

BatchJob

Um trabalho em lote do Azure.

BatchJobConstraints

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

BatchJobDefaultOrder

BatchJobDefaultOrder enums

BatchJobExecutionInfo

Contém informações sobre a execução de um Trabalho no serviço Batch do Azure.

BatchJobManagerTask

Especifica os detalhes de uma Tarefa do Gerenciador de Tarefas. A Tarefa do Gestor de Tarefas é iniciada automaticamente quando a Tarefa é criada. O serviço em lote tenta agendar a tarefa do gerenciador de tarefas antes de qualquer outra tarefa no trabalho. Ao reduzir um Pool, o serviço de Lote tenta preservar os Nós onde as Tarefas do Gerenciador de Tarefas estão sendo executadas pelo maior tempo possível (ou seja, os Nós de Computação que executam Tarefas 'normais' são removidos antes que os Nós de Computação executem as Tarefas do Gerenciador de Tarefas). Quando uma tarefa do Job Manager falha e precisa ser reiniciada, o sistema tenta programá-la com a prioridade mais alta. Se não houver nós de computação ociosos disponíveis, o sistema poderá encerrar uma das Tarefas em execução no Pool e devolvê-la à fila para abrir espaço para a reinicialização da Tarefa do Gerenciador de Tarefas. Observe que uma Tarefa do Gerenciador de Tarefas em um Trabalho não tem prioridade sobre as Tarefas em outros Trabalhos. Em todos os empregos, apenas as prioridades de nível de trabalho são observadas. Por exemplo, se um Gerente de Tarefas em um Trabalho de prioridade 0 precisar ser reiniciado, ele não substituirá Tarefas de um Trabalho de prioridade 1. O lote tentará novamente Tarefas quando uma operação de recuperação for acionada 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 desaparece devido a falha do host. As novas tentativas devido a operações de recuperação são independentes e não são contabilizadas em relação ao maxTaskRetryCount. Mesmo se maxTaskRetryCount for 0, pode 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 ser interrompidas e reiniciadas sem causar corrupção ou dados duplicados. A prática recomendada para tarefas de longa duração é usar alguma forma de ponto de verificação.

BatchJobNetworkConfiguration

(Esta propriedade não está disponível por padrão. Entre em contato com o suporte para obter mais informações) A configuração de rede para o trabalho.

BatchJobPreparationTask

Uma Tarefa de Preparação de Trabalho a ser executada antes de qualquer Tarefa do Trabalho em qualquer Nó de Computação. Você pode usar a Preparação do Trabalho para preparar um Nó para executar Tarefas para o Trabalho. As atividades normalmente realizadas na Preparação para o Trabalho incluem: Download de arquivos de recursos comuns usados por todas as Tarefas no Trabalho. A Tarefa de Preparação de Trabalho pode baixar esses arquivos de recursos comuns para o local compartilhado no nó. (AZ_BATCH_NODE_ROOT_DIR\shared) ou iniciar um serviço local no Nó para que todas as Tarefas desse Trabalho possam se comunicar com ele. Se a Tarefa de Preparação de Trabalho falhar (ou seja, esgotar sua contagem de tentativas antes de sair com o código de saída 0), o Lote não executará Tarefas deste Trabalho no Nó. O Nó de Computação permanece inelegível para executar Tarefas deste Trabalho até que seja recriado. O nó de computação permanece ativo e pode ser usado para outros trabalhos. A Tarefa de Preparação de Trabalho pode ser executada várias vezes no mesmo Nó. Portanto, você deve escrever a Tarefa de Preparação de Trabalho para lidar com a reexecução. Se o Nó for reinicializado, a Tarefa de Preparação de Trabalho será executada novamente no Nó de Computação antes de agendar qualquer outra Tarefa do Trabalho, se rerunOnNodeRebootAfterSuccess for true ou se a Tarefa de Preparação de Trabalho não tiver sido concluída anteriormente. Se o Nó for recriado, a Tarefa de Preparação do Trabalho será executada novamente antes de agendar qualquer Tarefa do Trabalho. O lote tentará novamente Tarefas quando uma operação de recuperação for acionada 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 desaparece devido a falha do host. As novas tentativas devido a operações de recuperação são independentes e não são contabilizadas em relação ao maxTaskRetryCount. Mesmo se maxTaskRetryCount for 0, pode 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 ser interrompidas e reiniciadas sem causar corrupção ou dados duplicados. A prática recomendada para tarefas de longa duração é usar alguma forma de ponto de verificação.

BatchJobReleaseTask

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 tenha sido executado. A Tarefa de Liberação de Trabalho é executada quando o Trabalho termina, devido a um dos seguintes motivos: O usuário chama a API Encerrar Trabalho ou a API Excluir Trabalho enquanto o Trabalho ainda está ativo, a restrição máxima de tempo de relógio de parede do Trabalho é atingida e o Trabalho ainda está ativo, ou a Tarefa do Gerenciador de Trabalho é concluída e o Trabalho é configurado para ser encerrado quando o Gerenciador de Trabalho é concluído. A Tarefa de Liberação de Trabalho é executada em cada Nó em que as Tarefas do Trabalho foram executadas e a Tarefa de Preparação de Trabalho executada e concluída. Se você recriar a imagem de um Nó depois que ele tiver executado a Tarefa de Preparação de Trabalho e o Trabalho terminar sem que outras Tarefas do Trabalho sejam executadas nesse Nó (e, portanto, a Tarefa de Preparação de Trabalho não será executada novamente), a Tarefa de Liberação de Trabalho não será executada nesse Nó de Computação. Se um Nó for reinicializado enquanto a Tarefa de Liberação de Trabalho ainda estiver em execução, a Tarefa de Liberação de Trabalho será executada novamente quando o Nó de Computação for iniciado. O Trabalho não é marcado como concluído até que todas as Tarefas de Liberação de Trabalho tenham sido concluídas. A Tarefa de Liberação de Trabalho é executada em segundo plano. Não ocupa uma faixa horária; ou seja, ele não conta para o limite taskSlotsPerNode especificado no Pool.

BatchJobSchedulingError

Um erro encontrado pelo serviço de lote ao agendar um trabalho.

BatchJobState

Enums do BatchJobState

BatchJobStatistics

Estatísticas de uso de recursos para um trabalho.

BatchMetadataItem

O serviço Batch não atribui qualquer significado a estes metadados; é exclusivamente para o uso do código de usuário.

BatchNodeFillType

Enums BatchNodeFillType

BatchNodeIdentityReference

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

BatchNodePlacementConfiguration

Para posicionamento regional, os nós no pool serão alocados na mesma região. Para o posicionamento zonal, os nós no pool serão distribuídos por diferentes zonas com o melhor balanceamento de esforço.

BatchNodePlacementPolicyType

Enums BatchNodePlacementPolicyType

BatchOsDisk

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

BatchPoolEndpointConfiguration

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

BatchPoolIdentityReference

A referência de uma das identidades do pool para criptografar o disco. Essa identidade será usada para acessar o cofre de chaves.

BatchPoolInfo

Especifica como um Trabalho deve ser atribuído a um Pool.

BatchPoolLifetimeOption

Enums de BatchPoolLifetimeOption

BatchPoolSpecification

Especificação para a criação de um novo Pool.

BatchPublicIpAddressConfiguration

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

BatchStartTask

O lote tentará novamente Tarefas quando uma operação de recuperação for acionada 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 desaparece devido a falha do host. As novas tentativas devido a operações de recuperação são independentes e não são contabilizadas em relação ao maxTaskRetryCount. Mesmo se maxTaskRetryCount for 0, pode 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 ser interrompidas e reiniciadas sem causar corrupção ou dados duplicados. A prática recomendada para tarefas de longa duração é usar alguma forma de ponto de verificação. Em alguns casos, o StartTask pode ser executado novamente mesmo que o nó de computação não tenha sido reinicializado. Cuidado especial deve ser tomado para evitar StartTasks que criam processos separatistas ou instalam/iniciam serviços a partir do diretório de trabalho StartTask, pois isso impedirá que o Batch possa executar novamente o StartTask.

BatchTaskConstraints

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

BatchTaskContainerSettings

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

BatchTaskFailureMode

Enums TaskFailure

BatchTaskSchedulingPolicy

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

BatchUefiSettings

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

BatchVmDiskSecurityProfile

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

BatchVmImageReference

Uma referência a uma Imagem do Azure Virtual Machines Marketplace ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de Imagem do Azure Marketplace verificadas pelo Azure Batch, consulte a operação ' Listar Imagens Suportadas '.

CachingType

Enums CachingType

CifsMountConfiguration

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

ContainerHostBatchBindMountEntry

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

ContainerHostDataPath

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

ContainerRegistryReference

Um registro de contêiner privado.

ContainerType

Enums ContainerType

ContainerWorkingDirectory

ContainerWorkingDirectory enums

DataDisk

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

DiffDiskPlacement

Especifica a colocação efémera do disco do sistema operativo para todos os nós de computação (VMs) do pool. Essa propriedade pode ser usada pelo usuário na solicitação para escolher em qual local o sistema operacional deve estar. por exemplo, espaço em disco de cache para provisionamento de disco do sistema operacional efêmero. Para 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 Efemérico para VMs Windows em https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e VMs Linux em https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

DiskCustomerManagedKey

A referência de chave gerenciada pelo cliente para criptografar o disco.

DiskEncryptionConfiguration

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

DiskEncryptionSetParameters

A ID do recurso ARM do conjunto de criptografia de disco.

DiskEncryptionTarget

Enums DiskEncryptionTarget

DynamicVNetAssignmentScope

DynamicVNetAssignmentScope enums

ElevationLevel

Enums ElevationLevel

EnvironmentSetting

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

HostEndpointSettings

Especifica configurações específicas do ponto de extremidade do host.

HostEndpointSettingsModeTypes

HostEndpointSettingsModeTypes enums

InboundEndpointProtocol

InboundEndpointProtocol enums

IpAddressProvisioningType

IPAddressProvisioningType enums

IPFamily

As famílias IP usadas para especificar as versões IP disponíveis para o pool.

IPTag

Contém a marca IP associada ao endereço IP público.

LinuxUserConfiguration

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

LoginMode

LoginMode enums

ManagedDisk

Os parâmetros do disco gerenciado.

MountConfiguration

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

NameValuePair

Representa um par nome-valor.

NetworkConfiguration

A configuração de rede para um Pool.

NetworkSecurityGroupRule

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

NetworkSecurityGroupRuleAccess

NetworkSecurityGroupRuleAccess enums

NfsMountConfiguration

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

OutputFile

Em cada upload de arquivo, o serviço Batch grava dois arquivos de log no nó de computação, 'fileuploadout.txt' e 'fileuploaderr.txt'. Esses arquivos de log são usados para saber mais sobre uma falha específica.

OutputFileBlobContainerDestination

Especifica um destino de carregamento de arquivo em um contêiner de armazenamento de blob do Azure.

OutputFileDestination

O destino para o qual um arquivo deve ser carregado.

OutputFileUploadCondition

OutputFileUploadCondition enums

OutputFileUploadConfig

Opções para uma operação de upload de arquivo de saída, incluindo em que condições executar o upload.

OutputFileUploadHeader

Um par nome-valor de cabeçalho HTTP

ProxyAgentSettings

Especifica as configurações do ProxyAgent ao criar a máquina virtual.

ResourceFile

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

RollingUpgradePolicy

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

SecurityEncryptionTypes

SecurityEncryptionTypes enums

SecurityProfile

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

SecurityTypes

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

ServiceArtifactReference

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

StorageAccountType

Enums StorageAccountType

UpgradeMode

Enums UpgradeMode

UpgradePolicy

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

UserAccount

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

UserIdentity

A definição da identidade do usuário sob a qual a Tarefa é executada. Especifique a propriedade userName ou autoUser, mas não ambas.

VirtualMachineConfiguration

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

VMExtension

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

WindowsConfiguration

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

WindowsUserConfiguration

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

AuthenticationTokenSettings

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

Name Tipo Description
access

BatchAccessScope[]

Os recursos do Batch a que o token concede acesso. O token de autenticação concede acesso a um conjunto limitado de operações de serviço em lote. Atualmente, o único valor suportado para a propriedade de acesso é 'job', que concede acesso a todas as operações relacionadas com o Job que contém a Tarefa.

AutomaticOsUpgradePolicy

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

Name Tipo Description
disableAutomaticRollback

boolean

Se o recurso de reversão de imagem do sistema operacional deve ser desativado.

enableAutomaticOSUpgrade

boolean

Indica se as atualizações do sistema operacional devem ser aplicadas automaticamente para dimensionar instâncias do conjunto de forma contínua quando uma versão mais recente da imagem do sistema operacional estiver disponível.

Se isso for definido como true para pools baseados no Windows, WindowsConfiguration.enableAutomaticUpdates não pode ser definido como true.

osRollingUpgradeDeferral

boolean

Adie as atualizações do sistema operacional nos TVMs se eles estiverem executando tarefas.

useRollingUpgradePolicy

boolean

Indica se a política de atualização contínua deve ser usada durante a Atualização Automática do SO. A Atualização Automática do SO retornará à política padrão se nenhuma política for definida no VMSS.

AutoUserScope

Enums AutoUserScope

Valor Description
task

Especifica que o serviço deve criar um novo utilizador para a Tarefa.

pool

Especifica que a Tarefa corre como a Conta de utilizador automática comum, criada em cada Nó de Computação de um Pool.

AutoUserSpecification

Especifica as opções para o usuário automático que executa uma Tarefa em Lote do Azure.

Name Tipo Description
elevationLevel

ElevationLevel

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

scope

AutoUserScope

O escopo para o usuário automático. O valor padrão é pool. Se o pool estiver executando o Windows, um valor de Task deverá ser especificado se for necessário um isolamento mais rigoroso entre as tarefas. Por exemplo, se a tarefa muta o registro de uma forma que pode afetar outras tarefas.

AzureBlobFileSystemConfiguration

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

Name Tipo Description
accountKey

string (password)

A chave da Conta de Armazenamento do Azure. Esta propriedade é mutuamente exclusiva com sasKey e identidade; exatamente um deve ser especificado.

accountName

string

O nome da Conta de Armazenamento do Azure.

blobfuseOptions

string

Opções de linha de comando adicionais para passar para o comando mount. Estas são opções de 'net use' no Windows e opções de 'mount' no Linux.

containerName

string

O nome do Contêiner de Armazenamento de Blob do Azure.

identityReference

BatchNodeIdentityReference

A referência à identidade atribuída pelo utilizador para aceder a ContainerName. Esta propriedade é mutuamente exclusiva com accountKey e sasKey; exatamente um deve ser especificado.

relativeMountPath

string

O caminho relativo no nó de computação onde o sistema de ficheiros será montado. Todos os sistemas de arquivos são montados em relação ao diretório Batch mounts, acessível através da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.

sasKey

string (password)

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

AzureFileShareConfiguration

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

Name Tipo Description
accountKey

string (password)

A chave da conta do Armazenamento do Azure.

accountName

string

O nome da conta de Armazenamento do Azure.

azureFileUrl

string (uri)

A URL dos Arquivos do Azure. Este é o formato 'https://{account}.file.core.windows.net/'.

mountOptions

string

Opções de linha de comando adicionais para passar para o comando mount. Estas são opções de 'net use' no Windows e opções de 'mount' no Linux.

relativeMountPath

string

O caminho relativo no nó de computação onde o sistema de ficheiros será montado. Todos os sistemas de arquivos são montados em relação ao diretório Batch mounts, acessível através da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.

BatchAccessScope

Enums BatchAccessScope

Valor Description
job

Concede acesso para realizar todas as operações no Trabalho que contém a Tarefa.

BatchAllTasksCompleteMode

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

Valor Description
noaction

Não faça nada. O cargo mantém-se ativo a menos que seja despedido ou desativado por outro meio.

terminatejob

Termina o trabalho. A Razão de Terminação do Trabalho está definida como 'TudoTarefasConcluídos'.

BatchApplicationPackageReference

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

Name Tipo Description
applicationId

string

O ID da aplicação a implementar. Ao criar um pool, a ID do aplicativo do pacote deve ser totalmente qualificada (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).

version

string

A versão do aplicativo a ser implantado. Se omitida, a versão padrão será implantada. Se isto for omitido num Pool e não for especificada uma versão padrão para esta aplicação, o pedido falha com o código de erro InvalidApplicationPackageReferences e o código de estado HTTP 409. Se isto for omitido numa Tarefa, e não for especificada uma versão padrão para esta aplicação, a Tarefa falha com um erro de pré-processamento.

BatchAutoPoolSpecification

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

Name Tipo Description
autoPoolIdPrefix

string

Um prefixo a ser adicionado ao identificador único quando um Pool é criado automaticamente. O serviço Batch atribui a cada autopool um identificador único na criação. Para distinguir entre Pools criados para diferentes fins, pode especificar este elemento para adicionar um prefixo ao ID atribuído. O prefixo pode ter até 20 caracteres.

keepAlive

boolean

Se deve manter um auto-pool vivo após o seu ciclo de vida expirar. Se for falso, o serviço Batch elimina o Pool assim que o seu tempo de vida (conforme determinado pela definição poolLifetimeOption) expira; isto é, quando o Trabalho ou Horário de Trabalho termina. Se for verdade, o serviço Batch não apaga automaticamente o Pool. Cabe ao utilizador eliminar autopools criados com esta opção.

pool

BatchPoolSpecification

A especificação do Pool para o auto Pool.

poolLifetimeOption

BatchPoolLifetimeOption

A vida útil mínima dos autopools criados e como vários Jobs num mesmo cronograma são atribuídos aos pools.

BatchContainerConfiguration

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

Name Tipo Description
containerImageNames

string[]

A coleção de nomes de imagens de contentores. Esta é a referência completa da Imagem, conforme especificado para "docker pull". Uma Imagem será obtida a partir do registo Docker padrão, a menos que a Imagem esteja totalmente qualificada com um registo alternativo.

containerRegistries

ContainerRegistryReference[]

Registos privados adicionais dos quais os contentores podem ser retirados. Se alguma Imagem tiver de ser descarregada de um registo privado que exija credenciais, então essas credenciais devem ser fornecidas aqui.

type

ContainerType

A tecnologia de contentores a utilizar.

BatchDiffDiskSettings

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

Name Tipo Description
placement

DiffDiskPlacement

Especifica o posicionamento efêmero do disco do sistema operacional para todas as VMs no pool. Essa propriedade pode ser usada pelo usuário na solicitação para escolher o local, por exemplo, espaço em disco de cache para provisionamento de disco do sistema operacional efêmero. Para obter mais informações sobre os requisitos de tamanho de disco do sistema operacional efêmero, consulte Requisitos de tamanho de disco do sistema operacional efêmero para VMs do Windows em https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e VMs do Linux em https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

BatchError

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

Name Tipo Description
code

string

Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.

message

BatchErrorMessage

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

values

BatchErrorDetail[]

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

BatchErrorDetail

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

Name Tipo Description
key

string

Um identificador que especifica o significado da propriedade Value.

value

string

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

BatchErrorMessage

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

Name Tipo Description
lang

string

O código da linguagem da mensagem de erro.

value

string

O texto da mensagem.

BatchErrorSourceCategory

BatchErrorSourceCategory enums

Valor Description
usererror

O erro deve-se a um problema do utilizador, como uma má configuração.

servererror

O erro deve-se a um problema interno no servidor.

BatchInboundNatPool

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

Name Tipo Description
backendPort

integer (int32)

O número de porta no Nó de Computação. Isto deve ser único dentro de um Batch Pool. Os valores aceitáveis situam-se entre 1 e 65535, exceto para 29876 e 29877, uma vez que estes são reservados. Se algum valor reservado for fornecido, a solicitação falhará com o código de status HTTP 400.

frontendPortRangeEnd

integer (int32)

O último número de porta no intervalo de portas externas que serão usadas para fornecer acesso de entrada ao backendPort em nós de computação individuais. Os valores aceitáveis variam entre 1 e 65534, exceto as portas de 50000 a 55000 que são reservadas pelo serviço de lote. Todos os intervalos dentro de um Pool devem ser distintos e não podem sobrepor-se. Cada gama deve conter pelo menos 40 portas. Se algum valor reservado ou sobreposto for fornecido, a solicitação falhará com o código de status HTTP 400.

frontendPortRangeStart

integer (int32)

O primeiro número de porta na gama de portas externas que serão usadas para fornecer acesso de entrada ao backendPort em nós de computação individuais. Os valores aceitáveis variam entre 1 e 65534, exceto as portas de 50000 a 55000 que são reservadas. Todos os intervalos dentro de um Pool devem ser distintos e não podem sobrepor-se. Cada gama deve conter pelo menos 40 portas. Se algum valor reservado ou sobreposto for fornecido, a solicitação falhará com o código de status HTTP 400.

name

string

O nome do ponto de extremidade. O nome deve ser único dentro de um Batch Pool, podendo conter letras, números, sublinhas, pontos e hífenes. Os nomes devem começar com uma letra ou número, devem terminar com uma letra, número ou sublinhado e não podem exceder 77 caracteres. Se algum valor inválido for fornecido, a solicitação falhará com o código de status HTTP 400.

networkSecurityGroupRules

NetworkSecurityGroupRule[]

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

protocol

InboundEndpointProtocol

O protocolo do ponto de extremidade.

BatchJob

Um trabalho em lote do Azure.

Name Tipo Default value Description
allowTaskPreemption

boolean

Se as tarefas neste trabalho podem ser antecipadas por outros trabalhos de alta prioridade. (Esta propriedade não está disponível por padrão. Entre em contato com o suporte para obter mais informações) Se o valor for definido como True, outros trabalhos de alta prioridade enviados ao sistema terão precedência e poderão enfileirar novamente as tarefas desse trabalho. Você pode atualizar allowTaskPreemption de um trabalho depois que ele tiver sido criado usando a API do trabalho de atualização.

commonEnvironmentSettings

EnvironmentSetting[]

A lista de configurações de variáveis de ambiente comuns. Essas variáveis de ambiente são definidas para todas as Tarefas no Trabalho (incluindo o Gerenciador de Tarefas, Preparação de Trabalho e Tarefas de Liberação de Trabalho). As Tarefas Individuais podem substituir uma configuração de ambiente especificada aqui, especificando o mesmo nome de configuração com um valor diferente.

constraints

BatchJobConstraints

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

creationTime

string (date-time)

O tempo de criação do Job.

displayName

string

O nome para exibição do trabalho.

eTag

string

O ETag do Trabalho. Esta é uma cadeia de caracteres opaca. Você pode usá-lo para detetar se o trabalho foi alterado entre as solicitações. Em particular, você pode passar o ETag ao atualizar um trabalho para especificar que suas alterações devem entrar em vigor somente se ninguém mais tiver modificado o trabalho entretanto.

executionInfo

BatchJobExecutionInfo

As informações de execução para o trabalho.

id

string

Uma cadeia de caracteres que identifica exclusivamente o Trabalho dentro da Conta. O ID preserva maiúsculas e minúsculas (ou seja, você não pode ter dois IDs em uma Conta que diferem apenas por maiúsculas e minúsculas).

jobManagerTask

BatchJobManagerTask

Detalhes de uma Tarefa do Gerenciador de Tarefas a ser iniciada quando a Tarefa for iniciada.

jobPreparationTask

BatchJobPreparationTask

A Tarefa de Preparação do Trabalho. A Tarefa de Preparação de Trabalho é uma Tarefa especial executada em cada Nó de Computação antes de qualquer outra Tarefa do Trabalho.

jobReleaseTask

BatchJobReleaseTask

A tarefa de liberação de trabalho. A Tarefa de Liberação de Trabalho é uma Tarefa especial executada no final do Trabalho em cada Nó de Computação que executou qualquer outra Tarefa do Trabalho.

lastModified

string (date-time)

A última hora modificada do Job. Esta é a última vez em que os dados de nível de trabalho, como o estado ou a prioridade do trabalho, foram alterados. Ele não leva em consideração as alterações no nível da tarefa, como a adição de novas Tarefas ou Tarefas alterando o estado.

maxParallelTasks

integer (int32)

-1

O número máximo de tarefas que podem ser executadas em paralelo para o trabalho. (Esta propriedade não está disponível por padrão. Entre em contato com o suporte para obter mais informações) O valor de maxParallelTasks deve ser -1 ou maior que 0, se especificado. Se não for especificado, o valor padrão será -1, o que significa que não há limite para o número de tarefas que podem ser executadas de uma só vez. Você pode atualizar maxParallelTasks de um trabalho depois que ele tiver sido criado usando a API do trabalho de atualização.

metadata

BatchMetadataItem[]

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

networkConfiguration

BatchJobNetworkConfiguration

(Esta propriedade não está disponível por padrão. Entre em contato com o suporte para obter mais informações) A configuração de rede para o trabalho.

onAllTasksComplete

BatchAllTasksCompleteMode

A ação que o serviço em lote deve executar quando todas as tarefas no trabalho estiverem no estado concluído. O padrão é noaction.

onTaskFailure

BatchTaskFailureMode

A ação que o serviço em lote deve executar quando qualquer tarefa no trabalho falhar. Uma tarefa é considerada como tendo falhado se tiver uma failureInfo. Um failureInfo é definido se a Tarefa for concluída com um código de saída diferente de zero depois de esgotar sua contagem de novas tentativas, ou se houver um erro ao iniciar a Tarefa, por exemplo, devido a um erro de download do arquivo de recurso. O padrão é noaction.

poolInfo

BatchPoolInfo

As configurações do Pool associadas ao Trabalho.

previousState

BatchJobState

O estado anterior do Jó. Esta propriedade não será definida se o Job estiver em seu estado Ativo inicial.

previousStateTransitionTime

string (date-time)

O momento em que o Job entrou em seu estado anterior. Esta propriedade não será definida se o Job estiver em seu estado Ativo inicial.

priority

integer (int32)

A prioridade do Trabalho. Os valores de prioridade podem variar de -1000 a 1000, sendo -1000 a prioridade mais baixa e 1000 a prioridade mais alta. O valor padrão é 0.

state

BatchJobState

O estado atual do Job.

stateTransitionTime

string (date-time)

O momento em que o Job entrou em seu estado atual.

stats

BatchJobStatistics

Estatísticas de uso de recursos para todo o tempo de vida do trabalho. Esta propriedade é preenchida somente se o BatchJob foi recuperado com uma cláusula de expansão incluindo o atributo 'stats'; caso contrário, é nulo. As estatísticas podem não estar imediatamente disponíveis. O serviço Batch executa o roll-up periódico de estatísticas. O atraso típico é de cerca de 30 minutos.

url

string (uri)

A URL do trabalho.

usesTaskDependencies

boolean

Se as Tarefas no Trabalho podem definir dependências entre si. O padrão é "false".

BatchJobConstraints

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

Name Tipo Description
maxTaskRetryCount

integer (int32)

O número máximo de vezes que cada Tarefa pode ser repetido. O serviço de lote tenta novamente uma tarefa se seu código de saída for diferente de zero. Observe que esse valor controla especificamente o número de tentativas. O serviço Batch tentará cada Tarefa uma vez e poderá depois tentar novamente até esse limite. Por exemplo, se o número máximo de tentativas for 3, o Batch tenta uma Tarefa até 4 vezes (uma tentativa inicial e 3 tentativas). Se o número máximo de tentativas for 0, o serviço Batch não tenta novamente Tarefas. Se o número máximo de tentativas for -1, o serviço Batch tenta Tasks sem limite. O valor padrão é 0 (sem tentativas).

maxWallClockTime

string (duration)

O tempo máximo decorrido que o Job pode executar, medido a partir do momento em que o Job é criado. Se a Tarefa não for concluída dentro do limite de tempo, o serviço Batch termina-a e termina todas as Tarefas que ainda estejam a correr. Neste caso, a razão de rescisão será MaxWallClockTimeExpiry. Se esta propriedade não for especificada, não existe limite de tempo para a duração do Trabalho.

BatchJobDefaultOrder

BatchJobDefaultOrder enums

Valor Description
none

As tarefas devem ser agendadas uniformemente a partir de todas as tarefas de igual prioridade para o pool.

creationtime

Se os trabalhos tiverem prioridade igual, as tarefas de empregos criados anteriormente devem ser agendadas primeiro.

BatchJobExecutionInfo

Contém informações sobre a execução de um Trabalho no serviço Batch do Azure.

Name Tipo Description
endTime

string (date-time)

O tempo de conclusão do Trabalho. Esta propriedade é definida apenas se o Job estiver no estado concluído.

poolId

string

O ID do Pool a que este Trabalho está atribuído. Este elemento contém o próprio Pool onde o Job é atribuído. Quando recebes detalhes do Job do serviço, eles também contêm um elemento poolInfo, que contém os dados de configuração do Pool desde que o Job foi adicionado ou atualizado. Esse elemento poolInfo pode também conter um elemento poolId. Se acontecer, os dois IDs são iguais. Se não o fizer, significa que o Job correu num autopool, e essa propriedade contém o ID desse autopool.

schedulingError

BatchJobSchedulingError

Detalhes de qualquer erro encontrado pelo serviço ao iniciar o trabalho. Esta propriedade não é definida se não houve erro ao iniciar o Job.

startTime

string (date-time)

A hora de início do trabalho. Foi nesta altura que o Emprego foi criado.

terminateReason

string

Uma sequência a descrever a razão pela qual o Trabalho terminou. Esta propriedade é definida apenas se o Job estiver no estado concluído. Se o serviço Batch terminar o Trabalho, define a razão da seguinte forma: JMComplete - a Tarefa do Gestor de Tarefas concluída, e killJobOnCompletion foi definido como true. MaxWallClockTimeExpiry - o Job atingiu a sua restrição maxWallClockTime. TermineJobSchedule - o Job foi executado como parte de um cronograma, e o cronograma terminou. AllTasksComplete - o atributo onAllTasksComplete do Job está definido para terminar-tarefa, e todas as Tarefas no Job estão concluídas. TaskFailed - o atributo onTaskFailure do Job está definido para executarOopçõesDeSaídaAçãoTrabalho, e uma Tarefa no Trabalho falhou com uma condição de saída que especificava uma JobAction de terminar-emprego. Qualquer outra cadeia é uma razão definida pelo utilizador especificada numa chamada à operação 'Terminar um Trabalho'.

BatchJobManagerTask

Especifica os detalhes de uma Tarefa do Gerenciador de Tarefas. A Tarefa do Gestor de Tarefas é iniciada automaticamente quando a Tarefa é criada. O serviço em lote tenta agendar a tarefa do gerenciador de tarefas antes de qualquer outra tarefa no trabalho. Ao reduzir um Pool, o serviço de Lote tenta preservar os Nós onde as Tarefas do Gerenciador de Tarefas estão sendo executadas pelo maior tempo possível (ou seja, os Nós de Computação que executam Tarefas 'normais' são removidos antes que os Nós de Computação executem as Tarefas do Gerenciador de Tarefas). Quando uma tarefa do Job Manager falha e precisa ser reiniciada, o sistema tenta programá-la com a prioridade mais alta. Se não houver nós de computação ociosos disponíveis, o sistema poderá encerrar uma das Tarefas em execução no Pool e devolvê-la à fila para abrir espaço para a reinicialização da Tarefa do Gerenciador de Tarefas. Observe que uma Tarefa do Gerenciador de Tarefas em um Trabalho não tem prioridade sobre as Tarefas em outros Trabalhos. Em todos os empregos, apenas as prioridades de nível de trabalho são observadas. Por exemplo, se um Gerente de Tarefas em um Trabalho de prioridade 0 precisar ser reiniciado, ele não substituirá Tarefas de um Trabalho de prioridade 1. O lote tentará novamente Tarefas quando uma operação de recuperação for acionada 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 desaparece devido a falha do host. As novas tentativas devido a operações de recuperação são independentes e não são contabilizadas em relação ao maxTaskRetryCount. Mesmo se maxTaskRetryCount for 0, pode 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 ser interrompidas e reiniciadas sem causar corrupção ou dados duplicados. A prática recomendada para tarefas de longa duração é usar alguma forma de ponto de verificação.

Name Tipo Description
allowLowPriorityNode

boolean

Se a Tarefa do Gestor de Jobs pode correr num nó de computação de Spot/Baixa Prioridade. O valor padrão é true.

applicationPackageReferences

BatchApplicationPackageReference[]

Uma lista de Pacotes de Aplicação que o serviço Batch irá implementar no Nó de Computação antes de executar a linha de comandos. Os Pacotes de Aplicação são descarregados e implementados num diretório partilhado, não no diretório de trabalho Tarefa. Portanto, se um Pacote de Aplicação referenciado já estiver no Nó de Computação e estiver atualizado, então não é descarregado novamente; a cópia existente no Nó de Computação é utilizada. Se um Pacote de Aplicação referenciado não puder ser instalado, por exemplo porque o pacote foi eliminado ou porque o download falhou, a Tarefa falha.

authenticationTokenSettings

AuthenticationTokenSettings

As configurações de um token de autenticação que a Tarefa pode usar para executar operações de serviço em lote. Se esta propriedade estiver definida, o serviço Batch fornece à Tarefa um token de autenticação que pode ser usado para autenticar operações do serviço Batch sem exigir uma chave de acesso à Conta. O token é fornecido através da variável de ambiente AZ_BATCH_AUTHENTICATION_TOKEN. As operações que a Tarefa pode realizar usando o token dependem das definições. Por exemplo, uma Tarefa pode solicitar permissões de Trabalho para adicionar outras Tarefas ao Trabalho, ou verificar o estado do Trabalho ou de outras Tarefas sob o Trabalho.

commandLine

string

A linha de comandos da Tarefa do Gestor de Trabalhos. A linha de comando não é executada sob um shell e, portanto, não pode aproveitar os recursos do shell, como a expansão da variável de ambiente. Se você quiser aproveitar esses recursos, você deve invocar o shell na linha de comando, por exemplo, usando "cmd /c MyCommand" no Windows ou "/bin/sh -c MyCommand" no Linux. Se a linha de comando se referir a caminhos de arquivo, ela deverá usar um caminho relativo (relativo ao diretório de trabalho Tarefa) ou usar a variável de ambiente Batch provided (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).

constraints

BatchTaskConstraints

Restrições que se aplicam à tarefa do Gestor de Funções.

containerSettings

BatchTaskContainerSettings

As definições do contentor sob o qual a Tarefa do Gestor de Jobs é executada. Se o Pool que irá executar esta tarefa tiver containerConfiguration definido, isto também deve ser definido. Se o Pool que irá executar esta Tarefa não tiver containerConfiguration ativado, isto não deve estar definido. Quando isto é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios Batch do Azure no nó) são mapeados para o contentor, todas as variáveis do ambiente Task são mapeadas para o contentor e a linha de comando Task é executada no contentor. Ficheiros produzidos no contentor fora de AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos para o disco anfitrião, o que significa que as APIs de ficheiros Batch não poderão aceder a esses ficheiros.

displayName

string

O nome de exibição da Tarefa do Gestor de Trabalhos. Não precisa de ser único e pode conter quaisquer caracteres Unicode até um comprimento máximo de 1024.

environmentSettings

EnvironmentSetting[]

Uma lista de definições de variáveis de ambiente para a Tarefa do Gestor de Trabalhos.

id

string

Uma cadeia que identifica de forma única a Tarefa do Gestor de Tarefas dentro do Trabalho. O ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hífenes e sublinhados, e não pode conter mais de 64 caracteres.

killJobOnCompletion

boolean

Se a conclusão da Tarefa de Gestor de Trabalho significa a conclusão de toda a Tarefa. Se for verdade, quando a Tarefa do Gestor de Trabalhos termina, o serviço Batch marca o Trabalho como concluído. Se houver Tarefas ainda a correr neste momento (exceto a Libertação de Emprego), essas Tarefas são terminadas. Se for falso, a conclusão da Tarefa do Gestor de Tarefas não afeta o estado do Trabalho. Neste caso, deve usar o atributo onAllTasksComplete para terminar o Trabalho, ou fazer com que um cliente ou utilizador termine explicitamente o Trabalho. Um exemplo disto é se o Gestor de Tarefas cria um conjunto de Tarefas, mas depois não assume mais papel na sua execução. O valor padrão é true. Se estiver a usar os atributos onAllTasksComplete e onTaskFailure para controlar a vida útil do Job, e a usar a Task do Job Manager apenas para criar as Tasks do Job (não para monitorizar o progresso), então é importante definir killJobOnCompletion como false.

outputFiles

OutputFile[]

Uma lista de ficheiros que o serviço Batch irá carregar do Nó de Computação após executar a linha de comandos. Para Tarefas de múltiplas instâncias, os ficheiros só serão carregados a partir do Nó de Computação onde a Tarefa principal é executada.

requiredSlots

integer (int32)

O número de espaços de agendamento que a Tarefa requer para executar. O padrão é 1. Uma Tarefa só pode ser agendada para correr num nó de computação se este tiver espaços de agendamento livres suficientes. Para Tarefas de múltiplas instâncias, esta propriedade não é suportada e não deve ser especificada.

resourceFiles

ResourceFile[]

Uma lista de arquivos que o serviço em lote baixará para o nó de computação antes de executar a linha de comando. Os arquivos listados sob este 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 deve ser reduzida em tamanho. Isso pode ser feito usando arquivos .zip, pacotes de aplicativos ou contêineres do Docker.

runExclusive

boolean

Se a Tarefa do Gestor de Tarefas requer uso exclusivo do Nó de Computação onde é executada. Se for verdade, nenhuma outra Tarefa irá correr no mesmo nó enquanto o Gestor de Tarefas estiver a funcionar. Se for falso, outras Tarefas podem correr simultaneamente com o Gestor de Trabalhos num Nó de Computação. A Tarefa do Gestor de Trabalhos conta normalmente contra o limite concorrente de Tarefas do Nó de Computação, pelo que isto só é relevante se o Nó de Cálculo permitir múltiplas Tarefas concorrentes. O valor padrão é true.

userIdentity

UserIdentity

A identidade do utilizador sob a qual a Tarefa do Gestor de Jobs é executada. Se omitida, a Tarefa é executada como um utilizador não administrativo único da Tarefa.

BatchJobNetworkConfiguration

(Esta propriedade não está disponível por padrão. Entre em contato com o suporte para obter mais informações) A configuração de rede para o trabalho.

Name Tipo Description
skipWithdrawFromVNet

boolean

Se os nós de computação devem ser retirados da rede virtual para o DNC quando o trabalho for encerrado ou excluído. Se verdadeiro, os nós permanecerão unidos à rede virtual para DNC. Se false, os nós serão automaticamente retirados quando o trabalho terminar. É definido para false por padrão.

subnetId

string

O identificador de recurso ARM da sub-rede de rede virtual à qual os nós de computação que executam tarefas do trabalho ingressarão durante a duração da tarefa. A rede virtual deve estar na mesma região e assinatura que a Conta em Lote do Azure. A sub-rede especificada deve ter endereços IP livres suficientes para acomodar o número de nós de computação 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 'Colaborador de Máquina Virtual Clássica' Role-Based Controle de Acesso (RBAC) para a VNet especificada para que o serviço Lote do Azure possa agendar Tarefas nos Nós. Isso pode ser verificado verificando se a rede virtual especificada tem algum NSG (Network Security Groups) associado. Se a comunicação com os nós na sub-rede especificada for negada por um NSG, o serviço em lote definirá o estado dos nós de computação como inutilizável. Este é o formato /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. Se a VNet especificada tiver quaisquer NSG (Grupos de Segurança de Rede) associados, algumas portas de sistema reservadas deverão ser habilitadas para comunicação de entrada do serviço Lote do Azure. Para pools criados com uma configuração de máquina virtual, habilite as portas 29876 e 29877, bem como a porta 22 para Linux e a porta 3389 para Windows. A porta 443 também precisa estar aberta para conexões de saída para comunicações com o Armazenamento do Azure. Para mais pormenores, consultar: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

BatchJobPreparationTask

Uma Tarefa de Preparação de Trabalho a ser executada antes de qualquer Tarefa do Trabalho em qualquer Nó de Computação. Você pode usar a Preparação do Trabalho para preparar um Nó para executar Tarefas para o Trabalho. As atividades normalmente realizadas na Preparação para o Trabalho incluem: Download de arquivos de recursos comuns usados por todas as Tarefas no Trabalho. A Tarefa de Preparação de Trabalho pode baixar esses arquivos de recursos comuns para o local compartilhado no nó. (AZ_BATCH_NODE_ROOT_DIR\shared) ou iniciar um serviço local no Nó para que todas as Tarefas desse Trabalho possam se comunicar com ele. Se a Tarefa de Preparação de Trabalho falhar (ou seja, esgotar sua contagem de tentativas antes de sair com o código de saída 0), o Lote não executará Tarefas deste Trabalho no Nó. O Nó de Computação permanece inelegível para executar Tarefas deste Trabalho até que seja recriado. O nó de computação permanece ativo e pode ser usado para outros trabalhos. A Tarefa de Preparação de Trabalho pode ser executada várias vezes no mesmo Nó. Portanto, você deve escrever a Tarefa de Preparação de Trabalho para lidar com a reexecução. Se o Nó for reinicializado, a Tarefa de Preparação de Trabalho será executada novamente no Nó de Computação antes de agendar qualquer outra Tarefa do Trabalho, se rerunOnNodeRebootAfterSuccess for true ou se a Tarefa de Preparação de Trabalho não tiver sido concluída anteriormente. Se o Nó for recriado, a Tarefa de Preparação do Trabalho será executada novamente antes de agendar qualquer Tarefa do Trabalho. O lote tentará novamente Tarefas quando uma operação de recuperação for acionada 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 desaparece devido a falha do host. As novas tentativas devido a operações de recuperação são independentes e não são contabilizadas em relação ao maxTaskRetryCount. Mesmo se maxTaskRetryCount for 0, pode 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 ser interrompidas e reiniciadas sem causar corrupção ou dados duplicados. A prática recomendada para tarefas de longa duração é usar alguma forma de ponto de verificação.

Name Tipo Description
commandLine

string

A linha de comandos da Tarefa de Preparação de Tarefas. A linha de comando não é executada sob um shell e, portanto, não pode aproveitar os recursos do shell, como a expansão da variável de ambiente. Se você quiser aproveitar esses recursos, você deve invocar o shell na linha de comando, por exemplo, usando "cmd /c MyCommand" no Windows ou "/bin/sh -c MyCommand" no Linux. Se a linha de comando se referir a caminhos de arquivo, ela deverá usar um caminho relativo (relativo ao diretório de trabalho Tarefa) ou usar a variável de ambiente Batch provided (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).

constraints

BatchTaskConstraints

Restrições que se aplicam à Tarefa de Preparação para o Emprego.

containerSettings

BatchTaskContainerSettings

As definições do contentor sob o qual a Tarefa de Preparação de Tarefas corre. Quando isto é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios Batch do Azure no nó) são mapeados para o contentor, todas as variáveis do ambiente Task são mapeadas para o contentor e a linha de comando Task é executada no contentor. Ficheiros produzidos no contentor fora de AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos para o disco anfitrião, o que significa que as APIs de ficheiros Batch não poderão aceder a esses ficheiros.

environmentSettings

EnvironmentSetting[]

Uma lista de definições de variáveis de ambiente para a Tarefa de Preparação de Trabalho.

id

string

Uma cadeia que identifica de forma única a Tarefa de Preparação do Trabalho dentro do Trabalho. O ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hífenes e sublinhados, e não pode conter mais de 64 caracteres. Se não especificar esta propriedade, o serviço Batch atribui um valor padrão de 'preparação para o trabalho'. Nenhuma outra Tarefa no Trabalho pode ter o mesmo ID que a Tarefa de Preparação do Trabalho. Se tentar submeter uma Tarefa com o mesmo id, o serviço Batch rejeita o pedido com o código de erro TaskIdSameAsJobPreparationTask; se estiver a chamar diretamente a API REST, o código de estado HTTP é 409 (Conflito).

rerunOnNodeRebootAfterSuccess

boolean

Se o serviço Batch deve reexecutar a Tarefa de Preparação de Tarefas após o reinício de um Nó de Computação. A Tarefa de Preparação de Trabalho é sempre reexecutada se um Nó de Computação for reimaginado, ou se a Tarefa de Preparação de Tarefas não foi concluída (por exemplo, porque o reinício ocorreu enquanto a Tarefa estava a correr). Por isso, deve sempre escrever uma Tarefa de Preparação de Tarefas para ser idempotente e comportar-se corretamente se for executada várias vezes. O valor padrão é true.

resourceFiles

ResourceFile[]

Uma lista de arquivos que o serviço em lote baixará para o nó de computação antes de executar a linha de comando. Os arquivos listados sob este 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 deve ser reduzida em tamanho. Isso pode ser feito usando arquivos .zip, pacotes de aplicativos ou contêineres do Docker.

userIdentity

UserIdentity

A identidade do utilizador sob a qual a Tarefa de Preparação de Tarefas é executada. Se omitida, a Tarefa executa-se como um utilizador não administrativo único da Tarefa nos Nós de Computação do Windows, ou como um utilizador não administrativo exclusivo do Pool nos Nós de Computação Linux.

waitForSuccess

boolean

Se o serviço Batch deve esperar que a Tarefa de Preparação de Trabalho seja concluída com sucesso antes de agendar quaisquer outras Tarefas do Trabalho no Nó de Computação. Uma Tarefa de Preparação de Trabalho foi concluída com sucesso se sair com código de saída 0. Se for verdade e a Tarefa de Preparação de Tarefas falhar num nó, o serviço Batch tenta novamente a Tarefa de Preparação de Tarefas até ao seu número máximo de tentativas (conforme especificado no elemento de restrições). Se a Tarefa ainda não tiver sido concluída com sucesso após todas as tentativas, então o serviço Batch não irá agendar as Tarefas do Trabalho para o nó. O Nó mantém-se ativo e elegível para executar Tarefas de outros Profissionais. Se for falso, o serviço em lote não espera que a Tarefa de Preparação de Trabalho seja concluída. Neste caso, outras Tarefas do Trabalho podem começar a ser executadas no Nó de Computação enquanto a Tarefa de Preparação de Tarefas ainda está a correr; e mesmo que a Tarefa de Preparação de Tarefas falhe, novas Tarefas continuarão a ser agendadas no Nó de Computação. O valor padrão é true.

BatchJobReleaseTask

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 tenha sido executado. A Tarefa de Liberação de Trabalho é executada quando o Trabalho termina, devido a um dos seguintes motivos: O usuário chama a API Encerrar Trabalho ou a API Excluir Trabalho enquanto o Trabalho ainda está ativo, a restrição máxima de tempo de relógio de parede do Trabalho é atingida e o Trabalho ainda está ativo, ou a Tarefa do Gerenciador de Trabalho é concluída e o Trabalho é configurado para ser encerrado quando o Gerenciador de Trabalho é concluído. A Tarefa de Liberação de Trabalho é executada em cada Nó em que as Tarefas do Trabalho foram executadas e a Tarefa de Preparação de Trabalho executada e concluída. Se você recriar a imagem de um Nó depois que ele tiver executado a Tarefa de Preparação de Trabalho e o Trabalho terminar sem que outras Tarefas do Trabalho sejam executadas nesse Nó (e, portanto, a Tarefa de Preparação de Trabalho não será executada novamente), a Tarefa de Liberação de Trabalho não será executada nesse Nó de Computação. Se um Nó for reinicializado enquanto a Tarefa de Liberação de Trabalho ainda estiver em execução, a Tarefa de Liberação de Trabalho será executada novamente quando o Nó de Computação for iniciado. O Trabalho não é marcado como concluído até que todas as Tarefas de Liberação de Trabalho tenham sido concluídas. A Tarefa de Liberação de Trabalho é executada em segundo plano. Não ocupa uma faixa horária; ou seja, ele não conta para o limite taskSlotsPerNode especificado no Pool.

Name Tipo Description
commandLine

string

A linha de comandos da Tarefa de Liberação de Tarefas. A linha de comando não é executada sob um shell e, portanto, não pode aproveitar os recursos do shell, como a expansão da variável de ambiente. Se você quiser aproveitar esses recursos, você deve invocar o shell na linha de comando, por exemplo, usando "cmd /c MyCommand" no Windows ou "/bin/sh -c MyCommand" no Linux. Se a linha de comando se referir a caminhos de arquivo, ela deverá usar um caminho relativo (relativo ao diretório de trabalho Tarefa) ou usar a variável de ambiente Batch provided (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).

containerSettings

BatchTaskContainerSettings

As definições do contentor sob o qual a Tarefa de Libertação de Tarefas é executada. Quando isto é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios Batch do Azure no nó) são mapeados para o contentor, todas as variáveis do ambiente Task são mapeadas para o contentor e a linha de comando Task é executada no contentor. Ficheiros produzidos no contentor fora de AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos para o disco anfitrião, o que significa que as APIs de ficheiros Batch não poderão aceder a esses ficheiros.

environmentSettings

EnvironmentSetting[]

Uma lista de definições de variáveis de ambiente para a Tarefa de Libertação de Tarefas.

id

string

Uma cadeia que identifica de forma única a Tarefa de Libertação de Trabalho dentro do Trabalho. O ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hífenes e sublinhados, e não pode conter mais de 64 caracteres. Se não especificar esta propriedade, o serviço Batch atribui um valor predefinido de 'jobrelease'. Nenhuma outra Tarefa no Trabalho pode ter o mesmo ID que a Tarefa de Libertação de Tarefas. Se tentar submeter uma Tarefa com o mesmo id, o serviço Batch rejeita o pedido com o código de erro TaskIdSameAsJobReleaseTask; se estiver a chamar diretamente a API REST, o código de estado HTTP é 409 (Conflito).

maxWallClockTime

string (duration)

O tempo máximo decorrido que a Tarefa de Libertação de Tarefas pode executar num dado Nó de Computação, medido a partir do momento em que a Tarefa começa. Se a Tarefa não for concluída dentro do limite de tempo, o serviço Batch termina-a. O valor padrão é 15 minutos. Não pode especificar um tempo de pausa superior a 15 minutos. Se o fizer, o serviço Batch rejeita com um erro; se estiver a chamar diretamente a API REST, o código de estado HTTP é 400 (Pedido Mau).

resourceFiles

ResourceFile[]

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

retentionTime

string (duration)

O tempo mínimo para manter o diretório Tarefa para a Tarefa de Lançamento de Tarefas no Nó de Computação. Após este período, o serviço Batch pode eliminar o diretório Task e todo o seu conteúdo. O padrão é 7 dias, ou seja, o diretório Tarefa será mantido durante 7 dias, a menos que o Nó de Computação seja removido ou o Trabalho seja eliminado.

userIdentity

UserIdentity

A identidade do utilizador sob a qual a Tarefa de Liberação de Tarefas é executada. Se omitida, a Tarefa é executada como um utilizador não administrativo único da Tarefa.

BatchJobSchedulingError

Um erro encontrado pelo serviço de lote ao agendar um trabalho.

Name Tipo Description
category

BatchErrorSourceCategory

A categoria do erro de agendamento de tarefas.

code

string

Um identificador para o erro de agendamento de tarefas. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.

details

NameValuePair[]

Uma lista de detalhes adicionais de erro relacionados com o erro de agendamento.

message

string

Uma mensagem que descreve o erro de agendamento de trabalhos, destinada a ser adequada para exibição numa interface de utilizador.

BatchJobState

Enums do BatchJobState

Valor Description
active

O Trabalho está disponível para ter Tarefas agendadas.

disabling

Um utilizador solicitou que o Job fosse desativado, mas a operação de desativação ainda está em curso (por exemplo, esperar que as Tarefas terminem).

disabled

Um utilizador desativou o Trabalho. Não estão a correr Tarefas e não serão agendadas novas Tarefas.

enabling

Um utilizador solicitou que o Job fosse ativado, mas a operação de ativação ainda está em curso.

terminating

O Job está prestes a ser concluído, seja porque uma Tarefa do Gestor de Jobs foi concluída ou porque o utilizador terminou o Job, mas a operação de terminar ainda está em curso (por exemplo, porque as Tarefas de Release de Job estão a decorrer).

completed

Todas as Tarefas terminaram e o sistema não aceita mais Tarefas nem alterações adicionais ao Trabalho.

deleting

Um utilizador pediu que o Trabalho fosse eliminado, mas a operação de eliminação ainda está em curso (por exemplo, porque o sistema continua a terminar as Tarefas em execução).

BatchJobStatistics

Estatísticas de uso de recursos para um trabalho.

Name Tipo Description
kernelCPUTime

string (duration)

O tempo total de CPU em modo kernel (somado por todos os núcleos e todos os Nós de Computação) consumido por todas as Tarefas no Trabalho.

lastUpdateTime

string (date-time)

A data em que as estatísticas foram atualizadas pela última vez. Todas as estatísticas estão limitadas ao intervalo entre startTime e lastUpdateTime.

numFailedTasks

string (int64)

O número total de Tarefas no Trabalho que falharam durante o intervalo de tempo dado. Uma tarefa falha se esgotar o seu número máximo de tentativas sem devolver o código de saída 0.

numSucceededTasks

string (int64)

O número total de Tarefas concluídas com sucesso no Trabalho durante o intervalo de tempo indicado. Uma tarefa é concluída com sucesso se devolver o código de saída 0.

numTaskRetries

string (int64)

O número total de tentativas em todas as Tarefas do Trabalho durante o intervalo de tempo dado.

readIOGiB

number (float)

A quantidade total de dados em GiB lidos do disco por todas as Tarefas no Trabalho.

readIOps

string (int64)

O número total de operações de leitura de disco realizadas por todas as Tarefas no Trabalho.

startTime

string (date-time)

A hora de início do intervalo temporal coberto pelas estatísticas.

url

string (uri)

O URL das estatísticas.

userCPUTime

string (duration)

O tempo total de CPU em modo utilizador (somado em todos os núcleos e todos os Nós de Computação) consumido por todas as Tarefas do Trabalho.

waitTime

string (duration)

O tempo total de espera de todas as tarefas do trabalho. 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 retentada devido a falhas, o tempo de espera é o tempo até à execução da tarefa mais recente.) Este valor é apenas reportado nas estatísticas de vida útil da conta; não está incluído nas estatísticas do Emprego.

wallClockTime

string (duration)

O tempo total do relógio de parede de todas as Tarefas no Trabalho. O tempo do relógio de parede é o tempo decorrido desde que a Tarefa começou a ser executada num Nó de Computação até ao seu término (ou até à última vez que as estatísticas foram atualizadas, se a Tarefa não tivesse terminado nessa altura). Se uma Tarefa fosse repetida, isto inclui o tempo de parede de todas as tentativas de Tarefa.

writeIOGiB

number (float)

A quantidade total de dados em GiB escritos no disco por todas as Tarefas no Trabalho.

writeIOps

string (int64)

O número total de operações de escrita em disco realizadas por todas as Tarefas no Trabalho.

BatchMetadataItem

O serviço Batch não atribui qualquer significado a estes metadados; é exclusivamente para o uso do código de usuário.

Name Tipo Description
name

string

O nome do item de metadados.

value

string

O valor do item de metadados.

BatchNodeFillType

Enums BatchNodeFillType

Valor Description
spread

As tarefas devem ser distribuídas de forma uniforme entre todos os Nós de Computação do Pool.

pack

O maior número possível de Tarefas (taskSlotsPerNode) deve ser atribuído a cada Nó de Computação do Pool antes de quaisquer Tarefas serem atribuídas ao próximo Nó de Computação do Pool.

BatchNodeIdentityReference

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

Name Tipo Description
resourceId

string (arm-id)

O ID de recurso ARM da identidade atribuída ao usuário.

BatchNodePlacementConfiguration

Para posicionamento regional, os nós no pool serão alocados na mesma região. Para o posicionamento zonal, os nós no pool serão distribuídos por diferentes zonas com o melhor balanceamento de esforço.

Name Tipo Description
policy

BatchNodePlacementPolicyType

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

BatchNodePlacementPolicyType

Enums BatchNodePlacementPolicyType

Valor Description
regional

Todos os nós no pool serão alocados na mesma região.

zonal

Os nós do pool estarão espalhados por diferentes zonas de disponibilidade com melhor equilíbrio de esforço.

BatchOsDisk

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

Name Tipo Description
caching

CachingType

Especifica os requisitos de cache. Os valores possíveis são: None, ReadOnly, ReadWrite. Os valores padrão são: Nenhum para armazenamento padrão. ReadOnly para armazenamento Premium.

diskSizeGB

integer (int32)

O tamanho inicial do disco em GB ao criar um novo disco do sistema operacional.

ephemeralOSDiskSettings

BatchDiffDiskSettings

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

managedDisk

ManagedDisk

Os parâmetros do disco gerenciado.

writeAcceleratorEnabled

boolean

Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco.

BatchPoolEndpointConfiguration

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

Name Tipo Description
inboundNATPools

BatchInboundNatPool[]

Uma lista de NAT Pools de entrada que podem ser usados para endereçar portas específicas num Nó de Computação individual externamente. O número máximo de NAT Pools de entrada por Batch Pool é 5. Se o número máximo de NAT Pools de entrada for ultrapassado, o pedido falha com o código de estado HTTP 400. Isso não pode ser especificado se o IPAddressProvisioningType for NoPublicIPAddresses.

BatchPoolIdentityReference

A referência de uma das identidades do pool para criptografar o disco. Essa identidade será usada para acessar o cofre de chaves.

Name Tipo Description
resourceId

string (arm-id)

O ID de recurso ARM da identidade atribuída ao usuário. Essa referência deve ser incluída nas identidades do pool.

BatchPoolInfo

Especifica como um Trabalho deve ser atribuído a um Pool.

Name Tipo Description
autoPoolSpecification

BatchAutoPoolSpecification

Características para um 'auto pool' temporário. O serviço de lote criará esse pool automático quando o trabalho for enviado. Se a criação automática do Pool falhar, o serviço Batch move o Job para um estado concluído, e o erro de criação do Pool é definido na propriedade de erro de agendamento do Job. O serviço Batch gere a vida útil (tanto a criação como, salvo especificação do keepAlive, a eliminação) do autopool. Qualquer ação do utilizador que afete a vida útil do autopool enquanto o Job está ativo resultará em comportamentos inesperados. Deve especificar ou o ID do Pool ou a especificação do auto Pool, mas não ambos.

poolId

string

O ID de um Pool existente. Todas as Tarefas do Trabalho serão executadas no Pool especificado. Deve garantir que o Pool referido por esta propriedade existe. Se o Pool não existir no momento em que o serviço Batch tenta agendar um Job, nenhuma Task for for Job será executada até que crie um Pool com esse id. Note que o serviço de lote não rejeita o pedido de emprego; simplesmente não executará Tarefas até que o Pool exista. Deve especificar ou o ID do Pool ou a especificação do auto Pool, mas não ambos.

BatchPoolLifetimeOption

Enums de BatchPoolLifetimeOption

Valor Description
jobschedule

O Pool existe durante toda a vida do Horário de Trabalho. O Serviço de Lote cria o Pool quando cria o primeiro Job no cronograma. Pode aplicar esta opção apenas a Horários de Trabalho, não a Empregos.

job

A Piscina existe durante toda a vida do Trabalho a que é dedicada. O serviço Batch cria o Pool quando cria o Job. Se a opção 'trabalho' for aplicada a um Horário de Trabalho, o serviço Batch cria um novo autopool para cada Trabalho criado no cronograma.

BatchPoolSpecification

Especificação para a criação de um novo Pool.

Name Tipo Description
applicationPackageReferences

BatchApplicationPackageReference[]

A lista de pacotes a serem instalados em cada nó de computação no pool. Ao criar um pool, a ID do aplicativo do pacote deve ser totalmente qualificada (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). As alterações nas referências de Pacote afetam todos os novos Nós que ingressam no Pool, mas não afetam os Nós de Computação que já estão no Pool até que sejam reinicializados ou recriados com imagem. Há um máximo de 10 referências de pacote em qualquer pool.

autoScaleEvaluationInterval

string (duration)

O intervalo de tempo no qual ajustar automaticamente o tamanho do Pool de acordo com a fórmula de dimensionamento automático. O valor padrão é 15 minutos. O valor mínimo e máximo são de 5 minutos e 168 horas, respectivamente. Se você especificar um valor inferior a 5 minutos ou superior a 168 horas, o serviço Batch 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. É necessário se enableAutoScale estiver definido como true. A validade da fórmula é verificada antes da criação do Pool. Se a fórmula não for válida, o serviço Lote rejeitará a solicitação com informações de erro detalhadas.

displayName

string

O nome para exibição do Pool. O nome para exibição não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024.

enableAutoScale

boolean

Se o tamanho do Pool deve ser ajustado automaticamente ao longo do tempo. Se false, pelo menos um dos targetDedicatedNodes e targetLowPriorityNodes deve ser especificado. Se true, o elemento autoScaleFormula é necessário. O Pool é redimensionado automaticamente de acordo com a fórmula. O valor predefinido é false.

enableInterNodeCommunication

boolean

Se o Pool permite a comunicação direta entre nós de computação. Habilitar a comunicação entre nós limita o tamanho máximo do Pool devido a restrições de implantação nos Nós de Computação do Pool. Isto pode fazer com que a Piscina não atinja o tamanho desejado. O valor predefinido é false.

metadata

BatchMetadataItem[]

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

mountConfiguration

MountConfiguration[]

Uma lista de sistemas de arquivos a serem montados em cada nó do pool. Isso dá suporte a Arquivos do Azure, NFS, CIFS/SMB e Blobfuse.

networkConfiguration

NetworkConfiguration

A configuração de rede para o Pool.

resizeTimeout

string (duration)

O tempo limite para alocação de nós de computação para o pool. Este tempo limite aplica-se apenas ao dimensionamento manual; ele não tem efeito quando enableAutoScale é definido como true. O valor padrão é 15 minutos. O valor mínimo é de 5 minutos. Se você especificar um valor inferior a 5 minutos, o serviço em 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

BatchStartTask

Uma Tarefa a ser executada em cada Nó de Computação à medida que ele se junta ao Pool. A Tarefa é executada quando o Nó de Computação é adicionado ao Pool ou quando o Nó de Computação é reiniciado.

targetDedicatedNodes

integer (int32)

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

targetLowPriorityNodes

integer (int32)

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

taskSchedulingPolicy

BatchTaskSchedulingPolicy

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

taskSlotsPerNode

integer (int32)

O número de slots de tarefas que podem ser usados para executar tarefas simultâneas em um único nó de computação no pool. O valor padrão é 1. O valor máximo é o menor de 4 vezes o número de núcleos do vmSize do pool ou 256.

upgradePolicy

UpgradePolicy

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

userAccounts

UserAccount[]

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

virtualMachineConfiguration

VirtualMachineConfiguration

A configuração da máquina virtual para o Pool. Esta propriedade deve ser especificada.

vmSize

string

O tamanho das máquinas virtuais no Pool. Todas as máquinas virtuais em um Pool têm o mesmo tamanho. Para obter informações sobre tamanhos disponíveis de máquinas virtuais em Pools, consulte Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).

BatchPublicIpAddressConfiguration

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

Name Tipo Description
ipAddressIds

string[] (arm-id)

A lista de IPs públicos que o serviço de lote usará ao provisionar nós de computação. O número de IPs especificado aqui limita o tamanho máximo do Pool - 100 nós dedicados ou 100 nós Spot/Low-priority podem ser alocados para cada IP público. Por exemplo, um pool que precisa de 250 VMs dedicadas precisaria de pelo menos 3 IPs públicos especificados. Cada elemento desta coleção tem o formato: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

ipFamilies

IPFamily[]

As famílias IP usadas para especificar as versões IP disponíveis para o pool. As famílias IP são usadas para determinar pools de pilha única ou de pilha dupla. Para pilha única, o valor esperado é IPv4. Para dual-stack, os valores esperados são IPv4 e IPv6.

ipTags

IPTag[]

Uma lista de marcas IP associadas aos endereços IP públicos do Pool. As tags IP são usadas para categorizar e filtrar endereços IP públicos para fins de faturamento e gerenciamento.

provision

IpAddressProvisioningType

O tipo de provisionamento para endereços IP públicos para o pool. O valor padrão é BatchManaged.

BatchStartTask

O lote tentará novamente Tarefas quando uma operação de recuperação for acionada 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 desaparece devido a falha do host. As novas tentativas devido a operações de recuperação são independentes e não são contabilizadas em relação ao maxTaskRetryCount. Mesmo se maxTaskRetryCount for 0, pode 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 ser interrompidas e reiniciadas sem causar corrupção ou dados duplicados. A prática recomendada para tarefas de longa duração é usar alguma forma de ponto de verificação. Em alguns casos, o StartTask pode ser executado novamente mesmo que o nó de computação não tenha sido reinicializado. Cuidado especial deve ser tomado para evitar StartTasks que criam processos separatistas ou instalam/iniciam serviços a partir do diretório de trabalho StartTask, pois isso impedirá que o Batch possa executar novamente o StartTask.

Name Tipo Description
commandLine

string

A linha de comando do StartTask. A linha de comando não é executada sob um shell e, portanto, não pode aproveitar os recursos do shell, como a expansão da variável de ambiente. Se você quiser aproveitar esses recursos, você deve invocar o shell na linha de comando, por exemplo, usando "cmd /c MyCommand" no Windows ou "/bin/sh -c MyCommand" no Linux. Se a linha de comando se referir a caminhos de arquivo, ela deverá usar um caminho relativo (relativo ao diretório de trabalho Tarefa) ou usar a variável de ambiente Batch provided (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).

containerSettings

BatchTaskContainerSettings

As definições do contentor sob o qual a StartTask é executada. Quando isto é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios Batch do Azure no nó) são mapeados para o contentor, todas as variáveis do ambiente Task são mapeadas para o contentor e a linha de comando Task é executada no contentor. Ficheiros produzidos no contentor fora de AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos para o disco anfitrião, o que significa que as APIs de ficheiros Batch não poderão aceder a esses ficheiros.

environmentSettings

EnvironmentSetting[]

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

maxTaskRetryCount

integer (int32)

O número máximo de vezes que a Tarefa pode ser repetida. O serviço de lote tenta novamente uma tarefa se seu código de saída for diferente de zero. Observe que esse valor controla especificamente o número de tentativas. O serviço de lote tentará a tarefa uma vez e, em seguida, poderá tentar novamente até esse limite. Por exemplo, se a contagem máxima de tentativas for 3, o Batch tentará a Tarefa até 4 vezes (uma tentativa inicial e 3 tentativas). Se a contagem máxima de tentativas for 0, o serviço Batch não repetirá a Tarefa. Se a contagem máxima de tentativas for -1, o serviço em lote repetirá a tarefa sem limite, no entanto, isso não é recomendado para uma tarefa inicial ou qualquer tarefa. O valor padrão é 0 (sem tentativas).

resourceFiles

ResourceFile[]

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

userIdentity

UserIdentity

A identidade do utilizador sob a qual o StartTask é executado. Se omitida, a Tarefa é executada como um utilizador não administrativo único da Tarefa.

waitForSuccess

boolean

Se o serviço em lote deve aguardar a conclusão bem-sucedida do StartTask (ou seja, sair com o código de saída 0) antes de agendar quaisquer tarefas no nó de computação. Se true e o StartTask falhar em um nó, o serviço Batch tentará novamente o StartTask até sua contagem máxima de tentativas (maxTaskRetryCount). Se a Tarefa ainda não tiver sido concluída com êxito após todas as tentativas, o serviço Lote marcará o Nó como inutilizável e não agendará Tarefas para ele. Esta condição pode ser detetada através do estado do nó de computação e detalhes de informações de falha. Se false, o serviço Batch não aguardará a conclusão do StartTask. Nesse caso, outras tarefas podem começar a ser executadas no nó de computação enquanto o StartTask ainda está em execução; e mesmo que o StartTask falhe, novas tarefas continuarão a ser agendadas no nó de computação. O padrão é verdadeiro.

BatchTaskConstraints

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

Name Tipo Description
maxTaskRetryCount

integer (int32)

O número máximo de vezes que a Tarefa pode ser repetida. O serviço de lote tenta novamente uma tarefa se seu código de saída for diferente de zero. Note que este valor controla especificamente o número de tentativas para o executável Task devido a um código de saída não nulo. O serviço de lote tentará a tarefa uma vez e, em seguida, poderá tentar novamente até esse limite. Por exemplo, se a contagem máxima de tentativas for 3, o Batch tentará a Tarefa até 4 vezes (uma tentativa inicial e 3 tentativas). Se o número máximo de tentativas for 0, o serviço Batch não tenta novamente a Tarefa após a primeira tentativa. Se a contagem máxima de tentativas for -1, o serviço em lote repetirá a tarefa sem limite, no entanto, isso não é recomendado para uma tarefa inicial ou qualquer tarefa. O valor padrão é 0 (sem tentativas).

maxWallClockTime

string (duration)

O tempo máximo decorrido que a Tarefa pode executar, medido a partir do momento em que a Tarefa começa. Se a Tarefa não for concluída dentro do limite de tempo, o serviço Batch termina-a. Se isto não for especificado, não existe limite de tempo para a duração da Tarefa.

retentionTime

string (duration)

O tempo mínimo para reter o diretório Tarefa no Nó de Computação onde foi executado, a partir da conclusão da execução. Após este período, o serviço Batch pode eliminar o diretório Task e todo o seu conteúdo. O padrão é 7 dias, ou seja, o diretório Tarefa será mantido durante 7 dias, a menos que o Nó de Computação seja removido ou o Trabalho seja eliminado.

BatchTaskContainerSettings

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

Name Tipo Description
containerHostBatchBindMounts

ContainerHostBatchBindMountEntry[]

Os caminhos que você deseja montar para a tarefa de contêiner. Se essa matriz for nula ou não estiver presente, a tarefa de contêiner montará toda a unidade de disco temporária no Windows (ou AZ_BATCH_NODE_ROOT_DIR no Linux). Ele não montará nenhum caminho de dados no contêiner se essa matriz estiver definida como vazia.

containerRunOptions

string

Opções adicionais para o comando container create. Essas opções adicionais são fornecidas como argumentos para o comando "docker create", além daquelas controladas pelo Batch Service.

imageName

string

A imagem a usar para criar o contentor onde a tarefa será executada. Esta é a referência completa da Imagem, conforme especificado para "docker pull". Se não for fornecida uma etiqueta como parte do nome da Imagem, a etiqueta ":latest" é usada como padrão.

registry

ContainerRegistryReference

O registo privado que contém a imagem do contentor. Esta definição pode ser omitida se já foi fornecida na criação do Pool.

workingDirectory

ContainerWorkingDirectory

A localização do diretório de trabalho da Tarefa do contentor. O padrão é 'taskWorkingDirectory'.

BatchTaskFailureMode

Enums TaskFailure

Valor Description
noaction

Não faça nada. O cargo mantém-se ativo a menos que seja despedido ou desativado por outro meio.

performexitoptionsjobaction

Termina o trabalho. A Razão de Terminação do Trabalho está definida como 'TudoTarefasConcluídos'.

BatchTaskSchedulingPolicy

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

Name Tipo Default value Description
jobDefaultOrder

BatchJobDefaultOrder

none

A ordem para agendar tarefas de diferentes trabalhos com a mesma prioridade. Se não for especificado, o padrão será nenhum.

nodeFillType

BatchNodeFillType

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

BatchUefiSettings

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

Name Tipo Description
secureBootEnabled

boolean

Especifica se a inicialização segura deve ser habilitada na máquina virtual.

vTpmEnabled

boolean

Especifica se o vTPM deve ser habilitado na máquina virtual.

BatchVmDiskSecurityProfile

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

Name Tipo Description
securityEncryptionType

SecurityEncryptionTypes

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

BatchVmImageReference

Uma referência a uma Imagem do Azure Virtual Machines Marketplace ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de Imagem do Azure Marketplace verificadas pelo Azure Batch, consulte a operação ' Listar Imagens Suportadas '.

Name Tipo Description
communityGalleryImageId

string

A imagem da galeria comunitária identificador único. Esta propriedade é mutuamente exclusiva com outras propriedades e pode ser obtida na chamada GET da galeria da comunidade.

exactVersion

string

A versão específica da imagem da plataforma ou da imagem do marketplace usada para criar o nó. Este campo de apenas leitura difere de 'versão' apenas se o valor especificado para 'versão' quando o pool foi criado for 'mais recente'.

offer

string

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

publisher

string

O editor da Azure Virtual Machines Marketplace Image. Por exemplo, Canonical ou MicrosoftWindowsServer.

sharedGalleryImageId

string

Identificador único da imagem da galeria partilhada. Esta propriedade é mutuamente exclusiva com outras propriedades e pode ser obtida a partir da chamada GET da imagem da galeria partilhada.

sku

string

O SKU da Imagem Azure Virtual Machines Marketplace. Por exemplo, 18.04-LTS ou 2019-Datacenter.

version

string

A versão da Imagem do Azure Virtual Machines Marketplace. Pode ser especificado um valor de 'mais recente' para selecionar a versão mais recente de uma Imagem. Se omitido, o padrão é 'mais recente'.

virtualMachineImageId

string (arm-id)

O identificador de recurso ARM da Imagem da Galeria de Computação do Azure. Os Nós de Computação no Pool serão criados usando este ID de Imagem. Isto é da forma /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 usar sempre a versão mais recente da imagem. Esta propriedade é mutuamente exclusiva com outras propriedades do ImageReference. A Imagem da Galeria de Computação do Azure deve ter réplicas na mesma região e deve estar na mesma subscrição da conta Batch do Azure. Se a versão da imagem não for especificada no imageId, será usada a versão mais recente. Para informações sobre as definições do firewall do agente Batch Compute Node para comunicar com o serviço Batch, veja https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

CachingType

Enums CachingType

Valor Description
none

O modo de cache para o disco não está habilitado.

readonly

O modo de cache para o disco é somente leitura.

readwrite

O modo de cache para o disco é leitura e gravação.

CifsMountConfiguration

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

Name Tipo Description
mountOptions

string

Opções de linha de comando adicionais para passar para o comando mount. Estas são opções de 'net use' no Windows e opções de 'mount' no Linux.

password

string (password)

A senha a ser usada para autenticação no sistema de arquivos CIFS.

relativeMountPath

string

O caminho relativo no nó de computação onde o sistema de ficheiros será montado. Todos os sistemas de arquivos são montados em relação ao diretório Batch mounts, acessível através da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.

source

string

O URI do sistema de arquivos a ser montado.

username

string

O usuário a ser usado para autenticação no sistema de arquivos CIFS.

ContainerHostBatchBindMountEntry

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

Name Tipo Description
isReadOnly

boolean

Monte esse caminho de origem como modo somente leitura ou não. O valor padrão é false (modo de leitura/gravação). Para Linux, se você montar esse caminho como um modo de leitura/gravação, isso não significa que todos os usuários no contêiner tenham o acesso de leitura/gravação para o caminho, depende do acesso na VM do host. Se esse caminho for montado somente leitura, todos os usuários dentro do contêiner não poderão modificá-lo.

source

ContainerHostDataPath

O caminho que ser montado para o cliente de contêiner pode selecionar.

ContainerHostDataPath

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

Valor Description
Shared

O caminho para a tarefa de várias instâncias compartilhar seus arquivos.

Startup

O caminho para iniciar a tarefa.

VfsMounts

O caminho contém todos os sistemas de arquivos virtuais montados neste nó.

Task

O caminho da tarefa.

JobPrep

O caminho da tarefa de preparação para o trabalho.

Applications

O caminho dos aplicativos.

ContainerRegistryReference

Um registro de contêiner privado.

Name Tipo Description
identityReference

BatchNodeIdentityReference

A referência à identidade atribuída ao usuário a ser usada para acessar um Registro de Contêiner do Azure em vez de nome de usuário e senha.

password

string (password)

A palavra-passe para iniciar sessão no servidor de registo.

registryServer

string (uri)

O URL do registo. Se omitido, o padrão é "docker.io".

username

string

O nome de utilizador para iniciar sessão no servidor de registo.

ContainerType

Enums ContainerType

Valor Description
dockerCompatible

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

criCompatible

Uma tecnologia baseada em CRI será usada para lançar os contêineres.

ContainerWorkingDirectory

ContainerWorkingDirectory enums

Valor Description
taskWorkingDirectory

Use o diretório de trabalho padrão de Tarefas do serviço Batch, que conterá os Ficheiros de Recursos da Tarefa preenchidos por Batch.

containerImageDefault

Use o diretório de trabalho definido na imagem do contentor. Atenção que este diretório não conterá os Ficheiros de Recursos descarregados pelo Batch.

DataDisk

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

Name Tipo Description
caching

CachingType

O tipo de cache a ser habilitado para os discos de dados. O valor padrão para cache é readwrite. Para obter informações sobre as opções de cache, consulte: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

diskSizeGB

integer (int32)

O tamanho inicial do disco em gigabytes.

lun

integer (int32)

O número da unidade lógica. O logicalUnitNumber é usado para identificar exclusivamente cada disco de dados. Se anexar vários discos, cada um deve ter um logicalUnitNumber distinto. O valor deve estar entre 0 e 63, inclusive.

managedDisk

ManagedDisk

Os parâmetros do disco gerenciado.

storageAccountType

StorageAccountType

O tipo de conta de armazenamento a ser usado para o disco de dados. Se omitido, o padrão é "standard_lrs".

DiffDiskPlacement

Especifica a colocação efémera do disco do sistema operativo para todos os nós de computação (VMs) do pool. Essa propriedade pode ser usada pelo usuário na solicitação para escolher em qual local o sistema operacional deve estar. por exemplo, espaço em disco de cache para provisionamento de disco do sistema operacional efêmero. Para 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 Efemérico para VMs Windows em https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e VMs Linux em https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

Valor Description
cachedisk

O disco do sistema operacional efêmero é armazenado no cache da VM.

DiskCustomerManagedKey

A referência de chave gerenciada pelo cliente para criptografar o disco.

Name Tipo Description
identityReference

BatchPoolIdentityReference

A referência de uma das identidades do pool para criptografar o disco. Essa identidade será usada para acessar o KeyVault.

keyUrl

string

URL de chave totalmente versionada apontando para uma chave no KeyVault. O segmento de versão da URL é necessário independentemente do valor rotationToLatestKeyVersionEnabled.

rotationToLatestKeyVersionEnabled

boolean

Defina esse sinalizador como true para habilitar a atualização automática da criptografia de disco para a versão de chave mais recente. O valor padrão é falso.

DiskEncryptionConfiguration

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

Name Tipo Description
customerManagedKey

DiskCustomerManagedKey

A referência de chave gerenciada pelo cliente para criptografar o disco do sistema operacional. A Chave Gerenciada pelo Cliente criptografará o disco do sistema operacional por EncryptionAtRest e, por padrão, criptografaremos o disco de dados também. Ele pode ser usado somente quando o pool é configurado com uma identidade e o OsDisk é definido como um dos destinos do DiskEncryption.

targets

DiskEncryptionTarget[]

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

DiskEncryptionSetParameters

A ID do recurso ARM do conjunto de criptografia de disco.

Name Tipo Description
id

string (arm-id)

A ID do recurso ARM do conjunto de criptografia de disco. O recurso deve estar na mesma assinatura que a conta Batch.

DiskEncryptionTarget

Enums DiskEncryptionTarget

Valor Description
osdisk

O disco do sistema operacional no nó de computação é criptografado.

temporarydisk

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

DynamicVNetAssignmentScope

DynamicVNetAssignmentScope enums

Valor Description
none

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

job

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

ElevationLevel

Enums ElevationLevel

Valor Description
nonadmin

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

admin

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

EnvironmentSetting

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

Name Tipo Description
name

string

O nome da variável de ambiente.

value

string

O valor da variável de ambiente.

HostEndpointSettings

Especifica configurações específicas do ponto de extremidade do host.

Name Tipo Description
inVMAccessControlProfileReferenceId

string

Especifica a referência à id do recurso InVMAccessControlProfileVersion na forma de /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}.

mode

HostEndpointSettingsModeTypes

Especifica o modo de execução da política de controle de acesso.

HostEndpointSettingsModeTypes

HostEndpointSettingsModeTypes enums

Valor Description
Audit

No modo de auditoria, o sistema age como se estivesse aplicando a política de controle de acesso, incluindo a emissão de entradas de negação de acesso nos logs, mas na verdade não nega nenhuma solicitação para hospedar pontos de extremidade.

Enforce

O modo de aplicação é o modo de operação recomendado e o sistema irá aplicar a política de controlo de acesso. Esta propriedade não pode ser usada juntamente com 'inVMAccessControlControlProfileReferenceId'.

InboundEndpointProtocol

InboundEndpointProtocol enums

Valor Description
tcp

Use TCP para o ponto de extremidade.

udp

Use UDP para o ponto de extremidade.

IpAddressProvisioningType

IPAddressProvisioningType enums

Valor Description
batchmanaged

Um IP público será criado e gerenciado pelo Batch. Pode haver vários IPs públicos, dependendo do tamanho do Pool.

usermanaged

IPs públicos são fornecidos pelo usuário e serão usados para provisionar os nós de computação.

nopublicipaddresses

Não será criado nenhum endereço IP público.

IPFamily

As famílias IP usadas para especificar as versões IP disponíveis para o pool.

Valor Description
IPv4

IPv4 está disponível para o pool.

IPv6

IPv6 está disponível para o pool.

IPTag

Contém a marca IP associada ao endereço IP público.

Name Tipo Description
ipTagType

string

O tipo de tag IP. Exemplo: FirstPartyUsage.

tag

string

O valor da tag IP associada ao IP público. Exemplo: SQL.

LinuxUserConfiguration

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

Name Tipo Description
gid

integer (int32)

O ID do grupo para a conta do utilizador. As propriedades uid e gid devem ser especificadas juntas ou não devem ser especificadas de todo. Se não for especificado, o sistema operacional subjacente seleciona o gid.

sshPrivateKey

string (password)

A chave privada SSH para a conta do utilizador. 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 Compute Nodes num Linux Pool quando a propriedade enableInterNodeCommunication do Pool é verdadeira (é ignorada se o enableInterNodeCommunication for falso). Ele faz isso colocando o par de chaves no diretório .ssh do usuário. Se não especificado, o SSH sem palavra-passe não é configurado entre os Nós de Computação (não é feita qualquer modificação do diretório .ssh do utilizador).

uid

integer (int32)

O ID de utilizador da conta de utilizador. As propriedades uid e gid devem ser especificadas juntas ou não devem ser especificadas de todo. Se não for especificado, o sistema operacional subjacente seleciona o uid.

LoginMode

LoginMode enums

Valor Description
batch

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

interactive

O LOGON32_LOGON_INTERACTIVE modo de login do Win32. O UAC está ativado nos Pools de Configuração de Máquinas Virtuais do Windows. Se esta opção for usada com uma identidade de utilizador elevada num PoolVirtualMachineConfiguration do Windows, a sessão do utilizador não será elevada a menos que a aplicação executada pela linha de comandos Task esteja configurada para exigir sempre privilégio administrativo ou para exigir sempre privilégio máximo.

ManagedDisk

Os parâmetros do disco gerenciado.

Name Tipo Description
diskEncryptionSet

DiskEncryptionSetParameters

Especifica a id do recurso do conjunto de criptografia de disco gerenciado pelo cliente para o disco gerenciado. Ele só pode ser definido no modo UserSubscription.

securityProfile

BatchVmDiskSecurityProfile

Especifica as configurações de perfil de segurança para o disco gerenciado.

storageAccountType

StorageAccountType

O tipo de conta de armazenamento para disco gerenciado.

MountConfiguration

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

Name Tipo Description
azureBlobFileSystemConfiguration

AzureBlobFileSystemConfiguration

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

azureFileShareConfiguration

AzureFileShareConfiguration

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

cifsMountConfiguration

CifsMountConfiguration

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

nfsMountConfiguration

NfsMountConfiguration

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

NameValuePair

Representa um par nome-valor.

Name Tipo Description
name

string

O nome no par nome-valor.

value

string

O valor no par nome-valor.

NetworkConfiguration

A configuração de rede para um Pool.

Name Tipo Description
dynamicVNetAssignmentScope

DynamicVNetAssignmentScope

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

enableAcceleratedNetworking

boolean

Se esse pool deve permitir a rede acelerada. A rede acelerada permite a virtualização de E/S de raiz única (SR-IOV) para uma VM, o que pode levar a um melhor desempenho de rede. Para mais informações, consultar: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.

endpointConfiguration

BatchPoolEndpointConfiguration

A configuração para endpoints nos Nós de Computação no Batch Pool.

publicIPAddressConfiguration

BatchPublicIpAddressConfiguration

A configuração de endereço IPAddress público para nós de computação no pool de lotes.

subnetId

string

O identificador de recurso ARM da sub-rede virtual que os Nós de Computação do Pool irão juntar. Este é o formato /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. A rede virtual deve estar na mesma região e assinatura que a Conta em Lote do Azure. A sub-rede especificada deve ter endereços IP livres suficientes para acomodar o número de Nós de Computação no Pool. Se a sub-rede não tiver endereços IP livres suficientes, o Pool aloca parcialmente os Nós e ocorre um erro de redimensionamento. A entidade de serviço 'MicrosoftAzureBatch' deve ter a função 'Colaborador de Máquina Virtual Clássica' Role-Based Controle de Acesso (RBAC) para a VNet especificada. A sub-rede especificada deve permitir a comunicação do serviço Batch Azure para poder agendar Tarefas nos Nós. Isso pode ser verificado verificando se a rede virtual especificada tem algum NSG (Network Security Groups) associado. Se a comunicação com os nós na sub-rede especificada for negada por um NSG, o serviço em lote definirá o estado dos nós de computação como inutilizável. Apenas as redes virtuais ARM ('Microsoft.Network/virtualNetworks') são suportadas. Se o VNet especificado tiver quaisquer Grupos de Segurança de Rede (NSG) associados, então algumas portas de sistema reservadas devem ser ativadas para comunicação de entrada, incluindo as portas 29876 e 29877. Habilite também as conexões de saída para o Armazenamento do Azure na porta 443. Para mais pormenores, consultar: https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

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

Name Tipo Description
access

NetworkSecurityGroupRuleAccess

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

priority

integer (int32)

A prioridade para esta regra. As prioridades dentro de um Pool devem ser únicas e avaliadas por ordem de prioridade. Quanto menor o número, maior a prioridade. Por exemplo, as regras podem ser especificadas com números de ordem de 150, 250 e 350. A regra com o número de ordem 150 tem precedência sobre a regra que tem uma ordem de 250. As prioridades permitidas são de 150 a 4096. Se algum valor reservado ou duplicado for fornecido, a solicitação falhará com o código de status HTTP 400.

sourceAddressPrefix

string

O prefixo do endereço de origem ou a tag a ser correspondida para a regra. Os valores válidos são um único endereço IP (ou seja, 10.10.10.10), sub-rede IP (ou seja, 192.168.1.0/24), tag padrão ou * (para todos os endereços). Se quaisquer outros valores forem fornecidos, a solicitação falhará com o código de status HTTP 400.

sourcePortRanges

string[]

A porta de origem varia para corresponder à regra. Os valores válidos são '' (para todas as portas 0 - 65535), uma porta específica (ou seja, 22) ou um intervalo de portas (ou seja, 100-200). As portas devem estar na faixa de 0 a 65535. Cada entrada desta coleção não deve sobrepor-se a nenhuma outra entrada (seja um intervalo ou uma porta individual). Se forem fornecidos outros valores, o pedido falha com o código de estado HTTP 400. O valor padrão é ''.

NetworkSecurityGroupRuleAccess

NetworkSecurityGroupRuleAccess enums

Valor Description
allow

Permitir acesso.

deny

Negar acesso.

NfsMountConfiguration

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

Name Tipo Description
mountOptions

string

Opções de linha de comando adicionais para passar para o comando mount. Estas são opções de 'net use' no Windows e opções de 'mount' no Linux.

relativeMountPath

string

O caminho relativo no nó de computação onde o sistema de ficheiros será montado. Todos os sistemas de arquivos são montados em relação ao diretório Batch mounts, acessível através da variável de ambiente AZ_BATCH_NODE_MOUNTS_DIR.

source

string

O URI do sistema de arquivos a ser montado.

OutputFile

Em cada upload de arquivo, o serviço Batch grava dois arquivos de log no nó de computação, 'fileuploadout.txt' e 'fileuploaderr.txt'. Esses arquivos de log são usados para saber mais sobre uma falha específica.

Name Tipo Description
destination

OutputFileDestination

O destino do(s) ficheiro(s) de saída.

filePattern

string

Um padrão que indica que ficheiro(s) carregar. Tanto os caminhos relativos como os absolutos são suportados. Os caminhos relativos são relativos ao diretório de trabalho Tarefa. São suportados os seguintes coringas: * corresponde a 0 ou mais caracteres (por exemplo, o padrão abc* corresponderia a abc ou abcdef), ** corresponde a qualquer diretório, ? corresponde a qualquer personagem individual, [ABC] corresponde a um personagem entre parênteses, e [A-C] corresponde a um carácter no intervalo. Os parênteses podem incluir uma negação para corresponder a qualquer carácter não especificado (por exemplo, [!abc] corresponde a qualquer carácter exceto a, b ou c). Se o nome de um ficheiro começar por "." é ignorado por defeito, mas pode ser correspondido especificando-o explicitamente (por exemplo ,.gif não corresponderá .a.gif, mas.gif sim). Um exemplo simples: ***.txt corresponde a qualquer ficheiro que não comece em '.' e termine com .txt no diretório de trabalho Task ou em qualquer subdiretório. Se o nome do ficheiro contiver um carácter curinga, pode ser escapado usando parênteses (por exemplo, abc[] corresponderia a um ficheiro chamado abc). Note que tanto \ como / são tratados como separadores de diretórios no Windows, mas apenas / é no Linux. As variáveis de ambiente (%var% no Windows ou $var no Linux) são expandidas antes da aplicação do padrão.

uploadOptions

OutputFileUploadConfig

Opções adicionais para a operação de upload, incluindo em que condições realizar o upload.

OutputFileBlobContainerDestination

Especifica um destino de carregamento de arquivo em um contêiner de armazenamento de blob do Azure.

Name Tipo Description
containerUrl

string (uri)

A URL do contentor dentro do Azure Blob Storage para onde carregar o(s) ficheiro(s). Se não estiver a usar uma identidade gerida, a URL deve incluir uma Assinatura de Acesso Partilhado (SAS) que conceda permissões de escrita ao contentor.

identityReference

BatchNodeIdentityReference

A referência à identidade atribuída pelo utilizador para aceder ao Azure Blob Storage especificada pelo containerUrl. A identidade deve ter acesso de escrita ao contentor Azure Blob Storage.

path

string

O blob de destino ou diretório virtual dentro do contentor Azure Storage. Se filePattern se referir a um ficheiro específico (ou seja, não contiver curingas), então path é o nome do blob para onde se deve carregar esse ficheiro. Se o filePattern contiver um ou mais wildcards (e, portanto, pode corresponder a vários ficheiros), então path é o nome do diretório virtual do blob (que é antecedido a cada nome do blob) para o qual carregar o(s) ficheiro(s). Se omitido(s), o(s) ficheiro(s) são carregados para a raiz do contentor com um nome de blob correspondente ao nome do ficheiro.

uploadHeaders

OutputFileUploadHeader[]

Uma lista de pares nome-valor para cabeçalhos a serem usados no carregamento de ficheiros de saída. Estes cabeçalhos serão especificados ao carregar ficheiros para o Azure Storage. Documento oficial sobre cabeçalhos permitidos ao carregar blobs: https://learn.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types.

OutputFileDestination

O destino para o qual um arquivo deve ser carregado.

Name Tipo Description
container

OutputFileBlobContainerDestination

Um local no armazenamento de blobs do Azure para onde os ficheiros são carregados.

OutputFileUploadCondition

OutputFileUploadCondition enums

Valor Description
tasksuccess

Carregue o(s) ficheiro(s) apenas depois de o processo de Tarefa sair com um código de saída 0.

taskfailure

Carrega o(s) ficheiro(s) apenas depois de o processo de Tarefa sair com um código de saída diferente de zero.

taskcompletion

Carrega o(s) ficheiro(s) depois de o processo de Tarefa sair, independentemente do código de saída.

OutputFileUploadConfig

Opções para uma operação de upload de arquivo de saída, incluindo em que condições executar o upload.

Name Tipo Description
uploadCondition

OutputFileUploadCondition

As condições sob as quais o ficheiro de saída da Tarefa ou conjunto de ficheiros deve ser carregado. O padrão é a conclusão de tarefas.

OutputFileUploadHeader

Um par nome-valor de cabeçalho HTTP

Name Tipo Description
name

string

O nome insensível a maiúsculas minúsculas do cabeçalho a ser usado durante o carregamento dos ficheiros de saída.

value

string

O valor do cabeçalho a ser usado ao carregar ficheiros de saída.

ProxyAgentSettings

Especifica as configurações do ProxyAgent ao criar a máquina virtual.

Name Tipo Description
enabled

boolean

Especifica se o recurso Protocolo de Segurança de Metadados deve ser habilitado na máquina virtual ou no conjunto de dimensionamento de máquina virtual. O padrão é False.

imds

HostEndpointSettings

Configurações para o ponto de extremidade IMDS.

wireServer

HostEndpointSettings

Configurações para o endpoint do WireServer.

ResourceFile

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

Name Tipo Description
autoStorageContainerName

string

O nome do contentor de armazenamento na conta de armazenamento automático. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada.

blobPrefix

string

O prefixo de blob a ser usado ao baixar blobs de um contêiner de Armazenamento do Azure. Somente os blobs cujos nomes começam com o prefixo especificado serão baixados. A propriedade é válida somente quando autoStorageContainerName ou storageContainerUrl é usado. Esse prefixo pode ser um nome de arquivo parcial ou um subdiretório. Se um prefixo não for especificado, todos os arquivos no contêiner serão baixados.

fileMode

string

O atributo file permission mode em formato octal. Esta propriedade aplica-se apenas a ficheiros descarregados para os Nós de Computação Linux. Será ignorado se for especificado para um resourceFile que será descarregado para um Nó de Computação do Windows. Se esta propriedade não for especificada para um Nó de Computação Linux, então é aplicado um valor padrão de 0770 ao ficheiro.

filePath

string

A localização no Nó de Computação para onde descarregar o(s) ficheiro(s), relativa ao diretório de trabalho da Tarefa. Se a propriedade httpUrl for especificada, o filePath será necessário e descreverá o caminho para o qual o arquivo será baixado, incluindo o nome do arquivo. Caso contrário, se a propriedade autoStorageContainerName ou storageContainerUrl for especificada, filePath será opcional e será o diretório para o qual os arquivos serão baixados. No caso em que filePath é usado como um diretório, qualquer estrutura de diretório já associada aos dados de entrada será mantida na íntegra e anexada ao diretório filePath especificado. O caminho relativo especificado não pode sair do diretório de trabalho da Tarefa (por exemplo, usando '..').

httpUrl

string (uri)

O URL do ficheiro a transferir. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Se a URL apontar para o Armazenamento de Blobs do Azure, ela deverá ser legível a partir dos nós de computação. Há três maneiras de obter essa URL para um blob no armazenamento do Azure: incluir uma Assinatura de Acesso Compartilhado (SAS) concedendo permissões de leitura no blob, usar uma identidade gerenciada com permissão de leitura ou definir a ACL para o blob ou seu contêiner para permitir acesso público.

identityReference

BatchNodeIdentityReference

A referência à identidade atribuída pelo utilizador para aceder ao Azure Blob Storage especificada por storageContainerUrl ou httpUrl.

storageContainerUrl

string (uri)

A URL do contêiner de blob no Armazenamento de Blob do Azure. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Este URL deve ser legível e listável a partir de nós de computação. Há três maneiras de obter essa URL para um contêiner no armazenamento do Azure: incluir uma SAS (Assinatura de Acesso Compartilhado) concedendo permissões de leitura e lista no contêiner, usar uma identidade gerenciada com permissões de leitura e lista ou definir a ACL do contêiner para permitir acesso público.

RollingUpgradePolicy

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

Name Tipo Description
enableCrossZoneUpgrade

boolean

Permita que o VMSS ignore os limites AZ ao construir lotes de atualização. Leve em consideração o Domínio de Atualização e maxBatchInstancePercent para determinar o tamanho do lote. Este campo pode ser definido como true ou false somente ao usar NodePlacementConfiguration como Zonal.

maxBatchInstancePercent

integer (int32)

A porcentagem máxima do total de instâncias de máquina virtual que serão atualizadas simultaneamente pela atualização sem interrupção em um lote. Como isso é máximo, instâncias não íntegras em lotes anteriores ou futuros podem fazer com que a porcentagem de instâncias em um lote diminua para garantir maior confiabilidade. O valor deste campo deve estar entre 5 e 100, inclusive. Se maxBatchInstancePercent e maxUnhealthyInstancePercent forem atribuídos com valor, o valor de maxBatchInstancePercent não deverá ser superior a maxUnhealthyInstancePercent.

maxUnhealthyInstancePercent

integer (int32)

A porcentagem máxima do total de instâncias de máquina virtual no conjunto de escala que pode estar simultaneamente não íntegra, seja como resultado de ser atualizada ou por ser encontrada em um estado não íntegro pelas verificações de integridade da máquina virtual antes que a atualização contínua seja abortada. Esta restrição será verificada antes de iniciar qualquer lote. O valor deste campo deve estar entre 5 e 100, inclusive. Se maxBatchInstancePercent e maxUnhealthyInstancePercent forem atribuídos com valor, o valor de maxBatchInstancePercent não deverá ser superior a maxUnhealthyInstancePercent.

maxUnhealthyUpgradedInstancePercent

integer (int32)

A porcentagem máxima de instâncias de máquina virtual atualizadas que podem ser encontradas em um estado não íntegro. Essa verificação acontecerá depois que cada lote for atualizado. Se essa porcentagem for excedida, a atualização contínua será anulada. O valor deste campo deve estar entre 0 e 100, inclusive.

pauseTimeBetweenBatches

string (duration)

O tempo de espera entre a conclusão da atualização para todas as máquinas virtuais em um lote e o início do próximo lote. A duração do tempo deve ser especificada no formato ISO 8601..

prioritizeUnhealthyInstances

boolean

Atualize todas as instâncias não íntegras em um conjunto de escala antes de quaisquer instâncias íntegras.

rollbackFailedInstancesOnPolicyBreach

boolean

Reversão de instâncias com falha para o modelo anterior se a política de Atualização Contínua for violada.

SecurityEncryptionTypes

SecurityEncryptionTypes enums

Valor Description
DiskWithVMGuestState

EncryptionType do disco gerenciado é definido como DiskWithVMGuestState para criptografia do disco gerenciado junto com o blob VMGuestState. Não é suportado em discos de dados.

NonPersistedTPM

EncryptionType do disco gerenciado é definido como NonPersistedTPM para não persistir o estado do firmware no blob VMGuestState.

VMGuestStateOnly

EncryptionType do disco gerenciado é definido como VMGuestStateOnly para criptografia apenas do blob VMGuestState.

SecurityProfile

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

Name Tipo Description
encryptionAtHost

boolean

Essa propriedade pode ser usada pelo usuário na solicitação para habilitar ou desabilitar a Criptografia de Host para a máquina virtual ou o conjunto de dimensionamento de máquina virtual. Isso habilitará a criptografia para todos os discos, incluindo o disco Resource/Temp no próprio host. Para obter mais informações sobre criptografia nos requisitos do host, consulte https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes.

proxyAgentSettings

ProxyAgentSettings

Especifica as configurações do ProxyAgent ao criar a máquina virtual.

securityType

SecurityTypes

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

uefiSettings

BatchUefiSettings

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

SecurityTypes

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

Valor Description
trustedLaunch

O lançamento confiável protege contra técnicas de ataque avançadas e persistentes.

confidentialvm

A computação confidencial do Azure oferece VMs confidenciais para locatários com altos requisitos de segurança e confidencialidade. Essas VMs fornecem um limite forte e imposto por hardware para ajudar a atender às suas necessidades de segurança. Você pode usar VMs confidenciais para migrações sem fazer alterações no código, com a plataforma protegendo o estado da VM de ser lido ou modificado.

ServiceArtifactReference

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

Name Tipo Description
id

string

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

StorageAccountType

Enums StorageAccountType

Valor Description
standard_lrs

O disco de dados deve usar armazenamento padrão localmente redundante.

premium_lrs

O disco de dados deve usar armazenamento redundante local premium.

standardssd_lrs

O disco de dados / disco do sistema operacional deve usar armazenamento padrão SSD localmente redundante.

UpgradeMode

Enums UpgradeMode

Valor Description
automatic

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

manual

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

rolling

As instâncias existentes em um conjunto de escala são reduzidas em lotes a serem atualizados. Quando o lote atualizado estiver concluído, as instâncias começarão a receber tráfego novamente e o próximo lote começará. Isso continua até que todas as instâncias sejam trazidas up-todata.

UpgradePolicy

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

Name Tipo Description
automaticOSUpgradePolicy

AutomaticOsUpgradePolicy

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

mode

UpgradeMode

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

Os valores possíveis são:

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

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

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

rollingUpgradePolicy

RollingUpgradePolicy

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

UserAccount

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

Name Tipo Description
elevationLevel

ElevationLevel

O nível de elevação da conta do utilizador. O valor padrão é nonAdmin.

linuxUserConfiguration

LinuxUserConfiguration

A configuração de utilizador específica para Linux para a Conta de utilizador. Esta propriedade é ignorada se especificada num Windows Pool. Se não for especificado, o usuário será criado com as opções padrão.

name

string

O nome da conta de utilizador. Os nomes podem conter caracteres Unicode até um comprimento máximo de 20.

password

string (password)

A palavra-passe da conta de utilizador.

windowsUserConfiguration

WindowsUserConfiguration

A configuração de utilizador específica do Windows para a Conta de utilizador. Esta propriedade só pode ser especificada se o utilizador estiver num Windows Pool. Se não for especificado e estiver num Windows Pool, o utilizador é criado com as opções padrão.

UserIdentity

A definição da identidade do usuário sob a qual a Tarefa é executada. Especifique a propriedade userName ou autoUser, mas não ambas.

Name Tipo Description
autoUser

AutoUserSpecification

O utilizador 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 utilizador sob a qual a Tarefa é executada. As propriedades userName e autoUser são mutuamente exclusivas; você deve especificar um, mas não ambos.

VirtualMachineConfiguration

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

Name Tipo Description
containerConfiguration

BatchContainerConfiguration

A configuração do contentor para o Pool. Se especificado, a configuração é feita em cada Nó de Computação do Pool para permitir que as Tarefas sejam executadas em contentores. Todas as Tarefas normais e Tarefas do Gestor de Tarefas que correm neste Pool devem especificar a propriedade ContainerSettings, e todas as outras Tarefas podem especificá-la.

dataDisks

DataDisk[]

A configuração para discos de dados ligados aos Nós de Computação no Pool. Esta propriedade deve ser especificada se os Nós de Computação no Pool precisarem de ter discos de dados vazios ligados a eles. Isso não pode ser atualizado. Cada Pó de Computação recebe o seu próprio disco (o disco não é uma partilha de ficheiros). Os discos existentes não podem ser ligados, cada disco ligado está vazio. Quando o Nó de Computação é removido do Pool, o disco e todos os dados a ele associados também são eliminados. O disco não é formatado depois de ser ligado, deve ser formatado antes de ser utilizado – para mais informações, veja https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux e https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.

diskEncryptionConfiguration

DiskEncryptionConfiguration

A configuração de criptografia de disco para o pool. Se especificado, a criptografia é executada em cada nó do pool durante o provisionamento do nó.

extensions

VMExtension[]

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

imageReference

BatchVmImageReference

Uma referência à Imagem do Azure Virtual Machines Marketplace ou à Imagem de Máquina Virtual personalizada a ser usada.

licenseType

string

Isto aplica-se apenas a Imagens que contenham o sistema operativo Windows e só deve ser usado quando tiver licenças válidas on-premises para os Nós de Computação que serão implementados. Se omitido, nenhum desconto de licenciamento local será aplicado. Os valores são:

Windows_Server - A licença local é para o Windows Server. Windows_Client - A licença local é para o Windows Client.

nodeAgentSKUId

string

A SKU do agente do Nó de Computação em Lote a ser provisionado em Nós de Computação no Pool. O agente Batch Compute Node é um programa que é executado em cada Nó de Computação no Pool e fornece a interface de comando e controle entre o Nó de Computação e o serviço Batch. Existem diferentes implementações do agente Compute Node, conhecido como SKUs, para diferentes sistemas operacionais. Você deve especificar uma SKU do agente do Nó de Computação que corresponda à referência de Imagem selecionada. Para obter a lista de SKUs de agente de nó de computação suportados, juntamente com sua lista de referências de imagem verificadas, consulte a operação 'Listar SKUs de agente de nó de computação suportados'.

nodePlacementConfiguration

BatchNodePlacementConfiguration

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

osDisk

BatchOsDisk

Configurações para o disco do sistema operacional da máquina virtual.

securityProfile

SecurityProfile

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

serviceArtifactReference

ServiceArtifactReference

Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de escala ao usar a versão de imagem 'mais recente'. A ID de referência do artefato de serviço na forma de /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

windowsConfiguration

WindowsConfiguration

Configurações do sistema operacional Windows na máquina virtual. Esta propriedade não deve ser especificada se a propriedade imageReference especificar uma imagem do sistema operativo Linux.

VMExtension

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

Name Tipo Description
autoUpgradeMinorVersion

boolean

Indica se a extensão deve usar uma versão secundária mais recente, se uma estiver disponível no momento da implantação. Uma vez implantada, no entanto, a extensão não atualizará versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como true.

enableAutomaticUpgrade

boolean

Indica se a extensão deve ser atualizada automaticamente pela plataforma se houver uma versão mais recente da extensão disponível.

name

string

O nome da extensão da máquina virtual.

protectedSettings

object

A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida.

provisionAfterExtensions

string[]

A coleção de nomes de extensão. Coleção de nomes de extensão após a qual essa extensão precisa ser provisionada.

publisher

string

O nome do editor do manipulador de extensão.

settings

object

Configurações públicas formatadas em JSON para a extensão.

type

string

O tipo da extensão.

typeHandlerVersion

string

A versão do manipulador de script.

WindowsConfiguration

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

Name Tipo Description
enableAutomaticUpdates

boolean

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

WindowsUserConfiguration

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

Name Tipo Description
loginMode

LoginMode

O modo de login para o utilizador. O padrão é 'batch'.