次の方法で共有

Pool - Create

サービス:
Batch Management
API バージョン:
2025-06-01

指定したアカウント内に新しいプールを作成します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}?api-version=2025-06-01

URI パラメーター

名前 / 必須 型 説明
accountName
 path True

string

minLength: 3
maxLength: 24
pattern: ^[a-zA-Z0-9]+$

Batch アカウントの名前。
poolName
 path True

string

minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9_-]+$

プール名。 これはアカウント内で一意である必要があります。
resourceGroupName
 path True

string

Batch アカウントを含むリソース グループの名前。
subscriptionId
 path True

string

Azure サブスクリプション ID。 これは GUID 形式の文字列です (例: 000000000-0000-0000-0000-000000000000)
api-version
 query True

string

HTTP 要求で使用される API バージョン。

要求ヘッダー

名前 必須 型 説明
If-Match

string

更新するプールのエンティティ状態 (ETag) バージョン。 値 "*" は、プールが既に存在する場合にのみ、操作を適用するために使用できます。 省略した場合、この操作は常に適用されます。
If-None-Match

string

新しいプールの作成を許可するが、既存のプールの更新を禁止するには、'*' に設定します。 その他の値は無視されます。

要求本文

名前 型 説明
identity

BatchPoolIdentity

バッチ プールに使用される ID の種類。
バッチ プールに使用される ID の種類。
properties.applicationPackages

ApplicationPackageReference[]

プール内の各コンピューティング ノードにインストールするアプリケーション パッケージの一覧。
アプリケーション パッケージ参照に対する変更は、プールに参加しているすべての新しいコンピューティング ノードに影響しますが、再起動または再イメージ化されるまで、プール内に既に存在するコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のアプリケーション パッケージ参照があります。
properties.deploymentConfiguration

DeploymentConfiguration

このプロパティは、プール ノードがデプロイされる仮想マシンについて説明します。
properties.displayName

string

プールの表示名。
表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。
properties.interNodeCommunication

InterNodeCommunicationState

プールがノード間の直接通信を許可するかどうか。
これにより、プールに割り当てることができるノードに制限が適用されます。 この値を有効にすると、要求されたノード数がプールに割り当てられる可能性が低くなります。 指定しない場合、この値の既定値は "Disabled" になります。
properties.metadata

MetadataItem[]

メタデータとしてプールに関連付けられている名前と値のペアの一覧。
Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。
properties.mountConfiguration

MountConfiguration[]

プール内の各ノードにマウントするファイル システムの一覧。
これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。
properties.networkConfiguration

NetworkConfiguration

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

ScaleSettings

プール内のノード数を構成する設定。
プールの目的のサイズを定義します。 これは、要求された targetDedicatedNodes が指定されている "fixedScale" か、定期的に再評価される数式を定義する 'autoScale' のいずれかです。 このプロパティを指定しない場合、プールは 0 targetDedicatedNodes を使用して固定スケールになります。
properties.startTask

StartTask

プールに参加する各コンピューティング ノードで実行するように指定されたタスク。
PATCH (更新) 操作では、このプロパティを空のオブジェクトに設定して、プールから開始タスクを削除できます。
properties.taskSchedulingPolicy

TaskSchedulingPolicy

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

integer (int32)

プール内の 1 つのコンピューティング ノードで同時実行タスクを実行するために使用できるタスク スロットの数。
既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。
properties.upgradePolicy

UpgradePolicy

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

UserAccount[]

プール内の各ノードに作成するユーザー アカウントの一覧。
properties.vmSize

string

プール内の仮想マシンのサイズ。 プール内のすべての VM のサイズは同じです。
使用可能な VM サイズの詳細については、「Azure の仮想マシンのサイズ (https://learn.microsoft.com/azure/virtual-machines/sizes/overview)」を参照してください。 Batch では、STANDARD_A0と Premium Storage (STANDARD_GS、STANDARD_DS、STANDARD_DSV2 シリーズ) を除くすべての Azure VM サイズがサポートされます。
tags

object

リソースのタグ。

応答

名前 型 説明
200 OK

Pool

操作が成功しました。 応答にはプール エンティティが含まれています。

ヘッダー

ETag: string
Other Status Codes

CloudError

操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Microsoft Entra OAuth 2.0 認証コード フロー

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

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

例

CreatePool - accelerated networking
CreatePool - Custom Image
CreatePool - Full VirtualMachineConfiguration
CreatePool - Minimal VirtualMachineConfiguration
CreatePool - No public IP
CreatePool - Public IPs
CreatePool - SecurityProfile
CreatePool - Tags
CreatePool - UpgradePolicy
CreatePool - UserAssignedIdentities
CreatePool - VirtualMachineConfiguration Extensions
CreatePool - VirtualMachineConfiguration OSDisk
CreatePool - VirtualMachineConfiguration ServiceArtifactReference

CreatePool - accelerated networking

要求のサンプル

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

{
  "properties": {
    "vmSize": "Standard_D4d_v5",
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "enableAcceleratedNetworking": true
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2025-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    }
  }
}

応答のサンプル

状態コード:
200 
ETag: W/"0x8DB46CB72A227E2"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DB46CB72A227E2\"",
  "properties": {
    "lastModified": "2023-04-27T02:59:41.8592226Z",
    "creationTime": "2023-04-27T02:59:41.8592226Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-04-27T02:59:41.8592226Z",
    "allocationState": "Steady",
    "allocationStateTransitionTime": "2023-04-27T03:00:34.0646502Z",
    "vmSize": "Standard_D4d_v5",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2025-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64"
      }
    },
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "dynamicVnetAssignmentScope": "none",
      "enableAcceleratedNetworking": true
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 1,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-04-27T02:59:41.8592226Z"
    },
    "currentDedicatedNodes": 1,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Custom Image

要求のサンプル

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

{
  "properties": {
    "vmSize": "Standard_D4ds_v5",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 24.04"
      }
    }
  }
}

応答のサンプル

状態コード:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2024-08-28T10:22:55.9407275Z",
    "creationTime": "2024-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2024-08-28T10:22:55.9407275Z",
    "allocationState": "Steady",
    "allocationStateTransitionTime": "2024-08-28T10:22:55.9407275Z",
    "vmSize": "Standard_D4ds_v5",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 24.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 0,
        "targetLowPriorityNodes": 0
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Full VirtualMachineConfiguration

要求のサンプル

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

{
  "properties": {
    "vmSize": "Standard_D4d_v5",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2025-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        },
        "licenseType": "Windows_Server",
        "dataDisks": [
          {
            "lun": 0,
            "caching": "ReadWrite",
            "diskSizeGB": 30,
            "storageAccountType": "Premium_LRS"
          },
          {
            "lun": 1,
            "caching": "None",
            "diskSizeGB": 200,
            "storageAccountType": "Standard_LRS"
          }
        ],
        "diskEncryptionConfiguration": {
          "targets": [
            "OsDisk",
            "TemporaryDisk"
          ]
        },
        "nodePlacementConfiguration": {
          "policy": "Zonal"
        },
        "osDisk": {
          "ephemeralOSDiskSettings": {
            "placement": "CacheDisk"
          }
        }
      }
    },
    "networkConfiguration": {
      "endpointConfiguration": {
        "inboundNatPools": [
          {
            "name": "testnat",
            "protocol": "TCP",
            "backendPort": 12001,
            "frontendPortRangeStart": 15000,
            "frontendPortRangeEnd": 15100,
            "networkSecurityGroupRules": [
              {
                "access": "Allow",
                "sourceAddressPrefix": "192.100.12.45",
                "priority": 150,
                "sourcePortRanges": [
                  "1",
                  "2"
                ]
              },
              {
                "access": "Deny",
                "sourceAddressPrefix": "*",
                "priority": 3500,
                "sourcePortRanges": [
                  "*"
                ]
              }
            ]
          }
        ]
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    }
  }
}

