SubscriptionScopeMetricsRequestBodyParameters interface
Parametry dotazu lze také zadat v textu a zadání stejného parametru v těle i parametrech dotazu způsobí chybu.
Vlastnosti
| aggregation | Seznam typů agregace (oddělených čárkami) k načtení. |
| auto |
Pokud je tato metrika nastavená na hodnotu true, rozhraní API vrátí výsledek pomocí nejbližšího podporovaného časového rozsahu. Při nastavení na hodnotu false se vrátí chyba pro neplatné parametry časového rozsahu. Výchozí nastavení je „false“. |
| filter |
$filter slouží ke snížení sady vrácených dat metriky. |
| interval | Interval dotazu (tj. timegrain) dotazu ve formátu doby trvání ISO 8601. Výchozí hodnota je PT1M. Zvláštní případ pro hodnotu FULL, která vrací jeden datový bod po celou dobu požadovanou. Příklady: PT15M, PT1H, P1D, FULL |
| metric |
Názvy metrik (oddělené čárkami) pro načtení. |
| metric |
Obor názvů metrik, ve kterém se mají nacházet metriky, které chcete mít. |
| order |
Agregace, která se má použít k řazení výsledků a směru řazení. Lze zadat pouze jednu objednávku. Příklady: sum asc. |
| result |
Snižuje sadu shromážděných dat. Povolená syntaxe závisí na operaci. Podrobnosti najdete v popisu operace. |
| roll |
Názvy dimenzí pro souhrnné výsledky. Pokud například chcete zobrazit jenom hodnoty metrik s filtrem, jako je City eq Seattle nebo City eq Tacoma, ale nechcete zobrazit samostatné hodnoty pro každé město, můžete zadat RollUpBy=City, abyste viděli výsledky pro Seattle a Tacoma, které se shrnují do časových období. |
| timespan | Časový rozsah dotazu. Jedná se o řetězec s následujícím formátem "startDateTime_ISO/endDateTime_ISO". |
| top | Maximální počet záznamů, které se mají načíst. Platné pouze v případě, že je zadán $filter. Výchozí nastavení je 10. |
| validate |
Pokud je nastavená hodnota false, budou neplatné hodnoty parametrů filtru ignorovány. Pokud je hodnota true, vrátí se chyba pro neplatné parametry filtru. Výchozí hodnota je true. |
Podrobnosti vlastnosti
aggregation
Seznam typů agregace (oddělených čárkami) k načtení.
aggregation?: string
Hodnota vlastnosti
string
autoAdjustTimegrain
Pokud je tato metrika nastavená na hodnotu true, rozhraní API vrátí výsledek pomocí nejbližšího podporovaného časového rozsahu. Při nastavení na hodnotu false se vrátí chyba pro neplatné parametry časového rozsahu. Výchozí nastavení je „false“.
autoAdjustTimegrain?: boolean
Hodnota vlastnosti
boolean
filter
$filter slouží ke snížení sady vrácených dat metriky.
Příklad:
Metrika obsahuje metadata A, B a C.
- Vrátí všechny časové řady C, kde A = a1 a B = b1 nebo b2
$filter=A eq 'a1' a B eq 'b1' nebo B eq 'b2' a C eq '*'
- Neplatná varianta:
$filter=A eq 'a1' a B eq 'b1' a C eq '*' nebo B = 'b2'
Je to neplatné, protože logický operátor nemůže oddělit dva různé názvy metadat.
- Vrátí všechny časové řady, kde A = a1, B = b1 a C = c1:
$filter=A eq 'a1' a B eq 'b1' a C eq 'c1'
- Vrátí všechny časové řady, kde A = a1
$filter=A eq 'a1' a B eq '' a C eq ''.
filter?: string
Hodnota vlastnosti
string
interval
Interval dotazu (tj. timegrain) dotazu ve formátu doby trvání ISO 8601. Výchozí hodnota je PT1M. Zvláštní případ pro hodnotu FULL, která vrací jeden datový bod po celou dobu požadovanou. Příklady: PT15M, PT1H, P1D, FULL
interval?: string
Hodnota vlastnosti
string
metricNames
Názvy metrik (oddělené čárkami) pro načtení.
metricNames?: string
Hodnota vlastnosti
string
metricNamespace
Obor názvů metrik, ve kterém se mají nacházet metriky, které chcete mít.
metricNamespace?: string
Hodnota vlastnosti
string
orderBy
Agregace, která se má použít k řazení výsledků a směru řazení. Lze zadat pouze jednu objednávku. Příklady: sum asc.
orderBy?: string
Hodnota vlastnosti
string
resultType
Snižuje sadu shromážděných dat. Povolená syntaxe závisí na operaci. Podrobnosti najdete v popisu operace.
resultType?: string
Hodnota vlastnosti
string
rollUpBy
Názvy dimenzí pro souhrnné výsledky. Pokud například chcete zobrazit jenom hodnoty metrik s filtrem, jako je City eq Seattle nebo City eq Tacoma, ale nechcete zobrazit samostatné hodnoty pro každé město, můžete zadat RollUpBy=City, abyste viděli výsledky pro Seattle a Tacoma, které se shrnují do časových období.
rollUpBy?: string
Hodnota vlastnosti
string
timespan
Časový rozsah dotazu. Jedná se o řetězec s následujícím formátem "startDateTime_ISO/endDateTime_ISO".
timespan?: string
Hodnota vlastnosti
string
top
Maximální počet záznamů, které se mají načíst. Platné pouze v případě, že je zadán $filter. Výchozí nastavení je 10.
top?: number
Hodnota vlastnosti
number
validateDimensions
Pokud je nastavená hodnota false, budou neplatné hodnoty parametrů filtru ignorovány. Pokud je hodnota true, vrátí se chyba pro neplatné parametry filtru. Výchozí hodnota je true.
validateDimensions?: boolean
Hodnota vlastnosti
boolean