BatchClient class

Classe cliente para acessar o serviço Batch do Azure.

Construtores

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

Métodos

createJob(BatchJobCreateOptions, CreateJobOptionalParams)	O serviço em lote suporta duas formas de controlar o trabalho realizado como parte de um Trabalho. Na primeira abordagem, o usuário especifica uma Tarefa do Gerenciador de Trabalhos. O serviço em lote lança essa tarefa quando está pronta para iniciar o trabalho. A Tarefa do Gerenciador de Jobs controla todas as outras Tarefas que rodam sob esse Job, usando as APIs de Tarefa. Na segunda abordagem, o usuário controla diretamente a execução de Tarefas sob um Job ativo, usando as APIs de Tarefas. Também observe: ao nomear Jobs, evite incluir informações sensíveis como nomes de usuário ou nomes secretos de projetos. Essas informações podem aparecer em registros 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)	Você pode adicionar uma conta de usuário a um Nó de Computação apenas quando ele estiver em estado de inatividade ou em execução. Antes de poder fazer login remotamente em um Compute Node, você deve configurar portas de acesso para SSH e RDP. Para obter mais informações, veja https://learn.microsoft.com/azure/batch/pool-endpoint-configuration
createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)	Ao nomear Pools, evite incluir informações confidenciais, como nomes de usuário ou nomes de projeto secretos. Essas informações podem aparecer em registros de telemetria acessíveis aos engenheiros do Suporte da Microsoft.
createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)	A vida útil máxima de uma tarefa desde a adição até a conclusão é de 180 dias. Se uma Tarefa não for concluída dentro de 180 dias após sua adição, ela será encerrada pelo serviço em lote e deixada no estado em que estava naquele momento.
createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)	Note que cada Tarefa deve ter um ID único. O serviço Batch pode não retornar os resultados de cada Tarefa na mesma ordem em que as Tarefas foram enviadas nesta solicitação. Se o servidor expirar ou a conexão for fechada durante a solicitação, a solicitação pode ter sido parcial ou totalmente processada, ou nem ter sido processada. Nesses casos, o usuário deve reemitir o pedido. Note que cabe ao usuário lidar corretamente com falhas ao reemitir uma solicitação. Por exemplo, você 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 extras inesperadamente. Se a resposta contiver alguma Tarefa que não foi adicionada, o cliente pode tentar a solicitação novamente. Em uma tentativa novamente, é mais eficiente reenviar apenas as Tarefas que não foram adicionadas e omitir as Tarefas que foram adicionadas com sucesso na primeira tentativa. A vida útil máxima de uma tarefa desde a adição até a conclusão é de 180 dias. Se uma Tarefa não for concluída dentro de 180 dias após sua adição, ela será encerrada pelo serviço em lote e deixada no estado em que estava naquele momento.
deallocateNode(string, string, DeallocateNodeOptionalParams)	Você só poderá desalocar um Nó de Computação se ele estiver em um estado ocioso ou em execução.
deleteJob(string, DeleteJobOptionalParams)	Deletar um Trabalho também exclui todas as Tarefas que fazem parte desse Trabalho, e todas as estatísticas do Trabalho. Isso também sobrepõe o período de retenção dos dados da tarefa; ou seja, se o Job contém Tarefas que ainda são mantidas nos Nós de Computação, os serviços Batch excluem os diretórios de trabalho dessas Tarefas e todo o seu conteúdo. Quando uma solicitação de Delete Job é recebida, o serviço Batch define o Job para o estado de exclusão. Todas as operações de atualização em um Trabalho que está em estado de exclusão falharão com o código de status 409 (Conflito), com informações adicionais indicando que o Trabalho está sendo excluído.
deleteJobSchedule(string, DeleteJobScheduleOptionalParams)	Quando você exclui um Agendamento de Trabalho, isso também exclui todos os Trabalhos e Tarefas nesse agendamento. Quando 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 de Agendamento de Trabalho não estarão mais acessíveis depois que a Agenda de Trabalho é excluída, embora ainda sejam contadas para 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 ela estiver no estado ocioso ou em execução. Antes de poder fazer login remotamente em um Compute Node, você deve configurar portas de acesso para SSH e RDP. Para obter mais informações, veja 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 está definido como exclusão; qualquer operação de redimensionamento em andamento no Pool é interrompida; o serviço do Lote começa a redimensionar o pool para zero Nós de Computação; as tarefas em execução em nós de computação existentes são encerradas e requeadas (como se uma operação de pool de redimensionamento tivesse sido solicitada com a opção de requeue padrão); por fim, o Pool é removido do sistema. Como as tarefas em execução são requeuídas, o usuário pode executar novamente essas Tarefas atualizando seu trabalho para direcionar um pool diferente. Em seguida, as Tarefas podem ser executadas no novo Pool. Se você quiser substituir o comportamento de substituição, chame o pool de redimensionamento explicitamente para reduzir o pool para tamanho zero antes de excluir o Pool. 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 em que ele foi executado 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 primária; 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 em que a Tarefa foi executada.
disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)	O Serviço de Lote imediatamente move o Trabalho para o estado de desativação. O Batch então usa o parâmetro disableTasks para determinar o que fazer com as Tasks do Job que estão em execução. O Job permanece no estado de desativação até que a operação de desabilitação seja concluída e todas as Tarefas sejam tratadas de acordo com a opção disableTasks; o Job então passa para o estado de deficiência. Nenhuma nova Tarefa é iniciada sob o Trabalho até que ele volte ao estado ativo. Se você tentar desabilitar um Job que esteja em qualquer estado que não ativo, desativado ou desativado, a solicitação falha com o código de status 409.
disableJobSchedule(string, DisableJobScheduleOptionalParams)	Nenhum novo Trabalho será criado até que o Agendamento de Trabalhos seja habilitado novamente.
disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)	Você pode desativar o Escalonamento de Tarefas em um Nó de Computação somente se seu estado atual de agendamento estiver ativado.
disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)	Desabilita o dimensionamento automático para um pool.
enableJob(string, EnableJobOptionalParams)	Quando você chama essa API, o serviço Batch define um Job desativado para o estado habilitador. Após a conclusão dessa operação, o Trabalho passa para o estado ativo, e o agendamento de novas Tarefas no Trabalho recomeça. O serviço Batch não permite que uma Tarefa permaneça ativa por mais de 180 dias. Portanto, se você 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 um agendamento de trabalho.
enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)	Você pode ativar o Escalonamento de Tarefas em um Nó de Computação somente se seu estado atual de agendamento estiver desativado
enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)	Você não poderá 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. Você não pode chamar essa API para o mesmo pool mais de uma vez a cada 30 segundos.
evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)	Essa API destina-se principalmente à validação de uma fórmula de dimensionamento automático, pois ela simplesmente retorna 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)	Essa operação retorna apenas Aplicações e versões disponíveis para uso em Nós de Computação; ou seja, que pode ser usado em uma referência de Pacote. Para informações de administrador sobre Aplicações e versões que ainda não estão disponíveis para Compute Nodes, use 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 cronograma de trabalho especificado.
getJobTaskCounts(string, GetJobTaskCountsOptionalParams)	As contagens de tarefas fornecem uma contagem das Tarefas ativas, executando ou concluindo o estado da tarefa e uma contagem de Tarefas que tiveram êxito ou falharam. 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 você 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)	Retorna o conteúdo do arquivo de Nó de Computação 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 fazer login remotamente em um Nó de Computação usando as configurações de login remoto, você deve criar uma conta de usuário no Nó de Computação e configurar portas de acesso para SSH e RDP. Para obter mais informações, veja 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 de lista para recuperar informações sobre subtarefas.
getTaskFile(string, string, string, GetTaskFileOptionalParams)	Retorna o conteúdo do arquivo Tarefa especificado.
getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)	Obtém as propriedades do arquivo de tarefa especificado.
jobScheduleExists(string, JobScheduleExistsOptionalParams)	Verifica a existência do Cronograma de Trabalho especificado.
listApplications(ListApplicationsOptionalParams)	Essa operação retorna apenas Aplicações e versões disponíveis para uso em Nós de Computação; ou seja, que pode ser usado em uma 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, use o portal Azure ou a API Azure Resource Manager.
listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)	Essa API retorna o status da Tarefa preparação do trabalho e da liberação de trabalho em todos os nós de computação que executaram a tarefa Preparação do Trabalho ou Liberação de Trabalho. Isso inclui nós de computação que foram removidos do pool desde então. Se essa API for invocada em um trabalho que não tem tarefa de preparação de trabalho ou de liberação de trabalho, o serviço do 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 Trabalhos que foram criados sob o Cronograma 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 tarefa 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 você precisar de contagens exatas de nó, 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 uma 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 padrão para os horários de início e término do último intervalo de agregação atualmente disponível; ou seja, somente 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 compatíveis com o serviço Lote do Azure.
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 de lista para recuperar 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 repetidamente até sua contagem máxima de repetição. 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 repetição é redefinida para 0. A reativação falhará para tarefas que não foram concluídas ou que foram concluídas 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 encerrando ou excluindo).
rebootNode(string, string, RebootNodeOptionalParams)	Você só poderá reiniciar um Nó de Computação 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. Essa API só pode ser invocada em Pools criados com a propriedade de configuração do serviço em nuvem.
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)	Isso substitui totalmente todas as propriedades atualizáveis do Job. Por exemplo, se o Job tiver restrições associadas a ele e se as restrições não forem especificadas com essa solicitação, então o serviço Batch removerá as restrições existentes.
replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)	Isso substitui totalmente todas as propriedades atualizáveis do Cronograma de Trabalhos. Por exemplo, se a propriedade de cronograma não for especificada com essa solicitação, então o serviço de lote removerá o cronograma existente. Mudanças em um cronograma de tarefas afetam apenas as vagas criadas pelo cronograma após a atualização ter ocorrido; Os empregos atualmente em execução não são afetados.
replaceNodeUser(string, string, string, BatchNodeUserUpdateOptions, ReplaceNodeUserOptionalParams)	Essa 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 padrão, não deixado sem modificação. Você pode atualizar uma conta de usuário em um Nó de Computação apenas quando ele estiver em estado ocioso ou em execução.
replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)	Isso substitui totalmente todas as propriedades atualizáveis da Piscina. Por exemplo, se o Pool tiver um StartTask associado e se StartTask não for especificado com essa solicitação, 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 do Lote retornará um erro 409. Se você redimensionar um Pool para baixo, o serviço lote escolherá quais nós de computação remover. Para remover nós de computação específicos, use a API Remover Nós de Computação do Pool.
startNode(string, string, StartNodeOptionalParams)	Você só pode iniciar um Compute Node se ele tiver sido realocado.
stopPoolResize(string, StopPoolResizeOptionalParams)	Isso não restaura o Pool ao seu estado anterior antes da operação de redimensionamento: apenas impede que quaisquer alterações adicionais sejam feitas, e o Pool mantém seu estado atual. Após a parada, o Pool se estabiliza no número de Nós de Computação em que estava quando a operação de parada foi concluída. Durante a operação de parada, o estado de alocação do pool muda primeiro para parada e depois para estabilização. Uma operação de redimensionamento não precisa ser uma solicitação explícita de redimensionamento do Pool; essa API também pode ser usada para interromper o dimensionamento inicial do Pool quando ele é criado.
terminateJob(string, TerminateJobOptionalParams)	Quando uma solicitação de Terminar Trabalho é recebida, o serviço Batch define o Trabalho para o estado de término. O serviço Batch então encerra quaisquer Tarefas em execução associadas ao Trabalho e executa quaisquer Tarefas de liberação de Tarefas necessárias. Então o Trabalho entra no estado completo. Se houver Tarefas no Trabalho no estado ativo, elas permanecerão no estado ativo. Uma vez que um Trabalho é encerrado, novas Tarefas não podem ser adicionadas e quaisquer Tarefas ativas restantes não serão agendadas.
terminateJobSchedule(string, TerminateJobScheduleOptionalParams)	Encerra um agendamento de trabalho.
terminateTask(string, string, TerminateTaskOptionalParams)	Quando a Tarefa foi encerrada, ela passa para o estado concluído. Para tarefas de várias instâncias, a operação encerrar Tarefa se aplica de forma síncrona à tarefa primária; As subtarefas são então encerradas de forma assíncrona em segundo plano.
updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)	Isso substitui apenas as propriedades do Job especificadas na solicitação. Por exemplo, se o Job tem restrições e uma requisição não especifica o elemento de restrição, então o Job mantém as restrições existentes.
updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)	Isso substitui apenas as propriedades do Horário de Trabalho especificadas no pedido. Por exemplo, se a propriedade de cronograma não for especificada com essa solicitação, então o serviço de lote manterá o cronograma existente. Mudanças em um cronograma de tarefas afetam apenas as vagas criadas pelo cronograma após a atualização ter ocorrido; Os empregos atualmente em execução não são afetados.
updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)	Isso apenas substitui as propriedades do Pool especificadas na solicitação. Por exemplo, se o Pool tiver um StartTask associado a ele, e uma solicitação não especificar um elemento StartTask, então o Pool mantém o StartTask existente.
uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)	Isso é para coletar arquivos de log de serviço Batch do Azure de forma automatizada a partir dos Compute Nodes, caso você esteja enfrentando um erro e deseje escalar para o suporte do Azure. Os arquivos de log de serviço Lote do Azure devem ser compartilhados com Suporte do Azure para ajudar na depuração de problemas com o serviço do Lote.

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

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