応答のサンプル

状態コード:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2025-07-28T10:22:55.9407275Z",
    "creationTime": "2025-07-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2025-07-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2025-07-28T10:22:55.9407275Z",
    "vmSize": "Standard_D4d_v5",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2025-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        },
        "licenseType": "Windows_Server",
        "dataDisks": [
          {
            "lun": 0,
            "caching": "ReadWrite",
            "diskSizeGB": 30,
            "storageAccountType": "Premium_LRS"
          },
          {
            "lun": 1,
            "caching": "None",
            "diskSizeGB": 200,
            "storageAccountType": "Standard_LRS"
          }
        ],
        "diskEncryptionConfiguration": {
          "targets": [
            "OsDisk",
            "TemporaryDisk"
          ]
        },
        "nodePlacementConfiguration": {
          "policy": "Zonal"
        }
      }
    },
    "networkConfiguration": {
      "endpointConfiguration": {
        "inboundNatPools": [
          {
            "name": "testnat",
            "protocol": "TCP",
            "backendPort": 12001,
            "frontendPortRangeStart": 15000,
            "frontendPortRangeEnd": 15100,
            "networkSecurityGroupRules": [
              {
                "access": "Allow",
                "sourceAddressPrefix": "192.100.12.45",
                "priority": 150,
                "sourcePortRanges": [
                  "1",
                  "2"
                ]
              },
              {
                "access": "Deny",
                "sourceAddressPrefix": "*",
                "priority": 3500,
                "sourcePortRanges": [
                  "*"
                ]
              }
            ]
          }
        ]
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Minimal VirtualMachineConfiguration

要求のサンプル

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

{
  "properties": {
    "vmSize": "Standard_D4ds_v5",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 24.04"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    }
  }
}

応答のサンプル

状態コード:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2024-08-28T10:22:55.9407275Z",
    "creationTime": "2024-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2024-08-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2024-08-28T10:22:55.9407275Z",
    "vmSize": "Standard_D4ds_v5",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 24.04"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - No public IP

要求のサンプル

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

{
  "properties": {
    "vmSize": "Standard_D4ds_v5",
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "NoPublicIPAddresses"
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 24.04"
      }
    }
  }
}

応答のサンプル

状態コード:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2024-08-28T10:22:55.9407275Z",
    "creationTime": "2024-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2024-08-28T10:22:55.9407275Z",
    "allocationState": "Steady",
    "allocationStateTransitionTime": "2024-08-28T10:22:55.9407275Z",
    "vmSize": "Standard_D4ds_v5",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "NoPublicIPAddresses"
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 24.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 0,
        "targetLowPriorityNodes": 0
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Public IPs

要求のサンプル

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

{
  "properties": {
    "vmSize": "Standard_D4ds_v5",
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "UserManaged",
        "ipAddressIds": [
          "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135"
        ]
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 24.04"
      }
    }
  }
}

応答のサンプル

状態コード:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2024-08-28T10:22:55.9407275Z",
    "creationTime": "2024-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2024-08-28T10:22:55.9407275Z",
    "allocationState": "Steady",
    "allocationStateTransitionTime": "2024-08-28T10:22:55.9407275Z",
    "vmSize": "Standard_D4ds_v5",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "UserManaged",
        "ipAddressIds": [
          "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135"
        ]
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 24.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 0,
        "targetLowPriorityNodes": 0
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - SecurityProfile

要求のサンプル

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

{
  "properties": {
    "vmSize": "Standard_D4ds_v5",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 24.04",
        "securityProfile": {
          "securityType": "trustedLaunch",
          "encryptionAtHost": true,
          "uefiSettings": {
            "secureBootEnabled": null,
            "vTpmEnabled": false
          }
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    }
  }
}

応答のサンプル

状態コード:
200 
ETag: W/"0x8DB554F8E08BCF4"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DB554F8E08BCF4\"",
  "properties": {
    "lastModified": "2024-08-28T07:03:58.3231917Z",
    "creationTime": "2024-08-28T07:03:58.3231917Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2024-08-28T07:03:58.3231917Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2024-08-28T07:03:58.3231917Z",
    "vmSize": "Standard_D4ds_v5",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 24.04",
        "securityProfile": {
          "securityType": "trustedLaunch",
          "encryptionAtHost": true,
          "uefiSettings": {
            "vTpmEnabled": false
          }
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 1,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2024-08-28T07:03:58.3231917Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Tags

要求のサンプル

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

{
  "tags": {
    "TagName1": "TagValue1",
    "TagName2": "TagValue2"
  },
  "properties": {
    "vmSize": "Standard_D4ds_v5",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 24.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    }
  }
}

応答のサンプル

状態コード:
200 
ETag: W/"0x8DB554F8E08BCF4"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DB554F8E08BCF4\"",
  "properties": {
    "lastModified": "2023-06-14T07:03:58.3231917Z",
    "creationTime": "2023-06-14T07:03:58.3231917Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "vmSize": "Standard_D4ds_v5",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 24.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 1,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-09-27T07:33:13.0625789Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  },
  "tags": {
    "TagName1": "TagValue1",
    "TagName2": "TagValue2"
  }
}

CreatePool - UpgradePolicy

要求のサンプル

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

{
  "properties": {
    "vmSize": "Standard_D4ds_v5",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2019-datacenter-smalldisk",
          "version": "latest"
        },
        "nodePlacementConfiguration": {
          "policy": "Zonal"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 2,
        "targetLowPriorityNodes": 0
      }
    },
    "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
      }
    }
  }
}

応答のサンプル

状態コード:
200 
ETag: W/"0x8DB51E64D3C3B69"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DB51E64D3C3B69\"",
  "properties": {
    "lastModified": "2023-05-11T06:16:44.2372184Z",
    "creationTime": "2023-05-11T06:16:44.2372184Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-05-11T06:16:44.2372184Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-05-11T06:16:44.2372184Z",
    "vmSize": "Standard_D4ds_v5",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2019-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        },
        "nodePlacementConfiguration": {
          "policy": "Zonal"
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 2,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 2,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-05-11T06:16:44.2372184Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "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
      }
    }
  }
}

CreatePool - UserAssignedIdentities

要求のサンプル

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

{
  "properties": {
    "vmSize": "Standard_D4ds_v5",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 24.04"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    }
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {}
    }
  }
}

応答のサンプル

状態コード:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2024-10-01T10:22:55.9407275Z",
    "creationTime": "2024-10-01T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2024-10-01T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2024-10-01T10:22:55.9407275Z",
    "vmSize": "Standard_D4ds_v5",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 24.04"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "principalId": "principalId1",
        "clientId": "clientId1"
      },
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {
        "principalId": "principalId2",
        "clientId": "clientId2"
      }
    }
  }
}

CreatePool - VirtualMachineConfiguration Extensions

要求のサンプル

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

{
  "properties": {
    "vmSize": "Standard_D4d_v5",
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 24.04",
        "extensions": [
          {
            "name": "batchextension1",
            "type": "KeyVaultForLinux",
            "publisher": "Microsoft.Azure.KeyVault",
            "typeHandlerVersion": "2.0",
            "autoUpgradeMinorVersion": true,
            "enableAutomaticUpgrade": true,
            "settings": {
              "secretsManagementSettingsKey": "secretsManagementSettingsValue",
              "authenticationSettingsKey": "authenticationSettingsValue"
            }
          }
        ]
      }
    }
  }
}

応答のサンプル

状態コード:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2025-07-28T10:22:55.9407275Z",
    "creationTime": "2025-07-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2025-07-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2025-07-28T10:22:55.9407275Z",
    "vmSize": "Standard_D4d_v5",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 24.04",
        "extensions": [
          {
            "name": "batchextension1",
            "type": "KeyVaultForLinux",
            "publisher": "Microsoft.Azure.KeyVault",
            "typeHandlerVersion": "2.0",
            "autoUpgradeMinorVersion": true,
            "enableAutomaticUpgrade": true,
            "settings": {
              "secretsManagementSettingsKey": "secretsManagementSettingsValue",
              "authenticationSettingsKey": "authenticationSettingsValue"
            }
          }
        ]
      }
    }
  }
}

