BatchClient class

Pacote:

@azure/batch

Classe cliente para aceder ao serviço Azure Batch.

Construtores

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

Métodos

createJob(BatchJobCreateOptions, CreateJobOptionalParams)	O serviço Batch suporta duas formas de controlar o trabalho realizado como parte de um Trabalho. Na primeira abordagem, o utilizador especifica uma Tarefa do Gestor de Trabalhos. O serviço Batch lança esta Tarefa quando está pronta para iniciar o Trabalho. A Tarefa do Gestor de Jobs controla todas as outras Tarefas que correm sob este Job, utilizando as APIs das Tarefas. Na segunda abordagem, o utilizador controla diretamente a execução de Tarefas sob um Job ativo, utilizando as APIs de Tarefas. Note também: ao nomear Jobs, evite incluir informações sensíveis como nomes de utilizador ou nomes secretos de projetos. Esta informação pode aparecer em registos de telemetria acessíveis aos engenheiros do Suporte da Microsoft.
createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)	Cria um Cronograma de Trabalho para a Conta especificada.
createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)	Pode adicionar uma Conta de utilizador a um Nó de Computação apenas quando este estiver em estado de inatividade ou a correr. Antes de poderes iniciar sessão remotamente num Nó de Computação, tens de configurar portas de acesso para SSH e RDP. Para mais informações, consulte https://learn.microsoft.com/azure/batch/pool-endpoint-configuration
createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)	Ao nomear Pools, evite incluir informações confidenciais, como nomes de usuários ou nomes de projetos secretos. Esta informação pode aparecer em registos de telemetria acessíveis aos engenheiros do Suporte da Microsoft.
createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)	A duração máxima de uma Tarefa desde a adição até à conclusão é de 180 dias. Se uma Tarefa não for concluída dentro de 180 dias após a sua adicionação, será terminada pelo serviço Batch e deixada no estado em que estava nessa altura.
createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)	Note que cada Tarefa deve ter um ID único. O serviço Batch pode não devolver os resultados de cada Tarefa na mesma ordem em que as Tarefas foram submetidas neste pedido. Se o servidor expirar ou a ligação for fechada durante o pedido, o pedido pode ter sido parcial ou totalmente processado, ou nem sequer processado. Nesses casos, o utilizador deve reemitir o pedido. Note que cabe ao utilizador tratar corretamente das falhas ao reemitir um pedido. Por exemplo, deve usar os mesmos IDs de tarefa durante uma retentativa para que, se a operação anterior tiver sido bem-sucedida, a retentativa não crie tarefas extra inesperadamente. Se a resposta contiver alguma Tarefa que não foi adicionada, o cliente pode tentar novamente o pedido. Numa nova tentativa, é mais eficiente submeter apenas as Tarefas que não foram adicionadas e omitir as Tarefas que foram adicionadas com sucesso à primeira tentativa. A duração máxima de uma Tarefa desde a adição até à conclusão é de 180 dias. Se uma Tarefa não for concluída dentro de 180 dias após a sua adicionação, será terminada pelo serviço Batch e deixada no estado em que estava nessa altura.
deallocateNode(string, string, DeallocateNodeOptionalParams)	Você pode desalocar um nó de computação somente se ele estiver em um estado ocioso ou em execução.
deleteJob(string, DeleteJobOptionalParams)	Eliminar um Trabalho também elimina todas as Tarefas que fazem parte desse Trabalho, bem como todas as estatísticas do Trabalho. Isto também sobrepõe-se ao período de retenção dos dados da tarefa; isto é, se o Job contiver Tasks que ainda estão retidas nos Nós de Computação, os serviços Batch eliminam os diretórios de trabalho dessas Tarefas e todo o seu conteúdo. Quando é recebido um pedido de Delete Job, o serviço Batch define o Job para o estado de eliminação. Todas as operações de atualização num Job que esteja em estado de eliminação falharão com o código de estado 409 (Conflito), com informação adicional a indicar que o Job está a ser eliminado.
deleteJobSchedule(string, DeleteJobScheduleOptionalParams)	Quando você exclui uma Agenda de Trabalhos, isso também exclui todos os Trabalhos e Tarefas sob essa agenda. Quando as Tarefas são excluídas, todos os arquivos em seus diretórios de trabalho nos Nós de Computação também são excluídos (o período de retenção é ignorado). As estatísticas da Agenda de Trabalho não são mais acessíveis quando a Agenda de Trabalho é excluída, embora ainda sejam contadas para as estatísticas de tempo de vida da Conta.
deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)	Exclui o arquivo especificado do nó de computação.
deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)	Você pode excluir uma conta de usuário para um nó de computação somente quando ele estiver no estado ocioso ou em execução. Antes de poderes iniciar sessão remotamente num Nó de Computação, tens de configurar portas de acesso para SSH e RDP. Para mais informações, consulte https://learn.microsoft.com/azure/batch/pool-endpoint-configuration
deletePool(string, DeletePoolOptionalParams)	Quando você solicita que um Pool seja excluído, as seguintes ações ocorrem: o estado do Pool é definido como exclusão; qualquer operação de redimensionamento em curso no Pool é interrompida; o serviço de lote começa a redimensionar o pool para zero nós de computação; todas as tarefas em execução em nós de computação existentes são encerradas e colocadas novamente na fila (como se uma operação de pool de redimensionamento tivesse sido solicitada com a opção de refila padrão); finalmente, o Pool é removido do sistema. Como as Tarefas em execução são enfileiradas novamente, o usuário pode executar novamente essas Tarefas atualizando seu Trabalho para direcionar um Pool diferente. As Tarefas podem ser executadas no novo Pool. Se quiser substituir o comportamento de refila de reenfileiramento, chame o Pool de redimensionamento explicitamente para reduzir o Pool para o tamanho zero antes de excluí-lo. Se você chamar uma API de Atualização, Patch ou Exclusão em um Pool no estado de exclusão, ela falhará com o código de status HTTP 409 com o código de erro PoolBeingDeleted.
deleteTask(string, string, DeleteTaskOptionalParams)	Quando uma Tarefa é excluída, todos os arquivos em seu diretório no Nó de Computação onde ela foi executada também são excluídos (independentemente do tempo de retenção). Para Tarefas de várias instâncias, a operação Excluir Tarefa aplica-se de forma síncrona à tarefa principal; As subtarefas e seus arquivos são excluídos de forma assíncrona em segundo plano.
deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)	Exclui o arquivo de Tarefa especificado do Nó de Computação onde a Tarefa foi executada.
disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)	O Serviço de Lotes move imediatamente o Trabalho para o estado de desativação. O Batch usa então o parâmetro disableTasks para determinar o que fazer com as Tasks do Job atualmente em execução. O Job mantém-se no estado de desativação até que a operação de desativação seja concluída e todas as Tarefas tenham sido tratadas de acordo com a opção disableTasks; o Job passa então para o estado de deficiência. Nenhuma nova Tarefa é iniciada sob o Trabalho até que este volte ao estado ativo. Se tentar desativar um Job que esteja em qualquer estado que não ativo, desativado ou desativado, o pedido falha com o código de estado 409.
disableJobSchedule(string, DisableJobScheduleOptionalParams)	Nenhum novo trabalho será criado até que o cronograma de trabalho seja ativado novamente.
disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)	Pode desativar o agendamento de tarefas num nó de computação apenas se o seu estado atual de agendamento estiver ativado.
disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)	Desabilita o dimensionamento automático para um pool.
enableJob(string, EnableJobOptionalParams)	Quando chamas esta API, o serviço Batch define um Job desativado para o estado de habilitação. Após a conclusão desta operação, o Job passa para o estado ativo e o agendamento de novas Tarefas no Job recomeça. O serviço Batch não permite que uma Tarefa permaneça no estado ativo por mais de 180 dias. Portanto, se ativar um Job contendo Tarefas ativas que foram adicionadas há mais de 180 dias, essas Tarefas não serão executadas.
enableJobSchedule(string, EnableJobScheduleOptionalParams)	Habilita uma agenda de trabalho.
enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)	Só pode ativar o agendamento de tarefas num Nó de Computação se o seu estado atual de agendamento estiver desativado
enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)	Não é possível habilitar o dimensionamento automático em um Pool se uma operação de redimensionamento estiver em andamento no Pool. Se o dimensionamento automático do Pool estiver desabilitado no momento, você deverá especificar uma fórmula de dimensionamento automático válida como parte da solicitação. Se o dimensionamento automático do Pool já estiver habilitado, você poderá especificar uma nova fórmula de dimensionamento automático e/ou um novo intervalo de avaliação. Não é possível chamar essa API para o mesmo Pool mais de uma vez a cada 30 segundos.
evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)	Esta API destina-se principalmente a validar uma fórmula de escala automática, uma vez que simplesmente devolve o resultado sem aplicar a fórmula ao Pool. O Pool deve ter o dimensionamento automático habilitado para avaliar uma fórmula.
getApplication(string, GetApplicationOptionalParams)	Esta operação devolve apenas Aplicações e versões disponíveis para uso nos Nós de Computação; isto é, que pode ser usado numa referência de Pacote. Para informações de administrador sobre aplicações e versões que ainda não estão disponíveis para os Compute Nodes, utilize o portal Azure ou a API Azure Resource Manager.
getJob(string, GetJobOptionalParams)	Obtém informações sobre o cargo especificado.
getJobSchedule(string, GetJobScheduleOptionalParams)	Obtém informações sobre o Horário de Trabalho especificado.
getJobTaskCounts(string, GetJobTaskCountsOptionalParams)	As contagens de Tarefas fornecem uma contagem das Tarefas por estado de Tarefa ativa, em execução ou concluída e uma contagem de Tarefas bem-sucedidas ou com falha. As tarefas no estado de preparação são contadas como em execução. Observe que os números retornados podem nem sempre estar atualizados. Se precisar de contagens exatas de tarefas, use uma consulta de lista.
getNode(string, string, GetNodeOptionalParams)	Obtém informações sobre o nó de computação especificado.
getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)	Obtém informações sobre a Extensão do Nó de Computação especificada.
getNodeFile(string, string, string, GetNodeFileOptionalParams)	Devolve o conteúdo do ficheiro Compute Node especificado.
getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)	Obtém as propriedades do arquivo de nó de computação especificado.
getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)	Antes de poder iniciar sessão remotamente num Nó de Computação usando as definições de login remoto, deve criar uma Conta de utilizador no Nó de Computação e configurar portas de acesso para SSH e RDP. Para mais informações, consulte https://learn.microsoft.com/azure/batch/pool-endpoint-configuration
getPool(string, GetPoolOptionalParams)	Obtém informações sobre o Pool especificado.
getTask(string, string, GetTaskOptionalParams)	Para Tarefas multi-instância, informações como affinityId, executionInfo e nodeInfo referem-se à Tarefa principal. Use a API de subtarefas da lista para obter informações sobre subtarefas.
getTaskFile(string, string, string, GetTaskFileOptionalParams)	Devolve o conteúdo do ficheiro de Tarefa especificado.
getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)	Obtém as propriedades do arquivo de tarefa especificado.
jobScheduleExists(string, JobScheduleExistsOptionalParams)	Verifica a existência do Horário de Trabalho especificado.
listApplications(ListApplicationsOptionalParams)	Esta operação devolve apenas Aplicações e versões disponíveis para uso nos Nós de Computação; isto é, que pode ser usado numa referência de Pacote. Para informações de administrador sobre aplicações e versões que ainda não estão disponíveis para a Compute Nodes, utilize o portal Azure ou a API Azure Resource Manager.
listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)	Essa API retorna o status da Tarefa de Preparação e Liberação de Trabalho em todos os Nós de Computação que executaram a Tarefa de Preparação ou Liberação de Trabalho. Isso inclui nós de computação que já foram removidos do pool. Se essa API for invocada em um trabalho que não tenha nenhuma tarefa de preparação ou liberação de trabalho, o serviço em lote retornará o código de status HTTP 409 (Conflito) com um código de erro de JobPreparationTaskNotSpecified.
listJobs(ListJobsOptionalParams)	Lista todos os empregos na Conta especificada.
listJobSchedules(ListJobSchedulesOptionalParams)	Lista todos os Cronogramas de Trabalho na Conta especificada.
listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)	Lista os Empregos que foram criados ao abrigo do Calendário de Tarefas especificado.
listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)	Lista as extensões dos nós de computação no pool especificado.
listNodeFiles(string, string, ListNodeFilesOptionalParams)	Lista todos os arquivos em diretórios de tarefas no nó de computação especificado.
listNodes(string, ListNodesOptionalParams)	Lista os nós de computação no pool especificado.
listPoolNodeCounts(ListPoolNodeCountsOptionalParams)	Obtém o número de nós de computação em cada estado, agrupados por pool. Observe que os números retornados podem nem sempre estar atualizados. Se precisar de contagens exatas de nós, use uma consulta de lista.
listPools(ListPoolsOptionalParams)	Lista todos os Pools na Conta especificada.
listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)	Se você não especificar uma cláusula $filter incluindo um poolId, a resposta incluirá todos os Pools que existiam na Conta no intervalo de tempo dos intervalos de agregação retornados. Se você não especificar uma cláusula $filter incluindo startTime ou endTime, esses filtros serão padronizados para as horas de início e término do último intervalo de agregação atualmente disponível; ou seja, apenas o último intervalo de agregação é retornado.
listSubTasks(string, string, ListSubTasksOptionalParams)	Se a Tarefa não for uma Tarefa de várias instâncias, isso retornará uma coleção vazia.
listSupportedImages(ListSupportedImagesOptionalParams)	Lista todas as Imagens de Máquina Virtual suportadas pelo serviço Azure Batch.
listTaskFiles(string, string, ListTaskFilesOptionalParams)	Lista os arquivos no diretório de uma tarefa em seu nó de computação.
listTasks(string, ListTasksOptionalParams)	Para Tarefas multi-instância, informações como affinityId, executionInfo e nodeInfo referem-se à Tarefa principal. Use a API de subtarefas da lista para obter informações sobre subtarefas.
poolExists(string, PoolExistsOptionalParams)	Obtém propriedades básicas de um Pool.
reactivateTask(string, string, ReactivateTaskOptionalParams)	A reativação torna uma Tarefa elegível para ser repetida novamente até sua contagem máxima de tentativas. O estado da tarefa é alterado para ativo. Como a Tarefa não está mais no estado concluído, qualquer código de saída anterior ou informações de falha não estão mais disponíveis após a reativação. Cada vez que uma Tarefa é reativada, sua contagem de tentativas é redefinida para 0. A reativação falhará para Tarefas que não foram concluídas ou que foram concluídas anteriormente com êxito (com um código de saída de 0). Além disso, ele falhará se o trabalho tiver sido concluído (ou estiver terminando ou excluindo).
rebootNode(string, string, RebootNodeOptionalParams)	Você pode reiniciar um nó de computação somente se ele estiver em um estado ocioso ou em execução.
reimageNode(string, string, ReimageNodeOptionalParams)	Você pode reinstalar o sistema operacional em um nó de computação somente se ele estiver em um estado ocioso ou em execução. Esta API só pode ser invocada em Pools criados com a propriedade de configuração do serviço cloud.
removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)	Essa operação só pode ser executada quando o estado de alocação do Pool estiver estável. Quando essa operação é executada, o estado de alocação muda de estável para redimensionamento. Cada solicitação pode remover até 100 nós.
replaceJob(string, BatchJob, ReplaceJobOptionalParams)	Isto substitui totalmente todas as propriedades atualizáveis do Job. Por exemplo, se o Job tiver restrições associadas e se as restrições não forem especificadas com este pedido, então o serviço Batch removerá as restrições existentes.
replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)	Isto substitui totalmente todas as propriedades atualizáveis do Work Schedule. Por exemplo, se a propriedade de horários não for especificada com este pedido, então o serviço Batch irá remover o horário existente. Alterações a um Horário de Tarefas afetam apenas os Trabalhos criados pelo calendário após a atualização ter ocorrido; Os empregos atualmente em execução não são afetados.
replaceNodeUser(string, string, string, BatchNodeUserUpdateOptions, ReplaceNodeUserOptionalParams)	Esta operação substitui todas as propriedades atualizáveis da Conta. Por exemplo, se o elemento expiryTime não for especificado, o valor atual é substituído pelo valor predefinido, não sendo deixado sem modificações. Pode atualizar uma conta de utilizador num Nó de Computação apenas quando estiver em estado de inatividade ou a correr.
replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)	Isto substitui totalmente todas as propriedades atualizáveis do Pool. Por exemplo, se o Pool tiver um StartTask associado e se o StartTask não for especificado com este pedido, então o serviço Batch removerá o StartTask existente.
replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)	Atualiza as propriedades da Tarefa especificada.
resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)	Você só pode redimensionar um Pool quando seu estado de alocação estiver estável. Se o Pool já estiver redimensionando, a solicitação falhará com o código de status 409. Quando você redimensiona um Pool, o estado de alocação do Pool muda de estável para redimensionamento. Não é possível redimensionar pools configurados para dimensionamento automático. Se você tentar fazer isso, o serviço de lote retorna um erro 409. Se você redimensionar um pool para baixo, o serviço de lote escolhe quais nós de computação remover. Para remover nós de computação específicos, use a API de remoção de nós de computação do pool.
startNode(string, string, StartNodeOptionalParams)	Só podes iniciar um Nó de Computação se este tiver sido realocado.
stopPoolResize(string, StopPoolResizeOptionalParams)	Isto não restaura o Pool ao seu estado anterior anterior à operação de redimensionamento: apenas impede que quaisquer alterações adicionais sejam feitas, e o Pool mantém o seu estado atual. Após a paragem, o Pool estabiliza no número de Nós de Computação em que estava quando a operação de paragem foi concluída. Durante a operação de paragem, o estado de alocação do Pool muda primeiro para paragem e depois para estabilização. Uma operação de redimensionamento não precisa de ser um pedido explícito de pool de redimensionamento; esta API também pode ser usada para travar o dimensionamento inicial do Pool quando este é criado.
terminateJob(string, TerminateJobOptionalParams)	Quando é recebido um pedido de Terminar Trabalho, o serviço Batch define o Trabalho para o estado de terminação. O serviço Batch termina então quaisquer Tarefas em execução associadas ao Job e executa quaisquer Tarefas de Release de Job necessárias. Depois, o Trabalho passa para o estado concluído. Se houver Tarefas no Trabalho no estado ativo, elas permanecerão no estado ativo. Uma vez terminado um Trabalho, novas Tarefas não podem ser adicionadas e quaisquer Tarefas ativas restantes não serão agendadas.
terminateJobSchedule(string, TerminateJobScheduleOptionalParams)	Encerra uma agenda de trabalho.
terminateTask(string, string, TerminateTaskOptionalParams)	Quando a Tarefa for encerrada, ela será movida para o estado concluído. Para Tarefas de várias instâncias, a operação Encerrar Tarefa aplica-se de forma síncrona à tarefa principal; As subtarefas são então encerradas de forma assíncrona em segundo plano.
updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)	Isto substitui apenas as propriedades do Job especificadas no pedido. Por exemplo, se o Job tiver restrições, e um pedido não especificar o elemento de restrição, então o Job mantém as restrições existentes.
updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)	Isto substitui apenas as propriedades do Horário de Trabalho especificadas no pedido. Por exemplo, se a propriedade de horários não for especificada com este pedido, então o serviço Batch manterá o horário existente. Alterações a um Horário de Tarefas afetam apenas os Trabalhos criados pelo calendário após a atualização ter ocorrido; Os empregos atualmente em execução não são afetados.
updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)	Isto apenas substitui as propriedades do Pool especificadas no pedido. Por exemplo, se o Pool tiver um StartTask associado e um pedido não especificar um elemento StartTask, então o Pool mantém o StartTask existente.
uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)	Isto serve para recolher ficheiros de registo do Azure Batch de forma automatizada a partir dos Compute Nodes caso esteja a experienciar um erro e pretenda escalar para o suporte Azure. Os ficheiros de registo do serviço Azure Batch devem ser partilhados com o suporte do Azure para ajudar na depuração de problemas com o serviço Batch.