Parâmetros

endpointParam: string

credential: TokenCredential | AzureNamedKeyCredential

options: BatchClientOptionalParams

createJob(BatchJobCreateOptions, CreateJobOptionalParams)

O serviço em lote suporta duas formas de controlar o trabalho realizado como parte de um Trabalho. Na primeira abordagem, o usuário especifica uma Tarefa do Gerenciador de Trabalhos. O serviço em lote lança essa tarefa quando está pronta para iniciar o trabalho. A Tarefa do Gerenciador de Jobs controla todas as outras Tarefas que rodam sob esse Job, usando as APIs de Tarefa. Na segunda abordagem, o usuário controla diretamente a execução de Tarefas sob um Job ativo, usando as APIs de Tarefas. Também observe: ao nomear Jobs, evite incluir informações sensíveis como nomes de usuário ou nomes secretos de projetos. Essas informações podem aparecer em registros de telemetria acessíveis aos engenheiros do Suporte da Microsoft.

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

Parâmetros

job: BatchJobCreateOptions

options: CreateJobOptionalParams

Retornos

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

Retornos

Promise<void>

createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)

Você pode adicionar uma conta de usuário a um Nó de Computação apenas quando ele estiver em estado de inatividade ou em execução. Antes de poder fazer login remotamente em um Compute Node, você deve configurar portas de acesso para SSH e RDP. Para obter mais informações, veja 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

