Remove-AzBatchJob

  • リファレンス
モジュール:
Az.Batch

Batch ジョブを削除します。

構文

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

説明

Remove-AzBatchJob コマンドレットは、Azure Batch ジョブを削除します。 このコマンドレットは、Force パラメーターを指定しない限り、ジョブを削除する前に確認を求められます。

例

例 1: Batch ジョブを削除する

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

このコマンドは、ID Job-000001 を持つジョブを削除します。 コマンドは、ジョブを削除する前に確認を求められます。 Get-AzBatchAccountKey コマンドレットを使用して、$Context変数にコンテキストを割り当てます。

例 2: パイプラインを使用して確認なしで Batch ジョブを削除する

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

このコマンドは、Get-AzBatchJob コマンドレットを使用して、ID Job-000002 を持つジョブを取得します。 コマンドは、パイプライン 演算子を使用して、そのジョブを現在のコマンドレットに渡します。 このコマンドは、そのジョブを削除します。 このコマンドには Force パラメーターが含まれているため、確認を求めるメッセージは表示されません。

例 3: すべてのジョブをループして削除する

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

上記のコマンドは、特定の Azure Batch アカウントのすべてのジョブを削除します。 このコマンドには Force パラメーターが含まれているため、確認を求めるメッセージは表示されません。

パラメーター

-BatchContext

このコマンドレットが Batch サービスとの対話に使用する BatchAccountContext インスタンスを指定します。 Get-AzBatchAccount コマンドレットを使用して BatchAccountContext を取得する場合、Batch サービスと対話するときに Microsoft Entra 認証が使用されます。 代わりに共有キー認証を使用するには、Get-AzBatchAccountKey コマンドレットを使用して、アクセス キーが設定された BatchAccountContext オブジェクトを取得します。 共有キー認証を使用する場合、プライマリ アクセス キーは既定で使用されます。 使用するキーを変更するには、BatchAccountContext.KeyInUse プロパティを設定します。

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

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

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

-Force

ユーザーに確認せずに、直ちにコマンドを実行します。

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

-Id

このコマンドレットが削除するジョブの ID を指定します。 ワイルドカード文字は指定できません。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

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

入力

String

BatchAccountContext

出力

Void