CreatePool - VirtualMachineConfiguration OSDisk

要求のサンプル

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

{
  "properties": {
    "vmSize": "Standard_D4ds_v5",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "microsoftwindowsserver",
          "offer": "windowsserver",
          "sku": "2022-datacenter-smalldisk"
        },
        "osDisk": {
          "diskSizeGB": 100,
          "managedDisk": {
            "storageAccountType": "StandardSSD_LRS"
          },
          "caching": "ReadWrite",
          "writeAcceleratorEnabled": false
        },
        "nodeAgentSkuId": "batch.node.windows amd64"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    }
  }
}

応答のサンプル

状態コード:
200 
ETag: W/"0x8DB51F14DC1A8AD"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DB51F396992B8D\"",
  "properties": {
    "lastModified": "2023-08-24T02:12:27.7527697Z",
    "creationTime": "2023-08-24T02:12:27.7527697Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-08-24T02:12:27.7527697Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-08-24T02:12:27.7527697Z",
    "vmSize": "Standard_D4d_v5",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "microsoftwindowsserver",
          "offer": "windowsserver",
          "sku": "2022-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "osDisk": {
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "StandardSSD_LRS"
          },
          "diskSizeGB": 100,
          "writeAcceleratorEnabled": false
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 1,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-08-24T02:12:27.7527697Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - VirtualMachineConfiguration ServiceArtifactReference

要求のサンプル

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

{
  "properties": {
    "vmSize": "Standard_D4ds_v5",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2019-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"
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 2,
        "targetLowPriorityNodes": 0
      }
    },
    "upgradePolicy": {
      "mode": "automatic",
      "automaticOSUpgradePolicy": {
        "enableAutomaticOSUpgrade": true
      }
    }
  }
}

応答のサンプル

状態コード:
200 
ETag: W/"0x8DB51F14DC1A8AD"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "mypool41",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DB51F396992B8D\"",
  "properties": {
    "lastModified": "2023-05-11T07:44:44.8580493Z",
    "creationTime": "2023-05-11T07:44:44.8580493Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-05-11T07:44:44.8580493Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-05-11T07:44:44.8580493Z",
    "vmSize": "Standard_D4ds_v5",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2019-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"
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 2,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 2,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-05-11T07:44:44.8580493Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "upgradePolicy": {
      "mode": "automatic",
      "automaticOSUpgradePolicy": {
        "enableAutomaticOSUpgrade": true
      }
    }
  }
}

定義

名前 説明
AllocationState

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

バッチアカウント内のアプリケーションパッケージへのリンク
AutomaticOSUpgradePolicy

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

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

プールを自動スケールするときに発生したエラー。
AutoScaleSettings

プールの自動スケール設定。
AutoUserScope

自動ユーザーのスコープ
AutoUserSpecification

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

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

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

Batch プールの ID (構成されている場合)。 既存のプールの更新中にプール ID が更新された場合、プールが 0 に縮小された後に作成された新しい VM のみが更新された ID を持ちます
CachingType

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

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

Batch サービスからのエラー応答。
CloudErrorBody

Batch サービスからのエラー応答。
ComputeNodeDeallocationOption

割り当て解除を選択した後のノードとその実行中のタスクの操作を決定します。
ComputeNodeFillType

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

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

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

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

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

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

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

コンテナー タスクの作業ディレクトリの場所を示すフラグ。 既定値は 'taskWorkingDirectory' です。
DataDisk

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

展開構成プロパティ。
DiffDiskPlacement

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

仮想マシンで使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。
DiskCustomerManagedKey

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

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

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

Batch Service がコンピューティング ノードで暗号化するディスク ターゲットの一覧
DynamicVNetAssignmentScope

動的 vnet 割り当てのスコープ。
ElevationLevel

ユーザーの昇格レベル。
EnvironmentSetting

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

プールのスケール設定を修正しました。
HostEndpointSettings

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

監査/執行
ImageReference

カスタム仮想マシンの Azure Virtual Machines Marketplace イメージまたは Azure Image リソースへの参照。 Azure Batch によって検証されたすべての imageReferences の一覧を取得するには、「サポートされているノード エージェント SKU の一覧表示」操作を参照してください。
InboundEndpointProtocol

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

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

プールがノード間の直接通信を許可するかどうか。
IPAddressProvisioningType

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

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

同じ優先度を持つ異なるジョブのタスクをスケジューリングする順序。
LinuxUserConfiguration

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

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

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

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

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

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

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

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

バッチプールのノード配置設定。
NodePlacementPolicyType

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

仮想マシンのオペレーティング システム ディスクの設定。
Pool

プールに関する情報を格納します。
PoolEndpointConfiguration

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

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

バッチ プールに使用される ID の種類。
PoolProvisioningState

プールの現在の状態。
ProxyAgentSettings

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

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

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

現在または最後に完了したサイズ変更操作の詳細。
ResourceFile

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

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

プールのスケール設定
SecurityEncryptionTypes

マネージド ディスクの EncryptionType を指定します。 管理ディスクとVMGuestState blobの暗号化にはDiskWithVMGuestState、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

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

Azure Batch ノードでユーザーを作成するために使用されるプロパティ。
UserAssignedIdentities

関連付けられているユーザー ID の一覧。
UserIdentity

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

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

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

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

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

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

AllocationState

列挙

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

値 説明
Steady

プールのサイズが変更されていません。 進行中のプール内のノードの数に変更はありません。 プールが作成されたとき、およびノードの数を変更する操作がプールに対して実行されていない場合、プールはこの状態になります。
Resizing

プールのサイズが変更されています。つまり、コンピューティング ノードがプールに追加またはプールから削除されます。
Stopping

プールのサイズは変更されていましたが、ユーザーはサイズ変更を停止することを要求しましたが、停止要求はまだ完了していません。

ApplicationPackageReference

Object

バッチアカウント内のアプリケーションパッケージへのリンク

名前 型 説明
id

string

インストールするアプリケーション パッケージの ID。 これはプールと同じバッチアカウント内にある必要があります。 これは、特定のバージョンへの参照でも、存在する場合は既定のバージョンでもかまいません。
version

string

デプロイするアプリケーションのバージョン。 省略すると、既定のバージョンがデプロイされます。
これを省略し、このアプリケーションに既定のバージョンが指定されていない場合、要求はエラー コード InvalidApplicationPackageReferences で失敗します。 REST API を直接呼び出す場合、HTTP 状態コードは 409 です。

AutomaticOSUpgradePolicy

Object

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

名前 型 説明
disableAutomaticRollback

boolean

OS イメージのロールバック機能を無効にする必要があるかどうか。
enableAutomaticOSUpgrade

boolean

新しいバージョンの OS イメージが使用可能になったときに、OS アップグレードをスケール セット インスタンスに自動的に適用するかどうかを示します。

Windows ベースのプールに対してこれが true に設定されている場合、WindowsConfiguration.enableAutomaticUpdates を true に設定することはできません。
osRollingUpgradeDeferral

boolean

タスクを実行している場合は、TVM の OS アップグレードを延期します。
useRollingUpgradePolicy

boolean

自動 OS アップグレード中にローリング アップグレード ポリシーを使用するかどうかを示します。 VMSS でポリシーが定義されていない場合、OS の自動アップグレードは既定のポリシーにフォールバックします。

AutoScaleRun

Object

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

名前 型 説明
error

AutoScaleRunError

評価が失敗した場合に、プールで自動スケール式の評価中に発生したエラーの詳細。
evaluationTime

string (date-time)

自動スケール式が最後に評価された時刻。
results

string

自動スケール式の評価で使用されるすべての変数の最終的な値。
各変数値は $variable=value の形式で返され、変数はセミコロンで区切られます。