Retornos

Promise<void>

createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)

Ao nomear Pools, evite incluir informações confidenciais, como nomes de usuário ou nomes de projeto secretos. Essas informações podem aparecer em registros de telemetria acessíveis aos engenheiros do Suporte da Microsoft.

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

Parâmetros

pool: BatchPoolCreateOptions

options: CreatePoolOptionalParams

Retornos

Promise<void>

createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)

A vida útil máxima de uma tarefa desde a adição até a conclusão é de 180 dias. Se uma Tarefa não for concluída dentro de 180 dias após sua adição, ela será encerrada pelo serviço em lote e deixada no estado em que estava naquele momento.

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

Parâmetros

jobId: string

task: BatchTaskCreateOptions

options: CreateTaskOptionalParams

Retornos

Promise<void>

createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)

Note que cada Tarefa deve ter um ID único. O serviço Batch pode não retornar os resultados de cada Tarefa na mesma ordem em que as Tarefas foram enviadas nesta solicitação. Se o servidor expirar ou a conexão for fechada durante a solicitação, a solicitação pode ter sido parcial ou totalmente processada, ou nem ter sido processada. Nesses casos, o usuário deve reemitir o pedido. Note que cabe ao usuário lidar corretamente com falhas ao reemitir uma solicitação. Por exemplo, você 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 extras inesperadamente. Se a resposta contiver alguma Tarefa que não foi adicionada, o cliente pode tentar a solicitação novamente. Em uma tentativa novamente, é mais eficiente reenviar apenas as Tarefas que não foram adicionadas e omitir as Tarefas que foram adicionadas com sucesso na primeira tentativa. A vida útil máxima de uma tarefa desde a adição até a conclusão é de 180 dias. Se uma Tarefa não for concluída dentro de 180 dias após sua adição, ela será encerrada pelo serviço em lote e deixada no estado em que estava naquele momento.

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

