Pool - Add

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

POST {batchUrl}/pools?api-version=2022-01-01.15.0
POST {batchUrl}/pools?timeout={timeout}&api-version=2022-01-01.15.0

URI パラメーター

Name In Required Type Description
batchUrl
path True
  • string

すべてのAzure Batch サービス要求のベース URL。

api-version
query True
  • string

クライアント API のバージョン。

timeout
query
  • integer
int32

サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 30 秒です。

要求ヘッダー

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

Name Required Type Description
client-request-id
  • string
uuid

呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (例: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。

return-client-request-id
  • boolean

サーバーが応答で client-request-id を返す必要があるかどうか。

ocp-date
  • string
date-time-rfc1123

要求が発行された時刻。 クライアント ライブラリは通常、これを現在のシステム クロック時刻に設定します。REST API を直接呼び出す場合は、明示的に設定します。

要求本文

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

Name Required Type Description
id True
  • string

アカウント内のプールを一意に識別する文字列。
ID には、ハイフンやアンダースコアを含む任意の英数字を組み合わせて使用でき、64 文字を超えることはできません。 ID は大文字と小文字が区別されず、大文字と小文字が区別されません (つまり、アカウント内に大文字と小文字のみが異なるプール ID が 2 つ存在しない場合があります)。

vmSize True
  • string

プール内の仮想マシンのサイズ。 プール内のすべての仮想マシンのサイズは同じです。
Cloud Services プール (cloudServiceConfiguration で作成されたプール) で使用可能な仮想マシンのサイズについては、「Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/) のサイズ」を参照してください。 Batch では、ExtraSmall、A1V2、A2V2 を除く、すべてのCloud Services VM サイズがサポートされます。 Virtual Machines Marketplace のイメージを使用してプールに使用できる VM サイズ (virtualMachineConfiguration で作成されたプール) の詳細については、「Virtual Machines (Linux) のサイズ(https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/)」または「Virtual Machines のサイズ (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/)」を参照してください。 Batch では、STANDARD_A0と Premium Storage (STANDARD_GS、STANDARD_DS、STANDARD_DSV2 シリーズ) を除くすべての Azure VM サイズがサポートされます。

applicationLicenses
  • string[]

Batch サービスがプール内の各コンピューティング ノードで使用できるアプリケーション ライセンスの一覧。
アプリケーション ライセンスの一覧は、使用可能な Batch サービス アプリケーション ライセンスのサブセットである必要があります。 サポートされていないライセンスが要求された場合、プールの作成は失敗します。

applicationPackageReferences

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

autoScaleEvaluationInterval
  • string

自動スケールの数式に従ってプール サイズを自動的に調整する時間間隔。
既定値は 15 分です。 最小値と最大値はそれぞれ 5 分と 168 時間です。 5 分未満または 168 時間を超える値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。

autoScaleFormula
  • string

プール内のコンピューティング ノードの必要な数の数式。
enableAutoScale が false に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が true に設定されている場合は必須です。 プールが作成される前に、数式の有効性がチェックされます。 式が無効な場合、Batch サービスは詳細なエラー情報を含む要求を拒否します。 この数式の指定の詳細については、「Azure Batch プール内のコンピューティング ノードを自動的にスケーリングする」(https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/) を参照してください。

certificateReferences

プール内の各コンピューティング ノードにインストールする証明書の一覧。
Windows ノードの場合、Batch サービスは、指定した証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書は Task 作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、証明書がそのディレクトリに配置されます。

cloudServiceConfiguration

プールのクラウド サービス構成。
このプロパティと virtualMachineConfiguration は相互に排他的であり、プロパティの 1 つを指定する必要があります。 batch アカウントが poolAllocationMode プロパティを 'UserSubscription' に設定して作成された場合、このプロパティを指定できません。

displayName
  • string

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

enableAutoScale
  • boolean

プール サイズが時間の経過と同時に自動的に調整されるかどうか。
false の場合、targetDedicatedNodes と targetLowPriorityNodes の少なくとも 1 つを指定する必要があります。 true の場合、autoScaleFormula プロパティが必要であり、プールは数式に従って自動的にサイズ変更されます。 既定値は false です。

enableInterNodeCommunication
  • boolean

プールがコンピューティング ノード間の直接通信を許可するかどうか。
ノード間通信を有効にすると、プールのコンピューティング ノードのデプロイ制限により、プールの最大サイズが制限されます。 これにより、プールが目的のサイズに達しない可能性があります。 既定値は false です。

metadata

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

mountConfiguration

プールの有効期間全体にわたって、指定したファイル システムを使用して記憶域をマウントします。
Azure ファイル共有、NFS、CIFS、または Blobfuse ベースのファイル システムを使用してストレージをマウントします。

