クイック スタート: PowerShell を使用して新しい Azure API Management インスタンスを作成する

このクイック スタートでは、Azure PowerShell コマンドレットを使用して、新しい API Management インスタンスを作成します。 インスタンスを作成したら、API Management インスタンスへの API のインポートなどの一般的な管理アクションに Azure PowerShell コマンドレットを使用できます。

Azure API Management が組織にもたらす利点は、外部のパートナーや社内の開発者に API を公開することによって、社内に眠っているデータやサービスの可能性を発掘できることです。 API Management は、開発者の取り組み、ビジネス インサイト、分析、セキュリティ、保護を通じて API プログラムの価値を高め、企業にコア コンピテンシーをもたらします。 API Management を使用すると、任意の場所でホストされている既存のバックエンド サービス用に最新の API ゲートウェイを作成して管理できます。

Azure サブスクリプションをお持ちでない場合は、開始する前に Azure 無料アカウントを作成してください。

前提条件

リソース グループの作成

New-AzResourceGroup を使用して Azure リソース グループを作成します。 リソース グループとは、Azure リソースのデプロイと管理に使用する論理コンテナーです。

次のコマンドは、myResourceGroup という名前のリソース グループを米国西部の場所に作成します。

New-AzResourceGroup -Name myResourceGroup -Location WestUS

API Management インスタンスの作成

リソース グループを作成したので、API Management サービス インスタンスを作成できます。 New-AzApiManagement を使用して作成し、サービス名と発行者の詳細を指定します。 サービス名は Azure 内で一意になっている必要があります。

次の例では、myapim をサービス名として使用します。 名前を一意の値に更新します。 また、API パブリッシャーの組織名と、通知を受信するための管理者の電子メール アドレスを更新します。

既定では、このコマンドは、Azure API Management を評価するための経済的なオプションである Developer レベルにインスタンスを作成します。 このレベルは運用目的では使用できません。 Azure API Management レベルの詳細については、「Azure API Management レベルのフィーチャーベースの比較」を参照してください。

ヒント

これは、実行時間の長いアクションです。 このサービス レベルに API Management サービスを作成してアクティブにするには、30 分から 40 分かかります。

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

コマンドが終了したら、Get-AzApiManagement を実行して、Azure API Management サービスのプロパティを表示します。 アクティブ化後、ProvisioningState は [成功] になり、インスタンスには複数の URL が関連付けられます。 次に例を示します。

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

出力例:

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

API Management サービス インスタンスがデプロイされると、使用する準備ができています。 最初の API をインポートして発行するチュートリアルを開始します。

リソースをクリーンアップする

必要がなくなったら、Remove-AzResourceGroup コマンドを使用して、リソース グループとすべての関連リソースを削除できます。

Remove-AzResourceGroup -Name myResourceGroup

次のステップ