Detalhes do Construtor

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

new BatchClient(endpointParam: string, credential: TokenCredential | AzureNamedKeyCredential, options?: BatchClientOptionalParams)

Parâmetros

endpointParam

string

credential

TokenCredential | AzureNamedKeyCredential

options

BatchClientOptionalParams

Detalhes de Método

createJob(BatchJobCreateOptions, CreateJobOptionalParams)

O serviço Batch suporta duas formas de controlar o trabalho realizado como parte de um Trabalho. Na primeira abordagem, o utilizador especifica uma Tarefa do Gestor de Trabalhos. O serviço Batch lança esta Tarefa quando está pronta para iniciar o Trabalho. A Tarefa do Gestor de Jobs controla todas as outras Tarefas que correm sob este Job, utilizando as APIs das Tarefas. Na segunda abordagem, o utilizador controla diretamente a execução de Tarefas sob um Job ativo, utilizando as APIs de Tarefas. Note também: ao nomear Jobs, evite incluir informações sensíveis como nomes de utilizador ou nomes secretos de projetos. Esta informação pode aparecer em registos de telemetria acessíveis aos engenheiros do Suporte da Microsoft.

function createJob(job: BatchJobCreateOptions, options?: CreateJobOptionalParams): Promise<void>

Parâmetros

