Pool - Get

サービス:

Batch Service

API バージョン:

2024-07-01.20.0

指定したプールに関する情報を取得します。

GET {batchUrl}/pools/{poolId}?api-version=2024-07-01.20.0

省略可能なパラメーターを含む:

GET {batchUrl}/pools/{poolId}?$select={$select}&$expand={$expand}&timeout={timeout}&api-version=2024-07-01.20.0

URI パラメーター

名前	/	必須	型	説明
batchUrl	path	True	string	すべての Azure Batch サービス要求のベース URL。
poolId	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 秒です。 値が 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	CloudPool	プールを含む応答。 ヘッダー client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	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 a pool with AcceleratedNetworking

Get a VirtualMachineConfiguration pool with extensions

Get a VirtualMachineConfiguration pool with SecurityProfile

Get a VirtualMachineConfiguration pool with ServiceArtifactReference

Get a VirtualMachineConfiguration pool with UpgradePolicy

Pool get

Add a VirtualMachineConfiguration pool with OS disk

要求のサンプル

HTTP

GET account.region.batch.azure.com/pools/mypool001?api-version=2024-07-01.20.0

応答のサンプル

状態コード:

200

{
  "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

要求のサンプル

HTTP

GET account.region.batch.azure.com/pools/pool?api-version=2024-07-01.20.0

応答のサンプル

状態コード:

200

{
  "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

要求のサンプル

HTTP

GET account.region.batch.azure.com/pools/pool?api-version=2024-07-01.20.0

応答のサンプル

状態コード:

200

{
  "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

要求のサンプル

HTTP

GET account.region.batch.azure.com/pools/mypool001?api-version=2024-07-01.20.0

応答のサンプル

状態コード:

200

{
  "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

要求のサンプル

HTTP

GET account.region.batch.azure.com/pools/pool?api-version=2024-07-01.20.0

応答のサンプル

状態コード:

200

{
  "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",
  "upgradePolicy": {
    "mode": "automatic",
    "automaticOSUpgradePolicy": {
      "enableAutomaticOSUpgrade": true
    }
  }
}

Get a VirtualMachineConfiguration pool with UpgradePolicy

要求のサンプル

HTTP

GET account.region.batch.azure.com/pools/mypool001?api-version=2024-07-01.20.0

応答のサンプル

状態コード:

200

{
  "id": "mypool001",
  "url": "https://account.region.batch.azure.com/pools/mypool001",
  "eTag": "0x8DB51ED3C9B6CF4",
  "lastModified": "2023-05-11T06:59:16.8975092Z",
  "creationTime": "2023-05-11T06:59:16.8975092Z",
  "state": "active",
  "stateTransitionTime": "2023-05-11T06:59:16.8975092Z",
  "allocationState": "steady",
  "allocationStateTransitionTime": "2023-05-11T07:00:34.9878574Z",
  "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
    },
    "nodePlacementConfiguration": {
      "policy": "zonal"
    }
  },
  "currentNodeCommunicationMode": "classic",
  "upgradePolicy": {
    "mode": "automatic",
    "automaticOSUpgradePolicy": {
      "disableAutomaticRollback": true,
      "enableAutomaticOSUpgrade": true,
      "useRollingUpgradePolicy": true,
      "osRollingUpgradeDeferral": true
    },
    "rollingUpgradePolicy": {
      "enableCrossZoneUpgrade": true,
      "maxBatchInstancePercent": 20,
      "maxUnhealthyInstancePercent": 20,
      "maxUnhealthyUpgradedInstancePercent": 20,
      "pauseTimeBetweenBatches": "PT0S",
      "prioritizeUnhealthyInstances": false,
      "rollbackFailedInstancesOnPolicyBreach": false
    }
  }
}

Pool get

要求のサンプル

HTTP

GET account.region.batch.azure.com/pools/pool?api-version=2024-07-01.20.0

応答のサンプル

状態コード:

200

{
  "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"
  }
}

定義

名前	説明
AllocationState	プールのサイズが変更されているかどうか。
ApplicationPackageReference	コンピューティング ノードにデプロイするパッケージへの参照。
AutomaticOSUpgradePolicy	OS の自動アップグレードを実行するために使用される構成パラメーター。
AutoScaleRun	プールの自動スケール式の実行の結果とエラー。
AutoScaleRunError	プールの自動スケール式を実行または評価するときに発生したエラー。
AutoUserScope	自動ユーザーのスコープ
AutoUserSpecification	Batch サービスでタスクを実行する自動ユーザーのパラメーターを指定します。
AzureBlobFileSystemConfiguration	Blobfuse を使用して Azure Storage コンテナーに接続するために使用される情報。
AzureFileShareConfiguration	Azure ファイル共有への接続に使用される情報。
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batch エラー応答に含まれる追加情報の項目。
BatchPoolIdentity	Batch プールの ID (構成されている場合)。
CachingType	ディスクに対して有効にするキャッシュの種類。
CertificateReference	プール内のコンピューティング ノードにインストールされる証明書への参照。
CertificateStoreLocation	証明書をインストールするコンピューティング ノード上の証明書ストアの場所。
CertificateVisibility	証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。
CIFSMountConfiguration	CIFS ファイル システムへの接続に使用される情報。
CloudPool	Azure Batch サービス内のプール。
ComputeNodeFillType	プール内のコンピューティング ノード間でタスクを分散する方法。
ComputeNodeIdentityReference	コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。
ContainerConfiguration	コンテナーが有効なプールの構成。
ContainerHostBatchBindMountEntry	タスク コンテナーにマウントするパスとマウント モードのエントリ。
ContainerHostDataPath	コンテナー タスクのコンテナーにマウントされるパス。
ContainerRegistry	プライベート コンテナー レジストリ。
ContainerType	使用するコンテナー テクノロジ。
ContainerWorkingDirectory	コンテナータスク作業ディレクトリの場所。
DataDisk	プール内のコンピューティング ノードに関連付けられているデータ ディスクによって使用される設定。 接続されたデータ ディスクを使用する場合は、VM 内からディスクをマウントしてフォーマットして使用する必要があります。
DiffDiskPlacement	プール内のすべてのコンピューティング ノード (VM) のオペレーティング システム ディスクのエフェメラル ディスク配置を指定します。
DiffDiskSettings	コンピューティング ノード (VM) によって使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。
DiskEncryptionConfiguration	プール内のコンピューティング ノードに適用されるディスク暗号化構成。 ディスク暗号化の構成は、Azure コンピューティング ギャラリー イメージで作成された Linux プールではサポートされていません。
DiskEncryptionTarget	Batch Service がコンピューティング ノードで暗号化するディスク ターゲットの一覧。
DynamicVNetAssignmentScope	動的 vnet 割り当てのスコープ。
ElevationLevel	ユーザーの昇格レベル。
EnvironmentSetting	タスク プロセスで設定する環境変数。
ErrorMessage	Azure Batch エラー応答で受信したエラー メッセージ。
ImageReference	Azure Virtual Machines Marketplace イメージまたは Azure コンピューティング ギャラリー イメージへの参照。 Azure Batch によって検証されたすべての Azure Marketplace イメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。
InboundEndpointProtocol	エンドポイントのプロトコル。
InboundNATPool	Batch プール内のコンピューティング ノード上の特定のポートを外部でアドレス指定するために使用できる受信 NAT プール。
IPAddressProvisioningType	プールのパブリック IP アドレスのプロビジョニングの種類。
LinuxUserConfiguration	Linux コンピューティング ノードでユーザー アカウントを作成するために使用されるプロパティ。
LoginMode	ユーザーのログイン モード
ManagedDisk
MetadataItem	Batch サービス リソースに関連付けられている名前と値のペア。
MountConfiguration	各ノードにマウントするファイル システム。
NameValuePair	名前と値のペアを表します。
NetworkConfiguration	プールのネットワーク構成。
NetworkSecurityGroupRule	受信エンドポイントに適用するネットワーク セキュリティ グループルール。
NetworkSecurityGroupRuleAccess	指定した IP アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。
NFSMountConfiguration	NFS ファイル システムへの接続に使用される情報。
NodeCommunicationMode	プールが Batch サービスと通信する方法を決定します。
NodePlacementConfiguration	プールのノード配置構成。
NodePlacementPolicyType	プール内のノードを割り当てる配置ポリシー。
OSDisk	コンピューティング ノード (VM) のオペレーティング システム ディスクの設定。
PoolEndpointConfiguration	プールのエンドポイント構成。
PoolIdentityType	Batch プールの ID (構成されている場合)。
PoolState	プールの現在の状態。
PoolStatistics	プールの有効期間中の使用率とリソース使用状況の統計情報が含まれます。
PublicIPAddressConfiguration	プールのネットワーク構成のパブリック IP アドレス構成。
ResizeError	プールのサイズを変更するときに発生したエラー。
ResourceFile	コンピューティング ノードにダウンロードする 1 つのファイルまたは複数のファイル。
ResourceStatistics	プール内のコンピューティング ノード別のリソース消費に関連する統計。
RollingUpgradePolicy	ローリング アップグレードの実行中に使用される構成パラメーター。
SecurityEncryptionTypes	マネージド ディスクの EncryptionType を指定します。 VMGuestState BLOB のみを暗号化する場合は VMGuestStateOnly に、VMGuestState BLOB にファームウェアの状態を保持しない場合は NonPersistedTPM に設定されます。 注: 機密 VM にのみ設定でき、機密 VM を使用する場合に必要です。
SecurityProfile	仮想マシンまたは仮想マシン スケール セットのセキュリティ プロファイル設定を指定します。
SecurityTypes	仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。
ServiceArtifactReference	"最新" イメージ バージョンを使用する場合に、スケール セット内のすべての仮想マシンに同じイメージ バージョンを設定するために使用されるサービス 成果物参照 ID を指定します。
StartTask	ノードが Azure Batch サービスのプールに参加したとき、またはコンピューティング ノードが再起動または再イメージ化されたときに実行されるタスク。
StorageAccountType	データ ディスクまたは OS ディスクの作成に使用するストレージ アカウントの種類。
TaskContainerSettings	タスクのコンテナー設定。
TaskSchedulingPolicy	タスクをコンピューティング ノード間で分散する方法を指定します。
UefiSettings	仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。
UpgradeMode	スケール セット内の仮想マシンへのアップグレード モードを指定します。 使用可能な値は次のとおりです。 手動 - スケール セット内の仮想マシンへの更新プログラムの適用を制御します。 これを行うには、manualUpgrade アクションを使用します。 自動 - スケール セット内のすべての仮想マシンが同時に自動的に更新されます。 ローリング - スケール セットは、必要に応じて一時停止時間の間にバッチで更新を実行します。
UpgradePolicy	アップグレード ポリシー (自動、手動、またはローリング) について説明します。
UsageStatistics	プールの使用状況情報に関連する統計。
UserAccount	Azure Batch コンピューティング ノードでタスクを実行するために使用するユーザーの作成に使用されるプロパティ。
UserAssignedIdentity	ユーザー割り当て ID
UserIdentity	タスクを実行するユーザー ID の定義。
VirtualMachineConfiguration	Azure Virtual Machines インフラストラクチャに基づくプール内のコンピューティング ノードの構成。
VMDiskSecurityProfile	マネージド ディスクのセキュリティ プロファイル設定を指定します。 注: 機密 VM に対してのみ設定でき、機密 VM を使用する場合に必要です。
VMExtension	仮想マシン拡張機能の構成。
WindowsConfiguration	仮想マシンに適用する Windows オペレーティング システムの設定。
WindowsUserConfiguration	Windows コンピューティング ノードでユーザー アカウントを作成するために使用されるプロパティ。

AllocationState

プールのサイズが変更されているかどうか。

名前	型	説明
resizing	string	プールのサイズが変更されています。つまり、コンピューティング ノードはプールに追加またはプールから削除されます。
steady	string	プールのサイズが変更されていません。 進行中のプール内のコンピューティング ノードの数に変更はありません。 プールは、作成されたとき、およびコンピューティング ノードの数を変更する操作がプールで実行されていない場合に、この状態になります。
stopping	string	プールのサイズが変更されましたが、ユーザーはサイズ変更を停止することを要求しましたが、停止要求はまだ完了していません。

ApplicationPackageReference

コンピューティング ノードにデプロイするパッケージへの参照。

名前	型	説明
applicationId	string	デプロイするアプリケーションの ID。 プールを作成する場合、パッケージのアプリケーション ID は完全修飾 (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}) である必要があります。
version	string	デプロイするアプリケーションのバージョン。 省略すると、既定のバージョンがデプロイされます。 プールでこれを省略し、このアプリケーションに既定のバージョンが指定されていない場合、要求はエラー コード InvalidApplicationPackageReferences と HTTP 状態コード 409 で失敗します。 タスクでこれを省略し、このアプリケーションに既定のバージョンが指定されていない場合、タスクは前処理エラーで失敗します。

