ODATADetailLevel クラス

定義

名前空間:

Microsoft.Azure.Batch

アセンブリ:

Microsoft.Azure.Batch.dll

パッケージ:

Microsoft.Azure.Batch v16.2.0

ソース:

ODATADetailLevel.cs

OData クエリ句を使用してリソースを一覧表示または取得するときに、Azure Batch サービスから要求される詳細の量を制御します。

public class ODATADetailLevel : Microsoft.Azure.Batch.DetailLevel

type ODATADetailLevel = class
    inherit DetailLevel

Public Class ODATADetailLevel
Inherits DetailLevel

継承

Object

DetailLevel

ODATADetailLevel

例

このサンプルでは、アクティブな CloudPools のみを一覧表示する ODataDetailLevel を指定し、各プールに対して と のみをIdDisplayNameStatistics取得する方法を示します (たとえば、レポート ユーザー インターフェイスに表示する場合)。

var detailLevel = new ODATADetailLevel(
    filterClause: "state eq 'active'",
    selectClause: "id,displayName,stats",
    expandClause: "stats"
);

var pools = batchClient.PoolOperations.ListPools(detailLevel);

注釈

Azure Batchでは OData クエリがサポートされています。これにより、クライアントは List 操作 () で返されるリソースと、List、Get、または Refresh 操作 (FilterClauseSelectClause および ExpandClause) で返される各リソースのプロパティを制御することで、クエリのパフォーマンスを細かく制御できます。

既定では、 を List、Get、または Refresh 操作に渡 DetailLevel さない場合、Batch クライアントはフィルターを指定せず (すべてのレコードが返されます)、select 句 (すべての単純なプロパティが返されます)、展開句 (関連付けられたエンティティは返されません) を指定します。 そのため、既定では、関連付けられているエンティティ プロパティは、他のプロパティと同様に設定されるのではなく、null になります。 関連付けられたエンティティと見なされ、設定するために拡張する必要があるプロパティを確認するには、個々のクラスドキュメントを参照してください。

OData クエリは REST API に直接渡されるため、句文字列では REST API の JSON 属性名を使用する必要があります。これは、必ずしも .NET プロパティ名と同じとは限りません。 たとえば、.NET CloudPool.VirtualMachineSize プロパティは REST API の vmSize 属性に対応します。そのため、プール リスト操作を VM サイズでフィルター処理するには、フィルター文字列に VirtualMachineSize ではなく vmSize を記述する必要があります。 .NET プロパティに対応する JSON 属性名については、REST API のドキュメントを参照してください。

OData を使用してAzure Batch サービスに効率的にクエリを実行する方法の詳細については、MSDN の「効率的なリスト クエリ」を参照してください。

コンストラクター

ODATADetailLevel()	空の句を使用して、 クラスの ODATADetailLevel 新しいインスタンスを初期化します。
ODATADetailLevel(String, String, String)	指定した句を使用して、 クラスの ODATADetailLevel 新しいインスタンスを初期化します。

プロパティ

ExpandClause	OData expand 句を取得または設定します。 取得するメイン エンティティの関連付けられたエンティティを取得するために使用されます。
FilterClause	OData フィルター句を取得または設定します。 リスト操作を、指定した条件に一致するアイテムに制限するために使用します。
SelectClause	OData select 句を取得または設定します。 すべてのオブジェクト プロパティではなく、特定のプロパティのみを取得するために使用されます。