Compartir a través de

MetricsQueryOptions interface

  • Referencia
Paquete:
@azure/monitor-query

Opciones usadas al consultar métricas.

Extends
OperationOptions

Propiedades

aggregations

Lista de tipos de agregación (separados por comas) que se van a recuperar.
autoAdjustTimegrain

Cuando se establece en true, si esta métrica no admite el intervalo de tiempo pasado, la API devolverá el resultado mediante el intervalo de tiempo admitido más cercano. Cuando se establece en false, se devuelve un error para parámetros de intervalo de tiempo no válidos. El valor predeterminado es "false".
filter

El $filter se usa para reducir el conjunto de datos de métricas devueltos.
Ejemplo:
La métrica contiene los metadatos A, B y C.
- Devuelve todas las series temporales de C donde A = a1 y B = b1 o b2
$filter=A eq 'a1' y B eq 'b1' o B eq 'b2' y C eq '*'
- Variante no válida:
$filter=A eq 'a1' y B eq 'b1' y C eq '*' o B = 'b2'
Esto no es válido porque el operador lógico o no puede separar dos nombres de metadatos diferentes.
- Devuelve todas las series temporales donde A = a1, B = b1 y C = c1:
$filter=A eq 'a1' y B eq 'b1' y C eq 'c1'
- Devuelve todas las series temporales donde A = a1
$filter=A eq 'a1' y B eq '' y C eq ''.
granularity

Intervalo (es decir, timegrain) de la consulta. El asistente de duraciones contiene alias para algunas duraciones comunes de ISO8601. Se trata de un valor de duración ISO8601 con el formato P[n]Y[n]M[n]DT[n]H[n]M[n]S donde P es el designador de duración (para período) colocado al principio de la representación de duración. Y es el designador de año que sigue el valor del número de años. M es el designador de mes que sigue el valor del número de meses. W es el designador de semana que sigue el valor del número de semanas. D es el designador de día que sigue el valor del número de días. T es el designador de hora que precede a los componentes de hora de la representación. H es el designador de hora que sigue el valor del número de horas. M es el designador de minutos que sigue al valor del número de minutos. S es el segundo designador que sigue el valor del número de segundos.
metricNamespace

Espacio de nombres de métrica para el que se van a consultar las definiciones de métricas.
orderBy

Agregación que se va a usar para ordenar los resultados y la dirección de la ordenación. Solo se puede especificar un orden. Ejemplos: suma asc.
resultType

Reduce el conjunto de datos recopilados. La sintaxis permitida depende de la operación. Consulte la descripción de la operación para obtener más información.
rollUpBy

Nombres de dimensión por los que se van a resumir los resultados. Por ejemplo, si solo desea ver valores de métricas con un filtro como "City eq Seattle o City eq Tacoma", pero no desea ver valores independientes para cada ciudad, puede especificar "RollUpBy=City" para ver los resultados de Seattle y Tacoma inscritos en una serie de veces.
timespan

Intervalo de tiempo envolvente para las métricas.
top

Número máximo de registros que se van a recuperar. Válido solo si se especifica $filter. El valor predeterminado es 10.
validateDimensions

Cuando se establece en false, se omitirán los valores de parámetros de filtro no válidos. Cuando se establece en true, se devuelve un error para parámetros de filtro no válidos. El valor predeterminado es true.

Propiedades heredadas

abortSignal

Señal que se puede usar para anular las solicitudes.
onResponse

Una función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.
requestOptions

Opciones usadas al crear y enviar solicitudes HTTP para esta operación.
serializerOptions

Opciones para invalidar el comportamiento de serialización o des serialización.
tracingOptions

Opciones usadas al habilitar el seguimiento.

Detalles de las propiedades

aggregations

Lista de tipos de agregación (separados por comas) que se van a recuperar.

aggregations?: AggregationType[]

Valor de propiedad

AggregationType[]

autoAdjustTimegrain

Cuando se establece en true, si esta métrica no admite el intervalo de tiempo pasado, la API devolverá el resultado mediante el intervalo de tiempo admitido más cercano. Cuando se establece en false, se devuelve un error para parámetros de intervalo de tiempo no válidos. El valor predeterminado es "false".

autoAdjustTimegrain?: boolean

