az monitor app-insights api-key

注

このリファレンスは、Azure CLI (バージョン 2.55.0 以降) の application-insights 拡張機能の一部です。 az monitor app-insights api-key コマンドを初めて実行すると、拡張機能が自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

Application Insights コンポーネントに関連付けられている API キーに対する操作。

コマンド

名前	説明	型	状態
az monitor app-insights api-key create	Application Insights コンポーネントの API キーを作成します。	拡張	GA
az monitor app-insights api-key delete	Application Insights リソースから API キーを削除します。	拡張	GA
az monitor app-insights api-key show	Application Insights リソースに関連付けられているすべてのキーまたは特定の API キーを取得します。	拡張	GA

az monitor app-insights api-key create

Application Insights コンポーネントの API キーを作成します。

az monitor app-insights api-key create --api-key
                                       --app
                                       --resource-group
                                       [--read-properties]
                                       [--write-properties]

例

種類 Web と場所を持つコンポーネントを作成します。

az monitor app-insights api-key create --api-key cli-demo --read-properties ReadTelemetry --write-properties WriteAnnotations -g demoRg --app testApp

アクセス許可なしで種類 Web と場所を持つコンポーネントを作成する

az monitor app-insights api-key create --api-key cli-demo --read-properties '""' --write-properties '""' -g demoRg --app testApp

必須のパラメーター

--api-key

作成する API キーの名前。

--app -a

Application Insights コンポーネントの GUID、アプリ名、または完全修飾 Azure リソース名。 アプリケーション GUID は、Azure portal の Application Insights リソースの [API アクセス] メニュー項目から取得できます。 アプリケーション名を使用する場合は、リソース グループを指定してください。

--resource-group -g

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

省略可能のパラメーター

--read-properties

この API キーが継承する読み取りロールの名前のスペース区切りの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--write-properties

この API キーが継承する書き込みロールの名前のスペース区切りの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

グローバル パラメーター

--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 app-insights api-key delete

Application Insights リソースから API キーを削除します。

az monitor app-insights api-key delete [--api-key]
                                       [--app]
                                       [--ids]
                                       [--resource-group]
                                       [--subscription]
                                       [--yes]

例

API キーを削除します。

az monitor app-insights api-key delete --app demoApp -g demoRg --api-key demo-key

省略可能のパラメーター

--api-key

削除する API キーの名前。 api-key showを使用して見つけることができます。

--app -a

Application Insights コンポーネントの GUID、アプリ名、または完全修飾 Azure リソース名。 アプリケーション GUID は、Azure portal の Application Insights リソースの [API アクセス] メニュー項目から取得できます。 アプリケーション名を使用する場合は、リソース グループを指定してください。

--ids

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

--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 monitor app-insights api-key show

Application Insights リソースに関連付けられているすべてのキーまたは特定の API キーを取得します。

az monitor app-insights api-key show --app
                                     --resource-group
                                     [--api-key]

例

API キーをフェッチします。

az monitor app-insights api-key show --app demoApp -g demoRg --api-key demo-key

API キーをフェッチします。

az monitor app-insights api-key show --app demoApp -g demoRg

必須のパラメーター

--app -a

Application Insights コンポーネント リソースの名前。

--resource-group -g

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

省略可能のパラメーター

--api-key

フェッチする API キーの名前。 api-key showを使用して見つけることができます。

グローバル パラメーター

--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 を使用します。