Snabbstart: Skapa en ny Azure API Management-tjänstinstans med hjälp av en ARM-mall

Artikel
2024-11-25

GÄLLER FÖR: Alla API Management-nivåer

Den här snabbstarten beskriver hur du använder en Azure Resource Manager-mall (ARM-mall) för att skapa en Azure API Management-instans. Du kan också använda ARM-mallar för vanliga hanteringsuppgifter som att importera API:er i din API Management-instans.

Azure API Management hjälper organisationer att publicera API:er till externa utvecklare, partner och interna utvecklare för att frigöra potentialen för sina data och tjänster. API Management lägger grunden till ett effektivt API-program genom engagerade utvecklare, affärsinsikter, analyser, hög säkerhet och skydd. Med API Management skapar och hanterar du moderna API-gatewayer för befintliga serverdelstjänster var som helst.

En Azure Resource Manager-mall är en JSON-fil (JavaScript Object Notation) som definierar infrastrukturen och konfigurationen för projektet. Mallen använder deklarativ syntax. Du beskriver den avsedda distributionen utan att skriva sekvensen med programmeringskommandon för att skapa distributionen.

Om din miljö uppfyller förhandskraven och du är van att använda ARM-mallar väljer du knappen Distribuera till Azure. Mallen öppnas på Azure-portalen.

Förutsättningar

Om du inte har någon Azure-prenumeration skapar du ett kostnadsfritt konto innan du börjar.

Granska mallen

Mallen som används i den här snabbstarten kommer från Azure-snabbstartsmallar.

JSON

{
  "$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')]"
      }
    }
  ]
}

Följande resurs definieras i mallen:

Microsoft.ApiManagement/service

Fler azure API Management-mallexempel finns i Azure-snabbstartsmallar.

Distribuera mallen

Välj följande bild för att logga in på Azure och öppna en mall. Mallen skapar en API Management-tjänstinstans med ett automatiskt genererat namn.

I det här exemplet konfigureras instansen på nivån Utvecklare, ett ekonomiskt alternativ för att utvärdera Azure API Management. Den här nivån är inte avsedd för produktionsanvändning. Mer information om att skala API Management-nivåerna finns i avsnittet Uppgradera och skala.
Välj eller ange följande värden.
- Prenumeration: välj en Azure-prenumeration.
- Resursgrupp: välj Skapa ny, ange ett unikt namn för resursgruppen och välj sedan OK.
- Region: välj en plats för resursgruppen. Exempel: USA, centrala.
- E-postadress för utgivare: Ange en e-postadress för att ta emot meddelanden.
- Utgivarens namn: ange ett namn som du väljer för API-utgivaren.
- Sku: acceptera standardvärdet utvecklare. Du kan också välja ett annat värde.
- Antal SKU:er: acceptera standardvärdet.
- Plats: acceptera den genererade platsen för API Management-tjänsten.
Välj Granska + skapa och granska sedan villkoren. Om du godkänner väljer du Skapa.

Tips

Det kan ta mellan 30 och 40 minuter att skapa och aktivera en API Management-tjänst på nivån Utvecklare. Tiderna varierar beroende på nivå.
När instansen har skapats får du ett meddelande:

Azure-portalen används för att distribuera mallen. Förutom Azure Portal kan du använda Azure PowerShell, Azure CLI och REST API. Mer information om andra distributionsmetoder finns i Distribuera mallar.

Granska distribuerade resurser

Använd Azure Portal för att kontrollera de distribuerade resurserna eller använd verktyg som Azure CLI eller Azure PowerShell för att lista de distribuerade resurserna.

I Azure Portal söker du efter och väljer API Management-tjänster och väljer den tjänstinstans som du skapade.
Granska egenskaperna för din tjänst på sidan Översikt .

Översiktssida för tjänst

När din API Management-tjänstinstans är online är du redo att använda den. Börja med självstudien för att importera och publicera ditt första API.

Rensa resurser

Om du planerar att fortsätta arbeta med efterföljande självstudier kanske du vill lämna API Management-instansen på plats. Ta bort resursgruppen när den inte längre behövs, vilket tar bort resurserna i resursgruppen.

I Azure Portal söker du efter och väljer Resursgrupper. Du kan också välja Resursgrupper på startsidan.
På sidan Resursgrupper väljer du din resursgrupp.
På sidan resursgrupp väljer du Ta bort resursgrupp.
Skriv namnet på resursgruppen och välj sedan Ta bort.

Nästa steg

Självstudie: Importera och publicera ditt första API

Dela via