Freigeben über

Remove-AzBatchJob

  • Referenz
Modul:
Az.Batch

Löscht einen Batchauftrag.

Syntax

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

Beschreibung

Das Cmdlet Remove-AzBatchJob einen Azure Batch-Auftrag löscht. Dieses Cmdlet fordert Sie zur Bestätigung auf, bevor ein Auftrag entfernt wird, es sei denn, Sie geben den Parameter Force an.

Beispiele

Beispiel 1: Löschen eines Batchauftrags

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

Mit diesem Befehl wird der Auftrag gelöscht, der über den ID-Auftrag 000001 verfügt. Die Eingabeaufforderung fordert Sie zur Bestätigung auf, bevor sie den Auftrag löscht. Verwenden Sie das Cmdlet Get-AzBatchAccountKey, um der variablen $Context einen Kontext zuzuweisen.

Beispiel 2: Löschen eines Batchauftrags ohne Bestätigung mithilfe der Pipeline

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

Dieser Befehl ruft den Auftrag ab, der über den ID-Auftrag 000002 verfügt, indem das cmdlet Get-AzBatchJob verwendet wird. Der Befehl übergibt diesen Auftrag mithilfe des Pipelineoperators an das aktuelle Cmdlet. Der Befehl löscht diesen Auftrag. Da der Befehl den Parameter Force enthält, werden Sie nicht zur Bestätigung aufgefordert.

Beispiel 3: Durchlaufen aller Aufträge und Löschen

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

Mit den Befehlen oben werden alle Aufträge für ein bestimmtes Azure Batch-Konto entfernt. Da der Befehl den Parameter Force enthält, werden Sie nicht zur Bestätigung aufgefordert.

Parameter

-BatchContext

Gibt die BatchAccountContext- Instanz an, die dieses Cmdlet für die Interaktion mit dem Batchdienst verwendet. Wenn Sie das Cmdlet Get-AzBatchAccount verwenden, um Ihren BatchAccountContext abzurufen, wird die Microsoft Entra-Authentifizierung bei der Interaktion mit dem Batchdienst verwendet. Verwenden Sie zum Verwenden der gemeinsamen Schlüsselauthentifizierung stattdessen das cmdlet Get-AzBatchAccountKey, um ein BatchAccountContext-Objekt mit den aufgefüllten Zugriffstasten abzurufen. Bei Verwendung der Authentifizierung mit gemeinsam genutzten Schlüsseln wird standardmäßig der primäre Zugriffsschlüssel verwendet. Um den zu verwendenden Schlüssel zu ändern, legen Sie die BatchAccountContext.KeyInUse-Eigenschaft fest.

Typ:BatchAccountContext
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Confirm

Fordert Sie vor dem Ausführen des Cmdlets zur Bestätigung auf.

Typ:SwitchParameter
Aliase:cf
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-DefaultProfile

Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.

Typ:IAzureContextContainer
Aliase:AzContext, AzureRmContext, AzureCredential
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Force

Erzwingt die Ausführung des Befehls, ohne eine Benutzerbestätigung zu verlangen.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Id

Gibt die ID des Auftrags an, den dieses Cmdlet löscht. Sie können keine Wildcardzeichen angeben.

Typ:String
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-WhatIf

Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Typ:SwitchParameter
Aliase:wi
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

String

BatchAccountContext

Ausgaben

Void