Delen via

Remove-AzBatchJob

  • Referentie
Module:
Az.Batch

Hiermee verwijdert u een Batch-taak.

Syntaxis

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

Description

Met de cmdlet Remove-AzBatchJob wordt een Azure Batch-taak verwijderd. Deze cmdlet vraagt u om bevestiging voordat een taak wordt verwijderd, tenzij u de parameter Force opgeeft.

Voorbeelden

Voorbeeld 1: Een Batch-taak verwijderen

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

Met deze opdracht verwijdert u de taak met de id-taak-000001. De opdracht vraagt u om bevestiging voordat de taak wordt verwijderd. Gebruik de cmdlet Get-AzBatchAccountKey om een context toe te wijzen aan de $Context variabele.

Voorbeeld 2: Een Batch-taak verwijderen zonder bevestiging met behulp van de pijplijn

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

Met deze opdracht wordt de taak met de id Job-000002 ophaalt met behulp van de Get-AzBatchJob-cmdlet. De opdracht geeft die taak door aan de huidige cmdlet met behulp van de pijplijnoperator. Met de opdracht wordt die taak verwijderd. Omdat de opdracht de parameter Force bevat, wordt u niet om bevestiging gevraagd.

Voorbeeld 3: Alle taken doorlopen en verwijderen

# 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
}

Met de bovenstaande opdrachten verwijdert u alle taken voor een bepaald Azure Batch-account. Omdat de opdracht de parameter Force bevat, wordt u niet om bevestiging gevraagd.

Parameters

-BatchContext

Hiermee geeft u het BatchAccountContext exemplaar dat door deze cmdlet wordt gebruikt om te communiceren met de Batch-service. Als u de cmdlet Get-AzBatchAccount gebruikt om uw BatchAccountContext op te halen, wordt Microsoft Entra-verificatie gebruikt bij interactie met de Batch-service. Als u in plaats daarvan verificatie met gedeelde sleutels wilt gebruiken, gebruikt u de cmdlet Get-AzBatchAccountKey om een BatchAccountContext-object op te halen waarin de bijbehorende toegangssleutels zijn ingevuld. Wanneer u verificatie met gedeelde sleutels gebruikt, wordt de primaire toegangssleutel standaard gebruikt. Als u de sleutel wilt wijzigen die u wilt gebruiken, stelt u de eigenschap BatchAccountContext.KeyInUse in.

Type:BatchAccountContext
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Confirm

U wordt gevraagd om bevestiging voordat u de cmdlet uitvoert.

Type:SwitchParameter
Aliassen:cf
Position:Named
Default value:False
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-DefaultProfile

De referenties, het account, de tenant en het abonnement die worden gebruikt voor communicatie met Azure.

Type:IAzureContextContainer
Aliassen:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Force

Hiermee dwingt u de opdracht uit te voeren zonder dat u om bevestiging van de gebruiker wordt gevraagd.

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Id

Hiermee geeft u de id op van de taak die door deze cmdlet wordt verwijderd. U kunt geen jokertekens opgeven.

Type:String
Position:0
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-WhatIf

Toont wat er zou gebeuren als de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.

Type:SwitchParameter
Aliassen:wi
Position:Named
Default value:False
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

Invoerwaarden

String

BatchAccountContext

Uitvoerwaarden

Void