Szybki start: tworzenie nowego wystąpienia usługi Azure API Management przy użyciu programu PowerShell
DOTYCZY: Zużycie | Deweloper | Podstawowa | Standardowa | Premium
W tym przewodniku Szybki start utworzysz nowe wystąpienie usługi API Management przy użyciu poleceń cmdlet programu Azure PowerShell. Po utworzeniu wystąpienia można użyć poleceń cmdlet programu Azure PowerShell do typowych akcji 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.
Jeśli nie masz subskrypcji platformy Azure, przed rozpoczęciem utwórz bezpłatne konto platformy Azure.
Wymagania wstępne
- Jeśli zdecydujesz się używać programu Azure PowerShell lokalnie:
- Zainstaluj najnowszą wersję modułu Az programu PowerShell.
- Połączenie do konta platformy Azure przy użyciu polecenia cmdlet Połączenie-AzAccount.
- Jeśli zdecydujesz się używać usługi Azure Cloud Shell:
- Aby uzyskać więcej informacji, zobacz Omówienie usługi Azure Cloud Shell .
Utwórz grupę zasobów
Utwórz grupę zasobów platformy Azure za pomocą polecenia New-AzResourceGroup. Grupa zasobów to logiczny kontener przeznaczony do wdrażania zasobów platformy Azure i zarządzania nimi.
Następujące polecenie tworzy grupę zasobów o nazwie myResourceGroup w lokalizacji Zachodnie stany USA:
New-AzResourceGroup -Name myResourceGroup -Location WestUS
Tworzenie wystąpienia usługi API Management
Teraz, gdy masz grupę zasobów, możesz utworzyć wystąpienie usługi API Management. Utwórz je przy użyciu polecenia New-AzApiManagement i podaj nazwę usługi i szczegóły wydawcy. Nazwa usługi musi być unikatowa na platformie Azure.
W poniższym przykładzie myapim jest używany dla nazwy usługi. Zaktualizuj nazwę na unikatową wartość. Ponadto zaktualizuj nazwę organizacji wydawcy interfejsu API i adres e-mail administratora, aby otrzymywać powiadomienia.
Domyślnie polecenie tworzy wystąpienie w warstwie Deweloper— ekonomiczną opcję oceny usługi Azure API Management. Ta warstwa nie jest używana w środowisku produkcyjnym. Aby uzyskać więcej informacji na temat warstw usługi API Management, zobacz Porównanie oparte na funkcjach warstw usługi Azure API Management.
Napiwek
Jest to długotrwała akcja. Utworzenie i aktywowanie usługi API Management w tej warstwie może potrwać od 30 do 40 minut.
New-AzApiManagement -Name "myapim" -ResourceGroupName "myResourceGroup" `
-Location "West US" -Organization "Contoso" -AdminEmail "admin@contoso.com"
Po powrocie polecenia uruchom polecenie Get-AzApiManagement , aby wyświetlić właściwości usługi Azure API Management. Po aktywacji parametr ProvisioningState
to Powodzenie, a wystąpienie ma kilka skojarzonych adresów URL. Na przykład:
Get-AzApiManagement -Name "myapim" -ResourceGroupName "myResourceGroup"
Przykładowe wyjście:
PublicIPAddresses : {203.0.113.1}
PrivateIPAddresses :
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ApiManagement/service/myapim
Name : myapim
Location : West US
Sku : Developer
Capacity : 1
CreatedTimeUtc : 9/9/2022 9:07:43 PM
ProvisioningState : Succeeded
RuntimeUrl : https://myapim.azure-api.net
RuntimeRegionalUrl : https://myapi-westus-01.regional.azure-api.net
PortalUrl : https://myapim.portal.azure-api.net
DeveloperPortalUrl : https://myapim.developer.azure-api.net
ManagementApiUrl : https://myapim.management.azure-api.net
ScmUrl : https://myapim.scm.azure-api.net
PublisherEmail : admin@contoso.com
OrganizationName : Contoso
NotificationSenderEmail : apimgmt-noreply@mail.windowsazure.com
VirtualNetwork :
VpnType : None
PortalCustomHostnameConfiguration :
ProxyCustomHostnameConfiguration : {myapim.azure-api.net}
ManagementCustomHostnameConfiguration :
ScmCustomHostnameConfiguration :
DeveloperPortalHostnameConfiguration :
SystemCertificates :
Tags : {}
AdditionalRegions : {}
SslSetting : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting
Identity :
EnableClientCertificate :
EnableClientCertificate :
Zone :
DisableGateway : False
MinimalControlPlaneApiVersion :
PublicIpAddressId :
PlatformVersion : stv2
PublicNetworkAccess : Enabled
PrivateEndpointConnections :
ResourceGroupName : myResourceGroup
Po wdrożeniu wystąpienia usługi API Management możesz go użyć. Zacznij od samouczka, aby zaimportować i opublikować swój pierwszy interfejs API.
Czyszczenie zasobów
Gdy grupa zasobów i wszystkie pokrewne zasoby nie będą już potrzebne, można je usunąć za pomocą polecenia Remove-AzResourceGroup.
Remove-AzResourceGroup -Name myResourceGroup