Baselines - List

リファレンス

Service:: Monitor

API Version:: 2019-03-01

リソースのメトリックベースライン値をListsします。

GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metricBaselines?api-version=2019-03-01

With optional parameters:

GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metricBaselines?metricnames={metricnames}&metricnamespace={metricnamespace}&timespan={timespan}&interval={interval}&aggregation={aggregation}&sensitivities={sensitivities}&$filter={$filter}&resultType={resultType}&api-version=2019-03-01

URI パラメーター

名前	/	必須	型	説明
resourceUri	path	True	string	リソースの識別子。
api-version	query	True	string	この操作に使用する API バージョン。
$filter	query		string	$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' を使用します"
aggregation	query		string	取得する集計の種類 (コンマ区切り) の一覧。
interval	query		string duration	クエリの間隔 (つまり、タイムグレイン)。
metricnames	query		string	取得するメトリックの名前 (コンマ区切り)。特殊なケース: メトリック名自体にコンマが含まれる場合は、%2 を使用して指定します。例: 'Metric,Name1' は 'Metric%2Name1' である必要があります
metricnamespace	query		string	メトリック定義のクエリを実行するメトリック名前空間。
resultType	query		ResultType	ベースラインのメタデータのみを取得できるようにします。データ要求時にすべての情報が取得されます。
sensitivities	query		string	取得する秘密度 (コンマ区切り) の一覧。
timespan	query		string	クエリの期間。 "startDateTime_ISO/endDateTime_ISO" という形式の文字列です。

応答

名前	型	説明
200 OK	MetricBaselinesResponse	メトリックベースライン値の一覧を取得する要求が成功しました。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Get metric baselines

Sample Request

GET https://management.azure.com/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Insights/metricBaselines?timespan=2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z&interval=PT1H&aggregation=average&sensitivities=Low,Medium&api-version=2019-03-01


import java.time.Duration;

/**
 * Samples for Baselines List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/examples/metricBaselines.json
     */
    /**
     * Sample code: Get metric baselines.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getMetricBaselines(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getBaselines().list(
            "subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1",
            null, null, "2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z", Duration.parse("PT1H"), "average",
            "Low,Medium", null, null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armmonitor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/examples/metricBaselines.json
func ExampleBaselinesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmonitor.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewBaselinesClient().NewListPager("subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1", &armmonitor.BaselinesClientListOptions{Metricnames: nil,
		Metricnamespace: nil,
		Timespan:        to.Ptr("2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z"),
		Interval:        to.Ptr("PT1H"),
		Aggregation:     to.Ptr("average"),
		Sensitivities:   to.Ptr("Low,Medium"),
		Filter:          nil,
		ResultType:      nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.MetricBaselinesResponse = armmonitor.MetricBaselinesResponse{
		// 	Value: []*armmonitor.SingleMetricBaseline{
		// 		{
		// 			Name: to.Ptr("Percentage CPU"),
		// 			Type: to.Ptr("microsoft.insights/metricBaselines"),
		// 			ID: to.Ptr("/subscriptions/11aeb0ed-456b-4ca0-8df5-b9fbdc63d0d3/resourceGroups/SmartAnalytics-DEV-VM/providers/Microsoft.Compute/virtualMachines/DemoVM1/providers/microsoft.insights/metricBaselines/Percentage CPU"),
		// 			Properties: &armmonitor.MetricBaselinesProperties{
		// 				Baselines: []*armmonitor.TimeSeriesBaseline{
		// 					{
		// 						Aggregation: to.Ptr("average"),
		// 						Data: []*armmonitor.SingleBaseline{
		// 							{
		// 								HighThresholds: []*float64{
		// 									to.Ptr[float64](90.3453),
		// 									to.Ptr[float64](91.3453)},
		// 									LowThresholds: []*float64{
		// 										to.Ptr[float64](30),
		// 										to.Ptr[float64](31.1)},
		// 										Sensitivity: to.Ptr(armmonitor.BaselineSensitivityLow),
		// 									},
		// 									{
		// 										HighThresholds: []*float64{
		// 											to.Ptr[float64](70.3453),
		// 											to.Ptr[float64](71.3453)},
		// 											LowThresholds: []*float64{
		// 												to.Ptr[float64](50),
		// 												to.Ptr[float64](51.1)},
		// 												Sensitivity: to.Ptr(armmonitor.BaselineSensitivityMedium),
		// 										}},
		// 										Dimensions: []*armmonitor.MetricSingleDimension{
		// 										},
		// 										MetadataValues: []*armmonitor.BaselineMetadata{
		// 											{
		// 												Name: to.Ptr("ErrorType"),
		// 												Value: to.Ptr("TooManyAnomalies"),
		// 											},
		// 											{
		// 												Name: to.Ptr("SeasonalityFrequency"),
		// 												Value: to.Ptr("288"),
		// 										}},
		// 										Timestamps: []*time.Time{
		// 											to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-12T11:00:00.000Z"); return t}()),
		// 											to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-03-12T12:00:00.000Z"); return t}())},
		// 									}},
		// 									Interval: to.Ptr("PT1H"),
		// 									Namespace: to.Ptr("microsoft.compute/virtualmachines"),
		// 									Timespan: to.Ptr("2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z"),
		// 								},
		// 						}},
		// 					}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { MonitorClient } = require("@azure/arm-monitor");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to **Lists the metric baseline values for a resource**.
 *
 * @summary **Lists the metric baseline values for a resource**.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/examples/metricBaselines.json
 */
