az monitor app-insights workbook

Note

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

app-insights ブックを管理します。

コマンド

名前	説明	型	Status
az monitor app-insights workbook create	ブックを作成します。	拡張子	GA
az monitor app-insights workbook delete	ブックを削除します。	拡張子	GA
az monitor app-insights workbook identity	ブックの idneity を管理します。	拡張子	GA
az monitor app-insights workbook identity assign	ID を割り当てます。	拡張子	GA
az monitor app-insights workbook identity remove	ID を削除します。	拡張子	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	リソース名で 1 つのブックを表示します。	拡張子	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

システム割り当て ID を有効にします。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--mi-user-assigned

ユーザー割り当て ID を追加するためのスペース区切りリソース ID。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--serialized-data

この特定のブックの構成。 構成データは、有効な JSON を含む文字列です。

--source-id

リンクされたすべてのブックをフェッチする Azure リソース ID。

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

サブスクリプションの名前または ID。 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

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

--name --resource-name -n

ブック リソースの名前。 値は UUID である必要があります。

--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 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 リソース ID。

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

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

--verbose

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

az monitor app-insights workbook show

リソース名で 1 つのブックを表示します。

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

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

--name --resource-name -n

ブック リソースの名前。 値は UUID である必要があります。

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

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

--kind

ブックの種類。 有効な値のみが共有されます。

承認された値: shared

--name --resource-name -n

ブック リソースの名前。 値は UUID である必要があります。

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list OR --remove propertyToRemove。

--resource-group -g

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

--serialized-data

この特定のブックの構成。 構成データは、有効な JSON を含む文字列です。

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=。

--source-id

リンクされたすべてのブックをフェッチする Azure リソース ID。

--storage-uri

独自のストレージを持ち込むときにストレージ アカウントに対する resourceId が使用されます。

--subscription

サブスクリプションの名前または ID。 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

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

--verbose

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