ODATADetailLevel Klasse

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Paket:

Microsoft.Azure.Batch v16.2.0

Quelle:

ODATADetailLevel.cs

Steuert die Vom Azure Batch-Dienst angeforderte Detailanzahl beim Auflisten oder Abrufen von Ressourcen mithilfe von OData-Abfrageklauseln.

public class ODATADetailLevel : Microsoft.Azure.Batch.DetailLevel

type ODATADetailLevel = class
    inherit DetailLevel

Public Class ODATADetailLevel
Inherits DetailLevel

Vererbung

Object

DetailLevel

ODATADetailLevel

Beispiele

In diesem Beispiel wird gezeigt, wie Sie einen ODataDetailLevel angeben, der nur aktive CloudPools auflistet und nur die Id- DisplayName und Statistics für jeden Pool abruft (z. B. zur Anzeige in einer Berichtsbenutzeroberfläche).

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

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

Hinweise

Azure Batch unterstützt OData-Abfragen, mit denen der Client eine genauere Kontrolle über die Abfrageleistung erhält, indem er steuert, welche Ressourcen in Listenvorgängen (FilterClause) zurückgegeben werden und welche Eigenschaften der einzelnen Ressourcen in Listen-, Get- oder Aktualisierungsvorgängen (SelectClause und ExpandClause) zurückgegeben werden.

Wenn Sie einen DetailLevel nicht an einen Listen-, Get- oder Aktualisierungsvorgang übergeben, gibt der Batch-Client standardmäßig keinen Filter (alle Datensätze werden zurückgegeben), keine Select-Klausel (alle einfachen Eigenschaften werden zurückgegeben) und keine Erweiterungsklausel (zugeordnete Entitäten werden nicht zurückgegeben). Daher sind zugeordnete Entitätseigenschaften standardmäßig NULL, anstatt wie andere Eigenschaften aufgefüllt zu werden. In der Dokumentation zu einzelnen Klassen finden Sie informationen, welche Eigenschaften als zugeordnete Entitäten gelten und erweitert werden müssen, um aufgefüllt zu werden.

Da die OData-Abfragen direkt an die REST-API übergeben werden, müssen Klauselzeichenfolgen die JSON-Attributnamen aus der REST-API verwenden, die nicht immer mit .NET-Eigenschaftsnamen identisch sind. Beispielsweise entspricht die .NET CloudPool.VirtualMachineSize-Eigenschaft dem vmSize-Attribut in der REST-API. Daher müssen Sie zum Filtern von Poollistenvorgängen nach VM-Größe vmSize anstelle von VirtualMachineSize in Ihre Filterzeichenfolge schreiben. Informationen zum JSON-Attributnamen, der einer .NET-Eigenschaft entspricht, finden Sie in der Dokumentation zur REST-API.

Weitere Informationen zur Verwendung von OData zum effizienten Abfragen des Azure Batch-Diensts finden Sie unter Effiziente Listenabfragen auf MSDN.

Konstruktoren

ODATADetailLevel()	Initialisiert eine neue instance der ODATADetailLevel -Klasse mit leeren Klauseln.
ODATADetailLevel(String, String, String)	Initialisiert eine neue instance der ODATADetailLevel -Klasse mit den angegebenen Klauseln.

Eigenschaften

ExpandClause	Ruft die OData-Erweiterungsklausel ab oder legt sie fest. Wird verwendet, um zugeordnete Entitäten der Standard entität abzurufen.
FilterClause	Ruft die OData-Filterklausel ab oder legt sie fest. Wird verwendet, um einen Listenvorgang auf Elemente zu beschränken, die den angegebenen Kriterien entsprechen.
SelectClause	Ruft die OData-Select-Klausel ab oder legt sie fest. Wird verwendet, um nur bestimmte Eigenschaften anstelle aller Objekteigenschaften abzurufen.