Freigeben über

Remove-AzBatchTask

  • Referenz
Modul:
Az.Batch

Löscht eine Batchaufgabe.

Syntax

Remove-AzBatchTask
      [-JobId] <String>
      [-Id] <String>
      [-Force]
      -BatchContext <BatchAccountContext>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzBatchTask
      [-InputObject] <PSCloudTask>
      [-Force]
      -BatchContext <BatchAccountContext>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Beschreibung

Das cmdlet Remove-AzBatchTask löscht eine Azure Batch-Aufgabe. Dieses Cmdlet fordert Sie zur Bestätigung auf, es sei denn, Sie geben den parameter Force an.

Beispiele

Beispiel 1: Löschen einer Batchaufgabe nach ID

Remove-AzBatchTask -JobId "Job-000001" -Id "Task23" -BatchContext $Context

Dieser Befehl löscht eine Aufgabe mit der ID Task23 unter dem Auftrag, der den ID-Auftrag 000001 aufweist. Die Eingabeaufforderung fordert Sie zur Bestätigung auf. Verwenden Sie das Cmdlet Get-AzBatchAccountKey, um der variablen $Context einen Kontext zuzuweisen.

Beispiel 2: Löschen einer Batchaufgabe mithilfe der Pipeline ohne Bestätigung

Get-AzBatchTask -JobId "Job-000001" -Id "Task26" -BatchContext $Context | Remove-AzBatchTask -Force -BatchContext $Context

Dieser Befehl ruft die Batchaufgabe ab, die die ID Task26 in dem Auftrag enthält, der den ID-Auftrag 000001 mit dem cmdlet Get-AzBatchTask hat. Der Befehl übergibt diese Aufgabe mithilfe des Pipelineoperators an das aktuelle Cmdlet. Der Befehl löscht diese Aufgabe. Dieser Befehl gibt den Parameter Force an. Daher werden Sie vom Befehl 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 der Aufgabe an, die dieses Cmdlet löscht. Sie können keine Wildcardzeichen angeben.

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

-InputObject

Gibt die Aufgabe an, die dieses Cmdlet löscht. Um ein PSCloudTask--Objekt abzurufen, verwenden Sie das cmdlet Get-AzBatchTask.

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

-JobId

Gibt die ID des Auftrags an, der die Aufgabe enthält.

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

PSCloudTask

BatchAccountContext

Ausgaben

Void