Parâmetros

jobId: string

taskCollection: BatchTaskGroup

options: CreateTaskCollectionOptionalParams

Retornos

Promise<BatchCreateTaskCollectionResult>

deallocateNode(string, string, DeallocateNodeOptionalParams)

Você só poderá desalocar um Nó de Computação 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

Retornos

PollerLike<OperationState<void>, void>

deleteJob(string, DeleteJobOptionalParams)

Deletar um Trabalho também exclui todas as Tarefas que fazem parte desse Trabalho, e todas as estatísticas do Trabalho. Isso também sobrepõe o período de retenção dos dados da tarefa; ou seja, se o Job contém Tarefas que ainda são mantidas nos Nós de Computação, os serviços Batch excluem os diretórios de trabalho dessas Tarefas e todo o seu conteúdo. Quando uma solicitação de Delete Job é recebida, o serviço Batch define o Job para o estado de exclusão. Todas as operações de atualização em um Trabalho que está em estado de exclusão falharão com o código de status 409 (Conflito), com informações adicionais indicando que o Trabalho está sendo excluído.

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

Parâmetros

jobId: string

options: DeleteJobOptionalParams

Retornos

PollerLike<OperationState<void>, void>

deleteJobSchedule(string, DeleteJobScheduleOptionalParams)

