az monitor metrics

Azure リソース メトリックを表示します。

コマンド

名前	説明	型	状態
az monitor metrics alert	ほぼリアルタイムのメトリック アラート ルールを管理します。	コア	GA
az monitor metrics alert condition	ほぼリアルタイムのメトリック アラート ルールの条件を管理します。	コア	GA
az monitor metrics alert condition create	メトリック アラート ルールの条件を作成します。	コア	プレビュー
az monitor metrics alert create	メトリックベースのアラート ルールを作成します。	コア	GA
az monitor metrics alert delete	メトリックベースのアラート ルールを削除します。	コア	GA
az monitor metrics alert dimension	ほぼリアルタイムのメトリック アラート ルール ディメンションを管理します。	コア	GA
az monitor metrics alert dimension create	メトリック アラート ルール ディメンションを作成します。	コア	プレビュー
az monitor metrics alert list	メトリックベースのアラート ルールを一覧表示します。	コア	GA
az monitor metrics alert show	メトリックベースのアラート ルールを表示します。	コア	GA
az monitor metrics alert update	メトリックベースのアラート ルールを更新します。	コア	GA
az monitor metrics list	リソースのメトリック値を一覧表示します。	コア	GA
az monitor metrics list-definitions	リソースのメトリック定義を一覧表示します。	コア	GA
az monitor metrics list-namespaces	リソースのメトリック名前空間を一覧表示します。	コア	プレビュー
az monitor metrics list-sub	サブスクリプションのメトリック データを一覧表示します。 パラメーターは本文で指定できます。	コア	GA
az monitor metrics list-sub-definitions	サブスクリプションのメトリック定義を一覧表示します。	コア	GA

az monitor metrics list

リソースのメトリック値を一覧表示します。

az monitor metrics list --resource
                        [--aggregation {Average, Count, Maximum, Minimum, None, Total}]
                        [--dimension]
                        [--end-time]
                        [--filter]
                        [--interval]
                        [--metadata]
                        [--metrics]
                        [--namespace]
                        [--offset]
                        [--orderby]
                        [--resource-group]
                        [--resource-namespace]
                        [--resource-parent]
                        [--resource-type]
                        [--start-time]
                        [--top]

例

過去 1 時間の VM の CPU 使用率を一覧表示する

az monitor metrics list --resource {ResourceName} --metric "Percentage CPU"

ストレージ アカウントの成功 E2E 待機時間を一覧表示し、API 名に基づいてデータ系列を分割する

az monitor metrics list --resource {ResourceName} --metric SuccessE2ELatency \
                        --dimension ApiName

ストレージ アカウントの成功 E2E 待機時間を一覧表示し、API 名と geo の種類の両方に基づいてデータ系列を分割する

az monitor metrics list --resource {ResourceName} --metric SuccessE2ELatency \
                        --dimension ApiName GeoType

ストレージ アカウントの成功 E2E 待機時間を一覧表示し、"--filter" パラメーターを使用して API 名と geo 型の両方に基づいてデータ系列を分割する

az monitor metrics list --resource {ResourceName} --metric SuccessE2ELatency \
                        --filter "ApiName eq '*' and GeoType eq '*'"

ストレージ アカウントの成功 E2E 待機時間を一覧表示し、API 名と geo の種類の両方に基づいてデータ系列を分割します。 API 名を 'DeleteContainer' に制限します

az monitor metrics list --resource {ResourceName} --metric SuccessE2ELatency \
                        --filter "ApiName eq 'DeleteContainer' and GeoType eq '*'"

2017-01-01 以降の 1 日あたりのストレージ アカウントのトランザクションを一覧表示する

az monitor metrics list --resource {ResourceName} --metric Transactions \
                        --start-time 2017-01-01T00:00:00Z \
                        --interval PT24H

2017 年以降のトランザクション メトリックの API 名ディメンションのストレージ アカウントのメタデータ値を一覧表示する

az monitor metrics list --resource {ResourceName} --metric Transactions \
                        --filter "ApiName eq '*'" \
                        --start-time 2017-01-01T00:00:00Z

必須のパラメーター

--resource

ターゲット リソースの名前または ID。

省略可能のパラメーター

--aggregation

取得する集計の種類 (スペース区切り) の一覧。

指定可能な値: Average, Count, Maximum, Minimum, None, Total

値の取得元: az monitor metrics list-definitions

--dimension

メトリックのクエリ対象となるディメンション (スペース区切り) の一覧。

値の取得元: az monitor metrics list-definitions

--end-time

クエリの終了時間。 既定値は現在の時刻です。 形式: date (yyyy-mm-dd) time (hh:mm:ss.xxxxx) タイムゾーン (+/-hh:mm)。

--filter

返されるメトリック データのセットを減らすために使用される文字列。 例: "BlobType eq '*'"。

フィルターの完全な一覧については、フィルター文字列のリファレンス https://docs.microsoft.com/rest/api/monitor/metrics/listを参照してください。

--interval

