クイックスタート: ARM テンプレートを使用して新しい Azure API Management サービスインスタンスを作成する

[アーティクル]
04/09/2024

適用対象: すべての API Management レベル

このクイックスタートでは、Azure Resource Manager テンプレート (ARM テンプレート) を使用して Azure API Management インスタンスを作成する方法を説明します。 API Management インスタンスへの API のインポートなど、一般的な管理タスクに ARM テンプレートを使用することもできます。

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

Azure Resource Manager テンプレートは JavaScript Object Notation (JSON) ファイルであり、プロジェクトのインフラストラクチャと構成が定義されています。このテンプレートでは、宣言型の構文が使用されています。デプロイしようとしているものを、デプロイを作成する一連のプログラミングコマンドを記述しなくても記述できます。

環境が前提条件を満たしていて、ARM テンプレートの使用に慣れている場合は、 [Azure へのデプロイ] ボタンを選択します。 Azure portal でテンプレートが開きます。

前提条件

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

テンプレートを確認する

このクイックスタートで使用されるテンプレートは Azure クイックスタートテンプレートからのものです。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "metadata": {
    "_generator": {
      "name": "bicep",
      "version": "0.26.54.24096",
      "templateHash": "15176578550391235821"
    }
  },
  "parameters": {
    "apiManagementServiceName": {
      "type": "string",
      "defaultValue": "[format('apiservice{0}', uniqueString(resourceGroup().id))]",
      "metadata": {
        "description": "The name of the API Management service instance"
      }
    },
    "publisherEmail": {
      "type": "string",
      "minLength": 1,
      "metadata": {
        "description": "The email address of the owner of the service"
      }
    },
    "publisherName": {
      "type": "string",
      "minLength": 1,
      "metadata": {
        "description": "The name of the owner of the service"
      }
    },
    "sku": {
      "type": "string",
      "defaultValue": "Developer",
      "allowedValues": [
        "Consumption",
        "Developer",
        "Basic",
        "Basicv2",
        "Standard",
        "Standardv2",
        "Premium"
      ],
      "metadata": {
        "description": "The pricing tier of this API Management service"
      }
    },
    "skuCount": {
      "type": "int",
      "defaultValue": 1,
      "allowedValues": [
        0,
        1,
        2
      ],
      "metadata": {
        "description": "The instance size of this API Management service."
      }
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]",
      "metadata": {
        "description": "Location for all resources."
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.ApiManagement/service",
      "apiVersion": "2023-05-01-preview",
      "name": "[parameters('apiManagementServiceName')]",
      "location": "[parameters('location')]",
      "sku": {
        "name": "[parameters('sku')]",
        "capacity": "[parameters('skuCount')]"
      },
      "properties": {
        "publisherEmail": "[parameters('publisherEmail')]",
        "publisherName": "[parameters('publisherName')]"
      }
    }
  ]
}

テンプレートには、次のリソースが定義されています。

Microsoft.ApiManagement/service

その他の Azure API Management テンプレートのサンプルは、Azure クイックスタートテンプレートのページから入手できます。

テンプレートのデプロイ

Azure にサインインし、テンプレートを開くには次のイメージを選択します。このテンプレートを使用すると、自動的に生成された名前を使用して API Management サービスインスタンスが作成されます。

この例では、Azure API Management を評価するための経済的なオプションである Developer レベルにインスタンスが構成されます。このレベルは運用目的では使用できません。 API Management レベルのスケーリングの詳細については、アップグレードとスケーリングに関するをページをご覧ください。
次の値を選択または入力します。
- サブスクリプション: Azure サブスクリプションを選択します。
- リソースグループ: [新規作成] を選択し、リソースグループの一意の名前を入力し、 [OK] を選択します。
- [リージョン] : リソースグループの場所を選択します。例:米国中部。
- [Publisher Email](公開者の電子メール) : 通知を受信するためのメールアドレスを入力します。
- [Publisher Name](公開者名) : API 公開者用に選択した名前を入力します。
- [SKU] : 既定値の Developer を受け入れます。または、別の値を選びます。
- [Sku Count](SKU 数) : 既定値を受け入れます。
- [場所] : API Management サービスに対して生成された場所を受け入れます。
[Review + Create](確認と作成) を選択し、使用条件を確認します。同意する場合は、 [作成] を選択します。

ヒント

Developer レベルに API Management サービスを作成してアクティブにするには、30 から 40 分かかる場合があります。時間はレベルによって異なります。
インスタンスが正常に作成されると、次の通知が表示されます。

テンプレートをデプロイするには Azure portal を使用します。 Azure portal だけでなく、Azure PowerShell、Azure CLI、REST API を使用することもできます。他のデプロイ方法については、「テンプレートのデプロイ」を参照してください。

デプロイされているリソースを確認する

Azure portal を使用してデプロイされたリソースを確認するか、Azure CLI や Azure PowerShell などのツールを使用してデプロイされたリソースを一覧表示します。

Azure portal で、API Management サービスを検索して選択し、作成したサービスインスタンスを選択します。
[概要] ページで、サービスのプロパティを確認します。

サービスの概要ページ

API Management サービスインスタンスがオンラインになったら、使用する準備ができています。最初の API をインポートして公開するためのチュートリアルを開始します。

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

後続のチュートリアルを引き続き実行する場合は、API Management インスタンスをそのまま残しておくことができます。不要になったら、リソースグループを削除します。これにより、リソースグループ内のリソースが削除されます。

Azure portal で、 [リソースグループ] を検索して選択します。 [ホーム] ページで [リソースグループ] を選択することもできます。
[リソースグループ] ページで、リソースグループを選択します。
[リソースグループ] ページで、[リソースグループの削除] を選択します。
リソースグループの名前を入力し、[削除] を選択します。

次のステップ

チュートリアル:最初の API のインポートと発行

クイックスタート: ARM テンプレートを使用して新しい Azure API Management サービス インスタンスを作成する