az apic api definition

Note

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 se instalará automáticamente la primera vez que ejecute un comando az apic api definition. Obtenga más información sobre las extensiones.

Comandos para administrar definiciones de API en el Centro de API.

Comandos

Nombre	Description	Tipo	Estado
az apic api definition create	Cree una nueva definición de API o actualice una definición de API existente.	Extension	GA
az apic api definition delete	Elimine la definición de API especificada.	Extension	GA
az apic api definition export-specification	Exporta la especificación de API.	Extension	GA
az apic api definition import-specification	Importa la especificación de la API.	Extension	GA
az apic api definition list	Enumeración de una colección de definiciones de API.	Extension	GA
az apic api definition show	Obtenga detalles de la definición de API.	Extension	GA
az apic api definition update	Actualice la definición de API existente.	Extension	GA

az apic api definition create

Cree una nueva definición de API o actualice una definición de API existente.

az apic api definition create --api-id
                              --definition-id
                              --resource-group
                              --service-name
                              --title
                              --version-id
                              [--description]

Ejemplos

Creación de una definición de API

az apic api definition create -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"

Parámetros requeridos

--api-id

Identificador de la API.

--definition-id

Identificador de la definición de API.

--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.

--title

Versión de la API.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments

--version-id

Identificador de la versión de la API.

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 definición de API.

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 definition delete

Elimine la definición de API especificada.

az apic api definition delete [--api-id]
                              [--definition-id]
                              [--ids]
                              [--resource-group]
                              [--service-name]
                              [--subscription]
                              [--version-id]
                              [--yes]

Ejemplos

Eliminar definición de API

az apic api definition delete -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "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.

--api-id

Identificador de la API.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--definition-id

Identificador de la definición de API.

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

--version-id

Identificador de la versión de la API.

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 definition export-specification

Exporta la especificación de API.

az apic api definition export-specification --file-name
                                            [--api-id]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service-name]
                                            [--subscription]
                                            [--version-id]

Ejemplos

Especificación de exportación

az apic api definition export-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id default --file-name filename.json

Parámetros requeridos

--file-name

Nombre del archivo en el que se va a exportar la especificación.

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.

--api-id

Identificador de la API.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--definition-id

Identificador de la definición de API.

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

--version-id

Identificador de la versión de la API.

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 definition import-specification

Importa la especificación de la API.

az apic api definition import-specification --format {inline, link}
                                            --specification
                                            --value
                                            [--api-id]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service-name]
                                            [--subscription]
                                            [--version-id]

Ejemplos

Ejemplo de especificación de importación 1

az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api-2 --version-id 2023-08-01 --definition-id openapi3 --format "inline" --value '{"openapi":"3.0.1","info":{"title":"httpbin.org","description":"API Management facade for a very handy and free online HTTP tool.","version":"1.0"}}' --specification '{"name":"openapi","version":"3.0.0"}'

Ejemplo de especificación de importación 2

az apic api definition import-specification -g api-center-test -n contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://petstore3.swagger.io/api/v3/openapi.json' --specification '{"name":"openapi","version":"3.0.0"}'

Ejemplo de importación de especificación de archivo

az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-08-01 --definition-id openapi --format "inline" --value '@petstore.json'

Parámetros requeridos

--format

Formato del origen de la especificación de API.

Propiedad	Valor
Grupo de parámetros:	Payload Arguments
Valores aceptados:	inline, link

--specification

Detalles de la especificación de API. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad	Valor
Grupo de parámetros:	Payload Arguments

--value

Valor del origen de la especificación de API.

Propiedad	Valor
Grupo de parámetros:	Payload Arguments

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.

--api-id

Identificador de la API.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--definition-id

Identificador de la definición de API.

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

--version-id

Identificador de la versión de la API.

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 definition list

Enumeración de una colección de definiciones de API.

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

Ejemplos

Enumerar definiciones de API

az apic api definition list -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01

Parámetros requeridos

--api-id

Identificador de la API.

--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.

--version-id

Identificador de la versión de la API.

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 definition show

Obtenga detalles de la definición de API.

az apic api definition show [--api-id]
                            [--definition-id]
                            [--ids]
                            [--resource-group]
                            [--service-name]
                            [--subscription]
                            [--version-id]

Ejemplos

Mostrar detalles de definición de API

az apic api definition show -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "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.

--api-id

Identificador de la API.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--definition-id

Identificador de la definición de API.

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

--version-id

Identificador de la versión de la API.

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 definition update

Actualice la definición de API existente.

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

Ejemplos

Actualización de la definición de API

az apic api definition update -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "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

--api-id

Identificador de la API.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--definition-id

Identificador de la definición de API.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--description

Descripción de la definición de API.

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 versión de la API.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments

--version-id

Identificador de la versión de la API.

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

Comentarios

¿Le ha resultado útil esta página?

Compartir a través de

az apic api definition

Comandos

az apic api definition create

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apic api definition delete

Ejemplos

Parámetros opcionales

az apic api definition export-specification

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apic api definition import-specification

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apic api definition list

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apic api definition show

Ejemplos

Parámetros opcionales

az apic api definition update

Ejemplos

Parámetros opcionales

Comentarios