networkConfiguration

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

resizeTimeout
  • string

プールへのコンピューティング ノードの割り当てタイムアウト。
このタイムアウトは、手動スケーリングにのみ適用されます。enableAutoScale が true に設定されている場合は影響しません。 既定値は 15 分です。 最小値は 5 分です。 5 分未満の値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。

startTask

プールに参加する各コンピューティング ノードで実行するように指定されたタスク。
タスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。

targetDedicatedNodes
  • integer

プール内の専用コンピューティング ノードの必要な数。
enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。

targetLowPriorityNodes
  • integer

プール内のスポット/優先順位の低いコンピューティング ノードの必要な数。
enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。

taskSchedulingPolicy

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

taskSlotsPerNode
  • integer

プール内の単一の計算ノードで同時実行タスクを実行するために使用できるタスク スロットの数。
既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。

userAccounts

プール内の各コンピューティング ノードに作成するユーザー アカウントの一覧。

virtualMachineConfiguration

プールの仮想マシンの構成。
このプロパティと cloudServiceConfiguration は相互に排他的であり、いずれかのプロパティを指定する必要があります。

応答

Name Type Description
201 Created

Batch サービスへの要求が成功しました。

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

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

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryする

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザー アカウントの借用

Authorization

Type: apiKey
In: header

Add a CloudServiceConfiguration pool
Add a pool with mount drive specified
Add a VirtualMachineConfiguration pool
Add a VirtualMachineConfiguration pool with containers
Add a VirtualMachineConfiguration pool with extensions

Add a CloudServiceConfiguration pool

Sample Request

POST account.region.batch.azure.com/pools?api-version=2022-01-01.15.0



{
  "id": "poolId",
  "vmSize": "small",
  "cloudServiceConfiguration": {
    "osFamily": "4"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Sample Response

Add a pool with mount drive specified

Sample Request

POST account.region.batch.azure.com/pools?api-version=2022-01-01.15.0


{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "20_04-lts"
    },
    "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
}

Sample Response

Add a VirtualMachineConfiguration pool

Sample Request

POST account.region.batch.azure.com/pools?api-version=2022-01-01.15.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts"
    },
    "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"
    }
  ]
}

Sample Response

Add a VirtualMachineConfiguration pool with containers

Sample Request

POST account.region.batch.azure.com/pools?api-version=2022-01-01.15.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "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
}

Sample Response

Add a VirtualMachineConfiguration pool with extensions

Sample Request

POST account.region.batch.azure.com/pools?api-version=2022-01-01.15.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04",
    "extensions": [
      {
        "name": "batchextension1",
        "type": "SecurityMonitoringForLinux",
        "publisher": "Microsoft.Azure.Security.Monitoring",
        "typeHandlerVersion": "1.0",
        "autoUpgradeMinorVersion": true,
        "settings": "{\"settingsKey\":\"settingsValue\"}",
        "protectedSettings": "{\"protectedSettingsKey\":\"protectedSettingsValue\"}"
      }
    ]
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Sample Response

定義

ApplicationPackageReference

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

AutoUserScope

自動ユーザーのスコープ

AutoUserSpecification

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

AzureBlobFileSystemConfiguration

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

AzureFileShareConfiguration

Azure Fileshare への接続に使用される情報。

BatchError

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

BatchErrorDetail

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

CachingType

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

CertificateReference

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

CertificateStoreLocation

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

CIFSMountConfiguration

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

CloudServiceConfiguration

Azure Cloud Services プラットフォームに基づくプール内のコンピューティング ノードの構成。

ComputeNodeFillType

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

ComputeNodeIdentityReference

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

ContainerConfiguration

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

ContainerRegistry

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

ContainerType

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

ContainerWorkingDirectory

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

DataDisk

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

DiffDiskPlacement

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

DiffDiskSettings

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

DiskEncryptionConfiguration

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

DynamicVNetAssignmentScope

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

ElevationLevel

ユーザーの昇格レベル。

EnvironmentSetting

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

ErrorMessage

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

ImageReference

Azure Virtual Machines Marketplace イメージまたは Shared Image Gallery イメージへの参照。 Azure Batchによって検証されたすべてのAzure Marketplaceイメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。

InboundEndpointProtocol

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

InboundNATPool

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

IPAddressProvisioningType

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

LinuxUserConfiguration

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

LoginMode

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

MetadataItem

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

MountConfiguration

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

NetworkConfiguration

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

NetworkSecurityGroupRule

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

NetworkSecurityGroupRuleAccess

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

NFSMountConfiguration

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