AutomaticOSUpgradePolicy

OS の自動アップグレードを実行するために使用される構成パラメーター。

名前	型	説明
disableAutomaticRollback	boolean	OS イメージのロールバック機能を無効にする必要があるかどうか。
enableAutomaticOSUpgrade	boolean	新しいバージョンの OS イメージが使用可能になったときに、OS アップグレードをスケール セット インスタンスに自動的に適用するかどうかを示します。 Windows ベースのプールに対してこれが true に設定されている場合、WindowsConfiguration.enableAutomaticUpdates を true に設定することはできません。
osRollingUpgradeDeferral	boolean	タスクを実行している場合は、TVM の OS アップグレードを延期します。
useRollingUpgradePolicy	boolean	自動 OS アップグレード中にローリング アップグレード ポリシーを使用するかどうかを示します。 VMSS でポリシーが定義されていない場合、OS の自動アップグレードは既定のポリシーにフォールバックします。

AutoScaleRun

プールの自動スケール式の実行の結果とエラー。

名前	型	説明
error	AutoScaleRunError	評価が失敗した場合に、プールで自動スケール式を評価するときに発生したエラーの詳細。
results	string	自動スケール式の評価で使用されるすべての変数の最終的な値。 各変数値は $variable=value の形式で返され、変数はセミコロンで区切られます。
timestamp	string	自動スケール式が最後に評価された時刻。

AutoScaleRunError

プールの自動スケール式を実行または評価するときに発生したエラー。

名前	型	説明
code	string	自動スケール エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。
message	string	ユーザー インターフェイスでの表示に適した自動スケール エラーを説明するメッセージ。
values	NameValuePair[]	自動スケール エラーに関連する追加エラーの詳細の一覧。

AutoUserScope

自動ユーザーのスコープ

名前	型	説明
pool	string	タスクが、プール内のすべてのコンピューティング ノードで作成される共通の自動ユーザー アカウントとして実行されるように指定します。
task	string	サービスがタスクの新しいユーザーを作成することを指定します。

AutoUserSpecification

Batch サービスでタスクを実行する自動ユーザーのパラメーターを指定します。

名前	型	説明
elevationLevel	ElevationLevel	自動ユーザーの昇格レベル。 既定値は nonAdmin です。
scope	AutoUserScope	自動ユーザーのスコープ 既定値は pool です。 プールが Windows を実行している場合は、タスク間のより厳密な分離が必要な場合は、Task の値を指定する必要があります。 たとえば、タスクが他のタスクに影響を与える可能性のある方法でレジストリを変更する場合や、通常のタスクではアクセスできないが StartTasks からアクセスできる必要がある証明書がプールで指定されている場合などです。

AzureBlobFileSystemConfiguration

Blobfuse を使用して Azure Storage コンテナーに接続するために使用される情報。

名前	型	説明
accountKey	string	Azure ストレージ アカウント キー。 このプロパティは、sasKey と ID の両方と相互に排他的です。正確に 1 つを指定する必要があります。
accountName	string	Azure ストレージ アカウント名。
blobfuseOptions	string	mount コマンドに渡す追加のコマンド ライン オプション。 これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。
containerName	string	Azure Blob Storage コンテナー名。
identityReference	ComputeNodeIdentityReference	containerName へのアクセスに使用するユーザー割り当て ID への参照 このプロパティは、accountKey と sasKey の両方と相互に排他的です。正確に 1 つを指定する必要があります。
relativeMountPath	string	ファイル システムがマウントされるコンピューティング ノード上の相対パス すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。
sasKey	string	Azure Storage SAS トークン。 このプロパティは accountKey と ID の両方と相互に排他的です。正確に 1 つを指定する必要があります。

AzureFileShareConfiguration

Azure ファイル共有への接続に使用される情報。

名前	型	説明
accountKey	string	Azure Storage アカウント キー。
accountName	string	Azure Storage アカウント名。
azureFileUrl	string	Azure Files の URL。 これは 'https://{account}.file.core.windows.net/' の形式です。
mountOptions	string	mount コマンドに渡す追加のコマンド ライン オプション。 これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。
relativeMountPath	string	ファイル システムがマウントされるコンピューティング ノード上の相対パス すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。

BatchError

Azure Batch サービスから受信したエラー応答。

名前	型	説明
code	string	エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。
message	ErrorMessage	ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。
values	BatchErrorDetail[]	エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

Azure Batch エラー応答に含まれる追加情報の項目。

名前	型	説明
key	string	Value プロパティの意味を指定する識別子。
value	string	エラー応答に含まれる追加情報。

BatchPoolIdentity

Batch プールの ID (構成されている場合)。

名前	型	説明
type	PoolIdentityType	Batch プールの ID (構成されている場合)。 Batch プールに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。
userAssignedIdentities	UserAssignedIdentity[]	Batch アカウントに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

CachingType

ディスクに対して有効にするキャッシュの種類。

名前	型	説明
none	string	ディスクのキャッシュ モードが有効になっていません。
readonly	string	ディスクのキャッシュ モードは読み取り専用です。
readwrite	string	ディスクのキャッシュ モードは読み取りと書き込みです。

