Remove-AzBatchJob

  • Référence
Module:
Az.Batch

Supprime un travail Batch.

Syntax

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

Description

L’applet de commande Remove-AzBatchJob supprime un travail Azure Batch. Cette applet de commande vous invite à confirmer avant de supprimer un travail, sauf si vous spécifiez le paramètre Force .

Exemples

Exemple 1 : Supprimer un travail Batch

Remove-AzBatchJob -Id "Job-000001" -BatchContext $Context

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

Exemple 2 : Supprimer un travail Batch sans confirmation à l’aide du pipeline

Get-AzBatchJob -Id "Job-000002" -BatchContext $Context | Remove-AzBatchJob -Force -BatchContext $Context

Cette commande obtient le travail qui a l’ID Job-000002 à l’aide de l’applet de commande Get-AzBatchJob. La commande transmet ce travail à l’applet de commande actuelle à l’aide de l’opérateur de pipeline. La commande supprime ce travail. Étant donné que la commande inclut le paramètre Force , elle ne vous invite pas à confirmer.

Exemple 3 : Effectuer une boucle dans tous les travaux et supprimer

# 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
}

Les commandes ci-dessus suppriment tous les travaux d’un compte Azure Batch donné. Étant donné que la commande inclut le paramètre Force , elle 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.

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

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

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

-DefaultProfile

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

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

-Force

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

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

-Id

Spécifie l’ID du travail que cette applet de commande supprime. Vous ne pouvez pas spécifier de caractères génériques carte.

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

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

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

Entrées

String

BatchAccountContext

Sorties

Void