job

BatchJobCreateOptions

options

CreateJobOptionalParams

Devoluções

Promise<void>

createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)

Cria um Cronograma de Trabalho para a Conta especificada.

function createJobSchedule(jobSchedule: BatchJobScheduleCreateOptions, options?: CreateJobScheduleOptionalParams): Promise<void>

Parâmetros

jobSchedule

BatchJobScheduleCreateOptions

options

CreateJobScheduleOptionalParams

Devoluções

Promise<void>

createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)

Pode adicionar uma Conta de utilizador a um Nó de Computação apenas quando este estiver em estado de inatividade ou a correr. Antes de poderes iniciar sessão remotamente num Nó de Computação, tens de configurar portas de acesso para SSH e RDP. Para mais informações, consulte https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

function createNodeUser(poolId: string, nodeId: string, user: BatchNodeUserCreateOptions, options?: CreateNodeUserOptionalParams): Promise<void>

Parâmetros

poolId

string

nodeId

string

user

BatchNodeUserCreateOptions

options

CreateNodeUserOptionalParams

Devoluções

Promise<void>

createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)

Ao nomear Pools, evite incluir informações confidenciais, como nomes de usuários ou nomes de projetos secretos. Esta informação pode aparecer em registos de telemetria acessíveis aos engenheiros do Suporte da Microsoft.

function createPool(pool: BatchPoolCreateOptions, options?: CreatePoolOptionalParams): Promise<void>

Parâmetros

pool

BatchPoolCreateOptions