NodePlacementConfiguration

プールのノード配置の構成。

NodePlacementPolicyType

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

OSDisk

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

PoolAddParameter

追加するAzure Batch サービス内のプール。

PoolEndpointConfiguration

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

PublicIPAddressConfiguration

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

ResourceFile

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

StartTask

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

StorageAccountType

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

TaskContainerSettings

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

TaskSchedulingPolicy

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

UserAccount

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

UserIdentity

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

VirtualMachineConfiguration

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

VMExtension

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

WindowsConfiguration

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

WindowsUserConfiguration

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

ApplicationPackageReference

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

Name Type Description
applicationId
  • string

デプロイするアプリケーションの ID。

version
  • string

デプロイするアプリケーションのバージョン。 省略すると、既定のバージョンがデプロイされます。
プールでこれを省略し、このアプリケーションに既定のバージョンが指定されていない場合、要求はエラー コード InvalidApplicationPackageReferences と HTTP 状態コード 409 で失敗します。 タスクでこれを省略し、このアプリケーションに既定のバージョンが指定されていない場合、タスクは前処理エラーで失敗します。

AutoUserScope

自動ユーザーのスコープ

Name Type Description
pool
  • string

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

task
  • string

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

AutoUserSpecification

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

Name Type Description
elevationLevel

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

scope

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

AzureBlobFileSystemConfiguration

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

Name Type Description
accountKey
  • string

Azure Storage アカウント キー。
このプロパティは、sasKey と ID の両方と相互に排他的です。正確に 1 つを指定する必要があります。

accountName
  • string

Azure Storage アカウント名。

blobfuseOptions
  • string

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

containerName
  • string

Azure Blob Storage コンテナー名。

identityReference

containerName へのアクセスに使用するユーザー割り当て ID への参照
このプロパティは、accountKey と sasKey の両方で相互に排他的です。正確に 1 つを指定する必要があります。

relativeMountPath
  • string

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

sasKey
  • string

Azure Storage SAS トークン。
このプロパティは、accountKey と ID の両方で相互に排他的です。正確に 1 つを指定する必要があります。

AzureFileShareConfiguration

Azure Fileshare への接続に使用される情報。

Name Type Description
accountKey
  • string

Azure Storage アカウント キー。

accountName
  • string

Azure Storage のアカウント名。

azureFileUrl
  • string

Azure Files URL。
これは "https://{account}.file.core.windows.net/" という形式です。

mountOptions
  • string

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

relativeMountPath
  • string

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

BatchError

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

Name Type Description
code
  • string

エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。

message

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

values

エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

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

Name Type Description
key
  • string

Value プロパティの意味を指定する識別子。

value
  • string

エラー応答に含まれる追加情報。

CachingType

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

Name Type Description
none
  • string

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

readonly
  • string

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

readwrite
  • string

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

CertificateReference

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

Name Type Description
storeLocation

証明書をインストールするコンピューティング ノード上の証明書ストアの場所。
既定値は currentuser です。 このプロパティは、Windows コンピューティング ノードで構成されたプール (つまり、cloudServiceConfiguration を使用して作成されたプール、または Windows イメージ参照を使用した virtualMachineConfiguration) にのみ適用されます。 Linux コンピューティング ノードの場合、証明書は Task 作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、証明書がそのディレクトリに配置されます。

storeName
  • string

証明書をインストールするコンピューティング ノード上の証明書ストアの名前。
このプロパティは、Windows コンピューティング ノードで構成されたプール (つまり、cloudServiceConfiguration を使用して作成されたプール、または Windows イメージ参照を使用した virtualMachineConfiguration) にのみ適用されます。 一般的なストア名には、My、Root、CA、Trust、Disallowed、TrustedPeople、TrustedPublisher、AuthRoot、AddressBook などがありますが、任意のカスタム ストア名も使用できます。 既定値は、My です。

thumbprint
  • string

証明書の拇印。

thumbprintAlgorithm
  • string

拇印が関連付けられているアルゴリズム。 これは sha1 である必要があります。

visibility
  • string[]

コンピューティング ノード上のどのユーザー アカウントが、証明書のプライベート データにアクセスできる必要があります。
このコレクションでは、複数の可視性を指定できます。 既定値は、すべてのアカウントです。

CertificateStoreLocation

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

Name Type Description
currentuser
  • string

CurrentUser 証明書ストアに証明書をインストールする必要があります。

localmachine
  • string

証明書は LocalMachine 証明書ストアにインストールする必要があります。

CIFSMountConfiguration

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

Name Type Description
mountOptions
  • string

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

password
  • string

CIFS ファイル システムに対する認証に使用するパスワード。