CertificateReference

プール内のコンピューティング ノードにインストールされる証明書への参照。

名前	型	説明
storeLocation	CertificateStoreLocation	証明書をインストールするコンピューティング ノード上の証明書ストアの場所。 既定値は currentuser です。 このプロパティは、Windows コンピューティング ノードで構成されたプールにのみ適用されます。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。
storeName	string	証明書をインストールするコンピューティング ノード上の証明書ストアの名前。 このプロパティは、Windows コンピューティング ノードで構成されたプールにのみ適用されます。 一般的なストア名には、My、Root、CA、Trust、Disallowed、TrustedPeople、TrustedPublisher、AuthRoot、AddressBook などがありますが、カスタム ストア名も使用できます。 既定値は My です。
thumbprint	string	証明書の拇印。
thumbprintAlgorithm	string	拇印が関連付けられているアルゴリズム。 これは sha1 である必要があります。
visibility	CertificateVisibility[]	証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。 このコレクションでは、複数の可視性を指定できます。 既定値はすべてのアカウントです。

CertificateStoreLocation

証明書をインストールするコンピューティング ノード上の証明書ストアの場所。

名前	型	説明
currentuser	string	証明書は CurrentUser 証明書ストアにインストールする必要があります。
localmachine	string	証明書は LocalMachine 証明書ストアにインストールする必要があります。

CertificateVisibility

証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。

名前	型	説明
remoteuser	string	証明書は、ユーザーがコンピューティング ノードにリモートでアクセスするユーザー アカウントに表示される必要があります。
starttask	string	証明書は、StartTask が実行されているユーザー アカウントに表示されます。 AutoUser スコープが StartTask と Task の両方のプールである場合、この証明書はタスクにも表示されることに注意してください。
task	string	証明書は、ジョブ タスクが実行されているユーザー アカウントに表示されます。

CIFSMountConfiguration

CIFS ファイル システムへの接続に使用される情報。

名前	型	説明
mountOptions	string	mount コマンドに渡す追加のコマンド ライン オプション。 これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。
password	string	CIFS ファイル システムに対する認証に使用するパスワード。
relativeMountPath	string	ファイル システムがマウントされるコンピューティング ノード上の相対パス すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。
source	string	マウントするファイル システムの URI。
username	string	CIFS ファイル システムに対する認証に使用するユーザー。

CloudPool

Azure Batch サービス内のプール。

名前	型	説明
allocationState	AllocationState	プールのサイズが変更されているかどうか。
allocationStateTransitionTime	string	プールが現在の割り当て状態になった時刻。
applicationPackageReferences	ApplicationPackageReference[]	プール内の各コンピューティング ノードにインストールするパッケージの一覧。 パッケージ参照への変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、既にプール内にあるコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のパッケージ参照があります。
autoScaleEvaluationInterval	string	自動スケールの数式に従ってプール のサイズを自動的に調整する時間間隔。 このプロパティは、プールが自動的にスケーリングされる場合 (enableAutoScale が true の場合) にのみ設定されます。
autoScaleFormula	string	プール内のコンピューティング ノードの必要な数の数式。 このプロパティは、プールが自動的にスケーリングされる場合 (enableAutoScale が true の場合) にのみ設定されます。
autoScaleRun	AutoScaleRun	自動スケール式の最後の実行の結果とエラー。 このプロパティは、プールが自動的にスケーリングされる場合 (enableAutoScale が true の場合) にのみ設定されます。
certificateReferences	CertificateReference[]	プール内の各コンピューティング ノードにインストールする証明書の一覧。 Windows ノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。 警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに、Azure KeyVault 拡張機能 を使用してください。
creationTime	string	プールの作成時刻。
currentDedicatedNodes	integer	プール内の現在の専用コンピューティング ノードの数。
currentLowPriorityNodes	integer	プール内の現在のスポット/優先順位の低いコンピューティング ノードの数。 このカウントには、割り込まれたスポット/低優先度のコンピューティング ノードが含まれます。
currentNodeCommunicationMode	NodeCommunicationMode	プール通信モードの現在の状態。
displayName	string	プールの表示名。 表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。
eTag	string	プールの ETag。 これは不透明な文字列です。 これを使用して、要求間でプールが変更されたかどうかを検出できます。 特に、プールを更新するときに ETag を渡して、その間に他の誰もプールを変更していない場合にのみ変更を有効にするように指定できます。
enableAutoScale	boolean	プール サイズが時間の経過と同時に自動的に調整されるかどうか。 false の場合は、targetDedicatedNodes と targetLowPriorityNodes の少なくとも 1 つを指定する必要があります。 true の場合、autoScaleFormula プロパティが必要であり、プールは数式に従って自動的にサイズ変更されます。 既定値は false です。
enableInterNodeCommunication	boolean	プールがコンピューティング ノード間の直接通信を許可するかどうか。 これにより、プールに割り当てることができるコンピューティング ノードに制限が適用されます。 この値を指定すると、要求されたコンピューティング ノードの数がプールに割り当てられる可能性が低くなります。
id	string	アカウント内のプールを一意に識別する文字列。 ID には、ハイフンやアンダースコアを含む任意の英数字を組み合わせて使用でき、64 文字を超えることはできません。 ID は大文字と小文字が区別されず、大文字と小文字が区別されません (つまり、アカウント内に大文字と小文字のみが異なる 2 つの ID がない可能性があります)。
identity	BatchPoolIdentity	Batch プールの ID (構成されている場合)。 Batch プールに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。
lastModified	string	プールの最終変更時刻。 これは、targetDedicatedNodes や enableAutoscale 設定など、プール レベルのデータが最後に変更された時刻です。 コンピューティング ノードの状態の変化など、ノード レベルの変更は考慮されません。
metadata	MetadataItem[]	メタデータとしてプールに関連付けられている名前と値のペアの一覧。
mountConfiguration	MountConfiguration[]	プール内の各ノードにマウントするファイル システムの一覧。 これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。
networkConfiguration	NetworkConfiguration	プールのネットワーク構成。 プールのネットワーク構成。
resizeErrors	ResizeError[]	プールで最後のサイズ変更の実行中に発生したエラーの一覧。 このプロパティは、プールの最後のサイズ変更中に 1 つ以上のエラーが発生した場合にのみ設定され、プールの割り当て状態が安定している場合にのみ設定されます。
resizeTimeout	string	プールへのコンピューティング ノードの割り当てのタイムアウト。 これは、最新のサイズ変更操作のタイムアウトです。 (プールの作成時の初期サイズ変更はサイズ変更としてカウントされます)。既定値は 15 分です。
resourceTags	object	プールに関連付けられているユーザー指定のタグ。 Azure Batch プールに関連付けるユーザー定義タグ。 これらのタグを指定すると、プールに関連付けられているバッキング Azure リソースにこれらのタグが伝達されます。 このプロパティは、poolAllocationMode プロパティが 'UserSubscription' に設定された Batch アカウントが作成された場合にのみ指定できます。
startTask	StartTask	プールに参加する各コンピューティング ノードで実行するように指定されたタスク。 Batch は、ノードで復旧操作がトリガーされたときにタスクを再試行します。 復旧操作の例としては、異常なノードが再起動されたときや、ホスト障害が原因でコンピューティング ノードが消えた場合などです (ただし、これらに限定されません)。 回復操作による再試行は独立しており、maxTaskRetryCount に対してカウントされません。 maxTaskRetryCount が 0 の場合でも、復旧操作による内部再試行が発生する可能性があります。 このため、すべてのタスクはべき等である必要があります。 つまり、タスクは、破損やデータの重複を引き起こさずに中断および再起動されることを許容する必要があります。 実行時間の長いタスクのベスト プラクティスは、何らかの形式のチェックポイント処理を使用することです。 場合によっては、コンピューティング ノードが再起動されなかった場合でも、StartTask が再実行されることがあります。 中断プロセスを作成したり、StartTask 作業ディレクトリからサービスをインストール/起動したりする StartTask を回避するには、特別な注意が必要です。これにより、Batch で StartTask を再実行できなくなるためです。
state	PoolState	プールの現在の状態。
stateTransitionTime	string	プールが現在の状態になった時刻。
stats	PoolStatistics	プールの有効期間全体の使用率とリソース使用状況の統計情報。 このプロパティは、CloudPool が 'stats' 属性を含む expand 句で取得された場合にのみ設定されます。それ以外の場合は null です。 統計をすぐに使用できない場合があります。 Batch サービスは、統計の定期的なロールアップを実行します。 一般的な遅延は約 30 分です。
targetDedicatedNodes	integer	プール内の専用コンピューティング ノードの必要な数。
targetLowPriorityNodes	integer	プール内のスポット/優先順位の低いコンピューティング ノードの目的の数。
targetNodeCommunicationMode	NodeCommunicationMode	プールの目的のノード通信モード。 省略した場合、既定値は Default です。
taskSchedulingPolicy	TaskSchedulingPolicy	プール内のコンピューティング ノード間でタスクを分散する方法。 指定しない場合、既定値はスプレッドです。
taskSlotsPerNode	integer	プール内の 1 つのコンピューティング ノードで同時実行タスクを実行するために使用できるタスク スロットの数。 既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。
upgradePolicy	UpgradePolicy	プールのアップグレード ポリシー。 アップグレード ポリシー (自動、手動、またはローリング) について説明します。
url	string	プールの URL。
userAccounts	UserAccount[]	プール内の各コンピューティング ノードに作成するユーザー アカウントの一覧。
virtualMachineConfiguration	VirtualMachineConfiguration	プールの仮想マシン構成。 このプロパティを指定する必要があります。
vmSize	string	プール内の仮想マシンのサイズ。 プール内のすべての仮想マシンのサイズは同じです。 プールで使用可能な仮想マシンのサイズについては、「Azure Batch プールのコンピューティング ノードの VM サイズの選択 (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)」を参照してください。

