クイック スタート: Azure CLI を使用して新しい Azure API Management インスタンスを作成する
適用対象: 従量課金 | 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 無料アカウントを作成してください。
前提条件
Azure Cloud Shell で Bash 環境を使用します。 詳細については、「Azure Cloud Shell の Bash のクイックスタート」を参照してください。
CLI リファレンス コマンドをローカルで実行する場合、Azure CLI をインストールします。 Windows または macOS で実行している場合は、Docker コンテナーで Azure CLI を実行することを検討してください。 詳細については、「Docker コンテナーで Azure CLI を実行する方法」を参照してください。
ローカル インストールを使用する場合は、az login コマンドを使用して Azure CLI にサインインします。 認証プロセスを完了するには、ターミナルに表示される手順に従います。 その他のサインイン オプションについては、Azure CLI でのサインインに関するページを参照してください。
初回使用時にインストールを求められたら、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