Stop-AzBatchJob
Batch ジョブを停止します。
構文
Stop-AzBatchJob
[-Id] <String>
[[-TerminateReason] <String>]
-BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Stop-AzBatchJob コマンドレットは、Azure Batch ジョブを停止します。 このコマンドは、ジョブを完了としてマークします。
例
例 1: バッチ ジョブを停止する
Stop-AzBatchJob -Id "Job-000001" -TerminateReason "No more tasks to run" -BatchContext $Context
このコマンドは、ID Job-000001 を持つジョブを停止します。 このコマンドは、ジョブを停止することを選択した理由を指定します。 Get-AzBatchAccountKey コマンドレットを使用して、$Context変数にコンテキストを割り当てます。
パラメーター
-BatchContext
このコマンドレットが Batch サービスとの対話に使用する BatchAccountContext インスタンスを指定します。 Get-AzBatchAccount コマンドレットを使用して BatchAccountContext を取得する場合、Batch サービスと対話するときに Microsoft Entra 認証が使用されます。 代わりに共有キー認証を使用するには、Get-AzBatchAccountKey コマンドレットを使用して、アクセス キーが設定された BatchAccountContext オブジェクトを取得します。 共有キー認証を使用する場合、プライマリ アクセス キーは既定で使用されます。 使用するキーを変更するには、BatchAccountContext.KeyInUse プロパティを設定します。
型: | BatchAccountContext |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
型: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Id
このコマンドレットが停止するジョブの ID を指定します。
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-TerminateReason
ジョブを停止することを決定した理由を指定します。 このコマンドレットは、このテキストをジョブの TerminateReason プロパティとして格納します。
型: | String |
配置: | 1 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |