MetricsListOptionalParams interface
Parâmetros opcionais.
- Extends
Propriedades
aggregation | A lista de tipos de agregação (separados por vírgula) a serem recuperados. |
filter | O $filter é usado para reduzir o conjunto de dados de métrica retornados. Exemplo: a métrica contém metadados A, B e C. – Retornar todas as séries temporais de C em que 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 em que 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 em que A = a1 $filter=A eq 'a1' e B eq '' e C eq ''. Caso especial: quando o nome da dimensão ou o valor da dimensão usa colchetes redondos. Por exemplo: quando o nome da dimensão estiver esmaecido (teste) 1 Em vez de usar $filter= "dim (test) 1 eq '' " use **$filter= "dim %2528test%2529 1 eq '' "** Quando o nome da dimensão estiver escuro (teste) 3 e o valor da dimensão for dim3 (teste) val Em vez de usar $filter= "dim (test) 3 eq 'dim3 (test) val' " use $filter= "dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' " |
interval | O intervalo (ou seja, timegrain) da consulta. |
metricnames | Os nomes das métricas (separadas por vírgula) a serem recuperadas. Caso especial: se um nome de métrica em si tiver uma vírgula, use %2 para indique-o. Por exemplo: 'Metric,Name1' deve ser 'Metric%2Name1' |
metricnamespace | Namespace de métrica para o qual consultar definições de métrica. |
orderby | A agregação a ser usada para classificar os resultados e a direção da classificação. Somente uma ordem pode ser especificada. Exemplos: sum asc. |
result |
Reduz o conjunto de dados coletados. A sintaxe permitida depende da operação. Confira a descrição da operação para obter detalhes. |
timespan | O período de tempo da consulta. É uma cadeia de caracteres com o seguinte formato 'startDateTime_ISO/endDateTime_ISO'. |
top | O número máximo de registros a serem obtidos. Válido somente se $filter for especificado. O valor padrão é 10. |
Propriedades herdadas
abort |
O sinal que pode ser usado para anular solicitações. |
on |
Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes. |
request |
Opções usadas ao criar e enviar solicitações HTTP para essa operação. |
serializer |
Opções para substituir o comportamento de serialização/des serialização. |
tracing |
Opções usadas quando o rastreamento está habilitado. |
Detalhes da propriedade
aggregation
A lista de tipos de agregação (separados por vírgula) a serem recuperados.
aggregation?: string
Valor da propriedade
string
filter
O $filter é usado para reduzir o conjunto de dados de métrica retornados. Exemplo: a métrica contém metadados A, B e C. – Retornar todas as séries temporais de C em que 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 em que 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 em que A = a1 $filter=A eq 'a1' e B eq '' e C eq ''. Caso especial: quando o nome da dimensão ou o valor da dimensão usa colchetes redondos. Por exemplo: quando o nome da dimensão estiver esmaecido (teste) 1 Em vez de usar $filter= "dim (test) 1 eq '' " use **$filter= "dim %2528test%2529 1 eq '' "** Quando o nome da dimensão estiver escuro (teste) 3 e o valor da dimensão for dim3 (teste) val Em vez de usar $filter= "dim (test) 3 eq 'dim3 (test) val' " use $filter= "dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' "
filter?: string
Valor da propriedade
string
interval
O intervalo (ou seja, timegrain) da consulta.
interval?: string
Valor da propriedade
string
metricnames
Os nomes das métricas (separadas por vírgula) a serem recuperadas. Caso especial: se um nome de métrica em si tiver uma vírgula, use %2 para indique-o. Por exemplo: 'Metric,Name1' deve ser 'Metric%2Name1'
metricnames?: string
Valor da propriedade
string
metricnamespace
Namespace de métrica para o qual consultar definições de métrica.
metricnamespace?: string
Valor da propriedade
string
orderby
A agregação a ser usada para classificar os resultados e a direção da classificação. Somente 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. Confira a descrição da operação para obter detalhes.
resultType?: ResultType
Valor da propriedade
timespan
O período de tempo da consulta. É uma cadeia de caracteres com o seguinte formato 'startDateTime_ISO/endDateTime_ISO'.
timespan?: string
Valor da propriedade
string
top
O número máximo de registros a serem obtidos. Válido somente se $filter for especificado. O valor padrão é 10.
top?: number
Valor da propriedade
number
Detalhes das propriedades herdadas
abortSignal
O sinal que pode ser usado para anular solicitações.
abortSignal?: AbortSignalLike
Valor da propriedade
Herdado de coreClient.OperationOptions.abortSignal
onResponse
Uma função a ser chamada sempre 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
Herdado de coreClient.OperationOptions.onResponse
requestOptions
Opções usadas ao criar e enviar solicitações HTTP para essa operação.
requestOptions?: OperationRequestOptions
Valor da propriedade
Herdado de coreClient.OperationOptions.requestOptions
serializerOptions
Opções para substituir o comportamento de serialização/des serialização.
serializerOptions?: SerializerOptions
Valor da propriedade
Herdado de coreClient.OperationOptions.serializerOptions
tracingOptions
Opções usadas quando o rastreamento está habilitado.
tracingOptions?: OperationTracingOptions
Valor da propriedade
Herdado de coreClient.OperationOptions.tracingOptions