ODATADetailLevel Classe

Définition

Espace de noms:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Paquet:

Microsoft.Azure.Batch v16.2.0

Source:

ODATADetailLevel.cs

Contrôle la quantité de détails demandés au service Azure Batch lors de la liste ou de la récupération de ressources, à l’aide de clauses de requête OData.

public class ODATADetailLevel : Microsoft.Azure.Batch.DetailLevel

type ODATADetailLevel = class
    inherit DetailLevel

Public Class ODATADetailLevel
Inherits DetailLevel

Héritage

Object

DetailLevel

ODATADetailLevel

Exemples

Cet exemple montre comment spécifier un ODataDetailLevel qui répertorie uniquement les CloudPools actifs et récupère uniquement les Idet DisplayNameStatistics pour chaque pool (par exemple, pour l’affichage dans une interface utilisateur de création de rapports).

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

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

Remarques

Azure Batch prend en charge les requêtes OData, qui permettent au client d’obtenir un contrôle plus précis sur les performances des requêtes en contrôlant quelles ressources sont retournées dans les opérations de liste (FilterClause), et quelles propriétés de chaque ressource sont retournées dans les opérations List, Get ou Refresh (SelectClause et ExpandClause).

Par défaut, si vous ne passez pas à DetailLevel une opération List, Get ou Refresh, le client Batch ne spécifie aucun filtre (tous les enregistrements sont retournés), aucune clause select (toutes les propriétés simples sont retournées) et aucune clause expand (les entités associées ne sont pas retournées). Par conséquent, par défaut, les propriétés d’entité associées sont null, au lieu d’être remplies comme d’autres propriétés. Reportez-vous à la documentation des classes individuelles pour savoir quelles propriétés sont considérées comme des entités associées et doivent être développées pour être remplies.

Étant donné que les requêtes OData sont transmises directement à l’API REST, les chaînes de clauses doivent utiliser les noms d’attributs JSON de l’API REST, qui ne sont pas toujours les mêmes que les noms de propriétés .NET. Par exemple, la propriété .NET CloudPool.VirtualMachineSize correspond à l’attribut vmSize dans l’API REST ; Par conséquent, pour filtrer les opérations de liste de pool par taille de machine virtuelle, vous devez écrire vmSize plutôt que VirtualMachineSize dans votre chaîne de filtre. Reportez-vous à la documentation de l’API REST pour connaître le nom d’attribut JSON correspondant à une propriété .NET.

Pour plus d’informations sur l’utilisation d’OData pour interroger efficacement le service Azure Batch, consultez Requêtes de liste efficaces sur MSDN.

Constructeurs

ODATADetailLevel()	Initialise une nouvelle instance de la ODATADetailLevel classe avec des clauses vides.
ODATADetailLevel(String, String, String)	Initialise une nouvelle instance de la ODATADetailLevel classe avec les clauses spécifiées.

Propriétés

ExpandClause	Obtient ou définit la clause de développement OData. Utilisé pour récupérer les entités associées de l’entité main en cours de récupération.
FilterClause	Obtient ou définit la clause de filtre OData. Permet de restreindre une opération de liste aux éléments qui correspondent à des critères spécifiés.
SelectClause	Obtient ou définit la clause OData select. Utilisé pour récupérer uniquement des propriétés spécifiques au lieu de toutes les propriétés d’objet.