Inicio rápido: Creación de un centro de API - CLI de Azure

Configure el centro de API para iniciar un inventario de las API de la organización. Azure API Center permite realizar un seguimiento de las API en una ubicación centralizada para la detección, reutilización y gobernanza.

Después de crear el centro de API, siga los pasos descritos en los tutoriales para agregar metadatos personalizados, API, versiones, definiciones y otra información.

Requisitos previos

• Si no tiene una suscripción a Azure, cree una cuenta gratuita de Azure antes de empezar.

• Al menos una asignación de roles de colaborador o permisos equivalentes en la suscripción de Azure.

• Para la CLI de Azure:

  • Use el entorno de Bash en Azure Cloud Shell. Para más información, consulte Introducción a Azure Cloud Shell.

    

  • Si prefiere ejecutar comandos de referencia de la CLI localmente, instale la CLI de Azure. Si utiliza Windows o macOS, considere la posibilidad de ejecutar la CLI de Azure en un contenedor Docker. Para más información, vea Ejecución de la CLI de Azure en un contenedor de Docker.

    • Si usa una instalación local, inicie sesión en la CLI de Azure mediante el comando az login. Siga los pasos que se muestran en el terminal para completar el proceso de autenticación. Para ver otras opciones de inicio de sesión, consulte Autenticación en Azure mediante la CLI de Azure.

    • En caso de que se le solicite, instale las extensiones de la CLI de Azure la primera vez que la use. Para obtener más información sobre las extensiones, consulte Uso y administración de extensiones con la CLI de Azure.

    • Ejecute az version para buscar cuál es la versión y las bibliotecas dependientes que están instaladas. Para realizar la actualización a la versión más reciente, ejecute az upgrade.

  Nota:

  Los comandos az apic requieren la extensión apic-extension CLI de Azure. Si no ha usado comandos az apic, la extensión se puede instalar dinámicamente al ejecutar el primer comando az apic o puede instalar la extensión manualmente. Obtenga más información sobre las extensiones de la CLI de Azure.

  Consulte las notas de la versión para conocer los cambios y actualizaciones más recientes de apic-extension. Algunas características podrían requerir una versión preliminar o una versión específica de la extensión.

Registro del proveedor Microsoft.ApiCenter

Si aún no lo ha hecho, registre el proveedor de recursos Microsoft.ApiCenter en su suscripción. Solo se registra el proveedor de recursos una vez.

Para registrar el proveedor de recursos en la suscripción mediante la CLI de Azure, ejecute el siguiente az provider register comando:

az provider register --namespace Microsoft.ApiCenter

Para comprobar el estado de registro, ejecute el siguiente comando az provider show:

az provider show --namespace Microsoft.ApiCenter

Crear un grupo de recursos

Las instancias de Azure API Center, al igual que otros recursos de Azure, se deben implementar en un grupo de recursos. Los grupos de recursos le permiten organizar y administrar los recursos relacionados de Azure.

Cree un grupo de recursos mediante el az group create comando . En el ejemplo siguiente se crea un grupo denominado MyGroup en la ubicación Este de EE. UU.:

az group create --name MyGroup --location eastus

Crear un centro de API

Cree un centro de API mediante el az apic create comando .

En el ejemplo siguiente se crea un centro de API denominado MyApiCenter en el grupo de recursos MyGroup. En este ejemplo, el centro de API se implementa en la ubicación oeste de Europa. Sustituya un nombre del centro de API de su elección y escriba una de las ubicaciones disponibles para el centro de API.

az apic create --name MyApiCenter --resource-group MyGroup --location westeurope

La salida del comando es similar a la siguiente. De manera predeterminada, el centro de API se crea en el plan gratis.

{
  "dataApiHostname": "myapicenter.data.westeurope.azure-apicenter.ms",
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/mygroup/providers/Microsoft.ApiCenter/services/myapicenter",
  "location": "westeurope",
  "name": "myapicenter",
  "resourceGroup": "mygroup",
  "sku": {
    "name": "Free"
  },
  "systemData": {
    "createdAt": "2024-06-22T21:40:35.2541624Z",
    "lastModifiedAt": "2024-06-22T21:40:35.2541624Z"
  },
  "tags": {},
  "type": "Microsoft.ApiCenter/services"
}

Después de la implementación, el centro de API está listo para usarse.

Paso siguiente

Ahora puede empezar a agregar información al inventario en el centro de API. Para ayudarle a organizar las API y otra información, empiece por definir metadatos personalizados en el centro de API.