Compartir a través de

az apic api

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

 Extension GA
az apic api definition

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

 Extension GA
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 delete

Elimine la API especificada.

 Extension GA
az apic api deployment

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

 Extension GA
az apic api deployment create

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

 Extension GA
az apic api deployment delete

Eliminar implementación de API.

 Extension GA
az apic api deployment list

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

 Extension GA
az apic api deployment show

Obtenga detalles de la implementación de la API.

 Extension GA
az apic api deployment update

Actualice la implementación de API existente.

 Extension GA
az apic api list

Enumeración de una colección de API.

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

 Extension Preview
az apic api show

Obtenga detalles de la API.

 Extension GA
az apic api update

Actualice la API existente.

 Extension GA
az apic api version

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

 Extension GA
az apic api version create

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

 Extension GA
az apic api version delete

Elimine la versión de API especificada.

 Extension GA
az apic api version list

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

 Extension GA
az apic api version show

Obtenga detalles de la versión de la API.

 Extension GA
az apic api version update

Actualice la versión de API existente.

 Extension 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

Creación de 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}'

Creación de una API con propiedades personalizadas mediante el archivo JSON

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '@customProperties.json'

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.

Propiedad Valor
Grupo de parámetros: Properties Arguments
--type

Tipo de API.

Propiedad Valor
Grupo de parámetros: Properties Arguments
Valores aceptados: graphql, grpc, rest, soap, webhook, websocket

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.

--contacts

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

Propiedad Valor
Grupo de parámetros: Properties Arguments
--custom-properties

Metadatos personalizados definidos para las entidades del catálogo de API. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad Valor
Grupo de parámetros: Properties Arguments
--description

Descripción de la API.

Propiedad Valor
Grupo de parámetros: Properties Arguments
--external-documentation

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

Propiedad Valor
Grupo de parámetros: Properties Arguments
--license

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

Propiedad Valor
Grupo de parámetros: Properties Arguments
--summary

Descripción breve de la 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 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

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

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

Registre la API proporcionando la dirección URL de especificación.

az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.yaml" --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

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.

--environment-id

Identificador del entorno creado antes.

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

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
--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
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 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}'

Actualización de propiedades personalizadas mediante el archivo json

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '@customProperities.json'

Actualización de metadatos personalizados únicos

az apic api update -g contoso-resources -n contoso --api-id echo-api --set customProperties.internal=false

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

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

Propiedad Valor
Grupo de parámetros: Properties Arguments
--custom-properties

Metadatos personalizados definidos para las entidades del catálogo de API. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad Valor
Grupo de parámetros: Properties Arguments
--description

Descripción de la API.

Propiedad Valor
Grupo de parámetros: Properties Arguments
--external-documentation

Documentación adicional externa para la 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

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

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

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

Descripción breve de la API.

Propiedad Valor
Grupo de parámetros: Properties Arguments
--title

Título de la API.

Propiedad Valor
Grupo de parámetros: Properties Arguments
--type

Tipo de API.

Propiedad Valor
Grupo de parámetros: Properties Arguments
Valores aceptados: graphql, grpc, rest, soap, webhook, websocket
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