MetricsBatchOptionalParams interface
省略可能なパラメーター。
- Extends
プロパティ
| aggregation | 取得する集計の種類 (コンマ区切り) の一覧。 例: average、minimum、maximum |
| end |
クエリの終了時刻。 "yyyy-MM-ddTHH:mm:ss.fffZ" という形式の文字列です。 |
| filter | フィルターは、返されるメトリック データのセットを減らすために使用されます。 |
| interval | クエリの間隔 (つまり timegrain)。 例: PT15M、PT1H、P1D |
| order |
結果の並べ替えに使用する集計と並べ替えの方向。 指定できる注文は 1 つだけです。 例: 合計 asc |
| start |
クエリの開始時刻。 "yyyy-MM-ddTHH:mm:ss.fffZ" という形式の文字列です。 endTime パラメーターを指定した場合、このパラメーターは必須です。 startTime のみを指定した場合、endTime は既定で現在の時刻になります。 時間間隔を指定しない場合、既定値は 1 時間です。 |
| top | 要求内のリソース ID ごとに取得するレコードの最大数。 フィルターが指定されている場合にのみ有効です。 既定値は 10 です。 |
継承されたプロパティ
| abort |
要求を中止するために使用できるシグナル。 |
| on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
| request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| serializer |
シリアル化/シリアル化解除の動作をオーバーライドするオプション。 |
| tracing |
トレースが有効な場合に使用されるオプション。 |
プロパティの詳細
aggregation
取得する集計の種類 (コンマ区切り) の一覧。 例: average、minimum、maximum
aggregation?: stringプロパティ値
string
endTime
クエリの終了時刻。 "yyyy-MM-ddTHH:mm:ss.fffZ" という形式の文字列です。
endTime?: Dateプロパティ値
Date
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' and B eq 'b1' and C eq 'c1'
- A = a1 のすべての時系列を返します
filter=A eq 'a1' and B eq '' and C eq ''.
filter?: stringプロパティ値
string
interval
クエリの間隔 (つまり timegrain)。 例: PT15M、PT1H、P1D
interval?: stringプロパティ値
string
orderBy
結果の並べ替えに使用する集計と並べ替えの方向。 指定できる注文は 1 つだけです。 例: 合計 asc
orderBy?: stringプロパティ値
string
startTime
クエリの開始時刻。 "yyyy-MM-ddTHH:mm:ss.fffZ" という形式の文字列です。 endTime パラメーターを指定した場合、このパラメーターは必須です。 startTime のみを指定した場合、endTime は既定で現在の時刻になります。 時間間隔を指定しない場合、既定値は 1 時間です。
startTime?: Dateプロパティ値
Date
top
要求内のリソース ID ごとに取得するレコードの最大数。 フィルターが指定されている場合にのみ有効です。 既定値は 10 です。
top?: numberプロパティ値
number
継承されたプロパティの詳細
abortSignal
要求を中止するために使用できるシグナル。
abortSignal?: AbortSignalLikeプロパティ値
coreClient.OperationOptions.abortSignal から継承
onResponse
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
onResponse?: RawResponseCallbackプロパティ値
coreClient.OperationOptions.onResponse から継承
requestOptions
この操作の HTTP 要求を作成および送信するときに使用されるオプション。
requestOptions?: OperationRequestOptionsプロパティ値
coreClient.OperationOptions.requestOptions から継承
serializerOptions
シリアル化/シリアル化解除の動作をオーバーライドするオプション。
serializerOptions?: SerializerOptionsプロパティ値
coreClient.OperationOptions.serializerOptions から継承
tracingOptions
トレースが有効な場合に使用されるオプション。
tracingOptions?: OperationTracingOptionsプロパティ値
coreClient.OperationOptions.tracingOptions から継承
