Pools - Create Pool

サービス:

Batch Service

API バージョン:

2025-06-01

指定されたアカウントにプールが作成されます。
プールに名前を付ける場合は、ユーザー名やシークレット プロジェクト名などの機密情報を含めないでください。 この情報は、Microsoft サポート エンジニアがアクセスできるテレメトリ ログに表示される場合があります。

POST {endpoint}/pools?api-version=2025-06-01

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

POST {endpoint}/pools?api-version=2025-06-01&timeOut={timeOut}

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	Batch アカウント エンドポイント (例: https://batchaccount.eastus2.batch.azure.com)。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
timeOut	query		integer (int32)	サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 30 秒です。 値が30より大きい場合は、デフォルトが使われます。」

要求ヘッダー

Media Types: "application/json; odata=minimalmetadata"

名前	必須	型	説明
client-request-id		string	呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (例: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。
return-client-request-id		boolean	サーバーが応答で client-request-id を返す必要があるかどうか。
ocp-date		string (date-time-rfc7231)	要求が発行された時刻。 通常、クライアント ライブラリはこれを現在のシステム クロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。

要求本文

Media Types: "application/json; odata=minimalmetadata"

名前	必須	型	説明
id	True	string	アカウント内のプールを一意に識別する文字列。 ID には、ハイフンやアンダースコアを含む任意の英数字を組み合わせて使用でき、64 文字を超えることはできません。 ID は大文字と小文字が区別されず、大文字と小文字が区別されません (つまり、アカウント内に、大文字と小文字のみが異なる 2 つのプール ID がない可能性があります)。
vmSize	True	string	プール内の仮想マシンのサイズ。 プール内のすべての仮想マシンのサイズは同じです。 Virtual Machines Marketplace のイメージを使用するプール (virtualMachineConfiguration で作成されたプール) で使用可能な VM サイズの詳細については、「Azure の Virtual Machines のサイズ (https://learn.microsoft.com/azure/virtual-machines/sizes/overview)」を参照してください。 Batch では、STANDARD_A0と Premium Storage (STANDARD_GS、STANDARD_DS、STANDARD_DSV2 シリーズ) を除くすべての Azure VM サイズがサポートされます。
applicationPackageReferences		BatchApplicationPackageReference[]	プール内の各コンピューティング ノードにインストールするパッケージの一覧。 プールを作成する場合、パッケージのアプリケーション ID は完全修飾 (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}) である必要があります。 パッケージ参照への変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、既にプール内にあるコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のパッケージ参照があります。
autoScaleEvaluationInterval		string (duration)	自動スケールの数式に従ってプール のサイズを自動的に調整する時間間隔。 既定値は 15 分です。 最小値と最大値はそれぞれ 5 分と 168 時間です。 5 分未満または 168 時間を超える値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
autoScaleFormula		string	プール内のコンピューティング ノードの必要な数の数式。 enableAutoScale が false に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が true に設定されている場合は必須です。 プールが作成される前に、数式の有効性がチェックされます。 数式が無効な場合、Batch サービスは詳細なエラー情報を含む要求を拒否します。 この数式の指定の詳細については、「Azure Batch プール内のコンピューティング ノードを自動的にスケーリングする」(https://learn.microsoft.com/azure/batch/batch-automatic-scaling) を参照してください。
displayName		string	プールの表示名。 表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。
enableAutoScale		boolean	プール サイズが時間の経過と同時に自動的に調整されるかどうか。 false の場合は、targetDedicatedNodes と targetLowPriorityNodes の少なくとも 1 つを指定する必要があります。 true の場合、autoScaleFormula プロパティが必要であり、プールは数式に従って自動的にサイズ変更されます。 既定値は false です。
enableInterNodeCommunication		boolean	プールがコンピューティング ノード間の直接通信を許可するかどうか。 ノード間通信を有効にすると、プールのコンピューティング ノードのデプロイ制限により、プールの最大サイズが制限されます。 これにより、プールが目的のサイズに達しない可能性があります。 既定値は false です。
metadata		BatchMetadataItem[]	メタデータとしてプールに関連付けられている名前と値のペアの一覧。 Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。
mountConfiguration		MountConfiguration[]	プールの存続期間中、指定されたファイルシステムを使用してストレージをマウントします。 Azure ファイル共有、NFS、CIFS、または Blobfuse ベースのファイル システムを使用してストレージをマウントします。
networkConfiguration		NetworkConfiguration	プールのネットワーク構成。
resizeTimeout		string (duration)	プールへのコンピューティング ノードの割り当てのタイムアウト。 このタイムアウトは、手動スケーリングにのみ適用されます。enableAutoScale が true に設定されている場合、効果はありません。 既定値は 15 分です。 最小値は 5 分です。 5 分未満の値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
startTask		BatchStartTask	プールに参加する各コンピューティング ノードで実行するように指定されたタスク。 タスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。
targetDedicatedNodes		integer (int32)	プール内の専用コンピューティング ノードの必要な数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。
targetLowPriorityNodes		integer (int32)	プール内のスポット/優先順位の低いコンピューティング ノードの目的の数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。
taskSchedulingPolicy		BatchTaskSchedulingPolicy	プール内のコンピューティング ノード間でタスクを分散する方法。 指定しない場合、既定値はスプレッドです。
taskSlotsPerNode		integer (int32)	プール内の 1 つのコンピューティング ノードで同時実行タスクを実行するために使用できるタスク スロットの数。 既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。
upgradePolicy		UpgradePolicy	プールのアップグレード ポリシー。 アップグレード ポリシー (自動、手動、またはローリング) について説明します。
userAccounts		UserAccount[]	プール内の各コンピューティング ノードに作成するユーザー アカウントの一覧。
virtualMachineConfiguration		VirtualMachineConfiguration	プールの仮想マシン構成。 このプロパティの指定は必須です。

応答

名前	型	説明
201 Created		要求が成功し、結果として新しいリソースが作成されました。 ヘッダー DataServiceId: string ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前	説明
https://batch.core.windows.net//.default

例

Creates a pool with accelerated networking

Creates a pool with confidential disk encryption set for user subscription accounts

Creates a pool with disk encryption set for user subscription accounts

Creates a pool with dual stack networking

Creates a pool with mount drive specified

Creates a pool with SecurityProfile

Creates a VirtualMachineConfiguration pool

Creates a VirtualMachineConfiguration pool with containers

Creates a VirtualMachineConfiguration pool with extensions

Creates a VirtualMachineConfiguration pool with OS disk

Creates a VirtualMachineConfiguration pool with ServiceArtifactReference

Creates a pool with accelerated networking

要求のサンプル

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "mypool01",
  "vmSize": "Standard_D1_v2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2025-datacenter-smalldisk",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 2,
  "networkConfiguration": {
    "enableAcceleratedNetworking": true
  }
}

応答のサンプル

状態コード:

201

Creates a pool with confidential disk encryption set for user subscription accounts

要求のサンプル

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool",
  "vmSize": "Standard_DC2as_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2019-datacenter-core-g2",
      "version": "latest"
    },
    "osDisk": {
      "managedDisk": {
        "storageAccountType": "standard_lrs",
        "diskEncryptionSet": {
          "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
        },
        "securityProfile": {
          "securityEncryptionType": "DiskWithVMGuestState"
        }
      }
    },
    "dataDisks": [
      {
        "lun": 0,
        "diskSizeGB": 1024,
        "managedDisk": {
          "storageAccountType": "standard_lrs",
          "diskEncryptionSet": {
            "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
          }
        }
      }
    ],
    "securityProfile": {
      "securityType": "confidentialvm",
      "uefiSettings": {
        "vTpmEnabled": true,
        "secureBootEnabled": true
      }
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 1
}

応答のサンプル

状態コード:

201

Creates a pool with disk encryption set for user subscription accounts

要求のサンプル

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool",
  "vmSize": "Standard_D2ds_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2019-datacenter-core-g2",
      "version": "latest"
    },
    "osDisk": {
      "managedDisk": {
        "storageAccountType": "standard_lrs",
        "diskEncryptionSet": {
          "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
        }
      }
    },
    "dataDisks": [
      {
        "lun": 0,
        "diskSizeGB": 1024,
        "managedDisk": {
          "storageAccountType": "standard_lrs",
          "diskEncryptionSet": {
            "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
          }
        }
      }
    ],
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 1
}

