az apic

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 . 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.	Extension	GA
az apic api-analysis	Administración de las características de análisis de api del servicio Azure API Center.	Extension	Preview
az apic api-analysis create	Cree una configuración de analizador de API nueva o actualice la existente.	Extension	Preview
az apic api-analysis delete	Elimina la configuración del analizador de API.	Extension	Preview
az apic api-analysis export-ruleset	Exporta el conjunto de reglas del analizador de API.	Extension	Preview
az apic api-analysis import-ruleset	Importa el conjunto de reglas del analizador de API.	Extension	Preview
az apic api-analysis list	Enumerar las configuraciones del analizador de API.	Extension	Preview
az apic api-analysis show	Obtenga detalles de la configuración del analizador de API.	Extension	Preview
az apic api-analysis update	Actualice la configuración del analizador de API nuevo o actualice la existente.	Extension	Preview
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 integration	Administra las integraciones en el Centro de API de Azure.	Extension	GA
az apic integration create	Administración de servicios del Centro de API de Azure.	Extension	GA
az apic integration create apim	Agregue Azure APIM como origen de API.	Extension	GA
az apic integration create aws	Agregue Amazon API Gateway como origen de API.	Extension	GA
az apic integration delete	Elimine el origen de API especificado.	Extension	GA
az apic integration list	Enumeración de una colección de orígenes de API.	Extension	GA
az apic integration show	Obtenga detalles del origen de la API.	Extension	GA
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

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.

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

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

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.

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

--name -n

Nombre del servicio del Centro de API.

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

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

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.

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

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

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

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.

--ids

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--name -n

Nombre del servicio del Centro de API.

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

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

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

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

--identity

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

--ids

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--name -n

Nombre del servicio del Centro de API.

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

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

--tags

Etiquetas de recursos. 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

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

Comandos

az apic create

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apic delete

Ejemplos

Parámetros opcionales

az apic list

Ejemplos

Parámetros opcionales

az apic show

Ejemplos

Parámetros opcionales

az apic update

Ejemplos

Parámetros opcionales

Comentarios