az apic

Note

This reference is part of the apic-extension extension for the Azure CLI (version 2.57.0 or higher). The extension will automatically install the first time you run an az apic command. Learn more about extensions.

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.	Extension	GA
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 create	Crea una instancia o actualiza una instancia existente de un servicio del Centro de API de Azure.	Extension	GA
az apic delete	Elimina una instancia de un servicio del Centro de API de Azure.	Extension	GA
az apic environment	Comandos para administrar entornos en el Centro de API.	Extension	GA
az apic environment create	Cree un nuevo entorno o actualice un entorno existente.	Extension	GA
az apic environment delete	Se elimina el entorno.	Extension	GA
az apic environment list	Enumerar una colección de entornos.	Extension	GA
az apic environment show	Obtenga detalles del entorno.	Extension	GA
az apic environment update	Actualice el entorno existente.	Extension	GA
az apic import	Administración de servicios del Centro de API de Azure.	Extension	GA
az apic import-from-apim	Importa las API desde una instancia del servicio Azure API Management.	Extension	GA
az apic import aws	Importe un origen de api de Amazon API Gateway.	Extension	Preview
az apic integration	Administra las integraciones en el Centro de API de Azure.	Extension	Preview
az apic integration create	Administración de servicios del Centro de API de Azure.	Extension	Preview
az apic integration create apim	Agregue Azure APIM como origen de API.	Extension	Preview
az apic integration create aws	Agregue Amazon API Gateway como origen de API.	Extension	Preview
az apic integration delete	Elimine el origen de API especificado.	Extension	Preview
az apic integration list	Enumeración de una colección de orígenes de API.	Extension	Preview
az apic integration show	Obtenga detalles del origen de la API.	Extension	Preview
az apic list	Enumera los servicios del Centro de API de Azure dentro de una suscripción de Azure.	Extension	GA
az apic metadata	Comandos para administrar esquemas de metadatos en el Centro de API.	Extension	GA
az apic metadata create	Cree un nuevo esquema de metadatos o actualice un esquema de metadatos existente.	Extension	GA
az apic metadata delete	Elimine el esquema de metadatos especificado.	Extension	GA
az apic metadata export	Exporta el esquema de metadatos.	Extension	GA
az apic metadata list	Enumerar una colección de esquemas de metadatos.	Extension	GA
az apic metadata show	Obtenga detalles del esquema de metadatos.	Extension	GA
az apic metadata update	Actualice el esquema de metadatos existente.	Extension	GA
az apic show	Mostrar detalles de una instancia de servicio del Centro de API de Azure.	Extension	GA
az apic update	Actualice una instancia de un servicio del Centro de API de Azure.	Extension	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 de creación de servicio

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

Ejemplo de creación de servicio con identidad asignada por el sistema

az apic create -g contoso-resources -n contoso -l eastus --identity '{type:systemassigned}'

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Resource tags. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

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

Output format.

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 delete

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

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

Ejemplos

Delete service

az apic delete -n contoso -g contoso-resources

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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
Parameter group:	Resource Id Arguments

--name -n

Nombre del servicio del Centro de API.

Propiedad	Valor
Parameter group:	Resource Id Arguments

--resource-group -g

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

Propiedad	Valor
Parameter group:	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
Parameter group:	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

Output format.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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 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
Parameter group:	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
Parameter group:	Resource Id Arguments

--service-name -n

Nombre del servicio Azure API Center.

Propiedad	Valor
Parameter group:	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
Parameter group:	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

Output format.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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
Parameter group:	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
Parameter group:	Pagination Arguments

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

Output format.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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
Parameter group:	Resource Id Arguments

--name -n

Nombre del servicio del Centro de API.

Propiedad	Valor
Parameter group:	Resource Id Arguments

--resource-group -g

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

Propiedad	Valor
Parameter group:	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
Parameter group:	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

Output format.

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

Ejemplo de actualización del servicio con identidad asignada por el sistema

az apic update -g contoso-resources -n contoso --identity '{type:systemassigned}'

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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
Parameter group:	Generic Update Arguments

--force-string

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

Propiedad	Valor
Parameter group:	Generic Update Arguments
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 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
Parameter group:	Resource Id Arguments

--name -n

Nombre del servicio del Centro de API.

Propiedad	Valor
Parameter group:	Resource Id Arguments

--remove

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

Propiedad	Valor
Parameter group:	Generic Update Arguments

--resource-group -g

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

Propiedad	Valor
Parameter group:	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
Parameter group:	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
Parameter group:	Resource Id Arguments

--tags

Resource tags. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

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

Output format.

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