Nota
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
SE APLICA A: todos los niveles de API Management
En este inicio rápido se describe cómo usar un archivo de Bicep para crear una instancia de Azure API Management. También puede usar Bicep para tareas comunes de administración, como importar API en la instancia de API Management.
Azure API Management ayuda a las organizaciones a publicar API para desarrolladores externos, asociados e internos para liberar el potencial de sus datos y servicios. API Management proporciona las competencias esenciales para garantizar un programa de API de éxito mediante compromisos con desarrolladores, información detallada empresarial, análisis, seguridad y protección. Con API Management, cree y administre puertas de enlace de API modernas para los servicios back-end existentes hospedados en cualquier lugar.
Bicep es un lenguaje específico de dominio (DSL) que usa una sintaxis declarativa para implementar recursos de Azure. Brinda sintaxis concisa, seguridad de tipos confiable y compatibilidad con la reutilización de código. Bicep ofrece la mejor experiencia de creación para sus soluciones de infraestructura como código en Azure.
Requisitos previos
Si no tiene una suscripción a Azure, cree una cuenta gratuita antes de empezar.
Para la CLI de Azure:
Use el entorno de Bash en Azure Cloud Shell. Para más información, consulte Inicio rápido para Bash en 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 Inicio de sesión con 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 más información sobre las extensiones, consulte Uso 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.
Para Azure PowerShell:
- Si opta por usar Azure PowerShell en un entorno local:
- Instale la versión más reciente del módulo Az de PowerShell.
- Conéctese a su cuenta de Azure mediante el cmdlet Connect-AzAccount.
- Si decide usar Azure Cloud Shell:
- Para más información, consulte Introducción a Azure Cloud Shell.
- Si opta por usar Azure PowerShell en un entorno local:
Revisión del archivo de Bicep
El archivo de Bicep usado en este inicio rápido forma parte de las plantillas de inicio rápido de Azure.
@description('The name of the API Management service instance')
param apiManagementServiceName string = 'apiservice${uniqueString(resourceGroup().id)}'
@description('The email address of the owner of the service')
@minLength(1)
param publisherEmail string
@description('The name of the owner of the service')
@minLength(1)
param publisherName string
@description('The pricing tier of this API Management service')
@allowed([
'Consumption'
'Developer'
'Basic'
'Basicv2'
'Standard'
'Standardv2'
'Premium'
])
param sku string = 'Developer'
@description('The instance size of this API Management service.')
@allowed([
0
1
2
])
param skuCount int = 1
@description('Location for all resources.')
param location string = resourceGroup().location
resource apiManagementService 'Microsoft.ApiManagement/service@2023-05-01-preview' = {
name: apiManagementServiceName
location: location
sku: {
name: sku
capacity: skuCount
}
properties: {
publisherEmail: publisherEmail
publisherName: publisherName
}
}
El siguiente recurso se define en el archivo de Bicep:
En este ejemplo, el archivo Bicep configura de forma predeterminada la instancia de API Management en el nivel de desarrollador, una opción económica para evaluar Azure API Management. Este nivel no puede utilizarse en producción.
Puede encontrar más muestras de Azure API Management Bicep en plantillas de inicio rápido de Azure.
Implementación del archivo de Bicep
Puede usar la CLI de Azure o Azure PowerShell para implementar el archivo Bicep. Para más información sobre la implementación de archivos Bicep, consulte Implementación.
Guarde el archivo de Bicep como main.bicep en el equipo local.
Implemente el archivo de Bicep mediante la CLI de Azure o Azure PowerShell.
az group create --name exampleRG --location eastus az deployment group create --resource-group exampleRG --template-file main.bicep --parameters publisherEmail=<publisher-email> publisherName=<publisher-name>Reemplace el <nombre del editor> y el <correo electrónico del editor> con el nombre de la organización del editor de la API y la dirección de correo electrónico para recibir notificaciones.
Una vez finalizada la implementación, debería mostrarse un mensaje indicando que la implementación se realizó correctamente.
Sugerencia
Normalmente, la creación y activación de una instancia del servicio API Management en el nivel de desarrollador tarda entre 30 y 40 minutos. Las horas varían según el nivel.
Revisión de los recursos implementados
Use Azure Portal, la CLI de Azure o Azure PowerShell para enumerar el recurso de Azure App Configuration implementado en el grupo de recursos.
az resource list --resource-group exampleRG
Cuando la instancia de servicio de API Management está en línea, está listo para usarla. Comience con el tutorial Importación y publicación de la primera API.
Limpieza de recursos
Si tiene previsto seguir trabajando con los tutoriales siguientes, podría conservar la instancia de API Management. Cuando ya no lo necesite, elimine el grupo de recursos, que elimina los recursos que contiene.
az group delete --name exampleRG