New-AzBatchPool
構文
CloudServiceAndTargetDedicated (既定)
New-AzBatchPool
[-Id] <String>
-VirtualMachineSize <String>
-BatchContext <BatchAccountContext>
[-DisplayName <String>]
[-ResizeTimeout <TimeSpan>]
[-TargetDedicatedComputeNodes <Int32>]
[-TargetLowPriorityComputeNodes <Int32>]
[-TaskSlotsPerNode <Int32>]
[-UpgradePolicy <PSUpgradePolicy>]
[-TaskSchedulingPolicy <PSTaskSchedulingPolicy>]
[-ResourceTag <IDictionary>]
[-Metadata <IDictionary>]
[-InterComputeNodeCommunicationEnabled]
[-StartTask <PSStartTask>]
[-CertificateReferences <PSCertificateReference[]>]
[-ApplicationPackageReferences <PSApplicationPackageReference[]>]
[-ApplicationLicenses <System.Collections.Generic.List`1[System.String]>]
[-CloudServiceConfiguration <PSCloudServiceConfiguration>]
[-NetworkConfiguration <PSNetworkConfiguration>]
[-MountConfiguration <PSMountConfiguration[]>]
[-UserAccount <PSUserAccount[]>]
[-CurrentNodeCommunicationMode <NodeCommunicationMode>]
[-TargetNodeCommunicationMode <NodeCommunicationMode>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
VirtualMachineAndTargetDedicated
New-AzBatchPool
[-Id] <String>
-VirtualMachineSize <String>
-BatchContext <BatchAccountContext>
[-DisplayName <String>]
[-ResizeTimeout <TimeSpan>]
[-TargetDedicatedComputeNodes <Int32>]
[-TargetLowPriorityComputeNodes <Int32>]
[-TaskSlotsPerNode <Int32>]
[-UpgradePolicy <PSUpgradePolicy>]
[-TaskSchedulingPolicy <PSTaskSchedulingPolicy>]
[-ResourceTag <IDictionary>]
[-Metadata <IDictionary>]
[-InterComputeNodeCommunicationEnabled]
[-StartTask <PSStartTask>]
[-CertificateReferences <PSCertificateReference[]>]
[-ApplicationPackageReferences <PSApplicationPackageReference[]>]
[-ApplicationLicenses <System.Collections.Generic.List`1[System.String]>]
[-VirtualMachineConfiguration <PSVirtualMachineConfiguration>]
[-NetworkConfiguration <PSNetworkConfiguration>]
[-MountConfiguration <PSMountConfiguration[]>]
[-UserAccount <PSUserAccount[]>]
[-CurrentNodeCommunicationMode <NodeCommunicationMode>]
[-TargetNodeCommunicationMode <NodeCommunicationMode>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CloudServiceAndAutoScale
New-AzBatchPool
[-Id] <String>
-VirtualMachineSize <String>
-BatchContext <BatchAccountContext>
[-DisplayName <String>]
[-AutoScaleEvaluationInterval <TimeSpan>]
[-AutoScaleFormula <String>]
[-TaskSlotsPerNode <Int32>]
[-UpgradePolicy <PSUpgradePolicy>]
[-TaskSchedulingPolicy <PSTaskSchedulingPolicy>]
[-ResourceTag <IDictionary>]
[-Metadata <IDictionary>]
[-InterComputeNodeCommunicationEnabled]
[-StartTask <PSStartTask>]
[-CertificateReferences <PSCertificateReference[]>]
[-ApplicationPackageReferences <PSApplicationPackageReference[]>]
[-ApplicationLicenses <System.Collections.Generic.List`1[System.String]>]
[-CloudServiceConfiguration <PSCloudServiceConfiguration>]
[-NetworkConfiguration <PSNetworkConfiguration>]
[-MountConfiguration <PSMountConfiguration[]>]
[-UserAccount <PSUserAccount[]>]
[-CurrentNodeCommunicationMode <NodeCommunicationMode>]
[-TargetNodeCommunicationMode <NodeCommunicationMode>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
VirtualMachineAndAutoScale
New-AzBatchPool
[-Id] <String>
-VirtualMachineSize <String>
-BatchContext <BatchAccountContext>
[-DisplayName <String>]
[-AutoScaleEvaluationInterval <TimeSpan>]
[-AutoScaleFormula <String>]
[-TaskSlotsPerNode <Int32>]
[-UpgradePolicy <PSUpgradePolicy>]
[-TaskSchedulingPolicy <PSTaskSchedulingPolicy>]
[-ResourceTag <IDictionary>]
[-Metadata <IDictionary>]
[-InterComputeNodeCommunicationEnabled]
[-StartTask <PSStartTask>]
[-CertificateReferences <PSCertificateReference[]>]
[-ApplicationPackageReferences <PSApplicationPackageReference[]>]
[-ApplicationLicenses <System.Collections.Generic.List`1[System.String]>]
[-VirtualMachineConfiguration <PSVirtualMachineConfiguration>]
[-NetworkConfiguration <PSNetworkConfiguration>]
[-MountConfiguration <PSMountConfiguration[]>]
[-UserAccount <PSUserAccount[]>]
[-CurrentNodeCommunicationMode <NodeCommunicationMode>]
[-TargetNodeCommunicationMode <NodeCommunicationMode>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
New-AzBatchPool コマンドレットは、BatchContext パラメーターで指定されたアカウントの下に、Azure Batch サービスにプールを作成します。
例
例 1: CloudServiceConfiguration を使用して TargetDedicated パラメーター セットを使用して新しいプールを作成する
$configuration = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSCloudServiceConfiguration" -ArgumentList @(4,"*")
New-AzBatchPool -Id "MyPool" -VirtualMachineSize "STANDARD_D1_V2" -CloudServiceConfiguration $configuration -TargetDedicatedComputeNodes 3 -BatchContext $Context
プールは、オペレーティング システム バージョンのファミリ 4 STANDARD_D1_V2仮想マシンを使用するように構成されています。
例 2: VirtualMachineConfiguration を使用して TargetDedicated パラメーター セットを使用して新しいプールを作成する
$imageReference = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSImageReference" -ArgumentList @("WindowsServer", "MicrosoftWindowsServer", "2016-Datacenter", "*")
$configuration = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSVirtualMachineConfiguration" -ArgumentList @($imageReference, "batch.node.windows amd64")
New-AzBatchPool -Id "MyPool" -VirtualMachineSize "STANDARD_D1_V2" -VirtualMachineConfiguration $configuration -TargetDedicatedComputeNodes 3 -BatchContext $Context
このコマンドは、TargetDedicated パラメーター セットを使用して、ID MyPool を持つ新しいプールを作成します。
ターゲット割り当ては 3 つのコンピューティング ノードです。
プールは、Windows-2016-Datacenter オペレーティング システム イメージSTANDARD_D1_V2仮想マシンを使用するように構成されています。
例 3: AutoScale パラメーター セットを使用して新しいプールを作成する
$imageReference = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSImageReference" -ArgumentList @("WindowsServer", "MicrosoftWindowsServer", "2016-Datacenter", "*")
$configuration = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSVirtualMachineConfiguration" -ArgumentList @($imageReference, "batch.node.windows amd64")
New-AzBatchPool -Id "AutoScalePool" -VirtualMachineSize "STANDARD_D1_V2" -VirtualMachineConfiguration $configuration -AutoScaleFormula '$TargetDedicated=2;' -BatchContext $Context
このコマンドは、AutoScale パラメーター セットを使用して、ID AutoScalePool を持つ新しいプールを作成します。
プールは、Windows-2016-Datacenter オペレーティング システム イメージSTANDARD_D1_V2仮想マシンを使用するように構成されており、コンピューティング ノードのターゲット数は自動スケール式によって決まります。
例 4: サブネット内にノードを含むプールを作成する
$imageReference = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSImageReference" -ArgumentList @("WindowsServer", "MicrosoftWindowsServer", "2016-Datacenter", "*")
$configuration = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSVirtualMachineConfiguration" -ArgumentList @($imageReference, "batch.node.windows amd64")
$networkConfig = New-Object Microsoft.Azure.Commands.Batch.Models.PSNetworkConfiguration
$networkConfig.SubnetId = "/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}"
New-AzBatchPool -Id "AutoScalePool" -VirtualMachineSize "STANDARD_D1_V2" -VirtualMachineConfiguration $configuration -TargetDedicatedComputeNodes 3 -NetworkConfiguration $networkConfig -BatchContext $Context
例 5: カスタム ユーザー アカウントを使用してプールを作成する
$imageReference = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSImageReference" -ArgumentList @("WindowsServer", "MicrosoftWindowsServer", "2016-Datacenter", "*")
$configuration = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSVirtualMachineConfiguration" -ArgumentList @($imageReference, "batch.node.windows amd64")
$userAccount = New-Object Microsoft.Azure.Commands.Batch.Models.PSUserAccount -ArgumentList @("myaccount", "mypassword")
New-AzBatchPool -Id "AutoScalePool" -VirtualMachineSize "STANDARD_D1_V2" -VirtualMachineConfiguration $configuration -TargetDedicatedComputeNodes 3 -UserAccount $userAccount
パラメーター
-ApplicationLicenses
Batch サービスがプール内の各コンピューティング ノードで使用できるアプリケーション ライセンスの一覧。
パラメーターのプロパティ
型: | List<T>[String]
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
Aliases: | ApplicationLicense |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-ApplicationPackageReferences
New-AzBatchPool コマンドレットは、BatchContext パラメーターで指定されたアカウントの下に、Azure Batch サービスにプールを作成します。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-AutoScaleEvaluationInterval
自動スケールの数式に従ってプール サイズが自動的に調整されるまでの時間を分単位で指定します。
既定値は 15 分で、最小値は 5 分です。
パラメーターのプロパティ
パラメーター セット
CloudServiceAndAutoScale
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
VirtualMachineAndAutoScale
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
プールを自動的にスケーリングするための数式を指定します。
型: | String
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
CloudServiceAndAutoScale
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
VirtualMachineAndAutoScale
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-BatchContext
このコマンドレットが Batch サービスとの対話に使用する BatchAccountContext インスタンスを指定します。
Get-AzBatchAccount コマンドレットを使用して BatchAccountContext を取得する場合、Batch サービスと対話するときに Microsoft Entra 認証が使用されます。 代わりに共有キー認証を使用するには、Get-AzBatchAccountKey コマンドレットを使用して、アクセス キーが設定された BatchAccountContext オブジェクトを取得します。 共有キー認証を使用する場合、プライマリ アクセス キーは既定で使用されます。 使用するキーを変更するには、BatchAccountContext.KeyInUse プロパティを設定します。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | True |
パイプラインからの値: | True |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-CertificateReferences
プールに関連付けられている証明書を指定します。
Batch サービスは、プールの各コンピューティング ノードに参照先の証明書をインストールします。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-CloudServiceConfiguration
Azure クラウド サービス プラットフォームに基づいてプールの構成設定を指定します。
パラメーターのプロパティ
パラメーター セット
CloudServiceAndTargetDedicated
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
CloudServiceAndAutoScale
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-CurrentNodeCommunicationMode
現在のプール通信モード。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
パラメーターのプロパティ
型: | IAzureContextContainer
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-DisplayName
プールの表示名を指定します。
パラメーターのプロパティ
型: | String
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-Id
作成するプールの ID を指定します。
パラメーターのプロパティ
型: | String
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | 0 |
必須: | True |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-InterComputeNodeCommunicationEnabled
このコマンドレットは、専用コンピューティング ノード間の直接通信用にプールを設定することを示します。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
新しいプールに追加するメタデータをキーと値のペアとして指定します。
キーはメタデータ名です。
値はメタデータ値です。
型: | IDictionary
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-MountConfiguration
プール内の各ノードにマウントするファイル システムの一覧。 これにより、Azure Files、NFS、CIFS/SMB、Blobfuse がサポートされます。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-NetworkConfiguration
プールのネットワーク構成。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-ResizeTimeout
コンピューティング ノードをプールに割り当てるタイムアウトを指定します。
パラメーターのプロパティ
パラメーター セット
CloudServiceAndTargetDedicated
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
VirtualMachineAndTargetDedicated
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-ResourceTag
Azure Batch プールに関連付けるユーザー定義タグ。指定すると、これらのタグは、プールに関連付けられているバッキング Azure リソースに伝達されます。このプロパティは、poolAllocationMode プロパティが 'UserSubscription' に設定された Batch アカウントが作成された場合にのみ指定できます。
パラメーターのプロパティ
型: | IDictionary
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-StartTask
プールの開始タスクの指定を指定します。
開始タスクは、コンピューティング ノードがプールに参加するとき、またはコンピューティング ノードが再起動または再イメージ化されるときに実行されます。
パラメーターのプロパティ
型: | PSStartTask
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-TargetDedicatedComputeNodes
プールに割り当てる専用コンピューティング ノードのターゲット数を指定します。
パラメーターのプロパティ
型: | Nullable<T>[Int32]
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
Aliases: | TargetDedicated |
パラメーター セット
CloudServiceAndTargetDedicated
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
VirtualMachineAndTargetDedicated
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-TargetLowPriorityComputeNodes
プールに割り当てる優先順位の低いコンピューティング ノードのターゲット数を指定します。
パラメーターのプロパティ
パラメーター セット
CloudServiceAndTargetDedicated
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
VirtualMachineAndTargetDedicated
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-TargetNodeCommunicationMode
プールの目的のノード通信モード。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-TaskSchedulingPolicy
ComputeNodeFillType などのタスク スケジュール ポリシーを指定します。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-TaskSlotsPerNode
プール内の 1 つのコンピューティング ノードで同時実行タスクを実行するために使用できるタスク スロットの数。
既定値は 1 です。 最大値は、プールの vmSize または 256 のコア数の 4 倍の小さい値です。
パラメーターのプロパティ
型: | Nullable<T>[Int32]
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
Aliases: | MaxTasksPerComputeNode |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-UpgradePolicy
NewBatchPoolCommand.cs内のプールのアップグレード ポリシー。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-UserAccount
プール内の各ノードに作成するユーザー アカウントの一覧。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-VirtualMachineConfiguration
仮想マシン インフラストラクチャ上のプールの構成設定を指定します。
パラメーターのプロパティ
パラメーター セット
VirtualMachineAndTargetDedicated
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
VirtualMachineAndAutoScale
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-VirtualMachineSize
プール内の仮想マシンのサイズを指定します。
仮想マシンのサイズの詳細については、Microsoft Azure サイトの「 Sizes for virtual machines 」を参照してください。
パラメーターのプロパティ
型: | String
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | True |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。
コマンドレットは実行されません。
パラメーターのプロパティ
型: | SwitchParameter
|
規定値: | False |
ワイルドカードのサポート: | False |
DontShow: | False |
Aliases: | ウィスコンシン |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力