Pool - Update Properties
Atualiza as propriedades do Pool especificado.
Isso substitui totalmente todas as propriedades atualizáveis do Pool. Por exemplo, se o Pool tiver um StartTask associado a ele e se StartTask não for especificado com essa solicitação, o serviço lote removerá o StartTask existente.
POST {batchUrl}/pools/{poolId}/updateproperties?api-version=2024-07-01.20.0
POST {batchUrl}/pools/{poolId}/updateproperties?timeout={timeout}&api-version=2024-07-01.20.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 do Lote do Azure. |
pool
|
path | True |
string |
A ID do Pool a ser atualizada. |
api-version
|
query | True |
string |
Versão da API do cliente. |
timeout
|
query |
integer int32 |
O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. Se o valor for maior que 30, o padrão será usado. |
Cabeçalho 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 a ID de solicitação do cliente 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. |
Corpo da solicitação
Media Types: "application/json; odata=minimalmetadata"
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
applicationPackageReferences | True |
A lista de Pacotes de Aplicativos a serem instalados em cada Nó de Computação no Pool. |
|
certificateReferences | True |
Uma lista de certificados a serem instalados em cada nó de computação no pool. Aviso: essa propriedade foi preterida e será removida após fevereiro de 2024. Em vez disso, use o de Extensão do Azure KeyVault |
|
metadata | True |
Uma lista de pares nome-valor associados ao Pool como metadados. |
|
startTask |
Uma Tarefa a ser executada em cada Nó de Computação à medida que ele ingressa no Pool. A Tarefa é executada quando o Nó de Computação é adicionado ao Pool ou quando o Nó de Computação é reiniciado. |
||
targetNodeCommunicationMode |
O modo de comunicação de nó desejado para o pool. |
Respostas
Nome | Tipo | Description |
---|---|---|
204 No Content |
A solicitação para o serviço do Lote foi bem-sucedida. Cabeçalhos
|
|
Other Status Codes |
O erro do serviço do Lote. |
Segurança
azure_auth
Fluxo de código de autenticação do Microsoft Entra 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
Pool update
Solicitação de exemplo
POST account.region.batch.azure.com/pools/poolId/updateproperties?api-version=2024-07-01.20.0
{
"startTask": {
"commandLine": "/bin/bash -c 'echo start task'"
},
"certificateReferences": [],
"applicationPackageReferences": [],
"metadata": []
}
Resposta de exemplo
Definições
Nome | Description |
---|---|
Application |
Uma referência a um pacote a ser implantado em Nós de Computação. |
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. |
Batch |
Uma resposta de erro recebida do serviço do Lote do Azure. |
Batch |
Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure. |
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. |
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 entrada do caminho e do modo de montagem que você deseja montar no contêiner de tarefas. |
Container |
Os caminhos que serão montados no contêiner da tarefa de contêiner. |
Container |
Um registro de contêiner privado. |
Container |
O local do diretório de trabalho da Tarefa de contêiner. |
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 do Lote do Azure. |
Metadata |
Um par nome-valor associado a um recurso de serviço do Lote. |
Node |
Determina como um pool se comunica com o serviço do Lote. |
Pool |
O conjunto de alterações a serem feitas em um pool. |
Resource |
Um único arquivo ou vários arquivos a serem baixados em um Nó de Computação. |
Start |
Uma tarefa que é executada quando um nó ingressa em um pool no serviço do Lote do Azure ou quando o Nó de Computação é reinicializado ou reimageado. |
Task |
As configurações de contêiner de uma Tarefa. |
User |
A definição da identidade do usuário na qual a Tarefa é executada. |
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. |
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 |
BatchError
Uma resposta de erro recebida do serviço do 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 do 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. |
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 com o 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 o 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. |
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. |
ContainerHostBatchBindMountEntry
A entrada do caminho e do modo de montagem que você deseja montar no contêiner de tarefas.
Nome | Tipo | Description |
---|---|---|
isReadOnly |
boolean |
Monte esse caminho de origem como modo somente leitura ou não. O valor padrão é falso (modo de leitura/gravação). |
source |
O caminho que será montado no cliente do contêiner pode ser selecionado. |
ContainerHostDataPath
Os caminhos que serão montados no contêiner da tarefa de contêiner.
Nome | Tipo | Description |
---|---|---|
Applications |
string |
O caminho dos aplicativos. |
JobPrep |
string |
O caminho da tarefa de preparação do trabalho. |
Shared |
string |
O caminho para a tarefa de várias instâncias compartilhar seus arquivos. |
Startup |
string |
O caminho para iniciar a tarefa. |
Task |
string |
O caminho da tarefa. |
VfsMounts |
string |
O caminho contém todos os sistemas de arquivos virtuais montados neste nó. |
ContainerRegistry
Um registro de contêiner privado.
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 a ser conectado ao servidor do Registro. |
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. |
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 de Administrador completas. |
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 do Lote do Azure.
Nome | Tipo | Description |
---|---|---|
lang |
string |
O código de idioma da mensagem de erro |
value |
string |
O texto da mensagem. |
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. |
NodeCommunicationMode
Determina como um pool se comunica com o serviço do Lote.
Nome | Tipo | Description |
---|---|---|
classic |
string |
Os nós que usam o modo de comunicação clássico exigem comunicação TCP de entrada nas portas 29876 e 29877 do "BatchNodeManagement. {region}" marca de serviço e comunicação TCP de saída na porta 443 para "Storage.region" e "BatchNodeManagement. Marcas de serviço {region}". |
default |
string |
O modo de comunicação do nó é definido automaticamente pelo serviço do Lote. |
simplified |
string |
Os nós que usam o modo de comunicação simplificado exigem comunicação TCP de saída na porta 443 para o "BatchNodeManagement. {region}" marca de serviço. Não são necessárias portas de entrada abertas. |
PoolUpdatePropertiesParameter
O conjunto de alterações a serem feitas em um pool.
Nome | Tipo | Description |
---|---|---|
applicationPackageReferences |
A lista de Pacotes de Aplicativos a serem instalados em cada Nó de Computação no Pool. |
|
certificateReferences |
Uma lista de certificados a serem instalados em cada nó de computação no pool. Aviso: essa propriedade foi preterida e será removida após fevereiro de 2024. Em vez disso, use o de Extensão do Azure KeyVault |
|
metadata |
Uma lista de pares nome-valor associados ao Pool como metadados. |
|
startTask |
Uma Tarefa a ser executada em cada Nó de Computação à medida que ele ingressa no Pool. A Tarefa é executada quando o Nó de Computação é adicionado ao Pool ou quando o Nó de Computação é reiniciado. |
|
targetNodeCommunicationMode |
O modo de comunicação de nó desejado para o pool. |
ResourceFile
Um único arquivo ou vários arquivos a serem baixados em um Nó de Computação.
Nome | Tipo | Description |
---|---|---|
autoStorageContainerName |
string |
O nome do contêiner de armazenamento na Conta de armazenamento automático. |
blobPrefix |
string |
O prefixo de blob a ser usado ao baixar blobs de um contêiner do Armazenamento do Azure. Somente os blobs cujos nomes começam com o prefixo especificado serão baixados. |
fileMode |
string |
O atributo de modo de permissão de arquivo no formato octal. |
filePath |
string |
O local no Nó de Computação para o qual baixar os arquivos em relação ao diretório de trabalho da Tarefa. |
httpUrl |
string |
A URL do arquivo a ser baixado. |
identityReference |
A referência à identidade atribuída pelo usuário a ser usada para acessar o Armazenamento de Blobs do Azure especificado por storageContainerUrl ou httpUrl |
|
storageContainerUrl |
string |
A URL do contêiner de blob no Armazenamento de Blobs do Azure. |
StartTask
Uma tarefa que é executada quando um nó ingressa em um pool no serviço do Lote do Azure ou quando o Nó de Computação é reinicializado ou reimageado.
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 o StartTask. |
|
maxTaskRetryCount |
integer |
O número máximo de vezes que a Tarefa pode ser repetida. |
resourceFiles |
Uma lista de arquivos que o serviço do Lote baixará no Nó de Computação antes de executar a linha de comando. Há um tamanho máximo para a lista de arquivos de recurso. Quando o tamanho máximo for excedido, a solicitação falhará e o código de erro de resposta será RequestEntityTooLarge. Se isso ocorrer, a coleção de ResourceFiles deverá ser reduzida em tamanho. Isso pode ser 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 do StartTask com êxito (ou seja, sair com o código de saída 0) antes de agendar tarefas no Nó de Computação. |
TaskContainerSettings
As configurações de contêiner de uma Tarefa.
Nome | Tipo | Description |
---|---|---|
containerHostBatchBindMounts |
Os caminhos que você deseja montar na tarefa de contêiner. |
|
containerRunOptions |
string |
Opções adicionais para o comando de criação de contêiner. |
imageName |
string |
A imagem a ser usada para criar o contêiner no qual a Tarefa será executada. |
registry |
O registro privado que contém a imagem do contêiner. |
|
workingDirectory |
O local do diretório de trabalho da Tarefa de contêiner. |
UserIdentity
A definição da identidade do usuário na qual a Tarefa é executada.
Nome | Tipo | Description |
---|---|---|
autoUser |
O usuário automático no qual a Tarefa é executada. |
|
username |
string |
O nome da identidade do usuário na qual a Tarefa é executada. |