az apic api-analysis

Vista previa

Nota:

Esta referencia forma parte de la extensión apic-extension para la CLI de Azure (versión 2.57.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az apic api-analysis . Obtenga más información sobre las extensiones.

Este grupo de comandos está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Administración de las características de análisis de api del servicio Azure API Center.

Comandos

Nombre	Description	Tipo	Estado
az apic api-analysis create	Cree una configuración de analizador de API nueva o actualice la existente.	Extensión	Versión preliminar
az apic api-analysis delete	Elimina la configuración del analizador de API.	Extensión	Versión preliminar
az apic api-analysis export-ruleset	Exporta el conjunto de reglas del analizador de API.	Extensión	Versión preliminar
az apic api-analysis import-ruleset	Importa el conjunto de reglas del analizador de API.	Extensión	Versión preliminar
az apic api-analysis list	Enumerar las configuraciones del analizador de API.	Extensión	Versión preliminar
az apic api-analysis show	Obtenga detalles de la configuración del analizador de API.	Extensión	Versión preliminar
az apic api-analysis update	Actualice la configuración del analizador de API nuevo o actualice la existente.	Extensión	Versión preliminar

az apic api-analysis create

Vista previa

El grupo de comandos "az apic api-analysis" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Cree una configuración de analizador de API nueva o actualice la existente.

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

Ejemplos

Creación de una configuración de regla de análisis de API

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

Parámetros requeridos

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

Nombre de la configuración.

--resource-group -g

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

--service-name -n

Nombre del servicio Azure API Center.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--description

Descripción de la configuración del analizador.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments

--filter

Filtro del analizador de API. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments

--title

Título de la configuración del analizador, por ejemplo, "Espectral (OpenAPI)".

Propiedad	Valor
Grupo de parámetros:	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

Formato de salida.

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 apic api-analysis delete

Vista previa

El grupo de comandos "az apic api-analysis" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Elimina la configuración del analizador de API.

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

Ejemplos

Eliminación de una configuración de regla de análisis de API

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

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

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

Nombre de la configuración.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--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
Grupo de parámetros:	Resource Id Arguments

--resource-group -g

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

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--service-name -n

Nombre del servicio Azure API Center.

Propiedad	Valor
Grupo de parámetros:	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
Grupo de parámetros:	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

Formato de salida.

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 apic api-analysis export-ruleset

Vista previa

El grupo de comandos "az apic api-analysis" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Exporta el conjunto de reglas del analizador 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]

Ejemplos

Exportación de un conjunto de reglas de análisis de API

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

Parámetros requeridos

--path

Ruta de acceso de carpeta para extraer los archivos del conjunto de reglas.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

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

Nombre de la configuración.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--ids

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--no-wait

No espere a que finalice la operación de ejecución prolongada.

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

--resource-group -g

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

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--service-name -n

Nombre del servicio Azure API Center.

Propiedad	Valor
Grupo de parámetros:	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
Grupo de parámetros:	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

Formato de salida.

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 apic api-analysis import-ruleset

Vista previa

El grupo de comandos "az apic api-analysis" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Importa el conjunto de reglas del analizador 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]

Ejemplos

Importación de un conjunto de reglas de análisis de API

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

Parámetros requeridos

--path

Ruta de acceso de carpeta que contiene los archivos del conjunto de reglas.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

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

Nombre de la configuración.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--ids

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--no-wait

No espere a que finalice la operación de ejecución prolongada.

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

--resource-group -g

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

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--service-name -n

Nombre del servicio Azure API Center.

Propiedad	Valor
Grupo de parámetros:	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
Grupo de parámetros:	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

Formato de salida.

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 apic api-analysis list

Vista previa

El grupo de comandos "az apic api-analysis" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Enumerar las configuraciones del analizador de API.

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

Ejemplos

Enumerar todas las configuraciones de la regla de análisis de API para el servicio

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

Parámetros requeridos

--resource-group -g

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

--service-name -n

Nombre del servicio Azure API Center.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--filter

Parámetro de filtro OData.

--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
Grupo de parámetros:	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
Grupo de parámetros:	Pagination 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

Formato de salida.

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 apic api-analysis show

Vista previa

El grupo de comandos "az apic api-analysis" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Obtenga detalles de la configuración del analizador de API.

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

Ejemplos

Mostrar detalles de una configuración de regla de análisis de API

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

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

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

Nombre de la configuración.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--ids

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--resource-group -g

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

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--service-name -n

Nombre del servicio Azure API Center.

Propiedad	Valor
Grupo de parámetros:	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
Grupo de parámetros:	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

Formato de salida.

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 apic api-analysis update

Vista previa

El grupo de comandos "az apic api-analysis" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Actualice la configuración del analizador de API nuevo o actualice la 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]

Ejemplos

Actualización de una configuración de regla de análisis de API

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

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--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
Grupo de parámetros:	Generic Update Arguments

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

Nombre de la configuración.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--description

Descripción de la configuración del analizador.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments

--filter

Filtro del analizador de API. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments

--force-string

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

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments
Valores aceptados:	0, 1, f, false, n, no, t, true, y, yes

--ids

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--remove

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

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments

--resource-group -g

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

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--service-name -n

Nombre del servicio Azure API Center.

Propiedad	Valor
Grupo de parámetros:	Resource Id 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
Grupo de parámetros:	Generic Update 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
Grupo de parámetros:	Resource Id Arguments

--title

Título de la configuración del analizador, por ejemplo, "Espectral (OpenAPI)".

Propiedad	Valor
Grupo de parámetros:	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

Formato de salida.

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

Comentarios

¿Le ha resultado útil esta página?

Compartir a través de

az apic api-analysis

Comandos

az apic api-analysis create

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apic api-analysis delete

Ejemplos

Parámetros opcionales

az apic api-analysis export-ruleset

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apic api-analysis import-ruleset

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apic api-analysis list

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apic api-analysis show

Ejemplos

Parámetros opcionales

az apic api-analysis update

Ejemplos

Parámetros opcionales

Comentarios