Job - Get
Obtém informações sobre o trabalho especificado.
GET {batchUrl}/jobs/{jobId}?api-version=2024-07-01.20.0
GET {batchUrl}/jobs/{jobId}?$select={$select}&$expand={$expand}&timeout={timeout}&api-version=2024-07-01.20.0
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
batch
|
path | True |
string |
A URL base para todas as solicitações de serviço do Lote do Azure. |
job
|
path | True |
string |
A ID do trabalho. |
api-version
|
query | True |
string |
Versão da API do cliente. |
$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 maior que 30, o padrão será usado. |
Cabeçalho do Pedido
Media Types: "application/json; odata=minimalmetadata"
Name | Necessário | Tipo | Description |
---|---|---|---|
client-request-id |
string uuid |
A identidade de solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves 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-rfc1123 |
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-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. |
|
If-Modified-Since |
string date-time-rfc1123 |
Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço tiver sido modificado desde o tempo especificado. |
|
If-Unmodified-Since |
string date-time-rfc1123 |
Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço não tiver sido modificado desde o tempo especificado. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Uma resposta contendo o Job. Cabeçalhos
|
|
Other Status Codes |
O erro do serviço de lote. |
Segurança
azure_auth
Fluxo de código de autenticação do Microsoft Entra OAuth 2.0
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
user_impersonation | Personificar a sua conta de utilizador |
Authorization
Tipo:
apiKey
Em:
header
Exemplos
Job get
Pedido de amostra
GET account.region.batch.azure.com/jobs/jobId?api-version=2024-07-01.20.0
Resposta da amostra
{
"id": "jobId",
"url": "https://account.region.batch.azure.com/jobs/jobId",
"eTag": "0x8D4100FC49F0278",
"lastModified": "2016-11-19T00:05:27.5391608Z",
"creationTime": "2016-11-19T00:05:25.311915Z",
"state": "completed",
"stateTransitionTime": "2016-11-19T00:05:27.578581Z",
"previousState": "active",
"previousStateTransitionTime": "2016-11-19T00:05:27.2137716Z",
"priority": 0,
"maxParallelTasks": -1,
"allowTaskPreemption": false,
"usesTaskDependencies": false,
"constraints": {
"maxWallClockTime": "P10675199DT2H48M5.4775807S",
"maxTaskRetryCount": 0
},
"poolInfo": {
"poolId": "poolId"
},
"executionInfo": {
"startTime": "2016-11-19T00:05:25.3309105Z",
"endTime": "2016-11-19T00:05:27.578581Z",
"poolId": "poolId",
"terminateReason": "UserTerminate"
},
"onAllTasksComplete": "noaction",
"onTaskFailure": "noaction"
}
Definições
Name | Description |
---|---|
Access |
Os recursos de lote aos quais o token concede acesso. |
Application |
Uma referência a um pacote a ser implantado em nós de computação. |
Authentication |
As configurações de um token de autenticação que a Tarefa pode usar para executar operações de serviço em lote. |
Automatic |
Os parâmetros de configuração usados para executar a atualização automática do sistema operacional. |
Auto |
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. |
Auto |
O escopo para o usuário automático |
Auto |
Especifica os parâmetros para o usuário automático que executa uma tarefa no serviço em lote. |
Azure |
Informações usadas para se conectar a um Contêiner de Armazenamento do Azure usando Blobfuse. |
Azure |
Informações usadas para se conectar a um compartilhamento de arquivos do Azure. |
Batch |
Uma resposta de erro recebida do serviço Batch do Azure. |
Batch |
Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure. |
Caching |
O tipo de cache a ser habilitado para o disco. |
Certificate |
Uma referência a um certificado a ser instalado em nós de computação em um pool. |
Certificate |
O local do armazenamento de certificados no nó de computação no qual instalar o certificado. |
Certificate |
Quais Contas de usuário no Nó de Computação devem ter acesso aos dados privados do Certificado. |
CIFSMount |
Informações usadas para se conectar a um sistema de arquivos CIFS. |
Cloud |
Um trabalho em lote do Azure. |
Compute |
Como as tarefas são distribuídas entre nós de computação em um pool. |
Compute |
A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará. |
Container |
A configuração para pools habilitados para contêiner. |
Container |
A entrada do caminho e do modo de montagem que você deseja montar no contêiner de tarefas. |
Container |
Os caminhos que serão montados no contêiner da tarefa do contêiner. |
Container |
Um registro de contêiner privado. |
Container |
A tecnologia de contentores a utilizar. |
Container |
O local do diretório de trabalho da tarefa do contêiner. |
Data |
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. |
Diff |
Especifica o posicionamento efêmero do disco do sistema operacional para todos os nós de computação (VMs) no pool. |
Diff |
Especifica as configurações de disco efêmeras para o disco do sistema operacional usado pelo nó de computação (VM). |
Disk |
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. |
Disk |
A lista de destinos de disco do Serviço em Lote será criptografada no nó de computação. |
Dynamic |
O escopo da atribuição dinâmica de vnet. |
Elevation |
O nível de elevação do usuário. |
Environment |
Uma variável de ambiente a ser definida em um processo Task. |
Error |
A categoria do erro. |
Error |
Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure. |
Http |
Um par nome-valor de cabeçalho HTTP |
Image |
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 Lote do Azure, consulte a operação 'Listar imagens suportadas'. |
Inbound |
O protocolo do ponto de extremidade. |
Inbound |
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. |
IPAddress |
O tipo de provisionamento para endereços IP públicos para o pool. |
Job |
As restrições de execução de um Trabalho. |
Job |
Contém informações sobre a execução de um Trabalho no serviço Batch do Azure. |
Job |
Especifica os detalhes de uma Tarefa do Gerenciador de Tarefas. |
Job |
A configuração de rede para o trabalho. |
Job |
Uma Tarefa de Preparação de Trabalho a ser executada antes de qualquer Tarefa do Trabalho em qualquer Nó de Computação. |
Job |
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. |
Job |
Um erro encontrado pelo serviço de lote ao agendar um trabalho. |
Job |
O estado do Jó. |
Job |
Estatísticas de uso de recursos para um trabalho. |
Linux |
Propriedades usadas para criar uma conta de usuário em um nó de computação Linux. |
Login |
O modo de login para o usuário |
Managed |
|
Metadata |
Um par nome-valor associado a um recurso de serviço em lote. |
Mount |
O sistema de arquivos a ser montado em cada nó. |
Name |
Representa um par nome-valor. |
Network |
A configuração de rede para um Pool. |
Network |
Uma regra de grupo de segurança de rede a ser aplicada a um ponto de extremidade de entrada. |
Network |
A ação que deve ser tomada para um endereço IP, intervalo de sub-rede ou tag especificado. |
NFSMount |
Informações usadas para se conectar a um sistema de arquivos NFS. |
Node |
Determina como um pool se comunica com o serviço de lote. |
Node |
Configuração de posicionamento de nó para um pool. |
Node |
A política de posicionamento para alocar nós no pool. |
On |
A ação que o serviço em lote deve executar quando todas as tarefas no trabalho estiverem no estado concluído. |
On |
A ação que o serviço em lote deve executar quando qualquer tarefa no trabalho falhar. |
OSDisk |
Configurações para o disco do sistema operacional do nó de computação (VM). |
Output |
Uma especificação para carregar arquivos de um Nó de Computação em Lote do Azure para outro local depois que o serviço de Lote concluir a execução do processo de Tarefa. |
Output |
Especifica um destino de carregamento de arquivo em um contêiner de armazenamento de blob do Azure. |
Output |
O destino para o qual um arquivo deve ser carregado. |
Output |
As condições sob as quais um arquivo de saída de tarefa ou conjunto de arquivos deve ser carregado. |
Output |
Detalhes sobre uma operação de upload de arquivo de saída, incluindo em que condições executar o upload. |
Pool |
A configuração do ponto de extremidade para um Pool. |
Pool |
Especifica como um Trabalho deve ser atribuído a um Pool. |
Pool |
O tempo de vida mínimo dos Pools automáticos criados e como vários Trabalhos em uma agenda são atribuídos aos Pools. |
Pool |
Especificação para a criação de um novo Pool. |
Public |
A configuração de endereço IP público da configuração de rede de um pool. |
Resource |
Um único arquivo ou vários arquivos a serem baixados para um nó de computação. |
Rolling |
Os parâmetros de configuração usados durante a execução de uma atualização contínua. |
Security |
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. |
Security |
Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquina virtual. |
Security |
Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings. |
Service |
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'. |
Start |
Uma Tarefa que é executada quando um Nó ingressa em um Pool no serviço Lote do Azure ou quando o Nó de Computação é reinicializado ou recriado. |
Storage |
O tipo de conta de armazenamento para uso na criação de discos de dados ou disco do sistema operacional. |
Task |
Restrições de execução a serem aplicadas a uma Tarefa. |
Task |
As configurações de contêiner para uma Tarefa. |
Task |
Especifica como as tarefas devem ser distribuídas entre nós de computação. |
Uefi |
Especifica as configurações de segurança, como inicialização segura e vTPM, usadas durante a criação da máquina virtual. |
Upgrade |
Especifica o modo de uma atualização para máquinas virtuais no conjunto de escala. |
Upgrade |
Descreve uma política de atualização - automática, manual ou rolante. |
User |
Propriedades usadas para criar um usuário usado para executar Tarefas em um Nó de Computação em Lote do Azure. |
User |
A definição da identidade do usuário sob a qual a Tarefa é executada. |
Virtual |
A configuração para nós de computação em um pool com base na infraestrutura de máquinas virtuais do Azure. |
VMDisk |
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. |
VMExtension |
A configuração para extensões de máquina virtual. |
Windows |
Configurações do sistema operacional Windows a serem aplicadas à máquina virtual. |
Windows |
Propriedades usadas para criar uma conta de usuário em um nó de computação do Windows. |
AccessScope
Os recursos de lote aos quais o token concede acesso.
Name | Tipo | Description |
---|---|---|
job |
string |
Concede acesso para executar todas as operações no Trabalho que contém a Tarefa. |
ApplicationPackageReference
Uma referência a um pacote a ser implantado em nós de computação.
Name | Tipo | Description |
---|---|---|
applicationId |
string |
A ID do aplicativo a ser implantado. |
version |
string |
A versão do aplicativo a ser implantado. Se omitida, a versão padrão será implantada. |
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 |
Os recursos de lote aos quais o token concede acesso. |
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. |
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. |
AutoPoolSpecification
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 exclusivo quando um Pool é criado automaticamente. |
keepAlive |
boolean |
Se deve manter um pool automático vivo depois que sua vida útil expirar. |
pool |
A especificação do Pool para o pool automático. |
|
poolLifetimeOption |
O tempo de vida mínimo dos Pools automáticos criados e como vários Trabalhos em uma agenda são atribuídos aos Pools. |
AutoUserScope
O escopo para o usuário automático
Name | Tipo | Description |
---|---|---|
pool |
string |
Especifica que a Tarefa é executada como a Conta de usuário automático comum que é criada em cada Nó de Computação em um Pool. |
task |
string |
Especifica que o serviço deve criar um novo usuário para a Tarefa. |
AutoUserSpecification
Especifica os parâmetros para o usuário automático que executa uma tarefa no serviço em lote.
Name | Tipo | Description |
---|---|---|
elevationLevel |
O nível de elevação do usuário automático. |
|
scope |
O escopo para o usuário automático |
AzureBlobFileSystemConfiguration
Informações usadas para se conectar a um Contêiner de Armazenamento do Azure usando Blobfuse.
Name | Tipo | Description |
---|---|---|
accountKey |
string |
A chave da Conta de Armazenamento do Azure. |
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. |
containerName |
string |
O nome do Contêiner de Armazenamento de Blob do Azure. |
identityReference |
A referência à identidade atribuída ao usuário a ser usada para acessar containerName |
|
relativeMountPath |
string |
O caminho relativo no nó de computação onde o sistema de arquivos será montado |
sasKey |
string |
O token SAS do Armazenamento do Azure. |
AzureFileShareConfiguration
Informações usadas para se conectar a um compartilhamento de arquivos do Azure.
Name | Tipo | Description |
---|---|---|
accountKey |
string |
A chave da conta do Armazenamento do Azure. |
accountName |
string |
O nome da conta de Armazenamento do Azure. |
azureFileUrl |
string |
A URL dos Arquivos do Azure. |
mountOptions |
string |
Opções de linha de comando adicionais para passar para o comando mount. |
relativeMountPath |
string |
O caminho relativo no nó de computação onde o sistema de arquivos será montado |
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 |
Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário. |
|
values |
Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro. |
BatchErrorDetail
Um item de informações adicionais incluído em uma resposta de erro 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. |
CachingType
O tipo de cache a ser habilitado para o disco.
Name | Tipo | Description |
---|---|---|
none |
string |
O modo de cache para o disco não está habilitado. |
readonly |
string |
O modo de cache para o disco é somente leitura. |
readwrite |
string |
O modo de cache para o disco é leitura e gravação. |
CertificateReference
Uma referência a um certificado a ser instalado em nós de computação em um pool.
Name | Tipo | Description |
---|---|---|
storeLocation |
O local do armazenamento de certificados no nó de computação no qual instalar o certificado. |
|
storeName |
string |
O nome do armazenamento de certificados no nó de computação no qual instalar o certificado. |
thumbprint |
string |
A impressão digital do Certificado. |
thumbprintAlgorithm |
string |
O algoritmo ao qual a impressão digital está associada. Isso deve ser sha1. |
visibility |
Quais Contas de usuário no Nó de Computação devem ter acesso aos dados privados do Certificado. |
CertificateStoreLocation
O local do armazenamento de certificados no nó de computação no qual instalar o certificado.
Name | Tipo | Description |
---|---|---|
currentuser |
string |
Os certificados devem ser instalados no repositório de certificados CurrentUser. |
localmachine |
string |
Os certificados devem ser instalados no armazenamento de certificados LocalMachine. |
CertificateVisibility
Quais Contas de usuário no Nó de Computação devem ter acesso aos dados privados do Certificado.
Name | Tipo | Description |
---|---|---|
remoteuser |
string |
O Certificado deve estar visível para as contas de usuário sob as quais os usuários acessam remotamente o Nó de Computação. |
starttask |
string |
O certificado deve estar visível para a conta de usuário sob a qual o StartTask é executado. Observe que, se o Escopo do Usuário Automático for Pool para StartTask e uma Tarefa, esse certificado também ficará visível para a Tarefa. |
task |
string |
O Certificado deve estar visível para as contas de usuário sob as quais as Tarefas de Trabalho são executadas. |
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. |
password |
string |
A senha a ser usada para autenticação no sistema de arquivos CIFS. |
relativeMountPath |
string |
O caminho relativo no nó de computação onde o sistema de arquivos será montado |
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. |
CloudJob
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 |
|
commonEnvironmentSettings |
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). |
||
constraints |
As restrições de execução para o trabalho. |
||
creationTime |
string |
O tempo de criação do Job. |
|
displayName |
string |
O nome para exibição do trabalho. |
|
eTag |
string |
O ETag do Trabalho. |
|
executionInfo |
As informações de execução para o trabalho. |
||
id |
string |
Uma cadeia de caracteres que identifica exclusivamente o Trabalho dentro da Conta. |
|
jobManagerTask |
Detalhes de uma Tarefa do Gerenciador de Tarefas a ser iniciada quando a Tarefa for iniciada. |
||
jobPreparationTask |
A Tarefa de Preparação do Trabalho. |
||
jobReleaseTask |
A tarefa de liberação de trabalho. |
||
lastModified |
string |
A última hora modificada do Job. |
|
maxParallelTasks |
integer |
-1 |
O número máximo de tarefas que podem ser executadas em paralelo para o trabalho. |
metadata |
Uma lista de pares nome-valor associados ao Job como metadados. |
||
networkConfiguration |
A configuração de rede para o trabalho. |
||
onAllTasksComplete |
A ação que o serviço em lote deve executar quando todas as tarefas no trabalho estiverem no estado concluído. |
||
onTaskFailure |
A ação que o serviço em lote deve executar quando qualquer tarefa no trabalho falhar. |
||
poolInfo |
As configurações do Pool associadas ao Trabalho. |
||
previousState |
O estado anterior do Jó. |
||
previousStateTransitionTime |
string |
O momento em que o Job entrou em seu estado anterior. |
|
priority |
integer |
A prioridade do Trabalho. |
|
state |
O estado atual do Job. |
||
stateTransitionTime |
string |
O momento em que o Job entrou em seu estado atual. |
|
stats |
Estatísticas de uso de recursos para todo o tempo de vida do trabalho. |
||
url |
string |
A URL do trabalho. |
|
usesTaskDependencies |
boolean |
Se as Tarefas no Trabalho podem definir dependências entre si. O padrão é false. |
ComputeNodeFillType
Como as tarefas são distribuídas entre nós de computação em um pool.
Name | Tipo | Description |
---|---|---|
pack |
string |
O maior número possível de Tarefas (taskSlotsPerNode) deve ser atribuído a cada Nó de Computação no Pool antes que qualquer Tarefa seja atribuída ao próximo Nó de Computação no Pool. |
spread |
string |
As tarefas devem ser atribuídas uniformemente em todos os nós de computação no pool. |
ComputeNodeIdentityReference
A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará.
Name | Tipo | Description |
---|---|---|
resourceId |
string |
O ID de recurso ARM da identidade atribuída ao usuário. |
ContainerConfiguration
A configuração para pools habilitados para contêiner.
Name | Tipo | Description |
---|---|---|
containerImageNames |
string[] |
A coleção de nomes de imagem de contêiner. |
containerRegistries |
Registos privados adicionais dos quais os contentores podem ser retirados. |
|
type |
A tecnologia de contentores a utilizar. |
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). |
source |
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.
Name | Tipo | Description |
---|---|---|
Applications |
string |
O caminho dos aplicativos. |
JobPrep |
string |
O caminho da tarefa de preparação para o trabalho. |
Shared |
string |
O caminho para a tarefa de várias instâncias compartilhar seus arquivos. |
Startup |
string |
O caminho para iniciar a tarefa. |
Task |
string |
O caminho da tarefa. |
VfsMounts |
string |
O caminho contém todos os sistemas de arquivos virtuais montados neste nó. |
ContainerRegistry
Um registro de contêiner privado.
Name | Tipo | Description |
---|---|---|
identityReference |
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 |
A palavra-passe para iniciar sessão no servidor de registo. |
registryServer |
string |
O URL do registo. |
username |
string |
O nome de utilizador para iniciar sessão no servidor de registo. |
ContainerType
A tecnologia de contentores a utilizar.
Name | Tipo | Description |
---|---|---|
criCompatible |
string |
Uma tecnologia baseada em CRI será usada para lançar os contêineres. |
dockerCompatible |
string |
Uma tecnologia de contêiner compatível com Docker será usada para iniciar os contêineres. |
ContainerWorkingDirectory
O local do diretório de trabalho da tarefa do contêiner.
Name | Tipo | Description |
---|---|---|
containerImageDefault |
string |
Use o diretório de trabalho definido na imagem do contêiner. Tenha cuidado que este diretório não conterá os arquivos de recursos baixados pelo lote. |
taskWorkingDirectory |
string |
Use o diretório de trabalho padrão Tarefa do serviço em lote, que conterá os arquivos de recursos da tarefa preenchidos por lote. |
DataDisk
Configurações que serão usadas pelos discos de dados associados aos nós de computação no pool. Ao usar discos de dados anexados, você precisa montar e formatar os discos de dentro de uma VM para usá-los.
Name | Tipo | Description |
---|---|---|
caching |
O tipo de cache a ser habilitado para os discos de dados. |
|
diskSizeGB |
integer |
O tamanho inicial do disco em gigabytes. |
lun |
integer |
O número da unidade lógica. |
storageAccountType |
O tipo de conta de armazenamento a ser usado para o disco de dados. |
DiffDiskPlacement
Especifica o posicionamento efêmero do disco do sistema operacional para todos os nós de computação (VMs) no pool.
Name | Tipo | Description |
---|---|---|
CacheDisk |
string |
O disco do sistema operacional efêmero é armazenado no cache da VM. |
DiffDiskSettings
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 |
Especifica o posicionamento efêmero do disco do sistema operacional para todas as VMs no pool. |
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 |
---|---|---|
targets |
A lista de destinos de disco do Serviço em Lote será criptografada no nó de computação. |
DiskEncryptionTarget
A lista de destinos de disco do Serviço em Lote será criptografada no nó de computação.
Name | Tipo | Description |
---|---|---|
osdisk |
string |
O disco do sistema operacional no nó de computação é criptografado. |
temporarydisk |
string |
O disco temporário no nó de computação é criptografado. No Linux, essa criptografia se aplica a outras partições (como aquelas em discos de dados montados) quando a criptografia ocorre no momento da inicialização. |
DynamicVNetAssignmentScope
O escopo da atribuição dinâmica de vnet.
Name | Tipo | Description |
---|---|---|
job |
string |
A atribuição de VNet dinâmica é feita por trabalho. |
none |
string |
Nenhuma atribuição de VNet dinâmica está habilitada. |
ElevationLevel
O nível de elevação do usuário.
Name | Tipo | Description |
---|---|---|
admin |
string |
O usuário é um usuário com acesso elevado e opera com permissões completas de administrador. |
nonadmin |
string |
O usuário é um usuário padrão sem acesso elevado. |
EnvironmentSetting
Uma variável de ambiente a ser definida em um processo Task.
Name | Tipo | Description |
---|---|---|
name |
string |
O nome da variável de ambiente. |
value |
string |
O valor da variável de ambiente. |
ErrorCategory
A categoria do erro.
Name | Tipo | Description |
---|---|---|
servererror |
string |
O erro é devido a um problema interno do servidor. |
usererror |
string |
O erro é devido a um problema do usuário, como configuração incorreta. |
ErrorMessage
Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
Name | Tipo | Description |
---|---|---|
lang |
string |
O código de idioma da mensagem de erro |
value |
string |
O texto da mensagem. |
HttpHeader
Um par nome-valor de cabeçalho HTTP
Name | Tipo | Description |
---|---|---|
name |
string |
O nome do cabeçalho que não diferencia maiúsculas de minúsculas a ser usado durante o upload de arquivos de saída |
value |
string |
O valor do cabeçalho a ser usado durante o upload de arquivos de saída |
ImageReference
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 Lote do Azure, consulte a operação 'Listar imagens suportadas'.
Name | Tipo | Description |
---|---|---|
communityGalleryImageId |
string |
O identificador exclusivo da imagem da galeria da comunidade |
exactVersion |
string |
A versão específica da imagem da plataforma ou imagem do mercado usada para criar o nó. Este campo somente leitura difere de 'version' somente se o valor especificado para 'version' quando o pool foi criado era 'mais recente'. |
offer |
string |
O tipo de oferta da Imagem do Azure Virtual Machines Marketplace. |
publisher |
string |
O editor da Imagem do Azure Virtual Machines Marketplace. |
sharedGalleryImageId |
string |
O identificador exclusivo da imagem da galeria compartilhada |
sku |
string |
A SKU da imagem do Azure Virtual Machines Marketplace. |
version |
string |
A versão da Imagem do Azure Virtual Machines Marketplace. |
virtualMachineImageId |
string |
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 essa ID de imagem. Este é o formato /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} ou /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} para sempre padronizar a versão de imagem mais recente. |
InboundEndpointProtocol
O protocolo do ponto de extremidade.
Name | Tipo | Description |
---|---|---|
tcp |
string |
Use TCP para o ponto de extremidade. |
udp |
string |
Use UDP para o ponto de extremidade. |
InboundNATPool
Um pool NAT de entrada que pode ser usado para endereçar portas específicas em nós de computação em um pool de lotes externamente.
Name | Tipo | Description |
---|---|---|
backendPort |
integer |
O número da porta no nó de computação. |
frontendPortRangeEnd |
integer |
O último número de porta no intervalo de portas externas que serão usadas para fornecer acesso de entrada à porta de back-end em nós de computação individuais. |
frontendPortRangeStart |
integer |
O primeiro número de porta no intervalo de portas externas que serão usadas para fornecer acesso de entrada à porta de back-end em nós de computação individuais. |
name |
string |
O nome do ponto de extremidade. |
networkSecurityGroupRules |
Uma lista de regras de grupo de segurança de rede que serão aplicadas ao ponto de extremidade. |
|
protocol |
O protocolo do ponto de extremidade. |
IPAddressProvisioningType
O tipo de provisionamento para endereços IP públicos para o pool.
Name | Tipo | Description |
---|---|---|
batchmanaged |
string |
Um IP público será criado e gerenciado pelo Batch. Pode haver vários IPs públicos, dependendo do tamanho do Pool. |
nopublicipaddresses |
string |
Nenhum endereço IP público será criado. |
usermanaged |
string |
IPs públicos são fornecidos pelo usuário e serão usados para provisionar os nós de computação. |
JobConstraints
As restrições de execução de um Trabalho.
Name | Tipo | Description |
---|---|---|
maxTaskRetryCount |
integer |
O número máximo de vezes que cada Tarefa pode ser repetida. O serviço de lote tenta novamente uma tarefa se seu código de saída for diferente de zero. |
maxWallClockTime |
string |
O tempo máximo decorrido que o Trabalho pode ser executado, medido a partir do momento em que o Trabalho é criado. |
JobExecutionInformation
Contém informações sobre a execução de um Trabalho no serviço Batch do Azure.
Name | Tipo | Description |
---|---|---|
endTime |
string |
O tempo de conclusão do trabalho. |
poolId |
string |
A ID do Pool ao qual este Trabalho está atribuído. |
schedulingError |
Detalhes de qualquer erro encontrado pelo serviço ao iniciar o trabalho. |
|
startTime |
string |
A hora de início do trabalho. |
terminateReason |
string |
Uma cadeia de caracteres que descreve o motivo pelo qual o trabalho terminou. |
JobManagerTask
Especifica os detalhes de uma Tarefa do Gerenciador de Tarefas.
Name | Tipo | Description |
---|---|---|
allowLowPriorityNode |
boolean |
Se a tarefa do gerenciador de tarefas pode ser executada em um nó de computação local/de baixa prioridade. |
applicationPackageReferences |
Uma lista de pacotes de aplicativos que o serviço em lote implantará no nó de computação antes de executar a linha de comando. |
|
authenticationTokenSettings |
As configurações de um token de autenticação que a Tarefa pode usar para executar operações de serviço em lote. |
|
commandLine |
string |
A linha de comando da Tarefa do Gerenciador de Tarefas. |
constraints |
Restrições que se aplicam à Tarefa do Gerenciador de Tarefas. |
|
containerSettings |
As configurações do contêiner sob o qual a Tarefa do Gerenciador de Tarefas é executada. |
|
displayName |
string |
O nome para exibição da Tarefa do Gerenciador de Tarefas. |
environmentSettings |
Uma lista de configurações de variáveis de ambiente para a tarefa do Gerenciador de tarefas. |
|
id |
string |
Uma cadeia de caracteres que identifica exclusivamente a Tarefa do Gerenciador de Tarefas dentro do Trabalho. |
killJobOnCompletion |
boolean |
Se a conclusão da Tarefa do Gerenciador de Tarefas significa a conclusão de todo o Trabalho. |
outputFiles |
Uma lista de arquivos que o serviço Batch carregará do nó de computação depois de executar a linha de comando. |
|
requiredSlots |
integer |
O número de slots de agendamento que a Tarefa requer para ser executada. |
resourceFiles |
Uma lista de arquivos que o serviço em lote baixará para o nó de computação antes de executar a linha de comando. |
|
runExclusive |
boolean |
Se a tarefa do Job Manager requer o uso exclusivo do nó de computação onde é executada. |
userIdentity |
A identidade do usuário sob a qual a Tarefa do Gerenciador de Tarefas é executada. |
JobNetworkConfiguration
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. |
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. |
JobPreparationTask
Uma Tarefa de Preparação de Trabalho a ser executada antes de qualquer Tarefa do Trabalho em qualquer Nó de Computação.
Name | Tipo | Description |
---|---|---|
commandLine |
string |
A linha de comando da Tarefa de Preparação de Trabalho. |
constraints |
Restrições que se aplicam à Tarefa de Preparação de Trabalho. |
|
containerSettings |
As configurações do contêiner sob o qual a Tarefa de Preparação de Trabalho é executada. |
|
environmentSettings |
Uma lista de configurações de variáveis de ambiente para a Tarefa de Preparação de Trabalho. |
|
id |
string |
Uma cadeia de caracteres que identifica exclusivamente a Tarefa de Preparação de Trabalho dentro do Trabalho. |
rerunOnNodeRebootAfterSuccess |
boolean |
Se o serviço em lote deve executar novamente a tarefa de preparação de trabalho após a reinicialização de um nó de computação. |
resourceFiles |
Uma lista de arquivos que o serviço em lote baixará para o nó de computação antes de executar a linha de comando. |
|
userIdentity |
A identidade do usuário sob a qual a Tarefa de Preparação de Trabalho é executada. |
|
waitForSuccess |
boolean |
Se o serviço em lote deve aguardar a conclusão bem-sucedida da tarefa de preparação do trabalho antes de agendar quaisquer outras tarefas do trabalho no nó de computação. Uma Tarefa de Preparação de Trabalho foi concluída com êxito se sair com o código de saída 0. |
JobReleaseTask
Uma Tarefa de Liberação de Trabalho a ser executada na conclusão do Trabalho em qualquer Nó de Computação em que o Trabalho tenha sido executado.
Name | Tipo | Description |
---|---|---|
commandLine |
string |
A linha de comando da Tarefa de Liberação de Trabalho. |
containerSettings |
As configurações do contêiner sob o qual a Tarefa de Liberação de Trabalho é executada. |
|
environmentSettings |
Uma lista de configurações de variáveis de ambiente para a Tarefa de Liberação de Trabalho. |
|
id |
string |
Uma cadeia de caracteres que identifica exclusivamente a Tarefa de Liberação de Trabalho dentro do Trabalho. |
maxWallClockTime |
string |
O tempo máximo decorrido que a Tarefa de Liberação de Trabalho pode ser executada em um determinado Nó de Computação, medido a partir do momento em que a Tarefa é iniciada. Se a Tarefa não for concluída dentro do prazo, o serviço em lote a encerrará. O valor padrão é 15 minutos. Não é possível especificar um tempo limite superior a 15 minutos. Se o fizer, o serviço Batch rejeita-o com um erro; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação incorreta). |
resourceFiles |
Uma lista de arquivos que o serviço 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. |
|
retentionTime |
string |
O tempo mínimo para reter o diretório de tarefas para a tarefa de liberação de trabalho no nó de computação. Após esse tempo, o serviço de lote pode excluir o diretório de tarefas e todo o seu conteúdo. |
userIdentity |
A identidade do usuário sob a qual a Tarefa de Liberação de Trabalho é executada. |
JobSchedulingError
Um erro encontrado pelo serviço de lote ao agendar um trabalho.
Name | Tipo | Description |
---|---|---|
category |
A categoria do erro de agendamento de trabalho. |
|
code |
string |
Um identificador para o erro de agendamento de trabalho. Os códigos são invariantes e destinam-se a ser consumidos programaticamente. |
details |
Uma lista de detalhes de erro adicionais relacionados ao erro de agendamento. |
|
message |
string |
Uma mensagem descrevendo o erro de agendamento de trabalho, destinado a ser adequado para exibição em uma interface do usuário. |
JobState
O estado do Jó.
Name | Tipo | Description |
---|---|---|
active |
string |
O Trabalho está disponível para ter Tarefas agendadas. |
completed |
string |
Todas as Tarefas foram encerradas e o sistema não aceitará mais Tarefas ou quaisquer outras alterações no Trabalho. |
deleting |
string |
Um usuário solicitou que o trabalho fosse excluído, mas a operação de exclusão ainda está em andamento (por exemplo, porque o sistema ainda está encerrando a execução de tarefas). |
disabled |
string |
Um usuário desativou o trabalho. Nenhuma Tarefa está em execução e nenhuma nova Tarefa será agendada. |
disabling |
string |
Um usuário solicitou que o Trabalho fosse desativado, mas a operação de desativação ainda está em andamento (por exemplo, aguardando o encerramento das Tarefas). |
enabling |
string |
Um usuário solicitou que o trabalho fosse habilitado, mas a operação de habilitação ainda está em andamento. |
terminating |
string |
O Trabalho está prestes a ser concluído, seja porque uma Tarefa do Gerenciador de Tarefas foi concluída ou porque o usuário encerrou o Trabalho, mas a operação de encerramento ainda está em andamento (por exemplo, porque as Tarefas de Liberação de Trabalho estão em execução). |
JobStatistics
Estatísticas de uso de recursos para um trabalho.
Name | Tipo | Description |
---|---|---|
kernelCPUTime |
string |
O tempo total de CPU do modo kernel (somado em todos os núcleos e todos os nós de computação) consumido por todas as tarefas no trabalho. |
lastUpdateTime |
string |
A hora em que as estatísticas foram atualizadas pela última vez. Todas as estatísticas são limitadas ao intervalo entre startTime e lastUpdateTime. |
numFailedTasks |
integer |
O número total de Tarefas no Trabalho que falharam durante o intervalo de tempo determinado. |
numSucceededTasks |
integer |
O número total de Tarefas concluídas com êxito no Trabalho durante o intervalo de tempo determinado. |
numTaskRetries |
integer |
O número total de novas tentativas em todas as Tarefas no Trabalho durante o intervalo de tempo determinado. |
readIOGiB |
number |
A quantidade total de dados em GiB lidos do disco por todas as Tarefas no Trabalho. |
readIOps |
integer |
O número total de operações de leitura de disco feitas por todas as Tarefas no Trabalho. |
startTime |
string |
A hora de início do intervalo de tempo coberto pelas estatísticas. |
url |
string |
O URL das estatísticas. |
userCPUTime |
string |
O tempo total de CPU do modo de usuário (somado em todos os núcleos e todos os nós de computação) consumido por todas as tarefas no trabalho. |
waitTime |
string |
O tempo total de espera de todas as tarefas no trabalho. |
wallClockTime |
string |
O tempo total do relógio de parede de todas as tarefas no trabalho. |
writeIOGiB |
number |
A quantidade total de dados em GiB gravados em disco por todas as tarefas no trabalho. |
writeIOps |
integer |
O número total de operações de gravação em disco feitas por todas as Tarefas no Trabalho. |
LinuxUserConfiguration
Propriedades usadas para criar uma conta de usuário em um nó de computação Linux.
Name | Tipo | Description |
---|---|---|
gid |
integer |
O ID de grupo para a conta de usuário. |
sshPrivateKey |
string |
A chave privada SSH para a conta do usuário. |
uid |
integer |
O ID de usuário da conta de usuário. |
LoginMode
O modo de login para o usuário
Name | Tipo | Description |
---|---|---|
batch |
string |
O LOGON32_LOGON_BATCH modo de login do Win32. O modo de login em lote é recomendado para processos paralelos de longa execução. |
interactive |
string |
O LOGON32_LOGON_INTERACTIVE modo de login do Win32. O UAC está habilitado em Pools do Windows. Se essa opção for usada com uma identidade de usuário elevada em um Pool do Windows, a sessão do usuário não será elevada, a menos que o aplicativo executado pela linha de comando Tarefa esteja configurado para sempre exigir privilégio administrativo ou sempre exigir privilégio máximo. |
ManagedDisk
Name | Tipo | Description |
---|---|---|
securityProfile |
Especifica as configurações de perfil de segurança para o disco gerenciado. |
|
storageAccountType |
O tipo de conta de armazenamento para disco gerenciado. |
MetadataItem
Um par nome-valor associado a um recurso de serviço em lote.
Name | Tipo | Description |
---|---|---|
name |
string |
O nome do item de metadados. |
value |
string |
O valor do item de metadados. |
MountConfiguration
O sistema de arquivos a ser montado em cada nó.
Name | Tipo | Description |
---|---|---|
azureBlobFileSystemConfiguration |
O Contêiner de Armazenamento do Azure a ser montado usando o blob FUSE em cada nó. |
|
azureFileShareConfiguration |
O Compartilhamento de Arquivos do Azure a ser montado em cada nó. |
|
cifsMountConfiguration |
O sistema de arquivos CIFS/SMB a ser montado em cada nó. |
|
nfsMountConfiguration |
O sistema de arquivos NFS a ser montado em cada nó. |
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 |
O escopo da atribuição dinâmica de vnet. |
|
enableAcceleratedNetworking |
boolean |
Se esse pool deve permitir a rede acelerada. |
endpointConfiguration |
A configuração para pontos de extremidade em nós de computação no pool de lotes. |
|
publicIPAddressConfiguration |
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 de rede virtual à qual os nós de computação do pool entrarão. Este é o formato /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. |
NetworkSecurityGroupRule
Uma regra de grupo de segurança de rede a ser aplicada a um ponto de extremidade de entrada.
Name | Tipo | Description |
---|---|---|
access |
A ação que deve ser tomada para um endereço IP, intervalo de sub-rede ou tag especificado. |
|
priority |
integer |
A prioridade para esta regra. |
sourceAddressPrefix |
string |
O prefixo do endereço de origem ou a tag a ser correspondida para a regra. |
sourcePortRanges |
string[] |
A porta de origem varia para corresponder à regra. |
NetworkSecurityGroupRuleAccess
A ação que deve ser tomada para um endereço IP, intervalo de sub-rede ou tag especificado.
Name | Tipo | Description |
---|---|---|
allow |
string |
Permitir acesso. |
deny |
string |
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. |
relativeMountPath |
string |
O caminho relativo no nó de computação onde o sistema de arquivos será montado |
source |
string |
O URI do sistema de arquivos a ser montado. |
NodeCommunicationMode
Determina como um pool se comunica com o serviço de lote.
Name | Tipo | Description |
---|---|---|
classic |
string |
Os nós que usam o modo de comunicação clássico exigem comunicação TCP de entrada nas portas 29876 e 29877 do "BatchNodeManagement. {region}" e comunicação TCP de saída na porta 443 para "Storage.region" e "BatchNodeManagement. {region}" tags de serviço. |
default |
string |
O modo de comunicação do nó é definido automaticamente pelo serviço Batch. |
simplified |
string |
Os nós que usam o modo de comunicação simplificado requerem comunicação TCP de saída na porta 443 para o "BatchNodeManagement. {region}" etiqueta de serviço. Não são necessárias portas de entrada abertas. |
NodePlacementConfiguration
Configuração de posicionamento de nó para um pool.
Name | Tipo | Description |
---|---|---|
policy |
Tipo de política de posicionamento de nó em Batch Pools. |
NodePlacementPolicyType
A política de posicionamento para alocar nós no pool.
Name | Tipo | Description |
---|---|---|
regional |
string |
Todos os nós no pool serão alocados na mesma região. |
zonal |
string |
Os nós no pool serão distribuídos por diferentes zonas de disponibilidade com o melhor balanceamento de esforço. |
OnAllTasksComplete
A ação que o serviço em lote deve executar quando todas as tarefas no trabalho estiverem no estado concluído.
Name | Tipo | Description |
---|---|---|
noaction |
string |
Não faça nada. O Trabalho permanece ativo, a menos que seja encerrado ou desativado por algum outro meio. |
terminatejob |
string |
Encerre o trabalho. O Job's terminateReason está definido como 'AllTasksComplete'. |
OnTaskFailure
A ação que o serviço em lote deve executar quando qualquer tarefa no trabalho falhar.
Name | Tipo | Description |
---|---|---|
noaction |
string |
Não faça nada. O Trabalho permanece ativo, a menos que seja encerrado ou desativado por algum outro meio. |
performexitoptionsjobaction |
string |
Execute a ação associada à condição de saída da tarefa na coleção exitConditions da tarefa. (Isso ainda pode resultar em nenhuma ação sendo tomada, se for isso que a Tarefa especifica.) |
OSDisk
Configurações para o disco do sistema operacional do nó de computação (VM).
Name | Tipo | Description |
---|---|---|
caching |
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 |
O tamanho inicial do disco em GB ao criar um novo disco do sistema operacional. |
ephemeralOSDiskSettings |
Especifica as configurações de disco efêmeras para o disco do sistema operacional usado pelo nó de computação (VM). |
|
managedDisk |
Os parâmetros do disco gerenciado. |
|
writeAcceleratorEnabled |
boolean |
Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco. |
OutputFile
Uma especificação para carregar arquivos de um Nó de Computação em Lote do Azure para outro local depois que o serviço de Lote concluir a execução do processo de Tarefa.
Name | Tipo | Description |
---|---|---|
destination |
O destino do(s) arquivo(s) de saída. |
|
filePattern |
string |
Um padrão que indica o(s) ficheiro(s) a carregar. |
uploadOptions |
Opções adicionais para a operação de carregamento, incluindo em que condições realizar o carregamento. |
OutputFileBlobContainerDestination
Especifica um destino de carregamento de arquivo em um contêiner de armazenamento de blob do Azure.
Name | Tipo | Description |
---|---|---|
containerUrl |
string |
A URL do contêiner no Armazenamento de Blobs do Azure para o qual carregar o(s) arquivo(s). |
identityReference |
A referência à identidade atribuída ao usuário a ser usada para acessar o Armazenamento de Blob do Azure especificado por containerUrl |
|
path |
string |
O blob de destino ou diretório virtual dentro do contêiner de Armazenamento do Azure. |
uploadHeaders |
Uma lista de pares nome-valor para cabeçalhos a serem usados no upload de arquivos de saída |
OutputFileDestination
O destino para o qual um arquivo deve ser carregado.
Name | Tipo | Description |
---|---|---|
container |
Um local no armazenamento de blob do Azure para o qual os arquivos são carregados. |
OutputFileUploadCondition
As condições sob as quais um arquivo de saída de tarefa ou conjunto de arquivos deve ser carregado.
Name | Tipo | Description |
---|---|---|
taskcompletion |
string |
Carregue o(s) arquivo(s) após a saída do processo de Tarefa, independentemente do código de saída. |
taskfailure |
string |
Carregue o(s) arquivo(s) somente depois que o processo de Tarefa for encerrado com um código de saída diferente de zero. |
tasksuccess |
string |
Carregue o(s) arquivo(s) somente depois que o processo de Tarefa sair com um código de saída de 0. |
OutputFileUploadOptions
Detalhes sobre uma operação de upload de arquivo de saída, incluindo em que condições executar o upload.
Name | Tipo | Description |
---|---|---|
uploadCondition |
As condições sob as quais o arquivo de saída da tarefa ou conjunto de arquivos deve ser carregado. |
PoolEndpointConfiguration
A configuração do ponto de extremidade para um Pool.
Name | Tipo | Description |
---|---|---|
inboundNATPools |
Uma lista de pools NAT de entrada que podem ser usados para endereçar portas específicas em um nó de computação individual externamente. |
PoolInformation
Especifica como um Trabalho deve ser atribuído a um Pool.
Name | Tipo | Description |
---|---|---|
autoPoolSpecification |
Características de um "pool automático" temporário. O serviço de lote criará esse pool automático quando o trabalho for enviado. |
|
poolId |
string |
A ID de um Pool existente. Todas as Tarefas do Trabalho serão executadas no Pool especificado. |
PoolLifetimeOption
O tempo de vida mínimo dos Pools automáticos criados e como vários Trabalhos em uma agenda são atribuídos aos Pools.
Name | Tipo | Description |
---|---|---|
job |
string |
A Piscina existe durante toda a vida do Trabalho a que se dedica. O serviço Batch cria o Pool quando cria o Job. Se a opção 'trabalho' for aplicada a uma Agenda de Trabalho, o serviço em lote criará um novo Pool automático para cada Trabalho criado na agenda. |
jobschedule |
string |
O Pool existe durante o tempo de vida do Cronograma de Trabalho. O Serviço de Lote cria o Pool quando cria o primeiro Trabalho na agenda. Pode aplicar esta opção apenas a Agendas de Trabalhos, não a Trabalhos. |
PoolSpecification
Especificação para a criação de um novo Pool.
Name | Tipo | Description |
---|---|---|
applicationPackageReferences |
A lista de pacotes a serem instalados em cada nó de computação no pool. |
|
autoScaleEvaluationInterval |
string |
O intervalo de tempo no qual ajustar automaticamente o tamanho do Pool de acordo com a fórmula de dimensionamento automático. |
autoScaleFormula |
string |
A fórmula para o número desejado de nós de computação no pool. |
certificateReferences |
Uma lista de certificados a serem instalados em cada nó de computação no pool. Aviso: Esta propriedade foi preterida e será removida após fevereiro de 2024. Em vez disso, use o |
|
displayName |
string |
O nome para exibição do Pool. |
enableAutoScale |
boolean |
Se o tamanho do Pool deve ser ajustado automaticamente ao longo do tempo. |
enableInterNodeCommunication |
boolean |
Se o Pool permite a comunicação direta entre nós de computação. |
metadata |
Uma lista de pares nome-valor associados ao Pool como metadados. |
|
mountConfiguration |
Uma lista de sistemas de arquivos a serem montados em cada nó do pool. |
|
networkConfiguration |
A configuração de rede para o Pool. |
|
resizeTimeout |
string |
O tempo limite para alocação de nós de computação para o pool. |
resourceTags |
object |
As tags especificadas pelo usuário associadas ao pool. |
startTask |
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 |
O número desejado de nós de computação dedicados no pool. |
targetLowPriorityNodes |
integer |
O número desejado de nós de computação spot/de baixa prioridade no pool. |
targetNodeCommunicationMode |
O modo de comunicação de nó desejado para o pool. |
|
taskSchedulingPolicy |
Como as tarefas são distribuídas entre nós de computação em um pool. |
|
taskSlotsPerNode |
integer |
O número de slots de tarefas que podem ser usados para executar tarefas simultâneas em um único nó de computação no pool. |
upgradePolicy |
A política de atualização para o pool. |
|
userAccounts |
A lista de Contas de usuário a serem criadas em cada Nó de Computação no Pool. |
|
virtualMachineConfiguration |
A configuração da máquina virtual para o Pool. |
|
vmSize |
string |
O tamanho das máquinas virtuais no Pool. Todas as máquinas virtuais em um Pool têm o mesmo tamanho. |
PublicIPAddressConfiguration
A configuração de endereço IP público da configuração de rede de um pool.
Name | Tipo | Description |
---|---|---|
ipAddressIds |
string[] |
A lista de IPs públicos que o serviço de lote usará ao provisionar nós de computação. |
provision |
O tipo de provisionamento para endereços IP públicos para o pool. |
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 contêiner de armazenamento na conta de armazenamento automático. |
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. |
fileMode |
string |
O atributo file permission mode em formato octal. |
filePath |
string |
O local no nó de computação para o qual baixar o(s) arquivo(s), relativo ao diretório de trabalho da tarefa. |
httpUrl |
string |
O URL do ficheiro a transferir. |
identityReference |
A referência à identidade atribuída ao usuário a ser usada para acessar o Armazenamento de Blob do Azure especificado por storageContainerUrl ou httpUrl |
|
storageContainerUrl |
string |
A URL do contêiner de blob no Armazenamento de Blob do Azure. |
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 |
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 |
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 |
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 |
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
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.
Name | Tipo | Description |
---|---|---|
NonPersistedTPM |
string |
|
VMGuestStateOnly |
string |
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. |
securityType |
Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings. |
|
uefiSettings |
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.
Name | Tipo | Description |
---|---|---|
confidentialVM |
string |
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. |
trustedLaunch |
string |
O lançamento confiável protege contra técnicas de ataque avançadas e persistentes. |
ServiceArtifactReference
Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de escala ao usar a versão de imagem 'mais recente'.
Name | Tipo | Description |
---|---|---|
id |
string |
A ID de referência de artefato de serviço de ServiceArtifactReference |
StartTask
Uma Tarefa que é executada quando um Nó ingressa em um Pool no serviço Lote do Azure ou quando o Nó de Computação é reinicializado ou recriado.
Name | Tipo | Description |
---|---|---|
commandLine |
string |
A linha de comando do StartTask. |
containerSettings |
As configurações para o contêiner sob o qual o StartTask é executado. |
|
environmentSettings |
Uma lista de configurações de variáveis de ambiente para o StartTask. |
|
maxTaskRetryCount |
integer |
O número máximo de vezes que a Tarefa pode ser repetida. |
resourceFiles |
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. |
|
userIdentity |
A identidade do usuário sob a qual o StartTask é executado. |
|
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. |
StorageAccountType
O tipo de conta de armazenamento para uso na criação de discos de dados ou disco do sistema operacional.
Name | Tipo | Description |
---|---|---|
premium_lrs |
string |
O disco de dados / disco do sistema operacional deve usar armazenamento premium localmente redundante. |
standard_lrs |
string |
O disco de dados / disco do sistema operacional deve usar armazenamento padrão localmente redundante. |
standardssd_lrs |
string |
O disco de dados / disco do sistema operacional deve usar armazenamento padrão SSD localmente redundante. |
TaskConstraints
Restrições de execução a serem aplicadas a uma Tarefa.
Name | Tipo | Description |
---|---|---|
maxTaskRetryCount |
integer |
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. |
maxWallClockTime |
string |
O tempo máximo decorrido que a Tarefa pode executar, medido a partir do momento em que a Tarefa é iniciada. Se a Tarefa não for concluída dentro do prazo, o serviço em lote a encerrará. |
retentionTime |
string |
O tempo mínimo para manter o diretório Task no Nó de Computação onde ele foi executado, a partir do momento em que ele conclui a execução. Após esse tempo, o serviço de lote pode excluir o diretório de tarefas e todo o seu conteúdo. |
TaskContainerSettings
As configurações de contêiner para uma Tarefa.
Name | Tipo | Description |
---|---|---|
containerHostBatchBindMounts |
Os caminhos que você deseja montar para a tarefa de contêiner. |
|
containerRunOptions |
string |
Opções adicionais para o comando container create. |
imageName |
string |
A Imagem a ser usada para criar o contêiner no qual a Tarefa será executada. |
registry |
O registro privado que contém a imagem do contêiner. |
|
workingDirectory |
O local do diretório de trabalho da tarefa do contêiner. |
TaskSchedulingPolicy
Especifica como as tarefas devem ser distribuídas entre nós de computação.
Name | Tipo | Description |
---|---|---|
nodeFillType |
Como as tarefas são distribuídas entre nós de computação em um pool. |
UefiSettings
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. |
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.
Name | Tipo | Description |
---|---|---|
automatic |
string |
Todas as máquinas virtuais no conjunto de escala são atualizadas automaticamente ao mesmo tempo. |
manual |
string |
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 |
string |
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 |
Parâmetros de configuração usados para executar a atualização automática do sistema operacional. |
|
mode |
Especifica o modo de uma atualização para máquinas virtuais no conjunto de escala. |
|
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 |
O nível de elevação da conta de usuário. |
|
linuxUserConfiguration |
A configuração de usuário específica do Linux para a conta de usuário. |
|
name |
string |
O nome da conta de usuário. Os nomes podem conter caracteres Unicode até um comprimento máximo de 20. |
password |
string |
A senha da conta de usuário. |
windowsUserConfiguration |
A configuração de usuário específica do Windows para a conta de usuário. |
UserIdentity
A definição da identidade do usuário sob a qual a Tarefa é executada.
Name | Tipo | Description |
---|---|---|
autoUser |
O usuário automático sob o qual a tarefa é executada. |
|
username |
string |
O nome da identidade do usuário sob a qual a Tarefa é executada. |
VirtualMachineConfiguration
A configuração para nós de computação em um pool com base na infraestrutura de máquinas virtuais do Azure.
Name | Tipo | Description |
---|---|---|
containerConfiguration |
A configuração do contêiner para o Pool. |
|
dataDisks |
Data |
A configuração para discos de dados anexados aos nós de computação no pool. |
diskEncryptionConfiguration |
A configuração de criptografia de disco para o pool. |
|
extensions |
A extensão de máquina virtual para o pool. |
|
imageReference |
Uma referência à Imagem do Azure Virtual Machines Marketplace ou à Imagem de Máquina Virtual personalizada a ser usada. |
|
licenseType |
string |
O tipo de licença local a ser usada ao implantar o sistema operacional. 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. |
nodePlacementConfiguration |
A configuração de posicionamento do nó para o pool. |
|
osDisk |
Configurações para o disco do sistema operacional da máquina virtual. |
|
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 |
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'. |
|
windowsConfiguration |
Configurações do sistema operacional Windows na máquina virtual. |
VMDiskSecurityProfile
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 |
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. |
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. |
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. |
WindowsUserConfiguration
Propriedades usadas para criar uma conta de usuário em um nó de computação do Windows.
Name | Tipo | Description |
---|---|---|
loginMode |
O modo de login para o usuário |