relativeMountPath
  • string

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

source
  • string

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

username
  • string

CIFS ファイル システムに対する認証に使用するユーザー。

CloudServiceConfiguration

Azure Cloud Services プラットフォームに基づくプール内のコンピューティング ノードの構成。

Name Type Description
osFamily
  • string

プール内の仮想マシンにインストールする Azure ゲスト OS ファミリ。
使用可能な値は、2 - OS ファミリ 2 で、Windows Server 2008 R2 SP1 に相当します。 3 - OS ファミリ 3(Windows Server 2012に相当)。 4 - WINDOWS SERVER 2012 R2 と同等の OS ファミリ 4。 5 - OS ファミリ 5(Windows Server 2016に相当)。 6 - OS ファミリ 6(Windows Server 2019 と同等)。 詳細については、「Azure ゲスト OS リリース (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases)」を参照してください。

osVersion
  • string

プール内の仮想マシンにインストールされる Azure ゲスト OS のバージョン。
既定値は *で、指定した OS ファミリの最新のオペレーティング システム バージョンを指定します。

ComputeNodeFillType

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

Name Type Description
pack
  • string

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

spread
  • string

タスクは、プール内のすべてのコンピューティング ノードに均等に割り当てる必要があります。

ComputeNodeIdentityReference

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

Name Type Description
resourceId
  • string

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

ContainerConfiguration

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

Name Type Description
containerImageNames
  • string[]

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

containerRegistries

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

type

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

ContainerRegistry

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

Name Type Description
identityReference

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

password
  • string

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

registryServer
  • string

レジストリ URL。
省略すると、既定値は "docker.io" になります。

username
  • string

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

ContainerType

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

Name Type Description
dockerCompatible
  • string

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

ContainerWorkingDirectory

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

Name Type Description
containerImageDefault
  • string

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

taskWorkingDirectory
  • string

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

DataDisk

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

Name Type Description
caching

データ ディスクに対して有効にするキャッシュの種類。
キャッシュの既定値は readwrite です。 キャッシュ オプションの詳細については、次 https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/を参照してください。

diskSizeGB
  • integer

初期ディスク サイズ (ギガバイト単位)。

lun
  • integer

論理単位番号。
lun は、各データ ディスクを一意に識別するために使用されます。 複数のディスクを接続する場合は、それぞれに個別の lun が必要です。 値は、0 から 63 の範囲で指定する必要があります。

storageAccountType

データ ディスクに使用するストレージ アカウントの種類。
省略すると、既定値は "standard_lrs" になります。

DiffDiskPlacement

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

Name Type Description
CacheDisk
  • string

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

DiffDiskSettings

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

Name Type Description
placement

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

DiskEncryptionConfiguration

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

Name Type Description
targets
  • string[]

Batch Service がコンピューティング ノードで暗号化するディスク ターゲットの一覧。
省略すると、プール内のコンピューティング ノード上のディスクは暗号化されません。 Linux プールでは、"TemporaryDisk" のみがサポートされています。Windows プールでは、"OsDisk" と "TemporaryDisk" を指定する必要があります。

DynamicVNetAssignmentScope

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

Name Type Description
job
  • string

動的 VNet の割り当てはジョブごとに実行されます。

none
  • string

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

ElevationLevel

ユーザーの昇格レベル。

Name Type Description
admin
  • string

ユーザーは、管理者特権のアクセス権を持つユーザーであり、完全な管理者アクセス許可を使用して操作します。

nonadmin
  • string

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

EnvironmentSetting

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

Name Type Description
name
  • string

環境変数の名前。

value
  • string

環境変数の値。

ErrorMessage

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

Name Type Description
lang
  • string

エラー メッセージの言語コード

value
  • string

メッセージのテキストです。

ImageReference

Azure Virtual Machines Marketplace イメージまたは Shared Image Gallery イメージへの参照。 Azure Batchによって検証されたすべてのAzure Marketplaceイメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。

Name Type Description
exactVersion
  • string

ノードの作成に使用されるプラットフォーム イメージまたはマーケットプレース イメージの特定のバージョン。 この読み取り専用フィールドは、プールの作成時に 'version' に指定された値が 'latest' の場合にのみ、'version' と異なります。

offer
  • string

Azure Virtual Machines Marketplace イメージのオファーの種類。
たとえば、UbuntuServer や WindowsServer などです。

publisher
  • string

Azure Virtual Machines Marketplace イメージの発行元。
たとえば、Canonical や MicrosoftWindowsServer などです。

sku
  • string

Azure Virtual Machines Marketplace イメージの SKU。
たとえば、18.04-LTS や 2019-Datacenter などです。

version
  • string

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

