Get-AzBatchPool
指定した Batch アカウントの下にある Batch プールを取得します。
構文
Get-AzBatchPool
[-Filter <String>]
[-MaxCount <Int32>]
[-Select <String>]
[-Expand <String>]
-BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzBatchPool
[[-Id] <String>]
[-Select <String>]
[-Expand <String>]
-BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Get-AzBatchPool コマンドレットは、BatchContext パラメーターで指定された Batch アカウントの下にある Azure Batch プールを取得します。 Id パラメーターを使用して 1 つのプールを取得することも、Filter パラメーターを使用して Open Data Protocol (OData) フィルターに一致するプールを取得することもできます。
例
例 1: ID でプールを取得する
Get-AzBatchPool -Id "MyPool" -BatchContext $Context
AllocationState : Resizing
AllocationStateTransitionTime : 7/25/2015 9:30:28 PM
AutoScaleEnabled : False
AutoScaleFormula :
AutoScaleRun :
CertificateReferences :
CreationTime : 7/25/2015 9:30:28 PM
CurrentDedicated : 0
CurrentOSVersion : *
DisplayName :
ETag : 0x8D29538429CF04C
Id : MyPool
InterComputeNodeCommunicationEnabled : False
LastModified : 7/25/2015 9:30:28 PM
MaxTasksPerComputeNode : 1
Metadata :
OSFamily : 4
ResizeError :
ResizeTimeout : 00:05:00
TaskSchedulingPolicy : Microsoft.Azure.Commands.Batch.Models.PSTaskSchedulingPolicy
StartTask :
State : Active
StateTransitionTime : 7/25/2015 9:30:28 PM
Statistics :
TargetDedicated : 1
TargetOSVersion : *
Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool
VirtualMachineSize : standard_d1_v2
このコマンドは、ID MyPool を持つプールを取得します。
例 2: OData フィルターを使用してすべてのプールを取得する
Get-AzBatchPool -Filter "startswith(id,'My')" -BatchContext $Context
AllocationState : Resizing
AllocationStateTransitionTime : 7/25/2015 9:30:28 PM
AutoScaleEnabled : False
AutoScaleFormula :
AutoScaleRun :
CertificateReferences :
CreationTime : 7/25/2015 9:30:28 PM
CurrentDedicated : 0
CurrentOSVersion : *
DisplayName :
ETag : 0x8D29538429CF04C
Id : MyPool
InterComputeNodeCommunicationEnabled : False
LastModified : 7/25/2015 9:30:28 PM
MaxTasksPerComputeNode : 1
Metadata :
OSFamily : 4
ResizeError :
ResizeTimeout : 00:05:00
TaskSchedulingPolicy : Microsoft.Azure.Commands.Batch.Models.PSTaskSchedulingPolicy
StartTask :
State : Active
StateTransitionTime : 7/25/2015 9:30:28 PM
Statistics :
TargetDedicated : 1
TargetOSVersion : *
Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool
VirtualMachineSize : standard_d1_v2
このコマンドは、 Filter パラメーターを使用して、ID が My で始まるプールを取得します。
パラメーター
-BatchContext
このコマンドレットが Batch サービスとの対話に使用する BatchAccountContext インスタンスを指定します。 Get-AzBatchAccount コマンドレットを使用して BatchAccountContext を取得する場合、Batch サービスと対話するときに Microsoft Entra 認証が使用されます。 代わりに共有キー認証を使用するには、Get-AzBatchAccountKey コマンドレットを使用して、アクセス キーが設定された BatchAccountContext オブジェクトを取得します。 共有キー認証を使用する場合、プライマリ アクセス キーは既定で使用されます。 使用するキーを変更するには、BatchAccountContext.KeyInUse プロパティを設定します。
型: | BatchAccountContext |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
型: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Expand
Open Data Protocol (OData) expand 句を指定します。 取得するメイン エンティティの関連エンティティを取得するには、このパラメーターの値を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Filter
プールのクエリを実行するときに使用する OData フィルター句を指定します。 フィルターを指定しない場合は、 BatchContext パラメーターで指定された Batch アカウントのすべてのプールが返されます。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Id
取得するプールの ID を指定します。 ワイルドカード文字を指定することはできません。
型: | String |
配置: | 0 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-MaxCount
返されるプールの最大数を指定します。 0 以下の値を指定した場合、このコマンドレットでは上限は使用されません。 既定値は 1000 です。
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Select
OData select 句を指定します。 すべてのオブジェクト プロパティではなく、特定のプロパティを取得するには、このパラメーターの値を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |