az apic api

Referencia

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 . Obtenga más información sobre las extensiones.

Comandos para administrar las API en el Centro de API.

Comandos

Nombre	Description	Tipo	Estado
az apic api create	Registre una nueva API o actualice una API existente.	Extensión	GA
az apic api definition	Comandos para administrar definiciones de API en el Centro de API.	Extensión	GA
az apic api definition create	Cree una nueva definición de API o actualice una definición de API existente.	Extensión	GA
az apic api definition delete	Elimine la definición de API especificada.	Extensión	GA
az apic api definition export-specification	Exporta la especificación de API.	Extensión	GA
az apic api definition import-specification	Importa la especificación de la API.	Extensión	GA
az apic api definition list	Enumeración de una colección de definiciones de API.	Extensión	GA
az apic api definition show	Obtenga detalles de la definición de API.	Extensión	GA
az apic api definition update	Actualice la definición de API existente.	Extensión	GA
az apic api delete	Elimine la API especificada.	Extensión	GA
az apic api deployment	Comandos para administrar implementaciones de API en el Centro de API.	Extensión	GA
az apic api deployment create	Cree una nueva implementación de API o actualice una implementación de API existente.	Extensión	GA
az apic api deployment delete	Eliminar implementación de API.	Extensión	GA
az apic api deployment list	Enumeración de una colección de implementaciones de API.	Extensión	GA
az apic api deployment show	Obtenga detalles de la implementación de la API.	Extensión	GA
az apic api deployment update	Actualice la implementación de API existente.	Extensión	GA
az apic api list	Enumeración de una colección de API.	Extensión	GA
az apic api register	Registra una nueva API con la versión, la definición y las implementaciones asociadas mediante el archivo de especificación como origen de verdad. Por ahora solo se admite el formato JSON/YAML de OpenAPI.	Extensión	Vista previa
az apic api show	Obtenga detalles de la API.	Extensión	GA
az apic api update	Actualice la API existente.	Extensión	GA
az apic api version	Comandos para administrar versiones de API en el Centro de API.	Extensión	GA
az apic api version create	Cree una nueva versión de API o actualice una versión de API existente.	Extensión	GA
az apic api version delete	Elimine la versión de API especificada.	Extensión	GA
az apic api version list	Enumeración de una colección de versiones de API.	Extensión	GA
az apic api version show	Obtenga detalles de la versión de la API.	Extensión	GA
az apic api version update	Actualice la versión de API existente.	Extensión	GA

az apic api create

Registre una nueva API o actualice una API existente.

az apic api create --api-id
                   --resource-group
                   --service-name
                   --title
                   --type {graphql, grpc, rest, soap, webhook, websocket}
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--license]
                   [--summary]

Ejemplos

Create API

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST

Creación de una API con propiedades personalizadas

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{"public-facing":true}'

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.

--title

Título de la API.

--type

Tipo de API.

Valores aceptados: graphql, grpc, rest, soap, webhook, websocket

Parámetros opcionales

--contacts

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

--custom-properties

Metadatos personalizados definidos para las entidades del catálogo de API. Admite json-file y yaml-file.

--description

Descripción de la API.

--external-documentation

Documentación adicional externa para la API. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--license

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

--summary

Descripción breve de la API.

Parámetros globales

--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az apic api delete

Elimine la API especificada.

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

Ejemplos

Eliminar API

az apic api delete -g contoso-resources -n contoso --api-id echo-api

Parámetros opcionales

--api-id

Identificador de la API.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). 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".

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

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--yes -y

No solicita confirmación.

Valor predeterminado: False

Parámetros globales

--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az apic api list

Enumeración de una colección de API.

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

Ejemplos

Enumerar LAS API

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

Enumeración de API con filtro

az apic api list -g contoso-resources -n contoso --filter "kind eq 'rest'"

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

--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 el argumento de un comando posterior.

--next-token

Token para especificar dónde iniciar la paginación. Este es el valor del token de una respuesta truncada anteriormente.

Parámetros globales

--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az apic api register

Vista previa

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

Registra una nueva API con la versión, la definición y las implementaciones asociadas mediante el archivo de especificación como origen de verdad. Por ahora solo se admite el formato JSON/YAML de OpenAPI.

az apic api register --api-location
                     --resource-group
                     --service-name
                     [--environment-id]

Ejemplos

Registre la API proporcionando un archivo de especificación.

az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.yml" --environment-id public

Parámetros requeridos

--api-location -l

Ubicación del archivo de especificación.

--resource-group -g

Nombre del grupo de recursos.

--service-name -n

ApiCenter Catalog o Nombre del servicio.

Parámetros opcionales

--environment-id

Identificador del entorno creado antes.

Parámetros globales

--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az apic api show

Obtenga detalles de la API.

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

Ejemplos

Mostrar detalles de la API

az apic api show -g contoso-resources -n contoso --api-id echo-api

Parámetros opcionales

--api-id

Identificador de la API.

--ids

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

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Parámetros globales

--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az apic api update

Actualice la API existente.

az apic api update [--add]
                   [--api-id]
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                   [--ids]
                   [--license]
                   [--remove]
                   [--resource-group]
                   [--service-name]
                   [--set]
                   [--subscription]
                   [--summary]
                   [--title]
                   [--type {graphql, grpc, rest, soap, webhook, websocket}]

Ejemplos

Actualizar API

az apic api update -g contoso-resources -n contoso --api-id echo-api --summary "Basic REST API service"

Actualización de propiedades personalizadas

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '{"public-facing":true}'

Parámetros opcionales

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

--api-id

Identificador de la API.

--contacts

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

--custom-properties

Metadatos personalizados definidos para las entidades del catálogo de API. Admite json-file y yaml-file.

--description

Descripción de la API.

--external-documentation

Documentación adicional externa para la API. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--force-string

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

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

--ids

--license

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

--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list OR --remove propertyToRemove.

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

--set

Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--summary

Descripción breve de la API.

--title

Título de la API.

--type

Tipo de API.

Valores aceptados: graphql, grpc, rest, soap, webhook, websocket

Parámetros globales

--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

Compartir a través de

az apic api

Comandos

az apic api create

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apic api delete

Ejemplos

Parámetros opcionales

az apic api list

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apic api register

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apic api show

Ejemplos

Parámetros opcionales

az apic api update

Ejemplos

Parámetros opcionales

Recursos adicionales