Compartilhar via

az apic api-analysis

  • Versão Prévia

Observação

Essa referência faz parte da extensão apic-extension para a CLI do Azure (versão 2.57.0 ou superior). A extensão instalará automaticamente na primeira vez que você executar um comando az apic api-analysis . Saiba mais sobre extensões.

Esse grupo de comandos está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Gerenciar recursos de análise de API de serviço do Centro de API do Azure.

Comandos

Nome Description Tipo Status
az apic api-analysis create

Crie novas ou atualize a configuração do analisador de API existente.

 Extensão Versão prévia
az apic api-analysis delete

Excluir exclui a configuração do analisador de API.

 Extensão Versão prévia
az apic api-analysis export-ruleset

Exporta o conjunto de regras do analisador de API.

 Extensão Versão prévia
az apic api-analysis import-ruleset

Importa o conjunto de regras do analisador de API.

 Extensão Versão prévia
az apic api-analysis list

Listar configurações do analisador de API.

 Extensão Versão prévia
az apic api-analysis show

Obtenha detalhes da configuração do analisador de API.

 Extensão Versão prévia
az apic api-analysis update

Atualize nova ou atualize a configuração do analisador de API existente.

 Extensão Versão prévia

az apic api-analysis create

Versão Prévia

O grupo de comandos 'az apic api-analysis' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Crie novas ou atualize a configuração do analisador de API existente.

az apic api-analysis create --analyzer-config-name --config-name
                            --resource-group
                            --service-name
                            [--description]
                            [--filter]
                            [--title]

Exemplos

Criar uma configuração de regra de Análise de API

az apic api-analysis create -g contoso-resources -n contoso -c spectral-openapi

Parâmetros Exigidos

--analyzer-config-name --config-name -c

O nome da configuração.

--resource-group -g

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

--service-name -n

O nome do serviço do Centro de API do Azure.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--description

A descrição da configuração do analisador.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--filter

O filtro do analisador de API. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--title

O título da configuração do analisador, por exemplo, "Spectral (OpenAPI)".

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az apic api-analysis delete

Versão Prévia

O grupo de comandos 'az apic api-analysis' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Excluir exclui a configuração do analisador de API.

az apic api-analysis delete [--analyzer-config-name --config-name]
                            [--ids]
                            [--resource-group]
                            [--service-name]
                            [--subscription]
                            [--yes]

Exemplos

Excluir uma configuração de regra de Análise de API

az apic api-analysis delete -g contoso-resources -n contoso -c spectral-openapi

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--analyzer-config-name --config-name -c

O nome da configuração.

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

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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
--service-name -n

O nome do serviço do Centro de API do Azure.

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

Nome ou ID da assinatura. 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 padrão: False
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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

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

Propriedade Valor
Valor padrão: False

az apic api-analysis export-ruleset

Versão Prévia

O grupo de comandos 'az apic api-analysis' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Exporta o conjunto de regras do analisador de API.

az apic api-analysis export-ruleset --path
                                    [--analyzer-config-name --config-name]
                                    [--ids]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--resource-group]
                                    [--service-name]
                                    [--subscription]

Exemplos

Exportar um conjunto de regras de Análise de API

az apic api-analysis export-ruleset -g contoso-resources -n contoso -c spectral-openapi --path '\path\for\output\files'

Parâmetros Exigidos

--path

O caminho da pasta para extrair os arquivos do conjunto de regras.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--analyzer-config-name --config-name -c

O nome da configuração.

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

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--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
--service-name -n

O nome do serviço do Centro de API do Azure.

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

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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

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

Propriedade Valor
Valor padrão: False

az apic api-analysis import-ruleset

Versão Prévia

O grupo de comandos 'az apic api-analysis' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Importa o conjunto de regras do analisador de API.

az apic api-analysis import-ruleset --path
                                    [--analyzer-config-name --config-name]
                                    [--ids]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--resource-group]
                                    [--service-name]
                                    [--subscription]

Exemplos

Importar um conjunto de regras de Análise de API

az apic api-analysis import-ruleset -g contoso-resources -n contoso -c spectral-openapi --path '\path\to\ruleset\folder'

Parâmetros Exigidos

--path

O caminho da pasta que contém os arquivos do conjunto de regras.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--analyzer-config-name --config-name -c

O nome da configuração.

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

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--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
--service-name -n

O nome do serviço do Centro de API do Azure.

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

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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

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

Propriedade Valor
Valor padrão: False

az apic api-analysis list

Versão Prévia

O grupo de comandos 'az apic api-analysis' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Listar configurações do analisador de API.

az apic api-analysis list --resource-group
                          --service-name
                          [--filter]
                          [--max-items]
                          [--next-token]

Exemplos

Listar todas as configurações de regra de Análise de API para o serviço

az apic api-analysis list -g contoso-resources -n contoso

Parâmetros Exigidos

--resource-group -g

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

--service-name -n

O nome do serviço do Centro de API do Azure.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--filter

Parâmetro de filtro OData.

--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 em --next-token argumento de um comando subsequente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
--next-token

Token para especificar onde iniciar a paginação. Esse é o valor do token de uma resposta truncada anteriormente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az apic api-analysis show

Versão Prévia

O grupo de comandos 'az apic api-analysis' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Obtenha detalhes da configuração do analisador de API.

az apic api-analysis show [--analyzer-config-name --config-name]
                          [--ids]
                          [--resource-group]
                          [--service-name]
                          [--subscription]

Exemplos

Mostrar detalhes de uma configuração de regra de Análise de API

az apic api-analysis show -g contoso-resources -n contoso -c spectral-openapi

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--analyzer-config-name --config-name -c

O nome da configuração.

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

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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
--service-name -n

O nome do serviço do Centro de API do Azure.

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

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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

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

Propriedade Valor
Valor padrão: False

az apic api-analysis update

Versão Prévia

O grupo de comandos 'az apic api-analysis' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Atualize nova ou atualize a configuração do analisador de API existente.

az apic api-analysis update [--add]
                            [--analyzer-config-name --config-name]
                            [--description]
                            [--filter]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--ids]
                            [--remove]
                            [--resource-group]
                            [--service-name]
                            [--set]
                            [--subscription]
                            [--title]

Exemplos

Atualizar uma configuração de regra de Análise de API

az apic api-analysis update -g contoso-resources -n contoso -c spectral-openapi

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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 or JSON string>.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--analyzer-config-name --config-name -c

O nome da configuração.

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

A descrição da configuração do analisador.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--filter

O filtro do analisador de API. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--force-string

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

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

Propriedade Valor
Grupo de parâmetros: Generic Update 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
--service-name -n

O nome do serviço do Centro de API do Azure.

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

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--subscription

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

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

O título da configuração do analisador, por exemplo, "Spectral (OpenAPI)".

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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

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

Propriedade Valor
Valor padrão: False