メトリックを集計する間隔 (##h##m 形式)。

規定値: 1m

--metadata

メトリック データの代わりにメタデータ値を返します。

--metrics

取得するメトリック名のスペース区切りの一覧。

値の取得元: az monitor metrics list-definitions

--namespace

メトリック定義のクエリを実行する名前空間。

値の取得元: az monitor metrics list-namespaces

--offset

クエリ範囲の時間オフセット (##d##h 形式)。

--start-time または --end-time と共に使用できます。 --start-time と共に使用した場合、終了時刻はオフセットを追加して計算されます。 --end-time (既定値) と共に使用した場合、開始時刻はオフセットを減算して計算されます。 --start-time と --end-time が指定されている場合、--offset は無視されます。

規定値: 1h

--orderby

結果の並べ替えと並べ替えの方向に使用する集計。 特定できる注文は 1 つだけです。 例: sum asc。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--resource-namespace

ターゲット リソース プロバイダーの名前空間。

--resource-parent

ターゲット リソースの親パス (該当する場合)。

--resource-type

ターゲット リソースの種類。 名前空間/型形式 (例: "Microsoft.Compute/virtualMachines") を受け入れることもできます。

--start-time

クエリの開始時間。 形式: date (yyyy-mm-dd) time (hh:mm:ss.xxxxx) タイムゾーン (+/-hh:mm)。

--top

取得するレコードの最大数。

規定値: 10

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az monitor metrics list-definitions

リソースのメトリック定義を一覧表示します。

az monitor metrics list-definitions --resource
                                    [--namespace]
                                    [--resource-group]
                                    [--resource-namespace]
                                    [--resource-parent]
                                    [--resource-type]

例

リソースのメトリック定義を一覧表示します。 (自動生成)

az monitor metrics list-definitions --resource /subscriptions/{subscriptionID}/resourceGroups/{resourceGroup}/Microsoft.Network/networkSecurityGroups/{resourceName}

必須のパラメーター

--resource

ターゲット リソースの名前または ID。

省略可能のパラメーター

--namespace

メトリック定義のクエリを実行する名前空間。

値の取得元: az monitor metrics list-namespaces

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--resource-namespace

ターゲット リソース プロバイダーの名前空間。

--resource-parent

ターゲット リソースの親パス (該当する場合)。

--resource-type

ターゲット リソースの種類。 名前空間/型形式 (例: "Microsoft.Compute/virtualMachines") を受け入れることもできます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az monitor metrics list-namespaces

プレビュー

このコマンドはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

リソースのメトリック名前空間を一覧表示します。

az monitor metrics list-namespaces --resource-uri
                                   [--start-time]

例

リソースのメトリック名前空間を一覧表示します。

az monitor metrics list-namespaces --resource /subscriptions/{subscriptionID}/resourceGroups/{resourceGroup}/Microsoft.Network/networkSecurityGroups/{resourceName} --start-time 2021-03-01T00:00:00Z

必須のパラメーター

--resource-uri

リソースの識別子。

省略可能のパラメーター

--start-time

クエリの開始時間。 形式: date (yyyy-mm-dd) time (hh:mm:ss.xxxxx) タイムゾーン (+/-hh:mm)。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az monitor metrics list-sub

サブスクリプションのメトリック データを一覧表示します。 パラメーターは本文で指定できます。

az monitor metrics list-sub --region
                            [--aggregation]
                            [--auto-adjust-timegrain {0, 1, f, false, n, no, t, true, y, yes}]
                            [--filter]
                            [--interval]
                            [--metricnames]
                            [--metricnamespace]
                            [--order-by]
                            [--result-type {Data, Metadata}]
                            [--roll-up-by]
                            [--timespan]
                            [--top]
                            [--validate-dimensions {0, 1, f, false, n, no, t, true, y, yes}]

必須のパラメーター

--region

必要なメトリックが存在するリージョン。

省略可能のパラメーター

--aggregation

取得する集計の種類 (コンマ区切り) の一覧。

--auto-adjust-timegrain

true に設定すると、渡された期間がこのメトリックでサポートされていない場合、API はサポートされている最も近い期間を使用して結果を返します。 false に設定すると、無効な timespan パラメーターに対してエラーが返されます。 既定は false です。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--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' と B eq '' と C eq '' です。

--interval

ISO 8601 期間形式のクエリの間隔 (つまり、タイムグレイン)。 既定値は PT1M です。 要求された期間全体の単一データポイントを返す 'FULL' 値の特殊なケース。 例: PT15M、PT1H、P1D、FULL。

--metricnames

取得するメトリックの名前 (コンマ区切り)。

--metricnamespace

必要なメトリックが存在するメトリック名前空間。

--order-by

結果の並べ替えに使用する集計と並べ替えの方向。 指定できる注文は 1 つだけです。 例: sum asc。

--result-type

収集されるデータのセットを減らします。 使用できる構文は、操作によって異なります。 詳細については、操作の説明を参照してください。

指定可能な値: Data, Metadata

--roll-up-by

結果をロールアップするディメンション名。 たとえば、"City eq Seattle or City eq Tacoma" のようなフィルターを使用してメトリック値のみを表示したいが、市区町村ごとに個別の値を表示したくない場合は、'RollUpBy=City' を指定して、シアトルとタコマの結果を 1 つの時系列にロールアップして表示できます。

--timespan

クエリの期間。 "startDateTime_ISO/endDateTime_ISO" という形式の文字列です。

--top

取得するレコードの最大数。 $filterが指定されている場合にのみ有効です。 既定値は 10 です。

--validate-dimensions

false に設定すると、無効なフィルター パラメーター値は無視されます。 true に設定すると、無効なフィルター パラメーターに対してエラーが返されます。 既定は true です。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az monitor metrics list-sub-definitions

サブスクリプションのメトリック定義を一覧表示します。

az monitor metrics list-sub-definitions --region
                                        [--metricnamespace]

必須のパラメーター

--region

必要なメトリックが存在するリージョン。

省略可能のパラメーター

--metricnamespace

必要なメトリックが存在するメトリック名前空間。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。