Compartir a través de

Creación y administración de un área de trabajo en Azure API Management

SE APLICA A: Premium

Configure un área de trabajo para permitir que un equipo de API administre y produzca sus propias API, al tiempo que proporciona al equipo de la plataforma de API las herramientas para observar, controlar y mantener la plataforma de API Management. Después de crear un área de trabajo y asignar permisos, los colaboradores del área de trabajo pueden crear y administrar sus propias API, productos, suscripciones y recursos relacionados.

Nota:

  • Las características más recientes del área de trabajo se admiten en la API de REST de API Management versión 2023-09-01-preview o posterior.
  • Para más consideraciones sobre el precio, consulte Precios de API Management.

Siga los pasos de este artículo para:

  • Crear un área de trabajo de API Management y asociar una puerta de enlace del espacio de trabajo mediante Azure Portal
  • Opcionalmente, aislar la puerta de enlace del espacio de trabajo en una red virtual de Azure
  • Asignar permisos al área de trabajo

Nota:

Requisitos previos

  • Una instancia de API Management Si es necesario, cree una en un nivel admitido.
  • Roles de Propietario o Colaborador en el grupo de recursos donde se implementa la instancia de API Management o permisos equivalentes para crear recursos en el grupo de recursos.
  • (Opcional) Una subred de una red virtual de Azure nueva o existente para aislar el tráfico entrante y saliente de la puerta de enlace del área de trabajo. Para conocer las opciones y los requisitos de configuración, consulte Requisitos de recursos de red para las puertas de enlace del área de trabajo.

Creación de un área de trabajo: portal

  1. Inicie sesión en Azure Portal y vaya a la instancia de API Management.

  2. En el menú de la izquierda, en API, seleccione Áreas de trabajo>+ Agregar.

  3. En la pestaña Datos básicos, escriba un Nombre para mostrar, un Nombre de recurso y una Descripción opcional para el área de trabajo. Seleccione Siguiente.

  4. En la pestaña Puerta de enlace , configure las opciones de la puerta de enlace del área de trabajo.

    Captura de pantalla de la creación de una puerta de enlace de área de trabajo en el portal.

    • Seleccione Crear nuevo para crear una nueva puerta de enlace del área de trabajo o seleccione Usar existente para asociar el área de trabajo a una puerta de enlace existente que tenga otras áreas de trabajo implementadas en ella.

    • Si decide crear una nueva puerta de enlace:

      • En Detalles de la puerta de enlace, introduzca un nuevo nombre de puerta de enlace y seleccione el número de unidades de escala. Los costos de la puerta de enlace se basan en el número de unidades. Para más información, consulte los precios de API Management.

      • En Red, seleccione una Configuración de red para la puerta de enlace del área de trabajo.

        Importante

        Planee cuidadosamente la configuración de red del área de trabajo. No se puede cambiar la configuración de red después de crear el área de trabajo.

      • Si selecciona Acceso público de entrada, acceso privado saliente (integración de red virtual) o Acceso privado de entrada, acceso privado saliente (inyección de red virtual), seleccione una red virtual y subred para aislar la puerta de enlace del área de trabajo o cree una nueva. Para obtener los requisitos de red, consulte Requisitos de recursos de red para las puertas de enlace del área de trabajo.

  5. Seleccione Siguiente. Una vez completada la validación, seleccione Crear.

    Nota:

    La creación de una nueva puerta de enlace del espacio de trabajo, si está seleccionada, puede tardar hasta varias horas en completarse. Para realizar un seguimiento del progreso de la implementación en Azure Portal, vaya al grupo de recursos de la puerta de enlace. En el menú de la izquierda, en Configuración, seleccione Implementaciones.

Una vez completada la implementación, la nueva área de trabajo aparece en la lista de la página Áreas de trabajo. Seleccione el área de trabajo para administrar su configuración y recursos.

Nota:

  • Para ver el nombre de host en el runtime de la puerta de enlace y otros detalles de la puerta de enlace, seleccione el área de trabajo en el portal. En Implementación e infraestructura, seleccione Puertas de enlace y seleccione el nombre de la puerta de enlace del área de trabajo.
  • Mientras se crea la puerta de enlace del espacio de trabajo, las llamadas en tiempo de ejecución a las API del espacio de trabajo no tendrán éxito.

Asignación de usuarios al área de trabajo: portal

Después de crear un área de trabajo, asigne permisos a los usuarios para administrar los recursos que contiene. A cada usuario del espacio de trabajo se le debe asignar tanto un rol RBAC con ámbito de servicio como un rol RBAC con ámbito de espacio de trabajo, o conceder permisos equivalentes mediante roles personalizados.

Para administrar la puerta de enlace del área de trabajo, se recomienda asignar también a los usuarios del área de trabajo un rol RBAC proporcionado por Azure con ámbito a la puerta de enlace del espacio de trabajo.

Nota:

Para facilitar la administración, configure grupos de Microsoft Entra para asignar permisos de área de trabajo a varios usuarios.

Asignación de un rol con ámbito de servicio

  1. Inicie sesión en Azure Portal y vaya a la instancia de API Management.

  2. En el menú izquierdo, seleccione Control de acceso (IAM)>+Agregar.

  3. Asigne uno de los siguientes roles con ámbito de servicio a cada miembro del área de trabajo:

    • Desarrollador de API del entorno del Servicio de Gestión de API
    • Gerente de Productos de API del Espacio de Trabajo del Servicio de Gestión de API

