Quickstart: Een nieuw Azure API Management-service-exemplaar maken met behulp van een ARM-sjabloon
VAN TOEPASSING OP: Alle API Management-lagen
In deze quickstart wordt beschreven hoe u een Azure Resource Manager-sjabloon (ARM-sjabloon) gebruikt om een Azure API Management-exemplaar te maken. U kunt ook ARM-sjablonen gebruiken voor algemene beheertaken, zoals het importeren van API's in uw API Management-exemplaar.
Met Azure API Management kunnen organisaties API's publiceren naar externe, partner- en interne ontwikkelaars om het potentieel van hun gegevens en services te ontgrendelen. API Management beschikt over de competenties die belangrijk zijn voor een geslaagd API-programma via ontwikkelaarsbetrokkenheid, zakelijke inzichten, analytische gegevens, beveiliging en bescherming. Met API Management kunt u moderne API-gateways maken en beheren voor bestaande back-endservices die overal worden gehost.
Een Azure Resource Manager-sjabloon is een JSON-bestand (JavaScript Object Notation) dat de infrastructuur en configuratie voor uw project definieert. Voor de sjabloon is declaratieve syntaxis vereist. U beschrijft de beoogde implementatie zonder de reeks programmeeropdrachten te schrijven om de implementatie te maken.
Als uw omgeving voldoet aan de vereisten en u benkend bent met het gebruik van ARM-sjablonen, selecteert u de knop Implementeren naar Azure. De sjabloon wordt in Azure Portal geopend.
Vereisten
Als u geen Azure-abonnement hebt, maakt u een gratis account voordat u begint.
De sjabloon controleren
De sjabloon die in deze quickstart wordt gebruikt, komt uit Azure-snelstartsjablonen.
{
"$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')]"
}
}
]
}
De volgende resource is gedefinieerd in de sjabloon:
In Azure-quickstart-sjablonen vindt u meer voorbeelden van Azure API Management-sjablonen.
De sjabloon implementeren
Selecteer de volgende afbeelding om u aan te melden bij Azure en een sjabloon te openen. Met de sjabloon wordt een API Management service-exemplaar gemaakt met een automatisch gegenereerde naam.
In dit voorbeeld wordt het exemplaar geconfigureerd in de ontwikkelaarslaag, een voordelige optie om Azure API Management te evalueren. Deze laag is niet bedoeld voor productie. Zie bijwerken en schalen voor meer informatie over het schalen van API Management-lagen.
Typ of selecteer de volgende waarden.
- Abonnement: selecteer een Azure-abonnement.
- Resourcegroep: selecteer Nieuwe maken, geef een unieke naam op voor de resourcegroep en selecteer OK.
- Regio: selecteer een locatie voor de resourcegroep. Voorbeeld: VS - centraal.
- E-mail van uitgever: voer een e-mailadres in om meldingen te ontvangen.
- Naam van uitgever: voer een naam in die u voor de API-uitgever hebt gekozen.
- SKU: accepteer de standaardwaarde van Ontwikkelaar. U kunt ook een andere waarde kiezen.
- Aantal SKU's: accepteer de standaardwaarde.
- Locatie: accepteer de gegenereerde locatie voor de API Management-service.
Selecteer Beoordelen + maken en controleer vervolgens de voorwaarden. Als u akkoord gaat, selecteert u Maken.
Tip
Het kan tussen de dertig en veertig minuten duren om een API Management-service in de ontwikkelaarslaag te maken en activeren. Tijden variëren per laag.
Nadat de instantie is gemaakt, krijgt u een melding:
Voor het implementeren van de sjabloon wordt de Azure-portal gebruikt. Naast de Azure-portal kunt u de Azure PowerShell, Azure CLI en REST API gebruiken. Zie Sjablonen implementeren voor meer informatie over andere implementatiemethoden.
Geïmplementeerde resources bekijken
Gebruik de Azure-portal om de geïmplementeerde resources te controleren of gebruik hulpprogramma's zoals Azure CLI of een Azure PowerShell om de geïmplementeerde resources weer te geven.
- In de Azure-portalzoekt en selecteert u API Management-services en selecteert u het service-exemplaar dat u hebt gemaakt.
- Controleer de eigenschappen van uw service op de pagina Overzicht.
Als het API Management-service-exemplaar online is, kunt u het gebruiken. Begin met de zelfstudie om uw eerste API te importeren en publiceren.
Resources opschonen
Als u van plan bent om verder te gaan met de volgende zelfstudies, kunt u het API Management-exemplaar het beste laten staan. Als u de resourcegroep niet meer nodig hebt, verwijdert u deze. Hierdoor worden ook de resources in de resourcegroep verwijderd.
Zoek en selecteer Resourcegroepen in Azure Portal. U kunt ook Resourcegroepen selecteren op de Startpagina.
Selecteer uw resourcegroep op de pagina Resourcegroepen.
Selecteer Resourcegroep verwijderen op de pagina van de resourcegroep.
Typ de naam van uw resourcegroep en selecteer Verwijderen.