応答のサンプル

状態コード:

201

Creates a pool with dual stack networking

要求のサンプル

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "dualstackpool",
  "vmSize": "Standard_D2ds_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "networkConfiguration": {
    "publicIPAddressConfiguration": {
      "ipFamilies": [
        "IPv4",
        "IPv6"
      ]
    },
    "endpointConfiguration": {
      "inboundNATPools": [
        {
          "backendPort": 22,
          "frontendPortRangeStart": 40000,
          "frontendPortRangeEnd": 40500,
          "name": "sshpool",
          "protocol": "tcp",
          "networkSecurityGroupRules": [
            {
              "access": "allow",
              "priority": 1000,
              "sourceAddressPrefix": "*",
              "sourcePortRanges": [
                "*"
              ]
            }
          ]
        }
      ]
    }
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0
}

応答のサンプル

状態コード:

201

Creates a pool with mount drive specified

要求のサンプル

HTTP

POST {endpoint}/pools?api-version=2025-06-01


{
  "id": "pool2",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "mountConfiguration": [
    {
      "azureBlobFileSystemConfiguration": {
        "accountName": "accountName",
        "containerName": "blobContainerName",
        "accountKey": "accountKey",
        "relativeMountPath": "bfusepath"
      }
    },
    {
      "azureFileShareConfiguration": {
        "accountName": "accountName",
        "azureFileUrl": "https://myaccount.file.core.windows.net/fileshare",
        "accountKey": "accountKey",
        "relativeMountPath": "filesharepath",
        "mountOptions": "mount options ver=1.0"
      }
    },
    {
      "nfsMountConfiguration": {
        "source": "somesource nfs url",
        "relativeMountPath": "mountpath",
        "mountOptions": "mount options ver=1.0"
      }
    },
    {
      "cifsMountConfiguration": {
        "username": "accountName",
        "password": "password",
        "source": "//myaccount.file.core.windows.net/file",
        "relativeMountPath": "mountpath",
        "mountOptions": "mount options ver=1.0"
      }
    }
  ],
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false
}

応答のサンプル

状態コード:

201

Creates a pool with SecurityProfile

要求のサンプル

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "mypool001",
  "vmSize": "STANDARD_DC2s_V2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "18_04-lts-gen2",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 18.04",
    "securityProfile": {
      "securityType": "trustedLaunch",
      "encryptionAtHost": true,
      "uefiSettings": {
        "secureBootEnabled": false,
        "vTpmEnabled": null
      }
    }
  },
  "targetDedicatedNodes": 1
}

応答のサンプル

状態コード:

201

Creates a VirtualMachineConfiguration pool

要求のサンプル

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool2",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

応答のサンプル

状態コード:

201

Creates a VirtualMachineConfiguration pool with containers

要求のサンプル

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool2",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "120_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04",
    "containerConfiguration": {
      "type": "dockerCompatible",
      "containerImageNames": [
        "busybox"
      ]
    }
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false
}

応答のサンプル

状態コード:

201

Creates a VirtualMachineConfiguration pool with extensions

要求のサンプル

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool2",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "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"
        }
      }
    ]
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

応答のサンプル

状態コード:

201

Creates a VirtualMachineConfiguration pool with OS disk