Quando você exclui um Agendamento de Trabalho, isso também exclui todos os Trabalhos e Tarefas nesse agendamento. Quando 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 de Agendamento de Trabalho não estarão mais acessíveis depois que a Agenda de Trabalho é excluída, embora ainda sejam contadas para estatísticas de tempo de vida da conta.

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

Parâmetros

jobScheduleId: string

options: DeleteJobScheduleOptionalParams

Retornos

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

Retornos

Promise<void>

deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)

Você pode excluir uma conta de usuário para um Nó de Computação somente quando ela estiver no estado ocioso ou em execução. Antes de poder fazer login remotamente em um Compute Node, você deve configurar portas de acesso para SSH e RDP. Para obter mais informações, veja 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

Retornos

Promise<void>

deletePool(string, DeletePoolOptionalParams)

Quando você solicita que um Pool seja excluído, as seguintes ações ocorrem: o estado do pool está definido como exclusão; qualquer operação de redimensionamento em andamento no Pool é interrompida; o serviço do Lote começa a redimensionar o pool para zero Nós de Computação; as tarefas em execução em nós de computação existentes são encerradas e requeadas (como se uma operação de pool de redimensionamento tivesse sido solicitada com a opção de requeue padrão); por fim, o Pool é removido do sistema. Como as tarefas em execução são requeuídas, o usuário pode executar novamente essas Tarefas atualizando seu trabalho para direcionar um pool diferente. Em seguida, as Tarefas podem ser executadas no novo Pool. Se você quiser substituir o comportamento de substituição, chame o pool de redimensionamento explicitamente para reduzir o pool para tamanho zero antes de excluir o Pool. 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

Retornos

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 em que ele foi executado 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 primária; 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

Retornos

Promise<void>

deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)

Exclui o arquivo de tarefa especificado do Nó de Computação em que 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

Retornos

Promise<void>

disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)

O Serviço de Lote imediatamente move o Trabalho para o estado de desativação. O Batch então usa o parâmetro disableTasks para determinar o que fazer com as Tasks do Job que estão em execução. O Job permanece no estado de desativação até que a operação de desabilitação seja concluída e todas as Tarefas sejam tratadas de acordo com a opção disableTasks; o Job então passa para o estado de deficiência. Nenhuma nova Tarefa é iniciada sob o Trabalho até que ele volte ao estado ativo. Se você tentar desabilitar um Job que esteja em qualquer estado que não ativo, desativado ou desativado, a solicitação falha com o código de status 409.

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

Parâmetros

jobId: string

disableOptions: BatchJobDisableOptions

options: DisableJobOptionalParams

Retornos

PollerLike<OperationState<void>, void>

disableJobSchedule(string, DisableJobScheduleOptionalParams)

Nenhum novo Trabalho será criado até que o Agendamento de Trabalhos seja habilitado novamente.

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

Parâmetros

jobScheduleId: string

options: DisableJobScheduleOptionalParams

Retornos

Promise<void>

disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)

Você pode desativar o Escalonamento de Tarefas em um Nó de Computação somente se 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

Retornos

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

Retornos

Promise<void>

enableJob(string, EnableJobOptionalParams)

Quando você chama essa API, o serviço Batch define um Job desativado para o estado habilitador. Após a conclusão dessa operação, o Trabalho passa para o estado ativo, e o agendamento de novas Tarefas no Trabalho recomeça. O serviço Batch não permite que uma Tarefa permaneça ativa por mais de 180 dias. Portanto, se você 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