options

CreatePoolOptionalParams

Devoluções

Promise<void>

createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)

A duração máxima de uma Tarefa desde a adição até à conclusão é de 180 dias. Se uma Tarefa não for concluída dentro de 180 dias após a sua adicionação, será terminada pelo serviço Batch e deixada no estado em que estava nessa altura.

function createTask(jobId: string, task: BatchTaskCreateOptions, options?: CreateTaskOptionalParams): Promise<void>

Parâmetros

jobId

string

task

BatchTaskCreateOptions

options

CreateTaskOptionalParams

Devoluções

Promise<void>

createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)

Note que cada Tarefa deve ter um ID único. O serviço Batch pode não devolver os resultados de cada Tarefa na mesma ordem em que as Tarefas foram submetidas neste pedido. Se o servidor expirar ou a ligação for fechada durante o pedido, o pedido pode ter sido parcial ou totalmente processado, ou nem sequer processado. Nesses casos, o utilizador deve reemitir o pedido. Note que cabe ao utilizador tratar corretamente das falhas ao reemitir um pedido. Por exemplo, deve usar os mesmos IDs de tarefa durante uma retentativa para que, se a operação anterior tiver sido bem-sucedida, a retentativa não crie tarefas extra inesperadamente. Se a resposta contiver alguma Tarefa que não foi adicionada, o cliente pode tentar novamente o pedido. Numa nova tentativa, é mais eficiente submeter apenas as Tarefas que não foram adicionadas e omitir as Tarefas que foram adicionadas com sucesso à primeira tentativa. A duração máxima de uma Tarefa desde a adição até à conclusão é de 180 dias. Se uma Tarefa não for concluída dentro de 180 dias após a sua adicionação, será terminada pelo serviço Batch e deixada no estado em que estava nessa altura.

function createTaskCollection(jobId: string, taskCollection: BatchTaskGroup, options?: CreateTaskCollectionOptionalParams): Promise<BatchCreateTaskCollectionResult>

Parâmetros

jobId

string

taskCollection

BatchTaskGroup

options

CreateTaskCollectionOptionalParams

Devoluções

Promise<BatchCreateTaskCollectionResult>

deallocateNode(string, string, DeallocateNodeOptionalParams)

Você pode desalocar um nó de computação somente se ele estiver em um estado ocioso ou em execução.

function deallocateNode(poolId: string, nodeId: string, options?: DeallocateNodeOptionalParams): PollerLike<OperationState<void>, void>

Parâmetros

poolId

string

nodeId

string

options

DeallocateNodeOptionalParams

Devoluções

PollerLike<OperationState<void>, void>

deleteJob(string, DeleteJobOptionalParams)

Eliminar um Trabalho também elimina todas as Tarefas que fazem parte desse Trabalho, bem como todas as estatísticas do Trabalho. Isto também sobrepõe-se ao período de retenção dos dados da tarefa; isto é, se o Job contiver Tasks que ainda estão retidas nos Nós de Computação, os serviços Batch eliminam os diretórios de trabalho dessas Tarefas e todo o seu conteúdo. Quando é recebido um pedido de Delete Job, o serviço Batch define o Job para o estado de eliminação. Todas as operações de atualização num Job que esteja em estado de eliminação falharão com o código de estado 409 (Conflito), com informação adicional a indicar que o Job está a ser eliminado.

function deleteJob(jobId: string, options?: DeleteJobOptionalParams): PollerLike<OperationState<void>, void>

Parâmetros

jobId

string

options

DeleteJobOptionalParams

Devoluções

PollerLike<OperationState<void>, void>

deleteJobSchedule(string, DeleteJobScheduleOptionalParams)

Quando você exclui uma Agenda de Trabalhos, isso também exclui todos os Trabalhos e Tarefas sob essa agenda. Quando as Tarefas são excluídas, todos os arquivos em seus diretórios de trabalho nos Nós de Computação também são excluídos (o período de retenção é ignorado). As estatísticas da Agenda de Trabalho não são mais acessíveis quando a Agenda de Trabalho é excluída, embora ainda sejam contadas para as estatísticas de tempo de vida da Conta.

function deleteJobSchedule(jobScheduleId: string, options?: DeleteJobScheduleOptionalParams): PollerLike<OperationState<void>, void>

Parâmetros

jobScheduleId

string

options

DeleteJobScheduleOptionalParams

Devoluções

PollerLike<OperationState<void>, void>

deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)

Exclui o arquivo especificado do nó de computação.

function deleteNodeFile(poolId: string, nodeId: string, filePath: string, options?: DeleteNodeFileOptionalParams): Promise<void>

Parâmetros

poolId

string

nodeId

string

filePath

string

options

DeleteNodeFileOptionalParams

Devoluções

Promise<void>

deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)

Você pode excluir uma conta de usuário para um nó de computação somente quando ele estiver no estado ocioso ou em execução. Antes de poderes iniciar sessão remotamente num Nó de Computação, tens de configurar portas de acesso para SSH e RDP. Para mais informações, consulte https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

function deleteNodeUser(poolId: string, nodeId: string, userName: string, options?: DeleteNodeUserOptionalParams): Promise<void>

Parâmetros

poolId

string

nodeId

string

userName

string

options

DeleteNodeUserOptionalParams

Devoluções

Promise<void>

deletePool(string, DeletePoolOptionalParams)

Quando você solicita que um Pool seja excluído, as seguintes ações ocorrem: o estado do Pool é definido como exclusão; qualquer operação de redimensionamento em curso no Pool é interrompida; o serviço de lote começa a redimensionar o pool para zero nós de computação; todas as tarefas em execução em nós de computação existentes são encerradas e colocadas novamente na fila (como se uma operação de pool de redimensionamento tivesse sido solicitada com a opção de refila padrão); finalmente, o Pool é removido do sistema. Como as Tarefas em execução são enfileiradas novamente, o usuário pode executar novamente essas Tarefas atualizando seu Trabalho para direcionar um Pool diferente. As Tarefas podem ser executadas no novo Pool. Se quiser substituir o comportamento de refila de reenfileiramento, chame o Pool de redimensionamento explicitamente para reduzir o Pool para o tamanho zero antes de excluí-lo. Se você chamar uma API de Atualização, Patch ou Exclusão em um Pool no estado de exclusão, ela falhará com o código de status HTTP 409 com o código de erro PoolBeingDeleted.

function deletePool(poolId: string, options?: DeletePoolOptionalParams): PollerLike<OperationState<void>, void>

Parâmetros

poolId

string

options

DeletePoolOptionalParams

Devoluções

PollerLike<OperationState<void>, void>

deleteTask(string, string, DeleteTaskOptionalParams)

Quando uma Tarefa é excluída, todos os arquivos em seu diretório no Nó de Computação onde ela foi executada também são excluídos (independentemente do tempo de retenção). Para Tarefas de várias instâncias, a operação Excluir Tarefa aplica-se de forma síncrona à tarefa principal; As subtarefas e seus arquivos são excluídos de forma assíncrona em segundo plano.

function deleteTask(jobId: string, taskId: string, options?: DeleteTaskOptionalParams): Promise<void>

Parâmetros

jobId

string

taskId

string

options

DeleteTaskOptionalParams

Devoluções

Promise<void>

deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)

Exclui o arquivo de Tarefa especificado do Nó de Computação onde a Tarefa foi executada.

function deleteTaskFile(jobId: string, taskId: string, filePath: string, options?: DeleteTaskFileOptionalParams): Promise<void>

Parâmetros

jobId

string

taskId

string

filePath

string

options

DeleteTaskFileOptionalParams

Devoluções

Promise<void>

disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)