要求のサンプル

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "mypool001",
  "vmSize": "Standard_D2ds_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "osDisk": {
      "diskSizeGB": 100,
      "managedDisk": {
        "storageAccountType": "standardssd_lrs"
      },
      "caching": "readwrite",
      "ephemeralOSDiskSettings": {
        "placement": "cachedisk"
      }
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 1,
  "enableAutoScale": false
}

応答のサンプル

状態コード:

201

Creates a VirtualMachineConfiguration pool with ServiceArtifactReference

要求のサンプル

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "mypool002",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2025-datacenter-smalldisk",
      "version": "latest"
    },
    "windowsConfiguration": {
      "enableAutomaticUpdates": false
    },
    "serviceArtifactReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 2
}

応答のサンプル

状態コード:

201

定義

名前	説明
AutomaticOsUpgradePolicy	OS の自動アップグレードを実行するために使用される構成パラメーター。
AutoUserScope	AutoUserScopeの列挙
AutoUserSpecification	Azure Batch タスクを実行する自動ユーザーのオプションを指定します。
AzureBlobFileSystemConfiguration	Blobfuse を使用して Azure Storage コンテナーに接続するために使用される情報。
AzureFileShareConfiguration	Azure ファイル共有への接続に使用される情報。
BatchApplicationPackageReference	コンピューティング ノードにデプロイするパッケージへの参照。
BatchContainerConfiguration	コンテナーが有効なプールの構成。
BatchDiffDiskSettings	コンピューティング ノード (VM) によって使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batch エラー応答に含まれる追加情報の項目。
BatchErrorMessage	Azure Batch エラー応答で受信したエラー メッセージ。
BatchInboundNatPool	Batch プール内のコンピューティング ノード上の特定のポートを外部でアドレス指定するために使用できる受信 NAT プール。
BatchJobDefaultOrder	BatchJobDefaultOrder 列挙
BatchMetadataItem	Batch サービスは、このメタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。
BatchNodeFillType	BatchNodeFillType の列挙
BatchNodeIdentityReference	コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。
BatchNodePlacementConfiguration	リージョン配置の場合、プール内のノードは同じリージョンに割り当てられます。 ゾーン配置の場合、プール内のノードは、ベスト エフォート分散を使用して異なるゾーンに分散されます。
BatchNodePlacementPolicyType	BatchNodePlacementPolicyType enums
BatchOsDisk	コンピューティング ノード (VM) のオペレーティング システム ディスクの設定。
BatchPoolCreateOptions	Azure Batch プールを作成するためのパラメーター。
BatchPoolEndpointConfiguration	プールのエンドポイント構成。
BatchPoolIdentityReference	ディスクを暗号化するためのプール ID の 1 つの参照。 この ID は、キー コンテナーへのアクセスに使用されます。
BatchPublicIpAddressConfiguration	プールのネットワーク構成のパブリック IP アドレス構成。
BatchStartTask	Batch は、ノードで復旧操作がトリガーされたときにタスクを再試行します。 復旧操作の例としては、異常なノードが再起動されたときや、ホスト障害が原因でコンピューティング ノードが消えた場合などです (ただし、これらに限定されません)。 回復操作による再試行は独立しており、maxTaskRetryCount に対してカウントされません。 maxTaskRetryCount が 0 の場合でも、復旧操作による内部再試行が発生する可能性があります。 このため、すべてのタスクはべき等である必要があります。 つまり、タスクは、破損やデータの重複を引き起こさずに中断および再起動されることを許容する必要があります。 実行時間の長いタスクのベスト プラクティスは、何らかの形式のチェックポイント処理を使用することです。 場合によっては、コンピューティング ノードが再起動されなかった場合でも、StartTask が再実行されることがあります。 中断プロセスを作成したり、StartTask 作業ディレクトリからサービスをインストール/起動したりする StartTask を回避するには、特別な注意が必要です。これにより、Batch で StartTask を再実行できなくなるためです。
BatchTaskContainerSettings	タスクのコンテナー設定。
BatchTaskSchedulingPolicy	タスクをコンピューティング ノード間で分散する方法を指定します。
BatchUefiSettings	仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。
BatchVmDiskSecurityProfile	マネージド ディスクのセキュリティ プロファイル設定を指定します。 注: これは機密仮想マシンに対してのみ設定でき、機密仮想マシンを使用する場合に必須です。
BatchVmImageReference	Azure Virtual Machines Marketplace イメージまたは Azure コンピューティング ギャラリー イメージへの参照。 Azure Batch によって検証されたすべての Azure Marketplace イメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。
CachingType	キャッシュタイプ列挙
CifsMountConfiguration	CIFS ファイル システムへの接続に使用される情報。
ContainerHostBatchBindMountEntry	タスク コンテナーにマウントするパスとマウント モードのエントリ。
ContainerHostDataPath	コンテナー タスクのコンテナーにマウントされるパス。
ContainerRegistryReference	プライベート コンテナー レジストリ。
ContainerType	コンテナタイプの列挙
ContainerWorkingDirectory	ContainerWorkingDirectory 列挙
DataDisk	プール内のコンピューティング ノードに関連付けられているデータ ディスクによって使用される設定。 接続されたデータ ディスクを使用する場合は、VM 内からディスクをマウントしてフォーマットして使用する必要があります。
DiffDiskPlacement	プール内のすべての計算ノード(VM)に対して、オペレーティングシステムディスクの一時的なディスク配置を指定します。 このプロパティは、オペレーティング システムを配置する場所を選択する要求でユーザーが使用できます。たとえば、エフェメラル OS ディスク プロビジョニング用のキャッシュ ディスク領域などです。 Ephemeral OSディスクサイズ要件の詳細については、「Ephemeral OS VM for Ephemeral OS disk size requirements at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements およびLinux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements
DiskCustomerManagedKey	ディスクを暗号化するためのカスタマー マネージド キー参照。
DiskEncryptionConfiguration	プール内のコンピューティング ノードに適用されるディスク暗号化構成。 ディスク暗号化の構成は、Azure コンピューティング ギャラリー イメージで作成された Linux プールではサポートされていません。
DiskEncryptionSetParameters	ディスク暗号化セットの ARM リソース ID。
DiskEncryptionTarget	DiskEncryptionTargetの列挙
DynamicVNetAssignmentScope	DynamicVNetAssignmentScope enums
ElevationLevel	ElevationLevel 列挙
EnvironmentSetting	タスク プロセスで設定する環境変数。
HostEndpointSettings	特定のホストエンドポイント設定を指定します。
HostEndpointSettingsModeTypes	HostEndpointSettingsModeTypes enum
InboundEndpointProtocol	InboundEndpointProtocol は列挙式です
IpAddressProvisioningType	IPAddressProvisioningType enums
IPFamily	プールで使用可能な IP バージョンを指定するために使用される IP ファミリ。
IPTag	パブリック IP アドレスに関連付けられている IP タグを格納します。
LinuxUserConfiguration	Linux コンピューティング ノードでユーザー アカウントを作成するために使用されるプロパティ。
LoginMode	LoginModeの列挙
ManagedDisk	マネージド ディスクのパラメーター。
MountConfiguration	各ノードにマウントするファイル システム。
NetworkConfiguration	プールのネットワーク構成。
NetworkSecurityGroupRule	受信エンドポイントに適用するネットワーク セキュリティ グループルール。
NetworkSecurityGroupRuleAccess	NetworkSecurityGroupRuleAccess の列挙
NfsMountConfiguration	NFS ファイル システムへの接続に使用される情報。
ProxyAgentSettings	仮想マシンの作成時に ProxyAgent の設定を指定します。
ResourceFile	コンピューティング ノードにダウンロードする 1 つのファイルまたは複数のファイル。
RollingUpgradePolicy	ローリング アップグレードの実行中に使用される構成パラメーター。
SecurityEncryptionTypes	セキュリティ暗号化タイプ列挙
SecurityProfile	仮想マシンまたは仮想マシン スケール セットのセキュリティ プロファイル設定を指定します。
SecurityTypes	仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。
ServiceArtifactReference	"最新" イメージ バージョンを使用する場合に、スケール セット内のすべての仮想マシンに同じイメージ バージョンを設定するために使用されるサービス 成果物参照 ID を指定します。
StorageAccountType	StorageAccountType 列挙型
UpgradeMode	UpgradeMode の列挙
UpgradePolicy	アップグレード ポリシー (自動、手動、またはローリング) について説明します。
UserAccount	Azure Batch コンピューティング ノードでタスクを実行するために使用するユーザーの作成に使用されるプロパティ。
UserIdentity	タスクを実行するユーザー ID の定義。 userName プロパティまたは autoUser プロパティを指定しますが、両方を指定することはできません。
VirtualMachineConfiguration	Azure Virtual Machines インフラストラクチャに基づくプール内のコンピューティング ノードの構成。
VMExtension	仮想マシン拡張機能の構成。
WindowsConfiguration	仮想マシンに適用する Windows オペレーティング システムの設定。
WindowsUserConfiguration	Windows コンピューティング ノードでユーザー アカウントを作成するために使用されるプロパティ。

