MetricsListOptionalParams interface
省略可能なパラメーター。
- Extends
プロパティ
| aggregation | 取得する集計の種類 (コンマ区切り) の一覧。 |
| filter | $filterは、返されるメトリック データのセットを減らすために使用されます。 例: メトリックにメタデータ A、 B と C。 - A = a1 と B = b1 または b2 $filter=A eq 'a1' と B eq 'b1' または B eq 'b2' と C eq '*' が含まれるすべての時系列 C を返します。バリアントが無効です: $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' と B eq '' と C eq '' のすべての時系列を返します。 特殊なケース: ディメンション名またはディメンション値で角かっこが使用されている場合。 例: ディメンション名が dim (テスト) 1 $filter= "dim (test) 1 eq '' を使用する代わりに、**$filter= "dim %2528test%2529 1 eq '' "** ディメンション名が dim (test) 3 で寸法値が dim の場合 3 (テスト) val $filter= "dim (test) 3 eq 'dim3 (test) val' を使用する代わりに、 $filter= "dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' を使用します" |
| interval | クエリの間隔 (つまり、タイムグレイン)。 |
| metricnames | 取得するメトリックの名前 (コンマ区切り)。 特殊なケース: メトリック名自体にコンマが含まれる場合は、%2 を使用して指定します。 例: 'Metric,Name1' は 'Metric%2Name1' である必要があります |
| metricnamespace | メトリック定義のクエリを実行するメトリック名前空間。 |
| orderby | 結果の並べ替えに使用する集計と並べ替えの方向。 指定できる注文は 1 つだけです。 例: sum asc。 |
| result |
収集されるデータのセットを減らします。 使用できる構文は、操作によって異なります。 詳細については、操作の説明を参照してください。 |
| timespan | クエリの期間。 "startDateTime_ISO/endDateTime_ISO" という形式の文字列です。 |
| top | 取得するレコードの最大数。 $filterが指定されている場合にのみ有効です。 既定値は 10 です。 |
継承されたプロパティ
| abort |
要求を中止するために使用できるシグナル。 |
| on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
| request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| serializer |
シリアル化/シリアル化解除の動作をオーバーライドするオプション。 |
| tracing |
トレースが有効な場合に使用されるオプション。 |
プロパティの詳細
aggregation
取得する集計の種類 (コンマ区切り) の一覧。
aggregation?: stringプロパティ値
string
filter
$filterは、返されるメトリック データのセットを減らすために使用されます。 例: メトリックにメタデータ A、 B と C。 - A = a1 と B = b1 または b2 $filter=A eq 'a1' と B eq 'b1' または B eq 'b2' と C eq '*' が含まれるすべての時系列 C を返します。バリアントが無効です: $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' と B eq '' と C eq '' のすべての時系列を返します。 特殊なケース: ディメンション名またはディメンション値で角かっこが使用されている場合。 例: ディメンション名が dim (テスト) 1 $filter= "dim (test) 1 eq '' を使用する代わりに、**$filter= "dim %2528test%2529 1 eq '' "** ディメンション名が dim (test) 3 で寸法値が dim の場合 3 (テスト) val $filter= "dim (test) 3 eq 'dim3 (test) val' を使用する代わりに、 $filter= "dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' を使用します"
filter?: stringプロパティ値
string
interval
クエリの間隔 (つまり、タイムグレイン)。
interval?: stringプロパティ値
string
metricnames
取得するメトリックの名前 (コンマ区切り)。 特殊なケース: メトリック名自体にコンマが含まれる場合は、%2 を使用して指定します。 例: 'Metric,Name1' は 'Metric%2Name1' である必要があります
metricnames?: stringプロパティ値
string
metricnamespace
メトリック定義のクエリを実行するメトリック名前空間。
metricnamespace?: stringプロパティ値
string
orderby
結果の並べ替えに使用する集計と並べ替えの方向。 指定できる注文は 1 つだけです。 例: sum asc。
orderby?: stringプロパティ値
string
resultType
収集されるデータのセットを減らします。 使用できる構文は、操作によって異なります。 詳細については、操作の説明を参照してください。
resultType?: ResultTypeプロパティ値
timespan
クエリの期間。 "startDateTime_ISO/endDateTime_ISO" という形式の文字列です。
timespan?: stringプロパティ値
string
top
取得するレコードの最大数。 $filterが指定されている場合にのみ有効です。 既定値は 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 から継承