Retornos

PollerLike<OperationState<void>, void>

enableJobSchedule(string, EnableJobScheduleOptionalParams)

Habilita um agendamento de trabalho.

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

Parâmetros

jobScheduleId: string

options: EnableJobScheduleOptionalParams

Retornos

Promise<void>

enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)

Você pode ativar o Escalonamento de Tarefas em um Nó de Computação somente se 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

Retornos

Promise<void>

enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)

Você não poderá 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. Você não pode 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

Retornos

Promise<void>

evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)

Essa API destina-se principalmente à validação de uma fórmula de dimensionamento automático, pois ela simplesmente retorna 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

Retornos

Promise<AutoScaleRun>

getApplication(string, GetApplicationOptionalParams)

Essa operação retorna apenas Aplicações e versões disponíveis para uso em Nós de Computação; ou seja, que pode ser usado em uma referência de Pacote. Para informações de administrador sobre Aplicações e versões que ainda não estão disponíveis para Compute Nodes, use o portal Azure ou a API Azure Resource Manager.

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

Parâmetros

applicationId: string

options: GetApplicationOptionalParams

Retornos

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

Retornos

Promise<BatchJob>

getJobSchedule(string, GetJobScheduleOptionalParams)

Obtém informações sobre o cronograma de trabalho especificado.

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

Parâmetros

jobScheduleId: string

options: GetJobScheduleOptionalParams

Retornos

Promise<BatchJobSchedule>

getJobTaskCounts(string, GetJobTaskCountsOptionalParams)

As contagens de tarefas fornecem uma contagem das Tarefas ativas, executando ou concluindo o estado da tarefa e uma contagem de Tarefas que tiveram êxito ou falharam. 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 você 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

Retornos

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

Retornos

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

Retornos

Promise<BatchNodeVMExtension>

getNodeFile(string, string, string, GetNodeFileOptionalParams)

Retorna o conteúdo do arquivo de Nó de Computação especificado.

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

Parâmetros

poolId: string

nodeId: string

filePath: string

options: GetNodeFileOptionalParams

Retornos

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

Retornos

Promise<BatchNodeFile>

getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)

Antes de poder fazer login remotamente em um Nó de Computação usando as configurações de login remoto, você deve criar uma conta de usuário no Nó de Computação e configurar portas de acesso para SSH e RDP. Para obter mais informações, veja 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

Retornos

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

Retornos

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 de lista para recuperar informações sobre subtarefas.

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

Parâmetros

jobId: string

taskId: string

options: GetTaskOptionalParams

Retornos

Promise<BatchTask>

getTaskFile(string, string, string, GetTaskFileOptionalParams)

Retorna o conteúdo do arquivo Tarefa especificado.

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

Parâmetros

jobId: string

taskId: string

filePath: string

options: GetTaskFileOptionalParams

Retornos

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

Retornos

Promise<BatchNodeFile>

jobScheduleExists(string, JobScheduleExistsOptionalParams)

Verifica a existência do Cronograma de Trabalho especificado.

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

Parâmetros

jobScheduleId: string

options: JobScheduleExistsOptionalParams

Retornos

Promise<boolean>

listApplications(ListApplicationsOptionalParams)

Essa operação retorna apenas Aplicações e versões disponíveis para uso em Nós de Computação; ou seja, que pode ser usado em uma 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, use o portal Azure ou a API Azure Resource Manager.

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

Parâmetros

options: ListApplicationsOptionalParams

Retornos

PagedAsyncIterableIterator<BatchApplication, BatchApplication[], PageSettings>

listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)

Essa API retorna o status da Tarefa preparação do trabalho e da liberação de trabalho em todos os nós de computação que executaram a tarefa Preparação do Trabalho ou Liberação de Trabalho. Isso inclui nós de computação que foram removidos do pool desde então. Se essa API for invocada em um trabalho que não tem tarefa de preparação de trabalho ou de liberação de trabalho, o serviço do 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

Retornos

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

Retornos

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

Retornos

PagedAsyncIterableIterator<BatchJobSchedule, BatchJobSchedule[], PageSettings>

listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)

Lista os Trabalhos que foram criados sob o Cronograma de Tarefas especificado.

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

Parâmetros

jobScheduleId: string

options: ListJobsFromScheduleOptionalParams

