New-AzBatchJob
Batch サービスでジョブを作成します。
構文
New-AzBatchJob
[-Id] <String>
[-CommonEnvironmentSettings <IDictionary>]
[-DisplayName <String>]
[-Constraints <PSJobConstraints>]
[-JobManagerTask <PSJobManagerTask>]
[-JobPreparationTask <PSJobPreparationTask>]
[-JobReleaseTask <PSJobReleaseTask>]
[-Metadata <IDictionary>]
-PoolInformation <PSPoolInformation>
[-Priority <Int32>]
[-UsesTaskDependencies]
[-OnTaskFailure <OnTaskFailure>]
[-OnAllTasksComplete <OnAllTasksComplete>]
-BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] 説明
New-AzBatchJob コマンドレットは、BatchAccountContext パラメーターで指定されたアカウントの Azure Batch サービスにジョブを作成します。
例
例 1: ジョブを作成する
$PoolInformation = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSPoolInformation"
$PoolInformation.PoolId = "Pool22"
New-AzBatchJob -Id "ContosoJob35" -PoolInformation $PoolInformation -BatchContext $Context最初のコマンドは、New-Object コマンドレットを使用して PSPoolInformation オブジェクトを作成します。 このコマンドは、そのオブジェクトを $PoolInformation 変数に格納します。 2 番目のコマンドは、ID Pool22 を $PoolInformation 内のオブジェクトの PoolId プロパティに割り当てます。 最後のコマンドは、ID ContosoJob35 を持つジョブを作成します。 ジョブに追加されたタスクは、ID Pool22 を持つプールで実行されます。 Get-AzBatchAccountKey コマンドレットを使用して、$Context変数にコンテキストを割り当てます。
パラメーター
-BatchContext
このコマンドレットが Batch サービスとの対話に使用する BatchAccountContext インスタンスを指定します。 Get-AzBatchAccount コマンドレットを使用して BatchAccountContext を取得する場合、Batch サービスと対話するときに Microsoft Entra 認証が使用されます。 代わりに共有キー認証を使用するには、Get-AzBatchAccountKey コマンドレットを使用して、アクセス キーが設定された BatchAccountContext オブジェクトを取得します。 共有キー認証を使用する場合、プライマリ アクセス キーは既定で使用されます。 使用するキーを変更するには、BatchAccountContext.KeyInUse プロパティを設定します。
| 型: | BatchAccountContext |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-CommonEnvironmentSettings
このコマンドレットがジョブ内のすべてのタスクに対して設定する共通環境変数をキーと値のペアとして指定します。 キーは環境変数の名前です。 値は環境変数の値です。
| 型: | IDictionary |
| Aliases: | CommonEnvironmentSetting |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Constraints
ジョブの実行制約を指定します。
| 型: | PSJobConstraints |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| 型: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DisplayName
ジョブの表示名を指定します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Id
ジョブの ID を指定します。
| 型: | String |
| 配置: | 0 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-JobManagerTask
ジョブ マネージャー タスクを指定します。 Batch サービスは、ジョブの開始時にジョブ マネージャー タスクを実行します。
| 型: | PSJobManagerTask |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-JobPreparationTask
ジョブ準備タスクを指定します。 Batch サービスは、そのコンピューティング ノードでジョブのタスクを開始する前に、コンピューティング ノードでジョブ準備タスクを実行します。
| 型: | PSJobPreparationTask |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-JobReleaseTask
ジョブ解放タスクを指定します。 Batch サービスは、ジョブの終了時にジョブ解放タスクを実行します。 Batch サービスは、ジョブのタスクを実行した各コンピューティング ノードでジョブ リリース タスクを実行します。
| 型: | PSJobReleaseTask |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Metadata
ジョブに追加するメタデータをキーと値のペアとして指定します。 キーはメタデータ名です。 値はメタデータ値です。
| 型: | IDictionary |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-OnAllTasksComplete
ジョブ内のすべてのタスクが完了状態の場合に Batch サービスが実行するアクションを指定します。
| 型: | Nullable<T>[OnAllTasksComplete] |
| 指定可能な値: | NoAction, TerminateJob |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-OnTaskFailure
ジョブ内のタスクが失敗した場合に Batch サービスが実行するアクションを指定します。
| 型: | Nullable<T>[OnTaskFailure] |
| 指定可能な値: | NoAction, PerformExitOptionsJobAction |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-PoolInformation
Batch サービスがジョブのタスクを実行するプールの詳細を指定します。
| 型: | PSPoolInformation |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Priority
ジョブの優先順位を指定します。 有効な値は、-1000 ~ 1000 の整数です。 値 -1000 が最も低い優先順位です。 値 1000 が最も高い優先順位です。 既定値は0です。
| 型: | Int32 |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-UsesTaskDependencies
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |