Compartir a través de


az monitor app-insights workbook

Note

This reference is part of the application-insights extension for the Azure CLI (version 2.71.0 or higher). La extensión instalará automáticamente la primera vez que ejecute un comando az monitor app-insights workbook. Learn more about extensions.

Administre el libro app-insights.

Comandos

Nombre Description Tipo Estado
az monitor app-insights workbook create

Crear un libro.

Extension GA
az monitor app-insights workbook delete

Eliminar un libro.

Extension GA
az monitor app-insights workbook identity

Administrar la idneidad del libro.

Extension GA
az monitor app-insights workbook identity assign

Assign identities.

Extension GA
az monitor app-insights workbook identity remove

Remove identities.

Extension GA
az monitor app-insights workbook list

Enumere todos los libros definidos dentro de un grupo de recursos y una categoría especificados.

Extension GA
az monitor app-insights workbook revision

Administrar la revisión del libro.

Extension GA
az monitor app-insights workbook revision list

Enumere las revisiones del libro.

Extension GA
az monitor app-insights workbook revision show

Mostrar revisión del libro.

Extension GA
az monitor app-insights workbook show

Mostrar un único libro por su nombre de recurso.

Extension GA
az monitor app-insights workbook update

Actualizar un libro.

Extension GA

az monitor app-insights workbook create

Crear un libro.

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]

Ejemplos

Create workbook

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

Parámetros requeridos

--name --resource-name -n

Nombre del recurso del libro. El valor debe ser un UUID.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--category

Categoría del libro, según lo definido por el usuario en el momento de la creación.

Propiedad Valor
Parameter group: Properties Arguments
--description

Descripción del libro.

Propiedad Valor
Parameter group: Properties Arguments
--display-name

Nombre definido por el usuario (nombre para mostrar) del libro.

Propiedad Valor
Parameter group: Properties Arguments
--kind

El tipo de libro. Solo se comparte el valor válido.

Propiedad Valor
Parameter group: WorkbookProperties Arguments
Valores aceptados: shared
--location -l

Ubicación geográfica donde reside el recurso Cuando no se especifica, se usará la ubicación del grupo de recursos.

Propiedad Valor
Parameter group: WorkbookProperties Arguments
--mi-system-assigned

Habilite la identidad asignada por el sistema.

Propiedad Valor
Valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--mi-user-assigned

Identificadores de recursos separados por espacios para agregar identidades asignadas por el usuario. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--serialized-data

Configuración de este libro en particular. Los datos de configuración son una cadena que contiene JSON válido.

Propiedad Valor
Parameter group: Properties Arguments
--source-id

Identificador de recurso de Azure que capturará todos los libros vinculados.

--storage-uri

ResourceId a la cuenta de almacenamiento cuando se usa bring your own storage.

Propiedad Valor
Parameter group: Properties Arguments
--tags

Resource tags. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad Valor
Parameter group: WorkbookProperties Arguments
--version

Formato de versión del esquema del libro, como "Notebook/1.0", que debe coincidir con el libro en serializedData.

Propiedad Valor
Parameter group: Properties Arguments
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az monitor app-insights workbook delete

Eliminar un libro.

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

Ejemplos

Delete workbook

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

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

Propiedad Valor
Parameter group: Resource Id Arguments
--name --resource-name -n

Nombre del recurso del libro. El valor debe ser un UUID.

Propiedad Valor
Parameter group: Resource Id Arguments
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Propiedad Valor
Parameter group: Resource Id Arguments
--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Propiedad Valor
Parameter group: Resource Id Arguments
--yes -y

No solicita confirmación.

Propiedad Valor
Valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az monitor app-insights workbook list

Enumere todos los libros definidos dentro de un grupo de recursos y una categoría especificados.

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]

Ejemplos

List workbook

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

Parámetros requeridos

--category

Categoría del libro que se va a devolver.

Propiedad Valor
Valores aceptados: TSG, performance, retention, workbook

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--can-fetch-content

Marca que indica si se va a devolver o no el contenido completo de cada libro aplicable. Si es false, solo se devuelve el contenido de resumen de los libros.

Propiedad Valor
Valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--max-items

Número total de elementos que se van a devolver en la salida del comando. Si el número total de elementos disponibles es mayor que el valor especificado, se proporciona un token en la salida del comando. Para reanudar la paginación, proporcione el valor del token en --next-token argumento de un comando posterior.

Propiedad Valor
Parameter group: Pagination Arguments
--next-token

Token para especificar dónde iniciar la paginación. Este es el valor del token de una respuesta truncada anteriormente.

Propiedad Valor
Parameter group: Pagination Arguments
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--source-id

Identificador de recurso de Azure que capturará todos los libros vinculados.

--tags

Las etiquetas se presentan en cada libro devuelto. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az monitor app-insights workbook show

Mostrar un único libro por su nombre de recurso.

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]

Ejemplos

Show workbook

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

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--can-fetch-content

Marca que indica si se va a devolver o no el contenido completo de cada libro aplicable. Si es false, solo se devuelve el contenido de resumen de los libros.

Propiedad Valor
Valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

Propiedad Valor
Parameter group: Resource Id Arguments
--name --resource-name -n

Nombre del recurso del libro. El valor debe ser un UUID.

Propiedad Valor
Parameter group: Resource Id Arguments
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Propiedad Valor
Parameter group: Resource Id Arguments
--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Propiedad Valor
Parameter group: Resource Id Arguments
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az monitor app-insights workbook update

Actualizar un libro.

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]

Ejemplos

Update workbook

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

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

Agregue un objeto a una lista de objetos especificando una ruta de acceso y pares clave-valor. Ejemplo: --add property.listProperty <key=value, string or JSON string>.

Propiedad Valor
Parameter group: Generic Update Arguments
--category

Categoría del libro, según lo definido por el usuario en el momento de la creación.

Propiedad Valor
Parameter group: Properties Arguments
--description

Descripción del libro.

Propiedad Valor
Parameter group: Properties Arguments
--display-name

Nombre definido por el usuario (nombre para mostrar) del libro.

Propiedad Valor
Parameter group: Properties Arguments
--force-string

Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.

Propiedad Valor
Parameter group: Generic Update Arguments
Valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

Propiedad Valor
Parameter group: Resource Id Arguments
--kind

El tipo de libro. Solo se comparte el valor válido.

Propiedad Valor
Parameter group: WorkbookProperties Arguments
Valores aceptados: shared
--name --resource-name -n

Nombre del recurso del libro. El valor debe ser un UUID.

Propiedad Valor
Parameter group: Resource Id Arguments
--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list <indexToRemove> O --remove propertyToRemove.

Propiedad Valor
Parameter group: Generic Update Arguments
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Propiedad Valor
Parameter group: Resource Id Arguments
--serialized-data

Configuración de este libro en particular. Los datos de configuración son una cadena que contiene JSON válido.

Propiedad Valor
Parameter group: Properties Arguments
--set

Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=<value>.

Propiedad Valor
Parameter group: Generic Update Arguments
--source-id

Identificador de recurso de Azure que capturará todos los libros vinculados.

--storage-uri

ResourceId a la cuenta de almacenamiento cuando se usa bring your own storage.

Propiedad Valor
Parameter group: Properties Arguments
--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Propiedad Valor
Parameter group: Resource Id Arguments
--tags

Resource tags. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad Valor
Parameter group: WorkbookProperties Arguments
--version

Formato de versión del esquema del libro, como "Notebook/1.0", que debe coincidir con el libro en serializedData.

Propiedad Valor
Parameter group: Properties Arguments
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False