Retornos

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

Retornos

PagedAsyncIterableIterator<BatchNodeVMExtension, BatchNodeVMExtension[], PageSettings>

listNodeFiles(string, string, ListNodeFilesOptionalParams)

Lista todos os arquivos em diretórios de tarefa 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

Retornos

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

Retornos

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 você precisar de contagens exatas de nó, use uma consulta de lista.

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

Parâmetros

options: ListPoolNodeCountsOptionalParams

Retornos

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

Retornos

PagedAsyncIterableIterator<BatchPool, BatchPool[], PageSettings>

listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)

Se você não especificar uma cláusula $filter incluindo uma 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 padrão para os horários de início e término do último intervalo de agregação atualmente disponível; ou seja, somente o último intervalo de agregação é retornado.

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

Parâmetros

options: ListPoolUsageMetricsOptionalParams

Retornos

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

Retornos

PagedAsyncIterableIterator<BatchSubtask, BatchSubtask[], PageSettings>

listSupportedImages(ListSupportedImagesOptionalParams)

Lista todas as imagens de máquina virtual compatíveis com o serviço Lote do Azure.

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

Parâmetros

options: ListSupportedImagesOptionalParams

Retornos

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

Retornos

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 de lista para recuperar informações sobre subtarefas.

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

Parâmetros

jobId: string

options: ListTasksOptionalParams

Retornos

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

Retornos

Promise<boolean>

reactivateTask(string, string, ReactivateTaskOptionalParams)

A reativação torna uma tarefa elegível para ser repetidamente até sua contagem máxima de repetição. 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 repetição é redefinida para 0. A reativação falhará para tarefas que não foram concluídas ou que foram concluídas 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 encerrando ou excluindo).

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

Parâmetros

jobId: string

taskId: string

options: ReactivateTaskOptionalParams

Retornos

Promise<void>

rebootNode(string, string, RebootNodeOptionalParams)

Você só poderá reiniciar um Nó de Computação 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

Retornos

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. Essa API só pode ser invocada em Pools criados com a propriedade de configuração do serviço em nuvem.

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

Parâmetros

poolId: string

nodeId: string

options: ReimageNodeOptionalParams

Retornos

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

Retornos

PollerLike<OperationState<void>, void>

replaceJob(string, BatchJob, ReplaceJobOptionalParams)

Isso substitui totalmente todas as propriedades atualizáveis do Job. Por exemplo, se o Job tiver restrições associadas a ele e se as restrições não forem especificadas com essa solicitação, 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

Retornos

Promise<void>

replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)

Isso substitui totalmente todas as propriedades atualizáveis do Cronograma de Trabalhos. Por exemplo, se a propriedade de cronograma não for especificada com essa solicitação, então o serviço de lote removerá o cronograma existente. Mudanças em um cronograma de tarefas afetam apenas as vagas criadas pelo cronograma 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

Retornos

Promise<void>

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

Essa 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 padrão, não deixado sem modificação. Você pode atualizar uma conta de usuário em um Nó de Computação apenas quando ele estiver em estado ocioso ou em execução.

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

Retornos

Promise<void>

replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)

Isso substitui totalmente todas as propriedades atualizáveis da Piscina. Por exemplo, se o Pool tiver um StartTask associado e se StartTask não for especificado com essa solicitação, 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

Retornos

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

Retornos

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 do Lote retornará um erro 409. Se você redimensionar um Pool para baixo, o serviço lote escolherá quais nós de computação remover. Para remover nós de computação específicos, use a API Remover 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

Retornos

PollerLike<OperationState<void>, void>

startNode(string, string, StartNodeOptionalParams)

Você só pode iniciar um Compute Node se ele tiver sido realocado.

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

Parâmetros

poolId: string

nodeId: string

options: StartNodeOptionalParams

Retornos

PollerLike<OperationState<void>, void>

stopPoolResize(string, StopPoolResizeOptionalParams)

Isso não restaura o Pool ao seu estado anterior antes da operação de redimensionamento: apenas impede que quaisquer alterações adicionais sejam feitas, e o Pool mantém seu estado atual. Após a parada, o Pool se estabiliza no número de Nós de Computação em que estava quando a operação de parada foi concluída. Durante a operação de parada, o estado de alocação do pool muda primeiro para parada e depois para estabilização. Uma operação de redimensionamento não precisa ser uma solicitação explícita de redimensionamento do Pool; essa API também pode ser usada para interromper o dimensionamento inicial do Pool quando ele é criado.

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