O Serviço de Lotes move imediatamente o Trabalho para o estado de desativação. O Batch usa então o parâmetro disableTasks para determinar o que fazer com as Tasks do Job atualmente em execução. O Job mantém-se no estado de desativação até que a operação de desativação seja concluída e todas as Tarefas tenham sido tratadas de acordo com a opção disableTasks; o Job passa então para o estado de deficiência. Nenhuma nova Tarefa é iniciada sob o Trabalho até que este volte ao estado ativo. Se tentar desativar um Job que esteja em qualquer estado que não ativo, desativado ou desativado, o pedido falha com o código de estado 409.

function disableJob(jobId: string, disableOptions: BatchJobDisableOptions, options?: DisableJobOptionalParams): PollerLike<OperationState<void>, void>

Parâmetros

jobId

string

disableOptions

BatchJobDisableOptions

options

DisableJobOptionalParams

Devoluções

PollerLike<OperationState<void>, void>

disableJobSchedule(string, DisableJobScheduleOptionalParams)

Nenhum novo trabalho será criado até que o cronograma de trabalho seja ativado novamente.

function disableJobSchedule(jobScheduleId: string, options?: DisableJobScheduleOptionalParams): Promise<void>

Parâmetros

jobScheduleId

string

options

DisableJobScheduleOptionalParams

Devoluções

Promise<void>

disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)

Pode desativar o agendamento de tarefas num nó de computação apenas se o seu estado atual de agendamento estiver ativado.

function disableNodeScheduling(poolId: string, nodeId: string, options?: DisableNodeSchedulingOptionalParams): Promise<void>

Parâmetros

poolId

string

nodeId

string

options

DisableNodeSchedulingOptionalParams

Devoluções

Promise<void>

disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)

Desabilita o dimensionamento automático para um pool.

function disablePoolAutoScale(poolId: string, options?: DisablePoolAutoScaleOptionalParams): Promise<void>

Parâmetros

poolId

string

options

DisablePoolAutoScaleOptionalParams

Devoluções

Promise<void>

enableJob(string, EnableJobOptionalParams)

Quando chamas esta API, o serviço Batch define um Job desativado para o estado de habilitação. Após a conclusão desta operação, o Job passa para o estado ativo e o agendamento de novas Tarefas no Job recomeça. O serviço Batch não permite que uma Tarefa permaneça no estado ativo por mais de 180 dias. Portanto, se ativar um Job contendo Tarefas ativas que foram adicionadas há mais de 180 dias, essas Tarefas não serão executadas.

function enableJob(jobId: string, options?: EnableJobOptionalParams): PollerLike<OperationState<void>, void>

Parâmetros

jobId

string

options

EnableJobOptionalParams

Devoluções

PollerLike<OperationState<void>, void>

enableJobSchedule(string, EnableJobScheduleOptionalParams)

Habilita uma agenda de trabalho.

function enableJobSchedule(jobScheduleId: string, options?: EnableJobScheduleOptionalParams): Promise<void>

Parâmetros

jobScheduleId

string

options

EnableJobScheduleOptionalParams

Devoluções

Promise<void>

enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)

Só pode ativar o agendamento de tarefas num Nó de Computação se o seu estado atual de agendamento estiver desativado

function enableNodeScheduling(poolId: string, nodeId: string, options?: EnableNodeSchedulingOptionalParams): Promise<void>

Parâmetros

poolId

string

nodeId

string

options

EnableNodeSchedulingOptionalParams

Devoluções

Promise<void>

enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)

Não é possível habilitar o dimensionamento automático em um Pool se uma operação de redimensionamento estiver em andamento no Pool. Se o dimensionamento automático do Pool estiver desabilitado no momento, você deverá especificar uma fórmula de dimensionamento automático válida como parte da solicitação. Se o dimensionamento automático do Pool já estiver habilitado, você poderá especificar uma nova fórmula de dimensionamento automático e/ou um novo intervalo de avaliação. Não é possível chamar essa API para o mesmo Pool mais de uma vez a cada 30 segundos.

function enablePoolAutoScale(poolId: string, enableAutoScaleOptions: BatchPoolEnableAutoScaleOptions, options?: EnablePoolAutoScaleOptionalParams): Promise<void>

Parâmetros

poolId

string

enableAutoScaleOptions

BatchPoolEnableAutoScaleOptions

options

EnablePoolAutoScaleOptionalParams

Devoluções

Promise<void>

evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)

Esta API destina-se principalmente a validar uma fórmula de escala automática, uma vez que simplesmente devolve o resultado sem aplicar a fórmula ao Pool. O Pool deve ter o dimensionamento automático habilitado para avaliar uma fórmula.

function evaluatePoolAutoScale(poolId: string, evaluateAutoScaleOptions: BatchPoolEvaluateAutoScaleOptions, options?: EvaluatePoolAutoScaleOptionalParams): Promise<AutoScaleRun>

Parâmetros

poolId

string

evaluateAutoScaleOptions

BatchPoolEvaluateAutoScaleOptions

options

EvaluatePoolAutoScaleOptionalParams

Devoluções

Promise<AutoScaleRun>

getApplication(string, GetApplicationOptionalParams)

Esta operação devolve apenas Aplicações e versões disponíveis para uso nos Nós de Computação; isto é, que pode ser usado numa referência de Pacote. Para informações de administrador sobre aplicações e versões que ainda não estão disponíveis para os Compute Nodes, utilize o portal Azure ou a API Azure Resource Manager.

function getApplication(applicationId: string, options?: GetApplicationOptionalParams): Promise<BatchApplication>

Parâmetros

applicationId

string

options

GetApplicationOptionalParams

Devoluções

Promise<BatchApplication>

getJob(string, GetJobOptionalParams)

Obtém informações sobre o cargo especificado.

function getJob(jobId: string, options?: GetJobOptionalParams): Promise<BatchJob>

Parâmetros

jobId

string

options

GetJobOptionalParams

Devoluções

Promise<BatchJob>

getJobSchedule(string, GetJobScheduleOptionalParams)

Obtém informações sobre o Horário de Trabalho especificado.

function getJobSchedule(jobScheduleId: string, options?: GetJobScheduleOptionalParams): Promise<BatchJobSchedule>

Parâmetros

jobScheduleId

string

options

GetJobScheduleOptionalParams

Devoluções

Promise<BatchJobSchedule>

getJobTaskCounts(string, GetJobTaskCountsOptionalParams)

As contagens de Tarefas fornecem uma contagem das Tarefas por estado de Tarefa ativa, em execução ou concluída e uma contagem de Tarefas bem-sucedidas ou com falha. As tarefas no estado de preparação são contadas como em execução. Observe que os números retornados podem nem sempre estar atualizados. Se precisar de contagens exatas de tarefas, use uma consulta de lista.

function getJobTaskCounts(jobId: string, options?: GetJobTaskCountsOptionalParams): Promise<BatchTaskCountsResult>

Parâmetros

jobId

string

options

GetJobTaskCountsOptionalParams

Devoluções

Promise<BatchTaskCountsResult>

getNode(string, string, GetNodeOptionalParams)

Obtém informações sobre o nó de computação especificado.

function getNode(poolId: string, nodeId: string, options?: GetNodeOptionalParams): Promise<BatchNode>

Parâmetros

poolId

string

nodeId

string

options

GetNodeOptionalParams

Devoluções

Promise<BatchNode>

getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)

Obtém informações sobre a Extensão do Nó de Computação especificada.

function getNodeExtension(poolId: string, nodeId: string, extensionName: string, options?: GetNodeExtensionOptionalParams): Promise<BatchNodeVMExtension>

Parâmetros

poolId

string

nodeId

string

extensionName

string

options

GetNodeExtensionOptionalParams

Devoluções

Promise<BatchNodeVMExtension>

getNodeFile(string, string, string, GetNodeFileOptionalParams)