async function getMetricBaselines() {
  const resourceUri =
    "subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1";
  const timespan = "2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z";
  const interval = "PT1H";
  const aggregation = "average";
  const sensitivities = "Low,Medium";
  const options = {
    timespan,
    interval,
    aggregation,
    sensitivities,
  };
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential);
  const resArray = new Array();
  for await (let item of client.baselines.list(resourceUri, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/11aeb0ed-456b-4ca0-8df5-b9fbdc63d0d3/resourceGroups/SmartAnalytics-DEV-VM/providers/Microsoft.Compute/virtualMachines/DemoVM1/providers/microsoft.insights/metricBaselines/Percentage CPU",
      "type": "microsoft.insights/metricBaselines",
      "name": "Percentage CPU",
      "properties": {
        "interval": "PT1H",
        "timespan": "2019-03-12T11:00:00.000Z/2019-03-12T12:00:00.000Z",
        "namespace": "microsoft.compute/virtualmachines",
        "baselines": [
          {
            "aggregation": "average",
            "dimensions": [],
            "metadataValues": [
              {
                "name": "ErrorType",
                "value": "TooManyAnomalies"
              },
              {
                "name": "SeasonalityFrequency",
                "value": "288"
              }
            ],
            "timestamps": [
              "2019-03-12T11:00:00.000Z",
              "2019-03-12T12:00:00.000Z"
            ],
            "data": [
              {
                "sensitivity": "Low",
                "lowThresholds": [
                  30,
                  31.1
                ],
                "highThresholds": [
                  90.3453,
                  91.3453
                ]
              },
              {
                "sensitivity": "Medium",
                "lowThresholds": [
                  50,
                  51.1
                ],
                "highThresholds": [
                  70.3453,
                  71.3453
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}

定義

名前	説明
BaselineMetadata	ベースラインメタデータ値を表します。
BaselineSensitivity	ベースラインの感度。
ErrorResponse	エラー応答の形式について説明します。
MetricBaselinesResponse	メトリックベースラインの一覧。
MetricSingleDimension	メトリックディメンションの名前と値。
ResultType	ベースラインのメタデータのみを取得できるようにします。データ要求時にすべての情報が取得されます。
SingleBaseline	1 つの秘密度値の基準値。
SingleMetricBaseline	1 つのメトリックのベースライン結果。
TimeSeriesBaseline	1 つの時系列の基準値。

BaselineMetadata

ベースラインメタデータ値を表します。

名前	型	説明
name	string	ベースラインメタデータの名前。
value	string	ベースラインメタデータの値。

BaselineSensitivity

ベースラインの感度。

名前	型	説明
High	string
Low	string
Medium	string

ErrorResponse

エラー応答の形式について説明します。

名前	型	説明
code	string	エラーコード
message	string	操作が失敗した理由を示すエラーメッセージ。

MetricBaselinesResponse

メトリックベースラインの一覧。

名前	型	説明
value	SingleMetricBaseline[]	メトリックベースラインの一覧。

MetricSingleDimension

メトリックディメンションの名前と値。

名前	型	説明
name	string	ディメンションの名前。
value	string	ディメンションの値。

ResultType

ベースラインのメタデータのみを取得できるようにします。データ要求時にすべての情報が取得されます。

名前	型	説明
Data	string
Metadata	string

SingleBaseline

1 つの秘密度値の基準値。

名前	型	説明
highThresholds	number[]	ベースラインの高いしきい値。
lowThresholds	number[]	ベースラインの低しきい値。
sensitivity	BaselineSensitivity	ベースラインの感度。

SingleMetricBaseline

1 つのメトリックのベースライン結果。

名前	型	説明
id	string	メトリックベースライン ID。
name	string	ベースラインが取得されたメトリックの名前。
properties.baselines	TimeSeriesBaseline[]	クエリが実行された各時系列のベースライン。
properties.interval	string	メトリックデータが返された間隔 (ウィンドウサイズ)。これは将来調整され、最初に要求されたものから返される可能性があります。これは、メタデータ要求が行われた場合には存在しません。
properties.namespace	string	メトリックの名前空間に対してクエリが実行されました。
properties.timespan	string	データが取得された期間。その値は、'/' で区切られた 2 つの datetime で構成されます。これは将来調整され、最初に要求されたものから返される可能性があります。
type	string	メトリックベースラインリソースのリソースの種類。

TimeSeriesBaseline

1 つの時系列の基準値。

名前	型	説明
aggregation	string	メトリックの集計の種類。
data	SingleBaseline[]	各秘密度の基準値。
dimensions	MetricSingleDimension[]	この時系列のディメンション。
metadataValues	BaselineMetadata[]	ベースラインメタデータ値。
timestamps	string[]	ベースラインのタイムスタンプの一覧。

次の方法で共有

Baselines - List

URI パラメーター

応答

セキュリティ

azure_auth

Scopes

例

Get metric baselines

Sample Request

Sample Response

定義

BaselineMetadata

BaselineSensitivity

ErrorResponse

MetricBaselinesResponse

MetricSingleDimension

ResultType

SingleBaseline

SingleMetricBaseline

TimeSeriesBaseline

その他のリソース