Inicio rápido: Creación de una instancia del servicio API Management mediante una plantilla de Resource Manager
SE APLICA A: todos los niveles de API Management
En este inicio rápido se describe cómo usar una plantilla de Azure Resource Manager para crear una instancia de Azure API Management. También puede usar plantillas de ARM 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.
Una plantilla de Azure Resource Manager es un archivo de notación de objetos JavaScript (JSON) que define tanto la infraestructura como la configuración de un proyecto. La plantilla usa sintaxis declarativa. Se describe la implementación deseada sin escribir la secuencia de comandos de programación para crear la implementación.
Si su entorno cumple los requisitos previos y está familiarizado con el uso de plantillas de Resource Manager, seleccione el botón Implementar en Azure. La plantilla se abrirá en Azure Portal.
Requisitos previos
Si no tiene una suscripción a Azure, cree una cuenta gratuita antes de empezar.
Revisión de la plantilla
La plantilla usada en este inicio rápido forma parte de las plantillas de inicio rápido de Azure.
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.26.54.24096",
"templateHash": "15176578550391235821"
}
},
"parameters": {
"apiManagementServiceName": {
"type": "string",
"defaultValue": "[format('apiservice{0}', uniqueString(resourceGroup().id))]",
"metadata": {
"description": "The name of the API Management service instance"
}
},
"publisherEmail": {
"type": "string",
"minLength": 1,
"metadata": {
"description": "The email address of the owner of the service"
}
},
"publisherName": {
"type": "string",
"minLength": 1,
"metadata": {
"description": "The name of the owner of the service"
}
},
"sku": {
"type": "string",
"defaultValue": "Developer",
"allowedValues": [
"Consumption",
"Developer",
"Basic",
"Basicv2",
"Standard",
"Standardv2",
"Premium"
],
"metadata": {
"description": "The pricing tier of this API Management service"
}
},
"skuCount": {
"type": "int",
"defaultValue": 1,
"allowedValues": [
0,
1,
2
],
"metadata": {
"description": "The instance size of this API Management service."
}
},
"location": {
"type": "string",
"defaultValue": "[resourceGroup().location]",
"metadata": {
"description": "Location for all resources."
}
}
},
"resources": [
{
"type": "Microsoft.ApiManagement/service",
"apiVersion": "2023-05-01-preview",
"name": "[parameters('apiManagementServiceName')]",
"location": "[parameters('location')]",
"sku": {
"name": "[parameters('sku')]",
"capacity": "[parameters('skuCount')]"
},
"properties": {
"publisherEmail": "[parameters('publisherEmail')]",
"publisherName": "[parameters('publisherName')]"
}
}
]
}
El siguiente recurso se define en la plantilla:
Puede encontrar más ejemplos de plantillas de API Management en Plantillas de inicio rápido de Azure.
Implementación de la plantilla
Seleccione la imagen siguiente para iniciar sesión en Azure y abrir una plantilla. La plantilla crea una instancia del servicio API Management con un nombre generado automáticamente.
En este ejemplo, la instancia se configura en el nivel de desarrollador, una opción económica para evaluar Azure API Management. Este nivel no puede utilizarse en producción. Para más información sobre el escalado de los niveles de API Management, consulte Actualización y escalado.
Seleccione o escriba los siguientes valores.
- Suscripción: seleccione una suscripción de Azure.
- Grupo de recursos: seleccione Crear nuevo, escriba un nombre único para el grupo de recursos y, después, seleccione Aceptar.
- Región: seleccione la ubicación del grupo de recursos. Ejemplo: Centro de EE. UU. .
- Publisher Email (Dirección de correo del editor): escriba una dirección de correo electrónico donde recibir las notificaciones.
- Publisher Name (Nombre del editor): escriba un nombre para el editor de la API.
- SKU: acepte el valor predeterminado de Developer (Desarrollador). Como alternativa, elige otro valor.
- Sku Count (Número de SKU): acepte el valor predeterminado.
- Location (Ubicación): acepte la ubicación generada para el servicio API Management.
Seleccione Revisar y crear y revise los términos y condiciones. Si está de acuerdo, seleccione Crear.
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.
Cuando la instancia se haya creado correctamente, recibirá una notificación:
Azure Portal se usa para implementar la plantilla. Además de Azure Portal, también puede usar Azure PowerShell, la CLI de Azure y API REST. Para obtener información sobre otros métodos de implementación, consulte Implementación de plantillas.
Revisión de los recursos implementados
Use Azure Portal para comprobar los recursos implementados, o utilice herramientas, como la CLI de Azure o Azure PowerShell, para enumerar los recursos implementados.
- En Azure Portal, busque y seleccione Servicios API Management, y seleccione la instancia de servicio que ha creado.
- Revise las propiedades del servicio en la página de información general.
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.
En Azure Portal, busque la opción Grupos de recursos y selecciónela. También puede seleccionar Grupos de recursos en la página principal.
En la página Grupos de recursos, seleccione el grupo de recursos.
En la página del grupo de recursos, seleccione Eliminar grupo de recursos.
Escriba el nombre del grupo de recursos y, después, seleccione Eliminar.