az monitor app-insights api-key

Note

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

Operações em chaves de API associadas a um componente do Application Insights.

Comandos

Nome Descrição Tipo Estado
az monitor app-insights api-key create

Crie uma chave de API de um componente do Application Insights.

Extension disponibilidade geral
az monitor app-insights api-key delete

Exclua uma chave de API de um recurso do Application Insights.

Extension disponibilidade geral
az monitor app-insights api-key show

Obtenha todas as chaves ou uma chave de API específica associada a um recurso do Application Insights.

Extension disponibilidade geral

az monitor app-insights api-key create

Crie uma chave de API de um componente do Application Insights.

az monitor app-insights api-key create --api-key
                                       --app
                                       --resource-group
                                       [--acquire-policy-token]
                                       [--change-reference]
                                       [--read-properties]
                                       [--write-properties]

Exemplos

Crie um componente com tipo web e localização.

az monitor app-insights api-key create --api-key cli-demo --read-properties ReadTelemetry --write-properties WriteAnnotations -g demoRg --app testApp

Crie um componente com tipo web e localização sem qualquer permissão

az monitor app-insights api-key create --api-key cli-demo --read-properties '""' --write-properties '""' -g demoRg --app testApp

Parâmetros Obrigatórios

--api-key

Nome da chave de API a ser criada.

--app -a

GUID, nome da aplicação ou nome de recurso Azure totalmente qualificado do componente Application Insights. O GUID da aplicação pode ser adquirido a partir do elemento do menu API Access em qualquer recurso Application Insights no portal Azure. Se estiver usando um nome de aplicativo, especifique o grupo de recursos.

--resource-group -g

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--read-properties

Uma lista separada por espaços de nomes de funções lidas para essa chave de API herdar. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--write-properties

Uma lista separada por espaços de nomes de funções de gravação para essa chave de API herdar. 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.

Propriedade Valor
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Valor predefinido: False

az monitor app-insights api-key delete

Exclua uma chave de API de um recurso do Application Insights.

az monitor app-insights api-key delete [--acquire-policy-token]
                                       [--api-key]
                                       [--app]
                                       [--change-reference]
                                       [--ids]
                                       [--resource-group]
                                       [--subscription]
                                       [--yes]

Exemplos

Exclua a chave da API.

az monitor app-insights api-key delete --app demoApp -g demoRg --api-key demo-key

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--api-key

Nome da chave de API a ser excluída. Pode ser encontrado usando api-key show.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--app -a

GUID, nome da aplicação ou nome de recurso Azure totalmente qualificado do componente Application Insights. O GUID da aplicação pode ser adquirido a partir do elemento do menu API Access em qualquer recurso Application Insights no portal Azure. Se estiver usando um nome de aplicativo, especifique o grupo de recursos.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--yes -y

Não solicite confirmação.

Propriedade Valor
Valor predefinido: False
Parâmetros de Globais
--debug

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

Propriedade Valor
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Valor predefinido: False

az monitor app-insights api-key show

Obtenha todas as chaves ou uma chave de API específica associada a um recurso do Application Insights.

az monitor app-insights api-key show --app
                                     --resource-group
                                     [--api-key]

Exemplos

Buscar chave de API.

az monitor app-insights api-key show --app demoApp -g demoRg --api-key demo-key

Buscar chaves de API.

az monitor app-insights api-key show --app demoApp -g demoRg

Parâmetros Obrigatórios

--app -a

O nome do recurso do componente Application Insights.

--resource-group -g

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--api-key

Nome da chave da API a ser buscada. Pode ser encontrado usando api-key show.

Parâmetros de Globais
--debug

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

Propriedade Valor
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Valor predefinido: False