AutomaticOsUpgradePolicy

Object

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

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

AutoUserScope

列挙

AutoUserScopeの列挙

値	説明
task	サービスがタスクのために新しいユーザーを作成することを指定します。
pool	タスクがプール内の各コンピュートノードで作成される共通自動ユーザーアカウントとして実行されることを指定します。

AutoUserSpecification

Object

Azure Batch タスクを実行する自動ユーザーのオプションを指定します。

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

AzureBlobFileSystemConfiguration

Object

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

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

AzureFileShareConfiguration

Object

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

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

BatchApplicationPackageReference

Object

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

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

BatchContainerConfiguration

Object

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

名前	型	説明
containerImageNames	string[]	コンテナイメージ名のコレクション。 これは「docker pull」で指定される完全なイメージ参照です。 イメージは、代替レジストリで完全に限定されていない限り、デフォルトのDockerレジストリからソース化されます。
containerRegistries	ContainerRegistryReference[]	コンテナーをプルできる追加のプライベート レジストリ。 もしプライベートレジストリからダウンロードする画像が認証情報が必要な場合は、その認証情報をここで提供しなければなりません。
type	ContainerType	使用するコンテナー テクノロジ。

BatchDiffDiskSettings

Object

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

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

BatchError

Object

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

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

BatchErrorDetail

Object

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

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

BatchErrorMessage

Object

Azure Batch エラー応答で受信したエラー メッセージ。

名前	型	説明
lang	string	エラーメッセージの言語コード。
value	string	メッセージのテキスト。

BatchInboundNatPool

Object

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

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

BatchJobDefaultOrder

列挙

BatchJobDefaultOrder 列挙

値	説明
none	タスクはプール内の同等優先度のすべてのジョブから均一にスケジューリングされるべきです。
creationtime	ジョブの優先度が同じ場合は、以前に作成されたジョブのタスクを優先してスケジューリングすべきです。

BatchMetadataItem

Object

Batch サービスは、このメタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。

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

BatchNodeFillType

列挙

BatchNodeFillType の列挙

値	説明
spread	タスクはプール内のすべてのコンピュートノードに均等に割り当てるべきです。
pack	次のコンピュートノードにタスクを割り当てる前に、できるだけ多くのタスク(taskSlotsPerNode)をプール内の各コンピュートノードに割り当てるべきです。

BatchNodeIdentityReference

Object

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

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

BatchNodePlacementConfiguration

Object

リージョン配置の場合、プール内のノードは同じリージョンに割り当てられます。 ゾーン配置の場合、プール内のノードは、ベスト エフォート分散を使用して異なるゾーンに分散されます。

