Microsoft.Batch batchAccounts/pools 2024-07-01
Bicep リソース定義
batchAccounts/pools リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.Batch/batchAccounts/pools リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Batch/batchAccounts/pools@2024-07-01' = {
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
name: 'string'
properties: {
applicationLicenses: [
'string'
]
applicationPackages: [
{
id: 'string'
version: 'string'
}
]
certificates: [
{
id: 'string'
storeLocation: 'string'
storeName: 'string'
visibility: [
'string'
]
}
]
deploymentConfiguration: {
virtualMachineConfiguration: {
containerConfiguration: {
containerImageNames: [
'string'
]
containerRegistries: [
{
identityReference: {
resourceId: 'string'
}
password: 'string'
registryServer: 'string'
username: 'string'
}
]
type: 'string'
}
dataDisks: [
{
caching: 'string'
diskSizeGB: int
lun: int
storageAccountType: 'string'
}
]
diskEncryptionConfiguration: {
targets: [
'string'
]
}
extensions: [
{
autoUpgradeMinorVersion: bool
enableAutomaticUpgrade: bool
name: 'string'
protectedSettings: any(Azure.Bicep.Types.Concrete.AnyType)
provisionAfterExtensions: [
'string'
]
publisher: 'string'
settings: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
typeHandlerVersion: 'string'
}
]
imageReference: {
communityGalleryImageId: 'string'
id: 'string'
offer: 'string'
publisher: 'string'
sharedGalleryImageId: 'string'
sku: 'string'
version: 'string'
}
licenseType: 'string'
nodeAgentSkuId: 'string'
nodePlacementConfiguration: {
policy: 'string'
}
osDisk: {
caching: 'string'
diskSizeGB: int
ephemeralOSDiskSettings: {
placement: 'CacheDisk'
}
managedDisk: {
securityProfile: {
securityEncryptionType: 'string'
}
storageAccountType: 'string'
}
writeAcceleratorEnabled: bool
}
securityProfile: {
encryptionAtHost: bool
securityType: 'string'
uefiSettings: {
secureBootEnabled: bool
vTpmEnabled: bool
}
}
serviceArtifactReference: {
id: 'string'
}
windowsConfiguration: {
enableAutomaticUpdates: bool
}
}
}
displayName: 'string'
interNodeCommunication: 'string'
metadata: [
{
name: 'string'
value: 'string'
}
]
mountConfiguration: [
{
azureBlobFileSystemConfiguration: {
accountKey: 'string'
accountName: 'string'
blobfuseOptions: 'string'
containerName: 'string'
identityReference: {
resourceId: 'string'
}
relativeMountPath: 'string'
sasKey: 'string'
}
azureFileShareConfiguration: {
accountKey: 'string'
accountName: 'string'
azureFileUrl: 'string'
mountOptions: 'string'
relativeMountPath: 'string'
}
cifsMountConfiguration: {
mountOptions: 'string'
password: 'string'
relativeMountPath: 'string'
source: 'string'
userName: 'string'
}
nfsMountConfiguration: {
mountOptions: 'string'
relativeMountPath: 'string'
source: 'string'
}
}
]
networkConfiguration: {
dynamicVnetAssignmentScope: 'string'
enableAcceleratedNetworking: bool
endpointConfiguration: {
inboundNatPools: [
{
backendPort: int
frontendPortRangeEnd: int
frontendPortRangeStart: int
name: 'string'
networkSecurityGroupRules: [
{
access: 'string'
priority: int
sourceAddressPrefix: 'string'
sourcePortRanges: [
'string'
]
}
]
protocol: 'string'
}
]
}
publicIPAddressConfiguration: {
ipAddressIds: [
'string'
]
provision: 'string'
}
subnetId: 'string'
}
resourceTags: {
{customized property}: 'string'
}
scaleSettings: {
autoScale: {
evaluationInterval: 'string'
formula: 'string'
}
fixedScale: {
nodeDeallocationOption: 'string'
resizeTimeout: 'string'
targetDedicatedNodes: int
targetLowPriorityNodes: int
}
}
startTask: {
commandLine: 'string'
containerSettings: {
containerHostBatchBindMounts: [
{
isReadOnly: bool
source: 'string'
}
]
containerRunOptions: 'string'
imageName: 'string'
registry: {
identityReference: {
resourceId: 'string'
}
password: 'string'
registryServer: 'string'
username: 'string'
}
workingDirectory: 'string'
}
environmentSettings: [
{
name: 'string'
value: 'string'
}
]
maxTaskRetryCount: int
resourceFiles: [
{
autoStorageContainerName: 'string'
blobPrefix: 'string'
fileMode: 'string'
filePath: 'string'
httpUrl: 'string'
identityReference: {
resourceId: 'string'
}
storageContainerUrl: 'string'
}
]
userIdentity: {
autoUser: {
elevationLevel: 'string'
scope: 'string'
}
userName: 'string'
}
waitForSuccess: bool
}
targetNodeCommunicationMode: 'string'
taskSchedulingPolicy: {
nodeFillType: 'string'
}
taskSlotsPerNode: int
upgradePolicy: {
automaticOSUpgradePolicy: {
disableAutomaticRollback: bool
enableAutomaticOSUpgrade: bool
osRollingUpgradeDeferral: bool
useRollingUpgradePolicy: bool
}
mode: 'string'
rollingUpgradePolicy: {
enableCrossZoneUpgrade: bool
maxBatchInstancePercent: int
maxUnhealthyInstancePercent: int
maxUnhealthyUpgradedInstancePercent: int
pauseTimeBetweenBatches: 'string'
prioritizeUnhealthyInstances: bool
rollbackFailedInstancesOnPolicyBreach: bool
}
}
userAccounts: [
{
elevationLevel: 'string'
linuxUserConfiguration: {
gid: int
sshPrivateKey: 'string'
uid: int
}
name: 'string'
password: 'string'
windowsUserConfiguration: {
loginMode: 'string'
}
}
]
vmSize: 'string'
}
tags: {
{customized property}: 'string'
}
}
プロパティ値
ApplicationPackageReference
名前 | 形容 | 価値 |
---|---|---|
身分証明書 | インストールするアプリケーション パッケージの ID。 これは、プールと同じバッチ アカウント内にある必要があります。 これは、特定のバージョンへの参照でも、存在する場合は既定のバージョンでもかまいません。 | string (必須) |
バージョン | これを省略し、このアプリケーションに既定のバージョンが指定されていない場合、要求はエラー コード InvalidApplicationPackageReferences で失敗します。 REST API を直接呼び出す場合、HTTP 状態コードは 409 です。 | 糸 |
AutomaticOSUpgradePolicy
名前 | 形容 | 価値 |
---|---|---|
disableAutomaticRollback | OS イメージのロールバック機能を無効にする必要があるかどうか。 | bool |
enableAutomaticOSUpgrade | 新しいバージョンの OS イメージが使用可能になったときに、OS アップグレードをスケール セット インスタンスに自動的に適用するかどうかを示します。 Windows ベースのプールに対してこれが true に設定されている場合、WindowsConfiguration.enableAutomaticUpdates を true に設定することはできません。 |
bool |
osRollingUpgradeDeferral | タスクを実行している場合は、TVM の OS アップグレードを延期します。 | bool |
useRollingUpgradePolicy | 自動 OS アップグレード中にローリング アップグレード ポリシーを使用するかどうかを示します。 VMSS でポリシーが定義されていない場合、OS の自動アップグレードは既定のポリシーにフォールバックします。 | bool |
AutoScaleSettings
名前 | 形容 | 価値 |
---|---|---|
evaluationInterval | 省略した場合、既定値は 15 分 (PT15M) です。 | 糸 |
式 | プール内のコンピューティング ノードの必要な数の数式。 | string (必須) |
AutoUserSpecification
名前 | 形容 | 価値 |
---|---|---|
elevationLevel | 既定値は nonAdmin です。 | 'Admin' 'NonAdmin' |
スコープ | 既定値は Pool です。 プールが Windows を実行している場合は、タスク間のより厳密な分離が必要な場合は、Task の値を指定する必要があります。 たとえば、タスクが他のタスクに影響を与える可能性のある方法でレジストリを変更する場合や、通常のタスクではアクセスできないが、開始タスクからアクセスできる必要がある証明書がプールで指定されている場合などです。 | 'Pool' 'Task' |
AzureBlobFileSystemConfiguration
名前 | 形容 | 価値 |
---|---|---|
accountKey | このプロパティは、sasKey と ID の両方と相互に排他的です。正確に 1 つを指定する必要があります。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
accountName | Azure ストレージ アカウント名。 | string (必須) |
blobfuseOptions | これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。 | 糸 |
containerName | Azure Blob Storage コンテナー名。 | string (必須) |
identityReference | このプロパティは、accountKey と sasKey の両方と相互に排他的です。正確に 1 つを指定する必要があります。 | ComputeNodeIdentityReference |
relativeMountPath | すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。 | string (必須) |
sasKey | このプロパティは accountKey と ID の両方と相互に排他的です。正確に 1 つを指定する必要があります。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
AzureFileShareConfiguration
名前 | 形容 | 価値 |
---|---|---|
accountKey | Azure Storage アカウント キー。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
accountName | Azure Storage アカウント名。 | string (必須) |
azureFileUrl | これは 'https://{account}.file.core.windows.net/' の形式です。 | string (必須) |
mountOptions | これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。 | 糸 |
relativeMountPath | すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。 | string (必須) |
AzureProxyResourceTags
名前 | 形容 | 価値 |
---|
BatchPoolIdentity
名前 | 形容 | 価値 |
---|---|---|
種類 | バッチ プールに使用される ID の種類。 | 'None' 'UserAssigned' (必須) |
userAssignedIdentities | Batch プールに関連付けられているユーザー ID の一覧。 | BatchPoolIdentityUserAssignedIdentities |
BatchPoolIdentityUserAssignedIdentities
名前 | 形容 | 価値 |
---|
CertificateReference
名前 | 形容 | 価値 |
---|---|---|
身分証明書 | プールにインストールする証明書の完全修飾 ID。 これは、プールと同じバッチ アカウント内にある必要があります。 | string (必須) |
storeLocation | 既定値は currentUser です。 このプロパティは、Windows コンピューティング ノードで構成されたプールにのみ適用されます。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。 | 'CurrentUser' 'LocalMachine' |
storeName | このプロパティは、Windows コンピューティング ノードで構成されたプールにのみ適用されます。 一般的なストア名には、My、Root、CA、Trust、Disallowed、TrustedPeople、TrustedPublisher、AuthRoot、AddressBook などがありますが、カスタム ストア名も使用できます。 既定値は My です。 | 糸 |
可視 | 証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。 | 次のいずれかを含む文字列配列: 'RemoteUser' 'StartTask' 'Task' |
CifsMountConfiguration
名前 | 形容 | 価値 |
---|---|---|
mountOptions | これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。 | 糸 |
パスワード | CIFS ファイル システムに対する認証に使用するパスワード。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
relativeMountPath | すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。 | string (必須) |
源 | マウントするファイル システムの URI。 | string (必須) |
userName | CIFS ファイル システムに対する認証に使用するユーザー。 | string (必須) |
ComputeNodeIdentityReference
名前 | 形容 | 価値 |
---|---|---|
resourceId | ユーザー割り当て ID の ARM リソース ID。 | 糸 |
ContainerConfiguration
名前 | 形容 | 価値 |
---|---|---|
containerImageNames | これは、"docker pull" に指定される完全なイメージ参照です。 イメージが代替レジストリで完全修飾されていない限り、イメージは既定の Docker レジストリから取得されます。 | string[] |
containerRegistries | 資格情報を必要とするプライベート レジストリからイメージをダウンロードする必要がある場合は、これらの資格情報をここで指定する必要があります。 | ContainerRegistry[] |
種類 | 使用するコンテナー テクノロジ。 | 'CriCompatible' 'DockerCompatible' (必須) |
ContainerHostBatchBindMountEntry
名前 | 形容 | 価値 |
---|---|---|
isReadOnly | Linux の場合、このパスを読み取り/書き込みモードとしてマウントした場合、コンテナー内のすべてのユーザーがパスの読み取り/書き込みアクセス権を持っているわけではありません。これは、ホスト VM のアクセスに依存します。 このパスが読み取り専用でマウントされている場合、コンテナー内のすべてのユーザーはパスを変更できません。 | bool |
源 | コンテナー タスクのコンテナーにマウントされるパス。 | 'Applications' 'JobPrep' 'Shared' 'Startup' 'Task' 'VfsMounts' |
ContainerRegistry
名前 | 形容 | 価値 |
---|---|---|
identityReference | コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。 | ComputeNodeIdentityReference |
パスワード | レジストリ サーバーにログインするためのパスワード。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
registryServer | 省略した場合、既定値は "docker.io" です。 | 糸 |
username | レジストリ サーバーにログインするユーザー名。 | 糸 |
DataDisk
名前 | 形容 | 価値 |
---|---|---|
キャッシング | 値は次のとおりです。 none - ディスクのキャッシュ モードが有効になっていません。 readOnly - ディスクのキャッシュ モードは読み取り専用です。 readWrite - ディスクのキャッシュ モードは読み取りと書き込みです。 キャッシュの既定値は none です。 キャッシュ オプションの詳細については、「https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/」を参照してください。 |
'None' 'ReadOnly' 'ReadWrite' |
diskSizeGB | 新しいデータ ディスクを作成するときの初期ディスク サイズ (GB)。 | int (必須) |
lun | lun は、各データ ディスクを一意に識別するために使用されます。 複数のディスクを接続する場合は、それぞれ個別の LUN が必要です。 値は、0 ~ 63 の範囲である必要があります。 | int (必須) |
storageAccountType | 省略した場合、既定値は "Standard_LRS" です。 値は次のとおりです。 Standard_LRS - データ ディスクは、標準のローカル冗長ストレージを使用する必要があります。 Premium_LRS - データ ディスクでは、Premium ローカル冗長ストレージを使用する必要があります。 |
'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' |
DeploymentConfiguration
名前 | 形容 | 価値 |
---|---|---|
virtualMachineConfiguration | Azure Virtual Machines インフラストラクチャに基づくプール内のコンピューティング ノードの構成。 | VirtualMachineConfiguration |
DiffDiskSettings
名前 | 形容 | 価値 |
---|---|---|
位置付け | このプロパティは、オペレーティング システムを配置する場所を選択する要求でユーザーが使用できます。たとえば、エフェメラル OS ディスク プロビジョニング用のキャッシュ ディスク領域などです。 エフェメラル OS ディスク サイズの要件の詳細については、「/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements」(/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements) の Windows VM のエフェメラル OS ディスク サイズ要件と Linux VM (/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements) を参照してください。 | 'CacheDisk' |
DiskEncryptionConfiguration
名前 | 形容 | 価値 |
---|---|---|
ターゲット | Linux プールでは、"TemporaryDisk" のみがサポートされています。Windows プールでは、"OsDisk" と "TemporaryDisk" を指定する必要があります。 | 次のいずれかを含む文字列配列: 'OsDisk' 'TemporaryDisk' |
EnvironmentSetting
名前 | 形容 | 価値 |
---|---|---|
名前 | 環境変数の名前。 | string (必須) |
価値 | 環境変数の値。 | 糸 |
FixedScaleSettings
名前 | 形容 | 価値 |
---|---|---|
nodeDeallocationOption | 省略した場合、既定値は Requeue です。 | 'Requeue' 'RetainedData' 'TaskCompletion' 'Terminate' |
resizeTimeout | 既定値は 15 分です。 タイムアウト値は ISO 8601 形式を使用します。 たとえば、PT10M を 10 分間使用します。 最小値は 5 分です。 5 分未満の値を指定した場合、Batch サービスはエラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 | 糸 |
targetDedicatedNodes | targetDedicatedNodes のうち少なくとも 1 つ、targetLowPriorityNodes を設定する必要があります。 | int |
targetLowPriorityNodes | targetDedicatedNodes のうち少なくとも 1 つ、targetLowPriorityNodes を設定する必要があります。 | int |
ImageReference
名前 | 形容 | 価値 |
---|---|---|
communityGalleryImageId | このプロパティは他のプロパティと相互に排他的であり、コミュニティ ギャラリー イメージの GET 呼び出しからフェッチできます。 | 糸 |
身分証明書 | このプロパティは、他のプロパティと相互に排他的です。 Azure コンピューティング ギャラリー イメージには、Azure Batch アカウントと同じリージョンにレプリカが必要です。 Batch サービスと通信するための Batch ノード エージェントのファイアウォール設定については、/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration を参照してください。 | 糸 |
提供 | たとえば、UbuntuServer や WindowsServer などです。 | 糸 |
発行者 | たとえば、Canonical または MicrosoftWindowsServer です。 | 糸 |
sharedGalleryImageId | このプロパティは他のプロパティと相互に排他的であり、共有ギャラリー イメージの GET 呼び出しからフェッチできます。 | 糸 |
sku | たとえば、18.04-LTS や 2022-datacenter などです。 | 糸 |
バージョン | "latest" の値を指定して、イメージの最新バージョンを選択できます。 省略した場合、既定値は 'latest' です。 | 糸 |
InboundNatPool
名前 | 形容 | 価値 |
---|---|---|
backendPort | これは Batch プール内で一意である必要があります。 29876 から 29877 を除き、使用可能な値は 1 から 65535 の間です。これらは予約されています。 予約された値が指定された場合、要求は HTTP 状態コード 400 で失敗します。 | int (必須) |
frontendPortRangeEnd | 指定できる値の範囲は 1 ~ 65534 です。ただし、Batch サービスによって予約されているポートは 50000 ~ 55000 です。 プール内のすべての範囲は個別である必要があり、重複することはできません。 予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。 | int (必須) |
frontendPortRangeStart | 使用可能な値の範囲は 1 ~ 65534 です。ただし、予約されているポートは 50000 ~ 55000 です。 プール内のすべての範囲は個別である必要があり、重複することはできません。 予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。 | int (必須) |
名前 | 名前は Batch プール内で一意である必要があり、文字、数字、アンダースコア、ピリオド、ハイフンを含めることができます。 名前は文字または数字で始まる必要があり、末尾は文字、数字、またはアンダースコアで終わる必要があり、77 文字を超えることはできません。 無効な値が指定された場合、要求は HTTP 状態コード 400 で失敗します。 | string (必須) |
networkSecurityGroupRules | Batch プール上のすべてのエンドポイントで指定できるルールの最大数は 25 です。 ネットワーク セキュリティ グループの規則が指定されていない場合は、指定された backendPort への受信アクセスを許可する既定の規則が作成されます。 ネットワーク セキュリティ グループ規則の最大数を超えた場合、要求は HTTP 状態コード 400 で失敗します。 | NetworkSecurityGroupRule[] |
議定書 | エンドポイントのプロトコル。 | 'TCP' 'UDP' (必須) |
LinuxUserConfiguration
名前 | 形容 | 価値 |
---|---|---|
gid | uid プロパティと gid プロパティは、一緒に指定するか、まったく指定しない必要があります。 指定しない場合、基になるオペレーティング システムは gid を選択します。 | int |
sshPrivateKey | 秘密キーはパスワードで保護しないでください。 この秘密キーは、プールの enableInterNodeCommunication プロパティが true の場合 (enableInterNodeCommunication が false の場合は無視されます)、Linux プール内のノード間で SSH の非対称キー ベースの認証を自動的に構成するために使用されます。 これを行うには、キー ペアをユーザーの .ssh ディレクトリに配置します。 指定しない場合、ノード間でパスワードレス SSH は構成されません (ユーザーの .ssh ディレクトリの変更は行われません)。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
uid | uid プロパティと gid プロパティは、一緒に指定するか、まったく指定しない必要があります。 指定しない場合、基になるオペレーティング システムは uid を選択します。 | int |
ManagedDisk
名前 | 形容 | 価値 |
---|---|---|
securityProfile | マネージド ディスクのセキュリティ プロファイル設定を指定します。 注: 機密 VM にのみ設定でき、機密 VM を使用する場合に必要です。 | VMDiskSecurityProfile を |
storageAccountType | データ ディスクまたは OS ディスクの作成に使用するストレージ アカウントの種類。 | 'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' |
MetadataItem
名前 | 形容 | 価値 |
---|---|---|
名前 | メタデータ項目の名前。 | string (必須) |
価値 | メタデータ項目の値。 | string (必須) |
Microsoft.Batch/batchAccounts/pools
名前 | 形容 | 価値 |
---|---|---|
同一性 | バッチ プールに使用される ID の種類。 | BatchPoolIdentity の |
名前 | リソース名 | 糸 制約: 最小長 = 1 最大長 = 1 パターン = ^[a-zA-Z0-9_-]+$ (必須) |
親 | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 |
種類のリソースのシンボリック名: batchAccounts |
プロパティ | プールに関連付けられているプロパティ。 | PoolProperties |
タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
MountConfiguration
名前 | 形容 | 価値 |
---|---|---|
azureBlobFileSystemConfiguration | このプロパティは、他のすべてのプロパティと相互に排他的です。 | AzureBlobFileSystemConfiguration の |
azureFileShareConfiguration | このプロパティは、他のすべてのプロパティと相互に排他的です。 | AzureFileShareConfiguration |
cifsMountConfiguration | このプロパティは、他のすべてのプロパティと相互に排他的です。 | CifsMountConfiguration の |
nfsMountConfiguration | このプロパティは、他のすべてのプロパティと相互に排他的です。 | NFSMountConfiguration の |
NetworkConfiguration
名前 | 形容 | 価値 |
---|---|---|
dynamicVnetAssignmentScope | 動的 vnet 割り当てのスコープ。 | 'job' 'none' |
enableAcceleratedNetworking | 高速ネットワークにより、VM への単一ルート I/O 仮想化 (SR-IOV) が可能になり、ネットワーク パフォーマンスが向上する可能性があります。 詳細については、/azure/virtual-network/accelerated-networking-overview を参照してください。 | bool |
endpointConfiguration | プールのエンドポイント構成。 | PoolEndpointConfiguration |
publicIPAddressConfiguration | プールのネットワーク構成のパブリック IP アドレス構成。 | PublicIPAddressConfiguration |
subnetId | 仮想ネットワークは、Azure Batch アカウントと同じリージョンとサブスクリプションに存在する必要があります。 指定されたサブネットには、プール内のノード数に対応できる十分な空き IP アドレスが必要です。 サブネットに十分な空き IP アドレスがない場合、プールはコンピューティング ノードを部分的に割り当て、サイズ変更エラーが発生します。 "MicrosoftAzureBatch" サービス プリンシパルには、指定された VNet の "クラシック仮想マシン共同作成者" Role-Based アクセス制御 (RBAC) ロールが必要です。 指定したサブネットでは、コンピューティング ノードでタスクをスケジュールできるように、Azure Batch サービスからの通信を許可する必要があります。 これは、指定された VNet にネットワーク セキュリティ グループ (NSG) が関連付けられているかどうかを確認することで確認できます。 指定したサブネット内のコンピューティング ノードへの通信が NSG によって拒否された場合、Batch サービスはコンピューティング ノードの状態を使用不可に設定します。 指定した VNet にネットワーク セキュリティ グループ (NSG) が関連付けられている場合は、ポート 29876 と 29877 を含む、受信通信用にいくつかの予約済みシステム ポートを有効にする必要があります。 また、ポート 443 で Azure Storage への送信接続を有効にします。 詳細については、/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration を参照してください。 | 糸 |
NetworkSecurityGroupRule
名前 | 形容 | 価値 |
---|---|---|
アクセス | 指定した IP アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。 | 'Allow' 'Deny' (必須) |
優先権 | プール内の優先順位は一意である必要があり、優先順位の順に評価されます。 数値が小さい方が優先度が高くなります。 たとえば、順序番号が 150、250、350 のルールを指定できます。 順序番号が 150 のルールは、順序が 250 のルールよりも優先されます。 許可される優先順位は 150 から 4096 です。 予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。 | int (必須) |
sourceAddressPrefix | 有効な値は、1 つの IP アドレス (10.10.10.10.10)、IP サブネット (つまり 192.168.1.0/24)、既定のタグ、または * (すべてのアドレスの場合) です。 その他の値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。 | string (必須) |
sourcePortRanges | 有効な値は、'*' (すべてのポート 0 から 65535) またはポートまたはポート範囲の配列 (つまり、100 から 200) です。 ポートは 0 ~ 65535 の範囲にする必要があり、ポート範囲またはポートは重複できません。 その他の値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。 既定値は *です。 | string[] |
NFSMountConfiguration
名前 | 形容 | 価値 |
---|---|---|
mountOptions | これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。 | 糸 |
relativeMountPath | すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。 | string (必須) |
源 | マウントするファイル システムの URI。 | string (必須) |
NodePlacementConfiguration
名前 | 形容 | 価値 |
---|---|---|
政策 | ノードをプロビジョニングするために Batch Service によって使用される割り当てポリシー。 指定しない場合、Batch はリージョン ポリシーを使用します。 | 'Regional' 'Zonal' |
OSDisk
名前 | 形容 | 価値 |
---|---|---|
キャッシング | ディスクに対して有効にするキャッシュの種類。 | 'None' 'ReadOnly' 'ReadWrite' |
diskSizeGB | 新しい OS ディスクを作成するときの初期ディスク サイズ (GB)。 | int |
ephemeralOSDiskSettings | 仮想マシンで使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。 | DiffDiskSettings の |
managedDisk | ManagedDisk の |
|
writeAcceleratorEnabled | ディスクで writeAccelerator を有効または無効にするかどうかを指定します。 | bool |
PoolEndpointConfiguration
名前 | 形容 | 価値 |
---|---|---|
inboundNatPools | Batch プールあたりの受信 NAT プールの最大数は 5 です。 受信 NAT プールの最大数を超えた場合、要求は HTTP 状態コード 400 で失敗します。 IPAddressProvisioningType が NoPublicIPAddresses の場合、これは指定できません。 | InboundNatPool[] (必須) |
PoolProperties
名前 | 形容 | 価値 |
---|---|---|
applicationLicenses | アプリケーション ライセンスの一覧は、使用可能な Batch サービス アプリケーション ライセンスのサブセットである必要があります。 サポートされていないライセンスが要求された場合、プールの作成は失敗します。 | string[] |
applicationPackages | アプリケーション パッケージ参照に対する変更は、プールに参加しているすべての新しいコンピューティング ノードに影響しますが、再起動または再イメージ化されるまで、プール内に既に存在するコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のアプリケーション パッケージ参照があります。 | ApplicationPackageReference[] |
証明 書 | Windows コンピューティング ノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。 警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに、Azure KeyVault 拡張機能 を使用してください。 |
CertificateReference[] |
deploymentConfiguration | 展開構成プロパティ。 | DeploymentConfiguration |
displayName | 表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。 | 糸 |
interNodeCommunication | これにより、プールに割り当てることができるノードに制限が適用されます。 この値を有効にすると、要求されたノード数がプールに割り当てられる可能性が低くなります。 指定しない場合、この値の既定値は "Disabled" になります。 | 'Disabled' 'Enabled' |
metadata | Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。 | MetadataItem[] |
mountConfiguration | これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。 | MountConfiguration[] |
networkConfiguration | プールのネットワーク構成。 | NetworkConfiguration |
resourceTags | Azure Batch プールに関連付けるユーザー定義タグ。 これらのタグを指定すると、プールに関連付けられているバッキング Azure リソースにこれらのタグが伝達されます。 このプロパティは、poolAllocationMode プロパティが 'UserSubscription' に設定された Batch アカウントが作成された場合にのみ指定できます。 | PoolPropertiesResourceTags |
scaleSettings | プールの目的のサイズを定義します。 これは、要求された targetDedicatedNodes が指定されている "fixedScale" か、定期的に再評価される数式を定義する 'autoScale' のいずれかです。 このプロパティを指定しない場合、プールは 0 targetDedicatedNodes を使用して固定スケールになります。 | ScaleSettings |
startTask | PATCH (更新) 操作では、このプロパティを空のオブジェクトに設定して、プールから開始タスクを削除できます。 | StartTask の |
targetNodeCommunicationMode | 省略した場合、既定値は Default です。 | 'Classic' 'Default' 'Simplified' |
taskSchedulingPolicy | 指定しない場合、既定値はスプレッドです。 | TaskSchedulingPolicy |
taskSlotsPerNode | 既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。 | int |
upgradePolicy | アップグレード ポリシー (自動、手動、またはローリング) について説明します。 | UpgradePolicy |
userAccounts | プール内の各ノードに作成するユーザー アカウントの一覧。 | UserAccount[] |
vmSize | 使用可能な VM サイズの詳細については、「仮想マシンのサイズ (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/)」または「仮想マシンのサイズ (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/)」を参照してください。 Batch では、STANDARD_A0と Premium Storage (STANDARD_GS、STANDARD_DS、STANDARD_DSV2 シリーズ) を除くすべての Azure VM サイズがサポートされます。 | 糸 |
PoolPropertiesResourceTags
名前 | 形容 | 価値 |
---|
PublicIPAddressConfiguration
名前 | 形容 | 価値 |
---|---|---|
ipAddressIds | ここで指定する IP の数によって、プールの最大サイズが制限されます。パブリック IP ごとに 100 個の専用ノードまたは 100 個のスポット/低優先度ノードを割り当て可能です。 たとえば、250 個の専用 VM を必要とするプールには、少なくとも 3 つのパブリック IP が指定されている必要があります。 このコレクションの各要素は、/subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip} の形式です。 | string[] |
支給 | 既定値は BatchManaged です | 'BatchManaged' 'NoPublicIPAddresses' 'UserManaged' |
ResourceFile
名前 | 形容 | 価値 |
---|---|---|
autoStorageContainerName | autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。 | 糸 |
blobPrefix | このプロパティは、autoStorageContainerName または storageContainerUrl が使用されている場合にのみ有効です。 このプレフィックスには、部分的なファイル名またはサブディレクトリを指定できます。 プレフィックスが指定されていない場合は、コンテナー内のすべてのファイルがダウンロードされます。 | 糸 |
fileMode | このプロパティは、Linux コンピューティング ノードにダウンロードされるファイルにのみ適用されます。 これは、Windows ノードにダウンロードされる resourceFile に対して指定されている場合は無視されます。 Linux ノードにこのプロパティが指定されていない場合は、既定値の 0770 がファイルに適用されます。 | 糸 |
filePath | httpUrl プロパティが指定されている場合、filePath は必須であり、ファイルのダウンロード先となるパス (ファイル名を含む) を記述します。 それ以外の場合、autoStorageContainerName または storageContainerUrl プロパティが指定されている場合、filePath は省略可能であり、ファイルをダウンロードするディレクトリです。 filePath がディレクトリとして使用されている場合、入力データに既に関連付けられているディレクトリ構造は完全に保持され、指定された filePath ディレクトリに追加されます。 指定した相対パスは、タスクの作業ディレクトリから抜け出すことはできません (たとえば、'..' を使用)。 | 糸 |
httpUrl | autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。 URL が Azure Blob Storage を指している場合は、コンピューティング ノードから読み取ることができる必要があります。 Azure Storage 内の BLOB のこのような URL を取得するには、3 つの方法があります。BLOB に対する読み取りアクセス許可を付与する Shared Access Signature (SAS) を含めるか、読み取りアクセス許可を持つマネージド ID を使用するか、BLOB またはそのコンテナーの ACL を設定してパブリック アクセスを許可します。 | 糸 |
identityReference | コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。 | ComputeNodeIdentityReference |
storageContainerUrl | autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。 この URL は、コンピューティング ノードから読み取り可能でリスト可能である必要があります。 Azure Storage 内のコンテナーのこのような URL を取得するには、3 つの方法があります。コンテナーに対する読み取りと一覧表示のアクセス許可を付与する Shared Access Signature (SAS) を含めるか、読み取りとリストのアクセス許可を持つマネージド ID を使用するか、コンテナーの ACL を設定してパブリック アクセスを許可します。 | 糸 |
RollingUpgradePolicy
名前 | 形容 | 価値 |
---|---|---|
enableCrossZoneUpgrade | アップグレード バッチを構築するときに、VMSS が AZ 境界を無視できるようにします。 バッチ サイズを決定するには、更新ドメインと maxBatchInstancePercent を考慮してください。 このフィールドが設定されていない場合、Azure Azure Batch では既定値は設定されません。 作成された VirtualMachineScaleSet の enableCrossZoneUpgrade の値は、VirtualMachineScaleSet の既定の構成によって決定されます。 このフィールドは、NodePlacementConfiguration をゾーンとして使用する場合にのみ true または false に設定できます。 | bool |
maxBatchInstancePercent | 1 回のバッチでのローリング アップグレードによって同時にアップグレードされる仮想マシン インスタンスの合計数に対する最大割合。 これは最大であるため、以前または将来のバッチの異常なインスタンスでは、信頼性を高めるためにバッチ内のインスタンスの割合が減少する可能性があります。 このフィールドの値は、5 ~ 100 の範囲にする必要があります。 maxBatchInstancePercent と maxUnhealthyInstancePercent の両方に値が割り当てられている場合、maxBatchInstancePercent の値は maxUnhealthyInstancePercent を超えてはなりません。 | int 制約: 最小値 = 5 最大値 = 100 |
maxUnhealthyInstancePercent | アップグレードの結果として、またはローリング アップグレードが中止される前に仮想マシンの正常性チェックによって異常な状態で検出された場合に、同時に異常になる可能性があるスケール セット内の仮想マシン インスタンスの合計数に対する最大割合。 この制約は、バッチを開始する前にチェックされます。 このフィールドの値は、5 ~ 100 の範囲にする必要があります。 maxBatchInstancePercent と maxUnhealthyInstancePercent の両方に値が割り当てられている場合、maxBatchInstancePercent の値は maxUnhealthyInstancePercent を超えてはなりません。 | int 制約: 最小値 = 5 最大値 = 100 |
maxUnhealthyUpgradedInstancePercent | 異常な状態にあると検出できるアップグレードされた仮想マシン インスタンスの最大割合。 このチェックは、各バッチがアップグレードされた後に行われます。 この割合を超えた場合、ローリング アップデートは中止されます。 このフィールドの値は、0 ~ 100 の範囲にする必要があります。 | int 制約: 最小値 = 0 最大値 = 100 |
pauseTimeBetweenBatches | すべての仮想マシンの更新を 1 つのバッチで完了してから次のバッチを開始するまでの待機時間。 期間は ISO 8601 形式で指定する必要があります。 | 糸 |
prioritizeUnhealthyInstances | 正常なインスタンスの前に、スケール セット内のすべての異常なインスタンスをアップグレードします。 | bool |
rollbackFailedInstancesOnPolicyBreach | ローリング アップグレード ポリシーに違反した場合、失敗したインスタンスを以前のモデルにロールバックします。 | bool |
ScaleSettings
名前 | 形容 | 価値 |
---|---|---|
autoScale | このプロパティと fixedScale は相互に排他的であり、プロパティの 1 つを指定する必要があります。 | AutoScaleSettings の |
fixedScale | このプロパティと自動スケールは相互に排他的であり、プロパティの 1 つを指定する必要があります。 | FixedScaleSettings |
SecurityProfile
名前 | 形容 | 価値 |
---|---|---|
encryptionAtHost | このプロパティは、要求のユーザーが仮想マシンまたは仮想マシン スケール セットの Host Encryption を有効または無効にするために使用できます。 これにより、ホスト自体のリソース/一時ディスクを含むすべてのディスクの暗号化が有効になります。 | bool |
securityType | 仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。 | 'confidentialVM' 'trustedLaunch' |
uefiSettings | 仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。 | UefiSettings |
ServiceArtifactReference
名前 | 形容 | 価値 |
---|---|---|
身分証明書 | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} の形式のサービス 成果物参照 ID | string (必須) |
StartTask
名前 | 形容 | 価値 |
---|---|---|
commandLine | コマンド ラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windows では "cmd /c MyCommand" を使用し、Linux では "/bin/sh -c MyCommand" を使用します。 startTask の他のプロパティが指定されている場合は必須です。 | 糸 |
containerSettings | これを指定すると、AZ_BATCH_NODE_ROOT_DIRの下にあるすべてのディレクトリ (ノード上の Azure Batch ディレクトリのルート) がコンテナーに再帰的にマップされ、すべてのタスク環境変数がコンテナーにマップされ、タスク コマンド ラインがコンテナーで実行されます。 | TaskContainerSettings |
environmentSettings | 開始タスクの環境変数設定の一覧。 | EnvironmentSetting[] |
maxTaskRetryCount | 終了コードが 0 以外の場合、Batch サービスはタスクを再試行します。 この値は、再試行回数を特に制御します。 Batch サービスはタスクを 1 回試し、この制限まで再試行できます。 たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (1 回の最初の再試行と 3 回の再試行)。 最大再試行回数が 0 の場合、Batch サービスはタスクを再試行しません。 最大再試行回数が -1 の場合、Batch サービスは制限なくタスクを再試行します。 既定値は 0 です | int |
resourceFiles | コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 | ResourceFile[] |
userIdentity | 省略すると、タスクはタスクに固有の非管理ユーザーとして実行されます。 | UserIdentity の |
waitForSuccess | true で、コンピューティング ノードで開始タスクが失敗した場合、Batch サービスは開始タスクを最大再試行回数 (maxTaskRetryCount) まで再試行します。 すべての再試行の後もタスクが正常に完了していない場合、Batch サービスはコンピューティング ノードを使用不可としてマークし、タスクをスケジュールしません。 この条件は、ノードの状態とスケジュール エラーの詳細を使用して検出できます。 false の場合、Batch サービスは開始タスクの完了を待機しません。 この場合、開始タスクの実行中に、他のタスクがコンピューティング ノードで実行を開始できます。開始タスクが失敗した場合でも、新しいタスクはノードで引き続きスケジュールされます。 既定値は true です。 | bool |
TaskContainerSettings
名前 | 形容 | 価値 |
---|---|---|
containerHostBatchBindMounts | この配列が null または存在しない場合、コンテナー タスクは一時ディスク ドライブ全体を Windows (または Linux では AZ_BATCH_NODE_ROOT_DIR) にマウントします。 この配列が空として設定されている場合、データ パスはコンテナーにマウントされません。 | ContainerHostBatchBindMountEntry[] |
containerRunOptions | これらの追加オプションは、Batch サービスによって制御されるオプションに加えて、"docker create" コマンドの引数として提供されます。 | 糸 |
imageName | これは、"docker pull" に指定される完全なイメージ参照です。 イメージ名の一部としてタグが指定されていない場合、タグ ":latest" が既定として使用されます。 | string (必須) |
記帳 | プールの作成時に既に指定されている場合は、この設定を省略できます。 | ContainerRegistry |
workingDirectory | コンテナー タスクの作業ディレクトリの場所を示すフラグ。 既定値は 'taskWorkingDirectory' です。 | 'ContainerImageDefault' 'TaskWorkingDirectory' |
TaskSchedulingPolicy
名前 | 形容 | 価値 |
---|---|---|
nodeFillType | タスクをコンピューティング ノード間で分散する方法。 | 'Pack' 'Spread' (必須) |
UefiSettings
名前 | 形容 | 価値 |
---|---|---|
secureBootEnabled | 仮想マシンでセキュア ブートを有効にするかどうかを指定します。 | bool |
vTpmEnabled | 仮想マシンで vTPM を有効にするかどうかを指定します。 | bool |
UpgradePolicy
名前 | 形容 | 価値 |
---|---|---|
automaticOSUpgradePolicy | OS の自動アップグレードを実行するために使用される構成パラメーター。 | AutomaticOSUpgradePolicy の |
モード | スケール セット内の仮想マシンへのアップグレード モードを指定します。 使用可能な値は次のとおりです。 手動 - スケール セット内の仮想マシンへの更新プログラムの適用を制御します。 これを行うには、manualUpgrade アクションを使用します。 自動 - スケール セット内のすべての仮想マシンが同時に自動的に更新されます。 ローリング - スケール セットは、必要に応じて一時停止時間の間にバッチで更新を実行します。 |
'automatic' 'manual' 'rolling' (必須) |
rollingUpgradePolicy | ローリング アップグレードの実行中に使用される構成パラメーター。 | RollingUpgradePolicy |
UserAccount
名前 | 形容 | 価値 |
---|---|---|
elevationLevel | nonAdmin - 自動ユーザーは、昇格されたアクセス権を持たない標準ユーザーです。 admin - 自動ユーザーは昇格されたアクセス権を持つユーザーであり、完全な管理者アクセス許可で動作します。 既定値は nonAdmin です。 | 'Admin' 'NonAdmin' |
linuxUserConfiguration | このプロパティは、Windows プールで指定されている場合は無視されます。 指定しない場合、ユーザーは既定のオプションで作成されます。 | LinuxUserConfiguration |
名前 | ユーザー アカウントの名前。 名前には、最大 20 文字までの Unicode 文字を含めることができます。 | string (必須) |
パスワード | ユーザー アカウントのパスワード。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
windowsUserConfiguration | このプロパティは、ユーザーが Windows プール上にある場合にのみ指定できます。 指定されていない場合、Windows プールでは、既定のオプションを使用してユーザーが作成されます。 | WindowsUserConfiguration |
UserAssignedIdentities
名前 | 形容 | 価値 |
---|
UserIdentity
名前 | 形容 | 価値 |
---|---|---|
autoUser | userName プロパティと autoUser プロパティは相互に排他的です。1 つを指定する必要がありますが、両方を指定する必要はありません。 | AutoUserSpecification の |
userName | userName プロパティと autoUser プロパティは相互に排他的です。1 つを指定する必要がありますが、両方を指定する必要はありません。 | 糸 |
VirtualMachineConfiguration
名前 | 形容 | 価値 |
---|---|---|
containerConfiguration | 指定した場合、タスクをコンテナーで実行できるように、プール内の各ノードでセットアップが実行されます。 このプールで実行されるすべての通常のタスクとジョブ マネージャー タスクは containerSettings プロパティを指定する必要があり、他のすべてのタスクで指定できます。 | ContainerConfiguration |
dataDisks | プール内のコンピューティング ノードに空のデータ ディスクが接続されている必要がある場合は、このプロパティを指定する必要があります。 | DataDisk[] |
diskEncryptionConfiguration | 指定した場合、暗号化は、ノードのプロビジョニング中にプール内の各ノードで実行されます。 | DiskEncryptionConfiguration |
拡張 機能 | 指定した場合、この構成に記載されている拡張機能が各ノードにインストールされます。 | VMExtension[] |
imageReference | カスタム仮想マシンの Azure Virtual Machines Marketplace イメージまたは Azure Image リソースへの参照。 Azure Batch によって検証されたすべての imageReferences の一覧を取得するには、「サポートされているノード エージェント SKU の一覧表示」操作を参照してください。 | ImageReference (必須) |
licenseType | これは、Windows オペレーティング システムを含むイメージにのみ適用され、展開されるノードの有効なオンプレミス ライセンスを保持している場合にのみ使用する必要があります。 省略した場合、オンプレミスのライセンス割引は適用されません。 値は次のとおりです。 Windows_Server - オンプレミスライセンスは Windows Server 用です。 Windows_Client - オンプレミス ライセンスは Windows クライアント用です。 |
糸 |
nodeAgentSkuId | Batch ノード エージェントは、プール内の各ノードで実行されるプログラムであり、ノードと Batch サービスの間のコマンドおよび制御インターフェイスを提供します。 オペレーティング システムごとに、SKU と呼ばれるノード エージェントのさまざまな実装があります。 選択したイメージ参照に一致するノード エージェント SKU を指定する必要があります。 サポートされているノード エージェント SKU の一覧と検証済みイメージ参照の一覧を取得するには、「サポートされているノード エージェント SKU の一覧表示」操作を参照してください。 | string (必須) |
nodePlacementConfiguration | この構成では、プール内のノードを物理的に割り当てる方法に関する規則を指定します。 | NodePlacementConfiguration |
osDisk | エフェメラル OSDisk 設定の構成が含まれています。 | OSDisk |
securityProfile | 仮想マシンまたは仮想マシン スケール セットのセキュリティ プロファイル設定を指定します。 | SecurityProfile の |
serviceArtifactReference | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} の形式のサービス 成果物参照 ID | ServiceArtifactReference |
windowsConfiguration | imageReference で Linux OS イメージが指定されている場合は、このプロパティを指定しないでください。 | WindowsConfiguration |
VMDiskSecurityProfile
名前 | 形容 | 価値 |
---|---|---|
securityEncryptionType | マネージド ディスクの EncryptionType を指定します。 VMGuestState BLOB のみを暗号化する場合は VMGuestStateOnly に、VMGuestState BLOB にファームウェアの状態を保持しない場合は NonPersistedTPM に設定されます。 注: 機密 VM にのみ設定でき、機密 VM を使用する場合は必須です。 | 'NonPersistedTPM' 'VMGuestStateOnly' |
VMExtension
名前 | 形容 | 価値 |
---|---|---|
autoUpgradeMinorVersion | 展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能はマイナー バージョンをアップグレードしません。 | bool |
enableAutomaticUpgrade | 使用可能な拡張機能の新しいバージョンがある場合に、拡張機能をプラットフォームによって自動的にアップグレードするかどうかを示します。 | bool |
名前 | 仮想マシン拡張機能の名前。 | string (必須) |
protectedSettings | 拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。 | 任意 |
provisionAfterExtensions | この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。 | string[] |
発行者 | 拡張ハンドラーの発行元の名前。 | string (必須) |
設定 | 拡張機能の JSON 形式のパブリック設定。 | 任意 |
種類 | 拡張機能の種類。 | string (必須) |
typeHandlerVersion | スクリプト ハンドラーのバージョン。 | 糸 |
WindowsConfiguration
名前 | 形容 | 価値 |
---|---|---|
enableAutomaticUpdates | 省略した場合、既定値は true です。 | bool |
WindowsUserConfiguration
名前 | 形容 | 価値 |
---|---|---|
loginMode | ユーザーのログイン モードを指定します。 既定値は Interactive です。 | 'Batch' 'Interactive' |
クイック スタートのサンプル
次のクイック スタート サンプルでは、このリソースの種類をデプロイします。
Bicep ファイル | 形容 |
---|---|
パブリック IP アドレスを せずに Azure Batch プールを |
このテンプレートでは、パブリック IP アドレスのない Azure Batch の簡略化されたノード通信プールが作成されます。 |
ARM テンプレート リソース定義
batchAccounts/pools リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.Batch/batchAccounts/pools リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Batch/batchAccounts/pools",
"apiVersion": "2024-07-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"properties": {
"applicationLicenses": [ "string" ],
"applicationPackages": [
{
"id": "string",
"version": "string"
}
],
"certificates": [
{
"id": "string",
"storeLocation": "string",
"storeName": "string",
"visibility": [ "string" ]
}
],
"deploymentConfiguration": {
"virtualMachineConfiguration": {
"containerConfiguration": {
"containerImageNames": [ "string" ],
"containerRegistries": [
{
"identityReference": {
"resourceId": "string"
},
"password": "string",
"registryServer": "string",
"username": "string"
}
],
"type": "string"
},
"dataDisks": [
{
"caching": "string",
"diskSizeGB": "int",
"lun": "int",
"storageAccountType": "string"
}
],
"diskEncryptionConfiguration": {
"targets": [ "string" ]
},
"extensions": [
{
"autoUpgradeMinorVersion": "bool",
"enableAutomaticUpgrade": "bool",
"name": "string",
"protectedSettings": {},
"provisionAfterExtensions": [ "string" ],
"publisher": "string",
"settings": {},
"type": "string",
"typeHandlerVersion": "string"
}
],
"imageReference": {
"communityGalleryImageId": "string",
"id": "string",
"offer": "string",
"publisher": "string",
"sharedGalleryImageId": "string",
"sku": "string",
"version": "string"
},
"licenseType": "string",
"nodeAgentSkuId": "string",
"nodePlacementConfiguration": {
"policy": "string"
},
"osDisk": {
"caching": "string",
"diskSizeGB": "int",
"ephemeralOSDiskSettings": {
"placement": "CacheDisk"
},
"managedDisk": {
"securityProfile": {
"securityEncryptionType": "string"
},
"storageAccountType": "string"
},
"writeAcceleratorEnabled": "bool"
},
"securityProfile": {
"encryptionAtHost": "bool",
"securityType": "string",
"uefiSettings": {
"secureBootEnabled": "bool",
"vTpmEnabled": "bool"
}
},
"serviceArtifactReference": {
"id": "string"
},
"windowsConfiguration": {
"enableAutomaticUpdates": "bool"
}
}
},
"displayName": "string",
"interNodeCommunication": "string",
"metadata": [
{
"name": "string",
"value": "string"
}
],
"mountConfiguration": [
{
"azureBlobFileSystemConfiguration": {
"accountKey": "string",
"accountName": "string",
"blobfuseOptions": "string",
"containerName": "string",
"identityReference": {
"resourceId": "string"
},
"relativeMountPath": "string",
"sasKey": "string"
},
"azureFileShareConfiguration": {
"accountKey": "string",
"accountName": "string",
"azureFileUrl": "string",
"mountOptions": "string",
"relativeMountPath": "string"
},
"cifsMountConfiguration": {
"mountOptions": "string",
"password": "string",
"relativeMountPath": "string",
"source": "string",
"userName": "string"
},
"nfsMountConfiguration": {
"mountOptions": "string",
"relativeMountPath": "string",
"source": "string"
}
}
],
"networkConfiguration": {
"dynamicVnetAssignmentScope": "string",
"enableAcceleratedNetworking": "bool",
"endpointConfiguration": {
"inboundNatPools": [
{
"backendPort": "int",
"frontendPortRangeEnd": "int",
"frontendPortRangeStart": "int",
"name": "string",
"networkSecurityGroupRules": [
{
"access": "string",
"priority": "int",
"sourceAddressPrefix": "string",
"sourcePortRanges": [ "string" ]
}
],
"protocol": "string"
}
]
},
"publicIPAddressConfiguration": {
"ipAddressIds": [ "string" ],
"provision": "string"
},
"subnetId": "string"
},
"resourceTags": {
"{customized property}": "string"
},
"scaleSettings": {
"autoScale": {
"evaluationInterval": "string",
"formula": "string"
},
"fixedScale": {
"nodeDeallocationOption": "string",
"resizeTimeout": "string",
"targetDedicatedNodes": "int",
"targetLowPriorityNodes": "int"
}
},
"startTask": {
"commandLine": "string",
"containerSettings": {
"containerHostBatchBindMounts": [
{
"isReadOnly": "bool",
"source": "string"
}
],
"containerRunOptions": "string",
"imageName": "string",
"registry": {
"identityReference": {
"resourceId": "string"
},
"password": "string",
"registryServer": "string",
"username": "string"
},
"workingDirectory": "string"
},
"environmentSettings": [
{
"name": "string",
"value": "string"
}
],
"maxTaskRetryCount": "int",
"resourceFiles": [
{
"autoStorageContainerName": "string",
"blobPrefix": "string",
"fileMode": "string",
"filePath": "string",
"httpUrl": "string",
"identityReference": {
"resourceId": "string"
},
"storageContainerUrl": "string"
}
],
"userIdentity": {
"autoUser": {
"elevationLevel": "string",
"scope": "string"
},
"userName": "string"
},
"waitForSuccess": "bool"
},
"targetNodeCommunicationMode": "string",
"taskSchedulingPolicy": {
"nodeFillType": "string"
},
"taskSlotsPerNode": "int",
"upgradePolicy": {
"automaticOSUpgradePolicy": {
"disableAutomaticRollback": "bool",
"enableAutomaticOSUpgrade": "bool",
"osRollingUpgradeDeferral": "bool",
"useRollingUpgradePolicy": "bool"
},
"mode": "string",
"rollingUpgradePolicy": {
"enableCrossZoneUpgrade": "bool",
"maxBatchInstancePercent": "int",
"maxUnhealthyInstancePercent": "int",
"maxUnhealthyUpgradedInstancePercent": "int",
"pauseTimeBetweenBatches": "string",
"prioritizeUnhealthyInstances": "bool",
"rollbackFailedInstancesOnPolicyBreach": "bool"
}
},
"userAccounts": [
{
"elevationLevel": "string",
"linuxUserConfiguration": {
"gid": "int",
"sshPrivateKey": "string",
"uid": "int"
},
"name": "string",
"password": "string",
"windowsUserConfiguration": {
"loginMode": "string"
}
}
],
"vmSize": "string"
},
"tags": {
"{customized property}": "string"
}
}
プロパティ値
ApplicationPackageReference
名前 | 形容 | 価値 |
---|---|---|
身分証明書 | インストールするアプリケーション パッケージの ID。 これは、プールと同じバッチ アカウント内にある必要があります。 これは、特定のバージョンへの参照でも、存在する場合は既定のバージョンでもかまいません。 | string (必須) |
バージョン | これを省略し、このアプリケーションに既定のバージョンが指定されていない場合、要求はエラー コード InvalidApplicationPackageReferences で失敗します。 REST API を直接呼び出す場合、HTTP 状態コードは 409 です。 | 糸 |
AutomaticOSUpgradePolicy
名前 | 形容 | 価値 |
---|---|---|
disableAutomaticRollback | OS イメージのロールバック機能を無効にする必要があるかどうか。 | bool |
enableAutomaticOSUpgrade | 新しいバージョンの OS イメージが使用可能になったときに、OS アップグレードをスケール セット インスタンスに自動的に適用するかどうかを示します。 Windows ベースのプールに対してこれが true に設定されている場合、WindowsConfiguration.enableAutomaticUpdates を true に設定することはできません。 |
bool |
osRollingUpgradeDeferral | タスクを実行している場合は、TVM の OS アップグレードを延期します。 | bool |
useRollingUpgradePolicy | 自動 OS アップグレード中にローリング アップグレード ポリシーを使用するかどうかを示します。 VMSS でポリシーが定義されていない場合、OS の自動アップグレードは既定のポリシーにフォールバックします。 | bool |
AutoScaleSettings
名前 | 形容 | 価値 |
---|---|---|
evaluationInterval | 省略した場合、既定値は 15 分 (PT15M) です。 | 糸 |
式 | プール内のコンピューティング ノードの必要な数の数式。 | string (必須) |
AutoUserSpecification
名前 | 形容 | 価値 |
---|---|---|
elevationLevel | 既定値は nonAdmin です。 | 'Admin' 'NonAdmin' |
スコープ | 既定値は Pool です。 プールが Windows を実行している場合は、タスク間のより厳密な分離が必要な場合は、Task の値を指定する必要があります。 たとえば、タスクが他のタスクに影響を与える可能性のある方法でレジストリを変更する場合や、通常のタスクではアクセスできないが、開始タスクからアクセスできる必要がある証明書がプールで指定されている場合などです。 | 'Pool' 'Task' |
AzureBlobFileSystemConfiguration
名前 | 形容 | 価値 |
---|---|---|
accountKey | このプロパティは、sasKey と ID の両方と相互に排他的です。正確に 1 つを指定する必要があります。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
accountName | Azure ストレージ アカウント名。 | string (必須) |
blobfuseOptions | これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。 | 糸 |
containerName | Azure Blob Storage コンテナー名。 | string (必須) |
identityReference | このプロパティは、accountKey と sasKey の両方と相互に排他的です。正確に 1 つを指定する必要があります。 | ComputeNodeIdentityReference |
relativeMountPath | すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。 | string (必須) |
sasKey | このプロパティは accountKey と ID の両方と相互に排他的です。正確に 1 つを指定する必要があります。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
AzureFileShareConfiguration
名前 | 形容 | 価値 |
---|---|---|
accountKey | Azure Storage アカウント キー。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
accountName | Azure Storage アカウント名。 | string (必須) |
azureFileUrl | これは 'https://{account}.file.core.windows.net/' の形式です。 | string (必須) |
mountOptions | これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。 | 糸 |
relativeMountPath | すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。 | string (必須) |
AzureProxyResourceTags
名前 | 形容 | 価値 |
---|
BatchPoolIdentity
名前 | 形容 | 価値 |
---|---|---|
種類 | バッチ プールに使用される ID の種類。 | 'None' 'UserAssigned' (必須) |
userAssignedIdentities | Batch プールに関連付けられているユーザー ID の一覧。 | BatchPoolIdentityUserAssignedIdentities |
BatchPoolIdentityUserAssignedIdentities
名前 | 形容 | 価値 |
---|
CertificateReference
名前 | 形容 | 価値 |
---|---|---|
身分証明書 | プールにインストールする証明書の完全修飾 ID。 これは、プールと同じバッチ アカウント内にある必要があります。 | string (必須) |
storeLocation | 既定値は currentUser です。 このプロパティは、Windows コンピューティング ノードで構成されたプールにのみ適用されます。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。 | 'CurrentUser' 'LocalMachine' |
storeName | このプロパティは、Windows コンピューティング ノードで構成されたプールにのみ適用されます。 一般的なストア名には、My、Root、CA、Trust、Disallowed、TrustedPeople、TrustedPublisher、AuthRoot、AddressBook などがありますが、カスタム ストア名も使用できます。 既定値は My です。 | 糸 |
可視 | 証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。 | 次のいずれかを含む文字列配列: 'RemoteUser' 'StartTask' 'Task' |
CifsMountConfiguration
名前 | 形容 | 価値 |
---|---|---|
mountOptions | これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。 | 糸 |
パスワード | CIFS ファイル システムに対する認証に使用するパスワード。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
relativeMountPath | すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。 | string (必須) |
源 | マウントするファイル システムの URI。 | string (必須) |
userName | CIFS ファイル システムに対する認証に使用するユーザー。 | string (必須) |
ComputeNodeIdentityReference
名前 | 形容 | 価値 |
---|---|---|
resourceId | ユーザー割り当て ID の ARM リソース ID。 | 糸 |
ContainerConfiguration
名前 | 形容 | 価値 |
---|---|---|
containerImageNames | これは、"docker pull" に指定される完全なイメージ参照です。 イメージが代替レジストリで完全修飾されていない限り、イメージは既定の Docker レジストリから取得されます。 | string[] |
containerRegistries | 資格情報を必要とするプライベート レジストリからイメージをダウンロードする必要がある場合は、これらの資格情報をここで指定する必要があります。 | ContainerRegistry[] |
種類 | 使用するコンテナー テクノロジ。 | 'CriCompatible' 'DockerCompatible' (必須) |
ContainerHostBatchBindMountEntry
名前 | 形容 | 価値 |
---|---|---|
isReadOnly | Linux の場合、このパスを読み取り/書き込みモードとしてマウントした場合、コンテナー内のすべてのユーザーがパスの読み取り/書き込みアクセス権を持っているわけではありません。これは、ホスト VM のアクセスに依存します。 このパスが読み取り専用でマウントされている場合、コンテナー内のすべてのユーザーはパスを変更できません。 | bool |
源 | コンテナー タスクのコンテナーにマウントされるパス。 | 'Applications' 'JobPrep' 'Shared' 'Startup' 'Task' 'VfsMounts' |
ContainerRegistry
名前 | 形容 | 価値 |
---|---|---|
identityReference | コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。 | ComputeNodeIdentityReference |
パスワード | レジストリ サーバーにログインするためのパスワード。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
registryServer | 省略した場合、既定値は "docker.io" です。 | 糸 |
username | レジストリ サーバーにログインするユーザー名。 | 糸 |
DataDisk
名前 | 形容 | 価値 |
---|---|---|
キャッシング | 値は次のとおりです。 none - ディスクのキャッシュ モードが有効になっていません。 readOnly - ディスクのキャッシュ モードは読み取り専用です。 readWrite - ディスクのキャッシュ モードは読み取りと書き込みです。 キャッシュの既定値は none です。 キャッシュ オプションの詳細については、「https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/」を参照してください。 |
'None' 'ReadOnly' 'ReadWrite' |
diskSizeGB | 新しいデータ ディスクを作成するときの初期ディスク サイズ (GB)。 | int (必須) |
lun | lun は、各データ ディスクを一意に識別するために使用されます。 複数のディスクを接続する場合は、それぞれ個別の LUN が必要です。 値は、0 ~ 63 の範囲である必要があります。 | int (必須) |
storageAccountType | 省略した場合、既定値は "Standard_LRS" です。 値は次のとおりです。 Standard_LRS - データ ディスクは、標準のローカル冗長ストレージを使用する必要があります。 Premium_LRS - データ ディスクでは、Premium ローカル冗長ストレージを使用する必要があります。 |
'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' |
DeploymentConfiguration
名前 | 形容 | 価値 |
---|---|---|
virtualMachineConfiguration | Azure Virtual Machines インフラストラクチャに基づくプール内のコンピューティング ノードの構成。 | VirtualMachineConfiguration |
DiffDiskSettings
名前 | 形容 | 価値 |
---|---|---|
位置付け | このプロパティは、オペレーティング システムを配置する場所を選択する要求でユーザーが使用できます。たとえば、エフェメラル OS ディスク プロビジョニング用のキャッシュ ディスク領域などです。 エフェメラル OS ディスク サイズの要件の詳細については、「/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements」(/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements) の Windows VM のエフェメラル OS ディスク サイズ要件と Linux VM (/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements) を参照してください。 | 'CacheDisk' |
DiskEncryptionConfiguration
名前 | 形容 | 価値 |
---|---|---|
ターゲット | Linux プールでは、"TemporaryDisk" のみがサポートされています。Windows プールでは、"OsDisk" と "TemporaryDisk" を指定する必要があります。 | 次のいずれかを含む文字列配列: 'OsDisk' 'TemporaryDisk' |
EnvironmentSetting
名前 | 形容 | 価値 |
---|---|---|
名前 | 環境変数の名前。 | string (必須) |
価値 | 環境変数の値。 | 糸 |
FixedScaleSettings
名前 | 形容 | 価値 |
---|---|---|
nodeDeallocationOption | 省略した場合、既定値は Requeue です。 | 'Requeue' 'RetainedData' 'TaskCompletion' 'Terminate' |
resizeTimeout | 既定値は 15 分です。 タイムアウト値は ISO 8601 形式を使用します。 たとえば、PT10M を 10 分間使用します。 最小値は 5 分です。 5 分未満の値を指定した場合、Batch サービスはエラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 | 糸 |
targetDedicatedNodes | targetDedicatedNodes のうち少なくとも 1 つ、targetLowPriorityNodes を設定する必要があります。 | int |
targetLowPriorityNodes | targetDedicatedNodes のうち少なくとも 1 つ、targetLowPriorityNodes を設定する必要があります。 | int |
ImageReference
名前 | 形容 | 価値 |
---|---|---|
communityGalleryImageId | このプロパティは他のプロパティと相互に排他的であり、コミュニティ ギャラリー イメージの GET 呼び出しからフェッチできます。 | 糸 |
身分証明書 | このプロパティは、他のプロパティと相互に排他的です。 Azure コンピューティング ギャラリー イメージには、Azure Batch アカウントと同じリージョンにレプリカが必要です。 Batch サービスと通信するための Batch ノード エージェントのファイアウォール設定については、/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration を参照してください。 | 糸 |
提供 | たとえば、UbuntuServer や WindowsServer などです。 | 糸 |
発行者 | たとえば、Canonical または MicrosoftWindowsServer です。 | 糸 |
sharedGalleryImageId | このプロパティは他のプロパティと相互に排他的であり、共有ギャラリー イメージの GET 呼び出しからフェッチできます。 | 糸 |
sku | たとえば、18.04-LTS や 2022-datacenter などです。 | 糸 |
バージョン | "latest" の値を指定して、イメージの最新バージョンを選択できます。 省略した場合、既定値は 'latest' です。 | 糸 |
InboundNatPool
名前 | 形容 | 価値 |
---|---|---|
backendPort | これは Batch プール内で一意である必要があります。 29876 から 29877 を除き、使用可能な値は 1 から 65535 の間です。これらは予約されています。 予約された値が指定された場合、要求は HTTP 状態コード 400 で失敗します。 | int (必須) |
frontendPortRangeEnd | 指定できる値の範囲は 1 ~ 65534 です。ただし、Batch サービスによって予約されているポートは 50000 ~ 55000 です。 プール内のすべての範囲は個別である必要があり、重複することはできません。 予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。 | int (必須) |
frontendPortRangeStart | 使用可能な値の範囲は 1 ~ 65534 です。ただし、予約されているポートは 50000 ~ 55000 です。 プール内のすべての範囲は個別である必要があり、重複することはできません。 予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。 | int (必須) |
名前 | 名前は Batch プール内で一意である必要があり、文字、数字、アンダースコア、ピリオド、ハイフンを含めることができます。 名前は文字または数字で始まる必要があり、末尾は文字、数字、またはアンダースコアで終わる必要があり、77 文字を超えることはできません。 無効な値が指定された場合、要求は HTTP 状態コード 400 で失敗します。 | string (必須) |
networkSecurityGroupRules | Batch プール上のすべてのエンドポイントで指定できるルールの最大数は 25 です。 ネットワーク セキュリティ グループの規則が指定されていない場合は、指定された backendPort への受信アクセスを許可する既定の規則が作成されます。 ネットワーク セキュリティ グループ規則の最大数を超えた場合、要求は HTTP 状態コード 400 で失敗します。 | NetworkSecurityGroupRule[] |
議定書 | エンドポイントのプロトコル。 | 'TCP' 'UDP' (必須) |
LinuxUserConfiguration
名前 | 形容 | 価値 |
---|---|---|
gid | uid プロパティと gid プロパティは、一緒に指定するか、まったく指定しない必要があります。 指定しない場合、基になるオペレーティング システムは gid を選択します。 | int |
sshPrivateKey | 秘密キーはパスワードで保護しないでください。 この秘密キーは、プールの enableInterNodeCommunication プロパティが true の場合 (enableInterNodeCommunication が false の場合は無視されます)、Linux プール内のノード間で SSH の非対称キー ベースの認証を自動的に構成するために使用されます。 これを行うには、キー ペアをユーザーの .ssh ディレクトリに配置します。 指定しない場合、ノード間でパスワードレス SSH は構成されません (ユーザーの .ssh ディレクトリの変更は行われません)。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
uid | uid プロパティと gid プロパティは、一緒に指定するか、まったく指定しない必要があります。 指定しない場合、基になるオペレーティング システムは uid を選択します。 | int |
ManagedDisk
名前 | 形容 | 価値 |
---|---|---|
securityProfile | マネージド ディスクのセキュリティ プロファイル設定を指定します。 注: 機密 VM にのみ設定でき、機密 VM を使用する場合に必要です。 | VMDiskSecurityProfile を |
storageAccountType | データ ディスクまたは OS ディスクの作成に使用するストレージ アカウントの種類。 | 'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' |
MetadataItem
名前 | 形容 | 価値 |
---|---|---|
名前 | メタデータ項目の名前。 | string (必須) |
価値 | メタデータ項目の値。 | string (必須) |
Microsoft.Batch/batchAccounts/pools
名前 | 形容 | 価値 |
---|---|---|
apiVersion | API のバージョン | '2024-07-01' |
同一性 | バッチ プールに使用される ID の種類。 | BatchPoolIdentity の |
名前 | リソース名 | 糸 制約: 最小長 = 1 最大長 = 1 パターン = ^[a-zA-Z0-9_-]+$ (必須) |
プロパティ | プールに関連付けられているプロパティ。 | PoolProperties |
タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
種類 | リソースの種類 | 'Microsoft.Batch/batchAccounts/pools' |
MountConfiguration
名前 | 形容 | 価値 |
---|---|---|
azureBlobFileSystemConfiguration | このプロパティは、他のすべてのプロパティと相互に排他的です。 | AzureBlobFileSystemConfiguration の |
azureFileShareConfiguration | このプロパティは、他のすべてのプロパティと相互に排他的です。 | AzureFileShareConfiguration |
cifsMountConfiguration | このプロパティは、他のすべてのプロパティと相互に排他的です。 | CifsMountConfiguration の |
nfsMountConfiguration | このプロパティは、他のすべてのプロパティと相互に排他的です。 | NFSMountConfiguration の |
NetworkConfiguration
名前 | 形容 | 価値 |
---|---|---|
dynamicVnetAssignmentScope | 動的 vnet 割り当てのスコープ。 | 'job' 'none' |
enableAcceleratedNetworking | 高速ネットワークにより、VM への単一ルート I/O 仮想化 (SR-IOV) が可能になり、ネットワーク パフォーマンスが向上する可能性があります。 詳細については、/azure/virtual-network/accelerated-networking-overview を参照してください。 | bool |
endpointConfiguration | プールのエンドポイント構成。 | PoolEndpointConfiguration |
publicIPAddressConfiguration | プールのネットワーク構成のパブリック IP アドレス構成。 | PublicIPAddressConfiguration |
subnetId | 仮想ネットワークは、Azure Batch アカウントと同じリージョンとサブスクリプションに存在する必要があります。 指定されたサブネットには、プール内のノード数に対応できる十分な空き IP アドレスが必要です。 サブネットに十分な空き IP アドレスがない場合、プールはコンピューティング ノードを部分的に割り当て、サイズ変更エラーが発生します。 "MicrosoftAzureBatch" サービス プリンシパルには、指定された VNet の "クラシック仮想マシン共同作成者" Role-Based アクセス制御 (RBAC) ロールが必要です。 指定したサブネットでは、コンピューティング ノードでタスクをスケジュールできるように、Azure Batch サービスからの通信を許可する必要があります。 これは、指定された VNet にネットワーク セキュリティ グループ (NSG) が関連付けられているかどうかを確認することで確認できます。 指定したサブネット内のコンピューティング ノードへの通信が NSG によって拒否された場合、Batch サービスはコンピューティング ノードの状態を使用不可に設定します。 指定した VNet にネットワーク セキュリティ グループ (NSG) が関連付けられている場合は、ポート 29876 と 29877 を含む、受信通信用にいくつかの予約済みシステム ポートを有効にする必要があります。 また、ポート 443 で Azure Storage への送信接続を有効にします。 詳細については、/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration を参照してください。 | 糸 |
NetworkSecurityGroupRule
名前 | 形容 | 価値 |
---|---|---|
アクセス | 指定した IP アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。 | 'Allow' 'Deny' (必須) |
優先権 | プール内の優先順位は一意である必要があり、優先順位の順に評価されます。 数値が小さい方が優先度が高くなります。 たとえば、順序番号が 150、250、350 のルールを指定できます。 順序番号が 150 のルールは、順序が 250 のルールよりも優先されます。 許可される優先順位は 150 から 4096 です。 予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。 | int (必須) |
sourceAddressPrefix | 有効な値は、1 つの IP アドレス (10.10.10.10.10)、IP サブネット (つまり 192.168.1.0/24)、既定のタグ、または * (すべてのアドレスの場合) です。 その他の値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。 | string (必須) |
sourcePortRanges | 有効な値は、'*' (すべてのポート 0 から 65535) またはポートまたはポート範囲の配列 (つまり、100 から 200) です。 ポートは 0 ~ 65535 の範囲にする必要があり、ポート範囲またはポートは重複できません。 その他の値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。 既定値は *です。 | string[] |
NFSMountConfiguration
名前 | 形容 | 価値 |
---|---|---|
mountOptions | これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。 | 糸 |
relativeMountPath | すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。 | string (必須) |
源 | マウントするファイル システムの URI。 | string (必須) |
NodePlacementConfiguration
名前 | 形容 | 価値 |
---|---|---|
政策 | ノードをプロビジョニングするために Batch Service によって使用される割り当てポリシー。 指定しない場合、Batch はリージョン ポリシーを使用します。 | 'Regional' 'Zonal' |
OSDisk
名前 | 形容 | 価値 |
---|---|---|
キャッシング | ディスクに対して有効にするキャッシュの種類。 | 'None' 'ReadOnly' 'ReadWrite' |
diskSizeGB | 新しい OS ディスクを作成するときの初期ディスク サイズ (GB)。 | int |
ephemeralOSDiskSettings | 仮想マシンで使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。 | DiffDiskSettings の |
managedDisk | ManagedDisk の |
|
writeAcceleratorEnabled | ディスクで writeAccelerator を有効または無効にするかどうかを指定します。 | bool |
PoolEndpointConfiguration
名前 | 形容 | 価値 |
---|---|---|
inboundNatPools | Batch プールあたりの受信 NAT プールの最大数は 5 です。 受信 NAT プールの最大数を超えた場合、要求は HTTP 状態コード 400 で失敗します。 IPAddressProvisioningType が NoPublicIPAddresses の場合、これは指定できません。 | InboundNatPool[] (必須) |
PoolProperties
名前 | 形容 | 価値 |
---|---|---|
applicationLicenses | アプリケーション ライセンスの一覧は、使用可能な Batch サービス アプリケーション ライセンスのサブセットである必要があります。 サポートされていないライセンスが要求された場合、プールの作成は失敗します。 | string[] |
applicationPackages | アプリケーション パッケージ参照に対する変更は、プールに参加しているすべての新しいコンピューティング ノードに影響しますが、再起動または再イメージ化されるまで、プール内に既に存在するコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のアプリケーション パッケージ参照があります。 | ApplicationPackageReference[] |
証明 書 | Windows コンピューティング ノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。 警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに、Azure KeyVault 拡張機能 を使用してください。 |
CertificateReference[] |
deploymentConfiguration | 展開構成プロパティ。 | DeploymentConfiguration |
displayName | 表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。 | 糸 |
interNodeCommunication | これにより、プールに割り当てることができるノードに制限が適用されます。 この値を有効にすると、要求されたノード数がプールに割り当てられる可能性が低くなります。 指定しない場合、この値の既定値は "Disabled" になります。 | 'Disabled' 'Enabled' |
metadata | Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。 | MetadataItem[] |
mountConfiguration | これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。 | MountConfiguration[] |
networkConfiguration | プールのネットワーク構成。 | NetworkConfiguration |
resourceTags | Azure Batch プールに関連付けるユーザー定義タグ。 これらのタグを指定すると、プールに関連付けられているバッキング Azure リソースにこれらのタグが伝達されます。 このプロパティは、poolAllocationMode プロパティが 'UserSubscription' に設定された Batch アカウントが作成された場合にのみ指定できます。 | PoolPropertiesResourceTags |
scaleSettings | プールの目的のサイズを定義します。 これは、要求された targetDedicatedNodes が指定されている "fixedScale" か、定期的に再評価される数式を定義する 'autoScale' のいずれかです。 このプロパティを指定しない場合、プールは 0 targetDedicatedNodes を使用して固定スケールになります。 | ScaleSettings |
startTask | PATCH (更新) 操作では、このプロパティを空のオブジェクトに設定して、プールから開始タスクを削除できます。 | StartTask の |
targetNodeCommunicationMode | 省略した場合、既定値は Default です。 | 'Classic' 'Default' 'Simplified' |
taskSchedulingPolicy | 指定しない場合、既定値はスプレッドです。 | TaskSchedulingPolicy |
taskSlotsPerNode | 既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。 | int |
upgradePolicy | アップグレード ポリシー (自動、手動、またはローリング) について説明します。 | UpgradePolicy |
userAccounts | プール内の各ノードに作成するユーザー アカウントの一覧。 | UserAccount[] |
vmSize | 使用可能な VM サイズの詳細については、「仮想マシンのサイズ (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/)」または「仮想マシンのサイズ (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/)」を参照してください。 Batch では、STANDARD_A0と Premium Storage (STANDARD_GS、STANDARD_DS、STANDARD_DSV2 シリーズ) を除くすべての Azure VM サイズがサポートされます。 | 糸 |
PoolPropertiesResourceTags
名前 | 形容 | 価値 |
---|
PublicIPAddressConfiguration
名前 | 形容 | 価値 |
---|---|---|
ipAddressIds | ここで指定する IP の数によって、プールの最大サイズが制限されます。パブリック IP ごとに 100 個の専用ノードまたは 100 個のスポット/低優先度ノードを割り当て可能です。 たとえば、250 個の専用 VM を必要とするプールには、少なくとも 3 つのパブリック IP が指定されている必要があります。 このコレクションの各要素は、/subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip} の形式です。 | string[] |
支給 | 既定値は BatchManaged です | 'BatchManaged' 'NoPublicIPAddresses' 'UserManaged' |
ResourceFile
名前 | 形容 | 価値 |
---|---|---|
autoStorageContainerName | autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。 | 糸 |
blobPrefix | このプロパティは、autoStorageContainerName または storageContainerUrl が使用されている場合にのみ有効です。 このプレフィックスには、部分的なファイル名またはサブディレクトリを指定できます。 プレフィックスが指定されていない場合は、コンテナー内のすべてのファイルがダウンロードされます。 | 糸 |
fileMode | このプロパティは、Linux コンピューティング ノードにダウンロードされるファイルにのみ適用されます。 これは、Windows ノードにダウンロードされる resourceFile に対して指定されている場合は無視されます。 Linux ノードにこのプロパティが指定されていない場合は、既定値の 0770 がファイルに適用されます。 | 糸 |
filePath | httpUrl プロパティが指定されている場合、filePath は必須であり、ファイルのダウンロード先となるパス (ファイル名を含む) を記述します。 それ以外の場合、autoStorageContainerName または storageContainerUrl プロパティが指定されている場合、filePath は省略可能であり、ファイルをダウンロードするディレクトリです。 filePath がディレクトリとして使用されている場合、入力データに既に関連付けられているディレクトリ構造は完全に保持され、指定された filePath ディレクトリに追加されます。 指定した相対パスは、タスクの作業ディレクトリから抜け出すことはできません (たとえば、'..' を使用)。 | 糸 |
httpUrl | autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。 URL が Azure Blob Storage を指している場合は、コンピューティング ノードから読み取ることができる必要があります。 Azure Storage 内の BLOB のこのような URL を取得するには、3 つの方法があります。BLOB に対する読み取りアクセス許可を付与する Shared Access Signature (SAS) を含めるか、読み取りアクセス許可を持つマネージド ID を使用するか、BLOB またはそのコンテナーの ACL を設定してパブリック アクセスを許可します。 | 糸 |
identityReference | コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。 | ComputeNodeIdentityReference |
storageContainerUrl | autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。 この URL は、コンピューティング ノードから読み取り可能でリスト可能である必要があります。 Azure Storage 内のコンテナーのこのような URL を取得するには、3 つの方法があります。コンテナーに対する読み取りと一覧表示のアクセス許可を付与する Shared Access Signature (SAS) を含めるか、読み取りとリストのアクセス許可を持つマネージド ID を使用するか、コンテナーの ACL を設定してパブリック アクセスを許可します。 | 糸 |
RollingUpgradePolicy
名前 | 形容 | 価値 |
---|---|---|
enableCrossZoneUpgrade | アップグレード バッチを構築するときに、VMSS が AZ 境界を無視できるようにします。 バッチ サイズを決定するには、更新ドメインと maxBatchInstancePercent を考慮してください。 このフィールドが設定されていない場合、Azure Azure Batch では既定値は設定されません。 作成された VirtualMachineScaleSet の enableCrossZoneUpgrade の値は、VirtualMachineScaleSet の既定の構成によって決定されます。 このフィールドは、NodePlacementConfiguration をゾーンとして使用する場合にのみ true または false に設定できます。 | bool |
maxBatchInstancePercent | 1 回のバッチでのローリング アップグレードによって同時にアップグレードされる仮想マシン インスタンスの合計数に対する最大割合。 これは最大であるため、以前または将来のバッチの異常なインスタンスでは、信頼性を高めるためにバッチ内のインスタンスの割合が減少する可能性があります。 このフィールドの値は、5 ~ 100 の範囲にする必要があります。 maxBatchInstancePercent と maxUnhealthyInstancePercent の両方に値が割り当てられている場合、maxBatchInstancePercent の値は maxUnhealthyInstancePercent を超えてはなりません。 | int 制約: 最小値 = 5 最大値 = 100 |
maxUnhealthyInstancePercent | アップグレードの結果として、またはローリング アップグレードが中止される前に仮想マシンの正常性チェックによって異常な状態で検出された場合に、同時に異常になる可能性があるスケール セット内の仮想マシン インスタンスの合計数に対する最大割合。 この制約は、バッチを開始する前にチェックされます。 このフィールドの値は、5 ~ 100 の範囲にする必要があります。 maxBatchInstancePercent と maxUnhealthyInstancePercent の両方に値が割り当てられている場合、maxBatchInstancePercent の値は maxUnhealthyInstancePercent を超えてはなりません。 | int 制約: 最小値 = 5 最大値 = 100 |
maxUnhealthyUpgradedInstancePercent | 異常な状態にあると検出できるアップグレードされた仮想マシン インスタンスの最大割合。 このチェックは、各バッチがアップグレードされた後に行われます。 この割合を超えた場合、ローリング アップデートは中止されます。 このフィールドの値は、0 ~ 100 の範囲にする必要があります。 | int 制約: 最小値 = 0 最大値 = 100 |
pauseTimeBetweenBatches | すべての仮想マシンの更新を 1 つのバッチで完了してから次のバッチを開始するまでの待機時間。 期間は ISO 8601 形式で指定する必要があります。 | 糸 |
prioritizeUnhealthyInstances | 正常なインスタンスの前に、スケール セット内のすべての異常なインスタンスをアップグレードします。 | bool |
rollbackFailedInstancesOnPolicyBreach | ローリング アップグレード ポリシーに違反した場合、失敗したインスタンスを以前のモデルにロールバックします。 | bool |
ScaleSettings
名前 | 形容 | 価値 |
---|---|---|
autoScale | このプロパティと fixedScale は相互に排他的であり、プロパティの 1 つを指定する必要があります。 | AutoScaleSettings の |
fixedScale | このプロパティと自動スケールは相互に排他的であり、プロパティの 1 つを指定する必要があります。 | FixedScaleSettings |
SecurityProfile
名前 | 形容 | 価値 |
---|---|---|
encryptionAtHost | このプロパティは、要求のユーザーが仮想マシンまたは仮想マシン スケール セットの Host Encryption を有効または無効にするために使用できます。 これにより、ホスト自体のリソース/一時ディスクを含むすべてのディスクの暗号化が有効になります。 | bool |
securityType | 仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。 | 'confidentialVM' 'trustedLaunch' |
uefiSettings | 仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。 | UefiSettings |
ServiceArtifactReference
名前 | 形容 | 価値 |
---|---|---|
身分証明書 | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} の形式のサービス 成果物参照 ID | string (必須) |
StartTask
名前 | 形容 | 価値 |
---|---|---|
commandLine | コマンド ラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windows では "cmd /c MyCommand" を使用し、Linux では "/bin/sh -c MyCommand" を使用します。 startTask の他のプロパティが指定されている場合は必須です。 | 糸 |
containerSettings | これを指定すると、AZ_BATCH_NODE_ROOT_DIRの下にあるすべてのディレクトリ (ノード上の Azure Batch ディレクトリのルート) がコンテナーに再帰的にマップされ、すべてのタスク環境変数がコンテナーにマップされ、タスク コマンド ラインがコンテナーで実行されます。 | TaskContainerSettings |
environmentSettings | 開始タスクの環境変数設定の一覧。 | EnvironmentSetting[] |
maxTaskRetryCount | 終了コードが 0 以外の場合、Batch サービスはタスクを再試行します。 この値は、再試行回数を特に制御します。 Batch サービスはタスクを 1 回試し、この制限まで再試行できます。 たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (1 回の最初の再試行と 3 回の再試行)。 最大再試行回数が 0 の場合、Batch サービスはタスクを再試行しません。 最大再試行回数が -1 の場合、Batch サービスは制限なくタスクを再試行します。 既定値は 0 です | int |
resourceFiles | コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 | ResourceFile[] |
userIdentity | 省略すると、タスクはタスクに固有の非管理ユーザーとして実行されます。 | UserIdentity の |
waitForSuccess | true で、コンピューティング ノードで開始タスクが失敗した場合、Batch サービスは開始タスクを最大再試行回数 (maxTaskRetryCount) まで再試行します。 すべての再試行の後もタスクが正常に完了していない場合、Batch サービスはコンピューティング ノードを使用不可としてマークし、タスクをスケジュールしません。 この条件は、ノードの状態とスケジュール エラーの詳細を使用して検出できます。 false の場合、Batch サービスは開始タスクの完了を待機しません。 この場合、開始タスクの実行中に、他のタスクがコンピューティング ノードで実行を開始できます。開始タスクが失敗した場合でも、新しいタスクはノードで引き続きスケジュールされます。 既定値は true です。 | bool |
TaskContainerSettings
名前 | 形容 | 価値 |
---|---|---|
containerHostBatchBindMounts | この配列が null または存在しない場合、コンテナー タスクは一時ディスク ドライブ全体を Windows (または Linux では AZ_BATCH_NODE_ROOT_DIR) にマウントします。 この配列が空として設定されている場合、データ パスはコンテナーにマウントされません。 | ContainerHostBatchBindMountEntry[] |
containerRunOptions | これらの追加オプションは、Batch サービスによって制御されるオプションに加えて、"docker create" コマンドの引数として提供されます。 | 糸 |
imageName | これは、"docker pull" に指定される完全なイメージ参照です。 イメージ名の一部としてタグが指定されていない場合、タグ ":latest" が既定として使用されます。 | string (必須) |
記帳 | プールの作成時に既に指定されている場合は、この設定を省略できます。 | ContainerRegistry |
workingDirectory | コンテナー タスクの作業ディレクトリの場所を示すフラグ。 既定値は 'taskWorkingDirectory' です。 | 'ContainerImageDefault' 'TaskWorkingDirectory' |
TaskSchedulingPolicy
名前 | 形容 | 価値 |
---|---|---|
nodeFillType | タスクをコンピューティング ノード間で分散する方法。 | 'Pack' 'Spread' (必須) |
UefiSettings
名前 | 形容 | 価値 |
---|---|---|
secureBootEnabled | 仮想マシンでセキュア ブートを有効にするかどうかを指定します。 | bool |
vTpmEnabled | 仮想マシンで vTPM を有効にするかどうかを指定します。 | bool |
UpgradePolicy
名前 | 形容 | 価値 |
---|---|---|
automaticOSUpgradePolicy | OS の自動アップグレードを実行するために使用される構成パラメーター。 | AutomaticOSUpgradePolicy の |
モード | スケール セット内の仮想マシンへのアップグレード モードを指定します。 使用可能な値は次のとおりです。 手動 - スケール セット内の仮想マシンへの更新プログラムの適用を制御します。 これを行うには、manualUpgrade アクションを使用します。 自動 - スケール セット内のすべての仮想マシンが同時に自動的に更新されます。 ローリング - スケール セットは、必要に応じて一時停止時間の間にバッチで更新を実行します。 |
'automatic' 'manual' 'rolling' (必須) |
rollingUpgradePolicy | ローリング アップグレードの実行中に使用される構成パラメーター。 | RollingUpgradePolicy |
UserAccount
名前 | 形容 | 価値 |
---|---|---|
elevationLevel | nonAdmin - 自動ユーザーは、昇格されたアクセス権を持たない標準ユーザーです。 admin - 自動ユーザーは昇格されたアクセス権を持つユーザーであり、完全な管理者アクセス許可で動作します。 既定値は nonAdmin です。 | 'Admin' 'NonAdmin' |
linuxUserConfiguration | このプロパティは、Windows プールで指定されている場合は無視されます。 指定しない場合、ユーザーは既定のオプションで作成されます。 | LinuxUserConfiguration |
名前 | ユーザー アカウントの名前。 名前には、最大 20 文字までの Unicode 文字を含めることができます。 | string (必須) |
パスワード | ユーザー アカウントのパスワード。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
windowsUserConfiguration | このプロパティは、ユーザーが Windows プール上にある場合にのみ指定できます。 指定されていない場合、Windows プールでは、既定のオプションを使用してユーザーが作成されます。 | WindowsUserConfiguration |
UserAssignedIdentities
名前 | 形容 | 価値 |
---|
UserIdentity
名前 | 形容 | 価値 |
---|---|---|
autoUser | userName プロパティと autoUser プロパティは相互に排他的です。1 つを指定する必要がありますが、両方を指定する必要はありません。 | AutoUserSpecification の |
userName | userName プロパティと autoUser プロパティは相互に排他的です。1 つを指定する必要がありますが、両方を指定する必要はありません。 | 糸 |
VirtualMachineConfiguration
名前 | 形容 | 価値 |
---|---|---|
containerConfiguration | 指定した場合、タスクをコンテナーで実行できるように、プール内の各ノードでセットアップが実行されます。 このプールで実行されるすべての通常のタスクとジョブ マネージャー タスクは containerSettings プロパティを指定する必要があり、他のすべてのタスクで指定できます。 | ContainerConfiguration |
dataDisks | プール内のコンピューティング ノードに空のデータ ディスクが接続されている必要がある場合は、このプロパティを指定する必要があります。 | DataDisk[] |
diskEncryptionConfiguration | 指定した場合、暗号化は、ノードのプロビジョニング中にプール内の各ノードで実行されます。 | DiskEncryptionConfiguration |
拡張 機能 | 指定した場合、この構成に記載されている拡張機能が各ノードにインストールされます。 | VMExtension[] |
imageReference | カスタム仮想マシンの Azure Virtual Machines Marketplace イメージまたは Azure Image リソースへの参照。 Azure Batch によって検証されたすべての imageReferences の一覧を取得するには、「サポートされているノード エージェント SKU の一覧表示」操作を参照してください。 | ImageReference (必須) |
licenseType | これは、Windows オペレーティング システムを含むイメージにのみ適用され、展開されるノードの有効なオンプレミス ライセンスを保持している場合にのみ使用する必要があります。 省略した場合、オンプレミスのライセンス割引は適用されません。 値は次のとおりです。 Windows_Server - オンプレミスライセンスは Windows Server 用です。 Windows_Client - オンプレミス ライセンスは Windows クライアント用です。 |
糸 |
nodeAgentSkuId | Batch ノード エージェントは、プール内の各ノードで実行されるプログラムであり、ノードと Batch サービスの間のコマンドおよび制御インターフェイスを提供します。 オペレーティング システムごとに、SKU と呼ばれるノード エージェントのさまざまな実装があります。 選択したイメージ参照に一致するノード エージェント SKU を指定する必要があります。 サポートされているノード エージェント SKU の一覧と検証済みイメージ参照の一覧を取得するには、「サポートされているノード エージェント SKU の一覧表示」操作を参照してください。 | string (必須) |
nodePlacementConfiguration | この構成では、プール内のノードを物理的に割り当てる方法に関する規則を指定します。 | NodePlacementConfiguration |
osDisk | エフェメラル OSDisk 設定の構成が含まれています。 | OSDisk |
securityProfile | 仮想マシンまたは仮想マシン スケール セットのセキュリティ プロファイル設定を指定します。 | SecurityProfile の |
serviceArtifactReference | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} の形式のサービス 成果物参照 ID | ServiceArtifactReference |
windowsConfiguration | imageReference で Linux OS イメージが指定されている場合は、このプロパティを指定しないでください。 | WindowsConfiguration |
VMDiskSecurityProfile
名前 | 形容 | 価値 |
---|---|---|
securityEncryptionType | マネージド ディスクの EncryptionType を指定します。 VMGuestState BLOB のみを暗号化する場合は VMGuestStateOnly に、VMGuestState BLOB にファームウェアの状態を保持しない場合は NonPersistedTPM に設定されます。 注: 機密 VM にのみ設定でき、機密 VM を使用する場合は必須です。 | 'NonPersistedTPM' 'VMGuestStateOnly' |
VMExtension
名前 | 形容 | 価値 |
---|---|---|
autoUpgradeMinorVersion | 展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能はマイナー バージョンをアップグレードしません。 | bool |
enableAutomaticUpgrade | 使用可能な拡張機能の新しいバージョンがある場合に、拡張機能をプラットフォームによって自動的にアップグレードするかどうかを示します。 | bool |
名前 | 仮想マシン拡張機能の名前。 | string (必須) |
protectedSettings | 拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。 | 任意 |
provisionAfterExtensions | この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。 | string[] |
発行者 | 拡張ハンドラーの発行元の名前。 | string (必須) |
設定 | 拡張機能の JSON 形式のパブリック設定。 | 任意 |
種類 | 拡張機能の種類。 | string (必須) |
typeHandlerVersion | スクリプト ハンドラーのバージョン。 | 糸 |
WindowsConfiguration
名前 | 形容 | 価値 |
---|---|---|
enableAutomaticUpdates | 省略した場合、既定値は true です。 | bool |
WindowsUserConfiguration
名前 | 形容 | 価値 |
---|---|---|
loginMode | ユーザーのログイン モードを指定します。 既定値は Interactive です。 | 'Batch' 'Interactive' |
クイック スタート テンプレート
次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。
テンプレート | 形容 |
---|---|
パブリック IP アドレスを せずに Azure Batch プールを Azure |
このテンプレートでは、パブリック IP アドレスのない Azure Batch の簡略化されたノード通信プールが作成されます。 |
Terraform (AzAPI プロバイダー) リソース定義
batchAccounts/pools リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループの
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.Batch/batchAccounts/pools リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Batch/batchAccounts/pools@2024-07-01"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
applicationLicenses = [
"string"
]
applicationPackages = [
{
id = "string"
version = "string"
}
]
certificates = [
{
id = "string"
storeLocation = "string"
storeName = "string"
visibility = [
"string"
]
}
]
deploymentConfiguration = {
virtualMachineConfiguration = {
containerConfiguration = {
containerImageNames = [
"string"
]
containerRegistries = [
{
identityReference = {
resourceId = "string"
}
password = "string"
registryServer = "string"
username = "string"
}
]
type = "string"
}
dataDisks = [
{
caching = "string"
diskSizeGB = int
lun = int
storageAccountType = "string"
}
]
diskEncryptionConfiguration = {
targets = [
"string"
]
}
extensions = [
{
autoUpgradeMinorVersion = bool
enableAutomaticUpgrade = bool
name = "string"
protectedSettings = ?
provisionAfterExtensions = [
"string"
]
publisher = "string"
settings = ?
type = "string"
typeHandlerVersion = "string"
}
]
imageReference = {
communityGalleryImageId = "string"
id = "string"
offer = "string"
publisher = "string"
sharedGalleryImageId = "string"
sku = "string"
version = "string"
}
licenseType = "string"
nodeAgentSkuId = "string"
nodePlacementConfiguration = {
policy = "string"
}
osDisk = {
caching = "string"
diskSizeGB = int
ephemeralOSDiskSettings = {
placement = "CacheDisk"
}
managedDisk = {
securityProfile = {
securityEncryptionType = "string"
}
storageAccountType = "string"
}
writeAcceleratorEnabled = bool
}
securityProfile = {
encryptionAtHost = bool
securityType = "string"
uefiSettings = {
secureBootEnabled = bool
vTpmEnabled = bool
}
}
serviceArtifactReference = {
id = "string"
}
windowsConfiguration = {
enableAutomaticUpdates = bool
}
}
}
displayName = "string"
interNodeCommunication = "string"
metadata = [
{
name = "string"
value = "string"
}
]
mountConfiguration = [
{
azureBlobFileSystemConfiguration = {
accountKey = "string"
accountName = "string"
blobfuseOptions = "string"
containerName = "string"
identityReference = {
resourceId = "string"
}
relativeMountPath = "string"
sasKey = "string"
}
azureFileShareConfiguration = {
accountKey = "string"
accountName = "string"
azureFileUrl = "string"
mountOptions = "string"
relativeMountPath = "string"
}
cifsMountConfiguration = {
mountOptions = "string"
password = "string"
relativeMountPath = "string"
source = "string"
userName = "string"
}
nfsMountConfiguration = {
mountOptions = "string"
relativeMountPath = "string"
source = "string"
}
}
]
networkConfiguration = {
dynamicVnetAssignmentScope = "string"
enableAcceleratedNetworking = bool
endpointConfiguration = {
inboundNatPools = [
{
backendPort = int
frontendPortRangeEnd = int
frontendPortRangeStart = int
name = "string"
networkSecurityGroupRules = [
{
access = "string"
priority = int
sourceAddressPrefix = "string"
sourcePortRanges = [
"string"
]
}
]
protocol = "string"
}
]
}
publicIPAddressConfiguration = {
ipAddressIds = [
"string"
]
provision = "string"
}
subnetId = "string"
}
resourceTags = {
{customized property} = "string"
}
scaleSettings = {
autoScale = {
evaluationInterval = "string"
formula = "string"
}
fixedScale = {
nodeDeallocationOption = "string"
resizeTimeout = "string"
targetDedicatedNodes = int
targetLowPriorityNodes = int
}
}
startTask = {
commandLine = "string"
containerSettings = {
containerHostBatchBindMounts = [
{
isReadOnly = bool
source = "string"
}
]
containerRunOptions = "string"
imageName = "string"
registry = {
identityReference = {
resourceId = "string"
}
password = "string"
registryServer = "string"
username = "string"
}
workingDirectory = "string"
}
environmentSettings = [
{
name = "string"
value = "string"
}
]
maxTaskRetryCount = int
resourceFiles = [
{
autoStorageContainerName = "string"
blobPrefix = "string"
fileMode = "string"
filePath = "string"
httpUrl = "string"
identityReference = {
resourceId = "string"
}
storageContainerUrl = "string"
}
]
userIdentity = {
autoUser = {
elevationLevel = "string"
scope = "string"
}
userName = "string"
}
waitForSuccess = bool
}
targetNodeCommunicationMode = "string"
taskSchedulingPolicy = {
nodeFillType = "string"
}
taskSlotsPerNode = int
upgradePolicy = {
automaticOSUpgradePolicy = {
disableAutomaticRollback = bool
enableAutomaticOSUpgrade = bool
osRollingUpgradeDeferral = bool
useRollingUpgradePolicy = bool
}
mode = "string"
rollingUpgradePolicy = {
enableCrossZoneUpgrade = bool
maxBatchInstancePercent = int
maxUnhealthyInstancePercent = int
maxUnhealthyUpgradedInstancePercent = int
pauseTimeBetweenBatches = "string"
prioritizeUnhealthyInstances = bool
rollbackFailedInstancesOnPolicyBreach = bool
}
}
userAccounts = [
{
elevationLevel = "string"
linuxUserConfiguration = {
gid = int
sshPrivateKey = "string"
uid = int
}
name = "string"
password = "string"
windowsUserConfiguration = {
loginMode = "string"
}
}
]
vmSize = "string"
}
})
}
プロパティ値
ApplicationPackageReference
名前 | 形容 | 価値 |
---|---|---|
身分証明書 | インストールするアプリケーション パッケージの ID。 これは、プールと同じバッチ アカウント内にある必要があります。 これは、特定のバージョンへの参照でも、存在する場合は既定のバージョンでもかまいません。 | string (必須) |
バージョン | これを省略し、このアプリケーションに既定のバージョンが指定されていない場合、要求はエラー コード InvalidApplicationPackageReferences で失敗します。 REST API を直接呼び出す場合、HTTP 状態コードは 409 です。 | 糸 |
AutomaticOSUpgradePolicy
名前 | 形容 | 価値 |
---|---|---|
disableAutomaticRollback | OS イメージのロールバック機能を無効にする必要があるかどうか。 | bool |
enableAutomaticOSUpgrade | 新しいバージョンの OS イメージが使用可能になったときに、OS アップグレードをスケール セット インスタンスに自動的に適用するかどうかを示します。 Windows ベースのプールに対してこれが true に設定されている場合、WindowsConfiguration.enableAutomaticUpdates を true に設定することはできません。 |
bool |
osRollingUpgradeDeferral | タスクを実行している場合は、TVM の OS アップグレードを延期します。 | bool |
useRollingUpgradePolicy | 自動 OS アップグレード中にローリング アップグレード ポリシーを使用するかどうかを示します。 VMSS でポリシーが定義されていない場合、OS の自動アップグレードは既定のポリシーにフォールバックします。 | bool |
AutoScaleSettings
名前 | 形容 | 価値 |
---|---|---|
evaluationInterval | 省略した場合、既定値は 15 分 (PT15M) です。 | 糸 |
式 | プール内のコンピューティング ノードの必要な数の数式。 | string (必須) |
AutoUserSpecification
名前 | 形容 | 価値 |
---|---|---|
elevationLevel | 既定値は nonAdmin です。 | 'Admin' 'NonAdmin' |
スコープ | 既定値は Pool です。 プールが Windows を実行している場合は、タスク間のより厳密な分離が必要な場合は、Task の値を指定する必要があります。 たとえば、タスクが他のタスクに影響を与える可能性のある方法でレジストリを変更する場合や、通常のタスクではアクセスできないが、開始タスクからアクセスできる必要がある証明書がプールで指定されている場合などです。 | 'Pool' 'Task' |
AzureBlobFileSystemConfiguration
名前 | 形容 | 価値 |
---|---|---|
accountKey | このプロパティは、sasKey と ID の両方と相互に排他的です。正確に 1 つを指定する必要があります。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
accountName | Azure ストレージ アカウント名。 | string (必須) |
blobfuseOptions | これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。 | 糸 |
containerName | Azure Blob Storage コンテナー名。 | string (必須) |
identityReference | このプロパティは、accountKey と sasKey の両方と相互に排他的です。正確に 1 つを指定する必要があります。 | ComputeNodeIdentityReference |
relativeMountPath | すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。 | string (必須) |
sasKey | このプロパティは accountKey と ID の両方と相互に排他的です。正確に 1 つを指定する必要があります。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
AzureFileShareConfiguration
名前 | 形容 | 価値 |
---|---|---|
accountKey | Azure Storage アカウント キー。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
accountName | Azure Storage アカウント名。 | string (必須) |
azureFileUrl | これは 'https://{account}.file.core.windows.net/' の形式です。 | string (必須) |
mountOptions | これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。 | 糸 |
relativeMountPath | すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。 | string (必須) |
AzureProxyResourceTags
名前 | 形容 | 価値 |
---|
BatchPoolIdentity
名前 | 形容 | 価値 |
---|---|---|
種類 | バッチ プールに使用される ID の種類。 | 'None' 'UserAssigned' (必須) |
userAssignedIdentities | Batch プールに関連付けられているユーザー ID の一覧。 | BatchPoolIdentityUserAssignedIdentities |
BatchPoolIdentityUserAssignedIdentities
名前 | 形容 | 価値 |
---|
CertificateReference
名前 | 形容 | 価値 |
---|---|---|
身分証明書 | プールにインストールする証明書の完全修飾 ID。 これは、プールと同じバッチ アカウント内にある必要があります。 | string (必須) |
storeLocation | 既定値は currentUser です。 このプロパティは、Windows コンピューティング ノードで構成されたプールにのみ適用されます。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。 | 'CurrentUser' 'LocalMachine' |
storeName | このプロパティは、Windows コンピューティング ノードで構成されたプールにのみ適用されます。 一般的なストア名には、My、Root、CA、Trust、Disallowed、TrustedPeople、TrustedPublisher、AuthRoot、AddressBook などがありますが、カスタム ストア名も使用できます。 既定値は My です。 | 糸 |
可視 | 証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。 | 次のいずれかを含む文字列配列: 'RemoteUser' 'StartTask' 'Task' |
CifsMountConfiguration
名前 | 形容 | 価値 |
---|---|---|
mountOptions | これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。 | 糸 |
パスワード | CIFS ファイル システムに対する認証に使用するパスワード。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
relativeMountPath | すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。 | string (必須) |
源 | マウントするファイル システムの URI。 | string (必須) |
userName | CIFS ファイル システムに対する認証に使用するユーザー。 | string (必須) |
ComputeNodeIdentityReference
名前 | 形容 | 価値 |
---|---|---|
resourceId | ユーザー割り当て ID の ARM リソース ID。 | 糸 |
ContainerConfiguration
名前 | 形容 | 価値 |
---|---|---|
containerImageNames | これは、"docker pull" に指定される完全なイメージ参照です。 イメージが代替レジストリで完全修飾されていない限り、イメージは既定の Docker レジストリから取得されます。 | string[] |
containerRegistries | 資格情報を必要とするプライベート レジストリからイメージをダウンロードする必要がある場合は、これらの資格情報をここで指定する必要があります。 | ContainerRegistry[] |
種類 | 使用するコンテナー テクノロジ。 | 'CriCompatible' 'DockerCompatible' (必須) |
ContainerHostBatchBindMountEntry
名前 | 形容 | 価値 |
---|---|---|
isReadOnly | Linux の場合、このパスを読み取り/書き込みモードとしてマウントした場合、コンテナー内のすべてのユーザーがパスの読み取り/書き込みアクセス権を持っているわけではありません。これは、ホスト VM のアクセスに依存します。 このパスが読み取り専用でマウントされている場合、コンテナー内のすべてのユーザーはパスを変更できません。 | bool |
源 | コンテナー タスクのコンテナーにマウントされるパス。 | 'Applications' 'JobPrep' 'Shared' 'Startup' 'Task' 'VfsMounts' |
ContainerRegistry
名前 | 形容 | 価値 |
---|---|---|
identityReference | コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。 | ComputeNodeIdentityReference |
パスワード | レジストリ サーバーにログインするためのパスワード。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
registryServer | 省略した場合、既定値は "docker.io" です。 | 糸 |
username | レジストリ サーバーにログインするユーザー名。 | 糸 |
DataDisk
名前 | 形容 | 価値 |
---|---|---|
キャッシング | 値は次のとおりです。 none - ディスクのキャッシュ モードが有効になっていません。 readOnly - ディスクのキャッシュ モードは読み取り専用です。 readWrite - ディスクのキャッシュ モードは読み取りと書き込みです。 キャッシュの既定値は none です。 キャッシュ オプションの詳細については、「https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/」を参照してください。 |
'None' 'ReadOnly' 'ReadWrite' |
diskSizeGB | 新しいデータ ディスクを作成するときの初期ディスク サイズ (GB)。 | int (必須) |
lun | lun は、各データ ディスクを一意に識別するために使用されます。 複数のディスクを接続する場合は、それぞれ個別の LUN が必要です。 値は、0 ~ 63 の範囲である必要があります。 | int (必須) |
storageAccountType | 省略した場合、既定値は "Standard_LRS" です。 値は次のとおりです。 Standard_LRS - データ ディスクは、標準のローカル冗長ストレージを使用する必要があります。 Premium_LRS - データ ディスクでは、Premium ローカル冗長ストレージを使用する必要があります。 |
'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' |
DeploymentConfiguration
名前 | 形容 | 価値 |
---|---|---|
virtualMachineConfiguration | Azure Virtual Machines インフラストラクチャに基づくプール内のコンピューティング ノードの構成。 | VirtualMachineConfiguration |
DiffDiskSettings
名前 | 形容 | 価値 |
---|---|---|
位置付け | このプロパティは、オペレーティング システムを配置する場所を選択する要求でユーザーが使用できます。たとえば、エフェメラル OS ディスク プロビジョニング用のキャッシュ ディスク領域などです。 エフェメラル OS ディスク サイズの要件の詳細については、「/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements」(/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements) の Windows VM のエフェメラル OS ディスク サイズ要件と Linux VM (/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements) を参照してください。 | 'CacheDisk' |
DiskEncryptionConfiguration
名前 | 形容 | 価値 |
---|---|---|
ターゲット | Linux プールでは、"TemporaryDisk" のみがサポートされています。Windows プールでは、"OsDisk" と "TemporaryDisk" を指定する必要があります。 | 次のいずれかを含む文字列配列: 'OsDisk' 'TemporaryDisk' |
EnvironmentSetting
名前 | 形容 | 価値 |
---|---|---|
名前 | 環境変数の名前。 | string (必須) |
価値 | 環境変数の値。 | 糸 |
FixedScaleSettings
名前 | 形容 | 価値 |
---|---|---|
nodeDeallocationOption | 省略した場合、既定値は Requeue です。 | 'Requeue' 'RetainedData' 'TaskCompletion' 'Terminate' |
resizeTimeout | 既定値は 15 分です。 タイムアウト値は ISO 8601 形式を使用します。 たとえば、PT10M を 10 分間使用します。 最小値は 5 分です。 5 分未満の値を指定した場合、Batch サービスはエラーで要求を拒否します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (無効な要求) です。 | 糸 |
targetDedicatedNodes | targetDedicatedNodes のうち少なくとも 1 つ、targetLowPriorityNodes を設定する必要があります。 | int |
targetLowPriorityNodes | targetDedicatedNodes のうち少なくとも 1 つ、targetLowPriorityNodes を設定する必要があります。 | int |
ImageReference
名前 | 形容 | 価値 |
---|---|---|
communityGalleryImageId | このプロパティは他のプロパティと相互に排他的であり、コミュニティ ギャラリー イメージの GET 呼び出しからフェッチできます。 | 糸 |
身分証明書 | このプロパティは、他のプロパティと相互に排他的です。 Azure コンピューティング ギャラリー イメージには、Azure Batch アカウントと同じリージョンにレプリカが必要です。 Batch サービスと通信するための Batch ノード エージェントのファイアウォール設定については、/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration を参照してください。 | 糸 |
提供 | たとえば、UbuntuServer や WindowsServer などです。 | 糸 |
発行者 | たとえば、Canonical または MicrosoftWindowsServer です。 | 糸 |
sharedGalleryImageId | このプロパティは他のプロパティと相互に排他的であり、共有ギャラリー イメージの GET 呼び出しからフェッチできます。 | 糸 |
sku | たとえば、18.04-LTS や 2022-datacenter などです。 | 糸 |
バージョン | "latest" の値を指定して、イメージの最新バージョンを選択できます。 省略した場合、既定値は 'latest' です。 | 糸 |
InboundNatPool
名前 | 形容 | 価値 |
---|---|---|
backendPort | これは Batch プール内で一意である必要があります。 29876 から 29877 を除き、使用可能な値は 1 から 65535 の間です。これらは予約されています。 予約された値が指定された場合、要求は HTTP 状態コード 400 で失敗します。 | int (必須) |
frontendPortRangeEnd | 指定できる値の範囲は 1 ~ 65534 です。ただし、Batch サービスによって予約されているポートは 50000 ~ 55000 です。 プール内のすべての範囲は個別である必要があり、重複することはできません。 予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。 | int (必須) |
frontendPortRangeStart | 使用可能な値の範囲は 1 ~ 65534 です。ただし、予約されているポートは 50000 ~ 55000 です。 プール内のすべての範囲は個別である必要があり、重複することはできません。 予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。 | int (必須) |
名前 | 名前は Batch プール内で一意である必要があり、文字、数字、アンダースコア、ピリオド、ハイフンを含めることができます。 名前は文字または数字で始まる必要があり、末尾は文字、数字、またはアンダースコアで終わる必要があり、77 文字を超えることはできません。 無効な値が指定された場合、要求は HTTP 状態コード 400 で失敗します。 | string (必須) |
networkSecurityGroupRules | Batch プール上のすべてのエンドポイントで指定できるルールの最大数は 25 です。 ネットワーク セキュリティ グループの規則が指定されていない場合は、指定された backendPort への受信アクセスを許可する既定の規則が作成されます。 ネットワーク セキュリティ グループ規則の最大数を超えた場合、要求は HTTP 状態コード 400 で失敗します。 | NetworkSecurityGroupRule[] |
議定書 | エンドポイントのプロトコル。 | 'TCP' 'UDP' (必須) |
LinuxUserConfiguration
名前 | 形容 | 価値 |
---|---|---|
gid | uid プロパティと gid プロパティは、一緒に指定するか、まったく指定しない必要があります。 指定しない場合、基になるオペレーティング システムは gid を選択します。 | int |
sshPrivateKey | 秘密キーはパスワードで保護しないでください。 この秘密キーは、プールの enableInterNodeCommunication プロパティが true の場合 (enableInterNodeCommunication が false の場合は無視されます)、Linux プール内のノード間で SSH の非対称キー ベースの認証を自動的に構成するために使用されます。 これを行うには、キー ペアをユーザーの .ssh ディレクトリに配置します。 指定しない場合、ノード間でパスワードレス SSH は構成されません (ユーザーの .ssh ディレクトリの変更は行われません)。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
uid | uid プロパティと gid プロパティは、一緒に指定するか、まったく指定しない必要があります。 指定しない場合、基になるオペレーティング システムは uid を選択します。 | int |
ManagedDisk
名前 | 形容 | 価値 |
---|---|---|
securityProfile | マネージド ディスクのセキュリティ プロファイル設定を指定します。 注: 機密 VM にのみ設定でき、機密 VM を使用する場合に必要です。 | VMDiskSecurityProfile を |
storageAccountType | データ ディスクまたは OS ディスクの作成に使用するストレージ アカウントの種類。 | 'Premium_LRS' 'StandardSSD_LRS' 'Standard_LRS' |
MetadataItem
名前 | 形容 | 価値 |
---|---|---|
名前 | メタデータ項目の名前。 | string (必須) |
価値 | メタデータ項目の値。 | string (必須) |
Microsoft.Batch/batchAccounts/pools
名前 | 形容 | 価値 |
---|---|---|
同一性 | バッチ プールに使用される ID の種類。 | BatchPoolIdentity の |
名前 | リソース名 | 糸 制約: 最小長 = 1 最大長 = 1 パターン = ^[a-zA-Z0-9_-]+$ (必須) |
parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: batchAccounts |
プロパティ | プールに関連付けられているプロパティ。 | PoolProperties |
タグ | リソース タグ | タグ名と値のディクショナリ。 |
種類 | リソースの種類 | "Microsoft.Batch/batchAccounts/pools@2024-07-01" |
MountConfiguration
名前 | 形容 | 価値 |
---|---|---|
azureBlobFileSystemConfiguration | このプロパティは、他のすべてのプロパティと相互に排他的です。 | AzureBlobFileSystemConfiguration の |
azureFileShareConfiguration | このプロパティは、他のすべてのプロパティと相互に排他的です。 | AzureFileShareConfiguration |
cifsMountConfiguration | このプロパティは、他のすべてのプロパティと相互に排他的です。 | CifsMountConfiguration の |
nfsMountConfiguration | このプロパティは、他のすべてのプロパティと相互に排他的です。 | NFSMountConfiguration の |
NetworkConfiguration
名前 | 形容 | 価値 |
---|---|---|
dynamicVnetAssignmentScope | 動的 vnet 割り当てのスコープ。 | 'job' 'none' |
enableAcceleratedNetworking | 高速ネットワークにより、VM への単一ルート I/O 仮想化 (SR-IOV) が可能になり、ネットワーク パフォーマンスが向上する可能性があります。 詳細については、/azure/virtual-network/accelerated-networking-overview を参照してください。 | bool |
endpointConfiguration | プールのエンドポイント構成。 | PoolEndpointConfiguration |
publicIPAddressConfiguration | プールのネットワーク構成のパブリック IP アドレス構成。 | PublicIPAddressConfiguration |
subnetId | 仮想ネットワークは、Azure Batch アカウントと同じリージョンとサブスクリプションに存在する必要があります。 指定されたサブネットには、プール内のノード数に対応できる十分な空き IP アドレスが必要です。 サブネットに十分な空き IP アドレスがない場合、プールはコンピューティング ノードを部分的に割り当て、サイズ変更エラーが発生します。 "MicrosoftAzureBatch" サービス プリンシパルには、指定された VNet の "クラシック仮想マシン共同作成者" Role-Based アクセス制御 (RBAC) ロールが必要です。 指定したサブネットでは、コンピューティング ノードでタスクをスケジュールできるように、Azure Batch サービスからの通信を許可する必要があります。 これは、指定された VNet にネットワーク セキュリティ グループ (NSG) が関連付けられているかどうかを確認することで確認できます。 指定したサブネット内のコンピューティング ノードへの通信が NSG によって拒否された場合、Batch サービスはコンピューティング ノードの状態を使用不可に設定します。 指定した VNet にネットワーク セキュリティ グループ (NSG) が関連付けられている場合は、ポート 29876 と 29877 を含む、受信通信用にいくつかの予約済みシステム ポートを有効にする必要があります。 また、ポート 443 で Azure Storage への送信接続を有効にします。 詳細については、/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration を参照してください。 | 糸 |
NetworkSecurityGroupRule
名前 | 形容 | 価値 |
---|---|---|
アクセス | 指定した IP アドレス、サブネット範囲、またはタグに対して実行する必要があるアクション。 | 'Allow' 'Deny' (必須) |
優先権 | プール内の優先順位は一意である必要があり、優先順位の順に評価されます。 数値が小さい方が優先度が高くなります。 たとえば、順序番号が 150、250、350 のルールを指定できます。 順序番号が 150 のルールは、順序が 250 のルールよりも優先されます。 許可される優先順位は 150 から 4096 です。 予約された値または重複する値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。 | int (必須) |
sourceAddressPrefix | 有効な値は、1 つの IP アドレス (10.10.10.10.10)、IP サブネット (つまり 192.168.1.0/24)、既定のタグ、または * (すべてのアドレスの場合) です。 その他の値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。 | string (必須) |
sourcePortRanges | 有効な値は、'*' (すべてのポート 0 から 65535) またはポートまたはポート範囲の配列 (つまり、100 から 200) です。 ポートは 0 ~ 65535 の範囲にする必要があり、ポート範囲またはポートは重複できません。 その他の値が指定されている場合、要求は HTTP 状態コード 400 で失敗します。 既定値は *です。 | string[] |
NFSMountConfiguration
名前 | 形容 | 価値 |
---|---|---|
mountOptions | これらは、Windows の "net use" オプションと Linux の "マウント" オプションです。 | 糸 |
relativeMountPath | すべてのファイル システムは、AZ_BATCH_NODE_MOUNTS_DIR環境変数を介してアクセスできる Batch マウント ディレクトリに対して相対的にマウントされます。 | string (必須) |
源 | マウントするファイル システムの URI。 | string (必須) |
NodePlacementConfiguration
名前 | 形容 | 価値 |
---|---|---|
政策 | ノードをプロビジョニングするために Batch Service によって使用される割り当てポリシー。 指定しない場合、Batch はリージョン ポリシーを使用します。 | 'Regional' 'Zonal' |
OSDisk
名前 | 形容 | 価値 |
---|---|---|
キャッシング | ディスクに対して有効にするキャッシュの種類。 | 'None' 'ReadOnly' 'ReadWrite' |
diskSizeGB | 新しい OS ディスクを作成するときの初期ディスク サイズ (GB)。 | int |
ephemeralOSDiskSettings | 仮想マシンで使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。 | DiffDiskSettings の |
managedDisk | ManagedDisk の |
|
writeAcceleratorEnabled | ディスクで writeAccelerator を有効または無効にするかどうかを指定します。 | bool |
PoolEndpointConfiguration
名前 | 形容 | 価値 |
---|---|---|
inboundNatPools | Batch プールあたりの受信 NAT プールの最大数は 5 です。 受信 NAT プールの最大数を超えた場合、要求は HTTP 状態コード 400 で失敗します。 IPAddressProvisioningType が NoPublicIPAddresses の場合、これは指定できません。 | InboundNatPool[] (必須) |
PoolProperties
名前 | 形容 | 価値 |
---|---|---|
applicationLicenses | アプリケーション ライセンスの一覧は、使用可能な Batch サービス アプリケーション ライセンスのサブセットである必要があります。 サポートされていないライセンスが要求された場合、プールの作成は失敗します。 | string[] |
applicationPackages | アプリケーション パッケージ参照に対する変更は、プールに参加しているすべての新しいコンピューティング ノードに影響しますが、再起動または再イメージ化されるまで、プール内に既に存在するコンピューティング ノードには影響しません。 特定のプールには、最大 10 個のアプリケーション パッケージ参照があります。 | ApplicationPackageReference[] |
証明 書 | Windows コンピューティング ノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。 警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに、Azure KeyVault 拡張機能 を使用してください。 |
CertificateReference[] |
deploymentConfiguration | 展開構成プロパティ。 | DeploymentConfiguration |
displayName | 表示名は一意である必要はありません。最大長 1024 までの Unicode 文字を含めることができます。 | 糸 |
interNodeCommunication | これにより、プールに割り当てることができるノードに制限が適用されます。 この値を有効にすると、要求されたノード数がプールに割り当てられる可能性が低くなります。 指定しない場合、この値の既定値は "Disabled" になります。 | 'Disabled' 'Enabled' |
metadata | Batch サービスは、メタデータに意味を割り当てません。これは、ユーザー コードの使用のみを目的とします。 | MetadataItem[] |
mountConfiguration | これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。 | MountConfiguration[] |
networkConfiguration | プールのネットワーク構成。 | NetworkConfiguration |
resourceTags | Azure Batch プールに関連付けるユーザー定義タグ。 これらのタグを指定すると、プールに関連付けられているバッキング Azure リソースにこれらのタグが伝達されます。 このプロパティは、poolAllocationMode プロパティが 'UserSubscription' に設定された Batch アカウントが作成された場合にのみ指定できます。 | PoolPropertiesResourceTags |
scaleSettings | プールの目的のサイズを定義します。 これは、要求された targetDedicatedNodes が指定されている "fixedScale" か、定期的に再評価される数式を定義する 'autoScale' のいずれかです。 このプロパティを指定しない場合、プールは 0 targetDedicatedNodes を使用して固定スケールになります。 | ScaleSettings |
startTask | PATCH (更新) 操作では、このプロパティを空のオブジェクトに設定して、プールから開始タスクを削除できます。 | StartTask の |
targetNodeCommunicationMode | 省略した場合、既定値は Default です。 | 'Classic' 'Default' 'Simplified' |
taskSchedulingPolicy | 指定しない場合、既定値はスプレッドです。 | TaskSchedulingPolicy |
taskSlotsPerNode | 既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。 | int |
upgradePolicy | アップグレード ポリシー (自動、手動、またはローリング) について説明します。 | UpgradePolicy |
userAccounts | プール内の各ノードに作成するユーザー アカウントの一覧。 | UserAccount[] |
vmSize | 使用可能な VM サイズの詳細については、「仮想マシンのサイズ (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/)」または「仮想マシンのサイズ (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/)」を参照してください。 Batch では、STANDARD_A0と Premium Storage (STANDARD_GS、STANDARD_DS、STANDARD_DSV2 シリーズ) を除くすべての Azure VM サイズがサポートされます。 | 糸 |
PoolPropertiesResourceTags
名前 | 形容 | 価値 |
---|
PublicIPAddressConfiguration
名前 | 形容 | 価値 |
---|---|---|
ipAddressIds | ここで指定する IP の数によって、プールの最大サイズが制限されます。パブリック IP ごとに 100 個の専用ノードまたは 100 個のスポット/低優先度ノードを割り当て可能です。 たとえば、250 個の専用 VM を必要とするプールには、少なくとも 3 つのパブリック IP が指定されている必要があります。 このコレクションの各要素は、/subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip} の形式です。 | string[] |
支給 | 既定値は BatchManaged です | 'BatchManaged' 'NoPublicIPAddresses' 'UserManaged' |
ResourceFile
名前 | 形容 | 価値 |
---|---|---|
autoStorageContainerName | autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。 | 糸 |
blobPrefix | このプロパティは、autoStorageContainerName または storageContainerUrl が使用されている場合にのみ有効です。 このプレフィックスには、部分的なファイル名またはサブディレクトリを指定できます。 プレフィックスが指定されていない場合は、コンテナー内のすべてのファイルがダウンロードされます。 | 糸 |
fileMode | このプロパティは、Linux コンピューティング ノードにダウンロードされるファイルにのみ適用されます。 これは、Windows ノードにダウンロードされる resourceFile に対して指定されている場合は無視されます。 Linux ノードにこのプロパティが指定されていない場合は、既定値の 0770 がファイルに適用されます。 | 糸 |
filePath | httpUrl プロパティが指定されている場合、filePath は必須であり、ファイルのダウンロード先となるパス (ファイル名を含む) を記述します。 それ以外の場合、autoStorageContainerName または storageContainerUrl プロパティが指定されている場合、filePath は省略可能であり、ファイルをダウンロードするディレクトリです。 filePath がディレクトリとして使用されている場合、入力データに既に関連付けられているディレクトリ構造は完全に保持され、指定された filePath ディレクトリに追加されます。 指定した相対パスは、タスクの作業ディレクトリから抜け出すことはできません (たとえば、'..' を使用)。 | 糸 |
httpUrl | autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。 URL が Azure Blob Storage を指している場合は、コンピューティング ノードから読み取ることができる必要があります。 Azure Storage 内の BLOB のこのような URL を取得するには、3 つの方法があります。BLOB に対する読み取りアクセス許可を付与する Shared Access Signature (SAS) を含めるか、読み取りアクセス許可を持つマネージド ID を使用するか、BLOB またはそのコンテナーの ACL を設定してパブリック アクセスを許可します。 | 糸 |
identityReference | コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。 | ComputeNodeIdentityReference |
storageContainerUrl | autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。 この URL は、コンピューティング ノードから読み取り可能でリスト可能である必要があります。 Azure Storage 内のコンテナーのこのような URL を取得するには、3 つの方法があります。コンテナーに対する読み取りと一覧表示のアクセス許可を付与する Shared Access Signature (SAS) を含めるか、読み取りとリストのアクセス許可を持つマネージド ID を使用するか、コンテナーの ACL を設定してパブリック アクセスを許可します。 | 糸 |
RollingUpgradePolicy
名前 | 形容 | 価値 |
---|---|---|
enableCrossZoneUpgrade | アップグレード バッチを構築するときに、VMSS が AZ 境界を無視できるようにします。 バッチ サイズを決定するには、更新ドメインと maxBatchInstancePercent を考慮してください。 このフィールドが設定されていない場合、Azure Azure Batch では既定値は設定されません。 作成された VirtualMachineScaleSet の enableCrossZoneUpgrade の値は、VirtualMachineScaleSet の既定の構成によって決定されます。 このフィールドは、NodePlacementConfiguration をゾーンとして使用する場合にのみ true または false に設定できます。 | bool |
maxBatchInstancePercent | 1 回のバッチでのローリング アップグレードによって同時にアップグレードされる仮想マシン インスタンスの合計数に対する最大割合。 これは最大であるため、以前または将来のバッチの異常なインスタンスでは、信頼性を高めるためにバッチ内のインスタンスの割合が減少する可能性があります。 このフィールドの値は、5 ~ 100 の範囲にする必要があります。 maxBatchInstancePercent と maxUnhealthyInstancePercent の両方に値が割り当てられている場合、maxBatchInstancePercent の値は maxUnhealthyInstancePercent を超えてはなりません。 | int 制約: 最小値 = 5 最大値 = 100 |
maxUnhealthyInstancePercent | アップグレードの結果として、またはローリング アップグレードが中止される前に仮想マシンの正常性チェックによって異常な状態で検出された場合に、同時に異常になる可能性があるスケール セット内の仮想マシン インスタンスの合計数に対する最大割合。 この制約は、バッチを開始する前にチェックされます。 このフィールドの値は、5 ~ 100 の範囲にする必要があります。 maxBatchInstancePercent と maxUnhealthyInstancePercent の両方に値が割り当てられている場合、maxBatchInstancePercent の値は maxUnhealthyInstancePercent を超えてはなりません。 | int 制約: 最小値 = 5 最大値 = 100 |
maxUnhealthyUpgradedInstancePercent | 異常な状態にあると検出できるアップグレードされた仮想マシン インスタンスの最大割合。 このチェックは、各バッチがアップグレードされた後に行われます。 この割合を超えた場合、ローリング アップデートは中止されます。 このフィールドの値は、0 ~ 100 の範囲にする必要があります。 | int 制約: 最小値 = 0 最大値 = 100 |
pauseTimeBetweenBatches | すべての仮想マシンの更新を 1 つのバッチで完了してから次のバッチを開始するまでの待機時間。 期間は ISO 8601 形式で指定する必要があります。 | 糸 |
prioritizeUnhealthyInstances | 正常なインスタンスの前に、スケール セット内のすべての異常なインスタンスをアップグレードします。 | bool |
rollbackFailedInstancesOnPolicyBreach | ローリング アップグレード ポリシーに違反した場合、失敗したインスタンスを以前のモデルにロールバックします。 | bool |
ScaleSettings
名前 | 形容 | 価値 |
---|---|---|
autoScale | このプロパティと fixedScale は相互に排他的であり、プロパティの 1 つを指定する必要があります。 | AutoScaleSettings の |
fixedScale | このプロパティと自動スケールは相互に排他的であり、プロパティの 1 つを指定する必要があります。 | FixedScaleSettings |
SecurityProfile
名前 | 形容 | 価値 |
---|---|---|
encryptionAtHost | このプロパティは、要求のユーザーが仮想マシンまたは仮想マシン スケール セットの Host Encryption を有効または無効にするために使用できます。 これにより、ホスト自体のリソース/一時ディスクを含むすべてのディスクの暗号化が有効になります。 | bool |
securityType | 仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。 | 'confidentialVM' 'trustedLaunch' |
uefiSettings | 仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。 | UefiSettings |
ServiceArtifactReference
名前 | 形容 | 価値 |
---|---|---|
身分証明書 | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} の形式のサービス 成果物参照 ID | string (必須) |
StartTask
名前 | 形容 | 価値 |
---|---|---|
commandLine | コマンド ラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windows では "cmd /c MyCommand" を使用し、Linux では "/bin/sh -c MyCommand" を使用します。 startTask の他のプロパティが指定されている場合は必須です。 | 糸 |
containerSettings | これを指定すると、AZ_BATCH_NODE_ROOT_DIRの下にあるすべてのディレクトリ (ノード上の Azure Batch ディレクトリのルート) がコンテナーに再帰的にマップされ、すべてのタスク環境変数がコンテナーにマップされ、タスク コマンド ラインがコンテナーで実行されます。 | TaskContainerSettings |
environmentSettings | 開始タスクの環境変数設定の一覧。 | EnvironmentSetting[] |
maxTaskRetryCount | 終了コードが 0 以外の場合、Batch サービスはタスクを再試行します。 この値は、再試行回数を特に制御します。 Batch サービスはタスクを 1 回試し、この制限まで再試行できます。 たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (1 回の最初の再試行と 3 回の再試行)。 最大再試行回数が 0 の場合、Batch サービスはタスクを再試行しません。 最大再試行回数が -1 の場合、Batch サービスは制限なくタスクを再試行します。 既定値は 0 です | int |
resourceFiles | コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 | ResourceFile[] |
userIdentity | 省略すると、タスクはタスクに固有の非管理ユーザーとして実行されます。 | UserIdentity の |
waitForSuccess | true で、コンピューティング ノードで開始タスクが失敗した場合、Batch サービスは開始タスクを最大再試行回数 (maxTaskRetryCount) まで再試行します。 すべての再試行の後もタスクが正常に完了していない場合、Batch サービスはコンピューティング ノードを使用不可としてマークし、タスクをスケジュールしません。 この条件は、ノードの状態とスケジュール エラーの詳細を使用して検出できます。 false の場合、Batch サービスは開始タスクの完了を待機しません。 この場合、開始タスクの実行中に、他のタスクがコンピューティング ノードで実行を開始できます。開始タスクが失敗した場合でも、新しいタスクはノードで引き続きスケジュールされます。 既定値は true です。 | bool |
TaskContainerSettings
名前 | 形容 | 価値 |
---|---|---|
containerHostBatchBindMounts | この配列が null または存在しない場合、コンテナー タスクは一時ディスク ドライブ全体を Windows (または Linux では AZ_BATCH_NODE_ROOT_DIR) にマウントします。 この配列が空として設定されている場合、データ パスはコンテナーにマウントされません。 | ContainerHostBatchBindMountEntry[] |
containerRunOptions | これらの追加オプションは、Batch サービスによって制御されるオプションに加えて、"docker create" コマンドの引数として提供されます。 | 糸 |
imageName | これは、"docker pull" に指定される完全なイメージ参照です。 イメージ名の一部としてタグが指定されていない場合、タグ ":latest" が既定として使用されます。 | string (必須) |
記帳 | プールの作成時に既に指定されている場合は、この設定を省略できます。 | ContainerRegistry |
workingDirectory | コンテナー タスクの作業ディレクトリの場所を示すフラグ。 既定値は 'taskWorkingDirectory' です。 | 'ContainerImageDefault' 'TaskWorkingDirectory' |
TaskSchedulingPolicy
名前 | 形容 | 価値 |
---|---|---|
nodeFillType | タスクをコンピューティング ノード間で分散する方法。 | 'Pack' 'Spread' (必須) |
UefiSettings
名前 | 形容 | 価値 |
---|---|---|
secureBootEnabled | 仮想マシンでセキュア ブートを有効にするかどうかを指定します。 | bool |
vTpmEnabled | 仮想マシンで vTPM を有効にするかどうかを指定します。 | bool |
UpgradePolicy
名前 | 形容 | 価値 |
---|---|---|
automaticOSUpgradePolicy | OS の自動アップグレードを実行するために使用される構成パラメーター。 | AutomaticOSUpgradePolicy の |
モード | スケール セット内の仮想マシンへのアップグレード モードを指定します。 使用可能な値は次のとおりです。 手動 - スケール セット内の仮想マシンへの更新プログラムの適用を制御します。 これを行うには、manualUpgrade アクションを使用します。 自動 - スケール セット内のすべての仮想マシンが同時に自動的に更新されます。 ローリング - スケール セットは、必要に応じて一時停止時間の間にバッチで更新を実行します。 |
'automatic' 'manual' 'rolling' (必須) |
rollingUpgradePolicy | ローリング アップグレードの実行中に使用される構成パラメーター。 | RollingUpgradePolicy |
UserAccount
名前 | 形容 | 価値 |
---|---|---|
elevationLevel | nonAdmin - 自動ユーザーは、昇格されたアクセス権を持たない標準ユーザーです。 admin - 自動ユーザーは昇格されたアクセス権を持つユーザーであり、完全な管理者アクセス許可で動作します。 既定値は nonAdmin です。 | 'Admin' 'NonAdmin' |
linuxUserConfiguration | このプロパティは、Windows プールで指定されている場合は無視されます。 指定しない場合、ユーザーは既定のオプションで作成されます。 | LinuxUserConfiguration |
名前 | ユーザー アカウントの名前。 名前には、最大 20 文字までの Unicode 文字を含めることができます。 | string (必須) |
パスワード | ユーザー アカウントのパスワード。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
windowsUserConfiguration | このプロパティは、ユーザーが Windows プール上にある場合にのみ指定できます。 指定されていない場合、Windows プールでは、既定のオプションを使用してユーザーが作成されます。 | WindowsUserConfiguration |
UserAssignedIdentities
名前 | 形容 | 価値 |
---|
UserIdentity
名前 | 形容 | 価値 |
---|---|---|
autoUser | userName プロパティと autoUser プロパティは相互に排他的です。1 つを指定する必要がありますが、両方を指定する必要はありません。 | AutoUserSpecification の |
userName | userName プロパティと autoUser プロパティは相互に排他的です。1 つを指定する必要がありますが、両方を指定する必要はありません。 | 糸 |
VirtualMachineConfiguration
名前 | 形容 | 価値 |
---|---|---|
containerConfiguration | 指定した場合、タスクをコンテナーで実行できるように、プール内の各ノードでセットアップが実行されます。 このプールで実行されるすべての通常のタスクとジョブ マネージャー タスクは containerSettings プロパティを指定する必要があり、他のすべてのタスクで指定できます。 | ContainerConfiguration |
dataDisks | プール内のコンピューティング ノードに空のデータ ディスクが接続されている必要がある場合は、このプロパティを指定する必要があります。 | DataDisk[] |
diskEncryptionConfiguration | 指定した場合、暗号化は、ノードのプロビジョニング中にプール内の各ノードで実行されます。 | DiskEncryptionConfiguration |
拡張 機能 | 指定した場合、この構成に記載されている拡張機能が各ノードにインストールされます。 | VMExtension[] |
imageReference | カスタム仮想マシンの Azure Virtual Machines Marketplace イメージまたは Azure Image リソースへの参照。 Azure Batch によって検証されたすべての imageReferences の一覧を取得するには、「サポートされているノード エージェント SKU の一覧表示」操作を参照してください。 | ImageReference (必須) |
licenseType | これは、Windows オペレーティング システムを含むイメージにのみ適用され、展開されるノードの有効なオンプレミス ライセンスを保持している場合にのみ使用する必要があります。 省略した場合、オンプレミスのライセンス割引は適用されません。 値は次のとおりです。 Windows_Server - オンプレミスライセンスは Windows Server 用です。 Windows_Client - オンプレミス ライセンスは Windows クライアント用です。 |
糸 |
nodeAgentSkuId | Batch ノード エージェントは、プール内の各ノードで実行されるプログラムであり、ノードと Batch サービスの間のコマンドおよび制御インターフェイスを提供します。 オペレーティング システムごとに、SKU と呼ばれるノード エージェントのさまざまな実装があります。 選択したイメージ参照に一致するノード エージェント SKU を指定する必要があります。 サポートされているノード エージェント SKU の一覧と検証済みイメージ参照の一覧を取得するには、「サポートされているノード エージェント SKU の一覧表示」操作を参照してください。 | string (必須) |
nodePlacementConfiguration | この構成では、プール内のノードを物理的に割り当てる方法に関する規則を指定します。 | NodePlacementConfiguration |
osDisk | エフェメラル OSDisk 設定の構成が含まれています。 | OSDisk |
securityProfile | 仮想マシンまたは仮想マシン スケール セットのセキュリティ プロファイル設定を指定します。 | SecurityProfile の |
serviceArtifactReference | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} の形式のサービス 成果物参照 ID | ServiceArtifactReference |
windowsConfiguration | imageReference で Linux OS イメージが指定されている場合は、このプロパティを指定しないでください。 | WindowsConfiguration |
VMDiskSecurityProfile
名前 | 形容 | 価値 |
---|---|---|
securityEncryptionType | マネージド ディスクの EncryptionType を指定します。 VMGuestState BLOB のみを暗号化する場合は VMGuestStateOnly に、VMGuestState BLOB にファームウェアの状態を保持しない場合は NonPersistedTPM に設定されます。 注: 機密 VM にのみ設定でき、機密 VM を使用する場合は必須です。 | 'NonPersistedTPM' 'VMGuestStateOnly' |
VMExtension
名前 | 形容 | 価値 |
---|---|---|
autoUpgradeMinorVersion | 展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能はマイナー バージョンをアップグレードしません。 | bool |
enableAutomaticUpgrade | 使用可能な拡張機能の新しいバージョンがある場合に、拡張機能をプラットフォームによって自動的にアップグレードするかどうかを示します。 | bool |
名前 | 仮想マシン拡張機能の名前。 | string (必須) |
protectedSettings | 拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。 | 任意 |
provisionAfterExtensions | この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。 | string[] |
発行者 | 拡張ハンドラーの発行元の名前。 | string (必須) |
設定 | 拡張機能の JSON 形式のパブリック設定。 | 任意 |
種類 | 拡張機能の種類。 | string (必須) |
typeHandlerVersion | スクリプト ハンドラーのバージョン。 | 糸 |
WindowsConfiguration
名前 | 形容 | 価値 |
---|---|---|
enableAutomaticUpdates | 省略した場合、既定値は true です。 | bool |
WindowsUserConfiguration
名前 | 形容 | 価値 |
---|---|---|
loginMode | ユーザーのログイン モードを指定します。 既定値は Interactive です。 | 'Batch' 'Interactive' |