AutoScaleRunError

Object

プールを自動スケールするときに発生したエラー。

名前 型 説明
code

string

エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。
details

AutoScaleRunError[]

エラーに関する追加の詳細。
message

string

ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。

AutoScaleSettings

Object

プールの自動スケール設定。

名前 型 説明
evaluationInterval

string (duration)

自動スケールの数式に従ってプール サイズを自動的に調整する時間間隔。
省略した場合、既定値は 15 分 (PT15M) です。
formula

string

プール内のコンピューティング ノードの必要な数の数式。

AutoUserScope

列挙

自動ユーザーのスコープ

値 説明
Task

サービスがタスクの新しいユーザーを作成することを指定します。
Pool

タスクが、プール内のすべてのノードで作成される共通の自動ユーザー アカウントとして実行されるように指定します。

AutoUserSpecification

Object

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

名前 型 説明
elevationLevel

ElevationLevel

自動ユーザーの昇格レベル。
既定値は nonAdmin です。
scope

AutoUserScope

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

AzureBlobFileSystemConfiguration

Object

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

Object

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 マウント ディレクトリに対して相対的にマウントされます。

BatchPoolIdentity

Object

Batch プールの ID (構成されている場合)。 既存のプールの更新中にプール ID が更新された場合、プールが 0 に縮小された後に作成された新しい VM のみが更新された ID を持ちます

名前 型 説明
type

PoolIdentityType

バッチ プールに使用される ID の種類。
userAssignedIdentities

<string,  UserAssignedIdentities>

Batch プールに関連付けられているユーザー ID の一覧。

CachingType

列挙

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

値 説明
None

ディスクのキャッシュ モードが有効になっていません。
ReadOnly

ディスクのキャッシュ モードは読み取り専用です。
ReadWrite

ディスクのキャッシュ モードは読み取りと書き込みです。

CIFSMountConfiguration

Object

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 ファイル システムに対する認証に使用するユーザー。

CloudError

Object

Batch サービスからのエラー応答。

名前 型 説明
error

CloudErrorBody

エラー応答の本文。

CloudErrorBody

Object

Batch サービスからのエラー応答。

名前 型 説明
code

string

エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。
details

CloudErrorBody[]

エラーに関する追加の詳細の一覧。
message

string

ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。
target

string

特定のエラーのターゲット。 たとえば、エラーが発生したプロパティの名前です。

ComputeNodeDeallocationOption

列挙

割り当て解除を選択した後のノードとその実行中のタスクの操作を決定します。

値 説明
Requeue

実行中のタスク プロセスを終了し、タスクを再キューします。 ノードが使用可能になると、タスクが再度実行されます。 タスクが終了したらすぐにノードを削除します。
Terminate

実行中のタスクを終了します。 タスクは、終了されたことを示す failureInfo で完了し、もう一度実行されません。 タスクが終了したらすぐにノードを削除します。
TaskCompletion

現在実行中のタスクの完了を許可します。 待機中に新しいタスクをスケジュールしない。 すべてのタスクが完了したら、ノードを削除します。
RetainedData

現在実行中のタスクの完了を許可し、すべてのタスク データ保持期間の有効期限が切れるのを待ちます。 待機中に新しいタスクをスケジュールしない。 すべてのタスク保有期間の有効期限が切れたときにノードを削除します。

ComputeNodeFillType

列挙

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

値 説明
Spread

タスクは、プール内のすべてのノードに均等に割り当てる必要があります。
Pack

プール内の次のノードにタスクを割り当てる前に、できるだけ多くのタスク (taskSlotsPerNode) をプール内の各ノードに割り当てる必要があります。

ComputeNodeIdentityReference

Object

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

名前 型 説明
resourceId

string

ユーザー割り当て ID の ARM リソース ID。

ContainerConfiguration

Object

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

名前 型 説明
containerImageNames

string[]

コンテナー イメージ名のコレクション。
これは、"docker pull" に指定される完全なイメージ参照です。 イメージが代替レジストリで完全修飾されていない限り、イメージは既定の Docker レジストリから取得されます。
containerRegistries

ContainerRegistry[]

コンテナーをプルできる追加のプライベート レジストリ。
資格情報を必要とするプライベート レジストリからイメージをダウンロードする必要がある場合は、これらの資格情報をここで指定する必要があります。
type

ContainerType

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

ContainerHostBatchBindMountEntry

Object

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

名前 型 説明
isReadOnly

boolean

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

ContainerHostDataPath

コンテナー顧客にマウントするパスを選択できます。

ContainerHostDataPath

列挙

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

値 説明
Shared

複数インスタンス のタスクがファイルを共有するためのパス。
Startup

開始タスクのパス。
VfsMounts

パスには、このノードにマウントされているすべての仮想ファイル システムが含まれています。
Task

タスク パス。
JobPrep

ジョブ準備タスクのパス。
Applications

アプリケーション パス。

ContainerRegistry

Object

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

名前 型 説明
identityReference

ComputeNodeIdentityReference

ユーザー名とパスワードではなく、Azure Container Registry へのアクセスに使用するユーザー割り当て ID への参照。
コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。
password

string

レジストリ サーバーにログインするためのパスワード。
registryServer

string

レジストリ URL。
省略した場合、既定値は "docker.io" です。
username

string

レジストリ サーバーにログインするユーザー名。

ContainerType

列挙

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

値 説明
DockerCompatible

Docker と互換性のあるコンテナー テクノロジを使用して、コンテナーを起動します。
CriCompatible

CRI ベースのテクノロジを使用して、コンテナーを起動します。

ContainerWorkingDirectory

列挙

コンテナー タスクの作業ディレクトリの場所を示すフラグ。 既定値は 'taskWorkingDirectory' です。

値 説明
TaskWorkingDirectory

標準の Batch サービス タスク作業ディレクトリを使用します。このディレクトリには、Batch によって設定されたタスク リソース ファイルが含まれます。
ContainerImageDefault

コンテナー イメージを使用して作業ディレクトリを定義します。 このディレクトリには、Batch によってダウンロードされたリソース ファイルが含まれていないことに注意してください。

DataDisk

Object

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

名前 型 説明
caching

CachingType

データ ディスクに対して有効にするキャッシュの種類。
値は次のとおりです。

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

キャッシュの既定値は none です。 キャッシュ オプションの詳細については、「https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/」を参照してください。
diskSizeGB

integer (int32)

新しいデータ ディスクを作成するときの初期ディスク サイズ (GB)。
lun

integer (int32)

論理ユニット番号。
lun は、各データ ディスクを一意に識別するために使用されます。 複数のディスクを接続する場合は、それぞれ個別の LUN が必要です。 値は、0 ~ 63 の範囲である必要があります。
managedDisk

ManagedDisk

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

StorageAccountType

データ ディスクに使用するストレージ アカウントの種類。
省略した場合、既定値は "Standard_LRS" です。 値は次のとおりです。

Standard_LRS - データ ディスクは、標準のローカル冗長ストレージを使用する必要があります。 Premium_LRS - データ ディスクでは、Premium ローカル冗長ストレージを使用する必要があります。

DeploymentConfiguration

Object

展開構成プロパティ。

名前 型 説明
virtualMachineConfiguration

VirtualMachineConfiguration

プールの仮想マシン構成。

DiffDiskPlacement

列挙

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

値 説明
CacheDisk

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

DiffDiskSettings

Object

仮想マシンで使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。

名前 型 説明
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 ディスク サイズ要件に関するページを参照してください。

DiskCustomerManagedKey

Object

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

名前 型 説明
identityReference

PoolIdentityReference

ディスクを暗号化するためのプール 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 がコンピューティング ノードで暗号化するディスク ターゲットの一覧
Linux プールでは、"TemporaryDisk" のみがサポートされています。Windows プールでは、"OsDisk" と "TemporaryDisk" を指定する必要があります。