名前	型	説明
policy	BatchNodePlacementPolicyType	Batch プールでのノード配置ポリシーの種類。 ノードをプロビジョニングするために Batch Service によって使用される割り当てポリシー。 指定しない場合、Batch はリージョン ポリシーを使用します。

BatchNodePlacementPolicyType

列挙

BatchNodePlacementPolicyType enums

値	説明
regional	プール内のすべてのノードは、同じリージョンに割り当てられます。
zonal	プール内のノードは異なる可用性ゾーンに分散し、ベストエフォートのバランスが取られます。

BatchOsDisk

Object

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

名前	型	説明
caching	CachingType	キャッシュ要件を指定します。 使用できる値は None、ReadOnly、ReadWrite です。 既定値は、Standard Storage の場合は [なし] です。 Premium Storage の ReadOnly。
diskSizeGB	integer (int32)	新しい OS ディスクを作成するときの初期ディスク サイズ (GB)。
ephemeralOSDiskSettings	BatchDiffDiskSettings	コンピューティング ノード (VM) によって使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。
managedDisk	ManagedDisk	マネージド ディスクのパラメーター。
writeAcceleratorEnabled	boolean	ディスクで writeAccelerator を有効または無効にするかどうかを指定します。

BatchPoolCreateOptions

Object

Azure Batch プールを作成するためのパラメーター。

