MetricsQueryOptions interface

Pacote:

@azure/monitor-query

Opções usadas ao consultar métricas.

Estende

OperationOptions

Propriedades

aggregations	A lista de tipos de agregação (separados por vírgula) a serem recuperados.
filter	O $filter é usado para reduzir o conjunto de dados métricos retornados. Exemplo: A métrica contém metadados A, B e C. - Retornar todas as séries temporais de C onde A = a1 e B = b1 ou b2 $filter=A eq 'a1' e B eq 'b1' ou B eq 'b2' e C eq '*' - Variante inválida: $filter=A eq 'a1' e B eq 'b1' e C eq '*' ou B = 'b2' Isso é inválido porque o operador lógico ou não pode separar dois nomes de metadados diferentes. - Retornar todas as séries temporais onde A = a1, B = b1 e C = c1: $filter=A eq «a1» e B eq «b1» e C eq «c1» - Retornar todas as séries temporais onde A = a1 $filter=A eq 'a1' e B eq '' e C eq ''.
granularity	O intervalo (ou seja, timegrain) da consulta. Durações auxiliar contém aliases para algumas durações de ISO8601 comuns. Este é um valor de duração ISO8601 no formato P[n]Y[n]M[n]DT[n]H[n]M[n]S onde P é o designador de duração (para período) colocado no início da representação de duração. Y é o designador de ano que segue o valor para o número de anos. M é o designador de mês que segue o valor para o número de meses. W é o designador de semana que segue o valor para o número de semanas. D é o designador de dia que segue o valor para o número de dias. T é o designador de tempo que precede os componentes de tempo da representação. H é o designador de hora que segue o valor para o número de horas. M é o designador de minutos que segue o valor para o número de minutos. S é o segundo designador que segue o valor para o número de segundos.
metricNamespace	Namespace de métrica para consultar definições de métrica.
orderBy	A agregação a ser usada para classificar resultados e a direção da classificação. Apenas uma ordem pode ser especificada. Exemplos: sum asc.
resultType	Reduz o conjunto de dados coletados. A sintaxe permitida depende da operação. Consulte a descrição da operação para obter detalhes.
timespan	O período de tempo de inclusão para métricas.
top	O número máximo de registros a serem recuperados. Válido apenas se $filter for especificado. O valor padrão é 10.

Propriedades Herdadas

abortSignal	O sinal que pode ser usado para abortar solicitações.
onResponse	Uma função a ser chamada cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.
requestOptions	Opções usadas ao criar e enviar solicitações HTTP para esta operação.
serializerOptions	Opções para substituir o comportamento de serialização/desserialização.
tracingOptions	Opções usadas quando o rastreamento está habilitado.

Detalhes da Propriedade

aggregations

A lista de tipos de agregação (separados por vírgula) a serem recuperados.

aggregations?: AggregationType[]

Valor da Propriedade

AggregationType[]

filter

O $filter é usado para reduzir o conjunto de dados métricos retornados.
Exemplo:
A métrica contém metadados A, B e C.
- Retornar todas as séries temporais de C onde A = a1 e B = b1 ou b2
$filter=A eq 'a1' e B eq 'b1' ou B eq 'b2' e C eq '*'
- Variante inválida:
$filter=A eq 'a1' e B eq 'b1' e C eq '*' ou B = 'b2'
Isso é inválido porque o operador lógico ou não pode separar dois nomes de metadados diferentes.
- Retornar todas as séries temporais onde A = a1, B = b1 e C = c1:
$filter=A eq «a1» e B eq «b1» e C eq «c1»
- Retornar todas as séries temporais onde A = a1
$filter=A eq 'a1' e B eq '' e C eq ''.

filter?: string

Valor da Propriedade

string

granularity

O intervalo (ou seja, timegrain) da consulta. Durações auxiliar contém aliases para algumas durações de ISO8601 comuns. Este é um valor de duração ISO8601 no formato P[n]Y[n]M[n]DT[n]H[n]M[n]S onde P é o designador de duração (para período) colocado no início da representação de duração. Y é o designador de ano que segue o valor para o número de anos. M é o designador de mês que segue o valor para o número de meses. W é o designador de semana que segue o valor para o número de semanas. D é o designador de dia que segue o valor para o número de dias. T é o designador de tempo que precede os componentes de tempo da representação. H é o designador de hora que segue o valor para o número de horas. M é o designador de minutos que segue o valor para o número de minutos. S é o segundo designador que segue o valor para o número de segundos.

granularity?: string

Valor da Propriedade

string

metricNamespace

Namespace de métrica para consultar definições de métrica.

metricNamespace?: string

Valor da Propriedade

string

orderBy

A agregação a ser usada para classificar resultados e a direção da classificação. Apenas uma ordem pode ser especificada. Exemplos: sum asc.

orderBy?: string

Valor da Propriedade

string

resultType

Reduz o conjunto de dados coletados. A sintaxe permitida depende da operação. Consulte a descrição da operação para obter detalhes.

resultType?: ResultType

Valor da Propriedade

ResultType

timespan

O período de tempo de inclusão para métricas.

timespan?: QueryTimeInterval

Valor da Propriedade

QueryTimeInterval

top

O número máximo de registros a serem recuperados. Válido apenas se $filter for especificado. O valor padrão é 10.

top?: number

Valor da Propriedade

number

Detalhes da Propriedade Herdada

abortSignal

O sinal que pode ser usado para abortar solicitações.

abortSignal?: AbortSignalLike

Valor da Propriedade

AbortSignalLike

herdado de OperationOptions.abortSignal

onResponse

Uma função a ser chamada cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.

onResponse?: RawResponseCallback

Valor da Propriedade

RawResponseCallback

herdado de OperationOptions.onResponse

requestOptions

Opções usadas ao criar e enviar solicitações HTTP para esta operação.

requestOptions?: OperationRequestOptions

Valor da Propriedade

OperationRequestOptions

herdado de OperationOptions.requestOptions

serializerOptions

Opções para substituir o comportamento de serialização/desserialização.

serializerOptions?: SerializerOptions

Valor da Propriedade

SerializerOptions

herdado de OperationOptions.serializerOptions

tracingOptions

Opções usadas quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor da Propriedade

OperationTracingOptions

herdado de OperationOptions.tracingOptions