Remove-AzBatchTask

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

Batch タスクを削除します。

構文

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

説明

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

例

例 1: ID で Batch タスクを削除する

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

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

例 2: 確認なしでパイプラインを使用して Batch タスクを削除する

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

このコマンドは、Get-AzBatchTask コマンドレットを使用して 、ID Job-0000001 を持つジョブに ID Task26 を持つ 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:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

このコマンドレットが削除するタスクを指定します。 PSCloudTask オブジェクトを取得するには、Get-AzBatchTask コマンドレットを使用します。

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

-JobId

タスクを含むジョブの 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

PSCloudTask

BatchAccountContext

出力

Void