名前	型	説明
applicationPackageReferences	BatchApplicationPackageReference[]	プール内の各コンピューティング ノードにインストールするパッケージの一覧。 プールを作成する場合、パッケージのアプリケーション ID は完全修飾 (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}) である必要があります。 パッケージ参照への変更は、プールに参加しているすべての新しいノードに影響しますが、再起動または再イメージ化されるまで、既にプール内にあるコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のパッケージ参照があります。
autoScaleEvaluationInterval	string (duration)	自動スケールの数式に従ってプール のサイズを自動的に調整する時間間隔。 既定値は 15 分です。 最小値と最大値はそれぞれ 5 分と 168 時間です。 5 分未満または 168 時間を超える値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
autoScaleFormula	string	プール内のコンピューティング ノードの必要な数の数式。 enableAutoScale が false に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が true に設定されている場合は必須です。 プールが作成される前に、数式の有効性がチェックされます。 数式が無効な場合、Batch サービスは詳細なエラー情報を含む要求を拒否します。 この数式の指定の詳細については、「Azure Batch プール内のコンピューティング ノードを自動的にスケーリングする」(https://learn.microsoft.com/azure/batch/batch-automatic-scaling) を参照してください。
displayName	string	プールの表示名。 表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。
enableAutoScale	boolean	プール サイズが時間の経過と同時に自動的に調整されるかどうか。 false の場合は、targetDedicatedNodes と targetLowPriorityNodes の少なくとも 1 つを指定する必要があります。 true の場合、autoScaleFormula プロパティが必要であり、プールは数式に従って自動的にサイズ変更されます。 既定値は false です。
enableInterNodeCommunication	boolean	プールがコンピューティング ノード間の直接通信を許可するかどうか。 ノード間通信を有効にすると、プールのコンピューティング ノードのデプロイ制限により、プールの最大サイズが制限されます。 これにより、プールが目的のサイズに達しない可能性があります。 既定値は false です。
id	string	アカウント内のプールを一意に識別する文字列。 ID には、ハイフンやアンダースコアを含む任意の英数字を組み合わせて使用でき、64 文字を超えることはできません。 ID は大文字と小文字が区別されず、大文字と小文字が区別されません (つまり、アカウント内に、大文字と小文字のみが異なる 2 つのプール ID がない可能性があります)。
metadata	BatchMetadataItem[]	メタデータとしてプールに関連付けられている名前と値のペアの一覧。 Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。
mountConfiguration	MountConfiguration[]	プールの存続期間中、指定されたファイルシステムを使用してストレージをマウントします。 Azure ファイル共有、NFS、CIFS、または Blobfuse ベースのファイル システムを使用してストレージをマウントします。
networkConfiguration	NetworkConfiguration	プールのネットワーク構成。
resizeTimeout	string (duration)	プールへのコンピューティング ノードの割り当てのタイムアウト。 このタイムアウトは、手動スケーリングにのみ適用されます。enableAutoScale が true に設定されている場合、効果はありません。 既定値は 15 分です。 最小値は 5 分です。 5 分未満の値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
startTask	BatchStartTask	プールに参加する各コンピューティング ノードで実行するように指定されたタスク。 タスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。
targetDedicatedNodes	integer (int32)	プール内の専用コンピューティング ノードの必要な数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。
targetLowPriorityNodes	integer (int32)	プール内のスポット/優先順位の低いコンピューティング ノードの目的の数。 enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。
taskSchedulingPolicy	BatchTaskSchedulingPolicy	プール内のコンピューティング ノード間でタスクを分散する方法。 指定しない場合、既定値はスプレッドです。
taskSlotsPerNode	integer (int32)	プール内の 1 つのコンピューティング ノードで同時実行タスクを実行するために使用できるタスク スロットの数。 既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。
upgradePolicy	UpgradePolicy	プールのアップグレード ポリシー。 アップグレード ポリシー (自動、手動、またはローリング) について説明します。
userAccounts	UserAccount[]	プール内の各コンピューティング ノードに作成するユーザー アカウントの一覧。
virtualMachineConfiguration	VirtualMachineConfiguration	プールの仮想マシン構成。 このプロパティの指定は必須です。
vmSize	string	プール内の仮想マシンのサイズ。 プール内のすべての仮想マシンのサイズは同じです。 Virtual Machines Marketplace のイメージを使用するプール (virtualMachineConfiguration で作成されたプール) で使用可能な VM サイズの詳細については、「Azure の Virtual Machines のサイズ (https://learn.microsoft.com/azure/virtual-machines/sizes/overview)」を参照してください。 Batch では、STANDARD_A0と Premium Storage (STANDARD_GS、STANDARD_DS、STANDARD_DSV2 シリーズ) を除くすべての Azure VM サイズがサポートされます。

BatchPoolEndpointConfiguration

Object

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

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

BatchPoolIdentityReference

Object

ディスクを暗号化するためのプール ID の 1 つの参照。 この ID は、キー コンテナーへのアクセスに使用されます。

名前	型	説明
resourceId	string (arm-id)	ユーザー割り当て ID の ARM リソース ID。 この参照は、プール ID に含める必要があります。

BatchPublicIpAddressConfiguration

Object

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

名前	型	説明
ipAddressIds	string[] (arm-id)	Batch サービスがコンピューティング ノードのプロビジョニング時に使用するパブリック IP の一覧。 ここで指定する IP の数によって、プールの最大サイズが制限されます。パブリック IP ごとに 100 個の専用ノードまたは 100 個のスポット/低優先度ノードを割り当て可能です。 たとえば、250 個の専用 VM を必要とするプールには、少なくとも 3 つのパブリック IP が指定されている必要があります。 このコレクションの各要素は、/subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip} の形式です。
ipFamilies	IPFamily[]	プールで使用可能な IP バージョンを指定するために使用される IP ファミリ。 IP ファミリは、シングルスタックまたはデュアルスタックプールを決定するために使用されます。 単一スタックの場合、予期される値は IPv4 です。 デュアル スタックの場合、想定される値は IPv4 と IPv6 です。
ipTags	IPTag[]	プールのパブリックIPアドレスに関連付けられたIPタグのリスト。 IP タグは、課金および管理の目的でパブリック IP アドレスを分類およびフィルタリングするために使用されます。
provision	IpAddressProvisioningType	プールのパブリック IP アドレスのプロビジョニングの種類。 既定値は BatchManaged です。

BatchStartTask

Object

Batch は、ノードで復旧操作がトリガーされたときにタスクを再試行します。 復旧操作の例としては、異常なノードが再起動されたときや、ホスト障害が原因でコンピューティング ノードが消えた場合などです (ただし、これらに限定されません)。 回復操作による再試行は独立しており、maxTaskRetryCount に対してカウントされません。 maxTaskRetryCount が 0 の場合でも、復旧操作による内部再試行が発生する可能性があります。 このため、すべてのタスクはべき等である必要があります。 つまり、タスクは、破損やデータの重複を引き起こさずに中断および再起動されることを許容する必要があります。 実行時間の長いタスクのベスト プラクティスは、何らかの形式のチェックポイント処理を使用することです。 場合によっては、コンピューティング ノードが再起動されなかった場合でも、StartTask が再実行されることがあります。 中断プロセスを作成したり、StartTask 作業ディレクトリからサービスをインストール/起動したりする StartTask を回避するには、特別な注意が必要です。これにより、Batch で StartTask を再実行できなくなるためです。

名前	型	説明
commandLine	string	StartTask のコマンド ライン。 コマンド ラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windows では "cmd /c MyCommand" を使用し、Linux では "/bin/sh -c MyCommand" を使用します。 コマンド ラインがファイル パスを参照している場合は、相対パス (Task 作業ディレクトリに対する相対パス) を使用するか、Batch で指定された環境変数 (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables) を使用する必要があります。
containerSettings	BatchTaskContainerSettings	StartTaskが動作するコンテナの設定。 これが指定されると、ノード上のAzure BatchディレクトリのルートであるAZ_BATCH_NODE_ROOT_DIRより下のすべてのディレクトリが再帰的にコンテナにマッピングされ、すべてのタスク環境変数がコンテナにマッピングされ、タスクコマンドラインがコンテナ内で実行されます。 AZ_BATCH_NODE_ROOT_DIR以外のコンテナで生成されたファイルはホストディスクに反映されない可能性があり、バッチファイルのAPIはそれらのファイルにアクセスできません。
environmentSettings	EnvironmentSetting[]	StartTask の環境変数設定の一覧。
maxTaskRetryCount	integer (int32)	タスクを再試行できる最大回数。 終了コードが 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 です。

BatchTaskContainerSettings

Object

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

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

BatchTaskSchedulingPolicy

Object

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

名前	型	規定値	説明
jobDefaultOrder	BatchJobDefaultOrder	none	同じ優先度を持つ異なるジョブのタスクをスケジューリングする順序。 指定しない場合、デフォルトは none です。
nodeFillType	BatchNodeFillType		プール内のコンピューティング ノード間でタスクを分散する方法。 指定しない場合、既定値はスプレッドです。

BatchUefiSettings

Object

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

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

BatchVmDiskSecurityProfile

Object

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

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

BatchVmImageReference

Object

Azure Virtual Machines Marketplace イメージまたは Azure コンピューティング ギャラリー イメージへの参照。 Azure Batch によって検証されたすべての Azure Marketplace イメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。

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

CachingType

列挙

キャッシュタイプ列挙

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

CifsMountConfiguration

Object

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

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

ContainerHostBatchBindMountEntry

Object

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

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

ContainerHostDataPath

列挙

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

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

ContainerRegistryReference

Object

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

名前	型	説明
identityReference	BatchNodeIdentityReference	ユーザー名とパスワードではなく、Azure Container Registry へのアクセスに使用するユーザー割り当て ID への参照。
password	string (password)	レジストリ サーバーにログインするためのパスワード。
registryServer	string (uri)	レジストリ URL。 省略した場合、既定値は "docker.io" です。
username	string	レジストリ サーバーにログインするユーザー名。

ContainerType

列挙

コンテナタイプの列挙

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

ContainerWorkingDirectory

列挙

ContainerWorkingDirectory 列挙

値	説明
taskWorkingDirectory	標準のバッチサービスのタスク作業ディレクトリを使用してください。そこにはバッチによって埋め込まれたタスクリソースファイルが含まれます。
containerImageDefault	コンテナImageで定義されたワーキングディレクトリを使いましょう。 ただし、このディレクトリにはバッチでダウンロードされたリソースファイルは含まれていないことに注意してください。

DataDisk

Object

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

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

DiffDiskPlacement

列挙

プール内のすべての計算ノード(VM)に対して、オペレーティングシステムディスクの一時的なディスク配置を指定します。 このプロパティは、オペレーティング システムを配置する場所を選択する要求でユーザーが使用できます。たとえば、エフェメラル OS ディスク プロビジョニング用のキャッシュ ディスク領域などです。 Ephemeral OSディスクサイズ要件の詳細については、「Ephemeral OS VM for Ephemeral OS disk size requirements at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements およびLinux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

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

DiskCustomerManagedKey

Object

ディスクを暗号化するためのカスタマー マネージド キー参照。

名前	型	説明
identityReference	BatchPoolIdentityReference	ディスクを暗号化するためのプール ID の 1 つの参照。 この ID は、KeyVault へのアクセスに使用されます。
keyUrl	string	KeyVault のキーを指す完全バージョン管理されたキー URL。 url のバージョン セグメントは、rotationToLatestKeyVersionEnabled 値に関係なく必要です。
rotationToLatestKeyVersionEnabled	boolean	このフラグを true に設定すると、ディスク暗号化が最新のキーバージョンに自動更新されます。 既定値は false です。

DiskEncryptionConfiguration

Object

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

名前	型	説明
customerManagedKey	DiskCustomerManagedKey	OS ディスクを暗号化するためのカスタマー マネージド キー参照。 カスタマー マネージド キーは EncryptionAtRest によって OS ディスクを暗号化し、既定ではデータ ディスクも暗号化します。 プールが ID で構成され、OsDisk が DiskEncryption のターゲットの 1 つとして設定されている場合にのみ使用できます。
targets	DiskEncryptionTarget[]	Batch Service がコンピューティング ノードで暗号化するディスク ターゲットの一覧。 Batch Service がコンピューティング ノードで暗号化するディスク ターゲットの一覧。

DiskEncryptionSetParameters

Object

ディスク暗号化セットの ARM リソース ID。

名前	型	説明
id	string (arm-id)	ディスク暗号化セットの ARM リソース ID。 リソースは、Batch アカウントと同じサブスクリプションにある必要があります。

DiskEncryptionTarget

列挙

DiskEncryptionTargetの列挙

値	説明
osdisk	コンピューティング ノード上の OS ディスクは暗号化されます。
temporarydisk	コンピューティング ノード上の一時ディスクは暗号化されます。 Linux では、起動時に暗号化が行われると、この暗号化は他のパーティション (マウントされたデータ ディスク上のパーティションなど) に適用されます。

DynamicVNetAssignmentScope

列挙

DynamicVNetAssignmentScope enums

値	説明
none	動的 VNet 割り当てが有効になっていません。
job	動的 VNet の割り当てはジョブごとに実行されます。

ElevationLevel

列挙

ElevationLevel 列挙

値	説明
nonadmin	ユーザーは、昇格されたアクセス権を持たない標準ユーザーです。
admin	ユーザーは昇格されたアクセス権を持つユーザーであり、完全な管理者権限で動作します。

EnvironmentSetting

Object

タスク プロセスで設定する環境変数。

名前	型	説明
name	string	環境変数の名前。
value	string	環境変数の値。

HostEndpointSettings

Object

特定のホストエンドポイント設定を指定します。

名前	型	説明
inVMAccessControlProfileReferenceId	string	InVMAccessControlProfileVersion リソース ID への参照を、/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} の形式で指定します。
mode	HostEndpointSettingsModeTypes	アクセス制御ポリシーの実行モードを指定します。

