Freigeben über

Stop-AzBatchJob

  • Referenz
Modul:
Az.Batch

Stoppt einen Batchauftrag.

Syntax

Stop-AzBatchJob
    [-Id] <String>
    [[-TerminateReason] <String>]
    -BatchContext <BatchAccountContext>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Beschreibung

Das Cmdlet Stop-AzBatchJob beendet einen Azure Batch-Auftrag. Mit diesem Befehl wird der Auftrag als abgeschlossen markiert.

Beispiele

Beispiel 1: Beenden eines Batchauftrags

Stop-AzBatchJob -Id "Job-000001" -TerminateReason "No more tasks to run" -BatchContext $Context

Mit diesem Befehl wird der Auftrag beendet, der über den ID-Auftrag 000001 verfügt. Der Befehl gibt einen Grund an, aus dem Sie den Auftrag beenden möchten. Verwenden Sie das Cmdlet Get-AzBatchAccountKey, um der variablen $Context einen Kontext zuzuweisen.

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

-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

-Id

Gibt die ID des Auftrags an, den dieses Cmdlet beendet.

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

-TerminateReason

Gibt den Grund an, warum Sie den Auftrag beenden möchten. Dieses Cmdlet speichert diesen Text als TerminateReason Eigenschaft des Auftrags.

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

Eingaben

String

BatchAccountContext

Ausgaben

Void