ComputeNodeFillType

プール内のコンピューティング ノード間でタスクを分散する方法。

名前	型	説明
pack	string	プール内の次のコンピューティング ノードにタスクが割り当てられる前に、できるだけ多くのタスク (taskSlotsPerNode) をプール内の各コンピューティング ノードに割り当てる必要があります。
spread	string	タスクは、プール内のすべてのコンピューティング ノードに均等に割り当てる必要があります。

ComputeNodeIdentityReference

コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。

名前	型	説明
resourceId	string	ユーザー割り当て ID の ARM リソース ID。

ContainerConfiguration

コンテナーが有効なプールの構成。

名前	型	説明
containerImageNames	string[]	コンテナー イメージ名のコレクション。 これは、"docker pull" に指定されているように、完全なイメージ参照です。 イメージが代替レジストリで完全修飾されていない限り、イメージは既定の Docker レジストリから取得されます。
containerRegistries	ContainerRegistry[]	コンテナーをプルできる追加のプライベート レジストリ。 資格情報を必要とするプライベート レジストリからイメージをダウンロードする必要がある場合は、ここでそれらの資格情報を指定する必要があります。
type	ContainerType	使用するコンテナー テクノロジ。

ContainerHostBatchBindMountEntry

タスク コンテナーにマウントするパスとマウント モードのエントリ。

名前	型	説明
isReadOnly	boolean	このソース パスを読み取り専用モードとしてマウントするかどうか。 既定値は false (読み取り/書き込みモード) です。 Linux の場合、このパスを読み取り/書き込みモードとしてマウントした場合、コンテナー内のすべてのユーザーがパスの読み取り/書き込みアクセス権を持っているわけではありません。これは、ホスト VM のアクセスに依存します。 このパスが読み取り専用でマウントされている場合、コンテナー内のすべてのユーザーはパスを変更できません。
source	ContainerHostDataPath	コンテナー顧客にマウントするパスを選択できます。

ContainerHostDataPath

コンテナー タスクのコンテナーにマウントされるパス。

名前	型	説明
Applications	string	アプリケーション パス。
JobPrep	string	ジョブ準備タスクのパス。
Shared	string	複数インスタンス のタスクがファイルを共有するためのパス。
Startup	string	開始タスクのパス。
Task	string	タスク パス。
VfsMounts	string	パスには、このノードにマウントされているすべての仮想ファイル システムが含まれています。

ContainerRegistry

プライベート コンテナー レジストリ。

名前	型	説明
identityReference	ComputeNodeIdentityReference	ユーザー名とパスワードではなく、Azure Container Registry へのアクセスに使用するユーザー割り当て ID への参照。 コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。
password	string	レジストリ サーバーにログインするためのパスワード。
registryServer	string	レジストリ URL。 省略した場合、既定値は "docker.io" です。
username	string	レジストリ サーバーにログインするユーザー名。

ContainerType

使用するコンテナー テクノロジ。

名前	型	説明
criCompatible	string	CRI ベースのテクノロジを使用して、コンテナーを起動します。
dockerCompatible	string	Docker と互換性のあるコンテナー テクノロジを使用して、コンテナーを起動します。

ContainerWorkingDirectory

コンテナータスク作業ディレクトリの場所。

名前	型	説明
containerImageDefault	string	コンテナー イメージで定義されている作業ディレクトリを使用します。 このディレクトリには、Batch によってダウンロードされたリソース ファイルが含まれていないことに注意してください。
taskWorkingDirectory	string	Batch によって設定されたタスク リソース ファイルが含まれる標準の Batch サービスタスク作業ディレクトリを使用します。

DataDisk

プール内のコンピューティング ノードに関連付けられているデータ ディスクによって使用される設定。 接続されたデータ ディスクを使用する場合は、VM 内からディスクをマウントしてフォーマットして使用する必要があります。

名前	型	説明
caching	CachingType	データ ディスクに対して有効にするキャッシュの種類。 キャッシュの既定値は readwrite です。 キャッシュ オプションの詳細については、「https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/」を参照してください。
diskSizeGB	integer	初期ディスク サイズ (ギガバイト単位)。
lun	integer	論理ユニット番号。 lun は、各データ ディスクを一意に識別するために使用されます。 複数のディスクを接続する場合は、それぞれ個別の LUN が必要です。 値は、0 ~ 63 の範囲である必要があります。
storageAccountType	StorageAccountType	データ ディスクに使用するストレージ アカウントの種類。 省略した場合、既定値は "standard_lrs" です。

DiffDiskPlacement

プール内のすべてのコンピューティング ノード (VM) のオペレーティング システム ディスクのエフェメラル ディスク配置を指定します。

名前	型	説明
CacheDisk	string	エフェメラル OS ディスクは VM キャッシュに格納されます。

DiffDiskSettings

コンピューティング ノード (VM) によって使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。

名前	型	説明
placement	DiffDiskPlacement	プール内のすべての VM のオペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。 このプロパティは、要求のユーザーが、エフェメラル OS ディスク プロビジョニング用のキャッシュ ディスク領域などの場所を選択するために使用できます。 エフェメラル OS ディスク サイズの要件の詳細については、https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements の Windows VM と https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirementsの Linux VM のエフェメラル OS ディスク サイズ要件に関するページを参照してください。

DiskEncryptionConfiguration

プール内のコンピューティング ノードに適用されるディスク暗号化構成。 ディスク暗号化の構成は、Azure コンピューティング ギャラリー イメージで作成された Linux プールではサポートされていません。

名前	型	説明
targets	DiskEncryptionTarget[]	Batch Service がコンピューティング ノードで暗号化するディスク ターゲットの一覧。 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 コンピューティング ギャラリー イメージへの参照。 Azure Batch によって検証されたすべての Azure Marketplace イメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。

名前	型	説明
communityGalleryImageId	string	コミュニティ ギャラリー イメージの一意識別子 このプロパティは他のプロパティと相互に排他的であり、コミュニティ ギャラリー イメージの GET 呼び出しからフェッチできます。
exactVersion	string	ノードの作成に使用されるプラットフォーム イメージまたはマーケットプレース イメージの特定のバージョン。 この読み取り専用フィールドは、プールの作成時に 'version' に指定された値が 'latest' の場合にのみ、'version' と異なります。
offer	string	Azure Virtual Machines Marketplace イメージのオファーの種類。 たとえば、UbuntuServer や WindowsServer などです。
publisher	string	Azure Virtual Machines Marketplace イメージの発行元。 たとえば、Canonical または MicrosoftWindowsServer です。
sharedGalleryImageId	string	共有ギャラリー イメージの一意識別子 このプロパティは他のプロパティと相互に排他的であり、共有ギャラリー イメージの GET 呼び出しからフェッチできます。
sku	string	Azure Virtual Machines Marketplace イメージの SKU。 たとえば、18.04-LTS や 2019-Datacenter などです。
version	string	Azure Virtual Machines Marketplace イメージのバージョン。 'latest' の値を指定して、イメージの最新バージョンを選択できます。 省略した場合、既定値は 'latest' です。
virtualMachineImageId	string	Azure コンピューティング ギャラリー イメージの ARM リソース識別子。 プール内のコンピューティング ノードは、このイメージ ID を使用して作成されます。これは、常に最新のイメージ バージョンに既定値を設定するために、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} または /subscriptions/{subscriptionId}/resourceGroup}/providers/Microsoft.Compute/galleryName}/images/{imageDefinitionName} の形式です。 このプロパティは、他の ImageReference プロパティと相互に排他的です。 Azure コンピューティング ギャラリー イメージは、同じリージョンにレプリカを持ち、Azure Batch アカウントと同じサブスクリプション内にある必要があります。 イメージのバージョンが imageId で指定されていない場合は、最新バージョンが使用されます。 Batch サービスと通信するための Batch コンピューティング ノード エージェントのファイアウォール設定については、https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configurationを参照してください。

InboundEndpointProtocol

エンドポイントのプロトコル。

名前	型	説明
tcp	string	エンドポイントには TCP を使用します。
udp	string	エンドポイントには UDP を使用します。

InboundNATPool

Batch プール内のコンピューティング ノード上の特定のポートを外部でアドレス指定するために使用できる受信 NAT プール。