DiskEncryptionSetParameters

Object

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

名前 型 説明
id

string

ディスク暗号化セットの ARM リソース ID。 リソースはバッチアカウントと同じサブスクリプションにあるはずです。

DiskEncryptionTarget

列挙

Batch Service がコンピューティング ノードで暗号化するディスク ターゲットの一覧

値 説明
OsDisk

コンピューティング ノード上の OS ディスクは暗号化されます。
TemporaryDisk

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

DynamicVNetAssignmentScope

列挙

動的 vnet 割り当てのスコープ。

値 説明
none

動的 VNet 割り当てが有効になっていません。
job

動的 VNet の割り当てはジョブごとに実行されます。 この値を設定する場合は、ネットワーク構成サブネット ID も設定する必要があります。 この機能は、使用前に承認が必要です。サポートにお問い合わせください

ElevationLevel

列挙

ユーザーの昇格レベル。

値 説明
NonAdmin

ユーザーは、昇格されたアクセス権を持たない標準ユーザーです。
Admin

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

EnvironmentSetting

Object

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

名前 型 説明
name

string

環境変数の名前。
value

string

環境変数の値。

FixedScaleSettings

Object

プールのスケール設定を修正しました。

名前 型 規定値 説明
nodeDeallocationOption

ComputeNodeDeallocationOption

プール サイズが減少している場合にノードとその実行中のタスクを処理する方法を決定します。
省略した場合、既定値は Requeue です。
resizeTimeout

string (duration)

PT15M

プールへのコンピューティング ノードの割り当てのタイムアウト。
既定値は 15 分です。 タイムアウト値は ISO 8601 形式を使用します。 たとえば、PT10M を 10 分間使用します。 最小値は 5 分です。 5 分未満の値を指定した場合、Batch サービスはエラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
targetDedicatedNodes

integer (int32)

プール内の専用コンピューティング ノードの目的の数。
targetDedicatedNodes のうち少なくとも 1 つ、targetLowPriorityNodes を設定する必要があります。
targetLowPriorityNodes

integer (int32)

プール内のスポット/優先順位の低いコンピューティング ノードの目的の数。
targetDedicatedNodes のうち少なくとも 1 つ、targetLowPriorityNodes を設定する必要があります。

HostEndpointSettings

Object

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

名前 型 説明
inVMAccessControlProfileReferenceId

string

InVMAccessControlProfileVersion リソース ID への参照を、/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} の形式で指定します。
mode

HostEndpointSettingsModeTypes

監査/執行
アクセス制御ポリシーの実行モードを指定します。

HostEndpointSettingsModeTypes

列挙

監査/執行

値 説明
Audit

監査モードでは、システムは、ログにアクセス拒否エントリを出力するなど、アクセス制御ポリシーを適用しているかのように機能しますが、実際にはホスト エンドポイントへの要求を拒否しません。
Enforce

強制モードは推奨される動作モードであり、システムはアクセス制御ポリシーを強制します。 このプロパティは「inVMAccessControlProfileReferenceId」と併用できません。

ImageReference

Object

カスタム仮想マシンの Azure Virtual Machines Marketplace イメージまたは Azure Image リソースへの参照。 Azure Batch によって検証されたすべての imageReferences の一覧を取得するには、「サポートされているノード エージェント SKU の一覧表示」操作を参照してください。

名前 型 説明
communityGalleryImageId

string

コミュニティ ギャラリー イメージの一意識別子
このプロパティは他のプロパティと相互に排他的であり、コミュニティ ギャラリー イメージの GET 呼び出しからフェッチできます。
id

string

Azure コンピューティング ギャラリー イメージの ARM リソース識別子。 プール内のコンピューティング ノードは、このイメージ ID を使用して作成されます。これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId} の形式です。
このプロパティは、他のプロパティと相互に排他的です。 Azure コンピューティング ギャラリー イメージには、Azure Batch アカウントと同じリージョンにレプリカが必要です。 Batch ノード エージェントが Batch サービスと通信するためのファイアウォール設定については、https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configurationを参照してください。
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 や 2022-datacenter などです。
version

string

Azure Virtual Machines Marketplace イメージのバージョン。
"latest" の値を指定して、イメージの最新バージョンを選択できます。 省略した場合、既定値は 'latest' です。

InboundEndpointProtocol

列挙

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

値 説明
TCP

エンドポイントには TCP を使用します。
UDP

エンドポイントには UDP を使用します。

InboundNatPool

Object

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

名前 型 説明
backendPort

integer (int32)

コンピューティング ノードのポート番号。
これは Batch プール内で一意である必要があります。 29876 から 29877 を除き、使用可能な値は 1 から 65535 の間です。これらは予約されています。 予約された値が指定された場合、要求は HTTP 状態コード 400 で失敗します。
frontendPortRangeEnd

integer (int32)

個々のコンピューティング ノードで backendPort への受信アクセスを提供するために使用される外部ポートの範囲内の最後のポート番号。
指定できる値の範囲は 1 ~ 65534 です。ただし、Batch サービスによって予約されているポートは 50000 ~ 55000 です。 プール内のすべての範囲は個別である必要があり、重複することはできません。 予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。
frontendPortRangeStart

integer (int32)

個々のコンピューティング ノードで backendPort への受信アクセスを提供するために使用される外部ポートの範囲内の最初のポート番号。
使用可能な値の範囲は 1 ~ 65534 です。ただし、予約されているポートは 50000 ~ 55000 です。 プール内のすべての範囲は個別である必要があり、重複することはできません。 予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。
name

string

エンドポイントの名前。
名前は Batch プール内で一意である必要があり、文字、数字、アンダースコア、ピリオド、ハイフンを含めることができます。 名前は文字または数字で始まる必要があり、末尾は文字、数字、またはアンダースコアで終わる必要があり、77 文字を超えることはできません。 無効な値が指定された場合、要求は HTTP 状態コード 400 で失敗します。
networkSecurityGroupRules

NetworkSecurityGroupRule[]

エンドポイントに適用されるネットワーク セキュリティ グループ規則の一覧。
Batch プール上のすべてのエンドポイントで指定できるルールの最大数は 25 です。 ネットワーク セキュリティ グループの規則が指定されていない場合は、指定された backendPort への受信アクセスを許可する既定の規則が作成されます。 ネットワーク セキュリティ グループ規則の最大数を超えた場合、要求は HTTP 状態コード 400 で失敗します。
protocol

InboundEndpointProtocol

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

InterNodeCommunicationState

列挙

プールがノード間の直接通信を許可するかどうか。

値 説明
Enabled

仮想マシン間のネットワーク通信を有効にします。
Disabled

仮想マシン間のネットワーク通信を無効にします。

IPAddressProvisioningType

列挙

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

値 説明
BatchManaged

パブリック IP は Batch によって作成および管理されます。 プールのサイズによっては、複数のパブリック IP が存在する場合があります。
UserManaged

パブリック IP はユーザーによって提供され、コンピューティング ノードのプロビジョニングに使用されます。
NoPublicIPAddresses

プール内のコンピューティング ノードのパブリック IP アドレスは作成されません。

IPFamily

列挙

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

値 説明
IPv4

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

IPv6はプールで利用可能です。

IpTag

Object
名前 型 説明
ipTagType

string

IP タグの種類。
例: FirstPartyUsage。
tag

string

パブリック IP に関連付けられている IP タグの値。
例: SQL。

JobDefaultOrder

列挙

同じ優先度を持つ異なるジョブのタスクをスケジューリングする順序。

値 説明
None

タスクはプール内の同等優先度のすべてのジョブから均一にスケジューリングされるべきです。
CreationTime

ジョブの優先度が同じ場合は、以前に作成されたジョブのタスクを優先してスケジューリングすべきです。

LinuxUserConfiguration

Object

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

名前 型 説明
gid

integer (int32)