Valor de propiedad

boolean

filter

El $filter se usa para reducir el conjunto de datos de métricas devueltos.
Ejemplo:
La métrica contiene los metadatos A, B y C.
- Devuelve todas las series temporales de C donde A = a1 y B = b1 o b2
$filter=A eq 'a1' y B eq 'b1' o B eq 'b2' y C eq '*'
- Variante no válida:
$filter=A eq 'a1' y B eq 'b1' y C eq '*' o B = 'b2'
Esto no es válido porque el operador lógico o no puede separar dos nombres de metadatos diferentes.
- Devuelve todas las series temporales donde A = a1, B = b1 y C = c1:
$filter=A eq 'a1' y B eq 'b1' y C eq 'c1'
- Devuelve todas las series temporales donde A = a1
$filter=A eq 'a1' y B eq '' y C eq ''.

filter?: string

Valor de propiedad

string

granularity

Intervalo (es decir, timegrain) de la consulta. El asistente de duraciones contiene alias para algunas duraciones comunes de ISO8601. Se trata de un valor de duración ISO8601 con el formato P[n]Y[n]M[n]DT[n]H[n]M[n]S donde P es el designador de duración (para período) colocado al principio de la representación de duración. Y es el designador de año que sigue el valor del número de años. M es el designador de mes que sigue el valor del número de meses. W es el designador de semana que sigue el valor del número de semanas. D es el designador de día que sigue el valor del número de días. T es el designador de hora que precede a los componentes de hora de la representación. H es el designador de hora que sigue el valor del número de horas. M es el designador de minutos que sigue al valor del número de minutos. S es el segundo designador que sigue el valor del número de segundos.

granularity?: string

Valor de propiedad

string

metricNamespace

Espacio de nombres de métrica para el que se van a consultar las definiciones de métricas.

metricNamespace?: string

Valor de propiedad

string

orderBy

Agregación que se va a usar para ordenar los resultados y la dirección de la ordenación. Solo se puede especificar un orden. Ejemplos: suma asc.

orderBy?: string

Valor de propiedad

string

resultType

Reduce el conjunto de datos recopilados. La sintaxis permitida depende de la operación. Consulte la descripción de la operación para obtener más información.

resultType?: ResultType

Valor de propiedad

ResultType

rollUpBy

Nombres de dimensión por los que se van a resumir los resultados. Por ejemplo, si solo desea ver valores de métricas con un filtro como "City eq Seattle o City eq Tacoma", pero no desea ver valores independientes para cada ciudad, puede especificar "RollUpBy=City" para ver los resultados de Seattle y Tacoma inscritos en una serie de veces.

rollUpBy?: string

Valor de propiedad

string

timespan

Intervalo de tiempo envolvente para las métricas.

timespan?: QueryTimeInterval

Valor de propiedad

QueryTimeInterval

top

Número máximo de registros que se van a recuperar. Válido solo si se especifica $filter. El valor predeterminado es 10.

top?: number

Valor de propiedad

number

validateDimensions

Cuando se establece en false, se omitirán los valores de parámetros de filtro no válidos. Cuando se establece en true, se devuelve un error para parámetros de filtro no válidos. El valor predeterminado es true.

validateDimensions?: boolean

Valor de propiedad

boolean

Detalles de las propiedades heredadas

abortSignal

Señal que se puede usar para anular las solicitudes.

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

Heredado de OperationOptions.abortSignal

onResponse

Una función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.

onResponse?: RawResponseCallback

Valor de propiedad

RawResponseCallback

Heredado de OperationOptions.onResponse

requestOptions

Opciones usadas al crear y enviar solicitudes HTTP para esta operación.

requestOptions?: OperationRequestOptions

Valor de propiedad

OperationRequestOptions

Heredado de OperationOptions.requestOptions

serializerOptions

Opciones para invalidar el comportamiento de serialización o des serialización.

serializerOptions?: SerializerOptions

Valor de propiedad

SerializerOptions

Heredado de OperationOptions.serializerOptions

tracingOptions

Opciones usadas al habilitar el seguimiento.

tracingOptions?: OperationTracingOptions

Valor de propiedad

OperationTracingOptions

Heredado de OperationOptions.tracingOptions