Job - Get
指定したジョブに関する情報を取得します。
GET {batchUrl}/jobs/{jobId}?api-version=2023-11-01.18.0
GET {batchUrl}/jobs/{jobId}?$select={$select}&$expand={$expand}&timeout={timeout}&api-version=2023-11-01.18.0
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
batch
|
path | True |
string |
すべてのAzure Batchサービス要求のベース URL。 |
job
|
path | True |
string |
ジョブの ID。 |
api-version
|
query | True |
string |
クライアント API のバージョン。 |
$expand
|
query |
string |
OData $expand 句。 |
|
$select
|
query |
string |
OData $select 句。 |
|
timeout
|
query |
integer int32 |
サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 30 秒です。 |
要求ヘッダー
Media Types: "application/json; odata=minimalmetadata"
名前 | 必須 | 型 | 説明 |
---|---|---|---|
client-request-id |
string uuid |
呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (9C4D50EE-2D56-4CD3-8152-34347DC9F2B0 など)。 |
|
return-client-request-id |
boolean |
サーバーが応答で client-request-id を返す必要があるかどうか。 |
|
ocp-date |
string date-time-rfc1123 |
要求が発行された時刻。 クライアント ライブラリは通常、これを現在のシステム クロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。 |
|
If-Match |
string |
クライアントに認識されているリソースのバージョンに関連付けられている ETag 値。 操作は、サービス上のリソースの現在の ETag がクライアントによって指定された値と正確に一致する場合にのみ実行されます。 |
|
If-None-Match |
string |
クライアントに認識されているリソースのバージョンに関連付けられている ETag 値。 この操作は、サービス上のリソースの現在の ETag がクライアントによって指定された値と一致しない場合にのみ実行されます。 |
|
If-Modified-Since |
string date-time-rfc1123 |
クライアントに認識されているリソースの最終変更時刻を示すタイムスタンプ。 この操作は、サービス上のリソースが指定された時刻以降に変更された場合にのみ実行されます。 |
|
If-Unmodified-Since |
string date-time-rfc1123 |
クライアントに認識されているリソースの最終変更時刻を示すタイムスタンプ。 この操作は、指定された時刻以降にサービス上のリソースが変更されていない場合にのみ実行されます。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
ジョブを含む応答。 ヘッダー
|
|
Other Status Codes |
Batch サービスからのエラー。 |
セキュリティ
azure_auth
Microsoft Entra OAuth 2.0 認証コード フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
Authorization
型:
apiKey
/:
header
例
Job get
要求のサンプル
GET account.region.batch.azure.com/jobs/jobId?api-version=2023-11-01.18.0
応答のサンプル
{
"id": "jobId",
"url": "https://account.region.batch.azure.com/jobs/jobId",
"eTag": "0x8D4100FC49F0278",
"lastModified": "2016-11-19T00:05:27.5391608Z",
"creationTime": "2016-11-19T00:05:25.311915Z",
"state": "completed",
"stateTransitionTime": "2016-11-19T00:05:27.578581Z",
"previousState": "active",
"previousStateTransitionTime": "2016-11-19T00:05:27.2137716Z",
"priority": 0,
"maxParallelTasks": -1,
"allowTaskPreemption": false,
"usesTaskDependencies": false,
"constraints": {
"maxWallClockTime": "P10675199DT2H48M5.4775807S",
"maxTaskRetryCount": 0
},
"poolInfo": {
"poolId": "poolId"
},
"executionInfo": {
"startTime": "2016-11-19T00:05:25.3309105Z",
"endTime": "2016-11-19T00:05:27.578581Z",
"poolId": "poolId",
"terminateReason": "UserTerminate"
},
"onAllTasksComplete": "noaction",
"onTaskFailure": "noaction"
}
定義
名前 | 説明 |
---|---|
Access |
トークンがアクセスを許可する Batch リソース。 |
Application |
コンピューティング ノードにデプロイするパッケージへの参照。 |
Authentication |
Batch サービス操作の実行にタスクが使用できる認証トークンの設定。 |
Auto |
一時 '自動プール' の特性を指定します。 Batch サービスは、ジョブの送信時にこの自動プールを作成します。 |
Auto |
自動ユーザーのスコープ |
Auto |
Batch サービスでタスクを実行する自動ユーザーのパラメーターを指定します。 |
Azure |
Blobfuse を使用して Azure Storage コンテナーに接続するために使用される情報。 |
Azure |
Azure Fileshare への接続に使用される情報。 |
Batch |
Azure Batch サービスから受信したエラー応答。 |
Batch |
Azure Batchエラー応答に含まれる追加情報の項目。 |
Caching |
ディスクに対して有効にするキャッシュの種類。 |
Certificate |
プール内のコンピューティング ノードにインストールされる証明書への参照。 |
Certificate |
証明書をインストールするコンピューティング ノード上の証明書ストアの場所。 |
Certificate |
証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。 |
CIFSMount |
CIFS ファイル システムへの接続に使用される情報。 |
Cloud |
Azure Batch ジョブ。 |
Cloud |
Azure Cloud Services プラットフォームに基づくプール内のコンピューティング ノードの構成。 |
Compute |
プール内のコンピューティング ノード間でタスクを分散する方法。 |
Compute |
コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。 |
Container |
コンテナーが有効なプールの構成。 |
Container |
プライベート コンテナー レジストリ。 |
Container |
使用するコンテナー テクノロジ。 |
Container |
コンテナー Task 作業ディレクトリの場所。 |
Data |
プール内のコンピューティング ノードに関連付けられているデータ ディスクによって使用される設定。 添付データ ディスクを含める場合は、それらを使用する VM 内からディスクを マウントおよびフォーマットする必要があります。 |
Diff |
プール内のすべてのコンピューティング ノード (VM) のオペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。 |
Diff |
コンピューティング ノード (VM) によって使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。 |
Disk |
プール内のコンピューティング ノードに適用されるディスク暗号化構成。 Azure Compute Gallery Image で作成された Linux プールでは、ディスク暗号化の構成はサポートされていません。 |
Disk |
Batch Service がコンピューティング ノードで暗号化するディスク ターゲットの一覧。 |
Dynamic |
動的 vnet 割り当てのスコープ。 |
Elevation |
ユーザーの昇格レベル。 |
Environment |
タスク プロセスで設定する環境変数。 |
Error |
エラーのカテゴリ。 |
Error |
Azure Batch エラー応答で受信したエラー メッセージ。 |
Http |
HTTP ヘッダーの名前と値のペア |
Image |
Azure Virtual Machines Marketplace イメージまたは Azure Compute Gallery イメージへの参照。 Azure Batchによって検証されたすべてのAzure Marketplaceイメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。 |
Inbound |
エンドポイントのプロトコル。 |
Inbound |
Batch プール内のコンピューティング ノード上の特定のポートを外部からアドレス指定するために使用できる受信 NAT プール。 |
IPAddress |
プールのパブリック IP アドレスのプロビジョニングの種類。 |
Job |
ジョブの実行制約。 |
Job |
Azure Batch サービスでのジョブの実行に関する情報が含まれます。 |
Job |
ジョブ マネージャー タスクの詳細を指定します。 |
Job |
ジョブのネットワーク構成。 |
Job |
特定のコンピューティング ノード上のジョブのタスクの前に実行するジョブ準備タスク。 |
Job |
ジョブが実行されている任意のコンピューティング ノードでジョブの完了時に実行するジョブ 解放タスク。 |
Job |
ジョブをスケジュールするときに Batch サービスによって発生したエラー。 |
Job |
ジョブの状態。 |
Job |
ジョブのリソース使用状況統計。 |
Linux |
Linux コンピューティング ノードでユーザー アカウントを作成するために使用されるプロパティ。 |
Login |
ユーザーのログイン モード |
Managed |
|
Metadata |
Batch サービス リソースに関連付けられている名前と値のペア。 |
Mount |
各ノードにマウントするファイル システム。 |
Name |
名前と値のペアを表します。 |
Network |
プールのネットワーク構成。 |
Network |
受信エンドポイントに適用するネットワーク セキュリティ グループ規則。 |
Network |
指定した IP アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。 |
NFSMount |
NFS ファイル システムへの接続に使用される情報。 |
Node |
プールが Batch サービスと通信する方法を決定します。 |
Node |
プールのノード配置の構成。 |
Node |
プール内のノードを割り当てる配置ポリシー。 |
On |
ジョブ内のすべてのタスクが完了状態のときに Batch サービスが実行する必要があるアクション。 |
On |
ジョブ内のタスクが失敗したときに Batch サービスが実行する必要があるアクション。 |
OSDisk |
コンピューティング ノード (VM) のオペレーティング システム ディスクの設定。 |
Output |
Batch サービスがタスク プロセスの実行を完了した後に、Azure Batchコンピューティング ノードから別の場所にファイルをアップロードするための仕様。 |
Output |
Azure BLOB ストレージ コンテナー内のファイルアップロード先を指定します。 |
Output |
ファイルのアップロード先。 |
Output |
タスク出力ファイルまたは一連のファイルをアップロードする条件。 |
Output |
アップロードを実行する条件など、出力ファイルのアップロード操作に関する詳細。 |
Pool |
プールのエンドポイント構成。 |
Pool |
ジョブをプールに割り当てる方法を指定します。 |
Pool |
作成された自動プールの最小有効期間と、スケジュール上の複数のジョブをプールに割り当てる方法。 |
Pool |
新しいプールを作成するための仕様。 |
Public |
プールのネットワーク構成のパブリック IP アドレス構成。 |
Resource |
コンピューティング ノードにダウンロードする 1 つのファイルまたは複数のファイル。 |
Security |
仮想マシンまたは仮想マシン スケール セットのセキュリティ プロファイル設定を指定します。 |
Security |
仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。 |
Service |
'latest' イメージ バージョンを使用する場合に、スケール セット内のすべての仮想マシンに同じイメージ バージョンを設定するために使用されるサービス成果物参照 ID を指定します。 |
Start |
ノードがAzure Batch サービスのプールに参加したとき、またはコンピューティング ノードが再起動または再イメージ化されたときに実行されるタスク。 |
Storage |
データ ディスクまたは OS ディスクの作成に使用するストレージ アカウントの種類。 |
Task |
タスクに適用する実行制約。 |
Task |
タスクのコンテナー設定。 |
Task |
タスクをコンピューティング ノード間で分散する方法を指定します。 |
Uefi |
仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。 |
User |
Azure Batchコンピューティング ノードでタスクを実行するために使用するユーザーの作成に使用されるプロパティ。 |
User |
タスクを実行するユーザー ID の定義。 |
Virtual |
Azure Virtual Machines インフラストラクチャに基づくプール内のコンピューティング ノードの構成。 |
VMExtension |
仮想マシン拡張機能の構成。 |
Windows |
仮想マシンに適用する Windows オペレーティング システムの設定。 |
Windows |
Windows コンピューティング ノードでユーザー アカウントを作成するために使用されるプロパティ。 |
AccessScope
トークンがアクセスを許可する Batch リソース。
名前 | 型 | 説明 |
---|---|---|
job |
string |
タスクを含むジョブに対するすべての操作を実行するためのアクセス権を付与します。 |
ApplicationPackageReference
コンピューティング ノードにデプロイするパッケージへの参照。
名前 | 型 | 説明 |
---|---|---|
applicationId |
string |
デプロイするアプリケーションの ID。 |
version |
string |
デプロイするアプリケーションのバージョン。 省略すると、既定のバージョンがデプロイされます。 |
AuthenticationTokenSettings
Batch サービス操作の実行にタスクが使用できる認証トークンの設定。
名前 | 型 | 説明 |
---|---|---|
access |
トークンがアクセスを許可する Batch リソース。 |
AutoPoolSpecification
一時 '自動プール' の特性を指定します。 Batch サービスは、ジョブの送信時にこの自動プールを作成します。
名前 | 型 | 説明 |
---|---|---|
autoPoolIdPrefix |
string |
プールが自動的に作成されるときに一意の識別子に追加されるプレフィックス。 |
keepAlive |
boolean |
有効期間が切れた後に自動プールを維持するかどうか。 |
pool |
自動プールのプール仕様。 |
|
poolLifetimeOption |
作成された自動プールの最小有効期間と、スケジュール上の複数のジョブをプールに割り当てる方法。 |
AutoUserScope
自動ユーザーのスコープ
名前 | 型 | 説明 |
---|---|---|
pool |
string |
タスクが、プール内のすべてのコンピューティング ノードで作成される共通の自動ユーザー アカウントとして実行されることを指定します。 |
task |
string |
サービスがタスクの新しいユーザーを作成することを指定します。 |
AutoUserSpecification
Batch サービスでタスクを実行する自動ユーザーのパラメーターを指定します。
名前 | 型 | 説明 |
---|---|---|
elevationLevel |
自動ユーザーの昇格レベル。 |
|
scope |
自動ユーザーのスコープ |
AzureBlobFileSystemConfiguration
Blobfuse を使用して Azure Storage コンテナーに接続するために使用される情報。
名前 | 型 | 説明 |
---|---|---|
accountKey |
string |
Azure Storage アカウント キー。 |
accountName |
string |
Azure Storage アカウント名。 |
blobfuseOptions |
string |
mount コマンドに渡す追加のコマンド ライン オプション。 |
containerName |
string |
Azure Blob Storage コンテナー名。 |
identityReference |
containerName へのアクセスに使用するユーザー割り当て ID への参照 |
|
relativeMountPath |
string |
ファイル システムがマウントされるコンピューティング ノードの相対パス |
sasKey |
string |
Azure Storage SAS トークン。 |
AzureFileShareConfiguration
Azure Fileshare への接続に使用される情報。
名前 | 型 | 説明 |
---|---|---|
accountKey |
string |
Azure Storage アカウント キー。 |
accountName |
string |
Azure Storage のアカウント名。 |
azureFileUrl |
string |
Azure Files URL。 |
mountOptions |
string |
mount コマンドに渡す追加のコマンド ライン オプション。 |
relativeMountPath |
string |
ファイル システムがマウントされるコンピューティング ノードの相対パス |
BatchError
Azure Batch サービスから受信したエラー応答。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。 |
message |
ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。 |
|
values |
エラーに関する追加の詳細を含むキーと値のペアのコレクション。 |
BatchErrorDetail
Azure Batchエラー応答に含まれる追加情報の項目。
名前 | 型 | 説明 |
---|---|---|
key |
string |
Value プロパティの意味を指定する識別子。 |
value |
string |
エラー応答に含まれる追加情報。 |
CachingType
ディスクに対して有効にするキャッシュの種類。
名前 | 型 | 説明 |
---|---|---|
none |
string |
ディスクのキャッシュ モードが有効になっていません。 |
readonly |
string |
ディスクのキャッシュ モードは読み取り専用です。 |
readwrite |
string |
ディスクのキャッシュ モードは読み取りと書き込みです。 |
CertificateReference
プール内のコンピューティング ノードにインストールされる証明書への参照。
名前 | 型 | 説明 |
---|---|---|
storeLocation |
証明書をインストールするコンピューティング ノード上の証明書ストアの場所。 |
|
storeName |
string |
証明書をインストールするコンピューティング ノード上の証明書ストアの名前。 |
thumbprint |
string |
証明書の拇印。 |
thumbprintAlgorithm |
string |
拇印が関連付けられているアルゴリズム。 これは sha1 である必要があります。 |
visibility |
証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。 |
CertificateStoreLocation
証明書をインストールするコンピューティング ノード上の証明書ストアの場所。
名前 | 型 | 説明 |
---|---|---|
currentuser |
string |
証明書は CurrentUser 証明書ストアにインストールする必要があります。 |
localmachine |
string |
証明書は LocalMachine 証明書ストアにインストールする必要があります。 |
CertificateVisibility
証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。
名前 | 型 | 説明 |
---|---|---|
remoteuser |
string |
証明書は、ユーザーがコンピューティング ノードにリモートでアクセスするユーザー アカウントに表示される必要があります。 |
starttask |
string |
証明書は、StartTask が実行されているユーザー アカウントに表示されます。 AutoUser スコープが StartTask と Task の両方のプールである場合、この証明書はタスクにも表示されることに注意してください。 |
task |
string |
証明書は、ジョブ タスクが実行されているユーザー アカウントに表示されます。 |
CIFSMountConfiguration
CIFS ファイル システムへの接続に使用される情報。
名前 | 型 | 説明 |
---|---|---|
mountOptions |
string |
mount コマンドに渡す追加のコマンド ライン オプション。 |
password |
string |
CIFS ファイル システムに対する認証に使用するパスワード。 |
relativeMountPath |
string |
ファイル システムがマウントされるコンピューティング ノードの相対パス |
source |
string |
マウントするファイル システムの URI。 |
username |
string |
CIFS ファイル システムに対する認証に使用するユーザー。 |
CloudJob
Azure Batch ジョブ。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
allowTaskPreemption |
boolean |
このジョブ内のタスクを他の優先度の高いジョブに割り込むことができるかどうか |
|
commonEnvironmentSettings |
一般的な環境変数設定の一覧。 これらの環境変数は、ジョブ内のすべてのタスク (ジョブ マネージャー、ジョブ準備タスク、ジョブ 解放タスクを含む) に設定されます。 |
||
constraints |
ジョブの実行制約。 |
||
creationTime |
string |
ジョブの作成時刻。 |
|
displayName |
string |
ジョブの表示名。 |
|
eTag |
string |
ジョブの ETag。 |
|
executionInfo |
ジョブの実行情報。 |
||
id |
string |
アカウント内のジョブを一意に識別する文字列。 |
|
jobManagerTask |
ジョブの開始時に起動されるジョブ マネージャー タスクの詳細。 |
||
jobPreparationTask |
ジョブ準備タスク。 |
||
jobReleaseTask |
ジョブ解放タスク。 |
||
lastModified |
string |
ジョブの最終変更時刻。 |
|
maxParallelTasks |
integer |
-1 |
ジョブに対して並列に実行できるタスクの最大数。 |
metadata |
ジョブにメタデータとして関連付けられている名前と値のペアの一覧。 |
||
networkConfiguration |
ジョブのネットワーク構成。 |
||
onAllTasksComplete |
ジョブ内のすべてのタスクが完了状態のときに Batch サービスが実行する必要があるアクション。 |
||
onTaskFailure |
ジョブ内のタスクが失敗したときに Batch サービスが実行する必要があるアクション。 |
||
poolInfo |
ジョブに関連付けられているプール設定。 |
||
previousState |
ジョブの以前の状態。 |
||
previousStateTransitionTime |
string |
ジョブが以前の状態になった時刻。 |
|
priority |
integer |
ジョブの優先度。 |
|
state |
ジョブの現在の状態。 |
||
stateTransitionTime |
string |
ジョブが現在の状態に入った時刻。 |
|
stats |
ジョブの有効期間全体のリソース使用状況統計。 |
||
url |
string |
ジョブの URL。 |
|
usesTaskDependencies |
boolean |
ジョブ内のタスクが相互に依存関係を定義できるかどうか。 既定値は false です。 |
CloudServiceConfiguration
Azure Cloud Services プラットフォームに基づくプール内のコンピューティング ノードの構成。
名前 | 型 | 説明 |
---|---|---|
osFamily |
string |
プール内の仮想マシンにインストールされる Azure ゲスト OS ファミリ。 |
osVersion |
string |
プール内の仮想マシンにインストールされる Azure ゲスト OS バージョン。 |
ComputeNodeFillType
プール内のコンピューティング ノード間でタスクを分散する方法。
名前 | 型 | 説明 |
---|---|---|
pack |
string |
プール内の次のコンピューティング ノードにタスクが割り当てられる前に、可能な限り多くのタスク (taskSlotsPerNode) をプール内の各コンピューティング ノードに割り当てる必要があります。 |
spread |
string |
タスクは、プール内のすべてのコンピューティング ノードに均等に割り当てる必要があります。 |
ComputeNodeIdentityReference
コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。
名前 | 型 | 説明 |
---|---|---|
resourceId |
string |
ユーザー割り当て ID の ARM リソース ID。 |
ContainerConfiguration
コンテナーが有効なプールの構成。
名前 | 型 | 説明 |
---|---|---|
containerImageNames |
string[] |
コンテナーイメージ名のコレクション。 |
containerRegistries |
コンテナーをプルできる追加のプライベート レジストリ。 |
|
type |
使用するコンテナー テクノロジ。 |
ContainerRegistry
プライベート コンテナー レジストリ。
名前 | 型 | 説明 |
---|---|---|
identityReference |
ユーザー名とパスワードではなく、Azure Container Registryへのアクセスに使用するユーザー割り当て ID への参照。 |
|
password |
string |
レジストリ サーバーにログインするためのパスワード。 |
registryServer |
string |
レジストリ URL。 |
username |
string |
レジストリ サーバーにログインするユーザー名。 |
ContainerType
使用するコンテナー テクノロジ。
名前 | 型 | 説明 |
---|---|---|
criCompatible |
string |
コンテナーの起動には、CRI ベースのテクノロジが使用されます。 |
dockerCompatible |
string |
Docker 互換のコンテナー テクノロジを使用してコンテナーを起動します。 |
ContainerWorkingDirectory
コンテナー Task 作業ディレクトリの場所。
名前 | 型 | 説明 |
---|---|---|
containerImageDefault |
string |
コンテナー Image で定義されている作業ディレクトリを使用します。 このディレクトリには、Batch によってダウンロードされたリソース ファイルが含まれていないことに注意してください。 |
taskWorkingDirectory |
string |
標準の Batch サービス Task 作業ディレクトリを使用します。このディレクトリには、Batch によって設定されたタスク リソース ファイルが含まれます。 |
DataDisk
プール内のコンピューティング ノードに関連付けられているデータ ディスクによって使用される設定。 添付データ ディスクを含める場合は、それらを使用する VM 内からディスクを マウントおよびフォーマットする必要があります。
名前 | 型 | 説明 |
---|---|---|
caching |
データ ディスクに対して有効にするキャッシュの種類。 |
|
diskSizeGB |
integer |
初期ディスク サイズ (ギガバイト単位)。 |
lun |
integer |
論理ユニット番号。 |
storageAccountType |
データ ディスクに使用するストレージ アカウントの種類。 |
DiffDiskPlacement
プール内のすべてのコンピューティング ノード (VM) のオペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。
名前 | 型 | 説明 |
---|---|---|
CacheDisk |
string |
エフェメラル OS ディスクは VM キャッシュに格納されます。 |
DiffDiskSettings
コンピューティング ノード (VM) によって使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。
名前 | 型 | 説明 |
---|---|---|
placement |
プール内のすべての VM のオペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。 |
DiskEncryptionConfiguration
プール内のコンピューティング ノードに適用されるディスク暗号化構成。 Azure Compute Gallery Image で作成された Linux プールでは、ディスク暗号化の構成はサポートされていません。
名前 | 型 | 説明 |
---|---|---|
targets |
Batch Service がコンピューティング ノードで暗号化するディスク ターゲットの一覧。 |
DiskEncryptionTarget
Batch Service がコンピューティング ノードで暗号化するディスク ターゲットの一覧。
名前 | 型 | 説明 |
---|---|---|
osdisk |
string |
コンピューティング ノード上の OS ディスクは暗号化されます。 |
temporarydisk |
string |
コンピューティング ノード上の一時ディスクは暗号化されます。 Linux では、起動時に暗号化が行われると、この暗号化は他のパーティション (マウントされたデータ ディスク上のパーティションなど) に適用されます。 |
DynamicVNetAssignmentScope
動的 vnet 割り当てのスコープ。
名前 | 型 | 説明 |
---|---|---|
job |
string |
動的 VNet の割り当てはジョブごとに行われます。 |
none |
string |
動的 VNet 割り当てが有効になっていません。 |
ElevationLevel
ユーザーの昇格レベル。
名前 | 型 | 説明 |
---|---|---|
admin |
string |
ユーザーは昇格されたアクセス権を持つユーザーであり、完全な管理者権限で動作します。 |
nonadmin |
string |
ユーザーは、昇格されたアクセス権のない標準ユーザーです。 |
EnvironmentSetting
タスク プロセスで設定する環境変数。
名前 | 型 | 説明 |
---|---|---|
name |
string |
環境変数の名前。 |
value |
string |
環境変数の値。 |
ErrorCategory
エラーのカテゴリ。
名前 | 型 | 説明 |
---|---|---|
servererror |
string |
このエラーは、内部サーバーの問題が原因です。 |
usererror |
string |
このエラーは、構成の誤りなど、ユーザーの問題が原因です。 |
ErrorMessage
Azure Batch エラー応答で受信したエラー メッセージ。
名前 | 型 | 説明 |
---|---|---|
lang |
string |
エラー メッセージの言語コード |
value |
string |
メッセージのテキストです。 |
HttpHeader
HTTP ヘッダーの名前と値のペア
名前 | 型 | 説明 |
---|---|---|
name |
string |
出力ファイルのアップロード時に使用するヘッダーの大文字と小文字を区別しない名前 |
value |
string |
出力ファイルのアップロード中に使用するヘッダーの値 |
ImageReference
Azure Virtual Machines Marketplace イメージまたは Azure Compute Gallery イメージへの参照。 Azure Batchによって検証されたすべてのAzure Marketplaceイメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。
名前 | 型 | 説明 |
---|---|---|
exactVersion |
string |
ノードの作成に使用されるプラットフォーム イメージまたはマーケットプレース イメージの特定のバージョン。 この読み取り専用フィールドは、プールの作成時に 'version' に指定された値が 'latest' の場合にのみ、'version' と異なります。 |
offer |
string |
Azure Virtual Machines Marketplace イメージのオファーの種類。 |
publisher |
string |
Azure Virtual Machines Marketplace イメージの発行元。 |
sku |
string |
Azure Virtual Machines Marketplace イメージの SKU。 |
version |
string |
Azure Virtual Machines Marketplace イメージのバージョン。 |
virtualMachineImageId |
string |
Azure Compute Gallery イメージの ARM リソース識別子。 プール内のコンピューティング ノードは、このイメージ ID を使用して作成されます。これは、常に最新のイメージ バージョンに既定値を設定するための /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleryName}/images/{imageDefinitionName}/versions/{VersionId} または /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallery/galleryName}/images/{imageDefinitionName} の形式です。 |
InboundEndpointProtocol
エンドポイントのプロトコル。
名前 | 型 | 説明 |
---|---|---|
tcp |
string |
エンドポイントには TCP を使用します。 |
udp |
string |
エンドポイントには UDP を使用します。 |
InboundNATPool
Batch プール内のコンピューティング ノード上の特定のポートを外部からアドレス指定するために使用できる受信 NAT プール。
名前 | 型 | 説明 |
---|---|---|
backendPort |
integer |
コンピューティング ノードのポート番号。 |
frontendPortRangeEnd |
integer |
個々のコンピューティング ノードの backendPort への受信アクセスを提供するために使用される外部ポートの範囲内の最後のポート番号。 |
frontendPortRangeStart |
integer |
個々のコンピューティング ノードの backendPort への受信アクセスを提供するために使用される外部ポートの範囲内の最初のポート番号。 |
name |
string |
エンドポイントの名前。 |
networkSecurityGroupRules |
エンドポイントに適用されるネットワーク セキュリティ グループ規則の一覧。 |
|
protocol |
エンドポイントのプロトコル。 |
IPAddressProvisioningType
プールのパブリック IP アドレスのプロビジョニングの種類。
名前 | 型 | 説明 |
---|---|---|
batchmanaged |
string |
パブリック IP は Batch によって作成および管理されます。 プールのサイズによっては、複数のパブリック IP が存在する場合があります。 |
nopublicipaddresses |
string |
パブリック IP アドレスは作成されません。 |
usermanaged |
string |
パブリック IP はユーザーによって提供され、コンピューティング ノードのプロビジョニングに使用されます。 |
JobConstraints
ジョブの実行制約。
名前 | 型 | 説明 |
---|---|---|
maxTaskRetryCount |
integer |
各タスクを再試行できる最大回数。 終了コードが 0 以外の場合、Batch サービスは Task を再試行します。 |
maxWallClockTime |
string |
ジョブが実行できる最大経過時間。ジョブの作成時刻から測定されます。 |
JobExecutionInformation
Azure Batch サービスでのジョブの実行に関する情報が含まれます。
名前 | 型 | 説明 |
---|---|---|
endTime |
string |
ジョブの完了時刻。 |
poolId |
string |
このジョブが割り当てられているプールの ID。 |
schedulingError |
ジョブの開始時にサービスによって発生したエラーの詳細。 |
|
startTime |
string |
ジョブの開始時刻。 |
terminateReason |
string |
ジョブが終了した理由を説明する文字列。 |
JobManagerTask
ジョブ マネージャー タスクの詳細を指定します。
名前 | 型 | 説明 |
---|---|---|
allowLowPriorityNode |
boolean |
ジョブ マネージャー タスクがスポット/優先順位の低いコンピューティング ノードで実行できるかどうか。 |
applicationPackageReferences |
コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにデプロイするアプリケーション パッケージの一覧。 |
|
authenticationTokenSettings |
Batch サービス操作の実行にタスクが使用できる認証トークンの設定。 |
|
commandLine |
string |
ジョブ マネージャー タスクのコマンド ライン。 |
constraints |
ジョブ マネージャー タスクに適用される制約。 |
|
containerSettings |
ジョブ マネージャー タスクを実行するコンテナーの設定。 |
|
displayName |
string |
ジョブ マネージャー タスクの表示名。 |
environmentSettings |
ジョブ マネージャー タスクの環境変数設定の一覧。 |
|
id |
string |
ジョブ内のジョブ マネージャー タスクを一意に識別する文字列。 |
killJobOnCompletion |
boolean |
ジョブ マネージャー タスクの完了が、ジョブ全体の完了を示すかどうか。 |
outputFiles |
コマンド ラインの実行後に Batch サービスがコンピューティング ノードからアップロードするファイルの一覧。 |
|
requiredSlots |
integer |
タスクの実行に必要なスケジュール スロットの数。 |
resourceFiles |
コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 |
|
runExclusive |
boolean |
ジョブ マネージャー タスクを実行するコンピューティング ノードを排他的に使用する必要があるかどうか。 |
userIdentity |
ジョブ マネージャー タスクを実行するユーザー ID。 |
JobNetworkConfiguration
ジョブのネットワーク構成。
名前 | 型 | 説明 |
---|---|---|
subnetId |
string |
ジョブからタスクを実行しているコンピューティング ノードがタスクの期間中参加する仮想ネットワーク サブネットの ARM リソース識別子。 これは、VirtualMachineConfiguration プールでのみ機能します。 |
JobPreparationTask
特定のコンピューティング ノード上のジョブのタスクの前に実行するジョブ準備タスク。
名前 | 型 | 説明 |
---|---|---|
commandLine |
string |
ジョブ準備タスクのコマンド ライン。 |
constraints |
ジョブ準備タスクに適用される制約。 |
|
containerSettings |
ジョブ準備タスクを実行するコンテナーの設定。 |
|
environmentSettings |
ジョブ準備タスクの環境変数設定の一覧。 |
|
id |
string |
ジョブ内のジョブ準備タスクを一意に識別する文字列。 |
rerunOnNodeRebootAfterSuccess |
boolean |
コンピューティング ノードの再起動後に Batch サービスでジョブ準備タスクを再実行する必要があるかどうか。 |
resourceFiles |
コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 |
|
userIdentity |
ジョブ準備タスクを実行するユーザー ID。 |
|
waitForSuccess |
boolean |
Batch サービスがジョブ準備タスクが正常に完了するまで待機してから、コンピューティング ノード上のジョブの他のタスクをスケジュールする必要があるかどうか。 ジョブ準備タスクが終了コード 0 で終了すると、正常に完了しました。 |
JobReleaseTask
ジョブが実行されている任意のコンピューティング ノードでジョブの完了時に実行するジョブ 解放タスク。
名前 | 型 | 説明 |
---|---|---|
commandLine |
string |
ジョブ 解放タスクのコマンド ライン。 |
containerSettings |
ジョブ 解放タスクを実行するコンテナーの設定。 |
|
environmentSettings |
ジョブ リリース タスクの環境変数設定の一覧。 |
|
id |
string |
ジョブ内のジョブ 解放タスクを一意に識別する文字列。 |
maxWallClockTime |
string |
特定のコンピューティング ノードでジョブ 解放タスクを実行できる最大経過時間。タスクの開始時から測定されます。 タスクが制限時間内に完了しない場合は、Batch サービスによって終了されます。 既定値は 15 分です。 15 分を超えるタイムアウトを指定することはできません。 その場合、Batch サービスはエラーで拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 |
resourceFiles |
コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 リソース ファイルの一覧には最大サイズがあります。 最大サイズを超えると、要求は失敗し、応答エラー コードは RequestEntityTooLarge になります。 この場合、ResourceFiles のコレクションのサイズを小さくする必要があります。 これは、.zip ファイル、アプリケーション パッケージ、または Docker コンテナーを使用して実現できます。 |
|
retentionTime |
string |
コンピューティング ノード上のジョブ リリース タスクの Task ディレクトリを保持する最小時間。 この時間が経過すると、Batch サービスによって Task ディレクトリとそのすべての内容が削除される可能性があります。 |
userIdentity |
ジョブ解放タスクを実行するユーザー ID。 |
JobSchedulingError
ジョブをスケジュールするときに Batch サービスによって発生したエラー。
名前 | 型 | 説明 |
---|---|---|
category |
ジョブ スケジュール エラーのカテゴリ。 |
|
code |
string |
ジョブ スケジュール エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。 |
details |
スケジュール エラーに関連する追加のエラーの詳細の一覧。 |
|
message |
string |
ユーザー インターフェイスでの表示に適したジョブ スケジュール エラーを説明するメッセージ。 |
JobState
ジョブの状態。
名前 | 型 | 説明 |
---|---|---|
active |
string |
ジョブは、タスクをスケジュールするために使用できます。 |
completed |
string |
すべてのタスクが終了し、システムはそれ以上のタスクやジョブに対するそれ以上の変更を受け入れなくなります。 |
deleting |
string |
ユーザーはジョブを削除することを要求しましたが、削除操作はまだ進行中です (たとえば、システムがまだ実行中のタスクを終了しているため)。 |
disabled |
string |
ユーザーがジョブを無効にしました。 タスクは実行されておらず、新しいタスクはスケジュールされません。 |
disabling |
string |
ユーザーはジョブを無効にすることを要求しましたが、無効化操作はまだ進行中です (たとえば、タスクの終了を待機しています)。 |
enabling |
string |
ユーザーはジョブを有効にすることを要求しましたが、有効化操作はまだ進行中です。 |
terminating |
string |
ジョブ マネージャー タスクが完了したか、ユーザーがジョブを終了したが、終了操作がまだ進行中であるため (たとえば、ジョブ 解放タスクが実行されているため)、ジョブが完了しようとしています。 |
JobStatistics
ジョブのリソース使用状況統計。
名前 | 型 | 説明 |
---|---|---|
kernelCPUTime |
string |
ジョブ内のすべてのタスクによって消費されるカーネル モードの CPU 時間の合計 (すべてのコアとすべてのコンピューティング ノードで合計)。 |
lastUpdateTime |
string |
統計が最後に更新された時刻。 すべての統計は、startTime と lastUpdateTime の間の範囲に制限されます。 |
numFailedTasks |
integer |
指定された時間範囲内に失敗したジョブ内のタスクの合計数。 |
numSucceededTasks |
integer |
指定された時間範囲内にジョブで正常に完了したタスクの合計数。 |
numTaskRetries |
integer |
指定された時間範囲内のジョブ内のすべてのタスクに対する再試行の合計数。 |
readIOGiB |
number |
ジョブ内のすべてのタスクによってディスクから読み取られた GiB 内のデータの合計量。 |
readIOps |
integer |
ジョブ内のすべてのタスクによって行われたディスク読み取り操作の合計数。 |
startTime |
string |
統計の対象となる時間範囲の開始時刻。 |
url |
string |
統計の URL。 |
userCPUTime |
string |
ジョブ内のすべてのタスクによって消費される合計ユーザー モードの CPU 時間 (すべてのコアとすべてのコンピューティング ノードで合計)。 |
waitTime |
string |
ジョブ内のすべてのタスクの合計待機時間。 |
wallClockTime |
string |
ジョブ内のすべてのタスクの合計ウォール クロック時間。 |
writeIOGiB |
number |
ジョブ内のすべてのタスクによってディスクに書き込まれた GiB 内のデータの合計量。 |
writeIOps |
integer |
ジョブ内のすべてのタスクによって行われたディスク書き込み操作の合計数。 |
LinuxUserConfiguration
Linux コンピューティング ノードでユーザー アカウントを作成するために使用されるプロパティ。
名前 | 型 | 説明 |
---|---|---|
gid |
integer |
ユーザー アカウントのグループ ID。 |
sshPrivateKey |
string |
ユーザー アカウントの SSH 秘密キー。 |
uid |
integer |
ユーザー アカウントのユーザー ID。 |
LoginMode
ユーザーのログイン モード
名前 | 型 | 説明 |
---|---|---|
batch |
string |
LOGON32_LOGON_BATCH Win32 ログイン モード。 バッチ ログイン モードは、実行時間の長い並列プロセスに推奨されます。 |
interactive |
string |
LOGON32_LOGON_INTERACTIVE Win32 ログイン モード。 UAC は、Windows VirtualMachineConfiguration プールで有効になっています。 このオプションを Windows VirtualMachineConfiguration プールの管理者特権ユーザー ID と共に使用する場合、タスク コマンド ラインによって実行されるアプリケーションが常に管理特権を必要とするか、常に最大特権を必要とするように構成されていない限り、ユーザー セッションは昇格されません。 |
ManagedDisk
名前 | 型 | 説明 |
---|---|---|
storageAccountType |
マネージド ディスクのストレージ アカウントの種類。 |
MetadataItem
Batch サービス リソースに関連付けられている名前と値のペア。
名前 | 型 | 説明 |
---|---|---|
name |
string |
メタデータ 項目の名前。 |
value |
string |
メタデータ項目の値。 |
MountConfiguration
各ノードにマウントするファイル システム。
名前 | 型 | 説明 |
---|---|---|
azureBlobFileSystemConfiguration |
各ノードで BLOB FUSE を使用してマウントする Azure Storage コンテナー。 |
|
azureFileShareConfiguration |
各ノードにマウントする Azure ファイル共有。 |
|
cifsMountConfiguration |
各ノードにマウントする CIFS/SMB ファイル システム。 |
|
nfsMountConfiguration |
各ノードにマウントする NFS ファイル システム。 |
NameValuePair
名前と値のペアを表します。
名前 | 型 | 説明 |
---|---|---|
name |
string |
名前と値のペアの名前。 |
value |
string |
名前と値のペアの値。 |
NetworkConfiguration
プールのネットワーク構成。
名前 | 型 | 説明 |
---|---|---|
dynamicVNetAssignmentScope |
動的 vnet 割り当てのスコープ。 |
|
enableAcceleratedNetworking |
boolean |
このプールで高速ネットワークを有効にする必要があるかどうか。 |
endpointConfiguration |
Batch プール内のコンピューティング ノード上のエンドポイントの構成。 |
|
publicIPAddressConfiguration |
Batch プール内のコンピューティング ノードのパブリック IPAddress 構成。 |
|
subnetId |
string |
プールのコンピューティング ノードが参加する仮想ネットワーク サブネットの ARM リソース識別子。 これは、/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet} の形式です。 |
NetworkSecurityGroupRule
受信エンドポイントに適用するネットワーク セキュリティ グループ規則。
名前 | 型 | 説明 |
---|---|---|
access |
指定した IP アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。 |
|
priority |
integer |
このルールの優先度。 |
sourceAddressPrefix |
string |
ルールに一致するソース アドレス プレフィックスまたはタグ。 |
sourcePortRanges |
string[] |
ルールに一致するソース ポート範囲。 |
NetworkSecurityGroupRuleAccess
指定した IP アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。
名前 | 型 | 説明 |
---|---|---|
allow |
string |
アクセスを許可します。 |
deny |
string |
アクセスを拒否します。 |
NFSMountConfiguration
NFS ファイル システムへの接続に使用される情報。
名前 | 型 | 説明 |
---|---|---|
mountOptions |
string |
mount コマンドに渡す追加のコマンド ライン オプション。 |
relativeMountPath |
string |
ファイル システムがマウントされるコンピューティング ノードの相対パス |
source |
string |
マウントするファイル システムの URI。 |
NodeCommunicationMode
プールが Batch サービスと通信する方法を決定します。
名前 | 型 | 説明 |
---|---|---|
classic |
string |
クラシック通信モードを使用するノードでは、"BatchNodeManagement" からのポート 29876 および 29877 で受信 TCP 通信が必要です。{region}" サービス タグとポート 443 の "Storage.region" および "BatchNodeManagement への送信 TCP 通信。{region}" サービス タグ。 |
default |
string |
ノード通信モードは、Batch サービスによって自動的に設定されます。 |
simplified |
string |
簡略化された通信モードを使用するノードでは、ポート 443 で "BatchNodeManagement" への送信 TCP 通信が必要です。{region}" サービス タグ。 開いている受信ポートは必要ありません。 |
NodePlacementConfiguration
プールのノード配置の構成。
名前 | 型 | 説明 |
---|---|---|
policy |
バッチ プールでのノード配置ポリシーの種類。 |
NodePlacementPolicyType
プール内のノードを割り当てる配置ポリシー。
名前 | 型 | 説明 |
---|---|---|
regional |
string |
プール内のすべてのノードが同じリージョンに割り当てられます。 |
zonal |
string |
プール内のノードは、ベスト エフォート分散によって異なる可用性ゾーンに分散されます。 |
OnAllTasksComplete
ジョブ内のすべてのタスクが完了状態のときに Batch サービスが実行する必要があるアクション。
名前 | 型 | 説明 |
---|---|---|
noaction |
string |
何もしない。 他の方法で終了または無効にしない限り、ジョブはアクティブなままになります。 |
terminatejob |
string |
ジョブを終了します。 ジョブの terminateReason が 'AllTasksComplete' に設定されています。 |
OnTaskFailure
ジョブ内のタスクが失敗したときに Batch サービスが実行する必要があるアクション。
名前 | 型 | 説明 |
---|---|---|
noaction |
string |
何もしない。 他の方法で終了または無効にしない限り、ジョブはアクティブなままになります。 |
performexitoptionsjobaction |
string |
タスクの exitConditions コレクションの Task 終了条件に関連付けられているアクションを実行します。 (タスクで指定されている場合は、アクションが実行されない可能性があります)。 |
OSDisk
コンピューティング ノード (VM) のオペレーティング システム ディスクの設定。
名前 | 型 | 説明 |
---|---|---|
caching |
キャッシュの要件を指定します。 使用できる値は、None、ReadOnly、ReadWrite です。 既定値は、標準ストレージの場合は [なし] です。 Premium Storage の ReadOnly。 |
|
diskSizeGB |
integer |
新しい OS ディスクを作成するときの初期ディスク サイズ (GB)。 |
ephemeralOSDiskSettings |
コンピューティング ノード (VM) によって使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。 |
|
managedDisk |
マネージド ディスク のパラメーター。 |
|
writeAcceleratorEnabled |
boolean |
ディスクで writeAccelerator を有効または無効にするかどうかを指定します。 |
OutputFile
Batch サービスがタスク プロセスの実行を完了した後に、Azure Batchコンピューティング ノードから別の場所にファイルをアップロードするための仕様。
名前 | 型 | 説明 |
---|---|---|
destination |
出力ファイルの出力先。 |
|
filePattern |
string |
アップロードするファイルを示すパターン。 |
uploadOptions |
アップロード操作の追加オプション (アップロードを実行する条件を含む)。 |
OutputFileBlobContainerDestination
Azure BLOB ストレージ コンテナー内のファイルアップロード先を指定します。
名前 | 型 | 説明 |
---|---|---|
containerUrl |
string |
ファイルをアップロードするAzure Blob Storage内のコンテナーの URL。 |
identityReference |
containerUrl で指定されたAzure Blob Storageにアクセスするために使用するユーザー割り当て ID への参照 |
|
path |
string |
Azure Storage コンテナー内の宛先 BLOB または仮想ディレクトリ。 |
uploadHeaders |
出力ファイルのアップロードで使用するヘッダーの名前と値のペアの一覧 |
OutputFileDestination
ファイルのアップロード先。
名前 | 型 | 説明 |
---|---|---|
container |
ファイルがアップロードされる Azure BLOB ストレージ内の場所。 |
OutputFileUploadCondition
タスク出力ファイルまたは一連のファイルをアップロードする条件。
名前 | 型 | 説明 |
---|---|---|
taskcompletion |
string |
終了コードに関係なく、タスク プロセスが終了した後にファイルをアップロードします。 |
taskfailure |
string |
タスク プロセスが 0 以外の終了コードで終了した後にのみ、ファイルをアップロードします。 |
tasksuccess |
string |
タスク プロセスが終了コード 0 で終了した後にのみ、ファイルをアップロードします。 |
OutputFileUploadOptions
アップロードを実行する条件など、出力ファイルのアップロード操作に関する詳細。
名前 | 型 | 説明 |
---|---|---|
uploadCondition |
タスク出力ファイルまたは一連のファイルをアップロードする条件。 |
PoolEndpointConfiguration
プールのエンドポイント構成。
名前 | 型 | 説明 |
---|---|---|
inboundNATPools |
個々のコンピューティング ノードの特定のポートを外部でアドレス指定するために使用できる受信 NAT プールの一覧。 |
PoolInformation
ジョブをプールに割り当てる方法を指定します。
名前 | 型 | 説明 |
---|---|---|
autoPoolSpecification |
一時的な '自動プール' の特性。 Batch サービスは、ジョブの送信時にこの自動プールを作成します。 |
|
poolId |
string |
既存のプールの ID。 ジョブのすべてのタスクは、指定されたプールで実行されます。 |
PoolLifetimeOption
作成された自動プールの最小有効期間と、スケジュール上の複数のジョブをプールに割り当てる方法。
名前 | 型 | 説明 |
---|---|---|
job |
string |
プールは、専用のジョブの有効期間中存在します。 Batch サービスは、ジョブの作成時にプールを作成します。 "job" オプションがジョブ スケジュールに適用されている場合、Batch サービスは、スケジュールに基づいて作成されたすべてのジョブに対して新しい自動プールを作成します。 |
jobschedule |
string |
プールは、ジョブ スケジュールの有効期間中存在します。 Batch サービスは、スケジュールに基づいて最初のジョブを作成するときにプールを作成します。 このオプションは、[ジョブ] ではなく [ジョブ スケジュール] にのみ適用できます。 |
PoolSpecification
新しいプールを作成するための仕様。
名前 | 型 | 説明 |
---|---|---|
applicationLicenses |
string[] |
Batch サービスがプール内の各コンピューティング ノードで使用できるようにするアプリケーション ライセンスの一覧。 |
applicationPackageReferences |
プール内の各コンピューティング ノードにインストールするパッケージの一覧。 |
|
autoScaleEvaluationInterval |
string |
自動スケーリングの数式に従ってプール サイズを自動的に調整する時間間隔。 |
autoScaleFormula |
string |
プール内のコンピューティング ノードの必要な数の数式。 |
certificateReferences |
プール内の各コンピューティング ノードにインストールする証明書の一覧。 警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに Azure KeyVault 拡張機能 を使用してください。 |
|
cloudServiceConfiguration |
プールのクラウド サービス構成。 |
|
displayName |
string |
プールの表示名。 |
enableAutoScale |
boolean |
プール サイズが時間の経過と同時に自動的に調整されるかどうか。 |
enableInterNodeCommunication |
boolean |
プールがコンピューティング ノード間の直接通信を許可するかどうか。 |
metadata |
プールにメタデータとして関連付けられている名前と値のペアの一覧。 |
|
mountConfiguration |
プール内の各ノードにマウントするファイル システムの一覧。 |
|
networkConfiguration |
プールのネットワーク構成。 |
|
resizeTimeout |
string |
プールへのコンピューティング ノードの割り当てのタイムアウト。 |
resourceTags |
object |
プールに関連付けられているユーザー指定のタグ。 |
startTask |
プールに参加する各コンピューティング ノードで実行するタスク。 タスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。 |
|
targetDedicatedNodes |
integer |
プール内の専用コンピューティング ノードの必要な数。 |
targetLowPriorityNodes |
integer |
プール内のスポット/低優先度コンピューティング ノードの必要な数。 |
targetNodeCommunicationMode |
プールの目的のノード通信モード。 |
|
taskSchedulingPolicy |
プール内のコンピューティング ノード間でタスクを分散する方法。 |
|
taskSlotsPerNode |
integer |
プール内の単一の計算ノードで同時実行タスクを実行するために使用できるタスク スロットの数。 |
userAccounts |
プール内の各コンピューティング ノードに作成されるユーザー アカウントの一覧。 |
|
virtualMachineConfiguration |
プールの仮想マシンの構成。 |
|
vmSize |
string |
プール内の仮想マシンのサイズ。 プール内のすべての仮想マシンのサイズは同じです。 |
PublicIPAddressConfiguration
プールのネットワーク構成のパブリック IP アドレス構成。
名前 | 型 | 説明 |
---|---|---|
ipAddressIds |
string[] |
Batch サービスがコンピューティング ノードのプロビジョニング時に使用するパブリック IP の一覧。 |
provision |
プールのパブリック IP アドレスのプロビジョニングの種類。 |
ResourceFile
コンピューティング ノードにダウンロードする 1 つのファイルまたは複数のファイル。
名前 | 型 | 説明 |
---|---|---|
autoStorageContainerName |
string |
自動ストレージ アカウント内のストレージ コンテナー名。 |
blobPrefix |
string |
Azure Storage コンテナーから BLOB をダウンロードするときに使用する BLOB プレフィックス。 指定したプレフィックスで始まる名前の BLOB のみがダウンロードされます。 |
fileMode |
string |
ファイルアクセス許可モード属性 (8 進数形式)。 |
filePath |
string |
タスクの作業ディレクトリを基準にして、ファイルをダウンロードするコンピューティング ノード上の場所。 |
httpUrl |
string |
ダウンロードするファイルの URL。 |
identityReference |
storageContainerUrl または httpUrl で指定されたAzure Blob Storageにアクセスするために使用するユーザー割り当て ID への参照 |
|
storageContainerUrl |
string |
Azure Blob Storage内の BLOB コンテナーの URL。 |
SecurityProfile
仮想マシンまたは仮想マシン スケール セットのセキュリティ プロファイル設定を指定します。
名前 | 型 | 説明 |
---|---|---|
encryptionAtHost |
boolean |
このプロパティは、要求のユーザーが仮想マシンまたは仮想マシン スケール セットの Host Encryption を有効または無効にするために使用できます。 これにより、ホスト自体のリソース/一時ディスクを含むすべてのディスクの暗号化が有効になります。 |
securityType |
仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。 |
|
uefiSettings |
仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。 |
SecurityTypes
仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。
名前 | 型 | 説明 |
---|---|---|
trustedLaunch |
string |
トラステッド起動により、高度で永続的な攻撃手法から保護されます。 |
ServiceArtifactReference
'latest' イメージ バージョンを使用する場合に、スケール セット内のすべての仮想マシンに同じイメージ バージョンを設定するために使用されるサービス成果物参照 ID を指定します。
名前 | 型 | 説明 |
---|---|---|
id |
string |
ServiceArtifactReference のサービス成果物参照 ID |
StartTask
ノードがAzure Batch サービスのプールに参加したとき、またはコンピューティング ノードが再起動または再イメージ化されたときに実行されるタスク。
名前 | 型 | 説明 |
---|---|---|
commandLine |
string |
StartTask のコマンド ライン。 |
containerSettings |
StartTask が実行されるコンテナーの設定。 |
|
environmentSettings |
StartTask の環境変数設定の一覧。 |
|
maxTaskRetryCount |
integer |
タスクを再試行できる最大回数。 |
resourceFiles |
コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 リソース ファイルの一覧には最大サイズがあります。 最大サイズを超えると、要求は失敗し、応答エラー コードは RequestEntityTooLarge になります。 この場合、ResourceFiles のコレクションのサイズを小さくする必要があります。 これは、.zip ファイル、アプリケーション パッケージ、または Docker コンテナーを使用して実現できます。 |
|
userIdentity |
StartTask を実行するユーザー ID。 |
|
waitForSuccess |
boolean |
コンピューティング ノードでタスクをスケジュールする前に、Batch サービスが StartTask が正常に完了するまで (つまり終了コード 0 で終了する) のを待つ必要があるかどうか。 |
StorageAccountType
データ ディスクまたは OS ディスクの作成に使用するストレージ アカウントの種類。
名前 | 型 | 説明 |
---|---|---|
premium_lrs |
string |
データ ディスク/OS ディスクでは、Premium ローカル冗長ストレージを使用する必要があります。 |
standard_lrs |
string |
データ ディスク/OS ディスクでは、標準のローカル冗長ストレージを使用する必要があります。 |
standardssd_lrs |
string |
データ ディスク/OS ディスクでは、Standard SSD のローカル冗長ストレージを使用する必要があります。 |
TaskConstraints
タスクに適用する実行制約。
名前 | 型 | 説明 |
---|---|---|
maxTaskRetryCount |
integer |
タスクを再試行できる最大回数。 終了コードが 0 以外の場合、Batch サービスは Task を再試行します。 |
maxWallClockTime |
string |
タスクが実行できる最大経過時間。タスクの開始時間から測定されます。 タスクが制限時間内に完了しない場合は、Batch サービスによって終了されます。 |
retentionTime |
string |
実行が完了してから実行されたコンピューティング ノード上の Task ディレクトリを保持する最小時間。 この時間が経過すると、Batch サービスによって Task ディレクトリとそのすべての内容が削除される可能性があります。 |
TaskContainerSettings
タスクのコンテナー設定。
名前 | 型 | 説明 |
---|---|---|
containerRunOptions |
string |
コンテナー作成コマンドの追加オプション。 |
imageName |
string |
タスクを実行するコンテナーの作成に使用するイメージ。 |
registry |
コンテナー イメージを含むプライベート レジストリ。 |
|
workingDirectory |
コンテナー Task 作業ディレクトリの場所。 |
TaskSchedulingPolicy
タスクをコンピューティング ノード間で分散する方法を指定します。
名前 | 型 | 説明 |
---|---|---|
nodeFillType |
プール内のコンピューティング ノード間でタスクを分散する方法。 |
UefiSettings
仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。
名前 | 型 | 説明 |
---|---|---|
secureBootEnabled |
boolean |
仮想マシンでセキュア ブートを有効にするかどうかを指定します。 |
vTpmEnabled |
boolean |
仮想マシンで vTPM を有効にするかどうかを指定します。 |
UserAccount
Azure Batchコンピューティング ノードでタスクを実行するために使用するユーザーの作成に使用されるプロパティ。
名前 | 型 | 説明 |
---|---|---|
elevationLevel |
ユーザー アカウントの昇格レベル。 |
|
linuxUserConfiguration |
ユーザー アカウントの Linux 固有のユーザー構成。 |
|
name |
string |
ユーザー アカウントの名前。 名前には、最大 20 文字までの Unicode 文字を含めることができます。 |
password |
string |
ユーザー アカウントのパスワード。 |
windowsUserConfiguration |
ユーザー アカウントの Windows 固有のユーザー構成。 |
UserIdentity
タスクを実行するユーザー ID の定義。
名前 | 型 | 説明 |
---|---|---|
autoUser |
タスクを実行する自動ユーザー。 |
|
username |
string |
タスクを実行するユーザー ID の名前。 |
VirtualMachineConfiguration
Azure Virtual Machines インフラストラクチャに基づくプール内のコンピューティング ノードの構成。
名前 | 型 | 説明 |
---|---|---|
containerConfiguration |
プールのコンテナー構成。 |
|
dataDisks |
Data |
プール内のコンピューティング ノードに接続されているデータ ディスクの構成。 |
diskEncryptionConfiguration |
プールのディスク暗号化構成。 |
|
extensions |
プールの仮想マシン拡張機能。 |
|
imageReference |
使用する Azure Virtual Machines Marketplace イメージまたはカスタム仮想マシン イメージへの参照。 |
|
licenseType |
string |
オペレーティング システムの展開時に使用するオンプレミス ライセンスの種類。 Windows_Server - オンプレミス ライセンスは Windows Server 用です。 Windows_Client - オンプレミス ライセンスは Windows クライアント用です。 |
nodeAgentSKUId |
string |
プール内のコンピューティング ノードにプロビジョニングされる Batch コンピューティング ノード エージェントの SKU。 |
nodePlacementConfiguration |
プールのノード配置構成。 |
|
osDisk |
仮想マシンのオペレーティング システム ディスクの設定。 |
|
securityProfile |
仮想マシンまたは仮想マシン スケール セットのセキュリティ プロファイル設定を指定します。 |
|
serviceArtifactReference |
'latest' イメージ バージョンを使用する場合に、スケール セット内のすべての仮想マシンに同じイメージ バージョンを設定するために使用されるサービス成果物参照 ID を指定します。 |
|
windowsConfiguration |
仮想マシン上の Windows オペレーティング システムの設定。 |
VMExtension
仮想マシン拡張機能の構成。
名前 | 型 | 説明 |
---|---|---|
autoUpgradeMinorVersion |
boolean |
展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用するかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。 |
enableAutomaticUpgrade |
boolean |
使用可能な拡張機能の新しいバージョンがある場合に、プラットフォームによって拡張機能を自動的にアップグレードするかどうかを示します。 |
name |
string |
仮想マシン拡張機能の名前。 |
protectedSettings |
object |
拡張機能には、protectedSettings または protectedSettingsFromKeyVault を含めることも、保護された設定をまったく含めることもできます。 |
provisionAfterExtensions |
string[] |
拡張名のコレクション。 |
publisher |
string |
拡張ハンドラーパブリッシャーの名前。 |
settings |
object |
拡張機能の JSON 形式のパブリック設定。 |
type |
string |
拡張機能の型。 |
typeHandlerVersion |
string |
スクリプト ハンドラーのバージョン。 |
WindowsConfiguration
仮想マシンに適用する Windows オペレーティング システムの設定。
名前 | 型 | 説明 |
---|---|---|
enableAutomaticUpdates |
boolean |
仮想マシンで自動更新が有効になっているかどうか。 |
WindowsUserConfiguration
Windows コンピューティング ノードでユーザー アカウントを作成するために使用されるプロパティ。
名前 | 型 | 説明 |
---|---|---|
loginMode |
ユーザーのログイン モード |