az datadog monitor

リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.17.0 以降) の datadog 拡張機能の一部です。拡張機能は、az datadog monitor コマンドを初めて実行するときに自動的にインストールされます。拡張機能の詳細をご覧ください。

datadog を使用してモニターを管理します。

コマンド

名前	説明	型	状態
az datadog monitor create	監視リソースを作成します。	拡張	GA
az datadog monitor delete	監視リソースを削除します。	拡張	GA
az datadog monitor get-default-key	既定の API キーを取得します。	拡張	GA
az datadog monitor list	指定したリソースグループのすべてのモニターを一覧表示します。指定したサブスクリプションのすべてのモニターを一覧表示します。	拡張	GA
az datadog monitor list-api-key	特定のモニターリソースの API キーを一覧表示します。	拡張	GA
az datadog monitor list-host	特定のモニターリソースのホストを一覧表示します。	拡張	GA
az datadog monitor list-linked-resource	ターゲットリソースと同じ Datadog 組織に関連付けられているすべての Azure リソースを一覧表示します。	拡張	GA
az datadog monitor list-monitored-resource	Datadog モニターリソースによって現在監視されているリソースを一覧表示します。	拡張	GA
az datadog monitor refresh-set-password-link	パスワードの設定リンクを更新し、最新のリンクを返します。	拡張	GA
az datadog monitor set-default-key	既定の API キーを設定します。	拡張	GA
az datadog monitor show	特定のモニターリソースのプロパティを取得します。	拡張	GA
az datadog monitor update	監視リソースを更新します。	拡張	GA
az datadog monitor wait	datadog モニターの条件が満たされるまで、CLI を待機状態にします。	拡張	GA

az datadog monitor create

監視リソースを作成します。

az datadog monitor create --monitor-name
                          --resource-group
                          [--datadog-organization-properties]
                          [--location]
                          [--no-wait]
                          [--sku-name]
                          [--tags]
                          [--type {SystemAssigned, UserAssigned}]
                          [--user-info]

例

Monitors_Create

az datadog monitor create --name "myMonitor" --resource-group "myResourceGroup" --location "West US 2" --tags Environment="Dev" --user-info name="Alice" email-address="alice@microsoft.com" phone-number="123-456-7890" --type "SystemAssigned" --sku-name "payg_v2_Monthly"

Datadogo 組織へのリンクを使用して作成を監視します。

az datadog monitor create --name "myMonitor" --resource-group "myResourceGroup" --location "West US 2" --datadog-organization-properties api-key=XX application-key=XX --tags Environment="Dev" --user-info name="Alice" email-address="alice@microsoft.com" phone-number="123-456-7890" --type "SystemAssigned" --sku-name "Linked"

必須のパラメーター

--monitor-name --name -n

リソース名を監視します。

--resource-group -g

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

省略可能のパラメーター

--datadog-organization-properties

Datadog 組織のプロパティ。

使用法: --datadog-organization-properties linking-auth-code=XX linking-client-id=XX redirect-uri=XX api-key=XX application-key=XX enterprise-app-id=XX

linking-auth-code: 既存の datadog 組織へのリンクに使用される認証コード。 linking-client-id: 組織をリンクするための認証トークンと引き換えに、既存のユーザーからのclient_id。 redirect-uri: リンクのリダイレクト URI。 api-key: Datadog 組織に関連付けられている API キー。 application-key: Datadog 組織に関連付けられているアプリケーションキー。 enterprise-app-id: シングルサインオンに使用されるエンタープライズアプリの ID。

--location -l

場所。値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--sku-name

SKU の名前。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--type

ID の型。

指定可能な値: SystemAssigned, UserAssigned

--user-info

ユーザー情報。

使用法: --user-info name=XX email-address=XX phone-number=XX

name: Name of the user email-address: Email of the user used by datadog used to contacting them if needed phone-number: 電話 number of the user used by datadog to contacting them if needed.

グローバルパラメーター