virtualMachineImageId
  • string

Shared Image Gallery イメージの ARM リソース識別子。 プール内のコンピューティング ノードは、このイメージ ID を使用して作成されます。これは、常に最新のイメージ バージョンに既定で設定される /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleryName}/images/{imageDefinitionName}/versions/{VersionId} または /subscriptions/{subscriptionId}/resourceGroup}/providers/Microsoft.Compute/gallerys/galleryName}/images/{imageDefinitionName} の形式です。
このプロパティは、他の ImageReference プロパティと相互に排他的です。 Shared Image Gallery イメージは、同じリージョンにレプリカがあり、Azure Batch アカウントと同じサブスクリプションに存在する必要があります。 イメージのバージョンが imageId で指定されていない場合は、最新バージョンが使用されます。 Batch サービスと通信する Batch コンピューティング ノード エージェントのファイアウォール設定の詳細については、次を参照してください https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

InboundEndpointProtocol

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

Name Type Description
tcp
  • string

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

udp
  • string

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

InboundNATPool

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

Name Type Description
backendPort
  • integer

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

frontendPortRangeEnd
  • integer

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

frontendPortRangeStart
  • integer

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

name
  • string

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

networkSecurityGroupRules

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

protocol

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

IPAddressProvisioningType

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

Name Type Description
batchmanaged
  • string

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

nopublicipaddresses
  • string

パブリック IP アドレスは作成されません。

usermanaged
  • string

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

LinuxUserConfiguration

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

Name Type Description
gid
  • integer

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

sshPrivateKey
  • string

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

uid
  • integer

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

LoginMode

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

Name Type Description
batch
  • string

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

interactive
  • string

LOGON32_LOGON_INTERACTIVE Win32 ログイン モード。 UAC は、Windows VirtualMachineConfiguration プールで有効になっています。 このオプションを Windows VirtualMachineConfiguration プール内の管理者特権ユーザー ID と共に使用する場合、タスク コマンド ラインによって実行されるアプリケーションが常に管理特権を必要とするように構成されているか、常に最大特権を必要とするように構成されていない限り、ユーザー セッションは昇格されません。

MetadataItem

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

Name Type Description
name
  • string

メタデータ項目の名前。

value
  • string

メタデータ項目の値。

MountConfiguration

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

Name Type Description
azureBlobFileSystemConfiguration

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

azureFileShareConfiguration

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

cifsMountConfiguration

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

nfsMountConfiguration

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

NetworkConfiguration

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

Name Type Description
dynamicVNetAssignmentScope

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

endpointConfiguration

Batch プール内のコンピューティング ノード上のエンドポイントの構成。
プール エンドポイントの構成は、virtualMachineConfiguration プロパティを持つプールでのみサポートされます。

publicIPAddressConfiguration

Batch プール内のコンピューティング ノードのパブリック IPAddress 構成。
パブリック IP 構成プロパティは、virtualMachineConfiguration プロパティを持つプールでのみサポートされます。

subnetId
  • string

プールのコンピューティング ノードが参加する仮想ネットワーク サブネットの ARM リソース識別子。 これは、/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}の形式です。
仮想ネットワークは、Azure Batch アカウントと同じリージョンとサブスクリプションに存在する必要があります。 指定されたサブネットには、プール内のコンピューティング ノードの数に対応できる十分な空き IP アドレスが必要です。 サブネットに十分な空き IP アドレスがない場合、プールは部分的にノードを割り当て、サイズ変更エラーが発生します。 "MicrosoftAzureBatch" サービス プリンシパルには、指定された VNet の "クラシック仮想マシン共同作成者" Role-Based Access Control (RBAC) ロールが必要です。 指定したサブネットは、ノードでタスクをスケジュールできるようにするために、Azure Batch サービスからの通信を許可する必要があります。 これは、指定された VNet にネットワーク セキュリティ グループ (NSG) が関連付けられているかどうかを確認することで確認できます。 指定したサブネット内のノードへの通信が NSG によって拒否された場合、Batch サービスはコンピューティング ノードの状態を使用不可に設定します。 virtualMachineConfiguration で作成されたプールでは ARM 仮想ネットワーク ('Microsoft.Network/virtualNetworks') のみがサポートされますが、cloudServiceConfiguration で作成されたプールでは ARM とクラシック仮想ネットワークの両方がサポートされます。 指定した VNet にネットワーク セキュリティ グループ (NSG) が関連付けられている場合、予約されているいくつかのシステム ポートの受信通信を有効にする必要があります。 仮想マシン構成で作成されたプールの場合は、ポート 29876 と 29877、Linux の場合はポート 22、Windowsの場合はポート 3389 を有効にします。 クラウド サービス構成で作成されたプールの場合は、ポート 10100、20100、および 30100 を有効にします。 また、ポート 443 でAzure Storageへの送信接続を有効にします。 詳細については、次を参照してください。 https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

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

