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

W tym przewodniku Szybki start opisano sposób użycia pliku Bicep do utworzenia wystąpienia usługi Azure API Management (APIM). Usługa APIM ułatwia organizacjom publikowanie interfejsów API dla deweloperów zewnętrznych, partnerskich i wewnętrznych w celu odblokowania potencjału ich danych i usług. Usługa API Management zapewnia podstawowe możliwości, które pozwalają na pomyślne programowanie interfejsów API przez zaangażowanych deweloperów, a także udostępnia wgląd w kwestie biznesowe, analizy, zabezpieczenia i ochronę. Usługa APIM umożliwia tworzenie nowoczesnych bram interfejsu API dla istniejących usług zaplecza hostowanych w dowolnym miejscu i zarządzanie nimi. Aby uzyskać więcej informacji, zapoznaj się z omówieniem.

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. Platforma Bicep oferuje najlepsze środowisko tworzenia dla rozwiązań infrastruktury jako kodu na platformie Azure.

Wymagania wstępne

Jeśli nie masz subskrypcji platformy Azure, przed rozpoczęciem utwórz bezpłatne konto.

Przeglądanie pliku 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([
  'Developer'
  'Standard'
  'Premium'
])
param sku string = 'Developer'

@description('The instance size of this API Management service.')
@allowed([
  1
  2
])
param skuCount int = 1

@description('Location for all resources.')
param location string = resourceGroup().location

resource apiManagementService 'Microsoft.ApiManagement/service@2021-08-01' = {
  name: apiManagementServiceName
  location: location
  sku: {
    name: sku
    capacity: skuCount
  }
  properties: {
    publisherEmail: publisherEmail
    publisherName: publisherName
  }
}

Następujący zasób jest zdefiniowany w pliku Bicep:

W tym przykładzie plik Bicep konfiguruje wystąpienie API Management w warstwie Deweloper, co jest ekonomiczną opcją oceny usługi Azure API Management. Ta warstwa nie jest do użytku produkcyjnego.

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

Wdrażanie pliku Bicep

Do wdrożenia pliku Bicep możesz użyć Azure PowerShell lub interfejsu wiersza polecenia platformy Azure. 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. Wdrażanie pliku Bicep przy użyciu interfejsu wiersza polecenia platformy Azure lub 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 nazwę wydawcy> i >, na który będą wysyłane powiadomienia.

    Po zakończeniu wdrażania powinien zostać wyświetlony komunikat informujący o tym, że wdrożenie zakończyło się pomyślnie.

Przeglądanie wdrożonych zasobów

Użyj interfejsu Azure Portal, interfejsu wiersza polecenia platformy Azure lub Azure PowerShell, aby wyświetlić listę App Configuration zasobów w grupie zasobów.

az resource list --resource-group exampleRG

Gdy twoje API Management usługi jest w trybie online, możesz z niego korzystać. Rozpocznij od samouczka, aby zaimportować i opublikować pierwszy interfejs API.

Czyszczenie zasobów

Jeśli planujesz kontynuować pracę z kolejnymi samouczkami, możesz pozostawić wystąpienie API Management na miejscu. Gdy grupa zasobów nie będzie już potrzebna, usuń ją, co spowoduje usunięcie zasobów w grupie zasobów.

az group delete --name exampleRG

Następne kroki