az monitor app-insights workbook

參考

注意

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

管理 app-insights 活頁簿。

命令

名稱	Description	類型	狀態
az monitor app-insights workbook create	建立活頁簿。	副檔名	GA
az monitor app-insights workbook delete	刪除活頁簿。	副檔名	GA
az monitor app-insights workbook identity	管理活頁簿標識碼。	副檔名	GA
az monitor app-insights workbook identity assign	指派身分識別。	副檔名	GA
az monitor app-insights workbook identity remove	拿掉身分識別。	副檔名	GA
az monitor app-insights workbook list	列出指定資源群組和類別內定義的所有活頁簿。	副檔名	GA
az monitor app-insights workbook revision	管理活頁簿修訂。	副檔名	GA
az monitor app-insights workbook revision list	列出活頁簿的修訂。	副檔名	GA
az monitor app-insights workbook revision show	顯示活頁簿修訂。	副檔名	GA
az monitor app-insights workbook show	依資源名稱顯示單一活頁簿。	副檔名	GA
az monitor app-insights workbook update	更新活頁簿。	副檔名	GA

az monitor app-insights workbook create

建立活頁簿。

az monitor app-insights workbook create --name
                                        --resource-group
                                        [--category]
                                        [--description]
                                        [--display-name]
                                        [--kind {shared}]
                                        [--location]
                                        [--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--mi-user-assigned]
                                        [--serialized-data]
                                        [--source-id]
                                        [--storage-uri]
                                        [--tags]
                                        [--version]

範例

建立活頁簿

az monitor app-insights workbook create -n 00000000-0000-0000-0000-000000000000 -g rg --serialized-data mydata --kind shared --category workbook  --display-name workbookname

必要參數

--name --resource-name -n

活頁簿資源的名稱。此值必須是 UUID。

--resource-group -g

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

選擇性參數

--category

活頁簿類別，如使用者在建立時所定義。

--description

活頁簿的描述。

--display-name

活頁簿的使用者定義名稱（顯示名稱）。

--kind

活頁簿的種類。只有有效的值是共用的。

接受的值: shared

--location -l

未指定資源所在的地理位置，將會使用資源群組的位置。

--mi-system-assigned

啟用系統指派的身分識別。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--mi-user-assigned

空間分隔的資源標識碼，以新增使用者指派的身分識別。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

--serialized-data

此特定活頁簿的設定。設定數據是包含有效 JSON 的字串。

--source-id

將擷取所有連結活頁簿的 Azure 資源識別碼。

--storage-uri

使用您自己的記憶體時，將 resourceId 複製到記憶體帳戶。

--tags

資源標籤。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

--version

活頁簿架構版本格式，例如『Notebook/1.0』，其應該符合 serializedData 中的活頁簿。

全域參數

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

刪除活頁簿。

az monitor app-insights workbook delete [--ids]
                                        [--name]
                                        [--resource-group]
                                        [--subscription]
                                        [--yes]

範例

刪除活頁簿

az monitor app-insights workbook delete -n 00000000-0000-0000-0000-000000000000 -g wktest

選擇性參數

--ids

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

--name --resource-name -n

活頁簿資源的名稱。此值必須是 UUID。

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

列出指定資源群組和類別內定義的所有活頁簿。

az monitor app-insights workbook list --category {TSG, performance, retention, workbook}
                                      [--can-fetch-content {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--max-items]
                                      [--next-token]
                                      [--resource-group]
                                      [--source-id]
                                      [--tags]

範例

列出活頁簿

az monitor app-insights workbook list -g rg --category workbook

必要參數

--category

要傳回的活頁簿類別。

接受的值: TSG, performance, retention, workbook

選擇性參數

--can-fetch-content

旗標，指出是否要傳回每個適用活頁簿的完整內容。如果為 false，則只會傳回活頁簿的摘要內容。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--max-items

命令輸出中要傳回的項目總數。如果可用的專案總數超過指定的值，則會在命令的輸出中提供令牌。若要繼續分頁，請在後續命令的自變數中 --next-token 提供令牌值。

--next-token

標記，指定要開始分頁的位置。這是先前截斷回應中的令牌值。

--resource-group -g

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

--source-id

將擷取所有連結活頁簿的 Azure 資源識別碼。

--tags

標記會顯示在每個傳回的活頁簿上。支援速記語法、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 workbook show

依資源名稱顯示單一活頁簿。

az monitor app-insights workbook show [--can-fetch-content {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]

範例

顯示活頁簿

az monitor app-insights workbook show -n 00000000-0000-0000-0000-000000000000 -g wktest

選擇性參數

--can-fetch-content

旗標，指出是否要傳回每個適用活頁簿的完整內容。如果為 false，則只會傳回活頁簿的摘要內容。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--ids

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

--name --resource-name -n

活頁簿資源的名稱。此值必須是 UUID。

--resource-group -g

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

--subscription

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

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

--verbose

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

az monitor app-insights workbook update

更新活頁簿。

az monitor app-insights workbook update [--add]
                                        [--category]
                                        [--description]
                                        [--display-name]
                                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--ids]
                                        [--kind {shared}]
                                        [--name]
                                        [--remove]
                                        [--resource-group]
                                        [--serialized-data]
                                        [--set]
                                        [--source-id]
                                        [--storage-uri]
                                        [--subscription]
                                        [--tags]
                                        [--version]

範例

更新活頁簿

az monitor app-insights workbook update -n 00000000-0000-0000-0000-000000000000 -g rg --tags tag=test

選擇性參數

--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。範例：--add property.listProperty <key=value、string 或 JSON 字串>。

--category

活頁簿類別，如使用者在建立時所定義。

--description

活頁簿的描述。

--display-name

活頁簿的使用者定義名稱（顯示名稱）。

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--ids

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

--kind

活頁簿的種類。只有有效的值是共用的。

接受的值: shared

--name --resource-name -n

活頁簿資源的名稱。此值必須是 UUID。

--remove

從清單中移除屬性或專案。範例：--remove property.list OR --remove 屬性ToRemove。

--resource-group -g

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

--serialized-data

此特定活頁簿的設定。設定數據是包含有效 JSON 的字串。

--set

指定要設定的屬性路徑和值，以更新物件。範例：--set property1.property2=。

--source-id

將擷取所有連結活頁簿的 Azure 資源識別碼。

--storage-uri

使用您自己的記憶體時，將 resourceId 複製到記憶體帳戶。

--subscription

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

--tags

資源標籤。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

--version

活頁簿架構版本格式，例如『Notebook/1.0』，其應該符合 serializedData 中的活頁簿。

全域參數

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

命令

az monitor app-insights workbook create

範例

必要參數

選擇性參數

az monitor app-insights workbook delete

範例

選擇性參數

az monitor app-insights workbook list

範例

必要參數

選擇性參數

az monitor app-insights workbook show

範例

選擇性參數

az monitor app-insights workbook update

範例

選擇性參數

其他資源