ユーザー アカウントのグループ ID。
uid プロパティと gid プロパティは、一緒に指定するか、まったく指定しない必要があります。 指定しない場合、基になるオペレーティング システムは gid を選択します。
sshPrivateKey

string

ユーザー アカウントの SSH 秘密キー。
秘密キーはパスワードで保護しないでください。 この秘密キーは、プールの enableInterNodeCommunication プロパティが true の場合 (enableInterNodeCommunication が false の場合は無視されます)、Linux プール内のノード間で SSH の非対称キー ベースの認証を自動的に構成するために使用されます。 これを行うには、キー ペアをユーザーの .ssh ディレクトリに配置します。 指定しない場合、ノード間でパスワードレス SSH は構成されません (ユーザーの .ssh ディレクトリの変更は行われません)。
uid

integer (int32)

ユーザー アカウントのユーザー ID。
uid プロパティと gid プロパティは、一緒に指定するか、まったく指定しない必要があります。 指定しない場合、基になるオペレーティング システムは uid を選択します。

LoginMode

列挙

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

値 説明
Batch

LOGON32_LOGON_BATCH Win32 ログイン モード。 バッチ ログイン モードは、実行時間の長い並列プロセスに推奨されます。
Interactive

LOGON32_LOGON_INTERACTIVE Win32 ログイン モード。 一部のアプリケーションでは、対話型ログイン モードに関連付けられたアクセス許可が必要です。 タスクで使用するアプリケーションの場合は、このオプションをお勧めします。

ManagedDisk

Object
名前 型 説明
diskEncryptionSet

DiskEncryptionSetParameters

マネージド ディスクのカスタマー マネージド ディスク暗号化セットのリソース ID を指定します。 UserSubscriptionモードでのみ設定できます。
securityProfile

VMDiskSecurityProfile

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

StorageAccountType

マネージド ディスクのストレージ アカウントの種類。

MetadataItem

Object

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

名前 型 説明
name

string

メタデータ項目の名前。
value

string

メタデータ項目の値。

MountConfiguration

Object

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

名前 型 説明
azureBlobFileSystemConfiguration

AzureBlobFileSystemConfiguration

各ノードで BLOB FUSE を使用してマウントする Azure Storage コンテナー。
このプロパティは、他のすべてのプロパティと相互に排他的です。
azureFileShareConfiguration

AzureFileShareConfiguration

各ノードにマウントする Azure ファイル共有。
このプロパティは、他のすべてのプロパティと相互に排他的です。
cifsMountConfiguration

CIFSMountConfiguration

各ノードにマウントする CIFS/SMB ファイル システム。
このプロパティは、他のすべてのプロパティと相互に排他的です。
nfsMountConfiguration

NFSMountConfiguration

各ノードにマウントする NFS ファイル システム。
このプロパティは、他のすべてのプロパティと相互に排他的です。

NetworkConfiguration

Object

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

名前 型 規定値 説明
dynamicVnetAssignmentScope

DynamicVNetAssignmentScope

none

動的 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 サービスはコンピューティング ノードの状態を使用不可に設定します。 指定した VNet にネットワーク セキュリティ グループ (NSG) が関連付けられている場合は、ポート 29876 と 29877 を含む、受信通信用にいくつかの予約済みシステム ポートを有効にする必要があります。 また、ポート 443 で Azure Storage への送信接続を有効にします。 詳細については、次を参照してください: https://learn.microsoft.com/azure/batch/batch-api-basics#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) またはポートまたはポート範囲の配列 (つまり、100 から 200) です。 ポートは 0 ~ 65535 の範囲にする必要があり、ポート範囲またはポートは重複できません。 その他の値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。 既定値は *です。

NetworkSecurityGroupRuleAccess

列挙

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

値 説明
Allow

アクセスを許可します。
Deny

アクセスを拒否します。

NFSMountConfiguration

Object

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

名前 型 説明
mountOptions

string

mount コマンドに渡す追加のコマンド ライン オプション。
これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。
relativeMountPath

string

ファイル システムがマウントされるコンピューティング ノード上の相対パス
すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。
source

string

マウントするファイル システムの URI。

NodePlacementConfiguration

Object

バッチプールのノード配置設定。

名前 型 説明
policy

NodePlacementPolicyType

バッチプールにおけるノード配置ポリシータイプ。
ノードをプロビジョニングするために Batch Service によって使用される割り当てポリシー。 指定しない場合、Batch はリージョン ポリシーを使用します。

NodePlacementPolicyType

列挙

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

値 説明
Regional

プール内のすべてのノードは、同じリージョンに割り当てられます。
Zonal

プール内のノードは、ベスト エフォート分散によって異なるゾーンに分散されます。

OSDisk

Object

仮想マシンのオペレーティング システム ディスクの設定。

名前 型 説明
caching

CachingType

キャッシュ要件を指定します。 使用できる値は None、ReadOnly、ReadWrite です。 既定値は、Standard Storage の場合は [なし] です。 Premium Storage の ReadOnly。
diskSizeGB

integer (int32)

新しい OS ディスクを作成するときの初期ディスク サイズ (GB)。
ephemeralOSDiskSettings

DiffDiskSettings

仮想マシンで使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。
managedDisk

ManagedDisk

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

boolean

ディスクで writeAccelerator を有効または無効にするかどうかを指定します。

Pool

Object

プールに関する情報を格納します。

名前 型 規定値 説明
etag

string

コンカレンシー ステートメントに使用されるリソースの ETag。
id

string

リソースの ID。
identity

BatchPoolIdentity

バッチ プールに使用される ID の種類。
バッチ プールに使用される ID の種類。
name

string

リソースの名前。
properties.allocationState

AllocationState

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

string (date-time)

プールが現在の割り当て状態になった時刻。
properties.applicationPackages

ApplicationPackageReference[]

プール内の各コンピューティング ノードにインストールするアプリケーション パッケージの一覧。
アプリケーション パッケージ参照に対する変更は、プールに参加しているすべての新しいコンピューティング ノードに影響しますが、再起動または再イメージ化されるまで、プール内に既に存在するコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のアプリケーション パッケージ参照があります。
properties.autoScaleRun

AutoScaleRun

自動スケール式の最後の実行の結果とエラー。
このプロパティは、プールが自動的にスケーリングされる場合 、つまり autoScaleSettings が使用される場合にのみ設定されます。
properties.creationTime

string (date-time)

プールの作成時刻。
properties.currentDedicatedNodes

integer (int32)

プール内の現在の専用コンピューティング ノードの数。
properties.currentLowPriorityNodes

integer (int32)

プール内の現在のスポット/優先順位の低いコンピューティング ノードの数。
properties.deploymentConfiguration

DeploymentConfiguration

このプロパティは、プール ノードがデプロイされる仮想マシンについて説明します。
properties.displayName

string

プールの表示名。
表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。
properties.interNodeCommunication

InterNodeCommunicationState

プールがノード間の直接通信を許可するかどうか。
これにより、プールに割り当てることができるノードに制限が適用されます。 この値を有効にすると、要求されたノード数がプールに割り当てられる可能性が低くなります。 指定しない場合、この値の既定値は "Disabled" になります。
properties.lastModified

string (date-time)

プールの最終変更時刻。
これは、targetDedicatedNodes や autoScaleSettings などのプール レベルのデータが最後に変更された時刻です。 コンピューティング ノードの状態の変化など、ノード レベルの変更は考慮されません。
properties.metadata

MetadataItem[]

メタデータとしてプールに関連付けられている名前と値のペアの一覧。
Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。
properties.mountConfiguration

MountConfiguration[]

プール内の各ノードにマウントするファイル システムの一覧。
これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。
properties.networkConfiguration

NetworkConfiguration

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

PoolProvisioningState

プールの現在の状態。
properties.provisioningStateTransitionTime

string (date-time)

プールが現在の状態になった時刻。
properties.resizeOperationStatus

ResizeOperationStatus

