Job - Add
Adiciona uma Tarefa à Conta especificada.
O serviço Batch suporta duas formas de controlar o trabalho realizado como parte de uma Tarefa. Na primeira abordagem, o utilizador especifica uma Tarefa do Gestor de Tarefas. O serviço Batch inicia esta Tarefa quando estiver pronto para iniciar a Tarefa. A Tarefa do Gestor de Tarefas controla todas as outras Tarefas que são executadas nesta Tarefa através das APIs de Tarefa. Na segunda abordagem, o utilizador controla diretamente a execução de Tarefas numa Tarefa ativa, utilizando as APIs de Tarefa. Nota: ao atribuir nomes a Tarefas, evite incluir informações confidenciais, como nomes de utilizadores ou nomes de projetos secretos. Estas informações podem aparecer em registos de telemetria acessíveis a engenheiros Suporte da Microsoft.
POST {batchUrl}/jobs?api-version=2023-11-01.18.0
POST {batchUrl}/jobs?timeout={timeout}&api-version=2023-11-01.18.0
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
batch
|
path | True |
string |
O URL base para todos os pedidos de serviço Azure Batch. |
api-version
|
query | True |
string |
Versão da API de Cliente. |
timeout
|
query |
integer int32 |
O tempo máximo que o servidor pode gastar a processar o pedido, em segundos. A predefinição é 30 segundos. |
Cabeçalho do Pedido
Media Types: "application/json; odata=minimalmetadata"
Name | Necessário | Tipo | Description |
---|---|---|---|
client-request-id |
string uuid |
A identidade do pedido gerado pelo autor da chamada, sob a forma de um GUID sem decoração, como chavetas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Se o servidor deve devolver o client-request-id na resposta. |
|
ocp-date |
string date-time-rfc1123 |
A hora em que o pedido foi emitido. Normalmente, as bibliotecas de cliente definem isto como a hora atual do relógio do sistema; defina-a explicitamente se estiver a chamar a API REST diretamente. |
Corpo do Pedido
Media Types: "application/json; odata=minimalmetadata"
Name | Necessário | Tipo | Description |
---|---|---|---|
id | True |
string |
Uma cadeia que identifica exclusivamente a Tarefa na Conta. |
poolInfo | True |
O Conjunto no qual o serviço Batch executa as Tarefas da Tarefa. |
|
allowTaskPreemption |
boolean |
Se as Tarefas nesta tarefa podem ser impedidas por outros trabalhos de alta prioridade |
|
commonEnvironmentSettings |
A lista de definições de variáveis de ambiente comuns. Estas variáveis de ambiente são definidas para todas as Tarefas na Tarefa (incluindo o Gestor de Tarefas, a Preparação de Trabalhos e as Tarefas de Lançamento de Trabalhos). |
||
constraints |
As restrições de execução de uma Tarefa. |
||
displayName |
string |
O nome a apresentar da Tarefa. |
|
jobManagerTask |
Detalhes de uma Tarefa do Gestor de Tarefas a iniciar quando a Tarefa for iniciada. |
||
jobPreparationTask |
A tarefa de preparação da tarefa. |
||
jobReleaseTask |
A Tarefa de Lançamento da Tarefa. |
||
maxParallelTasks |
integer |
O número máximo de tarefas que podem ser executadas em paralelo para a tarefa. |
|
metadata |
Uma lista de pares nome-valor associados à Tarefa como metadados. |
||
networkConfiguration |
A configuração de rede para a Tarefa. |
||
onAllTasksComplete |
A ação que o serviço Batch deve efetuar quando todas as Tarefas na Tarefa estiverem no estado concluído. |
||
onTaskFailure |
A ação que o serviço Batch deve efetuar quando qualquer Tarefa na Tarefa falhar. |
||
priority |
integer |
A prioridade da Tarefa. |
|
usesTaskDependencies |
boolean |
Se as Tarefas na Tarefa podem definir dependências entre si. A predefinição é false. |
Respostas
Name | Tipo | Description |
---|---|---|
201 Created |
O pedido para o serviço Batch foi efetuado com êxito. Cabeçalhos
|
|
Other Status Codes |
O erro do serviço Batch. |
Segurança
azure_auth
Microsoft Entra fluxo de código de autenticação OAuth 2.0
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
user_impersonation | Representar a sua conta de utilizador |
Authorization
Tipo:
apiKey
Em:
header
Exemplos
Add a basic job |
Add a complex job |
Add a basic job
Pedido de amostra
POST account.region.batch.azure.com/jobs?api-version=2023-11-01.18.0
{
"id": "jobId",
"priority": 0,
"poolInfo": {
"poolId": "poolId"
}
}
Resposta da amostra
Add a complex job
Pedido de amostra
POST account.region.batch.azure.com/jobs?api-version=2023-11-01.18.0
{
"id": "jobId",
"priority": 100,
"constraints": {
"maxWallClockTime": "PT1H",
"maxTaskRetryCount": -1
},
"jobManagerTask": {
"id": "taskId",
"commandLine": "myprogram.exe",
"resourceFiles": [
{
"httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas",
"filePath": "myprogram.exe"
},
{
"storageContainerUrl": "http://mystorage1.blob.core.windows.net/data?sas",
"filePath": "datafolder"
}
],
"environmentSettings": [
{
"name": "myvariable",
"value": "myvalue"
}
],
"constraints": {
"maxWallClockTime": "PT1H",
"maxTaskRetryCount": 0,
"retentionTime": "PT1H"
},
"requiredSlots": 2,
"killJobOnCompletion": false,
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "admin"
}
},
"runExclusive": true
},
"poolInfo": {
"autoPoolSpecification": {
"autoPoolIdPrefix": "mypool",
"poolLifetimeOption": "job",
"pool": {
"vmSize": "small",
"cloudServiceConfiguration": {
"osFamily": "4",
"osVersion": "*"
},
"resizeTimeout": "PT15M",
"targetDedicatedNodes": 3,
"targetLowPriorityNodes": 0,
"taskSlotsPerNode": 2,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"enableAutoScale": false,
"enableInterNodeCommunication": true,
"startTask": {
"commandLine": "myprogram2.exe",
"resourceFiles": [
{
"httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas",
"filePath": "myprogram2.exe"
}
],
"environmentSettings": [
{
"name": "myvariable",
"value": "myvalue"
}
],
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "admin"
}
},
"maxTaskRetryCount": 2,
"waitForSuccess": true
},
"certificateReferences": [
{
"thumbprint": "0123456789abcdef0123456789abcdef01234567",
"thumbprintAlgorithm": "sha1",
"storeLocation": "localmachine",
"storeName": "Root",
"visibility": [
"task"
]
}
],
"metadata": [
{
"name": "myproperty",
"value": "myvalue"
}
],
"targetNodeCommunicationMode": "default"
}
}
},
"metadata": [
{
"name": "myproperty",
"value": "myvalue"
}
]
}
Resposta da amostra
Definições
Name | Description |
---|---|
Access |
Os recursos do Batch aos quais o token concede acesso. |
Application |
Uma referência a um Pacote a ser implementado nos Nós de Computação. |
Authentication |
As definições de um token de autenticação que a Tarefa pode utilizar para realizar operações de serviço do Batch. |
Auto |
Especifica características para um "conjunto automático" temporário. O serviço Batch irá criar este Conjunto Automático quando a Tarefa for submetida. |
Auto |
O âmbito do utilizador automático |
Auto |
Especifica os parâmetros para o utilizador automático que executa uma Tarefa no serviço Batch. |
Azure |
Informações utilizadas para ligar a um Contentor de Armazenamento do Azure com o Blobfuse. |
Azure |
Informações utilizadas para ligar a uma Partilha de Ficheiros do Azure. |
Batch |
Uma resposta de erro recebida do serviço Azure Batch. |
Batch |
Um item de informações adicionais incluídas numa resposta de erro Azure Batch. |
Caching |
O tipo de colocação em cache a ativar para o disco. |
Certificate |
Uma referência a um Certificado a ser instalado nos Nós de Computação num Conjunto. |
Certificate |
A localização do Arquivo de certificados no Nó de Computação no qual pretende instalar o Certificado. |
Certificate |
Que contas de utilizador no Nó de Computação devem ter acesso aos dados privados do Certificado. |
CIFSMount |
Informações utilizadas para ligar a um sistema de ficheiros CIFS. |
Cloud |
A configuração para Nós de Computação num Conjunto com base na plataforma de Serviços Cloud do Azure. |
Compute |
Como as Tarefas são distribuídas pelos Nós de Computação num Conjunto. |
Compute |
A referência a uma identidade atribuída pelo utilizador associada ao conjunto do Batch que um nó de computação irá utilizar. |
Container |
A configuração para Conjuntos preparados para contentores. |
Container |
Um registo de contentor privado. |
Container |
A tecnologia de contentor a utilizar. |
Container |
A localização do diretório de trabalho da Tarefa de contentor. |
Data |
Definições que serão utilizadas pelos discos de dados associados aos Nós de Computação no Conjunto. Ao utilizar discos de dados anexados, tem de montar e formatar os discos a partir de uma VM para os utilizar. |
Diff |
Especifica o posicionamento do disco efémero para o disco do sistema operativo para todos os nós de computação (VMs) no conjunto. |
Diff |
Especifica as Definições de Disco efémero para o disco do sistema operativo utilizado pelo nó de computação (VM). |
Disk |
A configuração de encriptação de disco aplicada nos nós de computação no conjunto. A configuração da encriptação de disco não é suportada no conjunto linux criado com a Imagem da Galeria de Computação do Azure. |
Disk |
A lista de destinos de disco do Batch Service será encriptada no nó de computação. |
Dynamic |
O âmbito da atribuição de vnet dinâmica. |
Elevation |
O nível de elevação do utilizador. |
Environment |
Uma variável de ambiente a definir num processo de Tarefa. |
Error |
Uma mensagem de erro recebida numa resposta de erro Azure Batch. |
Http |
Um par de nome-valor de cabeçalho HTTP |
Image |
Uma referência a uma Imagem do Marketplace do Azure Máquinas Virtuais ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências da imagem Azure Marketplace verificadas por Azure Batch, veja a operação "Listar Imagens Suportadas". |
Inbound |
O protocolo do ponto final. |
Inbound |
Um Conjunto NAT de entrada que pode ser utilizado para abordar portas específicas em Nós de Computação num Conjunto do Batch externamente. |
IPAddress |
O tipo de aprovisionamento para Endereços IP Públicos para o Conjunto. |
Job |
Uma tarefa de Azure Batch a adicionar. |
Job |
As restrições de execução de uma Tarefa. |
Job |
Especifica detalhes de uma Tarefa do Gestor de Tarefas. |
Job |
A configuração de rede da Tarefa. |
Job |
Uma Tarefa de Preparação de Tarefas a executar antes de quaisquer Tarefas da Tarefa num determinado Nó de Computação. |
Job |
Uma Tarefa de Libertação de Tarefas para ser executada na conclusão da tarefa em qualquer Nó de Computação onde a Tarefa tenha sido executada. |
Linux |
Propriedades utilizadas para criar uma Conta de utilizador num Nó de Computação do Linux. |
Login |
O modo de início de sessão do utilizador |
Managed |
|
Metadata |
Um par name-value associado a um recurso do serviço Batch. |
Mount |
O sistema de ficheiros a montar em cada nó. |
Network |
A configuração de rede de um Conjunto. |
Network |
Uma regra de grupo de segurança de rede a aplicar a um ponto final de entrada. |
Network |
A ação que deve ser efetuada para um endereço IP especificado, intervalo de sub-rede ou etiqueta. |
NFSMount |
Informações utilizadas para ligar a um sistema de ficheiros NFS. |
Node |
Determina como um conjunto comunica com o serviço Batch. |
Node |
Configuração de colocação de nós para um conjunto. |
Node |
A política de colocação para alocar nós no conjunto. |
On |
A ação que o serviço Batch deve tomar quando todas as Tarefas na Tarefa estiverem no estado concluído. |
On |
A ação que o serviço Batch deve efetuar quando qualquer Tarefa na Tarefa falhar. |
OSDisk |
Definições para o disco do sistema operativo do nó de computação (VM). |
Output |
Uma especificação para carregar ficheiros a partir de um Nó de Computação Azure Batch para outra localização depois de o serviço Batch ter terminado de executar o processo de Tarefa. |
Output |
Especifica um destino de carregamento de ficheiros num contentor de armazenamento de blobs do Azure. |
Output |
O destino para o qual um ficheiro deve ser carregado. |
Output |
As condições nas quais um ficheiro de saída de tarefa ou conjunto de ficheiros deve ser carregado. |
Output |
Detalhes sobre uma operação de carregamento de ficheiros de saída, incluindo em que condições efetuar o carregamento. |
Pool |
A configuração do ponto final de um Conjunto. |
Pool |
Especifica como uma Tarefa deve ser atribuída a um Conjunto. |
Pool |
A duração mínima dos conjuntos automáticos criados e a forma como várias Tarefas numa agenda são atribuídas a Conjuntos. |
Pool |
Especificação para criar um novo Conjunto. |
Public |
A configuração do Endereço IP público da configuração de rede de um Conjunto. |
Resource |
Um único ficheiro ou vários ficheiros a transferir para um Nó de Computação. |
Security |
Especifica as definiçõ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. Tem de ser definido para qualquer valor especificado para ativar UefiSettings. |
Service |
Especifica o ID de referência do artefacto de serviço utilizado para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de dimensionamento ao utilizar a versão de imagem "mais recente". |
Start |
Uma Tarefa que é executada quando um Nó associa um Conjunto no serviço Azure Batch ou quando o Nó de Computação é reiniciado ou recriado. |
Storage |
O tipo de Conta de armazenamento para utilização na criação de discos de dados ou disco do SO. |
Task |
Restrições de execução a aplicar a uma Tarefa. |
Task |
As definições de contentor para uma Tarefa. |
Task |
Especifica como as Tarefas devem ser distribuídas pelos Nós de Computação. |
Uefi |
Especifica as definições de segurança, como o arranque seguro e o vTPM utilizados ao criar a máquina virtual. |
User |
Propriedades utilizadas para criar um utilizador utilizado para executar Tarefas num Nó de Computação Azure Batch. |
User |
A definição da identidade de utilizador na qual a Tarefa é executada. |
Virtual |
A configuração para Nós de Computação num Conjunto com base na infraestrutura de Máquinas Virtuais do Azure. |
VMExtension |
A configuração para extensões de máquinas virtuais. |
Windows |
Definições do sistema operativo Windows a aplicar à máquina virtual. |
Windows |
Propriedades utilizadas para criar uma Conta de utilizador num Nó de Computação do Windows. |
AccessScope
Os recursos do Batch aos quais o token concede acesso.
Name | Tipo | Description |
---|---|---|
job |
string |
Concede acesso para efetuar todas as operações na Tarefa que contém a Tarefa. |
ApplicationPackageReference
Uma referência a um Pacote a ser implementado nos Nós de Computação.
Name | Tipo | Description |
---|---|---|
applicationId |
string |
O ID da aplicação a implementar. |
version |
string |
A versão da aplicação a implementar. Se for omitida, a versão predefinida é implementada. |
AuthenticationTokenSettings
As definições de um token de autenticação que a Tarefa pode utilizar para realizar operações de serviço do Batch.
Name | Tipo | Description |
---|---|---|
access |
Os recursos do Batch aos quais o token concede acesso. |
AutoPoolSpecification
Especifica características para um "conjunto automático" temporário. O serviço Batch irá criar este Conjunto Automático quando a Tarefa for submetida.
Name | Tipo | Description |
---|---|---|
autoPoolIdPrefix |
string |
Um prefixo a ser adicionado ao identificador exclusivo quando um Conjunto é criado automaticamente. |
keepAlive |
boolean |
Se pretende manter um Conjunto automático ativo após a expiração da duração. |
pool |
A especificação do Conjunto para o Conjunto Automático. |
|
poolLifetimeOption |
A duração mínima dos conjuntos automáticos criados e a forma como várias Tarefas numa agenda são atribuídas a Conjuntos. |
AutoUserScope
O âmbito do utilizador automático
Name | Tipo | Description |
---|---|---|
pool |
string |
Especifica que a Tarefa é executada como a Conta de utilizador automático comum que é criada em todos os Nós de Computação num Conjunto. |
task |
string |
Especifica que o serviço deve criar um novo utilizador para a Tarefa. |
AutoUserSpecification
Especifica os parâmetros para o utilizador automático que executa uma Tarefa no serviço Batch.
Name | Tipo | Description |
---|---|---|
elevationLevel |
O nível de elevação do utilizador automático. |
|
scope |
O âmbito do utilizador automático |
AzureBlobFileSystemConfiguration
Informações utilizadas para ligar a um Contentor de Armazenamento do Azure com o 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 adicionais da linha de comandos para passar para o comando de montagem. |
containerName |
string |
O Armazenamento de Blobs do Azure Nome do contentor. |
identityReference |
A referência à identidade atribuída pelo utilizador a utilizar para aceder ao containerName |
|
relativeMountPath |
string |
O caminho relativo no nó de computação onde o sistema de ficheiros será montado |
sasKey |
string |
O token SAS do Armazenamento do Azure. |
AzureFileShareConfiguration
Informações utilizadas para ligar a uma Partilha de Ficheiros do Azure.
Name | Tipo | Description |
---|---|---|
accountKey |
string |
A chave da conta de Armazenamento do Azure. |
accountName |
string |
O nome da conta de Armazenamento do Azure. |
azureFileUrl |
string |
O URL do Ficheiros do Azure. |
mountOptions |
string |
Opções adicionais da linha de comandos para passar para o comando de montagem. |
relativeMountPath |
string |
O caminho relativo no nó de computação onde o sistema de ficheiros será montado |
BatchError
Uma resposta de erro recebida do serviço Azure Batch.
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 que descreve o erro, destinada a ser adequada para ser apresentada numa interface de utilizador. |
|
values |
Uma coleção de pares chave-valor que contém detalhes adicionais sobre o erro. |
BatchErrorDetail
Um item de informações adicionais incluídas numa resposta de erro Azure Batch.
Name | Tipo | Description |
---|---|---|
key |
string |
Um identificador que especifica o significado da propriedade Valor. |
value |
string |
As informações adicionais incluídas na resposta de erro. |
CachingType
O tipo de colocação em cache a ativar para o disco.
Name | Tipo | Description |
---|---|---|
none |
string |
O modo de colocação em cache do disco não está ativado. |
readonly |
string |
O modo de colocação em cache do disco é só de leitura. |
readwrite |
string |
O modo de colocação em cache do disco é lido e escrito. |
CertificateReference
Uma referência a um Certificado a ser instalado nos Nós de Computação num Conjunto.
Name | Tipo | Description |
---|---|---|
storeLocation |
A localização do Arquivo de certificados no Nó de Computação no qual instalar o Certificado. |
|
storeName |
string |
O nome do Arquivo de certificados no Nó de Computação no qual pretende instalar o Certificado. |
thumbprint |
string |
O thumbprint do Certificado. |
thumbprintAlgorithm |
string |
O algoritmo com o qual o thumbprint está associado. Deve ser sha1. |
visibility |
Que utilizador As Contas no Nó de Computação devem ter acesso aos dados privados do Certificado. |
CertificateStoreLocation
A localização do Arquivo de certificados no Nó de Computação no qual pretende instalar o Certificado.
Name | Tipo | Description |
---|---|---|
currentuser |
string |
Os certificados devem ser instalados no arquivo de Certificados CurrentUser. |
localmachine |
string |
Os certificados devem ser instalados no arquivo de Certificados LocalMachine. |
CertificateVisibility
Que contas de utilizador 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 utilizador nas quais os utilizadores acedem remotamente ao Nó de Computação. |
starttask |
string |
O Certificado deve estar visível para a conta de utilizador na qual o StartTask é executado. Tenha em atenção que se o Âmbito do AutoUser for Conjunto para StartTask e uma Tarefa, este certificado também estará visível para a Tarefa. |
task |
string |
O Certificado deve estar visível para as contas de utilizador nas quais as Tarefas de Trabalho são executadas. |
CIFSMountConfiguration
Informações utilizadas para ligar a um sistema de ficheiros CIFS.
Name | Tipo | Description |
---|---|---|
mountOptions |
string |
Opções adicionais da linha de comandos para passar para o comando de montagem. |
password |
string |
A palavra-passe a utilizar para autenticação no sistema de ficheiros CIFS. |
relativeMountPath |
string |
O caminho relativo no nó de computação onde o sistema de ficheiros será montado |
source |
string |
O URI do sistema de ficheiros a montar. |
username |
string |
O utilizador a utilizar para autenticação no sistema de ficheiros CIFS. |
CloudServiceConfiguration
A configuração para Nós de Computação num Conjunto com base na plataforma de Serviços Cloud do Azure.
Name | Tipo | Description |
---|---|---|
osFamily |
string |
A família de SO Convidado do Azure a ser instalada nas máquinas virtuais no Conjunto. |
osVersion |
string |
A versão do SO Convidado do Azure a ser instalada nas máquinas virtuais no Conjunto. |
ComputeNodeFillType
Como as Tarefas são distribuídas pelos Nós de Computação num Conjunto.
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 Conjunto antes de quaisquer Tarefas serem atribuídas ao próximo Nó de Computação no Conjunto. |
spread |
string |
As tarefas devem ser atribuídas uniformemente em todos os Nós de Computação no Conjunto. |
ComputeNodeIdentityReference
A referência a uma identidade atribuída pelo utilizador associada ao conjunto do Batch que um nó de computação irá utilizar.
Name | Tipo | Description |
---|---|---|
resourceId |
string |
O ID de recurso do ARM da identidade atribuída pelo utilizador. |
ContainerConfiguration
A configuração para Conjuntos preparados para contentores.
Name | Tipo | Description |
---|---|---|
containerImageNames |
string[] |
A coleção de nomes de imagens de contentor. |
containerRegistries |
Registos privados adicionais a partir dos quais os contentores podem ser extraídos. |
|
type |
A tecnologia de contentor a utilizar. |
ContainerRegistry
Um registo de contentor privado.
Name | Tipo | Description |
---|---|---|
identityReference |
A referência à identidade atribuída pelo utilizador a utilizar para aceder a um Azure Container Registry em vez de nome de utilizador e palavra-passe. |
|
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 a iniciar sessão no servidor de registo. |
ContainerType
A tecnologia de contentor a utilizar.
Name | Tipo | Description |
---|---|---|
criCompatible |
string |
Será utilizada uma tecnologia baseada em CRI para iniciar os contentores. |
dockerCompatible |
string |
Será utilizada uma tecnologia de contentor compatível com o Docker para iniciar os contentores. |
ContainerWorkingDirectory
A localização do diretório de trabalho da Tarefa de contentor.
Name | Tipo | Description |
---|---|---|
containerImageDefault |
string |
Utilize o diretório de trabalho definido no contentor Imagem. Tenha em atenção que este diretório não conterá os Ficheiros de Recursos transferidos pelo Batch. |
taskWorkingDirectory |
string |
Utilize o diretório de trabalho da Tarefa do serviço Batch padrão, que irá conter os Ficheiros de Recursos de Tarefa preenchidos pelo Batch. |
DataDisk
Definições que serão utilizadas pelos discos de dados associados aos Nós de Computação no Conjunto. Ao utilizar discos de dados anexados, tem de montar e formatar os discos a partir de uma VM para os utilizar.
Name | Tipo | Description |
---|---|---|
caching |
O tipo de colocação em cache a ativar para os discos de dados. |
|
diskSizeGB |
integer |
O tamanho do disco inicial em gigabytes. |
lun |
integer |
O número da unidade lógica. |
storageAccountType |
O tipo de Conta de armazenamento a ser utilizado para o disco de dados. |
DiffDiskPlacement
Especifica o posicionamento do disco efémero para o disco do sistema operativo para todos os nós de computação (VMs) no conjunto.
Name | Tipo | Description |
---|---|---|
CacheDisk |
string |
O Disco de SO Efémero é armazenado na cache da VM. |
DiffDiskSettings
Especifica as Definições de Disco efémero para o disco do sistema operativo utilizado pelo nó de computação (VM).
Name | Tipo | Description |
---|---|---|
placement |
Especifica o posicionamento do disco efémero para o disco do sistema operativo para todas as VMs no conjunto. |
DiskEncryptionConfiguration
A configuração de encriptação de disco aplicada nos nós de computação no conjunto. A configuração da encriptação de disco não é suportada no conjunto linux criado com a Imagem da Galeria de Computação do Azure.
Name | Tipo | Description |
---|---|---|
targets |
A lista de destinos de disco do Batch Service será encriptada no nó de computação. |
DiskEncryptionTarget
A lista de destinos de disco do Batch Service será encriptada no nó de computação.
Name | Tipo | Description |
---|---|---|
osdisk |
string |
O Disco do SO no nó de computação está encriptado. |
temporarydisk |
string |
O disco temporário no nó de computação é encriptado. No Linux, esta encriptação aplica-se a outras partições (como as em discos de dados montados) quando a encriptação ocorre no momento do arranque. |
DynamicVNetAssignmentScope
O âmbito da atribuição de vnet dinâmica.
Name | Tipo | Description |
---|---|---|
job |
string |
A atribuição de VNet dinâmica é efetuada por trabalho. |
none |
string |
Não está ativada nenhuma atribuição de VNet dinâmica. |
ElevationLevel
O nível de elevação do utilizador.
Name | Tipo | Description |
---|---|---|
admin |
string |
O utilizador é um utilizador com acesso elevado e funciona com permissões de Administrador completas. |
nonadmin |
string |
O utilizador é um utilizador padrão sem acesso elevado. |
EnvironmentSetting
Uma variável de ambiente a definir num processo de Tarefa.
Name | Tipo | Description |
---|---|---|
name |
string |
O nome da variável de ambiente. |
value |
string |
O valor da variável de ambiente. |
ErrorMessage
Uma mensagem de erro recebida numa resposta de erro Azure Batch.
Name | Tipo | Description |
---|---|---|
lang |
string |
O código de idioma da mensagem de erro |
value |
string |
O texto da mensagem. |
HttpHeader
Um par de nome-valor de cabeçalho HTTP
Name | Tipo | Description |
---|---|---|
name |
string |
O nome sensível a maiúsculas e minúsculas do cabeçalho a ser utilizado ao carregar ficheiros de saída |
value |
string |
O valor do cabeçalho a ser utilizado ao carregar ficheiros de saída |
ImageReference
Uma referência a uma Imagem do Marketplace do Azure Máquinas Virtuais ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências da imagem Azure Marketplace verificadas por Azure Batch, veja a operação "Listar Imagens Suportadas".
Name | Tipo | Description |
---|---|---|
exactVersion |
string |
A versão específica da imagem da plataforma ou imagem do marketplace utilizada para criar o nó. Este campo só de leitura só difere de "versão" se o valor especificado para "versão" quando o conjunto foi criado for "mais recente". |
offer |
string |
O tipo de oferta da Imagem do Azure Máquinas Virtuais Marketplace. |
publisher |
string |
O publicador 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 recursos do ARM da Imagem da Galeria de Computação do Azure. Os Nós de Computação no Conjunto serão criados com este ID de Imagem. Este é o 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 predefinir sempre a versão mais recente da imagem. |
InboundEndpointProtocol
O protocolo do ponto final.
Name | Tipo | Description |
---|---|---|
tcp |
string |
Utilize o TCP para o ponto final. |
udp |
string |
Utilize uDP para o ponto final. |
InboundNATPool
Um Conjunto NAT de entrada que pode ser utilizado para abordar portas específicas em Nós de Computação num Conjunto do Batch 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 utilizadas para fornecer acesso de entrada ao backendPort em Nós de Computação individuais. |
frontendPortRangeStart |
integer |
O primeiro número de porta no intervalo de portas externas que será utilizado para fornecer acesso de entrada ao backendPort em Nós de Computação individuais. |
name |
string |
O nome do ponto final. |
networkSecurityGroupRules |
Uma lista de regras do grupo de segurança de rede que serão aplicadas ao ponto final. |
|
protocol |
O protocolo do ponto final. |
IPAddressProvisioningType
O tipo de aprovisionamento para Endereços IP Públicos para o Conjunto.
Name | Tipo | Description |
---|---|---|
batchmanaged |
string |
Será criado e gerido um IP público pelo Batch. Podem existir vários IPs públicos consoante o tamanho do Conjunto. |
nopublicipaddresses |
string |
Não será criado nenhum Endereço IP público. |
usermanaged |
string |
Os IPs públicos são fornecidos pelo utilizador e serão utilizados para aprovisionar os Nós de Computação. |
JobAddParameter
Uma tarefa de Azure Batch a adicionar.
Name | Tipo | Default value | Description |
---|---|---|---|
allowTaskPreemption |
boolean |
Se as Tarefas neste trabalho podem ser preempidas por outras tarefas de alta prioridade |
|
commonEnvironmentSettings |
A lista de definições de variáveis de ambiente comuns. Estas variáveis de ambiente são definidas para todas as Tarefas na Tarefa (incluindo o Gestor de Tarefas, a Preparação de Trabalhos e as Tarefas de Lançamento de Trabalhos). |
||
constraints |
As restrições de execução de uma Tarefa. |
||
displayName |
string |
O nome a apresentar da Tarefa. |
|
id |
string |
Uma cadeia que identifica exclusivamente a Tarefa na Conta. |
|
jobManagerTask |
Detalhes de uma Tarefa do Gestor de Tarefas a iniciar quando a Tarefa for iniciada. |
||
jobPreparationTask |
A tarefa de preparação da tarefa. |
||
jobReleaseTask |
A tarefa de lançamento da tarefa. |
||
maxParallelTasks |
integer |
-1 |
O número máximo de tarefas que podem ser executadas em paralelo para a tarefa. |
metadata |
Uma lista de pares nome-valor associados à Tarefa como metadados. |
||
networkConfiguration |
A configuração de rede para a Tarefa. |
||
onAllTasksComplete |
A ação que o serviço Batch deve efetuar quando todas as Tarefas na Tarefa estiverem no estado concluído. |
||
onTaskFailure |
A ação que o serviço Batch deve efetuar quando qualquer Tarefa na Tarefa falhar. |
||
poolInfo |
O Conjunto no qual o serviço Batch executa as Tarefas da Tarefa. |
||
priority |
integer |
A prioridade da Tarefa. |
|
usesTaskDependencies |
boolean |
Se as Tarefas na Tarefa podem definir dependências entre si. A predefinição é false. |
JobConstraints
As restrições de execução de uma Tarefa.
Name | Tipo | Description |
---|---|---|
maxTaskRetryCount |
integer |
O número máximo de vezes que cada Tarefa pode ser repetida. O serviço Batch repetirá uma Tarefa se o código de saída não forzero. |
maxWallClockTime |
string |
O tempo máximo decorrido que a Tarefa pode executar, medido a partir do momento em que a Tarefa é criada. |
JobManagerTask
Especifica detalhes de uma Tarefa do Gestor de Tarefas.
Name | Tipo | Description |
---|---|---|
allowLowPriorityNode |
boolean |
Se a Tarefa do Gestor de Tarefas pode ser executada num Nó de Computação Spot/De baixa prioridade. |
applicationPackageReferences |
Uma lista de Pacotes de Aplicações que o serviço Batch irá implementar no Nó de Computação antes de executar a linha de comandos. |
|
authenticationTokenSettings |
As definições de um token de autenticação que a Tarefa pode utilizar para efetuar operações de serviço do Batch. |
|
commandLine |
string |
A linha de comandos da Tarefa do Gestor de Tarefas. |
constraints |
Restrições que se aplicam à Tarefa do Gestor de Tarefas. |
|
containerSettings |
As definições do contentor no qual a Tarefa do Gestor de Tarefas é executada. |
|
displayName |
string |
O nome a apresentar da Tarefa do Gestor de Tarefas. |
environmentSettings |
Uma lista de definições de variáveis de ambiente para a Tarefa do Gestor de Tarefas. |
|
id |
string |
Uma cadeia que identifica exclusivamente a Tarefa do Gestor de Tarefas na Tarefa. |
killJobOnCompletion |
boolean |
Se a conclusão da Tarefa do Gestor de Tarefas significa a conclusão de toda a Tarefa. |
outputFiles |
Uma lista de ficheiros que o serviço Batch irá carregar a partir do Nó de Computação depois de executar a linha de comandos. |
|
requiredSlots |
integer |
O número de blocos de agendamento necessários para a execução da Tarefa. |
resourceFiles |
Uma lista de ficheiros que o serviço Batch irá transferir para o Nó de Computação antes de executar a linha de comandos. |
|
runExclusive |
boolean |
Se a Tarefa do Gestor de Tarefas requer a utilização exclusiva do Nó de Computação onde é executada. |
userIdentity |
A identidade de utilizador na qual a Tarefa do Gestor de Tarefas é executada. |
JobNetworkConfiguration
A configuração de rede da Tarefa.
Name | Tipo | Description |
---|---|---|
subnetId |
string |
O identificador de recursos do ARM da sub-rede de rede virtual a que os Nós de Computação que executam Tarefas a partir da Tarefa serão associados durante a Tarefa. Isto só funcionará com um Conjunto VirtualMachineConfiguration. |
JobPreparationTask
Uma Tarefa de Preparação de Tarefas a executar antes de quaisquer Tarefas da Tarefa num determinado Nó de Computação.
Name | Tipo | Description |
---|---|---|
commandLine |
string |
A linha de comandos da Tarefa de Preparação de Tarefas. |
constraints |
Restrições aplicáveis à Tarefa de Preparação de Tarefas. |
|
containerSettings |
As definições do contentor no qual a Tarefa de Preparação de Tarefas é executada. |
|
environmentSettings |
Uma lista de definições de variáveis de ambiente para a Tarefa de Preparação de Tarefas. |
|
id |
string |
Uma cadeia que identifica exclusivamente a Tarefa de Preparação de Tarefas na Tarefa. |
rerunOnNodeRebootAfterSuccess |
boolean |
Se o serviço Batch deve executar novamente a Tarefa de Preparação de Tarefas após o reinício de um Nó de Computação. |
resourceFiles |
Uma lista de ficheiros que o serviço Batch irá transferir para o Nó de Computação antes de executar a linha de comandos. |
|
userIdentity |
A identidade de utilizador na qual a Tarefa de Preparação de Tarefas é executada. |
|
waitForSuccess |
boolean |
Se o serviço Batch deve aguardar que a Tarefa de Preparação da Tarefa seja concluída com êxito antes de agendar quaisquer outras Tarefas da Tarefa no Nó de Computação. Uma Tarefa de Preparação de Tarefas foi concluída com êxito se sair com o código de saída 0. |
JobReleaseTask
Uma Tarefa de Libertação de Tarefas para ser executada na conclusão da tarefa em qualquer Nó de Computação onde a Tarefa tenha sido executada.
Name | Tipo | Description |
---|---|---|
commandLine |
string |
A linha de comandos da Tarefa de Libertação de Tarefas. |
containerSettings |
As definições do contentor no qual a Tarefa de Lançamento de Tarefas é executada. |
|
environmentSettings |
Uma lista de definições de variáveis de ambiente para a Tarefa de Lançamento de Tarefas. |
|
id |
string |
Uma cadeia que identifica exclusivamente a Tarefa de Libertação de Tarefas na Tarefa. |
maxWallClockTime |
string |
O tempo máximo decorrido que a Tarefa de Lançamento da Tarefa pode ser executada num determinado Nó de Computação, medido a partir do momento em que a Tarefa é iniciada. Se a Tarefa não estiver concluída dentro do limite de tempo, o serviço Batch termina-a. O valor predefinido é 15 minutos. Não pode especificar um tempo limite superior a 15 minutos. Se o fizer, o serviço Batch rejeita-o com um erro; se estiver a chamar a API REST diretamente, o código de estado HTTP é 400 (Pedido Incorreto). |
resourceFiles |
Uma lista de ficheiros que o serviço Batch irá transferir para o Nó de Computação antes de executar a linha de comandos. Existe um tamanho máximo para a lista de ficheiros de recursos. Quando o tamanho máximo for excedido, o pedido falhará e o código de erro de resposta será RequestEntityTooLarge. Se isto ocorrer, a coleção de ResourceFiles tem de ser reduzida em tamanho. Isto pode ser conseguido com .zip ficheiros, Pacotes de Aplicações ou Contentores do Docker. |
|
retentionTime |
string |
O tempo mínimo para manter o diretório Tarefa da Tarefa de Lançamento de Tarefas no Nó de Computação. Após esta altura, o serviço Batch poderá eliminar o diretório Tarefa e todos os respetivos conteúdos. |
userIdentity |
A identidade de utilizador na qual a Tarefa de Lançamento de Tarefas é executada. |
LinuxUserConfiguration
Propriedades utilizadas para criar uma Conta de utilizador num Nó de Computação do Linux.
Name | Tipo | Description |
---|---|---|
gid |
integer |
O ID de grupo da Conta de utilizador. |
sshPrivateKey |
string |
A chave privada SSH para a Conta de utilizador. |
uid |
integer |
O ID de utilizador da Conta de utilizador. |
LoginMode
O modo de início de sessão do utilizador
Name | Tipo | Description |
---|---|---|
batch |
string |
O LOGON32_LOGON_BATCH modo de início de sessão win32. O modo de início de sessão em lote é recomendado para processos paralelos de execução prolongada. |
interactive |
string |
O LOGON32_LOGON_INTERACTIVE modo de início de sessão win32. O UAC está ativado em Conjuntos Windows VirtualMachineConfiguration. Se esta opção for utilizada com uma identidade de utilizador elevada num Conjunto de VirtualMachineConfiguration do Windows, a sessão de utilizador não será elevada, a menos que a aplicação executada pela linha de comandos Tarefa esteja configurada para exigir sempre privilégios administrativos ou para exigir sempre o máximo de privilégios. |
ManagedDisk
Name | Tipo | Description |
---|---|---|
storageAccountType |
O tipo de conta de armazenamento para o disco gerido. |
MetadataItem
Um par name-value associado a um recurso do serviço Batch.
Name | Tipo | Description |
---|---|---|
name |
string |
O nome do item de metadados. |
value |
string |
O valor do item de metadados. |
MountConfiguration
O sistema de ficheiros a montar em cada nó.
Name | Tipo | Description |
---|---|---|
azureBlobFileSystemConfiguration |
O Contentor de Armazenamento do Azure a montar com o FUSE de blobs em cada nó. |
|
azureFileShareConfiguration |
A Partilha de Ficheiros do Azure a montar em cada nó. |
|
cifsMountConfiguration |
O sistema de ficheiros CIFS/SMB a montar em cada nó. |
|
nfsMountConfiguration |
O sistema de ficheiros NFS a montar em cada nó. |
NetworkConfiguration
A configuração de rede de um Conjunto.
Name | Tipo | Description |
---|---|---|
dynamicVNetAssignmentScope |
O âmbito da atribuição de vnet dinâmica. |
|
enableAcceleratedNetworking |
boolean |
Se este conjunto deve ativar a rede acelerada. |
endpointConfiguration |
A configuração para pontos finais em Nós de Computação no Conjunto do Batch. |
|
publicIPAddressConfiguration |
A configuração ipAddress público para Nós de Computação no Conjunto do Batch. |
|
subnetId |
string |
O identificador do recurso ARM da sub-rede de rede virtual à qual serão associados os Nós de Computação do Conjunto. Este é do formulário /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. |
NetworkSecurityGroupRule
Uma regra de grupo de segurança de rede a aplicar a um ponto final de entrada.
Name | Tipo | Description |
---|---|---|
access |
A ação que deve ser efetuada para um endereço IP especificado, intervalo de sub-rede ou etiqueta. |
|
priority |
integer |
A prioridade para esta regra. |
sourceAddressPrefix |
string |
O prefixo ou etiqueta do endereço de origem a corresponder à regra. |
sourcePortRanges |
string[] |
Os intervalos de portas de origem a corresponder à regra. |
NetworkSecurityGroupRuleAccess
A ação que deve ser efetuada para um endereço IP especificado, intervalo de sub-rede ou etiqueta.
Name | Tipo | Description |
---|---|---|
allow |
string |
Permitir acesso. |
deny |
string |
Negar acesso. |
NFSMountConfiguration
Informações utilizadas para ligar a um sistema de ficheiros NFS.
Name | Tipo | Description |
---|---|---|
mountOptions |
string |
Opções adicionais da linha de comandos para passar para o comando de montagem. |
relativeMountPath |
string |
O caminho relativo no nó de computação onde o sistema de ficheiros será montado |
source |
string |
O URI do sistema de ficheiros a montar. |
NodeCommunicationMode
Determina como um conjunto comunica com o serviço Batch.
Name | Tipo | Description |
---|---|---|
classic |
string |
Os nós que utilizam o modo de comunicação clássica requerem comunicação TCP de entrada nas portas 29876 e 29877 a partir do "BatchNodeManagement. {region}" etiqueta de serviço e comunicação TCP de saída na porta 443 para "Storage.region" e "BatchNodeManagement. {region}" etiquetas de serviço. |
default |
string |
O modo de comunicação do nó é definido automaticamente pelo serviço Batch. |
simplified |
string |
Os nós que utilizam 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 colocação de nós para um conjunto.
Name | Tipo | Description |
---|---|---|
policy |
Tipo de política de colocação de nós em Conjuntos do Batch. |
NodePlacementPolicyType
A política de colocação para alocar nós no conjunto.
Name | Tipo | Description |
---|---|---|
regional |
string |
Todos os nós no conjunto serão alocados na mesma região. |
zonal |
string |
Os nós no conjunto serão distribuídos por diferentes zonas de disponibilidade com melhor balanceamento de esforço. |
OnAllTasksComplete
A ação que o serviço Batch deve tomar quando todas as Tarefas na Tarefa estiverem no estado concluído.
Name | Tipo | Description |
---|---|---|
noaction |
string |
Não fazer nada. A Tarefa permanece ativa, a menos que seja terminada ou desativada por outros meios. |
terminatejob |
string |
Termine a Tarefa. A Função terminateReason está definida como "AllTasksComplete". |
OnTaskFailure
A ação que o serviço Batch deve efetuar quando qualquer Tarefa na Tarefa falhar.
Name | Tipo | Description |
---|---|---|
noaction |
string |
Não fazer nada. A Tarefa permanece ativa, a menos que seja terminada ou desativada por outros meios. |
performexitoptionsjobaction |
string |
Efetue a ação associada à condição de saída da tarefa na coleção exitConditions da Tarefa. (Isto ainda pode resultar na não realização de nenhuma ação, se for o que a Tarefa especifica.) |
OSDisk
Definições para o disco do sistema operativo do nó de computação (VM).
Name | Tipo | Description |
---|---|---|
caching |
Especifica os requisitos de colocação em cache. Os valores possíveis são: Nenhum, ReadOnly, ReadWrite. Os valores predefinidos são: Nenhum para o armazenamento Standard. ReadOnly para armazenamento Premium. |
|
diskSizeGB |
integer |
O tamanho inicial do disco em GB ao criar um novo disco do SO. |
ephemeralOSDiskSettings |
Especifica as Definições de Disco efémero para o disco do sistema operativo utilizado pelo nó de computação (VM). |
|
managedDisk |
Os parâmetros do disco gerido. |
|
writeAcceleratorEnabled |
boolean |
Especifica se writeAccelerator deve ser ativado ou desativado no disco. |
OutputFile
Uma especificação para carregar ficheiros a partir de um Nó de Computação Azure Batch para outra localização depois de o serviço Batch ter terminado de executar o processo de Tarefa.
Name | Tipo | Description |
---|---|---|
destination |
O destino dos ficheiros de saída. |
|
filePattern |
string |
Um padrão que indica quais os ficheiros a carregar. |
uploadOptions |
Opções adicionais para a operação de carregamento, incluindo em que condições efetuar o carregamento. |
OutputFileBlobContainerDestination
Especifica um destino de carregamento de ficheiros num contentor de armazenamento de blobs do Azure.
Name | Tipo | Description |
---|---|---|
containerUrl |
string |
O URL do contentor no Armazenamento de Blobs do Azure para o qual carregar o(s) ficheiro(s). |
identityReference |
A referência à identidade atribuída pelo utilizador a utilizar para aceder a Armazenamento de Blobs do Azure especificado pelo containerUrl |
|
path |
string |
O blob de destino ou o diretório virtual no contentor do Armazenamento do Azure. |
uploadHeaders |
Uma lista de pares nome-valor para cabeçalhos a serem utilizados no carregamento de ficheiros de saída |
OutputFileDestination
O destino para o qual um ficheiro deve ser carregado.
Name | Tipo | Description |
---|---|---|
container |
Uma localização no armazenamento de blobs do Azure para a qual os ficheiros são carregados. |
OutputFileUploadCondition
As condições nas quais um ficheiro de saída de tarefa ou conjunto de ficheiros deve ser carregado.
Name | Tipo | Description |
---|---|---|
taskcompletion |
string |
Carregue o(s) ficheiro(s) após o processo de tarefa sair, independentemente do código de saída. |
taskfailure |
string |
Carregue o(s) ficheiro(s) apenas após o processo de tarefa sair com um código de saída diferente de zero. |
tasksuccess |
string |
Carregue o(s) ficheiro(s) apenas após o processo de tarefa sair com um código de saída de 0. |
OutputFileUploadOptions
Detalhes sobre uma operação de carregamento de ficheiros de saída, incluindo em que condições efetuar o carregamento.
Name | Tipo | Description |
---|---|---|
uploadCondition |
As condições em que o ficheiro de saída da tarefa ou o conjunto de ficheiros devem ser carregados. |
PoolEndpointConfiguration
A configuração do ponto final de um Conjunto.
Name | Tipo | Description |
---|---|---|
inboundNATPools |
Uma lista de Conjuntos NAT de entrada que podem ser utilizados para abordar portas específicas num Nó de Computação individual externamente. |
PoolInformation
Especifica como uma Tarefa deve ser atribuída a um Conjunto.
Name | Tipo | Description |
---|---|---|
autoPoolSpecification |
Características de um "conjunto automático" temporário. O serviço Batch irá criar este Conjunto Automático quando a Tarefa for submetida. |
|
poolId |
string |
O ID de um Conjunto existente. Todas as Tarefas da Tarefa serão executadas no Conjunto especificado. |
PoolLifetimeOption
A duração mínima dos conjuntos automáticos criados e a forma como várias Tarefas numa agenda são atribuídas a Conjuntos.
Name | Tipo | Description |
---|---|---|
job |
string |
O Conjunto existe durante a duração da Tarefa à qual é dedicada. O serviço Batch cria o Conjunto quando cria a Tarefa. Se a opção "tarefa" for aplicada a uma Agenda de Tarefas, o serviço Batch cria um novo Conjunto Automático para cada Tarefa criada na agenda. |
jobschedule |
string |
O Conjunto existe para a duração da Agenda de Tarefas. O Serviço Batch cria o Conjunto quando cria a primeira Tarefa na agenda. Pode aplicar esta opção apenas a Agendas de Tarefas e não a Tarefas. |
PoolSpecification
Especificação para criar um novo Conjunto.
Name | Tipo | Description |
---|---|---|
applicationLicenses |
string[] |
A lista de licenças de aplicações que o serviço Batch disponibilizará em cada Nó de Computação no Conjunto. |
applicationPackageReferences |
A lista de Pacotes a instalar em cada Nó de Computação no Conjunto. |
|
autoScaleEvaluationInterval |
string |
O intervalo de tempo no qual ajustar automaticamente o tamanho do Conjunto de acordo com a fórmula de dimensionamento automático. |
autoScaleFormula |
string |
A fórmula para o número pretendido de Nós de Computação no Conjunto. |
certificateReferences |
Uma lista de Certificados a instalar em cada Nó de Computação no Conjunto. Aviso: esta propriedade foi preterida e será removida após fevereiro de 2024. Em alternativa, utilize a Extensão Azure KeyVault . |
|
cloudServiceConfiguration |
A configuração do serviço cloud para o Conjunto. |
|
displayName |
string |
O nome a apresentar do Conjunto. |
enableAutoScale |
boolean |
Se o tamanho do Conjunto deve ser ajustado automaticamente ao longo do tempo. |
enableInterNodeCommunication |
boolean |
Se o Conjunto permite a comunicação direta entre Nós de Computação. |
metadata |
Uma lista de pares nome-valor associados ao Conjunto como metadados. |
|
mountConfiguration |
Uma lista de sistemas de ficheiros a montar em cada nó no conjunto. |
|
networkConfiguration |
A configuração de rede para o Conjunto. |
|
resizeTimeout |
string |
O tempo limite para a alocação de Nós de Computação no Conjunto. |
resourceTags |
object |
As etiquetas especificadas pelo utilizador associadas ao conjunto. |
startTask |
Uma Tarefa a executar em cada Nó de Computação à medida que se associa ao Conjunto. A Tarefa é executada quando o Nó de Computação é adicionado ao Conjunto ou quando o Nó de Computação é reiniciado. |
|
targetDedicatedNodes |
integer |
O número pretendido de Nós de Computação dedicados no Conjunto. |
targetLowPriorityNodes |
integer |
O número pretendido de Nós de Computação Spot/Low-priority no Conjunto. |
targetNodeCommunicationMode |
O modo de comunicação do nó pretendido para o conjunto. |
|
taskSchedulingPolicy |
Como as Tarefas são distribuídas pelos Nós de Computação num Conjunto. |
|
taskSlotsPerNode |
integer |
O número de blocos de tarefas que podem ser utilizados para executar tarefas simultâneas num único nó de computação no conjunto. |
userAccounts |
A lista de Contas de utilizador a criar em cada Nó de Computação no Conjunto. |
|
virtualMachineConfiguration |
A configuração da máquina virtual para o Conjunto. |
|
vmSize |
string |
O tamanho das máquinas virtuais no Conjunto. Todas as máquinas virtuais num Conjunto têm o mesmo tamanho. |
PublicIPAddressConfiguration
A configuração do Endereço IP público da configuração de rede de um Conjunto.
Name | Tipo | Description |
---|---|---|
ipAddressIds |
string[] |
A lista de IPs públicos que o serviço Batch irá utilizar ao aprovisionar Nós de Computação. |
provision |
O tipo de aprovisionamento para Endereços IP Públicos para o Conjunto. |
ResourceFile
Um único ficheiro ou vários ficheiros a transferir para um Nó de Computação.
Name | Tipo | Description |
---|---|---|
autoStorageContainerName |
string |
O nome do contentor de armazenamento na Conta de armazenamento automático. |
blobPrefix |
string |
O prefixo de blobs a utilizar ao transferir blobs a partir de um contentor do Armazenamento do Azure. Apenas os blobs cujos nomes começam com o prefixo especificado serão transferidos. |
fileMode |
string |
O atributo do modo de permissão de ficheiro no formato octal. |
filePath |
string |
A localização no Nó de Computação para o qual transferir os ficheiros, relativamente ao diretório de trabalho da Tarefa. |
httpUrl |
string |
O URL do ficheiro a transferir. |
identityReference |
A referência à identidade atribuída pelo utilizador a utilizar para aceder a Armazenamento de Blobs do Azure especificado por storageContainerUrl ou httpUrl |
|
storageContainerUrl |
string |
O URL do contentor de blobs no Armazenamento de Blobs do Azure. |
SecurityProfile
Especifica as definições de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais.
Name | Tipo | Description |
---|---|---|
encryptionAtHost |
boolean |
Esta propriedade pode ser utilizada pelo utilizador no pedido para ativar ou desativar a Encriptação de Anfitrião para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais. Isto irá ativar a encriptação para todos os discos, incluindo o disco Resource/Temp no próprio anfitrião. |
securityType |
Especifica o SecurityType da máquina virtual. Tem de ser definido como qualquer valor especificado para ativar UefiSettings. |
|
uefiSettings |
Especifica as definições de segurança, como o arranque seguro e o vTPM utilizados ao criar a máquina virtual. |
SecurityTypes
Especifica o SecurityType da máquina virtual. Tem de ser definido para qualquer valor especificado para ativar UefiSettings.
Name | Tipo | Description |
---|---|---|
trustedLaunch |
string |
O lançamento fidedigno protege contra técnicas de ataque avançadas e persistentes. |
ServiceArtifactReference
Especifica o ID de referência do artefacto de serviço utilizado para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de dimensionamento ao utilizar a versão de imagem "mais recente".
Name | Tipo | Description |
---|---|---|
id |
string |
O ID de referência do artefacto de serviço de ServiceArtifactReference |
StartTask
Uma Tarefa que é executada quando um Nó associa um Conjunto no serviço Azure Batch ou quando o Nó de Computação é reiniciado ou recriado.
Name | Tipo | Description |
---|---|---|
commandLine |
string |
A linha de comandos do StartTask. |
containerSettings |
As definições do contentor no qual o StartTask é executado. |
|
environmentSettings |
Uma lista de definições de variáveis de ambiente para StartTask. |
|
maxTaskRetryCount |
integer |
O número máximo de vezes que a Tarefa pode ser repetida. |
resourceFiles |
Uma lista de ficheiros que o serviço Batch irá transferir para o Nó de Computação antes de executar a linha de comandos. Existe um tamanho máximo para a lista de ficheiros de recursos. Quando o tamanho máximo for excedido, o pedido falhará e o código de erro de resposta será RequestEntityTooLarge. Se isto ocorrer, a coleção de ResourceFiles tem de ser reduzida em tamanho. Isto pode ser conseguido com .zip ficheiros, Pacotes de Aplicações ou Contentores do Docker. |
|
userIdentity |
A identidade de utilizador na qual o StartTask é executado. |
|
waitForSuccess |
boolean |
Se o serviço Batch deve aguardar que o StartTask seja concluído com êxito (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 utilização na criação de discos de dados ou disco do SO.
Name | Tipo | Description |
---|---|---|
premium_lrs |
string |
O disco de dados/disco do SO deve utilizar o armazenamento localmente redundante premium. |
standard_lrs |
string |
O disco de dados/disco do SO deve utilizar o armazenamento localmente redundante padrão. |
standardssd_lrs |
string |
O disco de dados/disco do SO deve utilizar o armazenamento SSD localmente redundante padrão. |
TaskConstraints
Restrições de execução a aplicar a uma Tarefa.
Name | Tipo | Description |
---|---|---|
maxTaskRetryCount |
integer |
O número máximo de vezes que a Tarefa pode ser repetida. O serviço Batch repetirá 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 desde o início da Tarefa. Se a Tarefa não for concluída dentro do limite de tempo, o serviço Batch termina-a. |
retentionTime |
string |
O tempo mínimo para manter o diretório Tarefa no Nó de Computação onde foi executado, desde o momento em que conclui a execução. Após este período de tempo, o serviço Batch poderá eliminar o diretório Tarefas e todos os respetivos conteúdos. |
TaskContainerSettings
As definições de contentor para uma Tarefa.
Name | Tipo | Description |
---|---|---|
containerRunOptions |
string |
Opções adicionais para o comando de criação de contentor. |
imageName |
string |
A Imagem a utilizar para criar o contentor no qual a Tarefa será executada. |
registry |
O registo privado que contém o contentor Imagem. |
|
workingDirectory |
A localização do diretório de trabalho tarefa do contentor. |
TaskSchedulingPolicy
Especifica como as Tarefas devem ser distribuídas pelos Nós de Computação.
Name | Tipo | Description |
---|---|---|
nodeFillType |
Como as Tarefas são distribuídas pelos Nós de Computação num Conjunto. |
UefiSettings
Especifica as definições de segurança, como o arranque seguro e o vTPM utilizados ao criar a máquina virtual.
Name | Tipo | Description |
---|---|---|
secureBootEnabled |
boolean |
Especifica se o arranque seguro deve ser ativado na máquina virtual. |
vTpmEnabled |
boolean |
Especifica se o vTPM deve ser ativado na máquina virtual. |
UserAccount
Propriedades utilizadas para criar um utilizador utilizado para executar Tarefas num Nó de Computação Azure Batch.
Name | Tipo | Description |
---|---|---|
elevationLevel |
O nível de elevação da Conta de utilizador. |
|
linuxUserConfiguration |
A configuração de utilizador específica do Linux para a Conta de utilizador. |
|
name |
string |
O nome da Conta de utilizador. Os nomes podem conter carateres Unicode até um comprimento máximo de 20. |
password |
string |
A palavra-passe da Conta de utilizador. |
windowsUserConfiguration |
A configuração de utilizador específica do Windows para a Conta de utilizador. |
UserIdentity
A definição da identidade de utilizador na qual a Tarefa é executada.
Name | Tipo | Description |
---|---|---|
autoUser |
O utilizador automático no qual a Tarefa é executada. |
|
username |
string |
O nome da identidade de utilizador na qual a Tarefa é executada. |
VirtualMachineConfiguration
A configuração para Nós de Computação num Conjunto com base na infraestrutura de Máquinas Virtuais do Azure.
Name | Tipo | Description |
---|---|---|
containerConfiguration |
A configuração do contentor para o Conjunto. |
|
dataDisks |
Data |
A configuração dos discos de dados anexados aos Nós de Computação no Conjunto. |
diskEncryptionConfiguration |
A configuração de encriptação do disco para o conjunto. |
|
extensions |
A extensão da máquina virtual para o conjunto. |
|
imageReference |
Uma referência à Imagem do Azure Máquinas Virtuais Marketplace ou à Imagem de Máquina Virtual personalizada a utilizar. |
|
licenseType |
string |
O tipo de licença no local a utilizar ao implementar o sistema operativo. Windows_Server – a licença no local destina-se ao Windows Server. Windows_Client - A licença no local é para o Cliente Windows. |
nodeAgentSKUId |
string |
O SKU do agente do Nó de Computação do Batch a aprovisionar em Nós de Computação no Conjunto. |
nodePlacementConfiguration |
A configuração de colocação do nó para o conjunto. |
|
osDisk |
Definições para o disco do sistema operativo da Máquina Virtual. |
|
securityProfile |
Especifica as definições do perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais. |
|
serviceArtifactReference |
Especifica o ID de referência do artefacto de serviço utilizado para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de dimensionamento ao utilizar a versão de imagem "mais recente". |
|
windowsConfiguration |
Definições do sistema operativo Windows na máquina virtual. |
VMExtension
A configuração para extensões de máquinas virtuais.
Name | Tipo | Description |
---|---|---|
autoUpgradeMinorVersion |
boolean |
Indica se a extensão deve utilizar uma versão secundária mais recente se uma estiver disponível no momento da implementação. No entanto, depois de implementada, a extensão não atualizará versões secundárias, a menos que seja reimplementada, mesmo com esta propriedade definida como verdadeira. |
enableAutomaticUpgrade |
boolean |
Indica se a extensão deve ser atualizada automaticamente pela plataforma se existir 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 definição protegida. |
provisionAfterExtensions |
string[] |
A coleção de nomes de extensões. |
publisher |
string |
O nome do editor do processador de extensões. |
settings |
object |
Definições públicas formatadas por JSON para a extensão. |
type |
string |
O tipo da extensão. |
typeHandlerVersion |
string |
A versão do processador de scripts. |
WindowsConfiguration
Definições do sistema operativo Windows a aplicar à máquina virtual.
Name | Tipo | Description |
---|---|---|
enableAutomaticUpdates |
boolean |
Se as atualizações automáticas estão ativadas na máquina virtual. |
WindowsUserConfiguration
Propriedades utilizadas para criar uma Conta de utilizador num Nó de Computação do Windows.
Name | Tipo | Description |
---|---|---|
loginMode |
O modo de início de sessão do utilizador |