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 löscht einen Azure Batch-Auftrag. 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 die ID Job-000002 mithilfe des Cmdlets "Get-AzBatchJob" aufweist. 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.

Type:BatchAccountContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Erzwingt die Ausführung des Befehls ohne Aufforderung zur Bestätigung durch den Benutzer.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

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

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Eingaben

String

BatchAccountContext

Ausgaben

Void