Pool - Patch

Service:

Batch Service

API Version:

2023-11-01.18.0

Atualizações as propriedades do Conjunto especificado.
Esta ação só substitui as propriedades do Conjunto especificadas no pedido. Por exemplo, se o Conjunto tiver uma StartTask associada e um pedido não especificar um elemento StartTask, o Conjunto mantém o StartTask existente.

PATCH {batchUrl}/pools/{poolId}?api-version=2023-11-01.18.0

With optional parameters:

PATCH {batchUrl}/pools/{poolId}?timeout={timeout}&api-version=2023-11-01.18.0

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
batchUrl	path	True	string	O URL base para todos os pedidos de serviço Azure Batch.
poolId	path	True	string	O ID do Conjunto a atualizar.
api-version	query	True	string	Versão da API de Cliente.
timeout	query		integer int32	O tempo máximo que o servidor pode gastar a processar o pedido, em segundos. A predefinição é 30 segundos.

Cabeçalho do Pedido

Media Types: "application/json; odata=minimalmetadata"

Name	Necessário	Tipo	Description
client-request-id		string uuid	A identidade do pedido gerado pelo autor da chamada, sob a forma de um GUID sem decoração, como chavetas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se o servidor deve devolver o client-request-id na resposta.
ocp-date		string date-time-rfc1123	A hora em que o pedido foi emitido. Normalmente, as bibliotecas de cliente definem isto como a hora atual do relógio do sistema; defina-a explicitamente se estiver a chamar a API REST diretamente.
If-Match		string	Um valor ETag associado à versão do recurso conhecido pelo cliente. A operação só será efetuada 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 só será efetuada 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 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 hora da última modificação 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.

Corpo do Pedido

Media Types: "application/json; odata=minimalmetadata"

Name	Tipo	Description
applicationPackageReferences	ApplicationPackageReference[]	Uma lista de Pacotes a instalar em cada Nó de Computação no Conjunto. As alterações às referências de Pacotes afetam todos os novos Nós que associam o Conjunto, mas não afetam os Nós de Computação que já se encontram no Conjunto até serem reiniciados ou reimagedos. Se este elemento estiver presente, substituirá quaisquer referências de Pacote existentes. Se especificar uma coleção vazia, todas as referências de Pacote são removidas do Conjunto. Se omitido, quaisquer referências de Pacote existentes permanecem inalteradas.
certificateReferences	CertificateReference[]	Uma lista de Certificados a instalar em cada Nó de Computação no Conjunto. Se este elemento estiver presente, substitui todas as referências de Certificado existentes configuradas no Conjunto. Se omitido, quaisquer referências de Certificado existentes permanecem inalteradas. Para Os Nós do Windows, o serviço Batch instala os Certificados no arquivo e localização de Certificados especificados. Para Nós de Computação do Linux, os Certificados são armazenados num diretório dentro do diretório de trabalho de tarefas e é fornecida uma variável de ambiente AZ_BATCH_CERTIFICATES_DIR à Tarefa para consultar esta localização. Para Certificados com visibilidade de "remoteUser", é criado um diretório "certificados" no diretório principal do utilizador (por exemplo, /home/{user-name}/certs) e os Certificados são colocados nesse diretório. Aviso: esta propriedade foi preterida e será removida após fevereiro de 2024. Em alternativa, utilize a Extensão Azure KeyVault .
metadata	MetadataItem[]	Uma lista de pares name-value associados ao Conjunto como metadados. Se este elemento estiver presente, substitui os metadados existentes configurados no Conjunto. Se especificar uma coleção vazia, todos os metadados serão removidos do Conjunto. Se for omitido, os metadados existentes permanecem inalterados.
startTask	StartTask	Uma Tarefa a executar em cada Nó de Computação à medida que se associa ao Conjunto. A Tarefa é executada quando o Nó de Computação é adicionado ao Conjunto ou quando o Nó de Computação é reiniciado. Se este elemento estiver presente, substitui qualquer StartTask existente. Se omitido, qualquer StartTask existente permanece inalterado.
targetNodeCommunicationMode	NodeCommunicationMode	O modo de comunicação do nó pretendido para o conjunto. Se este elemento estiver presente, substitui o targetNodeCommunicationMode existente configurado no Conjunto. Se for omitido, os metadados existentes permanecem inalterados.

