Rychlý start: Vytvoření nové instance služby Azure API Management pomocí PowerShellu

V tomto rychlém startu vytvoříte novou instanci API Management pomocí rutin Azure PowerShell.

Azure API Management pomáhá organizacím publikovat rozhraní API externím, partnerům a interním vývojářům, aby uvolnila potenciál jejich dat a služeb. Služba API Management nabízí základní možnosti pro zajištění úspěšného programu s rozhraním API prostřednictvím zapojení vývojářů, informací o podniku, analýz, zabezpečení a ochrany. API Management umožňuje vytvářet a spravovat moderní brány rozhraní API pro existující back-endové služby hostované kdekoli.

Požadavky

  • Účet Azure s aktivním předplatným. Zdarma si vytvořte účet.

  • Azure Cloud Shell nebo Azure PowerShell

    Azure hostí interaktivní prostředí Azure Cloud Shell, které můžete používat v prohlížeči. Pro práci se službami Azure můžete v prostředí Cloud Shell použít buď Bash, nebo PowerShell. K spuštění kódu v tomto článku můžete použít Cloud Shell předinstalované příkazy, aniž byste museli instalovat cokoli do místního prostředí.

    Spuštění služby Azure Cloud Shell:

    Možnost Příklad nebo odkaz
    Vyberte Vyzkoušet v pravém horním rohu bloku kódu nebo příkazu. Výběrem možnosti Vyzkoušet se kód nebo příkaz automaticky nekopíruje do Cloud Shell. Snímek obrazovky znázorňující příklad možnosti Vyzkoušet pro Azure Cloud Shell
    Přejděte na adresu https://shell.azure.com nebo výběrem tlačítka Spustit Cloud Shell otevřete Cloud Shell v prohlížeči. Snímek obrazovky, který ukazuje, jak spustit Cloud Shell v novém okně
    Zvolte tlačítko Cloud Shell v pruhu nabídky v pravém horním rohu webu Azure Portal. Snímek obrazovky znázorňující tlačítko Cloud Shell v Azure Portal

    Použití Azure Cloud Shell:

    1. Spusťte Cloud Shell.

    2. Výběrem tlačítka Kopírovat v bloku kódu (nebo bloku příkazu) zkopírujte kód nebo příkaz.

    3. Vložte kód nebo příkaz do relace Cloud Shell tak, že vyberete Kombinaci kláves Ctrl+Shift+V ve Windows a Linuxu nebo vyberete Cmd+Shift+V v macOS.

    4. Výběrem klávesy Enter spusťte kód nebo příkaz.

    Pokud se rozhodnete nainstalovat a používat PowerShell místně, tento rychlý start vyžaduje modul Azure PowerShell verze 1.0 nebo novější. Verzi zjistíte spuštěním příkazu Get-Module -ListAvailable Az. Pokud potřebujete upgrade, přečtěte si téma Instalace modulu Azure PowerShell. Pokud používáte PowerShell místně, musíte také spustit Connect-AzAccount , abyste vytvořili připojení k Azure.

Vytvoření skupiny prostředků

Vytvořte skupinu prostředků Azure pomocí rutiny New-AzResourceGroup. Skupina prostředků je logický kontejner, ve kterém se nasazují a spravují prostředky Azure.

Následující příkaz vytvoří skupinu prostředků myResourceGroup v umístění USA – západ:

New-AzResourceGroup -Name myResourceGroup -Location WestUS

Vytvoření instance služby API Management

Teď, když máte skupinu prostředků, můžete vytvořit instanci služby API Management. Vytvořte ho pomocí rutiny New-AzApiManagement a zadejte název služby a podrobnosti o vydavateli. Název služby musí být v rámci Azure jedinečný.

V následujícím příkladu se myapim používá pro název služby. Aktualizujte název na jedinečnou hodnotu. Aktualizujte také název organizace vydavatele rozhraní API a e-mailovou adresu správce, aby dostávala oznámení.

Ve výchozím nastavení příkaz vytvoří instanci na úrovni Developer, což je úsporná možnost vyhodnotit azure API Management. Tato úroveň není určená pro produkční použití. Další informace o úrovních API Management najdete v tématu Porovnání úrovní azure API Management založených na funkcích.

Poznámka

Toto je dlouhotrvající akce. Vytvoření a aktivace služby API Management v této vrstvě může trvat 30 až 40 minut.

New-AzApiManagement -Name "myapim" -ResourceGroupName "myResourceGroup" `
  -Location "West US" -Organization "Contoso" -AdminEmail "admin@contoso.com" 

Když se příkaz vrátí, spusťte Get-AzApiManagement a zobrazte vlastnosti služby Azure API Management. Po aktivaci je stav nastavení úspěšný a instance služby má několik přidružených adres URL. Příklad:

Get-AzApiManagement -Name "myapim" -ResourceGroupName "myResourceGroup" 

Příklad výstupu:

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 nasazení instance služby API Management jste připraveni ji použít. Začněte kurzem pro import a publikování prvního rozhraní API.

Vyčištění prostředků

Pokud už ji nepotřebujete, můžete pomocí příkazu Remove-AzResourceGroup odebrat skupinu prostředků a všechny související prostředky.

Remove-AzResourceGroup -Name myResourceGroup

Další kroky