Pool - Get
指定したプールに関する情報を取得します。
GET {batchUrl}/pools/{poolId}?api-version=2023-11-01.18.0
GET {batchUrl}/pools/{poolId}?$select={$select}&$expand={$expand}&timeout={timeout}&api-version=2023-11-01.18.0
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
batch
|
path | True |
string |
すべてのAzure Batchサービス要求のベース URL。 |
pool
|
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 |
Pool を含む応答。 ヘッダー
|
|
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
例
Add a VirtualMachineConfiguration pool with OS disk
要求のサンプル
GET account.region.batch.azure.com/pools/mypool001?api-version=2023-11-01.18.0
応答のサンプル
{
"id": "mypool001",
"url": "http://localhost:20302/testaccount1tls/pools/mypool001",
"eTag": "0x8DBA3B4E91CD7B7",
"lastModified": "2023-08-23T08:42:40.3479479Z",
"creationTime": "2023-08-23T08:42:40.3479479Z",
"state": "active",
"stateTransitionTime": "2023-08-23T08:42:40.3479479Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2023-08-23T08:42:53.8587829Z",
"vmSize": "standard_d2s_v3",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 1,
"targetDedicatedNodes": 1,
"currentLowPriorityNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "0001-com-ubuntu-server-focal",
"sku": "20_04-lts",
"version": "latest"
},
"osDisk": {
"ephemeralOSDiskSettings": {
"placement": "CacheDisk"
},
"managedDisk": {
"storageAccountType": "standardssd_lrs"
},
"diskSizeGB": 100,
"caching": "readwrite"
},
"nodeAgentSKUId": "batch.node.ubuntu 20.04"
},
"currentNodeCommunicationMode": "classic"
}
Get a pool with AcceleratedNetworking
要求のサンプル
GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0
応答のサンプル
{
"id": "pool",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8DB4792BE8566A2",
"lastModified": "2023-04-28T02:46:19.0268066Z",
"creationTime": "2023-04-28T02:46:19.0268066Z",
"state": "active",
"stateTransitionTime": "2023-04-28T02:46:19.0268066Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2023-04-28T02:47:17.9169655Z",
"vmSize": "standard_d1_v2",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 2,
"targetDedicatedNodes": 2,
"currentLowPriorityNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2016-datacenter-smalldisk",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.windows amd64"
},
"networkConfiguration": {
"dynamicVNetAssignmentScope": "none",
"enableAcceleratedNetworking": true
},
"currentNodeCommunicationMode": "classic"
}
Get a VirtualMachineConfiguration pool with extensions
要求のサンプル
GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0
応答のサンプル
{
"id": "pool",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8D413091E739A56",
"lastModified": "2016-11-22T18:55:25.2608598Z",
"creationTime": "2016-11-22T18:55:24.2632496Z",
"state": "active",
"stateTransitionTime": "2016-11-22T18:55:24.2632496Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z",
"vmSize": "standard_a1",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 0,
"currentLowPriorityNodes": 0,
"targetDedicatedNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"startTask": {
"commandLine": "/bin/bash -c 'echo start task'",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "0001-com-ubuntu-server-focal",
"sku": "20_04-lts",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.ubuntu 20.04",
"extensions": [
{
"name": "batchextension1",
"type": "KeyVaultForLinux",
"publisher": "Microsoft.Azure.KeyVault",
"typeHandlerVersion": "2.0",
"autoUpgradeMinorVersion": true,
"enableAutomaticUpgrade": true,
"settings": "{\"secretsManagementSettingsKey\":\"secretsManagementSettingsValue\",\"authenticationSettingsKey\":\"authenticationSettingsValue\"}"
}
]
},
"targetNodeCommunicationMode": "classic",
"currentNodeCommunicationMode": "classic"
}
Get a VirtualMachineConfiguration pool with SecurityProfile
要求のサンプル
GET account.region.batch.azure.com/pools/mypool001?api-version=2023-11-01.18.0
応答のサンプル
{
"id": "mypool001",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8DB6CA2DFF530D1",
"lastModified": "2023-06-14T06:45:00.0946897Z",
"creationTime": "2023-06-14T06:45:00.0946897Z",
"state": "active",
"stateTransitionTime": "2023-06-14T06:45:00.0946897Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2023-06-14T06:45:59.4770341Z",
"vmSize": "standard_dc2s_v2",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 1,
"targetDedicatedNodes": 1,
"currentLowPriorityNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "UbuntuServer",
"sku": "18_04-lts-gen2",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.ubuntu 18.04",
"securityProfile": {
"securityType": "trustedLaunch",
"encryptionAtHost": true,
"uefiSettings": {
"secureBootEnabled": false
}
}
},
"currentNodeCommunicationMode": "classic"
}
Get a VirtualMachineConfiguration pool with ServiceArtifactReference
要求のサンプル
GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0
応答のサンプル
{
"id": "pool",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8DB51F652DFC78F",
"lastModified": "2023-05-11T08:04:19.7259151Z",
"creationTime": "2023-05-11T08:04:19.7259151Z",
"state": "active",
"stateTransitionTime": "2023-05-11T08:04:19.7259151Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2023-05-11T08:05:22.0020052Z",
"vmSize": "standard_a1_v2",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 2,
"targetDedicatedNodes": 2,
"currentLowPriorityNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2016-datacenter-smalldisk",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.windows amd64",
"windowsConfiguration": {
"enableAutomaticUpdates": false
},
"serviceArtifactReference": {
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile"
}
},
"currentNodeCommunicationMode": "classic"
}
Pool get
要求のサンプル
GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0
応答のサンプル
{
"id": "pool",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8D413091E739A56",
"lastModified": "2016-11-22T18:55:25.2608598Z",
"creationTime": "2016-11-22T18:55:24.2632496Z",
"state": "active",
"stateTransitionTime": "2016-11-22T18:55:24.2632496Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z",
"vmSize": "standard_a1",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 0,
"currentLowPriorityNodes": 0,
"targetDedicatedNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"startTask": {
"commandLine": "/bin/bash -c 'echo start task'",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "0001-com-ubuntu-server-focal",
"sku": "20_04-lts",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.ubuntu 20.04"
}
}
定義
名前 | 説明 |
---|---|
Allocation |
プールのサイズを変更するかどうか。 |
Application |
コンピューティング ノードにデプロイするパッケージへの参照。 |
Auto |
プールの自動スケーリング式の実行の結果とエラー。 |
Auto |
プールの自動スケーリング式を実行または評価するときに発生したエラー。 |
Auto |
自動ユーザーのスコープ |
Auto |
Batch サービスで Task を実行する自動ユーザーのパラメーターを指定します。 |
Azure |
Blobfuse を使用して Azure Storage コンテナーに接続するために使用される情報。 |
Azure |
Azure Fileshare への接続に使用される情報。 |
Batch |
Azure Batch サービスから受信したエラー応答。 |
Batch |
Azure Batchエラー応答に含まれる追加情報の項目。 |
Batch |
Batch プールの ID (構成されている場合)。 |
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 イメージで作成された Linux プールではサポートされていません。 |
Disk |
Batch Service がコンピューティング ノードで暗号化するディスク ターゲットの一覧。 |
Dynamic |
動的 vnet 割り当てのスコープ。 |
Elevation |
ユーザーの昇格レベル。 |
Environment |
タスク プロセスで設定する環境変数。 |
Error |
Azure Batch エラー応答で受信したエラー メッセージ。 |
Image |
Azure Virtual Machines Marketplace イメージまたは Azure Compute Gallery イメージへの参照。 Azure Batchによって検証されたすべてのAzure Marketplaceイメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。 |
Inbound |
エンドポイントのプロトコル。 |
Inbound |
Batch プール内のコンピューティング ノード上の特定のポートを外部でアドレス指定するために使用できる受信 NAT プール。 |
IPAddress |
プールのパブリック IP アドレスのプロビジョニングの種類。 |
Linux |
Linux コンピューティング ノードでユーザー アカウントを作成するために使用されるプロパティ。 |
Login |
ユーザーのログイン モード |
Managed |
|
Metadata |
Batch サービス リソースに関連付けられている名前と値のペア。 |
Mount |
各ノードにマウントするファイル システム。 |
Name |
名前と値のペアを表します。 |
Network |
プールのネットワーク構成。 |
Network |
受信エンドポイントに適用するネットワーク セキュリティ グループ規則。 |
Network |
指定した IP アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。 |
NFSMount |
NFS ファイル システムへの接続に使用される情報。 |
Node |
プールが Batch サービスと通信する方法を決定します。 |
Node |
プールのノード配置の構成。 |
Node |
プール内のノードを割り当てる配置ポリシー。 |
OSDisk |
コンピューティング ノード (VM) のオペレーティング システム ディスクの設定。 |
Pool |
プールのエンドポイント構成。 |
Pool |
Batch プールの ID (構成されている場合)。 |
Pool |
プールの現在の状態。 |
Pool |
プールの有効期間の使用率とリソース使用量の統計情報が含まれます。 |
Public |
プールのネットワーク構成のパブリック IP アドレス構成。 |
Resize |
プールのサイズを変更するときに発生したエラー。 |
Resource |
コンピューティング ノードにダウンロードする 1 つのファイルまたは複数のファイル。 |
Resource |
プール内のコンピューティング ノード別のリソース消費に関連する統計。 |
Security |
仮想マシンまたは仮想マシン スケール セットのセキュリティ プロファイル設定を指定します。 |
Security |
仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。 |
Service |
'latest' イメージ バージョンを使用する場合に、スケール セット内のすべての仮想マシンに同じイメージ バージョンを設定するために使用されるサービス成果物参照 ID を指定します。 |
Start |
ノードがAzure Batch サービスのプールに参加したとき、またはコンピューティング ノードが再起動または再イメージ化されたときに実行されるタスク。 |
Storage |
データ ディスクまたは OS ディスクの作成に使用するストレージ アカウントの種類。 |
Task |
タスクのコンテナー設定。 |
Task |
コンピューティング ノード間でタスクを分散する方法を指定します。 |
Uefi |
仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。 |
Usage |
プールの使用状況情報に関連する統計。 |
User |
Azure Batch コンピューティング ノードでタスクを実行するために使用するユーザーの作成に使用されるプロパティ。 |
User |
ユーザー割り当て ID |
User |
タスクを実行するユーザー ID の定義。 |
Virtual |
Azure Virtual Machines インフラストラクチャに基づくプール内のコンピューティング ノードの構成。 |
VMExtension |
仮想マシン拡張機能の構成。 |
Windows |
仮想マシンに適用する Windows オペレーティング システムの設定。 |
Windows |
Windows コンピューティング ノードでユーザー アカウントを作成するために使用されるプロパティ。 |
AllocationState
プールのサイズを変更するかどうか。
名前 | 型 | 説明 |
---|---|---|
resizing |
string |
プールのサイズが変更されています。つまり、コンピューティング ノードはプールに追加されているか、プールから削除されます。 |
steady |
string |
プールのサイズが変更されていません。 進行中のプール内のコンピューティング ノードの数に変更はありません。 プールが作成され、コンピューティング ノードの数を変更する操作がプールに対して実行されていない場合に、この状態になります。 |
stopping |
string |
プールのサイズは変更されましたが、ユーザーはサイズ変更の停止を要求しましたが、停止要求はまだ完了していません。 |
ApplicationPackageReference
コンピューティング ノードにデプロイするパッケージへの参照。
名前 | 型 | 説明 |
---|---|---|
applicationId |
string |
デプロイするアプリケーションの ID。 |
version |
string |
デプロイするアプリケーションのバージョン。 省略すると、既定のバージョンがデプロイされます。 |
AutoScaleRun
プールの自動スケーリング式の実行の結果とエラー。
名前 | 型 | 説明 |
---|---|---|
error |
評価が失敗した場合に、プールで自動スケーリング式を評価するときに発生したエラーの詳細。 |
|
results |
string |
自動スケーリング式の評価で使用されるすべての変数の最終的な値。 |
timestamp |
string |
自動スケーリング式が最後に評価された時刻。 |
AutoScaleRunError
プールの自動スケーリング式を実行または評価するときに発生したエラー。
名前 | 型 | 説明 |
---|---|---|
code |
string |
自動スケーリング エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。 |
message |
string |
ユーザー インターフェイスでの表示に適した自動スケーリング エラーを説明するメッセージ。 |
values |
自動スケーリング エラーに関連する追加のエラーの詳細の一覧。 |
AutoUserScope
自動ユーザーのスコープ
名前 | 型 | 説明 |
---|---|---|
pool |
string |
タスクが、プール内のすべてのコンピューティング ノードで作成される共通の自動ユーザー アカウントとして実行されるように指定します。 |
task |
string |
サービスがタスクの新しいユーザーを作成することを指定します。 |
AutoUserSpecification
Batch サービスで Task を実行する自動ユーザーのパラメーターを指定します。
名前 | 型 | 説明 |
---|---|---|
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 |
エラー応答に含まれる追加情報。 |
BatchPoolIdentity
Batch プールの ID (構成されている場合)。
名前 | 型 | 説明 |
---|---|---|
type |
Batch プールの ID (構成されている場合)。 |
|
userAssignedIdentities |
Batch アカウントに関連付けられているユーザー ID の一覧。 |
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 ファイル システムに対する認証に使用するユーザー。 |
CloudPool
Azure Batch サービス内のプール。
名前 | 型 | 説明 |
---|---|---|
allocationState |
プールのサイズを変更するかどうか。 |
|
allocationStateTransitionTime |
string |
プールが現在の割り当て状態になった時刻。 |
applicationLicenses |
string[] |
Batch サービスがプール内の各コンピューティング ノードで使用できるようにするアプリケーション ライセンスの一覧。 |
applicationPackageReferences |
プール内の各コンピューティング ノードにインストールするパッケージの一覧。 |
|
autoScaleEvaluationInterval |
string |
自動スケーリング式に従ってプール サイズを自動的に調整する時間間隔。 |
autoScaleFormula |
string |
プール内のコンピューティング ノードの必要な数の数式。 |
autoScaleRun |
自動スケーリング式の最後の実行の結果とエラー。 |
|
certificateReferences |
プール内の各コンピューティング ノードにインストールされる証明書の一覧。 警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに Azure KeyVault 拡張機能 を使用してください。 |
|
cloudServiceConfiguration |
プールのクラウド サービス構成。 |
|
creationTime |
string |
プールの作成時刻。 |
currentDedicatedNodes |
integer |
プール内の現在の専用コンピューティング ノードの数。 |
currentLowPriorityNodes |
integer |
プール内の現在のスポット/低優先度コンピューティング ノードの数。 |
currentNodeCommunicationMode |
プール通信モードの現在の状態。 |
|
displayName |
string |
プールの表示名。 |
eTag |
string |
プールの ETag。 |
enableAutoScale |
boolean |
プール のサイズが時間の経過と同時に自動的に調整されるかどうか。 |
enableInterNodeCommunication |
boolean |
プールがコンピューティング ノード間の直接通信を許可するかどうか。 |
id |
string |
アカウント内のプールを一意に識別する文字列。 |
identity |
Batch プールの ID (構成されている場合)。 |
|
lastModified |
string |
プールの最終変更時刻。 |
metadata |
プールにメタデータとして関連付けられている名前と値のペアの一覧。 |
|
mountConfiguration |
プール内の各ノードにマウントするファイル システムの一覧。 |
|
networkConfiguration |
プールのネットワーク構成。 |
|
resizeErrors |
プールで最後のサイズ変更の実行中に発生したエラーの一覧。 |
|
resizeTimeout |
string |
プールへのコンピューティング ノードの割り当てのタイムアウト。 |
resourceTags |
object |
プールに関連付けられているユーザー指定のタグ。 |
startTask |
プールに参加する各コンピューティング ノードで実行するように指定されたタスク。 |
|
state |
プールの現在の状態。 |
|
stateTransitionTime |
string |
プールが現在の状態になった時刻。 |
stats |
プールの有効期間全体の使用率とリソース使用状況の統計。 |
|
targetDedicatedNodes |
integer |
プール内の専用コンピューティング ノードの必要な数。 |
targetLowPriorityNodes |
integer |
プール内のスポット/低優先度コンピューティング ノードの必要な数。 |
targetNodeCommunicationMode |
プールの目的のノード通信モード。 |
|
taskSchedulingPolicy |
プール内のコンピューティング ノード間でタスクを分散する方法。 |
|
taskSlotsPerNode |
integer |
プール内の単一の計算ノードで同時実行タスクを実行するために使用できるタスク スロットの数。 |
url |
string |
プールの URL。 |
userAccounts |
プール内の各コンピューティング ノードに作成するユーザー アカウントの一覧。 |
|
virtualMachineConfiguration |
プールの仮想マシンの構成。 |
|
vmSize |
string |
プール内の仮想マシンのサイズ。 プール内のすべての仮想マシンのサイズは同じです。 |
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 によって設定されたタスク リソース ファイルが含まれる標準の Batch サービスタスク作業ディレクトリを使用します。 |
DataDisk
プール内のコンピューティング ノードに関連付けられているデータ ディスクによって使用される設定。 添付データ ディスクを含める場合は、それらを使用する VM 内からディスクを マウントおよびフォーマットする必要があります。
名前 | 型 | 説明 |
---|---|---|
caching |
データ ディスクに対して有効にするキャッシュの種類。 |
|
diskSizeGB |
integer |
初期ディスク サイズ (ギガバイト単位)。 |
lun |
integer |
論理ユニット番号。 |
storageAccountType |
データ ディスクに使用するストレージ アカウントの種類。 |
DiffDiskPlacement
プール内のすべてのコンピューティング ノード (VM) のオペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。
名前 | 型 | 説明 |
---|---|---|
CacheDisk |
string |
エフェメラル OS ディスクは VM キャッシュに格納されます。 |
DiffDiskSettings
コンピューティング ノード (VM) によって使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。
名前 | 型 | 説明 |
---|---|---|
placement |
プール内のすべての VM のオペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。 |
DiskEncryptionConfiguration
プール内のコンピューティング ノードに適用されるディスク暗号化構成。 ディスク暗号化の構成は、Azure Compute Gallery イメージで作成された 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 |
環境変数の値。 |
ErrorMessage
Azure Batch エラー応答で受信したエラー メッセージ。
名前 | 型 | 説明 |
---|---|---|
lang |
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/{resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleryName}/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} または /subscriptions/{resourceGroup}/{resourceGroup}/providers/Microsoft.Compute/gallery/gallerys/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 はユーザーによって提供され、コンピューティング ノードのプロビジョニングに使用されます。 |
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 |
Batch プールでのノード配置ポリシーの種類。 |
NodePlacementPolicyType
プール内のノードを割り当てる配置ポリシー。
名前 | 型 | 説明 |
---|---|---|
regional |
string |
プール内のすべてのノードは、同じリージョンに割り当てられます。 |
zonal |
string |
プール内のノードは、ベスト エフォート分散によって異なる可用性ゾーンに分散されます。 |
OSDisk
コンピューティング ノード (VM) のオペレーティング システム ディスクの設定。
名前 | 型 | 説明 |
---|---|---|
caching |
キャッシュの要件を指定します。 使用できる値は、None、ReadOnly、ReadWrite です。 既定値は、Standard Storage の場合は [なし] です。 Premium Storage の ReadOnly。 |
|
diskSizeGB |
integer |
新しい OS ディスクを作成するときの初期ディスク サイズ (GB)。 |
ephemeralOSDiskSettings |
コンピューティング ノード (VM) によって使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。 |
|
managedDisk |
マネージド ディスクのパラメーター。 |
|
writeAcceleratorEnabled |
boolean |
ディスクで writeAccelerator を有効または無効にするかどうかを指定します。 |
PoolEndpointConfiguration
プールのエンドポイント構成。
名前 | 型 | 説明 |
---|---|---|
inboundNATPools |
個々のコンピューティング ノードの特定のポートを外部でアドレス指定するために使用できる受信 NAT プールの一覧。 |
PoolIdentityType
Batch プールの ID (構成されている場合)。
名前 | 型 | 説明 |
---|---|---|
None |
string |
バッチ プールには、関連付けられている ID がありません。 更新プールで を設定 |
UserAssigned |
string |
Batch プールには、ユーザー割り当て ID が含まれています。 |
PoolState
プールの現在の状態。
名前 | 型 | 説明 |
---|---|---|
active |
string |
プールは、コンピューティング ノードの可用性に応じてタスクを実行できます。 |
deleting |
string |
ユーザーはプールの削除を要求しましたが、削除操作はまだ完了していません。 |
PoolStatistics
プールの有効期間の使用率とリソース使用量の統計情報が含まれます。
名前 | 型 | 説明 |
---|---|---|
lastUpdateTime |
string |
統計が最後に更新された時刻。 すべての統計は、startTime と lastUpdateTime の間の範囲に制限されます。 |
resourceStats |
プール内のコンピューティング ノード別のリソース消費に関連する統計。 |
|
startTime |
string |
統計の対象となる時間範囲の開始時刻。 |
url |
string |
統計の URL。 |
usageStats |
プールの使用状況に関連する統計 (使用されたコア時間の量など)。 |
PublicIPAddressConfiguration
プールのネットワーク構成のパブリック IP アドレス構成。
名前 | 型 | 説明 |
---|---|---|
ipAddressIds |
string[] |
コンピューティング ノードのプロビジョニング時に Batch サービスが使用するパブリック IP の一覧。 |
provision |
プールのパブリック IP アドレスのプロビジョニングの種類。 |
ResizeError
プールのサイズを変更するときに発生したエラー。
名前 | 型 | 説明 |
---|---|---|
code |
string |
プールサイズ変更エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。 |
message |
string |
ユーザー インターフェイスでの表示に適したプールサイズ変更エラーを説明するメッセージ。 |
values |
プールのサイズ変更エラーに関連する追加のエラーの詳細の一覧。 |
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。 |
ResourceStatistics
プール内のコンピューティング ノード別のリソース消費に関連する統計。
名前 | 型 | 説明 |
---|---|---|
avgCPUPercentage |
number |
プール内のすべてのコンピューティング ノードの平均 CPU 使用率 (ノードあたりの割合)。 |
avgDiskGiB |
number |
プール内のすべてのコンピューティング ノードの GiB の平均使用ディスク領域。 |
avgMemoryGiB |
number |
プール内のすべてのコンピューティング ノードにおける GiB の平均メモリ使用量。 |
diskReadGiB |
number |
プール内のすべてのコンピューティング ノードに対するディスク読み取りの GiB 内のデータの合計量。 |
diskReadIOps |
integer |
プール内のすべてのコンピューティング ノードに対するディスク読み取り操作の合計数。 |
diskWriteGiB |
number |
プール内のすべてのコンピューティング ノードに対するディスク書き込みの GiB 内のデータの合計量。 |
diskWriteIOps |
integer |
プール内のすべてのコンピューティング ノードに対するディスク書き込み操作の合計数。 |
lastUpdateTime |
string |
統計が最後に更新された時刻。 すべての統計は、startTime と lastUpdateTime の間の範囲に制限されます。 |
networkReadGiB |
number |
プール内のすべてのコンピューティング ノードに対するネットワーク読み取りの GiB 内のデータの合計量。 |
networkWriteGiB |
number |
プール内のすべてのコンピューティング ノードに対するネットワーク書き込みの GiB 内のデータの合計量。 |
peakDiskGiB |
number |
プール内のすべてのコンピューティング ノードで GiB で使用されたディスク領域のピーク。 |
peakMemoryGiB |
number |
プール内のすべてのコンピューティング ノードでの GiB でのメモリ使用量のピーク。 |
startTime |
string |
統計の対象となる時間範囲の開始時刻。 |
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 ローカル冗長ストレージを使用する必要があります。 |
TaskContainerSettings
タスクのコンテナー設定。
名前 | 型 | 説明 |
---|---|---|
containerRunOptions |
string |
コンテナー作成コマンドの追加オプション。 |
imageName |
string |
タスクを実行するコンテナーの作成に使用するイメージ。 |
registry |
コンテナー イメージを含むプライベート レジストリ。 |
|
workingDirectory |
コンテナー Task 作業ディレクトリの場所。 |
TaskSchedulingPolicy
コンピューティング ノード間でタスクを分散する方法を指定します。
名前 | 型 | 説明 |
---|---|---|
nodeFillType |
プール内のコンピューティング ノード間でタスクを分散する方法。 |
UefiSettings
仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。
名前 | 型 | 説明 |
---|---|---|
secureBootEnabled |
boolean |
仮想マシンでセキュア ブートを有効にするかどうかを指定します。 |
vTpmEnabled |
boolean |
仮想マシンで vTPM を有効にするかどうかを指定します。 |
UsageStatistics
プールの使用状況情報に関連する統計。
名前 | 型 | 説明 |
---|---|---|
dedicatedCoreTime |
string |
プールの一部である専用のコンピューティング ノード コアの集約されたウォール クロック時間。 |
lastUpdateTime |
string |
統計が最後に更新された時刻。 すべての統計は、startTime と lastUpdateTime の間の範囲に制限されます。 |
startTime |
string |
統計の対象となる時間範囲の開始時刻。 |
UserAccount
Azure Batch コンピューティング ノードでタスクを実行するために使用するユーザーの作成に使用されるプロパティ。
名前 | 型 | 説明 |
---|---|---|
elevationLevel |
ユーザー アカウントの昇格レベル。 |
|
linuxUserConfiguration |
ユーザー アカウントの Linux 固有のユーザー構成。 |
|
name |
string |
ユーザー アカウントの名前。 名前には、最大 20 文字までの任意の Unicode 文字を含めることができます。 |
password |
string |
ユーザー アカウントのパスワード。 |
windowsUserConfiguration |
ユーザー アカウントの Windows 固有のユーザー構成。 |
UserAssignedIdentity
ユーザー割り当て ID
名前 | 型 | 説明 |
---|---|---|
clientId |
string |
ユーザー割り当て ID のクライアント ID。 |
principalId |
string |
ユーザー割り当て ID のプリンシパル ID。 |
resourceId |
string |
ユーザー割り当て ID の ARM リソース ID |
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 |
ユーザーのログイン モード |