Partager via

Remove-AzBatchTask

Module:
Az.Batch Module

Supprime une tâche Batch.

Syntaxe

Id 

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

InputObject 

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

Description

L’applet de commande Remove-AzBatchTask supprime une tâche Azure Batch. Cette applet de commande vous invite à confirmer, sauf si vous spécifiez le paramètre Force .

Exemples

Exemple 1 : Supprimer une tâche Batch par ID

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

Cette commande supprime une tâche qui a l’ID Task23 sous le travail qui a l’ID Job-000001. La commande vous invite à confirmer. Utilisez l’applet de commande Get-AzBatchAccountKey pour affecter un contexte à la variable $Context.

Exemple 2 : Supprimer une tâche Batch à l’aide du pipeline sans confirmation

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

Cette commande obtient la tâche Batch qui a l’ID Task26 dans le travail qui a l’ID Job-000001 à l’aide de l’applet de commande Get-AzBatchTask . La commande transmet cette tâche à l’applet de commande actuelle à l’aide de l’opérateur de pipeline. La commande supprime cette tâche. Cette commande spécifie le paramètre Force . Par conséquent, la commande ne vous invite pas à confirmer.

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.

Propriétés du paramètre

Type:BatchAccountContext
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False
Alias:cf

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-DefaultProfile

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

Propriétés du paramètre

Type:IAzureContextContainer
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Force

Force l’exécution de la commande sans demander la confirmation de l’utilisateur.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Id

Spécifie l’ID de la tâche que cette applet de commande supprime. Vous ne pouvez pas spécifier de caractères génériques.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

Id
Position:1
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-InputObject

Spécifie la tâche que cette applet de commande supprime. Pour obtenir un objet PSCloudTask , utilisez l’applet de commande Get-AzBatchTask.

Propriétés du paramètre

Type:PSCloudTask
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

InputObject
Position:0
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-JobId

Spécifie l’ID du travail qui contient la tâche.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

Id
Position:0
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande ne s’exécute pas.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False
Alias:Wi

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

String

PSCloudTask

BatchAccountContext

Sorties

Void