az apic

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

Administración de servicios del Centro de API de Azure.

Comandos

Nombre Description Tipo Estado
az apic api

Comandos para administrar las API en el Centro de API.

 Extensión GA
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 create

Crea una instancia o actualiza una instancia existente de un servicio del Centro de API de Azure.

 Extensión GA
az apic delete

Elimina una instancia de un servicio del Centro de API de Azure.

 Extensión GA
az apic environment

Comandos para administrar entornos en el Centro de API.

 Extensión GA
az apic environment create

Cree un nuevo entorno o actualice un entorno existente.

 Extensión GA
az apic environment delete

Se elimina el entorno.

 Extensión GA
az apic environment list

Enumerar una colección de entornos.

 Extensión GA
az apic environment show

Obtenga detalles del entorno.

 Extensión GA
az apic environment update

Actualice el entorno existente.

 Extensión GA
az apic import-from-apim

Importa las API desde una instancia del servicio Azure API Management.

 Extensión GA
az apic list

Enumera los servicios del Centro de API de Azure dentro de una suscripción de Azure.

 Extensión GA
az apic metadata

Comandos para administrar esquemas de metadatos en el Centro de API.

 Extensión GA
az apic metadata create

Cree un nuevo esquema de metadatos o actualice un esquema de metadatos existente.

 Extensión GA
az apic metadata delete

Elimine el esquema de metadatos especificado.

 Extensión GA
az apic metadata export

Exporta el esquema de metadatos.

 Extensión GA
az apic metadata list

Enumerar una colección de esquemas de metadatos.

 Extensión GA
az apic metadata show

Obtenga detalles del esquema de metadatos.

 Extensión GA
az apic metadata update

Actualice el esquema de metadatos existente.

 Extensión GA
az apic show

Mostrar detalles de una instancia de servicio del Centro de API de Azure.

 Extensión GA
az apic update

Actualice una instancia de un servicio del Centro de API de Azure.

 Extensión GA

az apic create

Crea una instancia o actualiza una instancia existente de un servicio del Centro de API de Azure.

az apic create --name
               --resource-group
               [--identity]
               [--location]
               [--tags]

Ejemplos

Ejemplo 1 de creación de servicio

az apic create -g contoso-resources -n contoso -l eastus

Ejemplo 2 de creación de servicio

az apic create --resource-group contoso-resources --name contoso --location eastus

Parámetros requeridos

--name -n

Nombre del servicio del Centro de API.

--resource-group -g

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

Parámetros opcionales

--identity

Identidades de servicio administradas asignadas a este recurso. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--location -l

Ubicación geográfica donde reside el recurso Cuando no se especifica, se usará la ubicación del grupo de recursos.

--tags

Etiquetas del recurso. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

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 delete

Elimina una instancia de un servicio del Centro de API de Azure.

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

Ejemplos

Eliminar servicio

az apic delete -n contoso -g contoso-resources

Parámetros opcionales

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

--name -n

Nombre del servicio del Centro de API.

--resource-group -g

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

--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 import-from-apim

Importa las API desde una instancia del servicio Azure API Management.

az apic import-from-apim --apim-apis
                         --apim-name
                         [--apim-resource-group]
                         [--apim-subscription]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--resource-group]
                         [--service-name]
                         [--subscription]

Ejemplos

Importación de todas las API desde APIM en el mismo grupo de recursos

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis *

Importación de API seleccionadas de APIM en el mismo grupo de recursos

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis [echo,foo]

Importación de todas las API de APIM en otra suscripción y grupo de recursos

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-subscription 00000000-0000-0000-0000-000000000000 --apim-resource-group apim-rg --apim-name contoso-apim --apim-apis *

Parámetros requeridos

--apim-apis

Las API que se van a importar. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--apim-name

Nombre de la instancia de APIM de origen.

Parámetros opcionales

--apim-resource-group

El grupo de recursos de la instancia de APIM de origen.

--apim-subscription

Identificador de suscripción de la instancia de APIM de origen.

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

--no-wait

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

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

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

Enumera los servicios del Centro de API de Azure dentro de una suscripción de Azure.

Hay un problema conocido que indica que no funciona la enumeración de todos los recursos de una suscripción. Enumere los recursos por grupo de recursos.

az apic list [--max-items]
             [--next-token]
             [--resource-group]

Ejemplos

Enumeración de servicios en el grupo de recursos

az apic list -g contoso-resources

Parámetros opcionales

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

--resource-group -g

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

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 show

Mostrar detalles de una instancia de servicio del Centro de API de Azure.

az apic show [--ids]
             [--name]
             [--resource-group]
             [--subscription]

Ejemplos

Mostrar detalles del servicio

az apic show -g contoso-resources -n contoso

Parámetros opcionales

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

--name -n

Nombre del servicio del Centro de API.

--resource-group -g

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

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

Actualice una instancia de un servicio del Centro de API de Azure.

az apic update [--add]
               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
               [--identity]
               [--ids]
               [--name]
               [--remove]
               [--resource-group]
               [--set]
               [--subscription]
               [--tags]

Ejemplos

Actualizar los detalles del servicio

az apic update -g contoso-resources -n contoso

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

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

Identidades de servicio administradas asignadas a este recurso. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

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

--name -n

Nombre del servicio del Centro de API.

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

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

--tags

Etiquetas del recurso. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

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.