az monitor app-insights workbook
Note
Эта ссылка является частью расширения application-insights для Azure CLI (версия 2.71.0 или более поздней). Расширение автоматически установит при первом запуске команды az monitor app-insights. Подробнее о расширениях.
Управление книгой App-Insights.
Команды
| Имя | Описание | Тип | Состояние |
|---|---|---|---|
| az monitor app-insights workbook create |
Создайте новую книгу. |
Extension | GA |
| az monitor app-insights workbook delete |
Удаление книги. |
Extension | GA |
| az monitor app-insights workbook identity |
Управление идентификатором книги. |
Extension | GA |
| az monitor app-insights workbook identity assign |
Назначение удостоверений. |
Extension | GA |
| az monitor app-insights workbook identity remove |
Удаление удостоверений. |
Extension | GA |
| az monitor app-insights workbook list |
Вывод списка всех книг, определенных в указанной группе ресурсов и категории. |
Extension | GA |
| az monitor app-insights workbook revision |
Управление редакцией книги. |
Extension | GA |
| az monitor app-insights workbook revision list |
Перечислить редакции книги. |
Extension | GA |
| az monitor app-insights workbook revision show |
Отображение редакции книги. |
Extension | GA |
| az monitor app-insights workbook show |
Отображение одной книги по имени ресурса. |
Extension | GA |
| az monitor app-insights workbook update |
Обновление книги. |
Extension | GA |
az monitor app-insights workbook create
Создайте новую книгу.
az monitor app-insights workbook create --name --resource-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
Обязательные параметры
Имя ресурса книги. Значение должно быть UUID.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Категория книги, определяемая пользователем во время создания.
| Свойство | Значение |
|---|---|
| Parameter group: | Properties Arguments |
Описание книги.
| Свойство | Значение |
|---|---|
| Parameter group: | Properties Arguments |
Определяемое пользователем имя (отображаемое имя) книги.
| Свойство | Значение |
|---|---|
| Parameter group: | Properties Arguments |
Тип книги. Совместно используется только допустимое значение.
| Свойство | Значение |
|---|---|
| Parameter group: | WorkbookProperties Arguments |
| Допустимые значения: | shared |
Географическое расположение, в котором находится ресурс, если он не указан, будет использоваться расположение группы ресурсов.
| Свойство | Значение |
|---|---|
| Parameter group: | WorkbookProperties Arguments |
Включите назначенное системой удостоверение.
| Свойство | Значение |
|---|---|
| Допустимые значения: | 0, 1, f, false, n, no, t, true, y, yes |
Идентификаторы ресурсов, назначенных пользователем, разделенные пробелами, для добавления удостоверений, назначенных пользователем. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.
Настройка конкретной книги. Данные конфигурации — это строка, содержащая допустимый JSON.
| Свойство | Значение |
|---|---|
| Parameter group: | Properties Arguments |
Идентификатор ресурса Azure, который будет получить все связанные книги.
Идентификатор ресурса для учетной записи хранения при использовании собственного хранилища.
| Свойство | Значение |
|---|---|
| Parameter group: | Properties Arguments |
Теги ресурсов. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.
| Свойство | Значение |
|---|---|
| Parameter group: | WorkbookProperties Arguments |
Формат версии схемы книги, например Notebook/1.0, который должен соответствовать книге в serializedData.
| Свойство | Значение |
|---|---|
| Parameter group: | Properties Arguments |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
az monitor app-insights workbook delete
Удаление книги.
az monitor app-insights workbook delete [--ids]
[--name --resource-name]
[--resource-group]
[--subscription]
[--yes]
Примеры
Удаление книги
az monitor app-insights workbook delete -n 00000000-0000-0000-0000-000000000000 -g wktest
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.
| Свойство | Значение |
|---|---|
| Parameter group: | Resource Id Arguments |
Имя ресурса книги. Значение должно быть UUID.
| Свойство | Значение |
|---|---|
| Parameter group: | Resource Id Arguments |
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.
| Свойство | Значение |
|---|---|
| Parameter group: | Resource Id Arguments |
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
| Свойство | Значение |
|---|---|
| Parameter group: | Resource Id Arguments |
Не запрашивать подтверждение.
| Свойство | Значение |
|---|---|
| Default value: | False |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
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
Обязательные параметры
Категория возвращаемой книги.
| Свойство | Значение |
|---|---|
| Допустимые значения: | TSG, performance, retention, workbook |
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Флаг, указывающий, следует ли возвращать полное содержимое для каждой применимой книги. Если значение false, возвращается только содержимое сводки для книг.
| Свойство | Значение |
|---|---|
| Допустимые значения: | 0, 1, f, false, n, no, t, true, y, yes |
Общее количество элементов, возвращаемых в выходных данных команды. Если общее количество доступных элементов превышает указанное значение, маркер предоставляется в выходных данных команды. Чтобы возобновить разбиение на страницы, укажите значение маркера в --next-token аргументе последующей команды.
| Свойство | Значение |
|---|---|
| Parameter group: | Pagination Arguments |
Маркер, чтобы указать, где начать разбиение на страницы. Это значение маркера из ранее усеченного ответа.
| Свойство | Значение |
|---|---|
| Parameter group: | Pagination Arguments |
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.
Идентификатор ресурса Azure, который будет получить все связанные книги.
Теги представлены в каждой книге, возвращенной. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
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-name]
[--resource-group]
[--subscription]
Примеры
Отображение книги
az monitor app-insights workbook show -n 00000000-0000-0000-0000-000000000000 -g wktest
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Флаг, указывающий, следует ли возвращать полное содержимое для каждой применимой книги. Если значение false, возвращается только содержимое сводки для книг.
| Свойство | Значение |
|---|---|
| Допустимые значения: | 0, 1, f, false, n, no, t, true, y, yes |
Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.
| Свойство | Значение |
|---|---|
| Parameter group: | Resource Id Arguments |
Имя ресурса книги. Значение должно быть UUID.
| Свойство | Значение |
|---|---|
| Parameter group: | Resource Id Arguments |
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.
| Свойство | Значение |
|---|---|
| Parameter group: | Resource Id Arguments |
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
| Свойство | Значение |
|---|---|
| Parameter group: | Resource Id Arguments |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
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 --resource-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
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>.
| Свойство | Значение |
|---|---|
| Parameter group: | Generic Update Arguments |
Категория книги, определяемая пользователем во время создания.
| Свойство | Значение |
|---|---|
| Parameter group: | Properties Arguments |
Описание книги.
| Свойство | Значение |
|---|---|
| Parameter group: | Properties Arguments |
Определяемое пользователем имя (отображаемое имя) книги.
| Свойство | Значение |
|---|---|
| Parameter group: | Properties Arguments |
При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.
| Свойство | Значение |
|---|---|
| Parameter group: | Generic Update Arguments |
| Допустимые значения: | 0, 1, f, false, n, no, t, true, y, yes |
Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.
| Свойство | Значение |
|---|---|
| Parameter group: | Resource Id Arguments |
Тип книги. Совместно используется только допустимое значение.
| Свойство | Значение |
|---|---|
| Parameter group: | WorkbookProperties Arguments |
| Допустимые значения: | shared |
Имя ресурса книги. Значение должно быть UUID.
| Свойство | Значение |
|---|---|
| Parameter group: | Resource Id Arguments |
Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove> OR --remove propertyToRemove.
| Свойство | Значение |
|---|---|
| Parameter group: | Generic Update Arguments |
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.
| Свойство | Значение |
|---|---|
| Parameter group: | Resource Id Arguments |
Настройка конкретной книги. Данные конфигурации — это строка, содержащая допустимый JSON.
| Свойство | Значение |
|---|---|
| Parameter group: | Properties Arguments |
Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>.
| Свойство | Значение |
|---|---|
| Parameter group: | Generic Update Arguments |
Идентификатор ресурса Azure, который будет получить все связанные книги.
Идентификатор ресурса для учетной записи хранения при использовании собственного хранилища.
| Свойство | Значение |
|---|---|
| Parameter group: | Properties Arguments |
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
| Свойство | Значение |
|---|---|
| Parameter group: | Resource Id Arguments |
Теги ресурсов. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.
| Свойство | Значение |
|---|---|
| Parameter group: | WorkbookProperties Arguments |
Формат версии схемы книги, например Notebook/1.0, который должен соответствовать книге в serializedData.
| Свойство | Значение |
|---|---|
| Parameter group: | Properties Arguments |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |