Szybki start: tworzenie nowego wystąpienia usługi Azure API Management przy użyciu szablonu usługi ARM
DOTYCZY: Wszystkie warstwy usługi API Management
W tym przewodniku Szybki start opisano sposób użycia szablonu usługi Azure Resource Manager (szablonu usługi ARM) do utworzenia wystąpienia usługi Azure API Management. Szablony usługi ARM można również używać 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.
Szablon usługi Azure Resource Manager to plik JavaScript Object Notation (JSON), który definiuje infrastrukturę i konfigurację projektu. W szablonie używana jest składnia deklaratywna. Możesz opisać zamierzone wdrożenie bez konieczności pisania sekwencji poleceń programowania w celu utworzenia wdrożenia.
Jeśli Twoje środowisko spełnia wymagania wstępne i masz doświadczenie w korzystaniu z szablonów ARM, wybierz przycisk Wdróż na platformie Azure. Szablon zostanie otwarty w witrynie Azure Portal.
Wymagania wstępne
Jeśli nie masz subskrypcji platformy Azure, przed rozpoczęciem utwórz bezpłatne konto.
Przegląd szablonu
Szablon używany w tym przewodniku Szybki start jest jednym z szablonów szybkiego startu platformy Azure.
{
"$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')]"
}
}
]
}
W szablonie zdefiniowano następujący zasób:
Więcej przykładów szablonów usługi Azure API Management można znaleźć w temacie Szablony szybkiego startu platformy Azure.
Wdrażanie szablonu
Wybierz poniższy obraz, aby zalogować się na platformie Azure i otworzyć szablon. Szablon tworzy wystąpienie usługi API Management z automatycznie wygenerowaną nazwą.
W tym przykładzie wystąpienie jest konfigurowane w warstwie Deweloper— ekonomiczna opcja oceny usługi Azure API Management. Ta warstwa nie jest używana w środowisku produkcyjnym. Aby uzyskać więcej informacji na temat skalowania warstw usługi API Management, zobacz Upgrade and scale (Uaktualnianie i skalowanie).
Wybierz lub wprowadź następujące wartości.
- Subskrypcja: wybierz subskrypcję platformy Azure.
- Grupa zasobów: wybierz pozycję Utwórz nową, wprowadź unikatową nazwę grupy zasobów, a następnie wybierz przycisk OK.
- Region: wybierz lokalizację dla grupy zasobów. Przykład: Środkowe stany USA.
- Adres e-mail wydawcy: wprowadź adres e-mail do odbierania powiadomień.
- Nazwa wydawcy: wprowadź nazwę wybraną dla wydawcy interfejsu API.
- Jednostka SKU: zaakceptuj wartość domyślną developera. Alternatywnie wybierz inną wartość.
- Liczba jednostek SKU: zaakceptuj wartość domyślną.
- Lokalizacja: zaakceptuj wygenerowaną lokalizację usługi API Management.
Wybierz pozycję Przejrzyj i utwórz, a następnie przejrzyj warunki i postanowienia. Jeśli zgadzasz się, wybierz pozycję Utwórz.
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.
Po pomyślnym utworzeniu wystąpienia otrzymasz powiadomienie:
Szablon jest wdrażany za pomocą witryny Azure Portal. Oprócz witryny Azure Portal można używać programu Azure PowerShell, interfejsu wiersza polecenia platformy Azure i interfejsu API REST. Aby dowiedzieć się więcej o innych metodach wdrażania, zobacz Wdrażanie szablonów.
Przeglądanie wdrożonych zasobów
Użyj witryny Azure Portal, aby sprawdzić wdrożone zasoby lub użyć narzędzi, takich jak interfejs wiersza polecenia platformy Azure lub program Azure PowerShell, aby wyświetlić listę wdrożonych zasobów.
- W witrynie Azure Portal wyszukaj i wybierz pozycję Usługi API Management, a następnie wybierz utworzone wystąpienie usługi.
- Przejrzyj właściwości usługi na stronie Przegląd .
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.
W witrynie Azure Portal wyszukaj i wybierz pozycję Grupy zasobów. Możesz również wybrać pozycję Grupy zasobów na stronie głównej.
Na stronie Grupy zasobów wybierz grupę zasobów.
Na stronie grupa zasobów wybierz pozycję Usuń grupę zasobów.
Wpisz nazwę grupy zasobów, a następnie wybierz pozycję Usuń.