az monitor app-insights api-key

參考

注意

此參考是 Azure CLI 應用程式深入解析延伸模組的一部分（2.55.0 版或更高版本）。擴充功能會在您第一次執行 az monitor app-insights api-key 命令時自動安裝。深入了解擴充功能。

與 Application Insights 元件相關聯的 API 金鑰作業。

命令

名稱	Description	類型	狀態
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 資源名稱。您可以從 Azure 入口網站中任何 Application Insights 資源上的 API 存取功能表項取得應用程式 GUID。如果使用應用程式名稱，請指定資源群組。

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

訂用帳戶的名稱或標識碼。您可以使用來設定預設訂用 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

--ids

一或多個資源識別碼 (以空格分隔)。它應該是包含「資源標識碼」自變數所有資訊的完整資源識別碼。您應該提供 --ids 或其他「資源識別碼」自變數。

--resource-group -g

資源群組的名稱。您可以使用來設定預設群組 az configure --defaults group=<name>。

--subscription

訂用帳戶的名稱或標識碼。您可以使用來設定預設訂用 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

訂用帳戶的名稱或標識碼。您可以使用來設定預設訂用 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

訂用帳戶的名稱或標識碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

共用方式為

az monitor app-insights api-key

命令

az monitor app-insights api-key create

範例

必要參數

選擇性參數

az monitor app-insights api-key delete

範例

選擇性參數

az monitor app-insights api-key show

範例

必要參數

選擇性參數

其他資源