ODATADetailLevel Classe

Definição

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Pacote:

Microsoft.Azure.Batch v16.2.0

Origem:

ODATADetailLevel.cs

Controla a quantidade de detalhes solicitados do serviço Lote do Azure ao listar ou recuperar recursos usando cláusulas de consulta OData.

public class ODATADetailLevel : Microsoft.Azure.Batch.DetailLevel

type ODATADetailLevel = class
    inherit DetailLevel

Public Class ODATADetailLevel
Inherits DetailLevel

Herança

Object

DetailLevel

ODATADetailLevel

Exemplos

Este exemplo mostra como especificar um ODataDetailLevel que lista apenas CloudPools ativos e recupera apenas o Ide DisplayNameStatistics para cada pool (por exemplo, para exibição em uma interface do usuário de relatório).

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

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

Comentários

Lote do Azure dá suporte a consultas OData, que permitem que o cliente obtenha um controle mais fino sobre o desempenho da consulta controlando quais recursos são retornados em Operações de lista (FilterClause) e quais propriedades de cada recurso são retornadas nas operações List, Get ou Refresh (SelectClause e ExpandClause).

Por padrão, se você não passar um para uma DetailLevel operação Listar, Obter ou Atualizar, o cliente do Lote não especificará nenhum filtro (todos os registros são retornados), nenhuma cláusula select (todas as propriedades simples são retornadas) e nenhuma cláusula de expansão (entidades associadas não são retornadas). Consequentemente, por padrão, as propriedades de entidade associadas são nulas, em vez de serem preenchidas como outras propriedades. Consulte a documentação de classe individual para descobrir quais propriedades são consideradas entidades associadas e precisam ser expandidas para serem preenchidas.

Como as consultas OData são passadas diretamente para a API REST, as cadeias de caracteres de cláusula devem usar os nomes de atributo JSON da API REST, que nem sempre são iguais aos nomes de propriedade do .NET. Por exemplo, a propriedade .NET CloudPool.VirtualMachineSize corresponde ao atributo vmSize na API REST; Portanto, para filtrar as operações de uma lista de pools por tamanho de VM, você precisaria gravar vmSize em vez de VirtualMachineSize na cadeia de caracteres de filtro. Consulte a documentação da API REST para descobrir o nome do atributo JSON correspondente a uma propriedade do .NET.

Para obter informações adicionais sobre como usar o OData para consultar com eficiência o serviço Lote do Azure, consulte Consultas de lista eficientes no MSDN.

Construtores

ODATADetailLevel()	Inicializa uma nova instância da ODATADetailLevel classe com cláusulas vazias.
ODATADetailLevel(String, String, String)	Inicializa uma nova instância da ODATADetailLevel classe com as cláusulas especificadas.

Propriedades

ExpandClause	Obtém ou define a cláusula de expansão OData. Usado para recuperar entidades associadas do main entidade que está sendo recuperada.
FilterClause	Obtém ou define a cláusula de filtro OData. Usado para restringir uma operação de lista a itens que correspondem aos critérios especificados.
SelectClause	Obtém ou define a cláusula select OData. Usado para recuperar apenas propriedades específicas em vez de todas as propriedades de objeto.