HostEndpointSettingsModeTypes

列挙

HostEndpointSettingsModeTypes enum

値	説明
Audit	監査モードでは、システムは、ログにアクセス拒否エントリを出力するなど、アクセス制御ポリシーを適用しているかのように機能しますが、実際にはホスト エンドポイントへの要求を拒否しません。
Enforce	強制モードは推奨される動作モードであり、システムはアクセス制御ポリシーを強制します。 このプロパティは「inVMAccessControlProfileReferenceId」と併用できません。

InboundEndpointProtocol

列挙

InboundEndpointProtocol は列挙式です

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

IpAddressProvisioningType

列挙

IPAddressProvisioningType enums

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

IPFamily

列挙

プールで使用可能な IP バージョンを指定するために使用される IP ファミリ。

値	説明
IPv4	プールにはIPv4が利用可能です。
IPv6	IPv6はプールで利用可能です。

IPTag

Object

パブリック IP アドレスに関連付けられている IP タグを格納します。

名前	型	説明
ipTagType	string	IP タグの種類。 例: FirstPartyUsage。
tag	string	パブリック IP に関連付けられている IP タグの値。 例: SQL。

LinuxUserConfiguration

Object

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

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

LoginMode

列挙

LoginModeの列挙

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

ManagedDisk

Object

マネージド ディスクのパラメーター。

名前	型	説明
diskEncryptionSet	DiskEncryptionSetParameters	マネージド ディスクのカスタマー マネージド ディスク暗号化セットのリソース ID を指定します。 UserSubscriptionモードでのみ設定できます。
securityProfile	BatchVmDiskSecurityProfile	マネージド ディスクのセキュリティ プロファイル設定を指定します。
storageAccountType	StorageAccountType	マネージド ディスクのストレージ アカウントの種類。

MountConfiguration

Object

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

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

NetworkConfiguration

Object

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