現在または最後に完了したサイズ変更操作に関する詳細が含まれます。
現在の操作 (プール AllocationState がサイズ変更中の場合) または以前に完了した操作 (AllocationState が安定している場合) について説明します。
properties.scaleSettings

ScaleSettings

プール内のノード数を構成する設定。
プールの目的のサイズを定義します。 これは、要求された targetDedicatedNodes が指定されている "fixedScale" か、定期的に再評価される数式を定義する 'autoScale' のいずれかです。 このプロパティを指定しない場合、プールは 0 targetDedicatedNodes を使用して固定スケールになります。
properties.startTask

StartTask

プールに参加する各コンピューティング ノードで実行するように指定されたタスク。
PATCH (更新) 操作では、このプロパティを空のオブジェクトに設定して、プールから開始タスクを削除できます。
properties.taskSchedulingPolicy

TaskSchedulingPolicy

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

integer (int32)

1

プール内の 1 つのコンピューティング ノードで同時実行タスクを実行するために使用できるタスク スロットの数。
既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。
properties.upgradePolicy

UpgradePolicy

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

UserAccount[]

プール内の各ノードに作成するユーザー アカウントの一覧。
properties.vmSize

string

プール内の仮想マシンのサイズ。 プール内のすべての VM のサイズは同じです。
使用可能な VM サイズの詳細については、「Azure の仮想マシンのサイズ (https://learn.microsoft.com/azure/virtual-machines/sizes/overview)」を参照してください。 Batch では、STANDARD_A0と Premium Storage (STANDARD_GS、STANDARD_DS、STANDARD_DSV2 シリーズ) を除くすべての Azure VM サイズがサポートされます。
tags

object

リソースのタグ。
type

string

リソースの型。

PoolEndpointConfiguration

Object

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

名前 型 説明
inboundNatPools

InboundNatPool[]

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

PoolIdentityReference

Object

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

名前 型 説明
resourceId

string

ユーザー割り当て ID の ARM リソース ID。 この参照は、プール ID に含める必要があります。

PoolIdentityType

列挙

バッチ プールに使用される ID の種類。

値 説明
UserAssigned

Batch プールには、ユーザー割り当て ID があります。
None

バッチ プールには ID が関連付けされません。 更新プールで None を設定すると、既存の ID が削除されます。

PoolProvisioningState

列挙

プールの現在の状態。

値 説明
Succeeded

プールは、コンピューティング ノードの可用性に応じてタスクを実行するために使用できます。
Deleting

ユーザーはプールの削除を要求しましたが、削除操作はまだ完了していません。

ProxyAgentSettings

Object

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

名前 型 説明
enabled

boolean

メタデータ セキュリティ プロトコル機能を仮想マシンまたは仮想マシン スケール セットのどちらで有効にするかを指定します。 既定値は False です。
imds

HostEndpointSettings

IMDS エンドポイントの設定。
wireServer

HostEndpointSettings

WireServer エンドポイントの設定。

PublicIPAddressConfiguration

Object

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

名前 型 説明
ipAddressIds

string[]

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[]

Batchで作成した新しいパブリックIPに適用されるIPタグ。
provision

IPAddressProvisioningType

プールのパブリック IP アドレスのプロビジョニングの種類
既定値は BatchManaged です

ResizeError

Object

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

名前 型 説明
code

string

エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。
details

ResizeError[]

エラーに関する追加の詳細。
message

string

ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。

ResizeOperationStatus

Object

現在または最後に完了したサイズ変更操作の詳細。

名前 型 説明
errors

ResizeError[]

プールで最後のサイズ変更の実行中に発生したエラーの詳細。
このプロパティは、プールの最後のサイズ変更中にエラーが発生した場合にのみ設定され、プールの allocationState が Steady の場合にのみ設定されます。
nodeDeallocationOption

ComputeNodeDeallocationOption

プール サイズが減少している場合にノードとその実行中のタスクを処理する方法を決定します。
既定値は requeue です。
resizeTimeout

string (duration)

プールへのコンピューティング ノードの割り当てまたはプールからのコンピューティング ノードの削除のタイムアウト。
既定値は 15 分です。 最小値は 5 分です。 5 分未満の値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。
startTime

string (date-time)

このサイズ変更操作が開始された時刻。
targetDedicatedNodes

integer (int32)

プール内の専用コンピューティング ノードの目的の数。
targetLowPriorityNodes

integer (int32)

プール内のスポット/優先順位の低いコンピューティング ノードの目的の数。

ResourceFile

Object

コンピューティング ノードにダウンロードする 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 を設定してパブリック アクセスを許可します。

RollingUpgradePolicy

Object

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

名前 型 説明
enableCrossZoneUpgrade

boolean

アップグレード バッチを構築するときに、VMSS が AZ 境界を無視できるようにします。 バッチ サイズを決定するには、更新ドメインと maxBatchInstancePercent を考慮してください。 このフィールドが設定されていない場合、Azure Azure Batch では既定値は設定されません。 作成された VirtualMachineScaleSet の enableCrossZoneUpgrade の値は、VirtualMachineScaleSet の既定の構成によって決定されます。 このフィールドは、NodePlacementConfiguration をゾーンとして使用する場合にのみ true または false に設定できます。
maxBatchInstancePercent

integer (int32)

minimum: 5
maximum: 100

1 回のバッチでのローリング アップグレードによって同時にアップグレードされる仮想マシン インスタンスの合計数に対する最大割合。 これは最大であるため、以前または将来のバッチの異常なインスタンスでは、信頼性を高めるためにバッチ内のインスタンスの割合が減少する可能性があります。 このフィールドの値は、5 ~ 100 の範囲にする必要があります。 maxBatchInstancePercent と maxUnhealthyInstancePercent の両方に値が割り当てられている場合、maxBatchInstancePercent の値は maxUnhealthyInstancePercent を超えてはなりません。
maxUnhealthyInstancePercent

integer (int32)

minimum: 5
maximum: 100

アップグレードの結果として、またはローリング アップグレードが中止される前に仮想マシンの正常性チェックによって異常な状態で検出された場合に、同時に異常になる可能性があるスケール セット内の仮想マシン インスタンスの合計数に対する最大割合。 この制約は、バッチを開始する前にチェックされます。 このフィールドの値は、5 ~ 100 の範囲にする必要があります。 maxBatchInstancePercent と maxUnhealthyInstancePercent の両方に値が割り当てられている場合、maxBatchInstancePercent の値は maxUnhealthyInstancePercent を超えてはなりません。
maxUnhealthyUpgradedInstancePercent

integer (int32)

minimum: 0
maximum: 100

異常な状態にあると検出できるアップグレードされた仮想マシン インスタンスの最大割合。 このチェックは、各バッチがアップグレードされた後に行われます。 この割合を超えた場合、ローリング アップデートは中止されます。 このフィールドの値は、0 ~ 100 の範囲にする必要があります。
pauseTimeBetweenBatches

string

すべての仮想マシンの更新を 1 つのバッチで完了してから次のバッチを開始するまでの待機時間。 期間は ISO 8601 形式で指定する必要があります。
prioritizeUnhealthyInstances

boolean

正常なインスタンスの前に、スケール セット内のすべての異常なインスタンスをアップグレードします。
rollbackFailedInstancesOnPolicyBreach

boolean

ローリング アップグレード ポリシーに違反した場合、失敗したインスタンスを以前のモデルにロールバックします。

ScaleSettings

Object

プールのスケール設定

名前 型 説明
autoScale

AutoScaleSettings

プールの自動スケール設定。
このプロパティと fixedScale は相互に排他的であり、プロパティの 1 つを指定する必要があります。
fixedScale

FixedScaleSettings

プールのスケール設定を修正しました。
このプロパティと自動スケールは相互に排他的であり、プロパティの 1 つを指定する必要があります。

SecurityEncryptionTypes

列挙

マネージド ディスクの EncryptionType を指定します。 管理ディスクとVMGuestState blobの暗号化にはDiskWithVMGuestState、VMGuestState blobのみの暗号化にはVMGuestStateOnly、VMGuestState blob内のファームウェア状態を永続化しないためにNonPersistedTPMに設定されています。 注: 機密 VM にのみ設定でき、機密 VM を使用する場合は必須です。

値 説明
DiskWithVMGuestState

マネージド ディスクの EncryptionType は、VMGuestState BLOB と共にマネージド ディスクを暗号化するために DiskWithVMGuestState に設定されます。 データディスクではサポートされていません。
NonPersistedTPM

マネージド ディスクの EncryptionType は、VMGuestState BLOB にファームウェア状態を保持しないため、NonPersistedTPM に設定されています。
VMGuestStateOnly

マネージド ディスクの EncryptionType は、VMGuestState BLOB のみの暗号化に対して VMGuestStateOnly に設定されます。

SecurityProfile

Object

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

名前 型 説明
encryptionAtHost

boolean

このプロパティは、要求のユーザーが仮想マシンまたは仮想マシン スケール セットの Host Encryption を有効または無効にするために使用できます。 これにより、ホスト自体のリソース/一時ディスクを含むすべてのディスクの暗号化が有効になります。
proxyAgentSettings

ProxyAgentSettings

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

SecurityTypes

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

UefiSettings

仮想マシンの作成時に使用されるセキュア ブートや 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

StartTask

Object

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

名前 型 規定値 説明
commandLine

string

開始タスクのコマンド ライン。
コマンド ラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windows では "cmd /c MyCommand" を使用し、Linux では "/bin/sh -c MyCommand" を使用します。 startTask の他のプロパティが指定されている場合は必須です。
containerSettings

TaskContainerSettings

開始タスクを実行するコンテナーの設定。
これを指定すると、AZ_BATCH_NODE_ROOT_DIRの下にあるすべてのディレクトリ (ノード上の Azure Batch ディレクトリのルート) がコンテナーに再帰的にマップされ、すべてのタスク環境変数がコンテナーにマップされ、タスク コマンド ラインがコンテナーで実行されます。
environmentSettings

EnvironmentSetting[]

開始タスクの環境変数設定の一覧。
maxTaskRetryCount

integer (int32)

0

タスクを再試行できる最大回数。
終了コードが 0 以外の場合、Batch サービスはタスクを再試行します。 この値は、再試行回数を特に制御します。 Batch サービスはタスクを 1 回試し、この制限まで再試行できます。 たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (1 回の最初の再試行と 3 回の再試行)。 最大再試行回数が 0 の場合、Batch サービスはタスクを再試行しません。 最大再試行回数が -1 の場合、Batch サービスは制限なくタスクを再試行します。 既定値は 0 です
resourceFiles

ResourceFile[]

コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。
userIdentity

UserIdentity

開始タスクを実行するユーザー ID。
省略すると、タスクはタスクに固有の非管理ユーザーとして実行されます。
waitForSuccess

boolean

コンピューティング ノード上のタスクをスケジュールする前に、Batch サービスが開始タスクが正常に完了するまで (つまり、終了コード 0 で終了する) のを待つ必要があるかどうか。
true で、コンピューティング ノードで開始タスクが失敗した場合、Batch サービスは開始タスクを最大再試行回数 (maxTaskRetryCount) まで再試行します。 すべての再試行の後もタスクが正常に完了していない場合、Batch サービスはコンピューティング ノードを使用不可としてマークし、タスクをスケジュールしません。 この条件は、ノードの状態とスケジュール エラーの詳細を使用して検出できます。 false の場合、Batch サービスは開始タスクの完了を待機しません。 この場合、開始タスクの実行中に、他のタスクがコンピューティング ノードで実行を開始できます。開始タスクが失敗した場合でも、新しいタスクはノードで引き続きスケジュールされます。 既定値は true です。

StorageAccountType

列挙

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

値 説明
Standard_LRS

データ ディスク/OS ディスクでは、標準のローカル冗長ストレージを使用する必要があります。
Premium_LRS

データ ディスク/OS ディスクでは、Premium ローカル冗長ストレージを使用する必要があります。
StandardSSD_LRS

データ ディスク/OS ディスクでは、Standard SSD のローカル冗長ストレージを使用する必要があります。

TaskContainerSettings

Object

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

名前 型 説明
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

Object

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

名前 型 規定値 説明
jobDefaultOrder

JobDefaultOrder

同じ優先度を持つ異なるジョブのタスクをスケジューリングする順序。
指定しない場合、デフォルトは none です。
nodeFillType

ComputeNodeFillType

Spread

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

UefiSettings

Object

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

名前 型 説明
secureBootEnabled

boolean

仮想マシンでセキュア ブートを有効にするかどうかを指定します。
vTpmEnabled

boolean

仮想マシンで vTPM を有効にするかどうかを指定します。

UpgradeMode

列挙

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

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

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

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

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

値 説明
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 - 自動ユーザーは、昇格されたアクセス権を持たない標準ユーザーです。 admin - 自動ユーザーは昇格されたアクセス権を持つユーザーであり、完全な管理者アクセス許可で動作します。 既定値は nonAdmin です。
linuxUserConfiguration

LinuxUserConfiguration

ユーザー アカウントの Linux 固有のユーザー構成。
このプロパティは、Windows プールで指定されている場合は無視されます。 指定しない場合、ユーザーは既定のオプションで作成されます。
name

string

ユーザー アカウントの名前。 名前には、最大 20 文字までの Unicode 文字を含めることができます。
password

string

ユーザー アカウントのパスワード。
windowsUserConfiguration

WindowsUserConfiguration

ユーザー アカウントの Windows 固有のユーザー構成。
このプロパティは、ユーザーが Windows プール上にある場合にのみ指定できます。 指定されていない場合、Windows プールでは、既定のオプションを使用してユーザーが作成されます。

UserAssignedIdentities

Object

関連付けられているユーザー ID の一覧。

名前 型 説明
clientId

string

ユーザー割り当て ID のクライアント ID。
principalId

string

ユーザー割り当て ID のプリンシパル ID。

UserIdentity

Object

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

名前 型 説明
autoUser

AutoUserSpecification

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

string

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

VirtualMachineConfiguration

Object

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

名前 型 説明
containerConfiguration

ContainerConfiguration

プールのコンテナー構成。
指定した場合、タスクをコンテナーで実行できるように、プール内の各ノードでセットアップが実行されます。 このプールで実行されるすべての通常のタスクとジョブ マネージャー タスクは containerSettings プロパティを指定する必要があり、他のすべてのタスクで指定できます。
dataDisks

DataDisk[]

プール内のコンピューティング ノードに接続されているデータ ディスクの構成。
プール内のコンピューティング ノードに空のデータ ディスクが接続されている必要がある場合は、このプロパティを指定する必要があります。
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

仮想マシンのオペレーティング システム ディスクの設定。
エフェメラル 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

Object

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

名前 型 説明
diskEncryptionSet

DiskEncryptionSetParameters

カスタマー マネージド キーで暗号化された ConfidentialVM OS ディスクと VMGuest BLOB に使用されるマネージド ディスクのカスタマー マネージド ディスク暗号化セット リソース ID を指定します。 UserSubscriptionモードでのみ設定できます。
securityEncryptionType

SecurityEncryptionTypes

マネージド ディスクの EncryptionType を指定します。 管理ディスクとVMGuestState blobの暗号化にはDiskWithVMGuestState、VMGuestState blobのみの暗号化にはVMGuestStateOnly、VMGuestState blob内のファームウェア状態を永続化しないためにNonPersistedTPMに設定されています。 注: 機密 VM にのみ設定でき、機密 VM を使用する場合は必須です。

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

ユーザーのログイン モード
ユーザーのログイン モードを指定します。 既定値は Interactive です。