Pool - Get
Obtém informações sobre o Conjunto especificado.
GET {batchUrl}/pools/{poolId}?api-version=2023-11-01.18.0
GET {batchUrl}/pools/{poolId}?$select={$select}&$expand={$expand}&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. |
pool
|
path | True |
string |
O ID do Conjunto a obter. |
api-version
|
query | True |
string |
Versão da API de Cliente. |
$expand
|
query |
string |
Uma cláusula OData $expand. |
|
$select
|
query |
string |
Uma cláusula OData $select. |
|
timeout
|
query |
integer int32 |
O tempo máximo que o servidor pode passar 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, na 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-o explicitamente se estiver a chamar a API REST diretamente. |
|
If-Match |
string |
Um valor ETag associado à versão do recurso conhecido pelo cliente. A operação só será efetuada se o ETag atual do recurso no serviço corresponder exatamente ao valor especificado pelo cliente. |
|
If-None-Match |
string |
Um valor ETag associado à versão do recurso conhecido pelo cliente. A operação só será efetuada se o 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 última hora modificada do recurso conhecido pelo cliente. A operação só será efetuada 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 última hora modificada do recurso conhecido pelo cliente. A operação só será efetuada se o recurso no serviço não tiver sido modificado desde a hora especificada. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Uma resposta que contém o Conjunto. 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 VirtualMachineConfiguration pool with OS disk
Pedido de amostra
GET account.region.batch.azure.com/pools/mypool001?api-version=2023-11-01.18.0
Resposta da amostra
{
"id": "mypool001",
"url": "http://localhost:20302/testaccount1tls/pools/mypool001",
"eTag": "0x8DBA3B4E91CD7B7",
"lastModified": "2023-08-23T08:42:40.3479479Z",
"creationTime": "2023-08-23T08:42:40.3479479Z",
"state": "active",
"stateTransitionTime": "2023-08-23T08:42:40.3479479Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2023-08-23T08:42:53.8587829Z",
"vmSize": "standard_d2s_v3",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 1,
"targetDedicatedNodes": 1,
"currentLowPriorityNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "0001-com-ubuntu-server-focal",
"sku": "20_04-lts",
"version": "latest"
},
"osDisk": {
"ephemeralOSDiskSettings": {
"placement": "CacheDisk"
},
"managedDisk": {
"storageAccountType": "standardssd_lrs"
},
"diskSizeGB": 100,
"caching": "readwrite"
},
"nodeAgentSKUId": "batch.node.ubuntu 20.04"
},
"currentNodeCommunicationMode": "classic"
}
Get a pool with AcceleratedNetworking
Pedido de amostra
GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0
Resposta da amostra
{
"id": "pool",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8DB4792BE8566A2",
"lastModified": "2023-04-28T02:46:19.0268066Z",
"creationTime": "2023-04-28T02:46:19.0268066Z",
"state": "active",
"stateTransitionTime": "2023-04-28T02:46:19.0268066Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2023-04-28T02:47:17.9169655Z",
"vmSize": "standard_d1_v2",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 2,
"targetDedicatedNodes": 2,
"currentLowPriorityNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2016-datacenter-smalldisk",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.windows amd64"
},
"networkConfiguration": {
"dynamicVNetAssignmentScope": "none",
"enableAcceleratedNetworking": true
},
"currentNodeCommunicationMode": "classic"
}
Get a VirtualMachineConfiguration pool with extensions
Pedido de amostra
GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0
Resposta da amostra
{
"id": "pool",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8D413091E739A56",
"lastModified": "2016-11-22T18:55:25.2608598Z",
"creationTime": "2016-11-22T18:55:24.2632496Z",
"state": "active",
"stateTransitionTime": "2016-11-22T18:55:24.2632496Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z",
"vmSize": "standard_a1",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 0,
"currentLowPriorityNodes": 0,
"targetDedicatedNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"startTask": {
"commandLine": "/bin/bash -c 'echo start task'",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "0001-com-ubuntu-server-focal",
"sku": "20_04-lts",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.ubuntu 20.04",
"extensions": [
{
"name": "batchextension1",
"type": "KeyVaultForLinux",
"publisher": "Microsoft.Azure.KeyVault",
"typeHandlerVersion": "2.0",
"autoUpgradeMinorVersion": true,
"enableAutomaticUpgrade": true,
"settings": "{\"secretsManagementSettingsKey\":\"secretsManagementSettingsValue\",\"authenticationSettingsKey\":\"authenticationSettingsValue\"}"
}
]
},
"targetNodeCommunicationMode": "classic",
"currentNodeCommunicationMode": "classic"
}
Get a VirtualMachineConfiguration pool with SecurityProfile
Pedido de amostra
GET account.region.batch.azure.com/pools/mypool001?api-version=2023-11-01.18.0
Resposta da amostra
{
"id": "mypool001",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8DB6CA2DFF530D1",
"lastModified": "2023-06-14T06:45:00.0946897Z",
"creationTime": "2023-06-14T06:45:00.0946897Z",
"state": "active",
"stateTransitionTime": "2023-06-14T06:45:00.0946897Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2023-06-14T06:45:59.4770341Z",
"vmSize": "standard_dc2s_v2",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 1,
"targetDedicatedNodes": 1,
"currentLowPriorityNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "UbuntuServer",
"sku": "18_04-lts-gen2",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.ubuntu 18.04",
"securityProfile": {
"securityType": "trustedLaunch",
"encryptionAtHost": true,
"uefiSettings": {
"secureBootEnabled": false
}
}
},
"currentNodeCommunicationMode": "classic"
}
Get a VirtualMachineConfiguration pool with ServiceArtifactReference
Pedido de amostra
GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0
Resposta da amostra
{
"id": "pool",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8DB51F652DFC78F",
"lastModified": "2023-05-11T08:04:19.7259151Z",
"creationTime": "2023-05-11T08:04:19.7259151Z",
"state": "active",
"stateTransitionTime": "2023-05-11T08:04:19.7259151Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2023-05-11T08:05:22.0020052Z",
"vmSize": "standard_a1_v2",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 2,
"targetDedicatedNodes": 2,
"currentLowPriorityNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2016-datacenter-smalldisk",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.windows amd64",
"windowsConfiguration": {
"enableAutomaticUpdates": false
},
"serviceArtifactReference": {
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile"
}
},
"currentNodeCommunicationMode": "classic"
}
Pool get
Pedido de amostra
GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0
Resposta da amostra
{
"id": "pool",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8D413091E739A56",
"lastModified": "2016-11-22T18:55:25.2608598Z",
"creationTime": "2016-11-22T18:55:24.2632496Z",
"state": "active",
"stateTransitionTime": "2016-11-22T18:55:24.2632496Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z",
"vmSize": "standard_a1",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 0,
"currentLowPriorityNodes": 0,
"targetDedicatedNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"startTask": {
"commandLine": "/bin/bash -c 'echo start task'",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "0001-com-ubuntu-server-focal",
"sku": "20_04-lts",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.ubuntu 20.04"
}
}
Definições
Name | Description |
---|---|
Allocation |
Se o Conjunto está a ser redimensionado. |
Application |
Uma referência a um Pacote a ser implementado em Nós de Computação. |
Auto |
Os resultados e erros de uma execução de uma fórmula de dimensionamento automático do Conjunto. |
Auto |
Erro que ocorreu ao executar ou avaliar uma fórmula de dimensionamento automático do Conjunto. |
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. |
Batch |
A identidade do conjunto do Batch, se configurada. |
Caching |
O tipo de colocação em cache a ativar para o disco. |
Certificate |
Uma referência a um Certificado a ser instalado em Nós de Computação num Conjunto. |
Certificate |
A localização do Arquivo de certificados no Nó de Computação no qual instalar o Certificado. |
Certificate |
Que utilizador As Contas 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 |
Um Conjunto no serviço Azure Batch. |
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 a colocação 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 discos não é suportada no conjunto do 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. |
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 de Imagem do 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 de Lotes externamente. |
IPAddress |
O tipo de aprovisionamento para Endereços IP Públicos para o Conjunto. |
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ó. |
Name |
Representa um par nome-valor. |
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. |
OSDisk |
Definições para o disco do sistema operativo do nó de computação (VM). |
Pool |
A configuração do ponto final para um Conjunto. |
Pool |
A identidade do conjunto do Batch, se configurada. |
Pool |
O estado atual do Conjunto. |
Pool |
Contém estatísticas de utilização e utilização de recursos para a duração de um Conjunto. |
Public |
A configuração do Endereço IP público da configuração de rede de um Conjunto. |
Resize |
Erro que ocorreu ao redimensionar um Conjunto. |
Resource |
Um único ficheiro ou vários ficheiros a transferir para um Nó de Computação. |
Resource |
Estatísticas relacionadas com o consumo de recursos por Nós de Computação num Conjunto. |
Security |
Especifica as definições do 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 como 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 |
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. |
Usage |
Estatísticas relacionadas com informações de utilização do conjunto. |
User |
Propriedades utilizadas para criar um utilizador utilizado para executar Tarefas num Nó de Computação Azure Batch. |
User |
Identidade atribuída pelo utilizador |
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áquina virtual. |
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. |
AllocationState
Se o Conjunto está a ser redimensionado.
Name | Tipo | Description |
---|---|---|
resizing |
string |
O Conjunto está a redimensionar; ou seja, os Nós de Computação estão a ser adicionados ou removidos do Conjunto. |
steady |
string |
O Conjunto não está a redimensionar. Não existem alterações ao número de Nós de Computação no Conjunto em curso. Um Conjunto entra neste estado quando é criado e quando não estão a ser efetuadas operações no Conjunto para alterar o número de Nós de Computação. |
stopping |
string |
O Conjunto foi redimensionado, mas o utilizador pediu que o redimensionamento fosse parado, mas o pedido de paragem ainda não foi concluído. |
ApplicationPackageReference
Uma referência a um Pacote a ser implementado em 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 omitido, a versão predefinida é implementada. |
AutoScaleRun
Os resultados e erros de uma execução de uma fórmula de dimensionamento automático do Conjunto.
Name | Tipo | Description |
---|---|---|
error |
Foram encontrados detalhes do erro ao avaliar a fórmula de dimensionamento automático no Conjunto, se a avaliação não tiver sido bem-sucedida. |
|
results |
string |
Os valores finais de todas as variáveis utilizadas na avaliação da fórmula de dimensionamento automático. |
timestamp |
string |
A hora em que a fórmula de dimensionamento automático foi avaliada pela última vez. |
AutoScaleRunError
Erro que ocorreu ao executar ou avaliar uma fórmula de dimensionamento automático do Conjunto.
Name | Tipo | Description |
---|---|---|
code |
string |
Um identificador para o erro de dimensionamento automático. Os códigos são invariantes e destinam-se a ser consumidos programaticamente. |
message |
string |
Uma mensagem que descreve o erro de dimensionamento automático, que se destina a ser adequada para ser apresentada numa interface de utilizador. |
values |
Uma lista de detalhes de erro adicionais relacionados com o erro de dimensionamento automático. |
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, que se destina 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. |
BatchPoolIdentity
A identidade do conjunto do Batch, se configurada.
Name | Tipo | Description |
---|---|---|
type |
A identidade do conjunto do Batch, se configurada. |
|
userAssignedIdentities |
A lista de identidades de utilizador associadas à conta do Batch. |
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 em 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 pretende 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. Tem de ser sha1. |
visibility |
Que contas de utilizador 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 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 utilizador As Contas 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 o 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. |
CloudPool
Um Conjunto no serviço Azure Batch.
Name | Tipo | Description |
---|---|---|
allocationState |
Se o Conjunto está a ser redimensionado. |
|
allocationStateTransitionTime |
string |
A hora em que o Conjunto entrou no estado de alocação atual. |
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 |
Uma fórmula para o número pretendido de Nós de Computação no Conjunto. |
autoScaleRun |
Os resultados e erros da última execução da fórmula de dimensionamento automático. |
|
certificateReferences |
A 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. |
|
creationTime |
string |
A hora de criação do Conjunto. |
currentDedicatedNodes |
integer |
O número de Nós de Computação dedicados atualmente no Conjunto. |
currentLowPriorityNodes |
integer |
O número de Nós de Computação Spot/Baixa Prioridade atualmente no Conjunto. |
currentNodeCommunicationMode |
O estado atual do modo de comunicação do conjunto. |
|
displayName |
string |
O nome a apresentar do Conjunto. |
eTag |
string |
A ETag do Conjunto. |
enableAutoScale |
boolean |
Se o Tamanho do conjunto deve ajustar-se automaticamente ao longo do tempo. |
enableInterNodeCommunication |
boolean |
Se o Conjunto permite a comunicação direta entre Nós de Computação. |
id |
string |
Uma cadeia que identifica exclusivamente o Conjunto na Conta. |
identity |
A identidade do conjunto do Batch, se configurada. |
|
lastModified |
string |
A hora da última modificação do Conjunto. |
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. |
|
resizeErrors |
Uma lista de erros encontrados ao realizar o último redimensionamento no Conjunto. |
|
resizeTimeout |
string |
O tempo limite para a alocação de Nós de Computação para o Conjunto. |
resourceTags |
object |
As etiquetas especificadas pelo utilizador associadas ao conjunto. |
startTask |
Uma Tarefa especificada para ser executada em cada Nó de Computação à medida que se associa ao Conjunto. |
|
state |
O estado atual do Conjunto. |
|
stateTransitionTime |
string |
A hora em que o Conjunto entrou no estado atual. |
stats |
Estatísticas de utilização e utilização de recursos durante toda a duração do Conjunto. |
|
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/De baixa prioridade 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. |
url |
string |
O URL do 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. |
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 de unidade lógica. |
storageAccountType |
O tipo de Conta de armazenamento a utilizar para o disco de dados. |
DiffDiskPlacement
Especifica a colocação 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 a colocação 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 discos não é suportada no conjunto do Linux criado com a Imagem da Galeria de Computação do Azure.
Name | Tipo | Description |
---|---|---|
targets |
A lista de destinos de disco do Serviço Batch 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. |
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 de Imagem do 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" apenas 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 do Azure Máquinas Virtuais Imagem do Marketplace. |
sku |
string |
O SKU da Imagem do Azure Máquinas Virtuais Marketplace. |
version |
string |
A versão do Azure Máquinas Virtuais Imagem do Marketplace. |
virtualMachineImageId |
string |
O identificador do recurso 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 é 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 obter sempre a predefinição da 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 o 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 de Lotes externamente.
Name | Tipo | Description |
---|---|---|
backendPort |
integer |
O número da porta no Nó de Computação. |
frontendPortRangeEnd |
integer |
O último número de porta no intervalo de portas externas que serão 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. |
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ó. |
NameValuePair
Representa um par nome-valor.
Name | Tipo | Description |
---|---|---|
name |
string |
O nome no par name-value. |
value |
string |
O valor no par name-value. |
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 para corresponder à regra. |
sourcePortRanges |
string[] |
Os intervalos de portas de origem correspondem à 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. |
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: None, ReadOnly, ReadWrite. Os valores predefinidos são: Nenhum para armazenamento Standard. ReadOnly para armazenamento Premium. |
|
diskSizeGB |
integer |
O tamanho do disco inicial 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. |
PoolEndpointConfiguration
A configuração do ponto final para 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. |
PoolIdentityType
A identidade do conjunto do Batch, se configurada.
Name | Tipo | Description |
---|---|---|
None |
string |
O conjunto de lotes não tem nenhuma identidade associada. A definição |
UserAssigned |
string |
O conjunto do Batch tem identidades atribuídas pelo utilizador. |
PoolState
O estado atual do Conjunto.
Name | Tipo | Description |
---|---|---|
active |
string |
O Conjunto está disponível para executar Tarefas sujeitas à disponibilidade de Nós de Computação. |
deleting |
string |
O utilizador pediu que o Conjunto fosse eliminado, mas a operação de eliminação ainda não foi concluída. |
PoolStatistics
Contém estatísticas de utilização e utilização de recursos para a duração de um Conjunto.
Name | Tipo | Description |
---|---|---|
lastUpdateTime |
string |
O momento em que as estatísticas foram atualizadas pela última vez. Todas as estatísticas estão limitadas ao intervalo entre startTime e lastUpdateTime. |
resourceStats |
Estatísticas relacionadas com o consumo de recursos por Nós de Computação no Conjunto. |
|
startTime |
string |
A hora de início do intervalo de tempo abrangido pelas estatísticas. |
url |
string |
O URL das estatísticas. |
usageStats |
Estatísticas relacionadas com a utilização do conjunto, como a quantidade de tempo de núcleo utilizado. |
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. |
ResizeError
Erro que ocorreu ao redimensionar um Conjunto.
Name | Tipo | Description |
---|---|---|
code |
string |
Um identificador para o erro de redimensionamento do conjunto. Os códigos são invariantes e destinam-se a ser consumidos programaticamente. |
message |
string |
Uma mensagem que descreve o erro de redimensionamento do conjunto, que se destina a ser adequada para ser apresentada numa interface de utilizador. |
values |
Uma lista de detalhes de erro adicionais relacionados com o erro de redimensionamento do 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. |
ResourceStatistics
Estatísticas relacionadas com o consumo de recursos por Nós de Computação num Conjunto.
Name | Tipo | Description |
---|---|---|
avgCPUPercentage |
number |
A utilização média da CPU em todos os Nós de Computação no Conjunto (percentagem por nó). |
avgDiskGiB |
number |
A média do espaço em disco utilizado no GiB em todos os Nós de Computação no Conjunto. |
avgMemoryGiB |
number |
A utilização média da memória no GiB em todos os Nós de Computação no Conjunto. |
diskReadGiB |
number |
A quantidade total de dados em GiB de leituras de disco em todos os Nós de Computação no Conjunto. |
diskReadIOps |
integer |
O número total de operações de leitura do disco em todos os Nós de Computação no Conjunto. |
diskWriteGiB |
number |
A quantidade total de dados em GiB de escritas de discos em todos os Nós de Computação no Conjunto. |
diskWriteIOps |
integer |
O número total de operações de escrita de discos em todos os Nós de Computação no Conjunto. |
lastUpdateTime |
string |
A hora em que as estatísticas foram atualizadas pela última vez. Todas as estatísticas estão limitadas ao intervalo entre startTime e lastUpdateTime. |
networkReadGiB |
number |
A quantidade total de dados em GiB de leituras de rede em todos os Nós de Computação no Conjunto. |
networkWriteGiB |
number |
A quantidade total de dados em GiB de escritas de rede em todos os Nós de Computação no Conjunto. |
peakDiskGiB |
number |
O pico do espaço em disco utilizado no GiB em todos os Nós de Computação no Conjunto. |
peakMemoryGiB |
number |
O pico de utilização da memória no GiB em todos os Nós de Computação no Conjunto. |
startTime |
string |
A hora de início do intervalo de tempo abrangido pelas estatísticas. |
SecurityProfile
Especifica as definições do 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 Recurso/Temp no próprio anfitrião. |
securityType |
Especifica o SecurityType da máquina virtual. Tem de ser definido para 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 como 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 o 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. |
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. |
UsageStatistics
Estatísticas relacionadas com informações de utilização do conjunto.
Name | Tipo | Description |
---|---|---|
dedicatedCoreTime |
string |
A hora agregada do relógio de parede dos núcleos de Nó de Computação dedicados que fazem parte do Conjunto. |
lastUpdateTime |
string |
A hora em que as estatísticas foram atualizadas pela última vez. Todas as estatísticas estão limitadas ao intervalo entre startTime e lastUpdateTime. |
startTime |
string |
A hora de início do intervalo de tempo abrangido pelas estatísticas. |
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 quaisquer 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. |
UserAssignedIdentity
Identidade atribuída pelo utilizador
Name | Tipo | Description |
---|---|---|
clientId |
string |
O ID de cliente da identidade atribuída pelo utilizador. |
principalId |
string |
O ID principal da identidade atribuída pelo utilizador. |
resourceId |
string |
O ID de recurso do ARM da identidade atribuída pelo 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áquina virtual.
Name | Tipo | Description |
---|---|---|
autoUpgradeMinorVersion |
boolean |
Indica se a extensão deve utilizar uma versão secundária mais recente se 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 sejam reimplementadas, 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 |