Devolve o conteúdo do ficheiro Compute Node especificado.

function getNodeFile(poolId: string, nodeId: string, filePath: string, options?: GetNodeFileOptionalParams): Promise<Uint8Array>

Parâmetros

poolId

string

nodeId

string

filePath

string

options

GetNodeFileOptionalParams

Devoluções

Promise<Uint8Array>

getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)

Obtém as propriedades do arquivo de nó de computação especificado.

function getNodeFileProperties(poolId: string, nodeId: string, filePath: string, options?: GetNodeFilePropertiesOptionalParams): Promise<BatchNodeFile>

Parâmetros

poolId

string

nodeId

string

filePath

string

options

GetNodeFilePropertiesOptionalParams

Devoluções

Promise<BatchNodeFile>

getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)

Antes de poder iniciar sessão remotamente num Nó de Computação usando as definições de login remoto, deve criar uma Conta de utilizador no Nó de Computação e configurar portas de acesso para SSH e RDP. Para mais informações, consulte https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

function getNodeRemoteLoginSettings(poolId: string, nodeId: string, options?: GetNodeRemoteLoginSettingsOptionalParams): Promise<BatchNodeRemoteLoginSettings>

Parâmetros

poolId

string

nodeId

string

options

GetNodeRemoteLoginSettingsOptionalParams

Devoluções

Promise<BatchNodeRemoteLoginSettings>

getPool(string, GetPoolOptionalParams)

Obtém informações sobre o Pool especificado.

function getPool(poolId: string, options?: GetPoolOptionalParams): Promise<BatchPool>

Parâmetros

poolId

string

options

GetPoolOptionalParams

Devoluções

Promise<BatchPool>

getTask(string, string, GetTaskOptionalParams)

Para Tarefas multi-instância, informações como affinityId, executionInfo e nodeInfo referem-se à Tarefa principal. Use a API de subtarefas da lista para obter informações sobre subtarefas.

function getTask(jobId: string, taskId: string, options?: GetTaskOptionalParams): Promise<BatchTask>

Parâmetros

jobId

string

taskId

string

options

GetTaskOptionalParams

Devoluções

Promise<BatchTask>

getTaskFile(string, string, string, GetTaskFileOptionalParams)

Devolve o conteúdo do ficheiro de Tarefa especificado.

function getTaskFile(jobId: string, taskId: string, filePath: string, options?: GetTaskFileOptionalParams): Promise<Uint8Array>

Parâmetros

jobId

string

taskId

string

filePath

string

options

GetTaskFileOptionalParams

Devoluções

Promise<Uint8Array>

getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)

Obtém as propriedades do arquivo de tarefa especificado.

function getTaskFileProperties(jobId: string, taskId: string, filePath: string, options?: GetTaskFilePropertiesOptionalParams): Promise<BatchNodeFile>

Parâmetros

jobId

string

taskId

string

filePath

string

options

GetTaskFilePropertiesOptionalParams

Devoluções

Promise<BatchNodeFile>

jobScheduleExists(string, JobScheduleExistsOptionalParams)

Verifica a existência do Horário de Trabalho especificado.

function jobScheduleExists(jobScheduleId: string, options?: JobScheduleExistsOptionalParams): Promise<boolean>

Parâmetros

jobScheduleId

string

options

JobScheduleExistsOptionalParams

Devoluções

Promise<boolean>

listApplications(ListApplicationsOptionalParams)

Esta operação devolve apenas Aplicações e versões disponíveis para uso nos Nós de Computação; isto é, que pode ser usado numa referência de Pacote. Para informações de administrador sobre aplicações e versões que ainda não estão disponíveis para a Compute Nodes, utilize o portal Azure ou a API Azure Resource Manager.

function listApplications(options?: ListApplicationsOptionalParams): PagedAsyncIterableIterator<BatchApplication, BatchApplication[], PageSettings>

Parâmetros

options

ListApplicationsOptionalParams

Devoluções

PagedAsyncIterableIterator<BatchApplication, BatchApplication[], PageSettings>

listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)

Essa API retorna o status da Tarefa de Preparação e Liberação de Trabalho em todos os Nós de Computação que executaram a Tarefa de Preparação ou Liberação de Trabalho. Isso inclui nós de computação que já foram removidos do pool. Se essa API for invocada em um trabalho que não tenha nenhuma tarefa de preparação ou liberação de trabalho, o serviço em lote retornará o código de status HTTP 409 (Conflito) com um código de erro de JobPreparationTaskNotSpecified.

function listJobPreparationAndReleaseTaskStatus(jobId: string, options?: ListJobPreparationAndReleaseTaskStatusOptionalParams): PagedAsyncIterableIterator<BatchJobPreparationAndReleaseTaskStatus, BatchJobPreparationAndReleaseTaskStatus[], PageSettings>

Parâmetros

jobId

string

options

ListJobPreparationAndReleaseTaskStatusOptionalParams

Devoluções

PagedAsyncIterableIterator<BatchJobPreparationAndReleaseTaskStatus, BatchJobPreparationAndReleaseTaskStatus[], PageSettings>

listJobs(ListJobsOptionalParams)

Lista todos os empregos na Conta especificada.

function listJobs(options?: ListJobsOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

Parâmetros

options

ListJobsOptionalParams

Devoluções

PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

listJobSchedules(ListJobSchedulesOptionalParams)

Lista todos os Cronogramas de Trabalho na Conta especificada.

function listJobSchedules(options?: ListJobSchedulesOptionalParams): PagedAsyncIterableIterator<BatchJobSchedule, BatchJobSchedule[], PageSettings>

Parâmetros

options

ListJobSchedulesOptionalParams

Devoluções

PagedAsyncIterableIterator<BatchJobSchedule, BatchJobSchedule[], PageSettings>

listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)

Lista os Empregos que foram criados ao abrigo do Calendário de Tarefas especificado.

function listJobsFromSchedule(jobScheduleId: string, options?: ListJobsFromScheduleOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

Parâmetros

jobScheduleId

string

options

ListJobsFromScheduleOptionalParams

Devoluções

PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)

Lista as extensões dos nós de computação no pool especificado.

function listNodeExtensions(poolId: string, nodeId: string, options?: ListNodeExtensionsOptionalParams): PagedAsyncIterableIterator<BatchNodeVMExtension, BatchNodeVMExtension[], PageSettings>

Parâmetros

poolId

string

nodeId

string

options

ListNodeExtensionsOptionalParams

Devoluções

PagedAsyncIterableIterator<BatchNodeVMExtension, BatchNodeVMExtension[], PageSettings>

listNodeFiles(string, string, ListNodeFilesOptionalParams)

Lista todos os arquivos em diretórios de tarefas no nó de computação especificado.

function listNodeFiles(poolId: string, nodeId: string, options?: ListNodeFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

Parâmetros

poolId

string

nodeId

string

options

ListNodeFilesOptionalParams

Devoluções

PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

listNodes(string, ListNodesOptionalParams)

Lista os nós de computação no pool especificado.

function listNodes(poolId: string, options?: ListNodesOptionalParams): PagedAsyncIterableIterator<BatchNode, BatchNode[], PageSettings>

Parâmetros

poolId

string

options

ListNodesOptionalParams

Devoluções

PagedAsyncIterableIterator<BatchNode, BatchNode[], PageSettings>

listPoolNodeCounts(ListPoolNodeCountsOptionalParams)

Obtém o número de nós de computação em cada estado, agrupados por pool. Observe que os números retornados podem nem sempre estar atualizados. Se precisar de contagens exatas de nós, use uma consulta de lista.

function listPoolNodeCounts(options?: ListPoolNodeCountsOptionalParams): PagedAsyncIterableIterator<BatchPoolNodeCounts, BatchPoolNodeCounts[], PageSettings>

Parâmetros

options

ListPoolNodeCountsOptionalParams

Devoluções

PagedAsyncIterableIterator<BatchPoolNodeCounts, BatchPoolNodeCounts[], PageSettings>

listPools(ListPoolsOptionalParams)

Lista todos os Pools na Conta especificada.

function listPools(options?: ListPoolsOptionalParams): PagedAsyncIterableIterator<BatchPool, BatchPool[], PageSettings>

Parâmetros

options

ListPoolsOptionalParams

Devoluções

PagedAsyncIterableIterator<BatchPool, BatchPool[], PageSettings>

listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)