Name Type Description
access

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

priority
  • integer

このルールの優先順位。
プール内の優先順位は一意である必要があり、優先順位の順に評価されます。 数値が低いほど、優先度は高くなります。 たとえば、注文番号が 150、250、350 のルールを指定できます。 順序番号が 150 のルールは、順序が 250 のルールよりも優先されます。 使用できる優先順位は 150 ~ 4096 です。 予約された値または重複する値が指定された場合、要求は HTTP 状態コード 400 で失敗します。

sourceAddressPrefix
  • string

ルールに一致する送信元アドレスプレフィックスまたはタグ。
有効な値は、1 つの IP アドレス (10.10.10.10.10)、IP サブネット (つまり 192.168.1.0/24)、既定のタグ、または * (すべてのアドレス) です。 他の値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。

sourcePortRanges
  • string[]

規則に一致するソース ポートの範囲。
有効な値は、'' (すべてのポート 0 ~ 65535)、特定のポート (つまり 22)、またはポート範囲 (つまり 100 から 200) です。ポートは 0 ~ 65535 の範囲である必要があります。このコレクション内の各エントリは、他のエントリ (範囲または個々のポート) と重複してはなりません。他の値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。既定値は '' です。

NetworkSecurityGroupRuleAccess

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

Name Type Description
allow
  • string

アクセスを許可します。

deny
  • string

アクセスを拒否します。

NFSMountConfiguration

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

Name Type Description
mountOptions
  • string

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

relativeMountPath
  • string

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

source
  • string

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

NodePlacementConfiguration

プールのノード配置の構成。

Name Type Description
policy

Batch プールでのノード配置ポリシーの種類。
Batch Service がノードをプロビジョニングするために使用する割り当てポリシー。 指定しない場合、Batch はリージョン ポリシーを使用します。

NodePlacementPolicyType

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

Name Type Description
regional
  • string

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

zonal
  • string

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

OSDisk

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

Name Type Description
ephemeralOSDiskSettings

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

PoolAddParameter

追加するAzure Batch サービス内のプール。

Name Type Description
applicationLicenses
  • string[]

Batch サービスがプール内の各コンピューティング ノードで使用できるアプリケーション ライセンスの一覧。
アプリケーション ライセンスの一覧は、使用可能な Batch サービス アプリケーション ライセンスのサブセットである必要があります。 サポートされていないライセンスが要求された場合、プールの作成は失敗します。

applicationPackageReferences

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

autoScaleEvaluationInterval
  • string

自動スケールの数式に従ってプール サイズを自動的に調整する時間間隔。
既定値は 15 分です。 最小値と最大値はそれぞれ 5 分と 168 時間です。 5 分未満または 168 時間を超える値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。

autoScaleFormula
  • string

プール内のコンピューティング ノードの必要な数の数式。
enableAutoScale が false に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が true に設定されている場合は必須です。 プールが作成される前に、数式の有効性がチェックされます。 式が無効な場合、Batch サービスは詳細なエラー情報を含む要求を拒否します。 この数式の指定の詳細については、「Azure Batch プール内のコンピューティング ノードを自動的にスケーリングする」(https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/) を参照してください。

certificateReferences

プール内の各コンピューティング ノードにインストールする証明書の一覧。
Windows ノードの場合、Batch サービスは指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、証明書がそのディレクトリに配置されます。

cloudServiceConfiguration

プールのクラウド サービス構成。
このプロパティと virtualMachineConfiguration は相互に排他的であり、プロパティの 1 つを指定する必要があります。 batch アカウントが poolAllocationMode プロパティを 'UserSubscription' に設定して作成された場合、このプロパティを指定できません。

displayName
  • string

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

enableAutoScale
  • boolean

プール サイズが時間の経過と同時に自動的に調整されるかどうか。
false の場合、targetDedicatedNodes と targetLowPriorityNodes の少なくとも 1 つを指定する必要があります。 true の場合、autoScaleFormula プロパティが必要であり、プールは数式に従って自動的にサイズ変更されます。 既定値は false です。

enableInterNodeCommunication
  • boolean

プールがコンピューティング ノード間の直接通信を許可するかどうか。
ノード間通信を有効にすると、プールのコンピューティング ノードのデプロイ制限により、プールの最大サイズが制限されます。 これにより、プールが目的のサイズに達しない可能性があります。 既定値は false です。

id
  • string

