MetricsQueryOptions interface
メトリックのクエリを実行するときに使用されるオプション。
- Extends
プロパティ
| aggregations | 取得する集計の種類 (コンマ区切り) の一覧。 |
| filter |
$filter は、返されるメトリック データのセットを減らすために使用されます。 |
| granularity | クエリの間隔 (つまり timegrain)。 Durations ヘルパーには、一般的なISO8601期間のエイリアスが含まれています。 これは、P[n]Y[n]M[n]DT[n]H[n]M[n]S という形式のISO8601期間の値です。ここで、P は期間表現の先頭に配置された期間指定子 (期間) です。 Y は、年数の値に従う年指定子です。 M は、月数の値に続く月指定子です。 W は週数の値に続く週指定子です。 D は、日数の値に続く日指定子です。 T は、表現の時間成分の前にある時間指定子です。 H は、時間数の値に続く時間指定子です。 M は、分数の値の後に続く分指定子です。 S は、秒数の値に続く 2 番目の指定子です。 |
| metric |
メトリック定義のクエリを実行するメトリック名前空間。 |
| order |
結果の並べ替えに使用する集計と並べ替えの方向。 指定できる注文は 1 つだけです。 例: sum asc。 |
| result |
収集されるデータのセットを減らします。 使用できる構文は、操作によって異なります。 詳細については、操作の説明を参照してください。 |
| timespan | メトリックの外側の期間。 |
| top | 取得するレコードの最大数。 $filterが指定されている場合にのみ有効です。 既定値は 10 です。 |
継承されたプロパティ
| abort |
要求を中止するために使用できるシグナル。 |
| on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
| request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| serializer |
シリアル化/シリアル化解除の動作をオーバーライドするオプション。 |
| tracing |
トレースが有効な場合に使用されるオプション。 |
プロパティの詳細
aggregations
filter
$filter は、返されるメトリック データのセットを減らすために使用されます。
例：
メトリックには、メタデータ A、B、C が含まれています。
- A = a1 および B = b1 または b2 の C のすべての時系列を返します
$filter=A eq 'a1' と B eq 'b1' または B eq 'b2' と C eq '*'
- バリアントが無効です。
$filter=A eq 'a1' と B eq 'b1' と C eq '*' または B = 'b2'
論理または演算子は 2 つの異なるメタデータ名を区切ることができないため、これは無効です。
- A = a1、B = b1、C = c1 のすべての時系列を返します。
$filter=A eq 'a1' および B eq 'b1' と C eq 'c1'
- A = a1 のすべての時系列を返します
$filter=A eq 'a1' and B eq '' and C eq ''.
filter?: stringプロパティ値
string
granularity
クエリの間隔 (つまり timegrain)。 Durations ヘルパーには、一般的なISO8601期間のエイリアスが含まれています。 これは、P[n]Y[n]M[n]DT[n]H[n]M[n]S という形式のISO8601期間の値です。ここで、P は期間表現の先頭に配置された期間指定子 (期間) です。 Y は、年数の値に従う年指定子です。 M は、月数の値に続く月指定子です。 W は週数の値に続く週指定子です。 D は、日数の値に続く日指定子です。 T は、表現の時間成分の前にある時間指定子です。 H は、時間数の値に続く時間指定子です。 M は、分数の値の後に続く分指定子です。 S は、秒数の値に続く 2 番目の指定子です。
granularity?: stringプロパティ値
string
metricNamespace
メトリック定義のクエリを実行するメトリック名前空間。
metricNamespace?: stringプロパティ値
string
orderBy
結果の並べ替えに使用する集計と並べ替えの方向。 指定できる注文は 1 つだけです。 例: sum asc。
orderBy?: stringプロパティ値
string
resultType
収集されるデータのセットを減らします。 使用できる構文は、操作によって異なります。 詳細については、操作の説明を参照してください。
resultType?: ResultTypeプロパティ値
timespan
top
取得するレコードの最大数。 $filterが指定されている場合にのみ有効です。 既定値は 10 です。
top?: numberプロパティ値
number
継承されたプロパティの詳細
abortSignal
要求を中止するために使用できるシグナル。
abortSignal?: AbortSignalLikeプロパティ値
OperationOptions.abortSignal から継承された
onResponse
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
onResponse?: RawResponseCallbackプロパティ値
OperationOptions.onResponse から継承された
requestOptions
この操作の HTTP 要求を作成および送信するときに使用されるオプション。
requestOptions?: OperationRequestOptionsプロパティ値
OperationOptions.requestOptions から継承された
serializerOptions
シリアル化/シリアル化解除の動作をオーバーライドするオプション。
serializerOptions?: SerializerOptionsプロパティ値
OperationOptions.serializerOptions から継承された
tracingOptions
トレースが有効な場合に使用されるオプション。
tracingOptions?: OperationTracingOptionsプロパティ値
OperationOptions.tracingOptions から継承された
