Remove-AzBatchTask
構文
Id
Remove-AzBatchTask
[-JobId] <String>
[-Id] <String>
-BatchContext <BatchAccountContext>
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzBatchTask
[-InputObject] <PSCloudTask>
-BatchContext <BatchAccountContext>
[-Force]
[-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 プロパティを設定します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
パラメーターのプロパティ
| 型: | IAzureContextContainer
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
ユーザーの確認を求めずにコマンドを強制的に実行します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Id
このコマンドレットが削除するタスクの ID を指定します。
ワイルドカード文字を指定することはできません。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Id
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
このコマンドレットが削除するタスクを指定します。
PSCloudTask オブジェクトを取得するには、Get-AzBatchTask コマンドレットを使用します。
| 型: | PSCloudTask
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
InputObject
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-JobId
タスクを含むジョブの ID を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Id
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。
コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力
