MetricsQueryClient class
メトリックのクエリを実行し、メトリック定義を取得し、メトリック名前空間を取得できるクライアント。
コンストラクター
| Metrics |
MetricsQueryClient を作成します。 |
メソッド
| list |
/** メトリック定義を一覧表示する非同期反復可能反復子を返します。
リソース URI を指定して、メトリック定義の一覧を取得します。 |
| list |
メトリック名前空間を一覧表示する非同期反復可能な反復子を返します。
リソース URI を指定して、メトリック名前空間の一覧を取得します。 |
| query |
リソース URI を指定してメトリックを照会する |
コンストラクターの詳細
MetricsQueryClient(TokenCredential, MetricsClientOptions)
MetricsQueryClient を作成します。
new MetricsQueryClient(tokenCredential: TokenCredential, options?: MetricsClientOptions)
パラメーター
- tokenCredential
- TokenCredential
リソースのメトリックに対してクエリを実行する権限を持つ TokenCredential。
- options
- MetricsClientOptions
要求の再試行の制御などのクライアントのオプション。
メソッドの詳細
listMetricDefinitions(string, ListMetricDefinitionsOptions)
/**
メトリック定義を一覧表示する非同期反復可能反復子を返します。
for await 構文の使用例:
const metricsQueryClient = new MetricsQueryClient(tokenCredential);
const metricDefinitions = client.listMetricDefinitions(resourceUri, options);
let i = 1;
for await (const metricDefinition of metricDefinitions) {
console.log(`metricDefinition ${i++}:`);
console.log(metricDefinition);
}
iter.next() の使用例:
let iter = client.listMetricDefinitions(resourceUri, options);
let result = await iter.next();
while (!result.done) {
console.log(` metricDefinitions - ${result.value.id}, ${result.value.name}`);
result = await iter.next();
}
リソース URI を指定して、メトリック定義の一覧を取得します。
function listMetricDefinitions(resourceUri: string, options?: ListMetricDefinitionsOptions): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>
パラメーター
- resourceUri
-
string
メトリック定義を取得するリソース URI。
- options
- ListMetricDefinitionsOptions
メトリック定義を取得するためのオプション。
戻り値
特定のリソース URI のメトリック定義。
listMetricNamespaces(string, ListMetricNamespacesOptions)
メトリック名前空間を一覧表示する非同期反復可能な反復子を返します。
for await 構文の使用例:
const metricsQueryClient = new MetricsQueryClient(tokenCredential);
const metricNamespaces = client.listMetricNamespaces(resourceUri, options);
let i = 1;
for await (const metricNamespace of metricNamespaces) {
console.log(`metricNamespace ${i++}:`);
console.log(metricNamespace);
}
iter.next() の使用例:
let iter = client.listMetricNamespaces(resourceUri, options);
let result = await iter.next();
while (!result.done) {
console.log(` metricNamespace - ${result.value.id}, ${result.value.name}`);
result = await iter.next();
}
リソース URI を指定して、メトリック名前空間の一覧を取得します。
function listMetricNamespaces(resourceUri: string, options?: ListMetricNamespacesOptions): PagedAsyncIterableIterator<MetricNamespace, MetricNamespace[], PageSettings>
パラメーター
- resourceUri
-
string
メトリック名前空間を取得するリソース URI。
- options
- ListMetricNamespacesOptions
メトリック名前空間を取得するためのオプション。
戻り値
特定のリソース URI のメトリック名前空間。
queryResource(string, string[], MetricsQueryOptions)
リソース URI を指定してメトリックを照会する
function queryResource(resourceUri: string, metricNames: string[], options?: MetricsQueryOptions): Promise<MetricsQueryResult>
パラメーター
- resourceUri
-
string
クエリを実行するリソース URI。
- metricNames
-
string[]
取得するメトリックの名前。
- options
- MetricsQueryOptions
メトリックのクエリを実行するためのオプション。
戻り値
Promise<MetricsQueryResult>
メトリックを含む応答。