適用対象: Consumption | Developer | Basic | Standard | Premium
このクイックスタートでは、Azure CLI コマンドを使用して新しい API Management インスタンスを作成する手順について説明します。 インスタンスを作成したら、API Management インスタンスへの API のインポートなどの一般的な管理タスクに Azure CLI を使用できます。
Azure API Management が組織にもたらす利点は、外部のパートナーや社内の開発者に API を公開することによって、社内に眠っているデータやサービスの可能性を発掘できることです。 API Management は、開発者の取り組み、ビジネス インサイト、分析、セキュリティ、保護を通じて API プログラムの価値を高め、企業にコア コンピテンシーをもたらします。 API Management を使用すると、任意の場所でホストされている既存のバックエンド サービス用に最新の API ゲートウェイを作成して管理できます。
Azure アカウントをお持ちでない場合は、開始する前に無料アカウントを作成してください。
[前提条件]
Azure Cloud Shell で Bash 環境を使用します。 詳細については、「Azure Cloud Shell の概要」を参照してください。
CLI 参照コマンドをローカルで実行する場合は、Azure CLI を インストール します。 Windows または macOS で実行している場合は、Docker コンテナーで Azure CLI を実行することを検討してください。 詳細については、「Docker コンテナーで Azure CLI を実行する方法」を参照してください。
ローカル インストールを使用する場合は、az login コマンドを使用して Azure CLI にサインインします。 認証プロセスを完了するには、ターミナルに表示される手順に従います。 その他のサインイン オプションについては、「 Azure CLI を使用した Azure への認証」を参照してください。
メッセージが表示されたら、最初に使用するときに Azure CLI 拡張機能をインストールします。 拡張機能の詳細については、「Azure CLI で拡張機能を使用および管理する」を参照してください。
az version を実行し、インストールされているバージョンおよび依存ライブラリを検索します。 最新バージョンにアップグレードするには、az upgrade を実行します。
- この記事では、Azure CLI のバージョン 2.11.1 以降が必要です。 Azure Cloud Shell を使用している場合は、最新バージョンが既にインストールされています。
リソース グループを作成する
Azure API Management インスタンスは、すべての Azure リソースと同様に、リソース グループにデプロイする必要があります。 リソース グループを使用すると、関連する Azure リソースを整理して管理できます。
まず、次の az group create コマンドを使用して、米国中部の場所に myResourceGroup という名前のリソース グループを作成 します。
az group create --name myResourceGroup --___location centralus
API Management インスタンスの作成
リソース グループが作成されたので、API Management インスタンスを作成できます。 az apim create コマンドを使用して作成し、サービス名と発行元の詳細を指定します。 サービス名は、Azure 内で一意である必要があります。
次の例では、サービス名に myapim が使用されています。 名前を一意の値に更新します。 また、API 発行元の組織の名前と、通知を受信する電子メール アドレスも更新します。
az apim create --name myapim --resource-group myResourceGroup \
--publisher-name Contoso --publisher-email admin@contoso.com \
--no-wait
既定では、このコマンドは、Azure API Management を評価するための経済的なオプションである Developer レベルでインスタンスを作成します。 このレベルは運用目的では使用できません。 API Management レベルのスケーリングの詳細については、アップグレードとスケーリングに関するをページをご覧ください。
ヒント
このレベルで API Management サービスを作成してアクティブ化するには、30 分から 40 分かかる場合があります。 前のコマンドでは、 --no-wait オプションを使用して、サービスの作成時にコマンドがすぐに返されるようにします。
az apim show コマンドを実行して、デプロイの状態を確認します。
az apim show --name myapim --resource-group myResourceGroup --output table
最初の出力は次のようになります。 Activating の状態が表示されます。
NAME RESOURCE GROUP LOCATION GATEWAY ADDR PUBLIC IP PRIVATE IP STATUS TIER UNITS
----------- ---------------- ---------- -------------- ----------- ------------ ---------- --------- -------
myapim myResourceGroup Central US Activating Developer 1
アクティブ化後、状態は Online され、サービス インスタンスにはゲートウェイ アドレスとパブリック IP アドレスがあります。 現時点では、これらのアドレスはコンテンツを公開しません。 例えば次が挙げられます。
NAME RESOURCE GROUP LOCATION GATEWAY ADDR PUBLIC IP PRIVATE IP STATUS TIER UNITS
----------- ---------------- ---------- --------------------------------- ------------ ------------ -------- --------- -------
myapim myResourceGroup Central US https://myapim.azure-api.net 203.0.113.1 Online Developer 1
API Management サービス インスタンスがオンラインの場合は、それを使用する準備が整います。 最初の API をインポートして発行するチュートリアルから始めます。
リソースをクリーンアップする
az group delete コマンドを使用すると、リソース グループと API Management サービス インスタンスが不要になったときに削除できます。
az group delete --name myResourceGroup