Parâmetros

poolId: string

options: StopPoolResizeOptionalParams

Retornos

PollerLike<OperationState<void>, void>

terminateJob(string, TerminateJobOptionalParams)

Quando uma solicitação de Terminar Trabalho é recebida, o serviço Batch define o Trabalho para o estado de término. O serviço Batch então encerra quaisquer Tarefas em execução associadas ao Trabalho e executa quaisquer Tarefas de liberação de Tarefas necessárias. Então o Trabalho entra no estado completo. Se houver Tarefas no Trabalho no estado ativo, elas permanecerão no estado ativo. Uma vez que um Trabalho é encerrado, 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

Retornos

PollerLike<OperationState<void>, void>

terminateJobSchedule(string, TerminateJobScheduleOptionalParams)

Encerra um agendamento de trabalho.

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

Parâmetros

jobScheduleId: string

options: TerminateJobScheduleOptionalParams

Retornos

PollerLike<OperationState<void>, void>

terminateTask(string, string, TerminateTaskOptionalParams)

Quando a Tarefa foi encerrada, ela passa para o estado concluído. Para tarefas de várias instâncias, a operação encerrar Tarefa se aplica de forma síncrona à tarefa primária; 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

Retornos

Promise<void>

updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)

Isso substitui apenas as propriedades do Job especificadas na solicitação. Por exemplo, se o Job tem restrições e uma requisição não especifica 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

Retornos

Promise<void>

updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)

Isso substitui apenas as propriedades do Horário de Trabalho especificadas no pedido. Por exemplo, se a propriedade de cronograma não for especificada com essa solicitação, então o serviço de lote manterá o cronograma existente. Mudanças em um cronograma de tarefas afetam apenas as vagas criadas pelo cronograma 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

Retornos

Promise<void>

updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)

Isso apenas substitui as propriedades do Pool especificadas na solicitação. Por exemplo, se o Pool tiver um StartTask associado a ele, e uma solicitação 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

Retornos

Promise<void>

uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)

Isso é para coletar arquivos de log de serviço Batch do Azure de forma automatizada a partir dos Compute Nodes, caso você esteja enfrentando um erro e deseje escalar para o suporte do Azure. Os arquivos de log de serviço Lote do Azure devem ser compartilhados com Suporte do Azure para ajudar na depuração de problemas com o serviço do Lote.

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

Parâmetros

poolId: string

nodeId: string

uploadOptions: UploadBatchServiceLogsOptions

options: UploadNodeLogsOptionalParams

Retornos

Promise<UploadBatchServiceLogsResult>

BatchClient class

Construtores

Métodos

Detalhes do construtor

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

Parâmetros

Detalhes do método

createJob(BatchJobCreateOptions, CreateJobOptionalParams)

Parâmetros

Retornos

createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)

Parâmetros

Retornos

createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)

Parâmetros

Retornos

createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)

Parâmetros

Retornos

createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)

Parâmetros

Retornos

createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)

Parâmetros

Retornos

deallocateNode(string, string, DeallocateNodeOptionalParams)

Parâmetros

Retornos

deleteJob(string, DeleteJobOptionalParams)

Parâmetros

Retornos

deleteJobSchedule(string, DeleteJobScheduleOptionalParams)

Parâmetros

Retornos

deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)

Parâmetros

Retornos

deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)

Parâmetros

Retornos

deletePool(string, DeletePoolOptionalParams)

Parâmetros

Retornos

deleteTask(string, string, DeleteTaskOptionalParams)

Parâmetros

Retornos

deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)

Parâmetros

Retornos

disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)

Parâmetros

Retornos

disableJobSchedule(string, DisableJobScheduleOptionalParams)

Parâmetros

Retornos

disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)

Parâmetros

Retornos

disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)

Parâmetros

Retornos

enableJob(string, EnableJobOptionalParams)

Parâmetros

Retornos

enableJobSchedule(string, EnableJobScheduleOptionalParams)

Parâmetros

Retornos

enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)

Parâmetros

Retornos

enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)

Parâmetros

Retornos

evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)

Parâmetros

Retornos

getApplication(string, GetApplicationOptionalParams)

Parâmetros

Retornos

getJob(string, GetJobOptionalParams)