Partager via

Stop-AzBatchJob

  • Référence
Module:
Az.Batch

Arrête un travail Batch.

Syntaxe

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

Description

L’applet de commande Stop-AzBatchJob arrête un travail Azure Batch. Cette commande marque le travail comme terminé.

Exemples

Exemple 1 : Arrêter un travail Batch

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

Cette commande arrête le travail qui a l’ID Job-000001. La commande spécifie une raison pour laquelle vous avez choisi d’arrêter le travail. Utilisez l’applet de commande Get-AzBatchAccountKey pour affecter un contexte à la variable $Context.

Paramètres

-BatchContext

Spécifie l’instance BatchAccountContext utilisée par cette applet de commande pour interagir avec le service Batch. Si vous utilisez l’applet de commande Get-AzBatchAccount pour obtenir votre BatchAccountContext, l’authentification Microsoft Entra sera utilisée lors de l’interaction avec le service Batch. Pour utiliser l’authentification par clé partagée à la place, utilisez l’applet de commande Get-AzBatchAccountKey pour obtenir un objet BatchAccountContext avec ses clés d’accès remplies. Lorsque vous utilisez l’authentification par clé partagée, la clé d’accès primaire est utilisée par défaut. Pour modifier la clé à utiliser, définissez la propriété BatchAccountContext.KeyInUse.

Type:BatchAccountContext
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Type:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Id

Spécifie l’ID du travail arrêté par cette applet de commande.

Type:String
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-TerminateReason

Spécifie la raison pour laquelle vous avez décidé d’arrêter le travail. Cette applet de commande stocke ce texte en tant que propriété TerminateReason du travail.

Type:String
Position:1
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

String

BatchAccountContext

Sorties

Void