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

Den här snabbstarten beskriver hur du använder en Azure Resource Manager mall (ARM-mall) för att skapa en Azure API Management-tjänstinstans (APIM). APIM hjälper organisationer att publicera API:er till externa partner och interna utvecklare för att frigöra potentialen i 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 APIM kan du skapa och hantera moderna API-gatewayer för befintliga backend-tjänster som finns var som helst. Mer information finns i Översikt.

En ARM-mall är en JSON-fil (JavaScript Object Notation) som definierar infrastrukturen och konfigurationen för ditt projekt. Mallen använder deklarativ syntax. I deklarativ syntax beskriver du din avsedda distribution utan att skriva sekvensen med programmeringskommandon för att skapa den.

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.

Distribuera till Azure

Krav

Om du inte har en Azure-prenumeration kan du skapa ett kostnadsfritt konto innan du börjar.

Granska mallen

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

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "metadata": {
    "_generator": {
      "name": "bicep",
      "version": "0.4.1008.15138",
      "templateHash": "10451446506799526629"
    }
  },
  "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": [
        "Developer",
        "Standard",
        "Premium"
      ],
      "metadata": {
        "description": "The pricing tier of this API Management service"
      }
    },
    "skuCount": {
      "type": "int",
      "defaultValue": 1,
      "allowedValues": [
        1,
        2
      ],
      "metadata": {
        "description": "The instance size of this API Management service."
      }
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]",
      "metadata": {
        "description": "Location for all resources."
      }
    }
  },
  "functions": [],
  "resources": [
    {
      "type": "Microsoft.ApiManagement/service",
      "apiVersion": "2020-12-01",
      "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:

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

Distribuera mallen

  1. 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.

    Distribuera till Azure

    I det här exemplet är instansen konfigurerad på developer-nivån, ett ekonomiskt alternativ för att utvärdera Azure API Management. Den här nivån är inte till för produktionsanvändning. Mer information om att skala API Management-nivåerna finns i avsnittet Uppgradera och skala.

  2. 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.
    • Publisher e-postadress: Ange en e-postadress för att ta emot meddelanden.
    • Publisher namn: Ange ett namn som du väljer för API-utgivaren.
    • SKU: acceptera standardvärdet Developer.
    • Antal SKU:er: acceptera standardvärdet.
    • Plats: acceptera den genererade platsen för API Management tjänsten.

    API Management egenskaper för mall

  3. 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 API Management en tjänst på developer-nivån.

  4. När instansen har skapats får du ett meddelande:

    Distributionsmeddelande

Azure-portalen används för att distribuera mallen. Förutom den här Azure Portal kan du även 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.

  1. I listan Azure Portaldu efter och väljer API Management tjänster och väljer den tjänstinstans som du skapade.
  2. Granska egenskaperna för din tjänst på sidan Översikt.

Översiktssidan för tjänsten

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.

  1. I Azure Portaldu efter och väljer Resursgrupper. Du kan också välja Resursgrupperstartsidan.

  2. På sidan Resursgrupper väljer du din resursgrupp.

  3. På resursgruppssidan väljer du Ta bort resursgrupp.

    Ta bort resursgrupp

  4. Skriv namnet på resursgruppen och välj sedan Ta bort.

Nästa steg