名前	型	説明
dynamicVNetAssignmentScope	DynamicVNetAssignmentScope	動的 vnet 割り当てのスコープ。
enableAcceleratedNetworking	boolean	このプールで高速ネットワークを有効にする必要があるかどうか。 高速ネットワークにより、VM への単一ルート I/O 仮想化 (SR-IOV) が可能になり、ネットワーク パフォーマンスが向上する可能性があります。 詳細については、https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overviewを参照してください。
endpointConfiguration	BatchPoolEndpointConfiguration	バッチプール内のCompute Node上のエンドポイントの設定。
publicIPAddressConfiguration	BatchPublicIpAddressConfiguration	Batch プール内のコンピューティング ノードのパブリック 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://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Object

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

名前	型	説明
access	NetworkSecurityGroupRuleAccess	指定した IP アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。
priority	integer (int32)	このルールの優先順位。 プール内の優先順位は一意でなければならず、優先順位で評価されます。 数値が小さい方が優先度が高くなります。 たとえば、順序番号が 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

列挙

NetworkSecurityGroupRuleAccess の列挙

値	説明
allow	アクセスを許可します。
deny	アクセスを拒否します。

NfsMountConfiguration

Object

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

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

ProxyAgentSettings

Object

仮想マシンの作成時に ProxyAgent の設定を指定します。

名前	型	説明
enabled	boolean	メタデータ セキュリティ プロトコル機能を仮想マシンまたは仮想マシン スケール セットのどちらで有効にするかを指定します。 既定値は False です。
imds	HostEndpointSettings	IMDS エンドポイントの設定。
wireServer	HostEndpointSettings	WireServer エンドポイントの設定。

ResourceFile

Object

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

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

RollingUpgradePolicy

Object

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

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

SecurityEncryptionTypes

列挙

セキュリティ暗号化タイプ列挙

値	説明
DiskWithVMGuestState	マネージド ディスクの EncryptionType は、VMGuestState BLOB と共にマネージド ディスクを暗号化するために DiskWithVMGuestState に設定されます。 データディスクではサポートされていません。
NonPersistedTPM	マネージド ディスクの EncryptionType は、VMGuestState BLOB にファームウェア状態を保持しないため、NonPersistedTPM に設定されています。
VMGuestStateOnly	マネージド ディスクの EncryptionType は、VMGuestState BLOB のみの暗号化に対して VMGuestStateOnly に設定されます。

SecurityProfile

Object

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

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

SecurityTypes

列挙

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

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

ServiceArtifactReference

Object

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

名前	型	説明
id	string	ServiceArtifactReferenceのサービスアーティファクト参照IDです。 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} の形式のサービス 成果物参照 ID

StorageAccountType

列挙

StorageAccountType 列挙型

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

UpgradeMode

列挙

UpgradeMode の列挙

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

UpgradePolicy

Object

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

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

UserAccount

Object

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

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

UserIdentity

Object

タスクを実行するユーザー ID の定義。 userName プロパティまたは autoUser プロパティを指定しますが、両方を指定することはできません。

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

VirtualMachineConfiguration

Object

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

名前	型	説明
containerConfiguration	BatchContainerConfiguration	プールのコンテナ構成。 指定されている場合、プール内の各コンピュートノードでセットアップが行われ、タスクがコンテナ内で実行できるようにします。 このプール上で動作するすべての通常のタスクおよびジョブマネージャータスクはcontainerSettingsプロパティを指定しなければならず、他のすべてのタスクも指定できます。
dataDisks	DataDisk[]	プール内のComputeノードに接続されたデータディスクの構成。 このプロパティは、プール内のComputeノードに空のデータディスクを接続する必要がある場合に指定する必要があります。 これは更新できません。 各コンピュートノードはそれぞれのディスクを持ちます(ディスクはファイル共有ではありません)。 既存のディスクは接続できず、各ディスクは空です。 Computeノードがプールから削除されると、ディスクおよびそれに関連するすべてのデータも削除されます。 ディスクは接続後にフォーマットされるわけではなく、使用前に必ずフォーマットする必要があります。詳細は「 https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux 」および「 https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine」を参照してください。
diskEncryptionConfiguration	DiskEncryptionConfiguration	プールのディスク暗号化構成。 指定した場合、暗号化は、ノードのプロビジョニング中にプール内の各ノードで実行されます。
extensions	VMExtension[]	プールの仮想マシン拡張機能。 指定した場合、この構成に記載されている拡張機能が各ノードにインストールされます。
imageReference	BatchVmImageReference	使用する 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	BatchNodePlacementConfiguration	プールのノード配置構成。 この構成では、プール内のノードを物理的に割り当てる方法に関する規則を指定します。
osDisk	BatchOsDisk	仮想マシンのオペレーティング システム ディスクの設定。
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イメージを指定する場合、このプロパティは指定してはいけません。

VMExtension

Object

仮想マシン拡張機能の構成。

名前	型	説明
autoUpgradeMinorVersion	boolean	展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能はマイナー バージョンをアップグレードしません。
enableAutomaticUpgrade	boolean	使用可能な拡張機能の新しいバージョンがある場合に、拡張機能をプラットフォームによって自動的にアップグレードするかどうかを示します。
name	string	仮想マシン拡張機能の名前。
protectedSettings	object	拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。
provisionAfterExtensions	string[]	拡張機能名のコレクション。 この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。
publisher	string	拡張ハンドラーの発行元の名前。
settings	object	拡張機能の JSON 形式のパブリック設定。
type	string	拡張機能の種類。
typeHandlerVersion	string	スクリプト ハンドラーのバージョン。

WindowsConfiguration

Object

仮想マシンに適用する Windows オペレーティング システムの設定。

名前	型	説明
enableAutomaticUpdates	boolean	仮想マシンで自動更新が有効になっているかどうか。 省略した場合、既定値は true です。

WindowsUserConfiguration

Object

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

名前	型	説明
loginMode	LoginMode	ユーザーのログインモード。 デフォルトは「バッチ」です。