名前	型	説明
backendPort	integer	コンピューティング ノードのポート番号。 これは、バッチ プール内で一意である必要があります。 29876 から 29877 を除き、使用可能な値は 1 から 65535 の間です。これらは予約されています。 予約された値が指定された場合、要求は HTTP 状態コード 400 で失敗します。
frontendPortRangeEnd	integer	個々のコンピューティング ノードの backendPort への受信アクセスを提供するために使用される外部ポートの範囲内の最後のポート番号。 指定できる値の範囲は 1 ~ 65534 です。ただし、Batch サービスによって予約されているポートは 50000 ~ 55000 です。 プール内のすべての範囲は個別である必要があり、重複することはできません。 各範囲には、少なくとも 40 個のポートが含まれている必要があります。 予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。
frontendPortRangeStart	integer	個々のコンピューティング ノードの backendPort への受信アクセスを提供するために使用される外部ポートの範囲内の最初のポート番号。 使用可能な値の範囲は 1 ~ 65534 です。ただし、予約されているポートは 50000 ~ 55000 です。 プール内のすべての範囲は個別である必要があり、重複することはできません。 各範囲には、少なくとも 40 個のポートが含まれている必要があります。 予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。
name	string	エンドポイントの名前。 名前は Batch プール内で一意である必要があり、文字、数字、アンダースコア、ピリオド、ハイフンを含めることができます。 名前は文字または数字で始まる必要があり、末尾は文字、数字、またはアンダースコアで終わる必要があり、77 文字を超えることはできません。 無効な値が指定された場合、要求は HTTP 状態コード 400 で失敗します。
networkSecurityGroupRules	NetworkSecurityGroupRule[]	エンドポイントに適用されるネットワーク セキュリティ グループ規則の一覧。 Batch プール上のすべてのエンドポイントで指定できるルールの最大数は 25 です。 ネットワーク セキュリティ グループの規則が指定されていない場合は、指定された backendPort への受信アクセスを許可する既定の規則が作成されます。 ネットワーク セキュリティ グループ規則の最大数を超えた場合、要求は HTTP 状態コード 400 で失敗します。
protocol	InboundEndpointProtocol	エンドポイントのプロトコル。

IPAddressProvisioningType

プールのパブリック IP アドレスのプロビジョニングの種類。

名前	型	説明
batchmanaged	string	パブリック IP は Batch によって作成および管理されます。 プールのサイズによっては、複数のパブリック IP が存在する場合があります。
nopublicipaddresses	string	パブリック IP アドレスは作成されません。
usermanaged	string	パブリック IP はユーザーによって提供され、コンピューティング ノードのプロビジョニングに使用されます。

LinuxUserConfiguration

Linux コンピューティング ノードでユーザー アカウントを作成するために使用されるプロパティ。

名前	型	説明
gid	integer	ユーザー アカウントのグループ ID。 uid プロパティと gid プロパティは、一緒に指定するか、まったく指定しない必要があります。 指定しない場合、基になるオペレーティング システムは gid を選択します。
sshPrivateKey	string	ユーザー アカウントの SSH 秘密キー。 秘密キーはパスワードで保護しないでください。 この秘密キーは、プールの enableInterNodeCommunication プロパティが true の場合 (enableInterNodeCommunication が false の場合は無視されます)、Linux プール内のコンピューティング ノード間で SSH の非対称キー ベースの認証を自動的に構成するために使用されます。 これを行うには、キー ペアをユーザーの .ssh ディレクトリに配置します。 指定しない場合、コンピューティング ノード間でパスワードレス SSH は構成されません (ユーザーの .ssh ディレクトリの変更は行われません)。
uid	integer	ユーザー アカウントのユーザー ID。 uid プロパティと gid プロパティは、一緒に指定するか、まったく指定しない必要があります。 指定しない場合、基になるオペレーティング システムは uid を選択します。

LoginMode

ユーザーのログイン モード

名前	型	説明
batch	string	LOGON32_LOGON_BATCH Win32 ログイン モード。 バッチ ログイン モードは、実行時間の長い並列プロセスに推奨されます。
interactive	string	LOGON32_LOGON_INTERACTIVE Win32 ログイン モード。 UAC は Windows プールで有効になっています。 このオプションを Windows プール内の昇格されたユーザー ID と共に使用する場合、タスク コマンド ラインによって実行されるアプリケーションが常に管理特権を必要とするか、常に最大特権を必要とするように構成されていない限り、ユーザー セッションは昇格されません。

ManagedDisk

名前	型	説明
securityProfile	VMDiskSecurityProfile	マネージド ディスクのセキュリティ プロファイル設定を指定します。 マネージド ディスクのセキュリティ プロファイル設定を指定します。 注: 機密 VM に対してのみ設定でき、機密 VM を使用する場合に必要です。
storageAccountType	StorageAccountType	マネージド ディスクのストレージ アカウントの種類。

MetadataItem

Batch サービス リソースに関連付けられている名前と値のペア。

名前	型	説明
name	string	メタデータ項目の名前。
value	string	メタデータ項目の値。

MountConfiguration

各ノードにマウントするファイル システム。

名前	型	説明
azureBlobFileSystemConfiguration	AzureBlobFileSystemConfiguration	各ノードで BLOB FUSE を使用してマウントする Azure Storage コンテナー。 このプロパティは、他のすべてのプロパティと相互に排他的です。
azureFileShareConfiguration	AzureFileShareConfiguration	各ノードにマウントする Azure ファイル共有。 このプロパティは、他のすべてのプロパティと相互に排他的です。
cifsMountConfiguration	CIFSMountConfiguration	各ノードにマウントする CIFS/SMB ファイル システム。 このプロパティは、他のすべてのプロパティと相互に排他的です。
nfsMountConfiguration	NFSMountConfiguration	各ノードにマウントする NFS ファイル システム。 このプロパティは、他のすべてのプロパティと相互に排他的です。

NameValuePair

名前と値のペアを表します。

名前	型	説明
name	string	名前と値のペアの名前。
value	string	名前と値のペアの値。

NetworkConfiguration

プールのネットワーク構成。

名前	型	説明
dynamicVNetAssignmentScope	DynamicVNetAssignmentScope	動的 vnet 割り当てのスコープ。
enableAcceleratedNetworking	boolean	このプールで高速ネットワークを有効にする必要があるかどうか。 高速ネットワークにより、VM への単一ルート I/O 仮想化 (SR-IOV) が可能になり、ネットワーク パフォーマンスが向上する可能性があります。 詳細については、https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overviewを参照してください。
endpointConfiguration	PoolEndpointConfiguration	Batch プール内のコンピューティング ノード上のエンドポイントの構成。
publicIPAddressConfiguration	PublicIPAddressConfiguration	Batch プール内のコンピューティング ノードのパブリック IP アドレス構成。 プールのネットワーク構成のパブリック IP アドレス構成。
subnetId	string	プールのコンピューティング ノードが参加する仮想ネットワーク サブネットの ARM リソース識別子。 これは、/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet} の形式です。 仮想ネットワークは、Azure Batch アカウントと同じリージョンとサブスクリプションに存在する必要があります。 指定されたサブネットには、プール内のコンピューティング ノードの数に対応できる十分な空き IP アドレスが必要です。 サブネットに十分な空き IP アドレスがない場合、プールはノードを部分的に割り当て、サイズ変更エラーが発生します。 "MicrosoftAzureBatch" サービス プリンシパルには、指定された VNet の "クラシック仮想マシン共同作成者" Role-Based アクセス制御 (RBAC) ロールが必要です。 指定したサブネットは、ノードでタスクをスケジュールできるように、Azure Batch サービスからの通信を許可する必要があります。 これは、指定された VNet にネットワーク セキュリティ グループ (NSG) が関連付けられているかどうかを確認することで確認できます。 指定したサブネット内のノードへの通信が NSG によって拒否された場合、Batch サービスはコンピューティング ノードの状態を使用不可に設定します。 ARM 仮想ネットワーク ('Microsoft.Network/virtualNetworks') のみがサポートされています。 指定した VNet にネットワーク セキュリティ グループ (NSG) が関連付けられている場合は、ポート 29876 や 29877 など、いくつかの予約済みシステム ポートを受信通信に対して有効にする必要があります。 また、ポート 443 で Azure Storage への送信接続を有効にします。 詳細については、次を参照してください: https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

受信エンドポイントに適用するネットワーク セキュリティ グループルール。

名前	型	説明
access	NetworkSecurityGroupRuleAccess	指定した IP アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。
priority	integer	このルールの優先順位。 プール内の優先順位は一意である必要があり、優先順位の順に評価されます。 数値が小さい方が優先度が高くなります。 たとえば、順序番号が 150、250、350 のルールを指定できます。 順序番号が 150 のルールは、順序が 250 のルールよりも優先されます。 許可される優先順位は 150 から 4096 です。 予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。
sourceAddressPrefix	string	ルールに一致する送信元アドレスプレフィックスまたはタグ。 有効な値は、1 つの IP アドレス (10.10.10.10.10)、IP サブネット (つまり 192.168.1.0/24)、既定のタグ、または * (すべてのアドレスの場合) です。 その他の値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。
sourcePortRanges	string[]	規則に一致するソース ポートの範囲。 有効な値は、'' (すべてのポート 0 から 65535)、特定のポート (つまり 22)、またはポート範囲 (つまり 100 から 200) です。ポートは 0 から 65535 の範囲である必要があります。このコレクション内の各エントリは、他のエントリ (範囲または個々のポート) と重複してはなりません。その他の値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。既定値は '' です。