--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 datadog monitor delete

監視リソースを削除します。

az datadog monitor delete [--ids]
                          [--monitor-name]
                          [--no-wait]
                          [--resource-group]
                          [--subscription]
                          [--yes]

例

Monitors_Delete

az datadog monitor delete --name "myMonitor" --resource-group "myResourceGroup"

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--monitor-name --name -n

リソース名を監視します。

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--resource-group -g

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

--subscription

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

--yes -y

確認のダイアログを表示しません。

規定値: False

グローバルパラメーター

--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 datadog monitor get-default-key

既定の API キーを取得します。

az datadog monitor get-default-key [--ids]
                                   [--monitor-name]
                                   [--resource-group]
                                   [--subscription]

例

Monitors_GetDefaultKey

az datadog monitor get-default-key --name "myMonitor" --resource-group "myResourceGroup"

省略可能のパラメーター

--ids

--monitor-name --name -n

リソース名を監視します。

--resource-group -g

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

--subscription

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

グローバルパラメーター

--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 datadog monitor list

指定したリソースグループのすべてのモニターを一覧表示します。指定したサブスクリプションのすべてのモニターを一覧表示します。

az datadog monitor list [--resource-group]

例

Monitors_ListByResourceGroup

az datadog monitor list --resource-group "myResourceGroup"

Monitors_List

az datadog monitor list

省略可能のパラメーター

--resource-group -g

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

グローバルパラメーター

--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 datadog monitor list-api-key

特定のモニターリソースの API キーを一覧表示します。

az datadog monitor list-api-key --monitor-name
                                --resource-group

例

Monitors_ListApiKeys

az datadog monitor list-api-key --name "myMonitor" --resource-group "myResourceGroup"

必須のパラメーター

--monitor-name --name -n

リソース名を監視します。

--resource-group -g

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

グローバルパラメーター

--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 datadog monitor list-host

特定のモニターリソースのホストを一覧表示します。

az datadog monitor list-host --monitor-name
                             --resource-group

例

Monitors_ListHosts

az datadog monitor list-host --name "myMonitor" --resource-group "myResourceGroup"

必須のパラメーター

--monitor-name --name -n

リソース名を監視します。

--resource-group -g

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

グローバルパラメーター

--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 datadog monitor list-linked-resource

ターゲットリソースと同じ Datadog 組織に関連付けられているすべての Azure リソースを一覧表示します。

az datadog monitor list-linked-resource --monitor-name
                                        --resource-group

例

Monitors_ListLinkedResources

az datadog monitor list-linked-resource --name "myMonitor" --resource-group "myResourceGroup"

必須のパラメーター

--monitor-name --name -n

リソース名を監視します。

--resource-group -g

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

グローバルパラメーター

--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 datadog monitor list-monitored-resource

Datadog モニターリソースによって現在監視されているリソースを一覧表示します。

az datadog monitor list-monitored-resource --monitor-name
                                           --resource-group

例

Monitors_ListMonitoredResources

az datadog monitor list-monitored-resource --name "myMonitor" --resource-group "myResourceGroup"

必須のパラメーター

--monitor-name --name -n

リソース名を監視します。

--resource-group -g

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

グローバルパラメーター

--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 datadog monitor refresh-set-password-link

パスワードの設定リンクを更新し、最新のリンクを返します。

az datadog monitor refresh-set-password-link [--ids]
                                             [--monitor-name]
                                             [--resource-group]
                                             [--subscription]

例

Monitors_RefreshSetPasswordLink

az datadog monitor refresh-set-password-link --name "myMonitor" --resource-group "myResourceGroup"

省略可能のパラメーター

--ids

--monitor-name --name -n

リソース名を監視します。

--resource-group -g

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

--subscription

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

グローバルパラメーター

--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 datadog monitor set-default-key

既定の API キーを設定します。

az datadog monitor set-default-key [--created]
                                   [--created-by]
                                   [--ids]
                                   [--key]
                                   [--monitor-name]
                                   [--name]
                                   [--resource-group]
                                   [--subscription]