Respostas

Name	Tipo	Description
200 OK		O pedido para o serviço Batch foi efetuado com êxito. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	O erro do serviço Batch.

Segurança

azure_auth

Microsoft Entra fluxo de código de autenticação OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Representar a sua conta de utilizador

Authorization

Type: apiKey
In: header

Exemplos

Patch the Pool

Sample Request

HTTP

PATCH account.region.batch.azure.com/pools/poolId?api-version=2023-11-01.18.0



{
  "startTask": {
    "commandLine": "/bin/bash -c 'echo start task'"
  }
}

Sample Response

Status code:

200

Definições

Name	Description
ApplicationPackageReference	Uma referência a um Pacote a ser implementado em Nós de Computação.
AutoUserScope	O âmbito do utilizador automático
AutoUserSpecification	Especifica os parâmetros para o utilizador automático que executa uma Tarefa no serviço Batch.
BatchError	Uma resposta de erro recebida do serviço Azure Batch.
BatchErrorDetail	Um item de informações adicionais incluídas numa resposta de erro Azure Batch.
CertificateReference	Uma referência a um Certificado a ser instalado em Nós de Computação num Conjunto.
CertificateStoreLocation	A localização do Arquivo de certificados no Nó de Computação no qual pretende instalar o Certificado.
CertificateVisibility	Que contas de utilizador no Nó de Computação devem ter acesso aos dados privados do Certificado.
ComputeNodeIdentityReference	A referência a uma identidade atribuída pelo utilizador associada ao conjunto do Batch que um nó de computação irá utilizar.
ContainerRegistry	Um registo de contentor privado.
ContainerWorkingDirectory	A localização do diretório de trabalho da Tarefa de contentor.
ElevationLevel	O nível de elevação do utilizador.
EnvironmentSetting	Uma variável de ambiente a definir num processo de Tarefa.
ErrorMessage	Uma mensagem de erro recebida numa resposta de erro Azure Batch.
MetadataItem	Um par name-value associado a um recurso do serviço Batch.
NodeCommunicationMode	Determina como um conjunto comunica com o serviço Batch.
PoolPatchParameter	O conjunto de alterações a efetuar a um Conjunto.
ResourceFile	Um único ficheiro ou vários ficheiros a transferir para um Nó de Computação.
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 reproduzido.
TaskContainerSettings	As definições de contentor para uma Tarefa.
UserIdentity	A definição da identidade de utilizador na qual a Tarefa é executada.

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. Ao criar um conjunto, o ID da aplicação do pacote tem de ser completamente qualificado (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	A versão da aplicação a implementar. Se omitido, a versão predefinida é implementada. Se for omitido num Conjunto e não for especificada nenhuma versão predefinida para esta aplicação, o pedido falhará com o código de erro InvalidApplicationPackageReferences e o código de estado HTTP 409. Se isto for omitido numa Tarefa e não for especificada nenhuma versão predefinida para esta aplicação, a Tarefa falha com um erro de pré-processamento.

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	ElevationLevel	O nível de elevação do utilizador automático. O valor predefinido não éAdmin.
scope	AutoUserScope	O âmbito do utilizador automático O valor predefinido é conjunto. Se o conjunto estiver a executar o Windows, deve ser especificado um valor de Tarefa se for necessário um isolamento mais rigoroso entre as tarefas. Por exemplo, se a tarefa mudar o registo de uma forma que possa afetar outras tarefas ou se os certificados tiverem sido especificados no conjunto que não devem ser acessíveis por tarefas normais, mas devem ser acessíveis por StartTasks.

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	ErrorMessage	Uma mensagem que descreve o erro, destinada a ser adequada para ser apresentada numa interface de utilizador.
values	BatchErrorDetail[]	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.

CertificateReference

Uma referência a um Certificado a ser instalado em Nós de Computação num Conjunto.

Name	Tipo	Description
storeLocation	CertificateStoreLocation	A localização do Arquivo de certificados no Nó de Computação no qual pretende instalar o Certificado. O valor predefinido é currentuser. Esta propriedade é aplicável apenas a Conjuntos configurados com Nós de Computação do Windows (ou seja, criados com cloudServiceConfiguration ou com virtualMachineConfiguration com uma referência de Imagem do Windows). Para Nós de Computação do Linux, os Certificados são armazenados num diretório dentro do diretório de trabalho de tarefas e é fornecida uma variável de ambiente AZ_BATCH_CERTIFICATES_DIR à Tarefa para consultar esta localização. Para Certificados com visibilidade de "remoteUser", é criado um diretório "certificados" no diretório principal do utilizador (por exemplo, /home/{user-name}/certs) e os Certificados são colocados nesse diretório.
storeName	string	O nome do Arquivo de certificados no Nó de Computação no qual pretende instalar o Certificado. Esta propriedade é aplicável apenas a Conjuntos configurados com Nós de Computação do Windows (ou seja, criados com cloudServiceConfiguration ou com virtualMachineConfiguration com uma referência de Imagem do Windows). Os nomes de arquivo comuns incluem: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, mas também pode ser utilizado qualquer nome de arquivo personalizado. O valor predefinido é O Meu.
thumbprint	string	O thumbprint do Certificado.
thumbprintAlgorithm	string	O algoritmo com o qual o thumbprint está associado. Tem de ser sha1.
visibility	CertificateVisibility[]	Que contas de utilizador no Nó de Computação devem ter acesso aos dados privados do Certificado. Pode especificar mais do que uma visibilidade nesta coleção. A predefinição é todas as Contas.

CertificateStoreLocation

A localização do Arquivo de certificados no Nó de Computação no qual pretende instalar o Certificado.

Name	Tipo	Description
currentuser	string	Os certificados devem ser instalados no arquivo de Certificados CurrentUser.
localmachine	string	Os certificados devem ser instalados no arquivo de Certificados LocalMachine.

CertificateVisibility

Que contas de utilizador no Nó de Computação devem ter acesso aos dados privados do Certificado.

Name	Tipo	Description
remoteuser	string	O Certificado deve estar visível para as contas de utilizador nas quais os utilizadores acedem remotamente ao Nó de Computação.
starttask	string	O Certificado deve estar visível para a conta de utilizador na qual o StartTask é executado. Tenha em atenção que se o Âmbito do AutoUser for Conjunto para StartTask e uma Tarefa, este certificado também estará visível para a Tarefa.
task	string	O Certificado deve estar visível para as contas de utilizador nas quais as Tarefas de Trabalho são executadas.

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.

ContainerRegistry

Um registo de contentor privado.

Name	Tipo	Description
identityReference	ComputeNodeIdentityReference	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. A referência a uma identidade atribuída pelo utilizador associada ao conjunto do Batch que um nó de computação irá utilizar.
password	string	A palavra-passe para iniciar sessão no servidor de registo.
registryServer	string	O URL do registo. Se omitido, a predefinição é "docker.io".
username	string	O nome de utilizador a iniciar sessão no servidor de registo.

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.

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.

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.

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.

PoolPatchParameter

O conjunto de alterações a efetuar a um Conjunto.

Name	Tipo	Description
applicationPackageReferences	ApplicationPackageReference[]	Uma lista de Pacotes a instalar em cada Nó de Computação no Conjunto. As alterações às referências de Pacotes afetam todos os novos Nós que associam o Conjunto, mas não afetam os Nós de Computação que já se encontram no Conjunto até serem reiniciados ou reimagedos. Se este elemento estiver presente, substituirá quaisquer referências de Pacote existentes. Se especificar uma coleção vazia, todas as referências de Pacote são removidas do Conjunto. Se omitido, quaisquer referências de Pacote existentes permanecem inalteradas.
certificateReferences	CertificateReference[]	Uma lista de Certificados a instalar em cada Nó de Computação no Conjunto. Se este elemento estiver presente, substitui todas as referências de Certificado existentes configuradas no Conjunto. Se omitido, quaisquer referências de Certificado existentes permanecem inalteradas. Para Os Nós do Windows, o serviço Batch instala os Certificados no arquivo e localização de Certificados especificados. Para Nós de Computação do Linux, os Certificados são armazenados num diretório dentro do diretório de trabalho de tarefas e é fornecida uma variável de ambiente AZ_BATCH_CERTIFICATES_DIR à Tarefa para consultar esta localização. Para Certificados com visibilidade de "remoteUser", é criado um diretório "certificados" no diretório principal do utilizador (por exemplo, /home/{user-name}/certs) e os Certificados são colocados nesse diretório. Aviso: esta propriedade foi preterida e será removida após fevereiro de 2024. Em alternativa, utilize a Extensão Azure KeyVault .
metadata	MetadataItem[]	Uma lista de pares name-value associados ao Conjunto como metadados. Se este elemento estiver presente, substitui os metadados existentes configurados no Conjunto. Se especificar uma coleção vazia, todos os metadados serão removidos do Conjunto. Se omitido, os metadados existentes permanecem inalterados.
startTask	StartTask	Uma Tarefa a executar em cada Nó de Computação à medida que se associa ao Conjunto. A Tarefa é executada quando o Nó de Computação é adicionado ao Conjunto ou quando o Nó de Computação é reiniciado. Se este elemento estiver presente, substitui qualquer StartTask existente. Se omitido, qualquer StartTask existente permanece inalterado.
targetNodeCommunicationMode	NodeCommunicationMode	O modo de comunicação de nó pretendido para o conjunto. Se este elemento estiver presente, substitui o targetNodeCommunicationMode existente configurado no Conjunto. Se omitido, os metadados existentes permanecem inalterados.

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. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas tem de ser especificada.
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. A propriedade só é válida quando autoStorageContainerName ou storageContainerUrl é utilizado. Este prefixo pode ser um nome de ficheiro parcial ou um subdiretório. Se não for especificado um prefixo, todos os ficheiros no contentor serão transferidos.
fileMode	string	O atributo do modo de permissão de ficheiro no formato octal. Esta propriedade aplica-se apenas aos ficheiros que estão a ser transferidos para Nós de Computação do Linux. Será ignorado se for especificado para um resourceFile que será transferido para um Nó de Computação do Windows. Se esta propriedade não for especificada para um Nó de Computação do Linux, é aplicado um valor predefinido de 0770 ao ficheiro.
filePath	string	A localização no Nó de Computação para o qual transferir os ficheiros, relativamente ao diretório de trabalho da Tarefa. Se a propriedade httpUrl for especificada, o filePath é necessário e descreve o caminho para o qual o ficheiro será transferido, incluindo o nome do ficheiro. Caso contrário, se a propriedade autoStorageContainerName ou storageContainerUrl for especificada, filePath é opcional e é o diretório para o qual transferir os ficheiros. No caso em que filePath é utilizado como um diretório, qualquer estrutura de diretório já associada aos dados de entrada será mantida na totalidade e anexada ao diretório filePath especificado. O caminho relativo especificado não consegue sair do diretório de trabalho da Tarefa (por exemplo, utilizando '.').
httpUrl	string	O URL do ficheiro a transferir. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas tem de ser especificada. Se o URL apontar para Armazenamento de Blobs do Azure, tem de ser legível a partir de nós de computação. Existem três formas de obter esse URL para um blob no armazenamento do Azure: incluir uma Assinatura de Acesso Partilhado (SAS) que concede permissões de leitura no blob, utilizar uma identidade gerida com permissão de leitura ou definir a ACL para o blob ou o respetivo contentor para permitir o acesso público.
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída pelo utilizador a utilizar para aceder a Armazenamento de Blobs do Azure especificada por storageContainerUrl ou httpUrl A referência a uma identidade atribuída pelo utilizador associada ao conjunto do Batch que um nó de computação irá utilizar.
storageContainerUrl	string	O URL do contentor de blobs no Armazenamento de Blobs do Azure. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas tem de ser especificada. Este URL tem de ser legível e listável a partir de nós de computação. Existem três formas de obter esse URL para um contentor no armazenamento do Azure: incluir uma Assinatura de Acesso Partilhado (SAS) que concede permissões de leitura e lista no contentor, utilizar uma identidade gerida com permissões de leitura e lista ou definir a ACL para o contentor para permitir o acesso público.

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 reproduzido.

Name	Tipo	Description
commandLine	string	A linha de comandos do StartTask. A linha de comandos não é executada sob uma shell e, por conseguinte, não pode tirar partido das funcionalidades da shell, como a expansão da variável de ambiente. Se quiser tirar partido destas funcionalidades, deve invocar a shell na linha de comandos, por exemplo, utilizando "cmd /c MyCommand" no Windows ou "/bin/sh -c MyCommand" no Linux. Se a linha de comandos se referir a caminhos de ficheiro, deve utilizar um caminho relativo (relativamente ao diretório de trabalho da tarefa) ou utilizar a variável de ambiente fornecido pelo Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
containerSettings	TaskContainerSettings	As definições do contentor no qual o StartTask é executado. Quando for especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios Azure Batch no nó) são mapeados para o contentor, todas as variáveis de ambiente de tarefas são mapeadas para o contentor e a linha de comandos Tarefa é executada no contentor. Os ficheiros produzidos no contentor fora do AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos no disco anfitrião, o que significa que as APIs de ficheiro do Batch não poderão aceder a esses ficheiros.
environmentSettings	EnvironmentSetting[]	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. O serviço Batch repetirá uma Tarefa se o código de saída não forzero. Tenha em atenção que este valor controla especificamente o número de tentativas. O serviço Batch tentará a Tarefa uma vez e, em seguida, poderá repetir até este limite. Por exemplo, se a contagem máxima de repetições for 3, o Batch tentará a Tarefa até 4 vezes (uma tentativa inicial e três repetições). Se a contagem máxima de repetições for 0, o serviço Batch não repetirá a Tarefa. Se a contagem máxima de repetições for -1, o serviço Batch repetirá a Tarefa sem limite, no entanto não é recomendado para uma tarefa de início ou qualquer tarefa. O valor predefinido é 0 (sem repetições).
resourceFiles	ResourceFile[]	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. Os ficheiros listados neste elemento estão localizados no diretório de trabalho da Tarefa.
userIdentity	UserIdentity	A identidade de utilizador na qual o StartTask é executado. Se omitido, a Tarefa é executada como um utilizador não administrativo exclusivo da Tarefa.
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. Se for verdadeiro e o StartTask falhar num Nó, o serviço Batch repete o StartTask até à contagem máxima de repetições (maxTaskRetryCount). Se a Tarefa ainda não tiver sido concluída com êxito após todas as repetições, o serviço Batch marca o Nó inutilizável e não agendará Tarefas para o mesmo. Esta condição pode ser detetada através do estado do Nó de Computação e dos detalhes das informações de falha. Se for falso, o serviço Batch não aguardará pela conclusão do StartTask. Neste caso, outras Tarefas podem começar a ser executadas no Nó de Computação enquanto o StartTask ainda está em execução; e mesmo que o StartTask falhe, as novas Tarefas continuarão a ser agendadas no Nó de Computação. A predefinição é verdadeira.

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. Estas opções adicionais são fornecidas como argumentos para o comando "docker create", além das que são controladas pelo Serviço Batch.
imageName	string	A Imagem a utilizar para criar o contentor no qual a Tarefa será executada. Esta é a referência de Imagem completa, tal como seria especificada para "docker pull". Se não for fornecida nenhuma etiqueta como parte do Nome da imagem, a etiqueta ":latest" é utilizada como predefinição.
registry	ContainerRegistry	O registo privado que contém o contentor Imagem. Esta definição pode ser omitida se já tiver sido fornecida na criação do Conjunto.
workingDirectory	ContainerWorkingDirectory	A localização do diretório de trabalho da Tarefa de contentor. A predefinição é "taskWorkingDirectory".

UserIdentity

A definição da identidade de utilizador na qual a Tarefa é executada.

Name	Tipo	Description
autoUser	AutoUserSpecification	O utilizador automático no qual a Tarefa é executada. As propriedades userName e autoUser são mutuamente exclusivas; tem de especificar um, mas não ambos.
username	string	O nome da identidade de utilizador na qual a Tarefa é executada. As propriedades userName e autoUser são mutuamente exclusivas; tem de especificar um, mas não ambos.