Pool - Get
Obtém informações sobre o Pool 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 de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
batch
|
path | True |
string |
A URL base para todas as solicitações de serviço Lote do Azure. |
pool
|
path | True |
string |
A ID do pool a ser obtido. |
api-version
|
query | True |
string |
Versão da API do 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 gastar processando a solicitação, em segundos. O padrão é 30 segundos. |
Cabeçalho da solicitação
Media Types: "application/json; odata=minimalmetadata"
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
client-request-id |
string uuid |
A identidade da solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Se o servidor deve retornar o client-request-id na resposta. |
|
ocp-date |
string date-time-rfc1123 |
A hora em que a solicitação foi emitida. As bibliotecas de cliente normalmente definem isso como a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente. |
|
If-Match |
string |
Um valor ETag associado à versão do recurso conhecido pelo cliente. A operação será executada somente se a ETag atual do recurso no serviço corresponder exatamente ao valor especificado pelo cliente. |
|
If-None-Match |
string |
Um valor ETag associado à versão do recurso conhecido pelo cliente. A operação será executada somente se a ETag atual do recurso no serviço não corresponder ao valor especificado pelo cliente. |
|
If-Modified-Since |
string date-time-rfc1123 |
Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço tiver sido modificado desde a hora especificada. |
|
If-Unmodified-Since |
string date-time-rfc1123 |
Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço não tiver sido modificado desde o horário especificado. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Uma resposta que contém o Pool. Cabeçalhos
|
|
Other Status Codes |
O erro do serviço do Lote. |
Segurança
azure_auth
Microsoft Entra fluxo de código de autenticação OAuth 2.0
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome | Description |
---|---|
user_impersonation | Representar sua conta de usuário |
Authorization
Tipo:
apiKey
Em:
header
Exemplos
Add a VirtualMachineConfiguration pool with OS disk
Solicitação de exemplo
GET account.region.batch.azure.com/pools/mypool001?api-version=2023-11-01.18.0
Resposta de exemplo
{
"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
Solicitação de exemplo
GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0
Resposta de exemplo
{
"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
Solicitação de exemplo
GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0
Resposta de exemplo
{
"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
Solicitação de exemplo
GET account.region.batch.azure.com/pools/mypool001?api-version=2023-11-01.18.0
Resposta de exemplo
{
"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
Solicitação de exemplo
GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0
Resposta de exemplo
{
"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
Solicitação de exemplo
GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0
Resposta de exemplo
{
"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
Nome | Description |
---|---|
Allocation |
Se o Pool está redimensionando. |
Application |
Uma referência a um pacote a ser implantado em nós de computação. |
Auto |
Os resultados e erros de uma execução de uma fórmula de dimensionamento automático do Pool. |
Auto |
Um erro que ocorreu ao executar ou avaliar uma fórmula de dimensionamento automático do Pool. |
Auto |
O escopo do usuário automático |
Auto |
Especifica os parâmetros para o usuário automático que executa uma Tarefa no serviço do Lote. |
Azure |
Informações usadas para se conectar a um Contêiner de Armazenamento do Azure usando o Blobfuse. |
Azure |
Informações usadas para se conectar a um compartilhamento de arquivos do Azure. |
Batch |
Uma resposta de erro recebida do serviço Lote do Azure. |
Batch |
Um item de informações adicionais incluído em uma resposta de erro Lote do Azure. |
Batch |
A identidade do pool do Lote, se configurada. |
Caching |
O tipo de cache a ser habilitado para o disco. |
Certificate |
Uma referência a um certificado a ser instalado em nós de computação em um pool. |
Certificate |
O local do repositório de certificados no Nó de Computação no qual instalar o Certificado. |
Certificate |
Quais contas de usuário no nó de computação devem ter acesso aos dados privados do Certificado. |
CIFSMount |
Informações usadas para se conectar a um sistema de arquivos CIFS. |
Cloud |
Um pool no serviço Lote do Azure. |
Cloud |
A configuração para nós de computação em um pool com base na plataforma Serviços de Nuvem do Azure. |
Compute |
Como as Tarefas são distribuídas entre nós de computação em um pool. |
Compute |
A referência a uma identidade atribuída pelo usuário associada ao pool do Lote que um nó de computação usará. |
Container |
A configuração para pools habilitados para contêineres. |
Container |
Um registro de contêiner privado. |
Container |
A tecnologia de contêiner a ser usada. |
Container |
O local do diretório de trabalho da Tarefa de contêiner. |
Data |
Configurações que serão usadas pelos discos de dados associados aos Nós de Computação no Pool. Ao usar discos de dados anexados, você precisa montar e formatar os discos de dentro de uma VM para usá-los. |
Diff |
Especifica o posicionamento de disco efêmero para o disco do sistema operacional para todos os nós de computação (VMs) no pool. |
Diff |
Especifica as Configurações de Disco efêmero para o disco do sistema operacional usado pelo nó de computação (VM). |
Disk |
A configuração de criptografia de disco aplicada em nós de computação no pool. Não há suporte para a configuração de criptografia de disco no pool do Linux criado com a Imagem da Galeria de Computação do Azure. |
Disk |
A lista de destinos de disco serviço de lote criptografará no nó de computação. |
Dynamic |
O escopo da atribuição de vnet dinâmica. |
Elevation |
O nível de elevação do usuário. |
Environment |
Uma variável de ambiente a ser definida em um processo de tarefa. |
Error |
Uma mensagem de erro recebida em uma resposta de erro Lote do Azure. |
Image |
Uma referência a uma imagem do Azure Máquinas Virtuais Marketplace ou a uma imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de imagem Azure Marketplace verificadas por Lote do Azure, consulte a operação 'Listar Imagens Com Suporte'. |
Inbound |
O protocolo do ponto de extremidade. |
Inbound |
Um pool nat de entrada que pode ser usado para lidar com portas específicas em nós de computação em um pool de lote externamente. |
IPAddress |
O tipo de provisionamento para endereços IP públicos para o pool. |
Linux |
Propriedades usadas para criar uma conta de usuário em um nó de computação do Linux. |
Login |
O modo de logon para o usuário |
Managed |
|
Metadata |
Um par nome-valor associado a um recurso de serviço do Lote. |
Mount |
O sistema de arquivos a ser montado em cada nó. |
Name |
Representa um par nome-valor. |
Network |
A configuração de rede para um Pool. |
Network |
Uma regra de grupo de segurança de rede a ser aplicada a um ponto de extremidade de entrada. |
Network |
A ação que deve ser executada para um endereço IP especificado, intervalo de sub-rede ou marca. |
NFSMount |
Informações usadas para se conectar a um sistema de arquivos NFS. |
Node |
Determina como um pool se comunica com o serviço do Lote. |
Node |
Configuração de posicionamento de nó para um pool. |
Node |
A política de posicionamento para alocar nós no pool. |
OSDisk |
Configurações para o disco do sistema operacional do nó de computação (VM). |
Pool |
A configuração do ponto de extremidade para um Pool. |
Pool |
A identidade do pool do Lote, se configurada. |
Pool |
O estado atual do Pool. |
Pool |
Contém estatísticas de utilização e uso de recursos para o tempo de vida de um pool. |
Public |
A configuração de endereço IP público da configuração de rede de um Pool. |
Resize |
Um erro que ocorreu ao redimensionar um Pool. |
Resource |
Um único arquivo ou vários arquivos a serem baixados em um Nó de Computação. |
Resource |
Estatísticas relacionadas ao consumo de recursos por nós de computação em um pool. |
Security |
Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais. |
Security |
Especifica o SecurityType da máquina virtual. Ele precisa ser definido como qualquer valor especificado para habilitar UefiSettings. |
Service |
Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de dimensionamento ao usar a versão de imagem 'mais recente'. |
Start |
Uma Tarefa que é executada quando um Nó ingressa em um Pool no serviço Lote do Azure ou quando o Nó de Computação é reinicializado ou reimagem. |
Storage |
O tipo de conta de armazenamento para uso na criação de discos de dados ou disco do sistema operacional. |
Task |
As configurações de contêiner de uma Tarefa. |
Task |
Especifica como as Tarefas devem ser distribuídas entre nós de computação. |
Uefi |
Especifica as configurações de segurança, como inicialização segura e vTPM usadas durante a criação da máquina virtual. |
Usage |
Estatísticas relacionadas às informações de uso do pool. |
User |
Propriedades usadas para criar um usuário usado para executar Tarefas em um nó de computação Lote do Azure. |
User |
A identidade atribuída pelo usuário |
User |
A definição da identidade do usuário sob a qual a Tarefa é executada. |
Virtual |
A configuração para nós de computação em um pool com base na infraestrutura de Máquinas Virtuais do Azure. |
VMExtension |
A configuração para extensões de máquina virtual. |
Windows |
Configurações do sistema operacional Windows a serem aplicadas à máquina virtual. |
Windows |
Propriedades usadas para criar uma conta de usuário em um nó de computação do Windows. |
AllocationState
Se o Pool está redimensionando.
Nome | Tipo | Description |
---|---|---|
resizing |
string |
O pool está redimensionando; ou seja, nós de computação estão sendo adicionados ou removidos do pool. |
steady |
string |
O Pool não está redimensionando. Não há alterações no número de nós de computação no pool em andamento. Um Pool entra nesse estado quando é criado e quando nenhuma operação está sendo executada no Pool para alterar o número de Nós de Computação. |
stopping |
string |
O Pool estava redimensionando, mas o usuário solicitou que o redimensionamento fosse interrompido, mas a solicitação de parada ainda não foi concluída. |
ApplicationPackageReference
Uma referência a um pacote a ser implantado em nós de computação.
Nome | Tipo | Description |
---|---|---|
applicationId |
string |
A ID do aplicativo a ser implantado. |
version |
string |
A versão do aplicativo a ser implantado. Se omitida, a versão padrão será implantada. |
AutoScaleRun
Os resultados e erros de uma execução de uma fórmula de dimensionamento automático do Pool.
Nome | Tipo | Description |
---|---|---|
error |
Detalhes do erro encontrado avaliando a fórmula de dimensionamento automático no Pool, se a avaliação não tiver sido bem-sucedida. |
|
results |
string |
Os valores finais de todas as variáveis usadas 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
Um erro que ocorreu ao executar ou avaliar uma fórmula de dimensionamento automático do Pool.
Nome | Tipo | Description |
---|---|---|
code |
string |
Um identificador para o erro de dimensionamento automático. Os códigos são invariáveis e devem ser consumidos programaticamente. |
message |
string |
Uma mensagem que descreve o erro de dimensionamento automático, destinada a ser adequada para exibição em uma interface do usuário. |
values |
Uma lista de detalhes de erro adicionais relacionados ao erro de dimensionamento automático. |
AutoUserScope
O escopo do usuário automático
Nome | Tipo | Description |
---|---|---|
pool |
string |
Especifica que a Tarefa é executada como a conta de usuário automático comum que é criada em cada nó de computação em um pool. |
task |
string |
Especifica que o serviço deve criar um novo usuário para a Tarefa. |
AutoUserSpecification
Especifica os parâmetros para o usuário automático que executa uma Tarefa no serviço do Lote.
Nome | Tipo | Description |
---|---|---|
elevationLevel |
O nível de elevação do usuário automático. |
|
scope |
O escopo do usuário automático |
AzureBlobFileSystemConfiguration
Informações usadas para se conectar a um Contêiner de Armazenamento do Azure usando o Blobfuse.
Nome | Tipo | Description |
---|---|---|
accountKey |
string |
A chave da Conta de Armazenamento do Azure. |
accountName |
string |
O nome da Conta de Armazenamento do Azure. |
blobfuseOptions |
string |
Opções de linha de comando adicionais a serem passadas para o comando de montagem. |
containerName |
string |
O nome do contêiner Armazenamento de Blobs do Azure. |
identityReference |
A referência à identidade atribuída pelo usuário a ser usada para acessar containerName |
|
relativeMountPath |
string |
O caminho relativo no nó de computação em que o sistema de arquivos será montado |
sasKey |
string |
O token SAS do Armazenamento do Azure. |
AzureFileShareConfiguration
Informações usadas para se conectar a um compartilhamento de arquivos do Azure.
Nome | Tipo | Description |
---|---|---|
accountKey |
string |
A chave de conta de Armazenamento do Microsoft Azure. |
accountName |
string |
O nome da conta do Armazenamento do Azure. |
azureFileUrl |
string |
A URL do Arquivos do Azure. |
mountOptions |
string |
Opções de linha de comando adicionais a serem passadas para o comando de montagem. |
relativeMountPath |
string |
O caminho relativo no nó de computação em que o sistema de arquivos será montado |
BatchError
Uma resposta de erro recebida do serviço Lote do Azure.
Nome | Tipo | Description |
---|---|---|
code |
string |
Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente. |
message |
Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário. |
|
values |
Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro. |
BatchErrorDetail
Um item de informações adicionais incluído em uma resposta de erro Lote do Azure.
Nome | Tipo | Description |
---|---|---|
key |
string |
Um identificador que especifica o significado da propriedade Value. |
value |
string |
As informações adicionais incluídas na resposta de erro. |
BatchPoolIdentity
A identidade do pool do Lote, se configurada.
Nome | Tipo | Description |
---|---|---|
type |
A identidade do pool do Lote, se configurada. |
|
userAssignedIdentities |
A lista de identidades de usuário associadas à conta do Lote. |
CachingType
O tipo de cache a ser habilitado para o disco.
Nome | Tipo | Description |
---|---|---|
none |
string |
O modo de cache do disco não está habilitado. |
readonly |
string |
O modo de cache do disco é somente leitura. |
readwrite |
string |
O modo de cache do disco é leitura e gravação. |
CertificateReference
Uma referência a um certificado a ser instalado em nós de computação em um pool.
Nome | Tipo | Description |
---|---|---|
storeLocation |
O local do repositório de certificados no Nó de Computação no qual instalar o Certificado. |
|
storeName |
string |
O nome do repositório de certificados no Nó de Computação no qual instalar o Certificado. |
thumbprint |
string |
A impressão digital do Certificado. |
thumbprintAlgorithm |
string |
O algoritmo ao qual a impressão digital está associada. Isso deve ser sha1. |
visibility |
Quais contas de usuário no nó de computação devem ter acesso aos dados privados do Certificado. |
CertificateStoreLocation
O local do repositório de certificados no Nó de Computação no qual instalar o Certificado.
Nome | Tipo | Description |
---|---|---|
currentuser |
string |
Os certificados devem ser instalados no repositório de certificados CurrentUser. |
localmachine |
string |
Os certificados devem ser instalados no repositório de certificados LocalMachine. |
CertificateVisibility
Quais contas de usuário no nó de computação devem ter acesso aos dados privados do Certificado.
Nome | Tipo | Description |
---|---|---|
remoteuser |
string |
O Certificado deve estar visível para as contas de usuário nas quais os usuários acessam remotamente o Nó de Computação. |
starttask |
string |
O Certificado deve estar visível para a conta de usuário na qual o StartTask é executado. Observe que, se o Escopo do AutoUser for Pool para StartTask e uma Tarefa, esse certificado também ficará visível para a Tarefa. |
task |
string |
O Certificado deve estar visível para as contas de usuário nas quais as Tarefas de Trabalho são executadas. |
CIFSMountConfiguration
Informações usadas para se conectar a um sistema de arquivos CIFS.
Nome | Tipo | Description |
---|---|---|
mountOptions |
string |
Opções de linha de comando adicionais a serem passadas para o comando de montagem. |
password |
string |
A senha a ser usada para autenticação no sistema de arquivos CIFS. |
relativeMountPath |
string |
O caminho relativo no nó de computação em que o sistema de arquivos será montado |
source |
string |
O URI do sistema de arquivos a ser montado. |
username |
string |
O usuário a ser usado para autenticação no sistema de arquivos CIFS. |
CloudPool
Um pool no serviço Lote do Azure.
Nome | Tipo | Description |
---|---|---|
allocationState |
Se o Pool está redimensionando. |
|
allocationStateTransitionTime |
string |
A hora em que o Pool entrou em seu estado de alocação atual. |
applicationLicenses |
string[] |
A lista de licenças de aplicativo que o serviço do Lote disponibilizará em cada Nó de Computação no Pool. |
applicationPackageReferences |
A lista de pacotes a serem instalados em cada nó de computação no pool. |
|
autoScaleEvaluationInterval |
string |
O intervalo de tempo no qual ajustar automaticamente o tamanho do pool de acordo com a fórmula de dimensionamento automático. |
autoScaleFormula |
string |
Uma fórmula para o número desejado de nós de computação no pool. |
autoScaleRun |
Os resultados e erros da última execução da fórmula de dimensionamento automático. |
|
certificateReferences |
A lista de certificados a serem instalados em cada nó de computação no pool. Aviso: essa propriedade foi preterida e será removida após fevereiro de 2024. Em vez disso, use a Extensão do Azure KeyVault . |
|
cloudServiceConfiguration |
A configuração do serviço de nuvem para o Pool. |
|
creationTime |
string |
A hora de criação do Pool. |
currentDedicatedNodes |
integer |
O número de nós de computação dedicados atualmente no pool. |
currentLowPriorityNodes |
integer |
O número de nós de computação spot/de baixa prioridade atualmente no pool. |
currentNodeCommunicationMode |
O estado atual do modo de comunicação do pool. |
|
displayName |
string |
O nome de exibição do Pool. |
eTag |
string |
A ETag do Pool. |
enableAutoScale |
boolean |
Se o tamanho do pool deve ser ajustado automaticamente ao longo do tempo. |
enableInterNodeCommunication |
boolean |
Se o pool permite comunicação direta entre nós de computação. |
id |
string |
Uma cadeia de caracteres que identifica exclusivamente o pool dentro da Conta. |
identity |
A identidade do pool do Lote, se configurada. |
|
lastModified |
string |
A hora da última modificação do pool. |
metadata |
Uma lista de pares nome-valor associados ao Pool como metadados. |
|
mountConfiguration |
Uma lista de sistemas de arquivos a serem montados em cada nó no pool. |
|
networkConfiguration |
A configuração de rede para o Pool. |
|
resizeErrors |
Uma lista de erros encontrados ao executar o último redimensionamento no Pool. |
|
resizeTimeout |
string |
O tempo limite para alocação de nós de computação para o pool. |
resourceTags |
object |
As marcas especificadas pelo usuário associadas ao pool. |
startTask |
Uma Tarefa especificada para ser executada em cada Nó de Computação à medida que ele ingressa no pool. |
|
state |
O estado atual do Pool. |
|
stateTransitionTime |
string |
A hora em que o Pool entrou em seu estado atual. |
stats |
Estatísticas de utilização e uso de recursos durante todo o tempo de vida do pool. |
|
targetDedicatedNodes |
integer |
O número desejado de nós de computação dedicados no pool. |
targetLowPriorityNodes |
integer |
O número desejado de nós de computação spot/de baixa prioridade no pool. |
targetNodeCommunicationMode |
O modo de comunicação de nó desejado para o pool. |
|
taskSchedulingPolicy |
Como as Tarefas são distribuídas entre nós de computação em um pool. |
|
taskSlotsPerNode |
integer |
O número de slots de tarefas que podem ser usados para executar tarefas simultâneas em um único nó de computação no pool. |
url |
string |
A URL do pool. |
userAccounts |
A lista de contas de usuário a serem criadas em cada nó de computação no pool. |
|
virtualMachineConfiguration |
A configuração da máquina virtual para o Pool. |
|
vmSize |
string |
O tamanho das máquinas virtuais no pool. Todas as máquinas virtuais em um pool têm o mesmo tamanho. |
CloudServiceConfiguration
A configuração para nós de computação em um pool com base na plataforma Serviços de Nuvem do Azure.
Nome | Tipo | Description |
---|---|---|
osFamily |
string |
A família de so convidado do Azure a ser instalada nas máquinas virtuais no Pool. |
osVersion |
string |
A versão do sistema operacional convidado do Azure a ser instalada nas máquinas virtuais no Pool. |
ComputeNodeFillType
Como as Tarefas são distribuídas entre nós de computação em um pool.
Nome | Tipo | Description |
---|---|---|
pack |
string |
O maior número possível de tarefas (taskSlotsPerNode) deve ser atribuído a cada nó de computação no pool antes que qualquer Tarefa seja atribuída ao próximo Nó de Computação no Pool. |
spread |
string |
As tarefas devem ser atribuídas uniformemente em todos os nós de computação no pool. |
ComputeNodeIdentityReference
A referência a uma identidade atribuída pelo usuário associada ao pool do Lote que um nó de computação usará.
Nome | Tipo | Description |
---|---|---|
resourceId |
string |
A ID de recurso do ARM da identidade atribuída pelo usuário. |
ContainerConfiguration
A configuração para pools habilitados para contêineres.
Nome | Tipo | Description |
---|---|---|
containerImageNames |
string[] |
A coleção de nomes de imagem do contêiner. |
containerRegistries |
Registros privados adicionais dos quais os contêineres podem ser extraídos. |
|
type |
A tecnologia de contêiner a ser usada. |
ContainerRegistry
Um registro de contêiner privado.
Nome | Tipo | Description |
---|---|---|
identityReference |
A referência à identidade atribuída pelo usuário a ser usada para acessar um Registro de Contêiner do Azure em vez de nome de usuário e senha. |
|
password |
string |
A senha para fazer logon no servidor do Registro. |
registryServer |
string |
A URL do registro. |
username |
string |
O nome de usuário para fazer logon no servidor do Registro. |
ContainerType
A tecnologia de contêiner a ser usada.
Nome | Tipo | Description |
---|---|---|
criCompatible |
string |
Uma tecnologia baseada em CRI será usada para iniciar os contêineres. |
dockerCompatible |
string |
Uma tecnologia de contêiner compatível com Docker será usada para iniciar os contêineres. |
ContainerWorkingDirectory
O local do diretório de trabalho da Tarefa de contêiner.
Nome | Tipo | Description |
---|---|---|
containerImageDefault |
string |
Use o diretório de trabalho definido na Imagem do contêiner. Cuidado para que esse diretório não contenha os Arquivos de Recursos baixados pelo Lote. |
taskWorkingDirectory |
string |
Use o diretório de trabalho da Tarefa de Serviço do Lote padrão, que conterá os Arquivos de Recurso de Tarefa preenchidos pelo Lote. |
DataDisk
Configurações que serão usadas pelos discos de dados associados aos Nós de Computação no Pool. Ao usar discos de dados anexados, você precisa montar e formatar os discos de dentro de uma VM para usá-los.
Nome | Tipo | Description |
---|---|---|
caching |
O tipo de cache a ser habilitado para os discos de dados. |
|
diskSizeGB |
integer |
O tamanho inicial do disco em gigabytes. |
lun |
integer |
O número da unidade lógica. |
storageAccountType |
O tipo de conta de armazenamento a ser usado para o disco de dados. |
DiffDiskPlacement
Especifica o posicionamento de disco efêmero para o disco do sistema operacional para todos os nós de computação (VMs) no pool.
Nome | Tipo | Description |
---|---|---|
CacheDisk |
string |
O Disco do SISTEMA Operacional Efêmero é armazenado no cache da VM. |
DiffDiskSettings
Especifica as Configurações de Disco efêmero para o disco do sistema operacional usado pelo nó de computação (VM).
Nome | Tipo | Description |
---|---|---|
placement |
Especifica o posicionamento de disco efêmero para o disco do sistema operacional para todas as VMs no pool. |
DiskEncryptionConfiguration
A configuração de criptografia de disco aplicada em nós de computação no pool. Não há suporte para a configuração de criptografia de disco no pool do Linux criado com a Imagem da Galeria de Computação do Azure.
Nome | Tipo | Description |
---|---|---|
targets |
A lista de destinos de disco Serviço de Lote será criptografada no nó de computação. |
DiskEncryptionTarget
A lista de destinos de disco serviço de lote criptografará no nó de computação.
Nome | Tipo | Description |
---|---|---|
osdisk |
string |
O disco do sistema operacional no nó de computação é criptografado. |
temporarydisk |
string |
O disco temporário no nó de computação é criptografado. No Linux, essa criptografia se aplica a outras partições (como aquelas em discos de dados montados) quando a criptografia ocorre no momento da inicialização. |
DynamicVNetAssignmentScope
O escopo da atribuição de vnet dinâmica.
Nome | Tipo | Description |
---|---|---|
job |
string |
A atribuição de VNet dinâmica é feita por trabalho. |
none |
string |
Nenhuma atribuição de VNet dinâmica está habilitada. |
ElevationLevel
O nível de elevação do usuário.
Nome | Tipo | Description |
---|---|---|
admin |
string |
O usuário é um usuário com acesso elevado e opera com permissões completas de Administrador. |
nonadmin |
string |
O usuário é um usuário padrão sem acesso elevado. |
EnvironmentSetting
Uma variável de ambiente a ser definida em um processo de tarefa.
Nome | Tipo | Description |
---|---|---|
name |
string |
O nome da variável de ambiente. |
value |
string |
O valor da variável de ambiente. |
ErrorMessage
Uma mensagem de erro recebida em uma resposta de erro Lote do Azure.
Nome | Tipo | Description |
---|---|---|
lang |
string |
O código de idioma da mensagem de erro |
value |
string |
O texto da mensagem. |
ImageReference
Uma referência a uma imagem do Azure Máquinas Virtuais Marketplace ou a uma imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de imagem Azure Marketplace verificadas por Lote do Azure, consulte a operação 'Listar Imagens Com Suporte'.
Nome | Tipo | Description |
---|---|---|
exactVersion |
string |
A versão específica da imagem da plataforma ou da imagem do marketplace usada para criar o nó. Esse campo somente leitura será diferente de "version" somente se o valor especificado para 'version' quando o pool foi criado for 'latest'. |
offer |
string |
O tipo de oferta da Imagem do Azure Máquinas Virtuais Marketplace. |
publisher |
string |
O editor da imagem do Azure Máquinas Virtuais Marketplace. |
sku |
string |
O SKU da imagem do Azure Máquinas Virtuais Marketplace. |
version |
string |
A versão da imagem do Azure Máquinas Virtuais Marketplace. |
virtualMachineImageId |
string |
O identificador de recurso do ARM da Imagem da Galeria de Computação do Azure. Nós de computação no pool serão criados usando essa ID de imagem. Isso é do formulário /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} ou /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} para sempre usar a versão mais recente da imagem. |
InboundEndpointProtocol
O protocolo do ponto de extremidade.
Nome | Tipo | Description |
---|---|---|
tcp |
string |
Use TCP para o ponto de extremidade. |
udp |
string |
Use UDP para o ponto de extremidade. |
InboundNATPool
Um pool nat de entrada que pode ser usado para lidar com portas específicas em nós de computação em um pool de lote externamente.
Nome | Tipo | Description |
---|---|---|
backendPort |
integer |
O número da porta no Nó de Computação. |
frontendPortRangeEnd |
integer |
O último número da porta no intervalo de portas externas que será usado para fornecer acesso de entrada ao backendPort em nós de computação individuais. |
frontendPortRangeStart |
integer |
O primeiro número da porta no intervalo de portas externas que será usado para fornecer acesso de entrada ao backendPort em nós de computação individuais. |
name |
string |
O nome do ponto de extremidade. |
networkSecurityGroupRules |
Uma lista de regras de grupo de segurança de rede que serão aplicadas ao ponto de extremidade. |
|
protocol |
O protocolo do ponto de extremidade. |
IPAddressProvisioningType
O tipo de provisionamento para endereços IP públicos para o pool.
Nome | Tipo | Description |
---|---|---|
batchmanaged |
string |
Um IP público será criado e gerenciado pelo Lote. Pode haver vários IPs públicos dependendo do tamanho do Pool. |
nopublicipaddresses |
string |
Nenhum endereço IP público será criado. |
usermanaged |
string |
Os IPs públicos são fornecidos pelo usuário e serão usados para provisionar os Nós de Computação. |
LinuxUserConfiguration
Propriedades usadas para criar uma conta de usuário em um nó de computação do Linux.
Nome | Tipo | Description |
---|---|---|
gid |
integer |
A ID do grupo para a Conta de usuário. |
sshPrivateKey |
string |
A chave privada SSH para a conta de usuário. |
uid |
integer |
A ID de usuário da conta de usuário. |
LoginMode
O modo de logon para o usuário
Nome | Tipo | Description |
---|---|---|
batch |
string |
O LOGON32_LOGON_BATCH modo de logon do Win32. O modo de logon em lote é recomendado para processos paralelos de execução prolongada. |
interactive |
string |
O LOGON32_LOGON_INTERACTIVE modo de logon do Win32. O UAC está habilitado no Windows VirtualMachineConfiguration Pools. Se essa opção for usada com uma identidade de usuário elevada em um Pool de VirtualMachineConfiguration do Windows, a sessão do usuário não será elevada, a menos que o aplicativo executado pela linha de comando Tarefa esteja configurado para sempre exigir privilégio administrativo ou sempre exigir privilégio máximo. |
ManagedDisk
Nome | Tipo | Description |
---|---|---|
storageAccountType |
O tipo de conta de armazenamento para disco gerenciado. |
MetadataItem
Um par nome-valor associado a um recurso de serviço do Lote.
Nome | Tipo | Description |
---|---|---|
name |
string |
O nome do item de metadados. |
value |
string |
O valor do item de metadados. |
MountConfiguration
O sistema de arquivos a ser montado em cada nó.
Nome | Tipo | Description |
---|---|---|
azureBlobFileSystemConfiguration |
O Contêiner de Armazenamento do Azure a ser montado usando o FUSE de blob em cada nó. |
|
azureFileShareConfiguration |
O Compartilhamento de Arquivos do Azure a ser montado em cada nó. |
|
cifsMountConfiguration |
O sistema de arquivos CIFS/SMB a ser montado em cada nó. |
|
nfsMountConfiguration |
O sistema de arquivos NFS a ser montado em cada nó. |
NameValuePair
Representa um par nome-valor.
Nome | Tipo | Description |
---|---|---|
name |
string |
O nome no par nome-valor. |
value |
string |
O valor no par nome-valor. |
NetworkConfiguration
A configuração de rede para um Pool.
Nome | Tipo | Description |
---|---|---|
dynamicVNetAssignmentScope |
O escopo da atribuição de vnet dinâmica. |
|
enableAcceleratedNetworking |
boolean |
Se esse pool deve habilitar a rede acelerada. |
endpointConfiguration |
A configuração para pontos de extremidade em Nós de Computação no Pool de Lotes. |
|
publicIPAddressConfiguration |
A configuração de IPAddress público para nós de computação no Pool de Lotes. |
|
subnetId |
string |
O identificador de recurso arm da sub-rede de rede virtual à qual os Nós de Computação do Pool ingressarão. Isso é do formulário /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. |
NetworkSecurityGroupRule
Uma regra de grupo de segurança de rede a ser aplicada a um ponto de extremidade de entrada.
Nome | Tipo | Description |
---|---|---|
access |
A ação que deve ser executada para um endereço IP especificado, intervalo de sub-rede ou marca. |
|
priority |
integer |
A prioridade para essa regra. |
sourceAddressPrefix |
string |
O prefixo de endereço de origem ou a marca a ser correspondida para a regra. |
sourcePortRanges |
string[] |
Os intervalos de porta de origem a serem correspondentes à regra. |
NetworkSecurityGroupRuleAccess
A ação que deve ser executada para um endereço IP especificado, intervalo de sub-rede ou marca.
Nome | Tipo | Description |
---|---|---|
allow |
string |
Permitir o acesso. |
deny |
string |
Nega o acesso. |
NFSMountConfiguration
Informações usadas para se conectar a um sistema de arquivos NFS.
Nome | Tipo | Description |
---|---|---|
mountOptions |
string |
Opções de linha de comando adicionais a serem passadas para o comando de montagem. |
relativeMountPath |
string |
O caminho relativo no nó de computação em que o sistema de arquivos será montado |
source |
string |
O URI do sistema de arquivos a ser montado. |
NodeCommunicationMode
Determina como um pool se comunica com o serviço do Lote.
Nome | Tipo | Description |
---|---|---|
classic |
string |
Os nós que usam o modo de comunicação clássico exigem comunicação TCP de entrada nas portas 29876 e 29877 do "BatchNodeManagement. {region}" marca de serviço e comunicação TCP de saída na porta 443 para "Storage.region" e "BatchNodeManagement. Marcas de serviço {region}". |
default |
string |
O modo de comunicação do nó é definido automaticamente pelo serviço lote. |
simplified |
string |
Os nós que usam o modo de comunicação simplificado exigem comunicação TCP de saída na porta 443 para o "BatchNodeManagement. Marca de serviço {region}". Nenhuma porta de entrada aberta é necessária. |
NodePlacementConfiguration
Configuração de posicionamento de nó para um pool.
Nome | Tipo | Description |
---|---|---|
policy |
Tipo de política de posicionamento de nó em Pools de Lote. |
NodePlacementPolicyType
A política de posicionamento para alocar nós no pool.
Nome | Tipo | Description |
---|---|---|
regional |
string |
Todos os nós no pool serão alocados na mesma região. |
zonal |
string |
Os nós no pool serão distribuídos em diferentes zonas de disponibilidade com o melhor balanceamento de esforço. |
OSDisk
Configurações para o disco do sistema operacional do nó de computação (VM).
Nome | Tipo | Description |
---|---|---|
caching |
Especifica os requisitos de cache. Os valores possíveis são: None, ReadOnly, ReadWrite. Os valores padrão são: Nenhum para armazenamento Standard. ReadOnly para armazenamento Premium. |
|
diskSizeGB |
integer |
O tamanho inicial do disco em GB ao criar um novo disco do sistema operacional. |
ephemeralOSDiskSettings |
Especifica as Configurações de Disco efêmero para o disco do sistema operacional usado pela VM (nó de computação). |
|
managedDisk |
Os parâmetros de disco gerenciado. |
|
writeAcceleratorEnabled |
boolean |
Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco. |
PoolEndpointConfiguration
A configuração do ponto de extremidade para um Pool.
Nome | Tipo | Description |
---|---|---|
inboundNATPools |
Uma lista de pools NAT de entrada que podem ser usados para abordar portas específicas em um nó de computação individual externamente. |
PoolIdentityType
A identidade do pool do Lote, se configurada.
Nome | Tipo | Description |
---|---|---|
None |
string |
O pool do Lote não tem nenhuma identidade associada a ele. A configuração |
UserAssigned |
string |
O pool do Lote tem identidades atribuídas pelo usuário com ele. |
PoolState
O estado atual do Pool.
Nome | Tipo | Description |
---|---|---|
active |
string |
O Pool está disponível para executar Tarefas sujeitas à disponibilidade de Nós de Computação. |
deleting |
string |
O usuário solicitou que o Pool fosse excluído, mas a operação de exclusão ainda não foi concluída. |
PoolStatistics
Contém estatísticas de utilização e uso de recursos para o tempo de vida de um pool.
Nome | Tipo | Description |
---|---|---|
lastUpdateTime |
string |
A hora em que as estatísticas foram atualizadas pela última vez. Todas as estatísticas são limitadas ao intervalo entre startTime e lastUpdateTime. |
resourceStats |
Estatísticas relacionadas ao consumo de recursos por nós de computação no pool. |
|
startTime |
string |
A hora de início do intervalo de tempo coberto pelas estatísticas. |
url |
string |
A URL das estatísticas. |
usageStats |
Estatísticas relacionadas ao uso do pool, como a quantidade de tempo principal usado. |
PublicIPAddressConfiguration
A configuração de endereço IP público da configuração de rede de um Pool.
Nome | Tipo | Description |
---|---|---|
ipAddressIds |
string[] |
A lista de IPs públicos que o serviço do Lote usará ao provisionar nós de computação. |
provision |
O tipo de provisionamento para endereços IP públicos para o pool. |
ResizeError
Um erro que ocorreu ao redimensionar um Pool.
Nome | Tipo | Description |
---|---|---|
code |
string |
Um identificador para o erro de redimensionamento do Pool. Os códigos são invariáveis e devem ser consumidos programaticamente. |
message |
string |
Uma mensagem que descreve o erro de redimensionamento do Pool, destinada a ser adequada para exibição em uma interface do usuário. |
values |
Uma lista de detalhes de erro adicionais relacionados ao erro de redimensionamento do Pool. |
ResourceFile
Um único arquivo ou vários arquivos a serem baixados em um Nó de Computação.
Nome | Tipo | Description |
---|---|---|
autoStorageContainerName |
string |
O nome do contêiner de armazenamento na Conta de armazenamento automático. |
blobPrefix |
string |
O prefixo de blob a ser usado ao baixar blobs de um contêiner do Armazenamento do Azure. Somente os blobs cujos nomes começam com o prefixo especificado serão baixados. |
fileMode |
string |
O atributo de modo de permissão de arquivo no formato octal. |
filePath |
string |
O local no Nó de Computação para o qual baixar os arquivos, em relação ao diretório de trabalho da Tarefa. |
httpUrl |
string |
A URL do arquivo para download. |
identityReference |
A referência à identidade atribuída pelo usuário a ser usada para acessar Armazenamento de Blobs do Azure especificada por storageContainerUrl ou httpUrl |
|
storageContainerUrl |
string |
A URL do contêiner de blob no Armazenamento de Blobs do Azure. |
ResourceStatistics
Estatísticas relacionadas ao consumo de recursos por nós de computação em um pool.
Nome | Tipo | Description |
---|---|---|
avgCPUPercentage |
number |
O uso médio da CPU em todos os nós de computação no pool (percentual por nó). |
avgDiskGiB |
number |
O espaço em disco usado médio em GiB em todos os nós de computação no pool. |
avgMemoryGiB |
number |
O uso médio de memória em GiB em todos os nós de computação no pool. |
diskReadGiB |
number |
A quantidade total de dados em GiB de leituras de disco em todos os nós de computação no pool. |
diskReadIOps |
integer |
O número total de operações de leitura de disco em todos os nós de computação no pool. |
diskWriteGiB |
number |
A quantidade total de dados em GiB de gravações de disco em todos os nós de computação no pool. |
diskWriteIOps |
integer |
O número total de operações de gravação de disco em todos os nós de computação no pool. |
lastUpdateTime |
string |
A hora em que as estatísticas foram atualizadas pela última vez. Todas as estatísticas são limitadas ao intervalo entre startTime e lastUpdateTime. |
networkReadGiB |
number |
A quantidade total de dados em GiB de leituras de rede em todos os nós de computação no pool. |
networkWriteGiB |
number |
A quantidade total de dados em GiB de gravações de rede em todos os nós de computação no pool. |
peakDiskGiB |
number |
O pico de espaço em disco usado em GiB em todos os nós de computação no pool. |
peakMemoryGiB |
number |
O pico de uso de memória em GiB em todos os nós de computação no pool. |
startTime |
string |
A hora de início do intervalo de tempo coberto pelas estatísticas. |
SecurityProfile
Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais.
Nome | Tipo | Description |
---|---|---|
encryptionAtHost |
boolean |
Essa propriedade pode ser usada pelo usuário na solicitação para habilitar ou desabilitar a Criptografia de Host para a máquina virtual ou conjunto de dimensionamento de máquinas virtuais. Isso habilitará a criptografia para todos os discos, incluindo o disco Resource/Temp no próprio host. |
securityType |
Especifica o SecurityType da máquina virtual. Ele precisa ser definido como qualquer valor especificado para habilitar UefiSettings. |
|
uefiSettings |
Especifica as configurações de segurança, como inicialização segura e vTPM usadas durante a criação da máquina virtual. |
SecurityTypes
Especifica o SecurityType da máquina virtual. Ele precisa ser definido como qualquer valor especificado para habilitar UefiSettings.
Nome | Tipo | Description |
---|---|---|
trustedLaunch |
string |
O início confiável protege contra técnicas de ataque avançadas e persistentes. |
ServiceArtifactReference
Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de dimensionamento ao usar a versão de imagem 'mais recente'.
Nome | Tipo | Description |
---|---|---|
id |
string |
A ID de referência do artefato de serviço de ServiceArtifactReference |
StartTask
Uma Tarefa que é executada quando um Nó ingressa em um Pool no serviço Lote do Azure ou quando o Nó de Computação é reinicializado ou reimagem.
Nome | Tipo | Description |
---|---|---|
commandLine |
string |
A linha de comando do StartTask. |
containerSettings |
As configurações do contêiner no qual o StartTask é executado. |
|
environmentSettings |
Uma lista de configurações de variável de ambiente para StartTask. |
|
maxTaskRetryCount |
integer |
O número máximo de vezes que a Tarefa pode ser repetida. |
resourceFiles |
Uma lista de arquivos que o serviço do Lote baixará para o Nó de Computação antes de executar a linha de comando. Há um tamanho máximo para a lista de arquivos de recurso. Quando o tamanho máximo for excedido, a solicitação falhará e o código de erro de resposta será RequestEntityTooLarge. Se isso ocorrer, a coleção de ResourceFiles deverá ser reduzida em tamanho. Isso pode ser feito usando arquivos .zip, Pacotes de Aplicativos ou Contêineres do Docker. |
|
userIdentity |
A identidade do usuário na qual o StartTask é executado. |
|
waitForSuccess |
boolean |
Se o serviço do Lote deve aguardar a conclusão bem-sucedida do StartTask (ou seja, sair com o código de saída 0) antes de agendar qualquer Tarefa no Nó de Computação. |
StorageAccountType
O tipo de conta de armazenamento para uso na criação de discos de dados ou disco do sistema operacional.
Nome | Tipo | Description |
---|---|---|
premium_lrs |
string |
O disco de dados/disco do sistema operacional deve usar o armazenamento premium com redundância local. |
standard_lrs |
string |
O disco de dados/disco do sistema operacional deve usar o armazenamento padrão com redundância local. |
standardssd_lrs |
string |
O disco de dados/disco do sistema operacional deve usar o armazenamento com redundância local do SSD padrão. |
TaskContainerSettings
As configurações de contêiner de uma Tarefa.
Nome | Tipo | Description |
---|---|---|
containerRunOptions |
string |
Opções adicionais para o comando container create. |
imageName |
string |
A Imagem a ser usada para criar o contêiner no qual a Tarefa será executada. |
registry |
O registro privado que contém a Imagem do contêiner. |
|
workingDirectory |
O local do diretório de trabalho tarefa do contêiner. |
TaskSchedulingPolicy
Especifica como as Tarefas devem ser distribuídas entre nós de computação.
Nome | Tipo | Description |
---|---|---|
nodeFillType |
Como as Tarefas são distribuídas entre nós de computação em um pool. |
UefiSettings
Especifica as configurações de segurança, como inicialização segura e vTPM usadas durante a criação da máquina virtual.
Nome | Tipo | Description |
---|---|---|
secureBootEnabled |
boolean |
Especifica se a inicialização segura deve ser habilitada na máquina virtual. |
vTpmEnabled |
boolean |
Especifica se o vTPM deve ser habilitado na máquina virtual. |
UsageStatistics
Estatísticas relacionadas às informações de uso do pool.
Nome | Tipo | Description |
---|---|---|
dedicatedCoreTime |
string |
O tempo agregado do relógio de parede dos núcleos de Nó de Computação dedicados que fazem parte do pool. |
lastUpdateTime |
string |
A hora em que as estatísticas foram atualizadas pela última vez. Todas as estatísticas são limitadas ao intervalo entre startTime e lastUpdateTime. |
startTime |
string |
A hora de início do intervalo de tempo coberto pelas estatísticas. |
UserAccount
Propriedades usadas para criar um usuário usado para executar Tarefas em um nó de computação Lote do Azure.
Nome | Tipo | Description |
---|---|---|
elevationLevel |
O nível de elevação da Conta de usuário. |
|
linuxUserConfiguration |
A configuração de usuário específica do Linux para a Conta de usuário. |
|
name |
string |
O nome da conta de usuário. Os nomes podem conter caracteres Unicode até um comprimento máximo de 20. |
password |
string |
A senha da conta de usuário. |
windowsUserConfiguration |
A configuração de usuário específica do Windows para a conta de usuário. |
UserAssignedIdentity
A identidade atribuída pelo usuário
Nome | Tipo | Description |
---|---|---|
clientId |
string |
A ID do cliente da identidade atribuída pelo usuário. |
principalId |
string |
A ID da entidade de segurança da identidade atribuída pelo usuário. |
resourceId |
string |
A ID de recurso do ARM da identidade atribuída pelo usuário |
UserIdentity
A definição da identidade do usuário sob a qual a Tarefa é executada.
Nome | Tipo | Description |
---|---|---|
autoUser |
O usuário automático sob o qual a Tarefa é executada. |
|
username |
string |
O nome da identidade do usuário sob a qual a Tarefa é executada. |
VirtualMachineConfiguration
A configuração para nós de computação em um pool com base na infraestrutura de Máquinas Virtuais do Azure.
Nome | Tipo | Description |
---|---|---|
containerConfiguration |
A configuração do contêiner para o Pool. |
|
dataDisks |
Data |
A configuração de discos de dados anexados aos Nós de Computação no Pool. |
diskEncryptionConfiguration |
A configuração de criptografia de disco para o pool. |
|
extensions |
A extensão da máquina virtual para o pool. |
|
imageReference |
Uma referência à imagem do Azure Máquinas Virtuais Marketplace ou à imagem de máquina virtual personalizada a ser usada. |
|
licenseType |
string |
O tipo de licença local a ser usada ao implantar o sistema operacional. Windows_Server – a licença local é para o Windows Server. Windows_Client – a licença local é para o Cliente Windows. |
nodeAgentSKUId |
string |
O SKU do agente do Nó de Computação em Lote a ser provisionado em Nós de Computação no Pool. |
nodePlacementConfiguration |
A configuração de posicionamento do nó para o pool. |
|
osDisk |
Configurações para o disco do sistema operacional da Máquina Virtual. |
|
securityProfile |
Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais. |
|
serviceArtifactReference |
Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de dimensionamento ao usar a versão de imagem 'mais recente'. |
|
windowsConfiguration |
Configurações do sistema operacional Windows na máquina virtual. |
VMExtension
A configuração para extensões de máquina virtual.
Nome | Tipo | Description |
---|---|---|
autoUpgradeMinorVersion |
boolean |
Indica se a extensão deve usar uma versão secundária mais recente se uma estiver disponível no momento da implantação. Após a implantação, no entanto, a extensão não atualizará as versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como verdadeira. |
enableAutomaticUpgrade |
boolean |
Indica se a extensão deve ser atualizada automaticamente pela plataforma se houver uma versão mais recente da extensão disponível. |
name |
string |
O nome da extensão da máquina virtual. |
protectedSettings |
object |
A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida. |
provisionAfterExtensions |
string[] |
A coleção de nomes de extensão. |
publisher |
string |
O nome do editor do manipulador de extensão. |
settings |
object |
Configurações públicas formatadas em JSON para a extensão. |
type |
string |
O tipo da extensão. |
typeHandlerVersion |
string |
A versão do manipulador de script. |
WindowsConfiguration
Configurações do sistema operacional Windows a serem aplicadas à máquina virtual.
Nome | Tipo | Description |
---|---|---|
enableAutomaticUpdates |
boolean |
Se as atualizações automáticas estão habilitadas na máquina virtual. |
WindowsUserConfiguration
Propriedades usadas para criar uma conta de usuário em um nó de computação do Windows.
Nome | Tipo | Description |
---|---|---|
loginMode |
O modo de logon do usuário |