アカウント内のプールを一意に識別する文字列。
ID には、ハイフンやアンダースコアを含む任意の英数字を組み合わせて使用でき、64 文字を超えることはできません。 ID は大文字と小文字が区別されず、大文字と小文字が区別されません (つまり、アカウント内に大文字と小文字のみが異なるプール ID が 2 つ存在しない場合があります)。

metadata

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

mountConfiguration

プールの有効期間全体にわたって、指定されたファイル システムを使用して記憶域をマウントします。
Azure fileshare、NFS、CIFS、Blobfuse ベースのファイル システムを使用してストレージをマウントします。

networkConfiguration

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

resizeTimeout
  • string

プールへのコンピューティング ノードの割り当てタイムアウト。
このタイムアウトは、手動スケーリングにのみ適用されます。enableAutoScale が true に設定されている場合は影響しません。 既定値は 15 分です。 最小値は 5 分です。 5 分未満の値を指定すると、Batch サービスはエラーを返します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。

startTask

プールに参加する各コンピューティング ノードで実行するように指定されたタスク。
タスクは、コンピューティング ノードがプールに追加されたとき、またはコンピューティング ノードが再起動されたときに実行されます。

targetDedicatedNodes
  • integer

プール内の専用コンピューティング ノードの必要な数。
enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。

targetLowPriorityNodes
  • integer

プール内のスポット/優先順位の低いコンピューティング ノードの必要な数。
enableAutoScale が true に設定されている場合は、このプロパティを指定しないでください。 enableAutoScale が false に設定されている場合は、targetDedicatedNodes、targetLowPriorityNodes、またはその両方を設定する必要があります。

taskSchedulingPolicy

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

taskSlotsPerNode
  • integer

プール内の単一の計算ノードで同時実行タスクを実行するために使用できるタスク スロットの数。
既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。

userAccounts

プール内の各コンピューティング ノードに作成するユーザー アカウントの一覧。

virtualMachineConfiguration

プールの仮想マシンの構成。
このプロパティと cloudServiceConfiguration は相互に排他的であり、いずれかのプロパティを指定する必要があります。

vmSize
  • string

プール内の仮想マシンのサイズ。 プール内のすべての仮想マシンのサイズは同じです。
Cloud Services プール (cloudServiceConfiguration で作成されたプール) で使用可能な仮想マシンのサイズについては、「Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/) のサイズ」を参照してください。 Batch では、ExtraSmall、A1V2、A2V2 を除く、すべてのCloud Services VM サイズがサポートされます。 Virtual Machines Marketplace のイメージを使用してプールに使用できる VM サイズ (virtualMachineConfiguration で作成されたプール) の詳細については、「Virtual Machines (Linux) のサイズ(https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/)」または「Virtual Machines のサイズ (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/)」を参照してください。 Batch では、STANDARD_A0と Premium Storage (STANDARD_GS、STANDARD_DS、STANDARD_DSV2 シリーズ) を除くすべての Azure VM サイズがサポートされます。

PoolEndpointConfiguration

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

Name Type Description
inboundNATPools

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

PublicIPAddressConfiguration

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

Name Type Description
ipAddressIds
  • string[]

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

provision

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

ResourceFile

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

Name Type Description
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 を取得するには、BLOB に対する読み取りアクセス許可を付与する Shared Access Signature (SAS) を含めるか、読み取りアクセス許可を持つマネージド ID を使用するか、BLOB またはそのコンテナーの ACL を設定してパブリック アクセスを許可するという 3 つの方法があります。

identityReference

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 を設定してパブリック アクセスを許可します。

StartTask

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

Name Type Description
commandLine
  • string

StartTask のコマンド ライン。
コマンド ラインはシェルでは実行されないため、環境変数の展開などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windowsの "cmd /c MyCommand" や Linux の "/bin/sh -c MyCommand" を使用します。 コマンド ラインがファイル パスを参照する場合は、相対パス (Task 作業ディレクトリに対する相対パス) を使用するか、Batch で指定された環境変数 (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) を使用する必要があります。

containerSettings

StartTask を実行するコンテナーの設定。
これを指定すると、AZ_BATCH_NODE_ROOT_DIRの下にあるすべてのディレクトリ (ノード上のAzure Batch ディレクトリのルート) がコンテナーに再帰的にマップされ、すべての Task 環境変数がコンテナーにマップされ、タスク コマンド ラインがコンテナーで実行されます。 AZ_BATCH_NODE_ROOT_DIR外のコンテナーで生成されたファイルはホスト ディスクに反映されない可能性があります。つまり、Batch ファイル API はそれらのファイルにアクセスできません。

environmentSettings

StartTask の環境変数設定の一覧。