NetworkSecurityGroupRuleAccess

指定した IP アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。

名前	型	説明
allow	string	アクセスを許可します。
deny	string	アクセスを拒否します。

NFSMountConfiguration

NFS ファイル システムへの接続に使用される情報。

名前	型	説明
mountOptions	string	mount コマンドに渡す追加のコマンド ライン オプション。 これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。
relativeMountPath	string	ファイル システムがマウントされるコンピューティング ノード上の相対パス すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。
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	Batch プールでのノード配置ポリシーの種類。 ノードをプロビジョニングするために Batch Service によって使用される割り当てポリシー。 指定しない場合、Batch はリージョン ポリシーを使用します。

NodePlacementPolicyType

プール内のノードを割り当てる配置ポリシー。

名前	型	説明
regional	string	プール内のすべてのノードは、同じリージョンに割り当てられます。
zonal	string	プール内のノードは、ベスト エフォート分散によって異なる可用性ゾーンに分散されます。

OSDisk

コンピューティング ノード (VM) のオペレーティング システム ディスクの設定。

名前	型	説明
caching	CachingType	キャッシュ要件を指定します。 使用できる値は None、ReadOnly、ReadWrite です。 既定値は、Standard Storage の場合は [なし] です。 Premium Storage の ReadOnly。 キャッシュの既定値は none です。 キャッシュ オプションの詳細については、「https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/」を参照してください。
diskSizeGB	integer	新しい OS ディスクを作成するときの初期ディスク サイズ (GB)。
ephemeralOSDiskSettings	DiffDiskSettings	コンピューティング ノード (VM) によって使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。
managedDisk	ManagedDisk	マネージド ディスクのパラメーター。
writeAcceleratorEnabled	boolean	ディスクで writeAccelerator を有効または無効にするかどうかを指定します。

PoolEndpointConfiguration

プールのエンドポイント構成。

名前	型	説明
inboundNATPools	InboundNATPool[]	個々のコンピューティング ノード上の特定のポートを外部でアドレス指定するために使用できる受信 NAT プールの一覧。 バッチ プールあたりの受信 NAT プールの最大数は 5 です。 受信 NAT プールの最大数を超えた場合、要求は HTTP 状態コード 400 で失敗します。 IPAddressProvisioningType が NoPublicIPAddresses の場合、これは指定できません。

PoolIdentityType

Batch プールの ID (構成されている場合)。

名前	型	説明
None	string	バッチ プールには ID が関連付けされません。 更新プールで None を設定すると、既存の ID が削除されます。
UserAssigned	string	Batch プールには、ユーザー割り当て ID があります。

PoolState

プールの現在の状態。

名前	型	説明
active	string	プールは、コンピューティング ノードの可用性に応じてタスクを実行するために使用できます。
deleting	string	ユーザーはプールの削除を要求しましたが、削除操作はまだ完了していません。

PoolStatistics

プールの有効期間中の使用率とリソース使用状況の統計情報が含まれます。

名前	型	説明
lastUpdateTime	string	統計が最後に更新された時刻。 すべての統計は、startTime と lastUpdateTime の間の範囲に制限されます。
resourceStats	ResourceStatistics	プール内のコンピューティング ノード別のリソース消費に関連する統計。
startTime	string	統計の対象となる時間範囲の開始時刻。
url	string	統計の URL。
usageStats	UsageStatistics	プールの使用状況に関連する統計 (コア時間の使用量など)。

PublicIPAddressConfiguration

プールのネットワーク構成のパブリック IP アドレス構成。

名前	型	説明
ipAddressIds	string[]	Batch サービスがコンピューティング ノードのプロビジョニング時に使用するパブリック IP の一覧。 ここで指定する IP の数によって、プールの最大サイズが制限されます。パブリック IP ごとに 100 個の専用ノードまたは 100 個のスポット/低優先度ノードを割り当て可能です。 たとえば、250 個の専用 VM を必要とするプールには、少なくとも 3 つのパブリック IP が指定されている必要があります。 このコレクションの各要素は、/subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip} の形式です。
provision	IPAddressProvisioningType	プールのパブリック IP アドレスのプロビジョニングの種類。 既定値は BatchManaged です。

ResizeError

プールのサイズを変更するときに発生したエラー。

名前	型	説明
code	string	プールのサイズ変更エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。
message	string	ユーザー インターフェイスでの表示に適したプールサイズ変更エラーを説明するメッセージ。
values	NameValuePair[]	プールのサイズ変更エラーに関連する追加のエラーの詳細の一覧。

ResourceFile

コンピューティング ノードにダウンロードする 1 つのファイルまたは複数のファイル。

名前	型	説明
autoStorageContainerName	string	自動ストレージ アカウントのストレージ コンテナー名。 autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。
blobPrefix	string	Azure Storage コンテナーから BLOB をダウンロードするときに使用する BLOB プレフィックス。 指定したプレフィックスで始まる名前の BLOB のみがダウンロードされます。 このプロパティは、autoStorageContainerName または storageContainerUrl が使用されている場合にのみ有効です。 このプレフィックスには、部分的なファイル名またはサブディレクトリを指定できます。 プレフィックスが指定されていない場合は、コンテナー内のすべてのファイルがダウンロードされます。
fileMode	string	ファイルアクセス許可モード属性 (8 進数形式)。 このプロパティは、Linux コンピューティング ノードにダウンロードされるファイルにのみ適用されます。 これは、Windows コンピューティング ノードにダウンロードされる resourceFile に対して指定されている場合は無視されます。 Linux コンピューティング ノードにこのプロパティが指定されていない場合は、既定値の 0770 がファイルに適用されます。
filePath	string	タスクの作業ディレクトリを基準にして、ファイルをダウンロードするコンピューティング ノード上の場所。 httpUrl プロパティが指定されている場合、filePath は必須であり、ファイルのダウンロード先となるパス (ファイル名を含む) を記述します。 それ以外の場合、autoStorageContainerName または storageContainerUrl プロパティが指定されている場合、filePath は省略可能であり、ファイルをダウンロードするディレクトリです。 filePath がディレクトリとして使用されている場合、入力データに既に関連付けられているディレクトリ構造は完全に保持され、指定された filePath ディレクトリに追加されます。 指定した相対パスは、タスクの作業ディレクトリから抜け出すことはできません (たとえば、'..' を使用)。
httpUrl	string	ダウンロードするファイルの URL。 autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。 URL が Azure Blob Storage を指している場合は、コンピューティング ノードから読み取ることができる必要があります。 Azure Storage 内の BLOB のこのような URL を取得するには、3 つの方法があります。BLOB に対する読み取りアクセス許可を付与する Shared Access Signature (SAS) を含めるか、読み取りアクセス許可を持つマネージド ID を使用するか、BLOB またはそのコンテナーの ACL を設定してパブリック アクセスを許可します。
identityReference	ComputeNodeIdentityReference	storageContainerUrl または httpUrl で指定された Azure Blob Storage へのアクセスに使用するユーザー割り当て ID への参照 コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。
storageContainerUrl	string	Azure Blob Storage 内の BLOB コンテナーの URL。 autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。 この URL は、コンピューティング ノードから読み取り可能でリスト可能である必要があります。 Azure Storage 内のコンテナーのこのような URL を取得するには、3 つの方法があります。コンテナーに対する読み取りと一覧表示のアクセス許可を付与する Shared Access Signature (SAS) を含めるか、読み取りとリストのアクセス許可を持つマネージド ID を使用するか、コンテナーの ACL を設定してパブリック アクセスを許可します。

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	統計の対象となる時間範囲の開始時刻。

RollingUpgradePolicy

ローリング アップグレードの実行中に使用される構成パラメーター。