Se você não especificar uma cláusula $filter incluindo um poolId, a resposta incluirá todos os Pools que existiam na Conta no intervalo de tempo dos intervalos de agregação retornados. Se você não especificar uma cláusula $filter incluindo startTime ou endTime, esses filtros serão padronizados para as horas de início e término do último intervalo de agregação atualmente disponível; ou seja, apenas o último intervalo de agregação é retornado.

function listPoolUsageMetrics(options?: ListPoolUsageMetricsOptionalParams): PagedAsyncIterableIterator<BatchPoolUsageMetrics, BatchPoolUsageMetrics[], PageSettings>

Parâmetros

options

ListPoolUsageMetricsOptionalParams

Devoluções

PagedAsyncIterableIterator<BatchPoolUsageMetrics, BatchPoolUsageMetrics[], PageSettings>

listSubTasks(string, string, ListSubTasksOptionalParams)

Se a Tarefa não for uma Tarefa de várias instâncias, isso retornará uma coleção vazia.

function listSubTasks(jobId: string, taskId: string, options?: ListSubTasksOptionalParams): PagedAsyncIterableIterator<BatchSubtask, BatchSubtask[], PageSettings>

Parâmetros

jobId

string

taskId

string

options

ListSubTasksOptionalParams

Devoluções

PagedAsyncIterableIterator<BatchSubtask, BatchSubtask[], PageSettings>

listSupportedImages(ListSupportedImagesOptionalParams)

Lista todas as Imagens de Máquina Virtual suportadas pelo serviço Azure Batch.

function listSupportedImages(options?: ListSupportedImagesOptionalParams): PagedAsyncIterableIterator<BatchSupportedImage, BatchSupportedImage[], PageSettings>

Parâmetros

options

ListSupportedImagesOptionalParams

Devoluções

PagedAsyncIterableIterator<BatchSupportedImage, BatchSupportedImage[], PageSettings>

listTaskFiles(string, string, ListTaskFilesOptionalParams)

Lista os arquivos no diretório de uma tarefa em seu nó de computação.

function listTaskFiles(jobId: string, taskId: string, options?: ListTaskFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

Parâmetros

jobId

string

taskId

string

options

ListTaskFilesOptionalParams

Devoluções

PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

listTasks(string, ListTasksOptionalParams)

Para Tarefas multi-instância, informações como affinityId, executionInfo e nodeInfo referem-se à Tarefa principal. Use a API de subtarefas da lista para obter informações sobre subtarefas.

function listTasks(jobId: string, options?: ListTasksOptionalParams): PagedAsyncIterableIterator<BatchTask, BatchTask[], PageSettings>

Parâmetros

jobId

string

options

ListTasksOptionalParams

Devoluções

PagedAsyncIterableIterator<BatchTask, BatchTask[], PageSettings>

poolExists(string, PoolExistsOptionalParams)

Obtém propriedades básicas de um Pool.

function poolExists(poolId: string, options?: PoolExistsOptionalParams): Promise<boolean>

Parâmetros

poolId

string

options

PoolExistsOptionalParams

Devoluções

Promise<boolean>

reactivateTask(string, string, ReactivateTaskOptionalParams)

A reativação torna uma Tarefa elegível para ser repetida novamente até sua contagem máxima de tentativas. O estado da tarefa é alterado para ativo. Como a Tarefa não está mais no estado concluído, qualquer código de saída anterior ou informações de falha não estão mais disponíveis após a reativação. Cada vez que uma Tarefa é reativada, sua contagem de tentativas é redefinida para 0. A reativação falhará para Tarefas que não foram concluídas ou que foram concluídas anteriormente com êxito (com um código de saída de 0). Além disso, ele falhará se o trabalho tiver sido concluído (ou estiver terminando ou excluindo).

function reactivateTask(jobId: string, taskId: string, options?: ReactivateTaskOptionalParams): Promise<void>

Parâmetros

jobId

string

taskId

string

options

ReactivateTaskOptionalParams

Devoluções

Promise<void>

rebootNode(string, string, RebootNodeOptionalParams)

Você pode reiniciar um nó de computação somente se ele estiver em um estado ocioso ou em execução.

function rebootNode(poolId: string, nodeId: string, options?: RebootNodeOptionalParams): PollerLike<OperationState<void>, void>

Parâmetros

poolId

string

nodeId

string

options

RebootNodeOptionalParams

Devoluções

PollerLike<OperationState<void>, void>

reimageNode(string, string, ReimageNodeOptionalParams)

Você pode reinstalar o sistema operacional em um nó de computação somente se ele estiver em um estado ocioso ou em execução. Esta API só pode ser invocada em Pools criados com a propriedade de configuração do serviço cloud.

function reimageNode(poolId: string, nodeId: string, options?: ReimageNodeOptionalParams): PollerLike<OperationState<void>, void>

Parâmetros

poolId

string

nodeId

string

options

ReimageNodeOptionalParams

Devoluções

PollerLike<OperationState<void>, void>

removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)

Essa operação só pode ser executada quando o estado de alocação do Pool estiver estável. Quando essa operação é executada, o estado de alocação muda de estável para redimensionamento. Cada solicitação pode remover até 100 nós.

function removeNodes(poolId: string, removeOptions: BatchNodeRemoveOptions, options?: RemoveNodesOptionalParams): PollerLike<OperationState<void>, void>

Parâmetros

poolId

string

removeOptions

BatchNodeRemoveOptions

options

RemoveNodesOptionalParams

Devoluções

PollerLike<OperationState<void>, void>

replaceJob(string, BatchJob, ReplaceJobOptionalParams)

Isto substitui totalmente todas as propriedades atualizáveis do Job. Por exemplo, se o Job tiver restrições associadas e se as restrições não forem especificadas com este pedido, então o serviço Batch removerá as restrições existentes.

function replaceJob(jobId: string, job: BatchJob, options?: ReplaceJobOptionalParams): Promise<void>

Parâmetros

jobId

string

job

BatchJob

options

ReplaceJobOptionalParams

Devoluções

Promise<void>

replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)

Isto substitui totalmente todas as propriedades atualizáveis do Work Schedule. Por exemplo, se a propriedade de horários não for especificada com este pedido, então o serviço Batch irá remover o horário existente. Alterações a um Horário de Tarefas afetam apenas os Trabalhos criados pelo calendário após a atualização ter ocorrido; Os empregos atualmente em execução não são afetados.

function replaceJobSchedule(jobScheduleId: string, jobSchedule: BatchJobSchedule, options?: ReplaceJobScheduleOptionalParams): Promise<void>

Parâmetros

jobScheduleId

string

jobSchedule

BatchJobSchedule

options

ReplaceJobScheduleOptionalParams

Devoluções

Promise<void>

replaceNodeUser(string, string, string, BatchNodeUserUpdateOptions, ReplaceNodeUserOptionalParams)

Esta operação substitui todas as propriedades atualizáveis da Conta. Por exemplo, se o elemento expiryTime não for especificado, o valor atual é substituído pelo valor predefinido, não sendo deixado sem modificações. Pode atualizar uma conta de utilizador num Nó de Computação apenas quando estiver em estado de inatividade ou a correr.