maxTaskRetryCount
  • integer

タスクを再試行できる最大回数。
終了コードが 0 以外の場合、Batch サービスは Task を再試行します。 この値によって再試行の回数が限定されますのでご注意ください。 Batch サービスはタスクを 1 回試し、この制限まで再試行できます。 たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (1 回の最初の再試行と 3 回の再試行)。 最大再試行回数が 0 の場合、Batch サービスはタスクを再試行しません。 最大再試行回数が -1 の場合、Batch サービスは制限なくタスクを再試行しますが、開始タスクまたはタスクには推奨されません。 既定値は 0 です (再試行なし)

resourceFiles

コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 リソース ファイルの一覧には最大サイズがあります。 最大サイズを超えると、要求は失敗し、応答エラー コードは RequestEntityTooLarge になります。 この場合、ResourceFiles のコレクションのサイズを小さくする必要があります。 これは、.zip ファイル、アプリケーション パッケージ、または Docker コンテナーを使用して実現できます。
この要素の下に一覧表示されるファイルは、タスクの作業ディレクトリにあります。

userIdentity

StartTask を実行するユーザー ID。
省略した場合、タスクはタスクに固有の管理以外のユーザーとして実行されます。

waitForSuccess
  • boolean

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

StorageAccountType

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

Name Type Description
premium_lrs
  • string

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

standard_lrs
  • string

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

TaskContainerSettings

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

Name Type Description
containerRunOptions
  • string

コンテナー作成コマンドの追加オプション。
これらの追加オプションは、Batch サービスによって制御されるオプションに加えて、"docker create" コマンドの引数として提供されます。

imageName
  • string

タスクが実行されるコンテナーの作成に使用するイメージ。
これは、"docker pull" に指定されているように、完全なイメージ参照です。 イメージ名の一部としてタグが指定されていない場合は、タグ ":latest" が既定として使用されます。

registry

コンテナー イメージを含むプライベート レジストリ。
プールの作成時に既に指定されている場合は、この設定を省略できます。

workingDirectory

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

TaskSchedulingPolicy

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

Name Type Description
nodeFillType

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

UserAccount

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

Name Type Description
elevationLevel

ユーザー アカウントの昇格レベル。
既定値は nonAdmin です。

linuxUserConfiguration

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

name
  • string

ユーザー アカウントの名前。

password
  • string

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

windowsUserConfiguration

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

UserIdentity

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

Name Type Description
autoUser

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

username
  • string

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

VirtualMachineConfiguration

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

Name Type Description
containerConfiguration

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

dataDisks

プール内のコンピューティング ノードに接続されているデータ ディスクの構成。
プール内のコンピューティング ノードに空のデータ ディスクが接続されている必要がある場合は、このプロパティを指定する必要があります。 これは更新できません。 各コンピューティング ノードは、独自のディスクを取得します (ディスクはファイル共有ではありません)。 既存のディスクを接続できません。接続されている各ディスクは空です。 コンピューティング ノードがプールから削除されると、ディスクとそのノードに関連付けられているすべてのデータも削除されます。 ディスクは接続後にフォーマットされません。使用https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linuxhttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machineする前にフォーマットする必要があります。

diskEncryptionConfiguration

プールのディスク暗号化構成。
指定した場合、暗号化は、ノードのプロビジョニング中にプール内の各ノードで実行されます。

extensions

プールの仮想マシン拡張機能。
指定した場合、この構成に記載されている拡張機能が各ノードにインストールされます。

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

プールのノード配置構成。
この構成では、プール内のノードを物理的に割り当てる方法に関する規則を指定します。

osDisk

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

windowsConfiguration

仮想マシンのオペレーティング システム設定をWindowsします。
imageReference プロパティで Linux OS イメージが指定されている場合は、このプロパティを指定しないでください。

VMExtension

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

Name Type Description
autoUpgradeMinorVersion
  • boolean

展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。

name
  • string

仮想マシン拡張機能の名前。

protectedSettings
  • object

拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。

provisionAfterExtensions
  • string[]

拡張機能名のコレクション。
この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。

publisher
  • string

拡張機能ハンドラーの発行元の名前。

settings
  • object

拡張機能の JSON 形式のパブリック設定。

type
  • string

拡張機能の型。

typeHandlerVersion
  • string

スクリプト ハンドラーのバージョン。

WindowsConfiguration

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

Name Type Description
enableAutomaticUpdates
  • boolean

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

WindowsUserConfiguration

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

Name Type Description
loginMode

ユーザーのログイン モード
VirtualMachineConfiguration プールの既定値は "batch" で、CloudServiceConfiguration プールの既定値は "対話型" です。