Asignación de un rol con ámbito de área de trabajo

  1. En el menú de la instancia de API Management, en API, seleccione en Áreas de trabajo> el nombre del área de trabajo que creó.

  2. En la ventana Área de trabajo, seleccione Control de acceso (IAM)>+Agregar.

  3. Asigne uno de los siguientes roles de ámbito de área de trabajo a los miembros del área de trabajo para administrar las API del área de trabajo y otros recursos.

    • Lector del área de trabajo de API Management
    • Colaborador del área de trabajo de API Management
    • Desarrollador de API en el Espacio de Trabajo de Gestión de API
    • Administrador de productos de la API del área de trabajo de API Management

Asignación de un rol con ámbito de puerta de enlace

  1. Inicie sesión en Azure Portal y vaya a la instancia de API Management.

  2. En el menú de la izquierda, en API, seleccione en Áreas de trabajo> el nombre del área de trabajo.

  3. En el menú izquierdo del área de trabajo, seleccione Puertas de enlace y seleccione la puerta de enlace del espacio de trabajo.

  4. En el menú izquierdo, seleccione Control de acceso (IAM)>+Agregar.

  5. Asigne uno de los siguientes roles a cada miembro del área de trabajo. Como mínimo, se recomienda asignar el rol Lector para ver la configuración de la puerta de enlace. Los Propietarios y Colaboradores pueden administrar la configuración de la puerta de enlace, incluido el escalado de la puerta de enlace.

    • Propietario
    • Colaborador
    • Lector

Habilitación de la configuración de diagnóstico para supervisar las API del área de trabajo

Configure las opciones para recopilar registros de Azure Monitor para el área de trabajo y enviarlos a un área de trabajo de Log Analytics para que el equipo del área de trabajo pueda supervisar sus propias API, mientras que el equipo de la plataforma de API puede acceder a registros centralizados para la instancia de API Management. Observe el diagrama siguiente:

Diagrama del registro federado en API Management.

Para recopilar registros de Azure Monitor para el área de trabajo, se necesita la configuración de diagnóstico en los niveles de servicio y área de trabajo:

  1. En primer lugar, habilite una configuración de diagnóstico en el nivel de servicio para la recopilación de registros de puerta de enlace de API Management, si aún no está habilitada una configuración. Se recomienda enviar registros a un área de trabajo de Log Analytics. Para obtener más información, consulte Configuración de las opciones de diagnóstico para API Management.

  2. A continuación, habilite una configuración de diagnóstico en el nivel de área de trabajo para enviar registros de puerta de enlace de API Management al mismo área de trabajo de Log Analytics. Esta configuración recopila registros de todas las puertas de enlace del área de trabajo asociadas al área de trabajo.

    Importante

    Una configuración de diagnóstico en el nivel de servicio configura el registro en la instancia de API Management, incluidas las áreas de trabajo que tienen habilitada una configuración de diagnóstico de nivel de área de trabajo. Si no habilita una configuración de diagnóstico de nivel de área de trabajo, los registros de puerta de enlace del área de trabajo no se recopilarán ni agregarán en Log Analytics.

    Nota:

    De forma predeterminada, los miembros del equipo del área de trabajo asignados a los roles RBAC de área de trabajo integrados no tienen permisos para editar la configuración de diagnóstico en un área de trabajo. El equipo de la plataforma de API tiene esos permisos.

Para hacer una configuración de diagnóstico del área de trabajo para la recopilación de registros de puerta de enlace de nivel de área de trabajo:

  1. Inicie sesión en Azure Portal y vaya a la instancia de API Management.

  2. En el menú de la izquierda, en API, seleccione en Áreas de trabajo> el nombre del área de trabajo.

  3. En el menú izquierdo de las áreas de trabajo, en Supervisión, seleccione Configuración> de diagnóstico+ Agregar configuración de diagnóstico.

  4. En la página configuración de diagnóstico, escriba o seleccione los detalles de la configuración:

    1. Nombre de configuración de diagnóstico: escriba un nombre descriptivo.
    2. Grupos de categorías: si lo desea, realice una selección para su escenario.
    3. En Categorías: seleccione Registros relacionados con ApiManagement Gateway para recopilar registros de puerta de enlace para las API de esta área de trabajo.
    4. En Detalles de destino, seleccione para enviar registros al mismo área de trabajo de Azure Log Analytics especificada en la configuración de diagnóstico de nivel de servicio y en otras opciones de diagnóstico de nivel de área de trabajo.
    5. Haga clic en Guardar.

Nota:

  • Actualmente, solo se pueden recopilar registros de puerta de enlace para áreas de trabajo.
  • Acceda a los registros de nivel de área de trabajo; para ello, vaya aRegistros de > en el menú izquierdo del área de trabajo.

Empieza con tu espacio de trabajo

En función de su rol en el área de trabajo, es posible que tenga permisos para crear API, productos, suscripciones y otros recursos, o que tenga acceso de solo lectura a algunos o a todos ellos.

Para empezar a administrar, proteger y publicar API en las áreas de trabajo, consulte la guía siguiente.

Recurso Guía
APIs (Interfaz de Programación de Aplicaciones) Tutorial: Importación y publicación de la primera API
Productos Tutorial: Crear y publicar un producto
Suscripciones Suscripciones en Azure API Management

Creación de suscripciones en API Management
Directivas Tutorial: Transformación y protección de una API

Directivas de Azure API Management

Establecimiento o modificación de directivas de Azure API Management
Valores con nombre Administración de secretos mediante valores con nombre
Sistemas de respaldo Uso de back-end en Azure API Management
Fragmentos de directiva Reutilización de configuraciones de directiva en las definiciones de directiva de API Management
Esquemas Validar contenido
Grupos Creación y uso de grupos para administrar cuentas de desarrollador
Notificaciones Cómo configurar notificaciones y plantillas de notificación

Contenido relacionado