Compartilhar via

Remove-AzBatchJob

  • Referência
Módulo:
Az.Batch

Exclui um trabalho do Lote.

Sintaxe

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

Description

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

Exemplos

Exemplo 1: Excluir um trabalho do Lote

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

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

Exemplo 2: excluir um trabalho do Lote sem confirmação usando o pipeline

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

Esse comando obtém o trabalho que tem o Trabalho de ID-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 confirmação.

Exemplo 3: Executar loop em 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 removem todos os trabalhos de uma determinada conta do Lote do Azure. Como o comando inclui o parâmetro Force, ele não solicita confirmação.

Parâmetros

-BatchContext

Especifica a instância BatchAccountContext que esse cmdlet usa para interagir com o serviço do Lote. Se você usar o cmdlet Get-AzBatchAccount para obter o BatchAccountContext, a autenticação do Microsoft Entra será usada ao interagir com o serviço do Lote. 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
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Confirm

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

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga: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
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Force

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

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Id

Especifica a ID do trabalho que esse cmdlet exclui. Você não pode especificar caracteres curinga.

Tipo:String
Cargo:0
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

String

BatchAccountContext

Saídas

Void