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

対象: すべてのAPI Management層

このクイック スタートでは、Bicep ファイルを使用してAzure API Management インスタンスを作成する方法について説明します。 Bicep は、API Management インスタンスへの API のインポートなどの一般的な管理タスクにも使用できます。

Azure API Management は、組織が外部、パートナー、および内部の開発者に API を発行して、データとサービスの可能性を引き出すのに役立ちます。 API Managementは、開発者エンゲージメント、ビジネス分析情報、分析、セキュリティ、保護を通じて API プログラムを成功させるためにコア コンピテンシーを提供します。 API Managementを使用して、任意の場所でホストされている既存のバックエンド サービスの最新の API ゲートウェイを作成および管理します。

Bicep は、宣言型構文を使用してAzure リソースをデプロイするドメイン固有言語 (DSL) です。 簡潔な構文、信頼性の高いタイプ セーフ、およびコードの再利用のサポートが提供されます。 Bicep は、Azureのコードとしてのインフラストラクチャ ソリューションに最適な作成エクスペリエンスを提供します。

前提条件

  • Azure サブスクリプションがない場合は、開始する前に free アカウントを作成します。

  • Azure CLIの場合:

    • Azure Cloud Shell で Bash 環境を使用します。 詳細については、Azure Cloud Shell の使い方を始めましょう を参照してください。

    • CLI 参照コマンドをローカルで実行する場合は、Azure CLIinstallします。 Windows または macOS で実行している場合は、Docker コンテナーでAzure CLIを実行することを検討してください。 詳細については、「 Docker コンテナーでAzure CLIを実行する方法を参照してください。

      • ローカル インストールを使用している場合は、az login コマンドを使用してAzure CLIにサインインします。 認証プロセスを完了するには、ターミナルに表示される手順に従います。 その他のサインイン オプションについては、「Azure CLI を使用して Azure に認証する」を参照してください。

      • メッセージが表示されたら、最初に使用するときにAzure CLI拡張機能をインストールします。 拡張機能の詳細については、「Azure CLIを参照してください。

      • az version を実行して、インストールされているバージョンと依存ライブラリを検索します。 最新バージョンにアップグレードするには、az upgrade を実行します。

  • Azure PowerShellの場合:

Bicep ファイルを確認する

このクイック スタートで使用される Bicep ファイルは、Azure クイック スタート テンプレートから取得しています。

@description('The name of the API Management service instance')
param apiManagementServiceName string = 'apiservice${uniqueString(resourceGroup().id)}'

@description('The email address of the owner of the service')
@minLength(1)
param publisherEmail string

@description('The name of the owner of the service')
@minLength(1)
param publisherName string

@description('The pricing tier of this API Management service')
@allowed([
  'Consumption'
  'Developer'
  'Basic'
  'Basicv2'
  'Standard'
  'Standardv2'
  'Premium'
])
param sku string = 'Developer'

@description('The instance size of this API Management service.')
@allowed([
  0
  1
  2
])
param skuCount int = 1

@description('Location for all resources.')
param location string = resourceGroup().location

resource apiManagementService 'Microsoft.ApiManagement/service@2023-05-01-preview' = {
  name: apiManagementServiceName
  location: location
  sku: {
    name: sku
    capacity: skuCount
  }
  properties: {
    publisherEmail: publisherEmail
    publisherName: publisherName
  }
}

Bicep ファイルには、次のリソースが定義されています。

この例では、Bicep ファイルは既定で、Azure API Managementを評価する経済的なオプションである Developer レベルでAPI Management インスタンスを構成します。 このレベルは運用目的では使用できません。

Bicep のその他のAzure API Managementサンプルについては、Azure クイック スタート テンプレートを参照してください。

Bicep ファイルをデプロイする

Azure CLIまたはAzure PowerShellを使用して、Bicep ファイルをデプロイできます。 Bicep ファイルのデプロイの詳細については、「deploy Bicep files with the Azure CLI」を参照してください。

  1. Bicep ファイルを main.bicep としてローカル コンピューターに保存します。

  2. Azure CLIまたはAzure PowerShellを使用して Bicep ファイルをデプロイします。

    <publisher-name> および <publisher-email> を組織の名前と電子メール アドレスに置き換えて通知を受信します。

    az group create --name exampleRG --location eastus

az deployment group create --resource-group exampleRG --template-file main.bicep --parameters publisherEmail=<publisher-email> publisherName=<publisher-name>

    デプロイが完了すると、デプロイが成功したことを示すメッセージが表示されます。

    ヒント

    Developer レベルで API Management サービスを作成してアクティブ化するには、30 分から 40 分かかる場合があります。 時間はレベルによって異なります。

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

Azure portal、Azure CLI、またはAzure PowerShellを使用して、リソース グループにデプロイされたApp Configuration リソースを一覧表示します。

az resource list --resource-group exampleRG

API Management サービス インスタンスがオンラインの場合は、そのインスタンスを使用する準備が整います。 最初の API をインポートして公開するためのチュートリアルを開始します。

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

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

az group delete --name exampleRG

次のステップ

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

  • Last updated on