Szybki start: tworzenie nowego wystąpienia usługi Azure API Management przy użyciu Bicep

  • Artykuł

DOTYCZY: Wszystkie warstwy usługi API Management

W tym przewodniku Szybki start opisano sposób użycia pliku Bicep do utworzenia wystąpienia usługi Azure API Management. Można również użyć Bicep do typowych zadań zarządzania, takich jak importowanie interfejsów API w wystąpieniu usługi API Management.

Usługa Azure API Management pomaga organizacjom publikować interfejsy API dla deweloperów zewnętrznych, partnerskich i wewnętrznych w celu odblokowania potencjału swoich danych i usług. Usługa API Management udostępnia podstawowe funkcje wymagane do tworzenia skutecznych interfejsów API przez zaangażowanych deweloperów, a także zapewnia informacje biznesowe, analizy, zabezpieczenia i ochronę. Usługa API Management umożliwia tworzenie nowoczesnych bram interfejsów API i zarządzanie nimi dla istniejących usług zaplecza hostowanych w dowolnym miejscu.

Bicep to język specyficzny dla domeny (DSL), który używa składni deklaratywnej do wdrażania zasobów platformy Azure. Zapewnia zwięzłą składnię, niezawodne bezpieczeństwo typów i obsługę ponownego użycia kodu. Bicep oferuje najlepsze środowisko tworzenia rozwiązań infrastruktury jako kodu na platformie Azure.

Wymagania wstępne

Przejrzyj plik Bicep

Plik Bicep używany w tym przewodniku Szybki start pochodzi z szablonów szybkiego startu platformy 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
  }
}

W pliku Bicep zdefiniowano następujący zasób:

W tym przykładzie plik Bicep domyślnie konfiguruje wystąpienie usługi API Management w warstwie Deweloper— ekonomiczną opcję oceny usługi Azure API Management. Ta warstwa nie jest używana w środowisku produkcyjnym.

Więcej przykładów usługi Azure API Management Bicep można znaleźć w artykule Szablony szybkiego startu platformy Azure.

Wdrażanie pliku Bicep

Aby wdrożyć plik Bicep, możesz użyć interfejsu wiersza polecenia platformy Azure lub programu Azure PowerShell. Aby uzyskać więcej informacji na temat wdrażania plików Bicep, zobacz Wdrażanie.

  1. Zapisz plik Bicep jako main.bicep na komputerze lokalnym.

  2. Wdróż plik Bicep przy użyciu interfejsu wiersza polecenia platformy Azure lub programu 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>

    Zastąp <ciąg publisher-name> i <publisher-email> nazwą organizacji wydawcy interfejsu API oraz adresem e-mail, aby otrzymywać powiadomienia.

    Po zakończeniu wdrażania powinien zostać wyświetlony komunikat informujący o pomyślnym wdrożeniu.

    Napiwek

    Utworzenie i aktywowanie usługi API Management w warstwie Deweloper może potrwać od 30 do 40 minut. Czasy różnią się w zależności od warstwy.

Przeglądanie wdrożonych zasobów

Użyj witryny Azure Portal, interfejsu wiersza polecenia platformy Azure lub programu Azure PowerShell, aby wyświetlić listę wdrożonego zasobu usługi App Configuration w grupie zasobów.

az resource list --resource-group exampleRG

Gdy wystąpienie usługi API Management jest w trybie online, możesz go użyć. Zacznij od samouczka, aby zaimportować i opublikować swój pierwszy interfejs API.

Czyszczenie zasobów

Jeśli planujesz kontynuować pracę z kolejnymi samouczkami, możesz pozostawić wystąpienie usługi API Management w miejscu. Gdy grupa zasobów nie będzie już potrzebna, usuń grupę zasobów, która usuwa zasoby w grupie zasobów.

az group delete --name exampleRG

Następne kroki

Samouczek: importowanie i publikowanie pierwszego interfejsu API