名前	型	説明
enableCrossZoneUpgrade	boolean	アップグレード バッチを構築するときに、VMSS が AZ 境界を無視できるようにします。 バッチ サイズを決定するには、更新ドメインと maxBatchInstancePercent を考慮してください。 このフィールドは、NodePlacementConfiguration をゾーンとして使用する場合にのみ true または false に設定できます。
maxBatchInstancePercent	integer	1 回のバッチでのローリング アップグレードによって同時にアップグレードされる仮想マシン インスタンスの合計数に対する最大割合。 これは最大であるため、以前または将来のバッチの異常なインスタンスでは、信頼性を高めるためにバッチ内のインスタンスの割合が減少する可能性があります。 このフィールドの値は、5 ~ 100 の範囲にする必要があります。 maxBatchInstancePercent と maxUnhealthyInstancePercent の両方に値が割り当てられている場合、maxBatchInstancePercent の値は maxUnhealthyInstancePercent を超えてはなりません。
maxUnhealthyInstancePercent	integer	アップグレードの結果として、またはローリング アップグレードが中止される前に仮想マシンの正常性チェックによって異常な状態で検出された場合に、同時に異常になる可能性があるスケール セット内の仮想マシン インスタンスの合計数に対する最大割合。 この制約は、バッチを開始する前にチェックされます。 このフィールドの値は、5 ~ 100 の範囲にする必要があります。 maxBatchInstancePercent と maxUnhealthyInstancePercent の両方に値が割り当てられている場合、maxBatchInstancePercent の値は maxUnhealthyInstancePercent を超えてはなりません。
maxUnhealthyUpgradedInstancePercent	integer	異常な状態にあると検出できるアップグレードされた仮想マシン インスタンスの最大割合。 このチェックは、各バッチがアップグレードされた後に行われます。 この割合を超えた場合、ローリング アップデートは中止されます。 このフィールドの値は、0 ~ 100 の範囲にする必要があります。
pauseTimeBetweenBatches	string	すべての仮想マシンの更新を 1 つのバッチで完了してから次のバッチを開始するまでの待機時間。 期間は ISO 8601 形式で指定する必要があります。
prioritizeUnhealthyInstances	boolean	正常なインスタンスの前に、スケール セット内のすべての異常なインスタンスをアップグレードします。
rollbackFailedInstancesOnPolicyBreach	boolean	ローリング アップグレード ポリシーに違反した場合、失敗したインスタンスを以前のモデルにロールバックします。

SecurityEncryptionTypes

マネージド ディスクの EncryptionType を指定します。 VMGuestState BLOB のみを暗号化する場合は VMGuestStateOnly に、VMGuestState BLOB にファームウェアの状態を保持しない場合は NonPersistedTPM に設定されます。 注: 機密 VM にのみ設定でき、機密 VM を使用する場合に必要です。

名前	型	説明
NonPersistedTPM	string
VMGuestStateOnly	string

SecurityProfile

仮想マシンまたは仮想マシン スケール セットのセキュリティ プロファイル設定を指定します。

名前	型	説明
encryptionAtHost	boolean	このプロパティは、要求のユーザーが仮想マシンまたは仮想マシン スケール セットの Host Encryption を有効または無効にするために使用できます。 これにより、ホスト自体のリソース/一時ディスクを含むすべてのディスクの暗号化が有効になります。 ホスト要件での暗号化の詳細については、https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizesを参照してください。
securityType	SecurityTypes	仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。
uefiSettings	UefiSettings	仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。 仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。

SecurityTypes

仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。

名前	型	説明
confidentialVM	string	Azure コンフィデンシャル コンピューティングは、セキュリティと機密性の高い要件を持つテナント向けの機密 VM を提供します。 これらの VM は、セキュリティ ニーズを満たすのに役立つ強力なハードウェア強制境界を提供します。 コードを変更することなく、機密 VM を移行に使用できます。プラットフォームを使用すると、VM の状態が読み取られたり変更されたりするのを防いでいます。
trustedLaunch	string	信頼できる起動は、高度で永続的な攻撃手法から保護します。

ServiceArtifactReference

"最新" イメージ バージョンを使用する場合に、スケール セット内のすべての仮想マシンに同じイメージ バージョンを設定するために使用されるサービス 成果物参照 ID を指定します。

名前	型	説明
id	string	ServiceArtifactReference のサービス 成果物参照 ID /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} の形式のサービス 成果物参照 ID

StartTask

ノードが Azure Batch サービスのプールに参加したとき、またはコンピューティング ノードが再起動または再イメージ化されたときに実行されるタスク。

名前	型	説明
commandLine	string	StartTask のコマンド ライン。 コマンド ラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windows では "cmd /c MyCommand" を使用し、Linux では "/bin/sh -c MyCommand" を使用します。 コマンド ラインがファイル パスを参照している場合は、相対パス (Task 作業ディレクトリに対する相対パス) を使用するか、Batch で指定された環境変数 (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables) を使用する必要があります。
containerSettings	TaskContainerSettings	StartTask を実行するコンテナーの設定。 これを指定すると、AZ_BATCH_NODE_ROOT_DIRの下にあるすべてのディレクトリ (ノード上の Azure Batch ディレクトリのルート) がコンテナーに再帰的にマップされ、すべての Task 環境変数がコンテナーにマップされ、タスク コマンド ラインがコンテナーで実行されます。 AZ_BATCH_NODE_ROOT_DIR外のコンテナーで生成されたファイルはホスト ディスクに反映されない可能性があります。つまり、Batch ファイル API はそれらのファイルにアクセスできません。
environmentSettings	EnvironmentSetting[]	StartTask の環境変数設定の一覧。
maxTaskRetryCount	integer	タスクを再試行できる最大回数。 終了コードが 0 以外の場合、Batch サービスはタスクを再試行します。 この値は、再試行回数を特に制御します。 Batch サービスはタスクを 1 回試し、この制限まで再試行できます。 たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (1 回の最初の再試行と 3 回の再試行)。 最大再試行回数が 0 の場合、Batch サービスはタスクを再試行しません。 最大再試行回数が -1 の場合、Batch サービスは制限なくタスクを再試行しますが、これは開始タスクまたはタスクには推奨されません。 既定値は 0 (再試行なし) です。
resourceFiles	ResourceFile[]	コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 リソース ファイルの一覧には最大サイズがあります。 最大サイズを超えると、要求は失敗し、応答エラー コードは RequestEntityTooLarge になります。 この場合、ResourceFiles のコレクションのサイズを小さくする必要があります。 これは、.zip ファイル、アプリケーション パッケージ、または Docker コンテナーを使用して実現できます。 この要素の下に一覧表示されるファイルは、タスクの作業ディレクトリにあります。
userIdentity	UserIdentity	StartTask を実行するユーザー ID。 省略した場合、タスクはタスクに固有の非管理ユーザーとして実行されます。
waitForSuccess	boolean	コンピューティング ノードでタスクをスケジュールする前に、Batch サービスが StartTask が正常に完了するまで (つまり、終了コード 0 で終了する) のを待つ必要があるかどうか。 True で、ノードで StartTask が失敗した場合、Batch サービスは StartTask を最大再試行回数 (maxTaskRetryCount) まで再試行します。 すべての再試行の後もタスクが正常に完了していない場合、Batch サービスはノードを使用不可としてマークし、タスクをスケジュールしません。 この状態は、コンピューティング ノードの状態とエラー情報の詳細を使用して検出できます。 false の場合、Batch サービスは StartTask の完了を待機しません。 この場合、StartTask がまだ実行されている間に、コンピューティング ノードで他のタスクの実行を開始できます。StartTask が失敗した場合でも、新しいタスクはコンピューティング ノードで引き続きスケジュールされます。 既定値は true です。

StorageAccountType

データ ディスクまたは OS ディスクの作成に使用するストレージ アカウントの種類。

名前	型	説明
premium_lrs	string	データ ディスク/OS ディスクでは、Premium ローカル冗長ストレージを使用する必要があります。
standard_lrs	string	データ ディスク/OS ディスクでは、標準のローカル冗長ストレージを使用する必要があります。
standardssd_lrs	string	データ ディスク/OS ディスクでは、Standard SSD のローカル冗長ストレージを使用する必要があります。

TaskContainerSettings

タスクのコンテナー設定。

名前	型	説明
containerHostBatchBindMounts	ContainerHostBatchBindMountEntry[]	コンテナー タスクにマウントするパス。 この配列が null または存在しない場合、コンテナー タスクは一時ディスク ドライブ全体を Windows (または Linux では AZ_BATCH_NODE_ROOT_DIR) にマウントします。 この配列が空として設定されている場合、データ パスはコンテナーにマウントされません。
containerRunOptions	string	コンテナー作成コマンドの追加オプション。 これらの追加オプションは、Batch サービスによって制御されるオプションに加えて、"docker create" コマンドの引数として提供されます。
imageName	string	タスクを実行するコンテナーの作成に使用するイメージ。 これは、"docker pull" に指定されているように、完全なイメージ参照です。 イメージ名の一部としてタグが指定されていない場合は、タグ ":latest" が既定として使用されます。
registry	ContainerRegistry	コンテナー イメージを含むプライベート レジストリ。 この設定は、プールの作成時に既に指定されている場合は省略できます。
workingDirectory	ContainerWorkingDirectory	コンテナータスク作業ディレクトリの場所。 既定値は 'taskWorkingDirectory' です。

TaskSchedulingPolicy

タスクをコンピューティング ノード間で分散する方法を指定します。

名前	型	説明
nodeFillType	ComputeNodeFillType	プール内のコンピューティング ノード間でタスクを分散する方法。 指定しない場合、既定値はスプレッドです。

UefiSettings

仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。

