Job - Get
Obtém informações sobre o Trabalho especificado.
GET {batchUrl}/jobs/{jobId}?api-version=2023-11-01.18.0
GET {batchUrl}/jobs/{jobId}?$select={$select}&$expand={$expand}&timeout={timeout}&api-version=2023-11-01.18.0
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
batch
|
path | True |
string |
A URL base para todas as solicitações de serviço 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 de $expand OData. |
|
$select
|
query |
string |
Uma cláusula de $select OData. |
|
timeout
|
query |
integer int32 |
O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. |
Cabeçalho da solicitação
Media Types: "application/json; odata=minimalmetadata"
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
client-request-id |
string uuid |
A identidade de solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Se o servidor deve retornar a client-request-id na resposta. |
|
ocp-date |
string date-time-rfc1123 |
A hora em que a solicitação foi emitida. As bibliotecas de cliente normalmente definem isso como a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente. |
|
If-Match |
string |
Um valor de ETag associado à versão do recurso conhecido pelo cliente. A operação será executada somente se a ETag atual do recurso no serviço corresponder exatamente ao valor especificado pelo cliente. |
|
If-None-Match |
string |
Um valor de ETag associado à versão do recurso conhecido pelo cliente. A operação será executada somente se a ETag atual do recurso no serviço não corresponder ao valor especificado pelo cliente. |
|
If-Modified-Since |
string date-time-rfc1123 |
Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço tiver sido modificado desde a hora especificada. |
|
If-Unmodified-Since |
string date-time-rfc1123 |
Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço não tiver sido modificado desde a hora especificada. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Uma resposta que contém o Trabalho. Cabeçalhos
|
|
Other Status Codes |
O erro do serviço do Lote. |
Segurança
azure_auth
Microsoft Entra fluxo de código de autenticação OAuth 2.0
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome | Description |
---|---|
user_impersonation | Representar sua conta de usuário |
Authorization
Tipo:
apiKey
Em:
header
Exemplos
Job get
Solicitação de exemplo
GET account.region.batch.azure.com/jobs/jobId?api-version=2023-11-01.18.0
Resposta de exemplo
{
"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
Nome | Description |
---|---|
Access |
Os recursos do 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 do Lote. |
Auto |
Especifica características para um 'pool automático' temporário. O serviço lote criará esse pool automático quando o trabalho for enviado. |
Auto |
O escopo do usuário automático |
Auto |
Especifica os parâmetros para o usuário automático que executa uma Tarefa no serviço do Lote. |
Azure |
Informações usadas para se conectar a um Contêiner de Armazenamento do Azure usando o Blobfuse. |
Azure |
Informações usadas para se conectar a um compartilhamento de arquivos do Azure. |
Batch |
Uma resposta de erro recebida do serviço Lote do Azure. |
Batch |
Um item de informações adicionais incluído em uma resposta de erro 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 repositório 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 Lote do Azure. |
Cloud |
A configuração para nós de computação em um pool com base na plataforma de Serviços de Nuvem 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 pelo usuário associada ao pool do Lote que um nó de computação usará. |
Container |
A configuração para pools habilitados para contêineres. |
Container |
Um registro de contêiner privado. |
Container |
A tecnologia de contêiner a ser usada. |
Container |
O local do diretório de trabalho 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 de disco efêmero para o disco do sistema operacional para todos os nós de computação (VMs) no pool. |
Diff |
Especifica as Configurações de Disco efêmero 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. Não há suporte para a configuração de criptografia de disco no pool do Linux criado com a Imagem da Galeria de Computação do Azure. |
Disk |
A lista de destinos de disco serviço de lote criptografará no nó de computação. |
Dynamic |
O escopo da atribuição de vnet dinâmica. |
Elevation |
O nível de elevação do usuário. |
Environment |
Uma variável de ambiente a ser definida em um processo de Tarefa. |
Error |
A categoria do erro. |
Error |
Uma mensagem de erro recebida em uma resposta de erro Lote do Azure. |
Http |
Um par nome-valor de cabeçalho HTTP |
Image |
Uma referência a uma imagem do Azure Máquinas Virtuais Marketplace ou a uma imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de imagem Azure Marketplace verificadas por Lote do Azure, consulte a operação 'Listar Imagens Com Suporte'. |
Inbound |
O protocolo do ponto de extremidade. |
Inbound |
Um pool nat de entrada que pode ser usado para lidar com portas específicas em nós de computação em um pool de lote externamente. |
IPAddress |
O tipo de provisionamento para endereços IP públicos para o pool. |
Job |
As restrições de execução para um Trabalho. |
Job |
Contém informações sobre a execução de um trabalho no serviço Lote do Azure. |
Job |
Especifica os detalhes de uma tarefa do Gerenciador de Trabalhos. |
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 especificado. |
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 do Lote ao agendar um trabalho. |
Job |
O estado do Trabalho. |
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 do Linux. |
Login |
O modo de logon do usuário |
Managed |
|
Metadata |
Um par nome-valor associado a um recurso de serviço do 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 executada para um endereço IP, intervalo de sub-rede ou marca 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 do 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 lote deve executar quando todas as Tarefas no Trabalho estão no estado concluído. |
On |
A ação que o serviço lote deve executar quando qualquer Tarefa no Trabalho falha. |
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 Lote do Azure para outro local depois que o serviço do Lote terminar de executar o processo de Tarefa. |
Output |
Especifica um destino de upload de arquivo em um contêiner de armazenamento de blobs 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 da Tarefa ou um conjunto de arquivos devem ser carregados. |
Output |
Detalhes sobre uma operação de upload de arquivo de saída, incluindo sob quais 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 um agendamento são atribuídos a pools. |
Pool |
Especificação para criar um 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 em um Nó de Computação. |
Security |
Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais. |
Security |
Especifica o SecurityType da máquina virtual. Ele precisa 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 dimensionamento 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 de 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. |
User |
Propriedades usadas para criar um usuário usado para executar Tarefas em um nó de computação 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. |
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 do Lote aos quais o token concede acesso.
Nome | Tipo | Description |
---|---|---|
job |
string |
Concede acesso para executar todas as operações no Trabalho que contém a Tarefa. |
ApplicationPackageReference
Uma referência a um Pacote a ser implantado em Nós de Computação.
Nome | Tipo | Description |
---|---|---|
applicationId |
string |
A ID do aplicativo a ser implantado. |
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 do Lote.
Nome | Tipo | Description |
---|---|---|
access |
Os recursos do Lote aos quais o token concede acesso. |
AutoPoolSpecification
Especifica características para um 'pool automático' temporário. O serviço lote criará esse pool automático quando o trabalho for enviado.
Nome | Tipo | Description |
---|---|---|
autoPoolIdPrefix |
string |
Um prefixo a ser adicionado ao identificador exclusivo quando um Pool é criado automaticamente. |
keepAlive |
boolean |
Se um pool automático deve ser mantido vivo após a expiração de seu tempo de vida. |
pool |
A especificação pool para o pool automático. |
|
poolLifetimeOption |
O tempo de vida mínimo dos Pools automáticos criados e como vários Trabalhos em um agendamento são atribuídos aos Pools. |
AutoUserScope
O escopo do usuário automático
Nome | Tipo | Description |
---|---|---|
pool |
string |
Especifica que a Tarefa é executada como a conta de usuário automático comum que é criada em cada nó de computação em um pool. |
task |
string |
Especifica que o serviço deve criar um novo usuário para a Tarefa. |
AutoUserSpecification
Especifica os parâmetros para o usuário automático que executa uma Tarefa no serviço do Lote.
Nome | Tipo | Description |
---|---|---|
elevationLevel |
O nível de elevação do usuário automático. |
|
scope |
O escopo do usuário automático |
AzureBlobFileSystemConfiguration
Informações usadas para se conectar a um Contêiner de Armazenamento do Azure usando o Blobfuse.
Nome | Tipo | Description |
---|---|---|
accountKey |
string |
A chave da Conta de Armazenamento do Azure. |
accountName |
string |
O nome da Conta de Armazenamento do Azure. |
blobfuseOptions |
string |
Opções de linha de comando adicionais a serem passadas para o comando de montagem. |
containerName |
string |
O nome do contêiner Armazenamento de Blobs do Azure. |
identityReference |
A referência à identidade atribuída pelo usuário a ser usada para acessar containerName |
|
relativeMountPath |
string |
O caminho relativo no nó de computação em que 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.
Nome | Tipo | Description |
---|---|---|
accountKey |
string |
A chave de conta de Armazenamento do Microsoft Azure. |
accountName |
string |
O nome da conta do Armazenamento do Azure. |
azureFileUrl |
string |
A URL do Arquivos do Azure. |
mountOptions |
string |
Opções de linha de comando adicionais a serem passadas para o comando de montagem. |
relativeMountPath |
string |
O caminho relativo no nó de computação em que o sistema de arquivos será montado |
BatchError
Uma resposta de erro recebida do serviço Lote do Azure.
Nome | Tipo | Description |
---|---|---|
code |
string |
Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente. |
message |
Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário. |
|
values |
Uma coleção de pares chave-valor que contém detalhes adicionais sobre o erro. |
BatchErrorDetail
Um item de informações adicionais incluído em uma resposta de erro Lote do Azure.
Nome | Tipo | Description |
---|---|---|
key |
string |
Um identificador que especifica o significado da propriedade Value. |
value |
string |
As informações adicionais incluídas na resposta de erro. |
CachingType
O tipo de cache a ser habilitado para o disco.
Nome | Tipo | Description |
---|---|---|
none |
string |
O modo de cache do disco não está habilitado. |
readonly |
string |
O modo de cache do disco é somente leitura. |
readwrite |
string |
O modo de cache do disco é leitura e gravação. |
CertificateReference
Uma referência a um certificado a ser instalado em nós de computação em um pool.
Nome | Tipo | Description |
---|---|---|
storeLocation |
O local do repositório de certificados no Nó de Computação no qual instalar o Certificado. |
|
storeName |
string |
O nome do repositório 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 repositório de certificados no Nó de Computação no qual instalar o Certificado.
Nome | Tipo | Description |
---|---|---|
currentuser |
string |
Os certificados devem ser instalados no repositório de certificados CurrentUser. |
localmachine |
string |
Os certificados devem ser instalados no repositório de certificados LocalMachine. |
CertificateVisibility
Quais contas de usuário no nó de computação devem ter acesso aos dados privados do Certificado.
Nome | Tipo | Description |
---|---|---|
remoteuser |
string |
O Certificado deve estar visível para as contas de usuário nas quais os usuários acessam remotamente o Nó de Computação. |
starttask |
string |
O Certificado deve estar visível para a conta de usuário na qual o StartTask é executado. Observe que, se o Escopo do AutoUser for Pool para StartTask e uma Tarefa, esse certificado também ficará visível para a Tarefa. |
task |
string |
O Certificado deve estar visível para as contas de usuário nas quais as Tarefas de Trabalho são executadas. |
CIFSMountConfiguration
Informações usadas para se conectar a um sistema de arquivos CIFS.
Nome | Tipo | Description |
---|---|---|
mountOptions |
string |
Opções de linha de comando adicionais a serem passadas para o comando de montagem. |
password |
string |
A senha a ser usada para autenticação no sistema de arquivos CIFS. |
relativeMountPath |
string |
O caminho relativo no nó de computação em que o sistema de arquivos será montado |
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 Lote do Azure.
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
allowTaskPreemption |
boolean |
Se as tarefas neste trabalho podem ser preempcionadas por outros trabalhos de alta prioridade |
|
commonEnvironmentSettings |
A lista de configurações comuns de variáveis de ambiente. Essas variáveis de ambiente são definidas para todas as Tarefas no Trabalho (incluindo as tarefas Gerenciador de Trabalhos, Preparação do Trabalho e Liberação de Trabalho). |
||
constraints |
As restrições de execução para o Trabalho. |
||
creationTime |
string |
A hora de criação do Trabalho. |
|
displayName |
string |
O nome de exibição do Trabalho. |
|
eTag |
string |
A ETag do Trabalho. |
|
executionInfo |
As informações de execução do Trabalho. |
||
id |
string |
Uma cadeia de caracteres que identifica exclusivamente o Trabalho na Conta. |
|
jobManagerTask |
Detalhes de uma Tarefa do Gerenciador de Trabalhos a ser iniciada quando o Trabalho for iniciado. |
||
jobPreparationTask |
A Tarefa de Preparação do Trabalho. |
||
jobReleaseTask |
A tarefa De liberação do trabalho. |
||
lastModified |
string |
A hora da última modificação do Trabalho. |
|
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 Trabalho como metadados. |
||
networkConfiguration |
A configuração de rede para o Trabalho. |
||
onAllTasksComplete |
A ação que o serviço lote deve executar quando todas as Tarefas no Trabalho estão no estado concluído. |
||
onTaskFailure |
A ação que o serviço do Lote deve executar quando qualquer Tarefa no Trabalho falhar. |
||
poolInfo |
As configurações do Pool associadas ao Trabalho. |
||
previousState |
O estado anterior do Trabalho. |
||
previousStateTransitionTime |
string |
A hora em que o Trabalho inseriu seu estado anterior. |
|
priority |
integer |
A prioridade do Trabalho. |
|
state |
O estado atual do Trabalho. |
||
stateTransitionTime |
string |
A hora em que o Trabalho entrou em seu estado atual. |
|
stats |
Estatísticas de uso de recursos durante todo o tempo de vida do Trabalho. |
||
url |
string |
A URL do Trabalho. |
|
usesTaskDependencies |
boolean |
Se tarefas no trabalho podem definir dependências entre si. O padrão é false. |
CloudServiceConfiguration
A configuração para nós de computação em um pool com base na plataforma de Serviços de Nuvem do Azure.
Nome | Tipo | Description |
---|---|---|
osFamily |
string |
A família de so convidado do Azure a ser instalada nas máquinas virtuais no pool. |
osVersion |
string |
A versão do sistema operacional convidado do Azure a ser instalada nas máquinas virtuais no Pool. |
ComputeNodeFillType
Como as tarefas são distribuídas entre nós de computação em um pool.
Nome | Tipo | Description |
---|---|---|
pack |
string |
O maior número possível de tarefas (taskSlotsPerNode) deve ser atribuído a cada nó de computação no pool antes que qualquer Tarefa seja atribuída ao próximo Nó de Computação no Pool. |
spread |
string |
As tarefas devem ser atribuídas uniformemente em todos os Nós de Computação no Pool. |
ComputeNodeIdentityReference
A referência a uma identidade atribuída pelo usuário associada ao pool do Lote que um nó de computação usará.
Nome | Tipo | Description |
---|---|---|
resourceId |
string |
A ID de recurso do ARM da identidade atribuída pelo usuário. |
ContainerConfiguration
A configuração para pools habilitados para contêineres.
Nome | Tipo | Description |
---|---|---|
containerImageNames |
string[] |
A coleção de nomes de imagem do contêiner. |
containerRegistries |
Registros privados adicionais dos quais os contêineres podem ser extraídos. |
|
type |
A tecnologia de contêiner a ser usada. |
ContainerRegistry
Um registro de contêiner privado.
Nome | Tipo | Description |
---|---|---|
identityReference |
A referência à identidade atribuída pelo usuário a ser usada para acessar um Registro de Contêiner do Azure em vez de nome de usuário e senha. |
|
password |
string |
A senha para fazer logon no servidor do Registro. |
registryServer |
string |
A URL do registro. |
username |
string |
O nome de usuário para fazer logon no servidor do Registro. |
ContainerType
A tecnologia de contêiner a ser usada.
Nome | Tipo | Description |
---|---|---|
criCompatible |
string |
Uma tecnologia baseada em CRI será usada para iniciar os contêineres. |
dockerCompatible |
string |
Uma tecnologia de contêiner compatível com Docker será usada para iniciar os contêineres. |
ContainerWorkingDirectory
O local do diretório de trabalho tarefa do contêiner.
Nome | Tipo | Description |
---|---|---|
containerImageDefault |
string |
Use o diretório de trabalho definido na imagem do contêiner. Cuidado para que esse diretório não contenha os Arquivos de Recurso baixados pelo Lote. |
taskWorkingDirectory |
string |
Use o diretório de trabalho task do serviço lote padrão, que conterá os Arquivos de Recurso de Tarefa preenchidos pelo Lote. |
DataDisk
Configurações que serão usadas pelos discos de dados associados aos Nós de Computação no Pool. Ao usar discos de dados anexados, você precisa montar e formatar os discos de dentro de uma VM para usá-los.
Nome | Tipo | Description |
---|---|---|
caching |
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 de disco efêmero para o disco do sistema operacional para todos os nós de computação (VMs) no pool.
Nome | Tipo | Description |
---|---|---|
CacheDisk |
string |
O Disco do SO Efêmero é armazenado no cache da VM. |
DiffDiskSettings
Especifica as Configurações de Disco efêmero para o disco do sistema operacional usado pelo nó de computação (VM).
Nome | Tipo | Description |
---|---|---|
placement |
Especifica o posicionamento de disco efêmero para o 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. Não há suporte para a configuração de criptografia de disco no pool do Linux criado com a Imagem da Galeria de Computação do Azure.
Nome | Tipo | Description |
---|---|---|
targets |
A lista de destinos de disco Serviço de Lote será criptografada no nó de computação. |
DiskEncryptionTarget
A lista de destinos de disco serviço de lote criptografará no nó de computação.
Nome | Tipo | Description |
---|---|---|
osdisk |
string |
O disco do sistema operacional no nó de computação é criptografado. |
temporarydisk |
string |
O disco temporário no nó de computação é criptografado. No Linux, essa criptografia se aplica a outras partições (como aquelas em discos de dados montados) quando a criptografia ocorre no momento da inicialização. |
DynamicVNetAssignmentScope
O escopo da atribuição de vnet dinâmica.
Nome | Tipo | Description |
---|---|---|
job |
string |
A atribuição de VNet dinâmica é feita por trabalho. |
none |
string |
Nenhuma atribuição de VNet dinâmica está habilitada. |
ElevationLevel
O nível de elevação do usuário.
Nome | Tipo | Description |
---|---|---|
admin |
string |
O usuário é um usuário com acesso elevado e opera com permissões completas de Administrador. |
nonadmin |
string |
O usuário é um usuário padrão sem acesso elevado. |
EnvironmentSetting
Uma variável de ambiente a ser definida em um processo de Tarefa.
Nome | Tipo | Description |
---|---|---|
name |
string |
O nome da variável de ambiente. |
value |
string |
O valor da variável de ambiente. |
ErrorCategory
A categoria do erro.
Nome | Tipo | Description |
---|---|---|
servererror |
string |
O erro ocorre devido a um problema interno do servidor. |
usererror |
string |
O erro ocorre devido a um problema do usuário, como configuração incorreta. |
ErrorMessage
Uma mensagem de erro recebida em uma resposta de erro Lote do Azure.
Nome | Tipo | Description |
---|---|---|
lang |
string |
O código de idioma da mensagem de erro |
value |
string |
O texto da mensagem. |
HttpHeader
Um par nome-valor de cabeçalho HTTP
Nome | Tipo | Description |
---|---|---|
name |
string |
O nome que não diferencia maiúsculas de minúsculas do cabeçalho a ser usado durante o carregamento de arquivos de saída |
value |
string |
O valor do cabeçalho a ser usado durante o carregamento de arquivos de saída |
ImageReference
Uma referência a uma imagem do Azure Máquinas Virtuais Marketplace ou a uma imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de imagem Azure Marketplace verificadas por Lote do Azure, consulte a operação 'Listar Imagens Com Suporte'.
Nome | Tipo | Description |
---|---|---|
exactVersion |
string |
A versão específica da imagem da plataforma ou da imagem do marketplace usada para criar o nó. Esse campo somente leitura será diferente de "version" somente se o valor especificado para 'version' quando o pool foi criado for 'latest'. |
offer |
string |
O tipo de oferta da Imagem do Azure Máquinas Virtuais Marketplace. |
publisher |
string |
O editor da imagem do Azure Máquinas Virtuais Marketplace. |
sku |
string |
O SKU da imagem do Azure Máquinas Virtuais Marketplace. |
version |
string |
A versão da imagem do Azure Máquinas Virtuais Marketplace. |
virtualMachineImageId |
string |
O identificador de recurso do ARM da Imagem da Galeria de Computação do Azure. Nós de computação no pool serão criados usando essa ID de imagem. Isso é do formulário /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} ou /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} para sempre usar a versão mais recente da imagem. |
InboundEndpointProtocol
O protocolo do ponto de extremidade.
Nome | Tipo | Description |
---|---|---|
tcp |
string |
Use TCP para o ponto de extremidade. |
udp |
string |
Use UDP para o ponto de extremidade. |
InboundNATPool
Um pool nat de entrada que pode ser usado para lidar com portas específicas em nós de computação em um pool de lote externamente.
Nome | Tipo | Description |
---|---|---|
backendPort |
integer |
O número da porta no Nó de Computação. |
frontendPortRangeEnd |
integer |
O último número da porta no intervalo de portas externas que será usado para fornecer acesso de entrada ao backendPort em nós de computação individuais. |
frontendPortRangeStart |
integer |
O primeiro número da porta no intervalo de portas externas que será usado para fornecer acesso de entrada ao backendPort em nós de computação individuais. |
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.
Nome | Tipo | Description |
---|---|---|
batchmanaged |
string |
Um IP público será criado e gerenciado pelo Lote. Pode haver vários IPs públicos dependendo do tamanho do pool. |
nopublicipaddresses |
string |
Nenhum endereço IP público será criado. |
usermanaged |
string |
Os IPs públicos são fornecidos pelo usuário e serão usados para provisionar os Nós de Computação. |
JobConstraints
As restrições de execução para um Trabalho.
Nome | Tipo | Description |
---|---|---|
maxTaskRetryCount |
integer |
O número máximo de vezes que cada Tarefa pode ser repetida. O serviço do Lote tentará novamente uma Tarefa se seu código de saída for diferente de zero. |
maxWallClockTime |
string |
O tempo máximo decorrido que o Trabalho pode executar, 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 Lote do Azure.
Nome | Tipo | Description |
---|---|---|
endTime |
string |
A hora de conclusão do Trabalho. |
poolId |
string |
A ID do pool ao qual este trabalho é 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 Trabalhos.
Nome | Tipo | Description |
---|---|---|
allowLowPriorityNode |
boolean |
Se a Tarefa Gerenciador de Trabalhos pode ser executada em um nó de computação spot/de baixa prioridade. |
applicationPackageReferences |
Uma lista de Pacotes de Aplicativos que o serviço do Lote implantará no Nó de Computação antes de executar a linha de comando. |
|
authenticationTokenSettings |
As configurações de um token de autenticação que a Tarefa pode usar para executar operações de serviço do Lote. |
|
commandLine |
string |
A linha de comando da Tarefa Gerenciador de Trabalhos. |
constraints |
Restrições que se aplicam à Tarefa Gerenciador de Trabalhos. |
|
containerSettings |
As configurações para o contêiner no qual a Tarefa Gerenciador de Trabalhos é executada. |
|
displayName |
string |
O nome de exibição da Tarefa Gerenciador de Trabalhos. |
environmentSettings |
Uma lista de configurações de variável de ambiente para a Tarefa gerenciador de trabalhos. |
|
id |
string |
Uma cadeia de caracteres que identifica exclusivamente a Tarefa do Gerenciador de Trabalhos dentro do Trabalho. |
killJobOnCompletion |
boolean |
Se a conclusão da Tarefa gerenciador de trabalho significa a conclusão de todo o Trabalho. |
outputFiles |
Uma lista de arquivos que o serviço do Lote carregará do Nó de Computação depois de executar a linha de comando. |
|
requiredSlots |
integer |
O número de slots de agendamento necessários para execução da Tarefa. |
resourceFiles |
Uma lista de arquivos que o serviço do Lote baixará no Nó de Computação antes de executar a linha de comando. |
|
runExclusive |
boolean |
Se a Tarefa Gerenciador de Trabalho requer uso exclusivo do Nó de Computação em que ela é executada. |
userIdentity |
A identidade do usuário sob a qual a Tarefa Gerenciador de Trabalhos é executada. |
JobNetworkConfiguration
A configuração de rede para o Trabalho.
Nome | Tipo | Description |
---|---|---|
subnetId |
string |
O identificador de recurso do ARM da sub-rede de rede virtual em que os Nós de Computação que executam Tarefas do Trabalho ingressarão durante a Tarefa. Isso só funcionará com um Pool VirtualMachineConfiguration. |
JobPreparationTask
Uma Tarefa de Preparação de Trabalho a ser executada antes de qualquer Tarefa do Trabalho em qualquer nó de computação especificado.
Nome | Tipo | Description |
---|---|---|
commandLine |
string |
A linha de comando da Tarefa de Preparação do Trabalho. |
constraints |
Restrições que se aplicam à Tarefa de Preparação do Trabalho. |
|
containerSettings |
As configurações do contêiner no qual a Tarefa de Preparação do Trabalho é executada. |
|
environmentSettings |
Uma lista de configurações de variável de ambiente para a Tarefa de Preparação do Trabalho. |
|
id |
string |
Uma cadeia de caracteres que identifica exclusivamente a Tarefa de Preparação do Trabalho dentro do Trabalho. |
rerunOnNodeRebootAfterSuccess |
boolean |
Se o serviço do Lote deve executar novamente a Tarefa de Preparação do Trabalho após a reinicialização de um Nó de Computação. |
resourceFiles |
Uma lista de arquivos que o serviço do Lote baixará no 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 do Trabalho é executada. |
|
waitForSuccess |
boolean |
Se o serviço do Lote deve aguardar a conclusão da Tarefa de Preparação do Trabalho com êxito antes de agendar outras Tarefas do Trabalho no Nó de Computação. Uma Tarefa de Preparação de Trabalho foi concluída com êxito se ela sair com o código de saída 0. |
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.
Nome | Tipo | Description |
---|---|---|
commandLine |
string |
A linha de comando da Tarefa de Liberação de Trabalho. |
containerSettings |
As configurações para o contêiner no qual a Tarefa de Liberação de Trabalho é executada. |
|
environmentSettings |
Uma lista de configurações de variável de ambiente para a Tarefa de Versão do Trabalho. |
|
id |
string |
Uma cadeia de caracteres que identifica exclusivamente a Tarefa de Liberação de Trabalho no Trabalho. |
maxWallClockTime |
string |
O tempo máximo decorrido que a Tarefa de Liberação de Trabalho pode executar em um determinado Nó de Computação, medido a partir do momento em que a Tarefa é iniciada. Se a Tarefa não for concluída dentro do limite de tempo, o serviço do Lote a encerrará. O valor padrão é 15 minutos. Você não pode especificar um tempo limite maior que 15 minutos. Se você fizer isso, o serviço do Lote o rejeitará com um erro; se você estiver chamando a API REST diretamente, o código http status será 400 (solicitação incorreta). |
resourceFiles |
Uma lista de arquivos que o serviço do Lote baixará no Nó de Computação antes de executar a linha de comando. Há um tamanho máximo para a lista de arquivos de recurso. Quando o tamanho máximo for excedido, a solicitação falhará e o código de erro de resposta será RequestEntityTooLarge. Se isso ocorrer, a coleção de ResourceFiles deverá ser reduzida em tamanho. Isso pode ser obtido usando arquivos .zip, Pacotes de Aplicativos ou Contêineres do Docker. |
|
retentionTime |
string |
O tempo mínimo para manter o diretório Tarefa para a Tarefa de Versão do Trabalho no Nó de Computação. Após esse tempo, o serviço do Lote pode excluir o diretório Tarefa 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 do Lote ao agendar um trabalho.
Nome | 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 invariáveis e devem ser consumidos programaticamente. |
details |
Uma lista de detalhes de erro adicionais relacionados ao erro de agendamento. |
|
message |
string |
Uma mensagem que descreve o erro agendamento de trabalho, destinado a ser adequado para exibição em uma interface do usuário. |
JobState
O estado do Trabalho.
Nome | 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 alterações adicionais 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 tarefas em execução). |
disabled |
string |
Um usuário desabilitou o Trabalho. Nenhuma Tarefa está em execução e nenhuma nova Tarefa será agendada. |
disabling |
string |
Um usuário solicitou que o Trabalho fosse desabilitado, mas a operação de desabilitação ainda está em andamento (por exemplo, aguardando o término de 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 Trabalhos 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 Versão do Trabalho estão em execução). |
JobStatistics
Estatísticas de uso de recursos para um trabalho.
Nome | Tipo | Description |
---|---|---|
kernelCPUTime |
string |
O tempo total de CPU do modo kernel (somado em todos os núcleos e todos os Nós de Computação) consumido por todas as Tarefas 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 especificado. |
numSucceededTasks |
integer |
O número total de Tarefas concluídas com êxito no Trabalho durante o intervalo de tempo fornecido. |
numTaskRetries |
integer |
O número total de repetições em todas as Tarefas no Trabalho durante o intervalo de tempo especificado. |
readIOGiB |
number |
A quantidade total de dados no 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 |
A URL das estatísticas. |
userCPUTime |
string |
O tempo total de CPU do modo de usuário (somado em todos os núcleos e todos os Nós de Computação) consumido por todas as Tarefas 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 no GiB gravados em disco por todas as Tarefas no Trabalho. |
writeIOps |
integer |
O número total de operações de gravação de disco feitas por todas as Tarefas no Trabalho. |
LinuxUserConfiguration
Propriedades usadas para criar uma conta de usuário em um nó de computação do Linux.
Nome | Tipo | Description |
---|---|---|
gid |
integer |
A ID do grupo para a Conta de usuário. |
sshPrivateKey |
string |
A chave privada SSH para a conta de usuário. |
uid |
integer |
A ID de usuário da conta de usuário. |
LoginMode
O modo de logon do usuário
Nome | Tipo | Description |
---|---|---|
batch |
string |
O LOGON32_LOGON_BATCH modo de logon do Win32. O modo de logon em lote é recomendado para processos paralelos de execução prolongada. |
interactive |
string |
O LOGON32_LOGON_INTERACTIVE modo de logon do Win32. O UAC está habilitado no Windows VirtualMachineConfiguration Pools. Se essa opção for usada com uma identidade de usuário elevada em um Pool virtualMachineConfiguration do Windows, a sessão do usuário não será elevada, a menos que o aplicativo executado pela linha de comando Tarefa esteja configurado para sempre exigir privilégio administrativo ou sempre exigir privilégio máximo. |
ManagedDisk
Nome | Tipo | Description |
---|---|---|
storageAccountType |
O tipo de conta de armazenamento para disco gerenciado. |
MetadataItem
Um par nome-valor associado a um recurso de serviço do Lote.
Nome | Tipo | Description |
---|---|---|
name |
string |
O nome do item de metadados. |
value |
string |
O valor do item de metadados. |
MountConfiguration
O sistema de arquivos a ser montado em cada nó.
Nome | Tipo | Description |
---|---|---|
azureBlobFileSystemConfiguration |
O Contêiner de Armazenamento do Azure a ser montado usando o FUSE de blob 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.
Nome | Tipo | Description |
---|---|---|
name |
string |
O nome no par nome-valor. |
value |
string |
O valor no par nome-valor. |
NetworkConfiguration
A configuração de rede para um pool.
Nome | Tipo | Description |
---|---|---|
dynamicVNetAssignmentScope |
O escopo da atribuição de vnet dinâmica. |
|
enableAcceleratedNetworking |
boolean |
Se esse pool deve habilitar a rede acelerada. |
endpointConfiguration |
A configuração para pontos de extremidade em Nós de Computação no Pool do Lote. |
|
publicIPAddressConfiguration |
A configuração de IPAddress público para nós de computação no pool do Lote. |
|
subnetId |
string |
O identificador de recurso arm da sub-rede de rede virtual à qual os Nós de Computação do Pool ingressarão. Isso é do formato /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. |
NetworkSecurityGroupRule
Uma regra de grupo de segurança de rede a ser aplicada a um ponto de extremidade de entrada.
Nome | Tipo | Description |
---|---|---|
access |
A ação que deve ser executada para um endereço IP, intervalo de sub-rede ou marca especificado. |
|
priority |
integer |
A prioridade dessa regra. |
sourceAddressPrefix |
string |
O prefixo de endereço de origem ou a marca a ser correspondida para a regra. |
sourcePortRanges |
string[] |
Os intervalos de porta de origem a serem correspondidos para a regra. |
NetworkSecurityGroupRuleAccess
A ação que deve ser executada para um endereço IP, intervalo de sub-rede ou marca especificado.
Nome | Tipo | Description |
---|---|---|
allow |
string |
Permitir o acesso. |
deny |
string |
Nega o acesso. |
NFSMountConfiguration
Informações usadas para se conectar a um sistema de arquivos NFS.
Nome | Tipo | Description |
---|---|---|
mountOptions |
string |
Opções de linha de comando adicionais a serem passadas para o comando de montagem. |
relativeMountPath |
string |
O caminho relativo no nó de computação em que 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 do Lote.
Nome | Tipo | Description |
---|---|---|
classic |
string |
Os nós que usam o modo de comunicação clássico exigem comunicação TCP de entrada nas portas 29876 e 29877 do "BatchNodeManagement. {region}" marca de serviço e comunicação TCP de saída na porta 443 para "Storage.region" e "BatchNodeManagement. Marcas de serviço {region}". |
default |
string |
O modo de comunicação do nó é definido automaticamente pelo serviço do Lote. |
simplified |
string |
Os nós que usam o modo de comunicação simplificado exigem comunicação TCP de saída na porta 443 para o "BatchNodeManagement. Marca de serviço {region}". Não são necessárias portas de entrada abertas. |
NodePlacementConfiguration
Configuração de posicionamento de nó para um pool.
Nome | Tipo | Description |
---|---|---|
policy |
Tipo de política de posicionamento de nó em Pools de Lote. |
NodePlacementPolicyType
A política de posicionamento para alocar nós no pool.
Nome | Tipo | Description |
---|---|---|
regional |
string |
Todos os nós no pool serão alocados na mesma região. |
zonal |
string |
Os nós no pool serão distribuídos em diferentes zonas de disponibilidade com o melhor balanceamento de esforço. |
OnAllTasksComplete
A ação que o serviço lote deve executar quando todas as Tarefas no Trabalho estão no estado concluído.
Nome | Tipo | Description |
---|---|---|
noaction |
string |
Não fazer nada. O Trabalho permanece ativo, a menos que seja encerrado ou desabilitado por outros meios. |
terminatejob |
string |
Encerre o trabalho. O TerminateReason do trabalho está definido como 'AllTasksComplete'. |
OnTaskFailure
A ação que o serviço lote deve executar quando qualquer Tarefa no Trabalho falha.
Nome | Tipo | Description |
---|---|---|
noaction |
string |
Não fazer nada. O Trabalho permanece ativo, a menos que seja encerrado ou desabilitado por outros meios. |
performexitoptionsjobaction |
string |
Execute a ação associada à condição de saída da tarefa na coleção exitConditions da Tarefa. (Isso ainda pode resultar em nenhuma ação sendo tomada, se for isso que a Tarefa especifica.) |
OSDisk
Configurações para o disco do sistema operacional do nó de computação (VM).
Nome | Tipo | Description |
---|---|---|
caching |
Especifica os requisitos de cache. Os valores possíveis são: None, ReadOnly, ReadWrite. Os valores padrão são: Nenhum para armazenamento Standard. ReadOnly para armazenamento Premium. |
|
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êmero para o disco do sistema operacional usado pela VM (nó de computação). |
|
managedDisk |
Os parâmetros de disco gerenciado. |
|
writeAcceleratorEnabled |
boolean |
Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco. |
OutputFile
Uma especificação para carregar arquivos de um nó de computação Lote do Azure para outro local depois que o serviço do Lote terminar de executar o processo de Tarefa.
Nome | Tipo | Description |
---|---|---|
destination |
O destino dos arquivos de saída. |
|
filePattern |
string |
Um padrão que indica quais arquivos carregar. |
uploadOptions |
Opções adicionais para a operação de carregamento, incluindo sob quais condições executar o upload. |
OutputFileBlobContainerDestination
Especifica um destino de upload de arquivo em um contêiner de armazenamento de blobs do Azure.
Nome | Tipo | Description |
---|---|---|
containerUrl |
string |
A URL do contêiner no Armazenamento de Blobs do Azure para o qual carregar os arquivos. |
identityReference |
A referência à identidade atribuída pelo usuário a ser usada para acessar Armazenamento de Blobs do Azure especificada por containerUrl |
|
path |
string |
O blob de destino ou o diretório virtual dentro do contêiner do Armazenamento do Azure. |
uploadHeaders |
Uma lista de pares nome-valor para cabeçalhos a serem usados no carregamento de arquivos de saída |
OutputFileDestination
O destino para o qual um arquivo deve ser carregado.
Nome | Tipo | Description |
---|---|---|
container |
Um local no armazenamento de blobs do Azure para o qual os arquivos são carregados. |
OutputFileUploadCondition
As condições sob as quais um arquivo de saída da Tarefa ou um conjunto de arquivos devem ser carregados.
Nome | Tipo | Description |
---|---|---|
taskcompletion |
string |
Carregue os arquivos após a saída do processo de tarefa, independentemente do código de saída. |
taskfailure |
string |
Carregue os arquivos somente depois que o processo de tarefa for encerrado com um código de saída diferente de zero. |
tasksuccess |
string |
Carregue os arquivos somente depois que o processo de tarefa for encerrado com um código de saída de 0. |
OutputFileUploadOptions
Detalhes sobre uma operação de upload de arquivo de saída, incluindo sob quais condições executar o upload.
Nome | Tipo | Description |
---|---|---|
uploadCondition |
As condições sob as quais o arquivo de saída da tarefa ou o conjunto de arquivos devem ser carregados. |
PoolEndpointConfiguration
A configuração do ponto de extremidade para um Pool.
Nome | Tipo | Description |
---|---|---|
inboundNATPools |
Uma lista de pools NAT de entrada que podem ser usados para abordar portas específicas em um nó de computação individual externamente. |
PoolInformation
Especifica como um trabalho deve ser atribuído a um pool.
Nome | Tipo | Description |
---|---|---|
autoPoolSpecification |
Características de um 'pool automático' temporário. O serviço lote criará esse pool automático quando o trabalho for enviado. |
|
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 um agendamento são atribuídos a pools.
Nome | Tipo | Description |
---|---|---|
job |
string |
O pool existe durante o tempo de vida do trabalho ao qual ele é dedicado. O serviço do Lote cria o Pool quando cria o Trabalho. Se a opção 'job' for aplicada a uma Agenda de Trabalho, o serviço do Lote criará um novo pool automático para cada Trabalho criado na agenda. |
jobschedule |
string |
O pool existe durante o tempo de vida da Agenda de Trabalho. O Serviço de Lote cria o Pool quando cria o primeiro Trabalho na agenda. Você pode aplicar essa opção somente a Agendas de Trabalho, não a Trabalhos. |
PoolSpecification
Especificação para criar um pool.
Nome | Tipo | Description |
---|---|---|
applicationLicenses |
string[] |
A lista de licenças de aplicativo que o serviço do Lote disponibilizará em cada Nó de Computação no Pool. |
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: essa propriedade foi preterida e será removida após fevereiro de 2024. Em vez disso, use a Extensão do Azure KeyVault . |
|
cloudServiceConfiguration |
A configuração do serviço de nuvem para o Pool. |
|
displayName |
string |
O nome de 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 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ó no 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 marcas especificadas pelo usuário associadas ao pool. |
startTask |
Uma Tarefa a ser executada em cada Nó de Computação à medida que ele ingressa no pool. A Tarefa é executada quando o Nó de Computação é adicionado ao pool ou quando o nó de computação é reiniciado. |
|
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. |
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.
Nome | Tipo | Description |
---|---|---|
ipAddressIds |
string[] |
A lista de IPs públicos que o serviço do Lote usará ao provisionar nós de computação. |
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 em um Nó de Computação.
Nome | 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 do Armazenamento do Azure. Somente os blobs cujos nomes começam com o prefixo especificado serão baixados. |
fileMode |
string |
O atributo de modo de permissão de arquivo no formato octal. |
filePath |
string |
O local no Nó de Computação para o qual baixar os arquivos em relação ao diretório de trabalho da Tarefa. |
httpUrl |
string |
A URL do arquivo para download. |
identityReference |
A referência à identidade atribuída pelo usuário a ser usada para acessar Armazenamento de Blobs do Azure especificada por storageContainerUrl ou httpUrl |
|
storageContainerUrl |
string |
A URL do contêiner de blob no Armazenamento de Blobs do Azure. |
SecurityProfile
Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais.
Nome | Tipo | Description |
---|---|---|
encryptionAtHost |
boolean |
Essa propriedade pode ser usada pelo usuário na solicitação para habilitar ou desabilitar a Criptografia de Host para a máquina virtual ou conjunto de dimensionamento de máquinas virtuais. Isso habilitará a criptografia para todos os discos, incluindo o disco Resource/Temp no próprio host. |
securityType |
Especifica o SecurityType da máquina virtual. Ele precisa 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 precisa ser definido como qualquer valor especificado para habilitar UefiSettings.
Nome | Tipo | Description |
---|---|---|
trustedLaunch |
string |
O início confiável protege contra técnicas de ataque avançadas e persistentes. |
ServiceArtifactReference
Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de dimensionamento ao usar a versão de imagem 'mais recente'.
Nome | Tipo | Description |
---|---|---|
id |
string |
A ID de referência do artefato de serviço de ServiceArtifactReference |
StartTask
Uma Tarefa que é executada quando um nó ingressa em um pool no serviço Lote do Azure ou quando o Nó de Computação é reinicializado ou recriado.
Nome | Tipo | Description |
---|---|---|
commandLine |
string |
A linha de comando do StartTask. |
containerSettings |
As configurações para o contêiner no qual o StartTask é executado. |
|
environmentSettings |
Uma lista de configurações de variável de ambiente para StartTask. |
|
maxTaskRetryCount |
integer |
O número máximo de vezes que a Tarefa pode ser repetida. |
resourceFiles |
Uma lista de arquivos que o serviço do Lote baixará para o Nó de Computação antes de executar a linha de comando. Há um tamanho máximo para a lista de arquivos de recurso. Quando o tamanho máximo for excedido, a solicitação falhará e o código de erro de resposta será RequestEntityTooLarge. Se isso ocorrer, a coleção de ResourceFiles deverá ser reduzida em tamanho. Isso pode ser feito usando arquivos .zip, Pacotes de Aplicativos ou Contêineres do Docker. |
|
userIdentity |
A identidade do usuário na qual o StartTask é executado. |
|
waitForSuccess |
boolean |
Se o serviço do Lote deve aguardar a conclusão bem-sucedida do StartTask (ou seja, sair com o código de saída 0) antes de agendar qualquer Tarefa no Nó de Computação. |
StorageAccountType
O tipo de conta de armazenamento para uso na criação de discos de dados ou disco do sistema operacional.
Nome | Tipo | Description |
---|---|---|
premium_lrs |
string |
O disco de dados/disco do sistema operacional deve usar o armazenamento premium com redundância local. |
standard_lrs |
string |
O disco de dados/disco do sistema operacional deve usar o armazenamento padrão com redundância local. |
standardssd_lrs |
string |
O disco de dados/disco do sistema operacional deve usar o armazenamento com redundância local do SSD padrão. |
TaskConstraints
Restrições de execução a serem aplicadas a uma Tarefa.
Nome | Tipo | Description |
---|---|---|
maxTaskRetryCount |
integer |
O número máximo de vezes que a Tarefa pode ser repetida. O serviço do Lote tentará novamente uma Tarefa se o código de saída não for 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 limite de tempo, o serviço do Lote a encerrará. |
retentionTime |
string |
O tempo mínimo para manter o diretório Tarefa no Nó de Computação em que ele foi executado, a partir do momento em que ele conclui a execução. Após esse tempo, o serviço do Lote pode excluir o diretório Tarefa e todo o seu conteúdo. |
TaskContainerSettings
As configurações de contêiner de uma Tarefa.
Nome | Tipo | Description |
---|---|---|
containerRunOptions |
string |
Opções adicionais para o comando de criação de contêiner. |
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 de contêiner. |
TaskSchedulingPolicy
Especifica como as Tarefas devem ser distribuídas entre nós de computação.
Nome | 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.
Nome | Tipo | Description |
---|---|---|
secureBootEnabled |
boolean |
Especifica se a inicialização segura deve ser habilitada na máquina virtual. |
vTpmEnabled |
boolean |
Especifica se o vTPM deve ser habilitado na máquina virtual. |
UserAccount
Propriedades usadas para criar um usuário usado para executar Tarefas em um nó de computação Lote do Azure.
Nome | Tipo | Description |
---|---|---|
elevationLevel |
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.
Nome | 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.
Nome | 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 Máquinas Virtuais Marketplace ou à imagem de máquina virtual personalizada a ser usada. |
|
licenseType |
string |
O tipo de licença local a ser usado ao implantar o sistema operacional. Windows_Server – a licença local é para o Windows Server. Windows_Client - A licença local é para o Cliente Windows. |
nodeAgentSKUId |
string |
O SKU do agente do Nó de Computação em Lote a ser provisionado em Nós de Computação no Pool. |
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áquinas virtuais. |
|
serviceArtifactReference |
Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de dimensionamento ao usar a versão de imagem 'mais recente'. |
|
windowsConfiguration |
Configurações do sistema operacional Windows na máquina virtual. |
VMExtension
A configuração para extensões de máquina virtual.
Nome | Tipo | Description |
---|---|---|
autoUpgradeMinorVersion |
boolean |
Indica se a extensão deve usar uma versão secundária mais recente se uma estiver disponível no momento da implantação. Após a implantação, no entanto, a extensão não atualizará as versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como verdadeira. |
enableAutomaticUpgrade |
boolean |
Indica se a extensão deve ser atualizada automaticamente pela plataforma se houver uma versão mais recente da extensão disponível. |
name |
string |
O nome da extensão da máquina virtual. |
protectedSettings |
object |
A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida. |
provisionAfterExtensions |
string[] |
A coleção de nomes de extensão. |
publisher |
string |
O nome do editor do manipulador de extensão. |
settings |
object |
Configurações públicas formatadas em JSON para a extensão. |
type |
string |
O tipo da extensão. |
typeHandlerVersion |
string |
A versão do manipulador de script. |
WindowsConfiguration
Configurações do sistema operacional Windows a serem aplicadas à máquina virtual.
Nome | Tipo | Description |
---|---|---|
enableAutomaticUpdates |
boolean |
Se as atualizações automáticas estão habilitadas na máquina virtual. |
WindowsUserConfiguration
Propriedades usadas para criar uma conta de usuário em um nó de computação do Windows.
Nome | Tipo | Description |
---|---|---|
loginMode |
O modo de logon do usuário |