Remove-AzBatchJob

  • Referência
Módulo:
Az.Batch

Exclui um trabalho em lote.

Sintaxe

Remove-AzBatchJob
      [-Id] <String>
      [-Force]
      -BatchContext <BatchAccountContext>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

O cmdlet Remove-AzBatchJob exclui um trabalho do Azure Batch. Este cmdlet solicita confirmação antes de remover um trabalho, a menos que você especifique o parâmetro Force .

Exemplos

Exemplo 1: Excluir um trabalho em lote

Remove-AzBatchJob -Id "Job-000001" -BatchContext $Context

Este comando exclui o trabalho que tem a ID Job-000001. O comando solicita a confirmação antes de excluir o trabalho. Use o cmdlet Get-AzBatchAccountKey para atribuir um contexto à variável $Context.

Exemplo 2: Excluir um trabalho em lote sem confirmação usando o pipeline

Get-AzBatchJob -Id "Job-000002" -BatchContext $Context | Remove-AzBatchJob -Force -BatchContext $Context

Este comando obtém o trabalho que tem a ID Job-000002 usando o cmdlet Get-AzBatchJob. O comando passa esse trabalho para o cmdlet atual usando o operador de pipeline. O comando exclui esse trabalho. Como o comando inclui o parâmetro Force , ele não solicita a confirmação.

Exemplo 3: Percorrer todos os trabalhos e excluir

# Get context
$accountname = "PUT YOUR AZURE BATCH ACCOUNT NAME HERE"
$batchcontext = Get-AzBatchAccount -AccountName $accountname

# Get jobs
$jobs = Get-AzBatchJob -BatchContext $batchcontext

# Loop through jobs
foreach ($element in $jobs) {
	Write-Host "Processing "$element.Id
	Remove-AzBatchJob -Id $element.Id -BatchContext $batchcontext -Force -Confirm:$false
}

Os comandos acima Remova todos os trabalhos de uma determinada conta do Lote do Azure. Como o comando inclui o parâmetro Force , ele não solicita a confirmação.

Parâmetros

-BatchContext

Especifica a instância BatchAccountContext que esse cmdlet usa para interagir com o serviço Batch. Se você usar o cmdlet Get-AzBatchAccount para obter seu BatchAccountContext, a autenticação do Microsoft Entra será usada ao interagir com o serviço Batch. Para usar a autenticação de chave compartilhada, use o cmdlet Get-AzBatchAccountKey para obter um objeto BatchAccountContext com suas chaves de acesso preenchidas. Ao usar a autenticação de chave compartilhada, a chave de acesso primária é usada por padrão. Para alterar a chave a ser usada, defina a propriedade BatchAccountContext.KeyInUse.

Tipo:BatchAccountContext
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Force

Força o comando a ser executado sem pedir a confirmação do usuário.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Id

Especifica a ID do trabalho que este cmdlet exclui. Não é possível especificar caracteres curinga.

Tipo:String
Position:0
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

String

BatchAccountContext

Saídas

Void