名前	型	説明
secureBootEnabled	boolean	仮想マシンでセキュア ブートを有効にするかどうかを指定します。
vTpmEnabled	boolean	仮想マシンで vTPM を有効にするかどうかを指定します。

UpgradeMode

スケール セット内の仮想マシンへのアップグレード モードを指定します。

使用可能な値は次のとおりです。

手動 - スケール セット内の仮想マシンへの更新プログラムの適用を制御します。 これを行うには、manualUpgrade アクションを使用します。

自動 - スケール セット内のすべての仮想マシンが同時に自動的に更新されます。

ローリング - スケール セットは、必要に応じて一時停止時間の間にバッチで更新を実行します。

名前	型	説明
automatic	string	スケール セット内のすべての仮想マシンが同時に自動的に更新されます。
manual	string	スケール セット内の仮想マシンへの更新プログラムの適用を制御します。 これを行うには、manualUpgrade アクションを使用します。
rolling	string	スケール セット内の既存のインスタンスは、アップグレードするバッチでダウンします。 アップグレードされたバッチが完了すると、インスタンスはトラフィックの取得を再開し、次のバッチが開始されます。 これは、すべてのインスタンスが -date を up-toするまで続けられます。

UpgradePolicy

アップグレード ポリシー (自動、手動、またはローリング) について説明します。

名前	型	説明
automaticOSUpgradePolicy	AutomaticOSUpgradePolicy	OS の自動アップグレードを実行するために使用される構成パラメーター。 OS の自動アップグレードを実行するために使用される構成パラメーター。
mode	UpgradeMode	スケール セット内の仮想マシンへのアップグレード モードを指定します。 使用可能な値は次のとおりです。 手動 - スケール セット内の仮想マシンへの更新プログラムの適用を制御します。 これを行うには、manualUpgrade アクションを使用します。 自動 - スケール セット内のすべての仮想マシンが同時に自動的に更新されます。 ローリング - スケール セットは、必要に応じて一時停止時間の間にバッチで更新を実行します。
rollingUpgradePolicy	RollingUpgradePolicy	ローリング アップグレードの実行中に使用される構成パラメーター。 ローリング アップグレードの実行中に使用される構成パラメーター。

UsageStatistics

プールの使用状況情報に関連する統計。

名前	型	説明
dedicatedCoreTime	string	プールの一部である専用のコンピューティング ノード コアの集約された実時間。
lastUpdateTime	string	統計が最後に更新された時刻。 すべての統計は、startTime と lastUpdateTime の間の範囲に制限されます。
startTime	string	統計の対象となる時間範囲の開始時刻。

UserAccount

Azure Batch コンピューティング ノードでタスクを実行するために使用するユーザーの作成に使用されるプロパティ。

名前	型	説明
elevationLevel	ElevationLevel	ユーザー アカウントの昇格レベル。 既定値は nonAdmin です。
linuxUserConfiguration	LinuxUserConfiguration	ユーザー アカウントの Linux 固有のユーザー構成。 このプロパティは、Windows プールで指定されている場合は無視されます。 指定しない場合、ユーザーは既定のオプションで作成されます。
name	string	ユーザー アカウントの名前。 名前には、最大 20 文字までの Unicode 文字を含めることができます。
password	string	ユーザー アカウントのパスワード。
windowsUserConfiguration	WindowsUserConfiguration	ユーザー アカウントの Windows 固有のユーザー構成。 このプロパティは、ユーザーが Windows プール上にある場合にのみ指定できます。 指定されていない場合、Windows プールでは、既定のオプションを使用してユーザーが作成されます。

UserAssignedIdentity

ユーザー割り当て ID

名前	型	説明
clientId	string	ユーザー割り当て ID のクライアント ID。
principalId	string	ユーザー割り当て ID のプリンシパル ID。
resourceId	string	ユーザー割り当て ID の ARM リソース ID

UserIdentity

タスクを実行するユーザー ID の定義。

名前	型	説明
autoUser	AutoUserSpecification	タスクを実行する自動ユーザー。 userName プロパティと autoUser プロパティは相互に排他的です。1 つを指定する必要がありますが、両方を指定する必要はありません。
username	string	タスクを実行するユーザー ID の名前。 userName プロパティと autoUser プロパティは相互に排他的です。1 つを指定する必要がありますが、両方を指定する必要はありません。

VirtualMachineConfiguration

Azure Virtual Machines インフラストラクチャに基づくプール内のコンピューティング ノードの構成。

名前	型	説明
containerConfiguration	ContainerConfiguration	プールのコンテナー構成。 指定した場合、タスクをコンテナーで実行できるように、プール内の各コンピューティング ノードに対してセットアップが実行されます。 このプールで実行されるすべての通常のタスクとジョブ マネージャー タスクは containerSettings プロパティを指定する必要があり、他のすべてのタスクで指定できます。
dataDisks	DataDisk[]	プール内のコンピューティング ノードに接続されているデータ ディスクの構成。 プール内のコンピューティング ノードに空のデータ ディスクが接続されている必要がある場合は、このプロパティを指定する必要があります。 これは更新できません。 各コンピューティング ノードは、独自のディスクを取得します (ディスクはファイル共有ではありません)。 既存のディスクを接続できません。接続されている各ディスクは空です。 コンピューティング ノードがプールから削除されると、ディスクとそのノードに関連付けられているすべてのデータも削除されます。 ディスクは接続後にフォーマットされません。使用する前にフォーマットする必要があります。詳細については、https://docs.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux と https://docs.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machineを参照してください。
diskEncryptionConfiguration	DiskEncryptionConfiguration	プールのディスク暗号化構成。 指定した場合、暗号化は、ノードのプロビジョニング中にプール内の各ノードで実行されます。
extensions	VMExtension[]	プールの仮想マシン拡張機能。 指定した場合、この構成に記載されている拡張機能が各ノードにインストールされます。
imageReference	ImageReference	使用する Azure Virtual Machines Marketplace イメージまたはカスタム仮想マシン イメージへの参照。
licenseType	string	オペレーティング システムの展開時に使用するオンプレミス ライセンスの種類。 これは、Windows オペレーティング システムを含むイメージにのみ適用され、デプロイされるコンピューティング ノードの有効なオンプレミス ライセンスを保持している場合にのみ使用する必要があります。 省略した場合、オンプレミスのライセンス割引は適用されません。 値は次のとおりです。 Windows_Server - オンプレミスライセンスは Windows Server 用です。 Windows_Client - オンプレミス ライセンスは Windows クライアント用です。
nodeAgentSKUId	string	プール内のコンピューティング ノードにプロビジョニングされる Batch コンピューティング ノード エージェントの SKU。 Batch コンピューティング ノード エージェントは、プール内の各コンピューティング ノードで実行されるプログラムであり、コンピューティング ノードと Batch サービスの間のコマンドアンドコントロール インターフェイスを提供します。 コンピューティング ノード エージェントの実装は、SKU と呼ばれ、オペレーティング システムごとに異なります。 選択したイメージ参照と一致するコンピューティング ノード エージェント SKU を指定する必要があります。 サポートされているコンピューティング ノード エージェント SKU の一覧と検証済みイメージ参照の一覧を取得するには、「サポートされているコンピューティング ノード エージェント SKU の一覧」操作を参照してください。
nodePlacementConfiguration	NodePlacementConfiguration	プールのノード配置構成。 この構成では、プール内のノードを物理的に割り当てる方法に関する規則を指定します。
osDisk	OSDisk	仮想マシンのオペレーティング システム ディスクの設定。
securityProfile	SecurityProfile	仮想マシンまたは仮想マシン スケール セットのセキュリティ プロファイル設定を指定します。 仮想マシンまたは仮想マシン スケール セットのセキュリティ プロファイル設定を指定します。
serviceArtifactReference	ServiceArtifactReference	"最新" イメージ バージョンを使用する場合に、スケール セット内のすべての仮想マシンに同じイメージ バージョンを設定するために使用されるサービス 成果物参照 ID を指定します。 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} の形式のサービス 成果物参照 ID
windowsConfiguration	WindowsConfiguration	仮想マシン上の Windows オペレーティング システムの設定。 imageReference プロパティで Linux OS イメージが指定されている場合は、このプロパティを指定しないでください。

VMDiskSecurityProfile

マネージド ディスクのセキュリティ プロファイル設定を指定します。 注: 機密 VM に対してのみ設定でき、機密 VM を使用する場合に必要です。

名前	型	説明
securityEncryptionType	SecurityEncryptionTypes	マネージド ディスクの EncryptionType を指定します。 VMGuestState BLOB のみを暗号化する場合は VMGuestStateOnly に、VMGuestState BLOB にファームウェアの状態を保持しない場合は NonPersistedTPM に設定されます。 注: 機密 VM にのみ設定でき、機密 VM を使用する場合に必要です。

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	仮想マシンで自動更新が有効になっているかどうか。 省略した場合、既定値は true です。

WindowsUserConfiguration

Windows コンピューティング ノードでユーザー アカウントを作成するために使用されるプロパティ。

名前	型	説明
loginMode	LoginMode	ユーザーのログイン モード 既定値は "batch" です。