Partilhar via

az monitor app-insights workbook

  • Referência

Nota

Essa referência faz parte da extensão application-insights para a CLI do Azure (versão 2.55.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az monitor app-insights workbook . Saiba mais sobre extensões.

Gerencie a pasta de trabalho do app-insights.

Comandos

Name Description Tipo Estado
az monitor app-insights workbook create

Crie uma pasta de trabalho.

 Extensão GA
az monitor app-insights workbook delete

Excluir uma pasta de trabalho.

 Extensão GA
az monitor app-insights workbook identity

Gerencie a idneidade da pasta de trabalho.

 Extensão GA
az monitor app-insights workbook identity assign

Atribua identidades.

 Extensão GA
az monitor app-insights workbook identity remove

Remova identidades.

 Extensão GA
az monitor app-insights workbook list

Liste todas as pastas de trabalho definidas dentro de um grupo de recursos e categoria especificados.

 Extensão GA
az monitor app-insights workbook revision

Gerenciar revisão da pasta de trabalho.

 Extensão GA
az monitor app-insights workbook revision list

Liste as revisões para a pasta de trabalho.

 Extensão GA
az monitor app-insights workbook revision show

Mostrar revisão da pasta de trabalho.

 Extensão GA
az monitor app-insights workbook show

Mostrar uma única pasta de trabalho pelo nome do recurso.

 Extensão GA
az monitor app-insights workbook update

Atualizar uma pasta de trabalho.

 Extensão GA

az monitor app-insights workbook create

Crie uma pasta de trabalho.

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]

Exemplos

Criar pasta de trabalho

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 Obrigatórios

--name --resource-name -n

O nome do recurso da pasta de trabalho. O valor deve ser um UUID.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--category

Categoria da pasta de trabalho, conforme definido pelo usuário no momento da criação.

--description

A descrição da pasta de trabalho.

--display-name

O nome definido pelo usuário (nome para exibição) da pasta de trabalho.

--kind

O tipo de pasta de trabalho. Apenas o valor válido é compartilhado.

valores aceites: shared
--location -l

A localização geográfica onde o recurso reside Quando não especificada, a localização do grupo de recursos será usada.

--mi-system-assigned

Habilite a identidade atribuída ao sistema.

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--mi-user-assigned

IDs de recursos separados por espaço para adicionar identidades atribuídas pelo usuário. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--serialized-data

Configuração desta pasta de trabalho específica. Os dados de configuração são uma cadeia de caracteres que contém JSON válido.

--source-id

Id de Recurso do Azure que buscará todas as pastas de trabalho vinculadas.

--storage-uri

O resourceId para a conta de armazenamento quando traz seu próprio armazenamento é usado.

--tags

Tags de recursos. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--version

Formato de versão do esquema da pasta de trabalho, como 'Notebook/1.0', que deve corresponder à pasta de trabalho em serializedData.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az monitor app-insights workbook delete

Excluir uma pasta de trabalho.

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

Exemplos

Excluir pasta de trabalho

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

Parâmetros Opcionais

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name --resource-name -n

O nome do recurso da pasta de trabalho. O valor deve ser um UUID.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--yes -y

Não solicite confirmação.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az monitor app-insights workbook list

Liste todas as pastas de trabalho definidas dentro de um grupo de recursos e categoria 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]

Exemplos

Listar pasta de trabalho

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

Parâmetros Obrigatórios

--category

Categoria de pasta de trabalho a ser retornada.

valores aceites: TSG, performance, retention, workbook

Parâmetros Opcionais

--can-fetch-content

Sinalizador que indica se o conteúdo completo de cada pasta de trabalho aplicável deve ou não ser retornado. Se false, retorne apenas o conteúdo de resumo para pastas de trabalho.

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--max-items

Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token no --next-token argumento de um comando subsequente.

--next-token

Token para especificar por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--source-id

Id de Recurso do Azure que buscará todas as pastas de trabalho vinculadas.

--tags

Tags apresentadas em cada pasta de trabalho retornada. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az monitor app-insights workbook show

Mostrar uma única pasta de trabalho pelo nome do recurso.

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

Exemplos

Mostrar pasta de trabalho

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

Parâmetros Opcionais

--can-fetch-content

Sinalizador que indica se o conteúdo completo de cada pasta de trabalho aplicável deve ou não ser retornado. Se false, retorne apenas o conteúdo de resumo para pastas de trabalho.

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name --resource-name -n

O nome do recurso da pasta de trabalho. O valor deve ser um UUID.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az monitor app-insights workbook update

Atualizar uma pasta de trabalho.

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]

Exemplos

Atualizar pasta de trabalho

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

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string ou JSON string>.

--category

Categoria da pasta de trabalho, conforme definido pelo usuário no momento da criação.

--description

A descrição da pasta de trabalho.

--display-name

O nome definido pelo usuário (nome para exibição) da pasta de trabalho.

--force-string

Ao usar 'set' ou 'add', preserve literais de string em vez de tentar converter para JSON.

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--kind

O tipo de pasta de trabalho. Apenas o valor válido é compartilhado.

valores aceites: shared
--name --resource-name -n

O nome do recurso da pasta de trabalho. O valor deve ser um UUID.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list OR --remove propertyToRemove.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--serialized-data

Configuração desta pasta de trabalho específica. Os dados de configuração são uma cadeia de caracteres que contém JSON válido.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=.

--source-id

Id de Recurso do Azure que buscará todas as pastas de trabalho vinculadas.

--storage-uri

O resourceId para a conta de armazenamento quando traz seu próprio armazenamento é usado.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--tags

Tags de recursos. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--version

Formato de versão do esquema da pasta de trabalho, como 'Notebook/1.0', que deve corresponder à pasta de trabalho em serializedData.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.