例

Monitors_SetDefaultKey

az datadog monitor set-default-key --monitor-name "myMonitor" --key "1111111111111111aaaaaaaaaaaaaaaa" --resource-group "myResourceGroup"

省略可能のパラメーター

--created

API キーの作成時刻。

--created-by

API キーを作成したユーザー。

--ids

--key

API キーの値。

--monitor-name

リソース名を監視します。

--name

API キーの名前。

--resource-group -g

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

--subscription

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

グローバルパラメーター

--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 datadog monitor show

特定のモニターリソースのプロパティを取得します。

az datadog monitor show [--ids]
                        [--monitor-name]
                        [--resource-group]
                        [--subscription]

例

Monitors_Get

az datadog monitor show --name "myMonitor" --resource-group "myResourceGroup"

省略可能のパラメーター

--ids

--monitor-name --name -n

リソース名を監視します。

--resource-group -g

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

--subscription

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

グローバルパラメーター

--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 datadog monitor update

監視リソースを更新します。

az datadog monitor update [--ids]
                          [--monitor-name]
                          [--monitoring-status]
                          [--no-wait]
                          [--resource-group]
                          [--sku-name]
                          [--subscription]
                          [--tags]

例

Monitors_Update

az datadog monitor update --name "myMonitor" --tags Environment="Dev" --monitoring-status "Disabled" --resource-group "myResourceGroup"

省略可能のパラメーター

--ids

--monitor-name --name -n

リソース名を監視します。

--monitoring-status

リソース監視を有効または無効にするかどうかを指定するフラグ。使用できる値: "Enabled"、"Disabled"。

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--resource-group -g

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

--sku-name

SKU の名前。

--subscription

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

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

グローバルパラメーター

--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 datadog monitor wait

datadog モニターの条件が満たされるまで、CLI を待機状態にします。

az datadog monitor wait [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--ids]
                        [--interval]
                        [--monitor-name]
                        [--resource-group]
                        [--subscription]
                        [--timeout]
                        [--updated]

例

datadog モニターが正常に作成されるまで、CLI スクリプトの次の行の実行を一時停止します。

az datadog monitor wait --name "myMonitor" --resource-group "myResourceGroup" --created

datadog モニターが正常に更新されるまで、CLI スクリプトの次の行の実行を一時停止します。

az datadog monitor wait --name "myMonitor" --resource-group "myResourceGroup" --updated

datadog モニターが正常に削除されるまで、CLI スクリプトの次の行の実行を一時停止します。

az datadog monitor wait --name "myMonitor" --resource-group "myResourceGroup" --deleted

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

規定値: False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

規定値: False

--exists

リソースが存在するまで待ちます。

規定値: False

--ids

--interval

ポーリング間隔 (秒単位)。

規定値: 30

--monitor-name --name -n

リソース名を監視します。

--resource-group -g

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

--subscription

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

--timeout

最大待機時間 (秒単位)。

規定値: 3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

規定値: False

グローバルパラメーター

--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 datadog monitor

コマンド

az datadog monitor create

例

必須のパラメーター

省略可能のパラメーター

az datadog monitor delete

例

省略可能のパラメーター

az datadog monitor get-default-key

例

省略可能のパラメーター

az datadog monitor list

例

省略可能のパラメーター

az datadog monitor list-api-key

例

必須のパラメーター

az datadog monitor list-host

例

必須のパラメーター

az datadog monitor list-linked-resource

例

必須のパラメーター

az datadog monitor list-monitored-resource

例

必須のパラメーター

az datadog monitor refresh-set-password-link

例

省略可能のパラメーター

az datadog monitor set-default-key

例

省略可能のパラメーター

az datadog monitor show

例

省略可能のパラメーター

az datadog monitor update

例

省略可能のパラメーター

az datadog monitor wait

例

省略可能のパラメーター

その他のリソース