function replaceNodeUser(poolId: string, nodeId: string, userName: string, updateOptions: BatchNodeUserUpdateOptions, options?: ReplaceNodeUserOptionalParams): Promise<void>

Parâmetros

poolId

string

nodeId

string

userName

string

updateOptions

BatchNodeUserUpdateOptions

options

ReplaceNodeUserOptionalParams

Devoluções

Promise<void>

replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)

Isto substitui totalmente todas as propriedades atualizáveis do Pool. Por exemplo, se o Pool tiver um StartTask associado e se o StartTask não for especificado com este pedido, então o serviço Batch removerá o StartTask existente.

function replacePoolProperties(poolId: string, pool: BatchPoolReplaceOptions, options?: ReplacePoolPropertiesOptionalParams): Promise<void>

Parâmetros

poolId

string

pool

BatchPoolReplaceOptions

options

ReplacePoolPropertiesOptionalParams

Devoluções

Promise<void>

replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)

Atualiza as propriedades da Tarefa especificada.

function replaceTask(jobId: string, taskId: string, task: BatchTask, options?: ReplaceTaskOptionalParams): Promise<void>

Parâmetros

jobId

string

taskId

string

task

BatchTask

options

ReplaceTaskOptionalParams

Devoluções

Promise<void>

resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)

Você só pode redimensionar um Pool quando seu estado de alocação estiver estável. Se o Pool já estiver redimensionando, a solicitação falhará com o código de status 409. Quando você redimensiona um Pool, o estado de alocação do Pool muda de estável para redimensionamento. Não é possível redimensionar pools configurados para dimensionamento automático. Se você tentar fazer isso, o serviço de lote retorna um erro 409. Se você redimensionar um pool para baixo, o serviço de lote escolhe quais nós de computação remover. Para remover nós de computação específicos, use a API de remoção de nós de computação do pool.

function resizePool(poolId: string, resizeOptions: BatchPoolResizeOptions, options?: ResizePoolOptionalParams): PollerLike<OperationState<void>, void>

Parâmetros

poolId

string

resizeOptions

BatchPoolResizeOptions

options

ResizePoolOptionalParams

Devoluções

PollerLike<OperationState<void>, void>

startNode(string, string, StartNodeOptionalParams)

Só podes iniciar um Nó de Computação se este tiver sido realocado.

function startNode(poolId: string, nodeId: string, options?: StartNodeOptionalParams): PollerLike<OperationState<void>, void>

Parâmetros

poolId

string

nodeId

string

options

StartNodeOptionalParams

Devoluções

PollerLike<OperationState<void>, void>

stopPoolResize(string, StopPoolResizeOptionalParams)

Isto não restaura o Pool ao seu estado anterior anterior à operação de redimensionamento: apenas impede que quaisquer alterações adicionais sejam feitas, e o Pool mantém o seu estado atual. Após a paragem, o Pool estabiliza no número de Nós de Computação em que estava quando a operação de paragem foi concluída. Durante a operação de paragem, o estado de alocação do Pool muda primeiro para paragem e depois para estabilização. Uma operação de redimensionamento não precisa de ser um pedido explícito de pool de redimensionamento; esta API também pode ser usada para travar o dimensionamento inicial do Pool quando este é criado.

function stopPoolResize(poolId: string, options?: StopPoolResizeOptionalParams): PollerLike<OperationState<void>, void>

Parâmetros

poolId

string

options

StopPoolResizeOptionalParams

Devoluções

PollerLike<OperationState<void>, void>

terminateJob(string, TerminateJobOptionalParams)

Quando é recebido um pedido de Terminar Trabalho, o serviço Batch define o Trabalho para o estado de terminação. O serviço Batch termina então quaisquer Tarefas em execução associadas ao Job e executa quaisquer Tarefas de Release de Job necessárias. Depois, o Trabalho passa para o estado concluído. Se houver Tarefas no Trabalho no estado ativo, elas permanecerão no estado ativo. Uma vez terminado um Trabalho, novas Tarefas não podem ser adicionadas e quaisquer Tarefas ativas restantes não serão agendadas.

function terminateJob(jobId: string, options?: TerminateJobOptionalParams): PollerLike<OperationState<void>, void>

Parâmetros

jobId

string

options

TerminateJobOptionalParams

Devoluções

PollerLike<OperationState<void>, void>

terminateJobSchedule(string, TerminateJobScheduleOptionalParams)

Encerra uma agenda de trabalho.

function terminateJobSchedule(jobScheduleId: string, options?: TerminateJobScheduleOptionalParams): PollerLike<OperationState<void>, void>

Parâmetros

jobScheduleId

string

options

TerminateJobScheduleOptionalParams

Devoluções

PollerLike<OperationState<void>, void>

terminateTask(string, string, TerminateTaskOptionalParams)

Quando a Tarefa for encerrada, ela será movida para o estado concluído. Para Tarefas de várias instâncias, a operação Encerrar Tarefa aplica-se de forma síncrona à tarefa principal; As subtarefas são então encerradas de forma assíncrona em segundo plano.

function terminateTask(jobId: string, taskId: string, options?: TerminateTaskOptionalParams): Promise<void>

Parâmetros

jobId

string

taskId

string

options

TerminateTaskOptionalParams

Devoluções

Promise<void>

updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)

Isto substitui apenas as propriedades do Job especificadas no pedido. Por exemplo, se o Job tiver restrições, e um pedido não especificar o elemento de restrição, então o Job mantém as restrições existentes.

function updateJob(jobId: string, job: BatchJobUpdateOptions, options?: UpdateJobOptionalParams): Promise<void>

Parâmetros

jobId

string

job

BatchJobUpdateOptions

options

UpdateJobOptionalParams

Devoluções

Promise<void>

updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)

Isto substitui apenas as propriedades do Horário de Trabalho especificadas no pedido. Por exemplo, se a propriedade de horários não for especificada com este pedido, então o serviço Batch manterá o horário existente. Alterações a um Horário de Tarefas afetam apenas os Trabalhos criados pelo calendário após a atualização ter ocorrido; Os empregos atualmente em execução não são afetados.

function updateJobSchedule(jobScheduleId: string, jobSchedule: BatchJobScheduleUpdateOptions, options?: UpdateJobScheduleOptionalParams): Promise<void>

Parâmetros

jobScheduleId

string

jobSchedule

BatchJobScheduleUpdateOptions

options

UpdateJobScheduleOptionalParams

Devoluções

Promise<void>

updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)

Isto apenas substitui as propriedades do Pool especificadas no pedido. Por exemplo, se o Pool tiver um StartTask associado e um pedido não especificar um elemento StartTask, então o Pool mantém o StartTask existente.

function updatePool(poolId: string, pool: BatchPoolUpdateOptions, options?: UpdatePoolOptionalParams): Promise<void>

Parâmetros

poolId

string

pool

BatchPoolUpdateOptions

options

UpdatePoolOptionalParams

Devoluções

Promise<void>

uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)

Isto serve para recolher ficheiros de registo do Azure Batch de forma automatizada a partir dos Compute Nodes caso esteja a experienciar um erro e pretenda escalar para o suporte Azure. Os ficheiros de registo do serviço Azure Batch devem ser partilhados com o suporte do Azure para ajudar na depuração de problemas com o serviço Batch.

function uploadNodeLogs(poolId: string, nodeId: string, uploadOptions: UploadBatchServiceLogsOptions, options?: UploadNodeLogsOptionalParams): Promise<UploadBatchServiceLogsResult>

Parâmetros

poolId

string

nodeId

string

uploadOptions

UploadBatchServiceLogsOptions

options

UploadNodeLogsOptionalParams

Devoluções

Promise<UploadBatchServiceLogsResult>