クイック スタート: API センターを作成する - Azure CLI

  • [アーティクル]

API センターを作成して、組織の API のインベントリを開始します。 Azure API Center を使用すると、API を 1 か所で追跡して、検出、再利用、ガバナンスを行うことができます。

API センターを作成したら、このチュートリアルの手順に従って、カスタム メタデータ、API、バージョン、定義、その他の情報を追加します。

前提条件

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

  • Azure サブスクリプション内の少なくとも共同作成者ロールの割り当て、または同等のアクセス許可。

  • Azure CLI の場合

    • 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 を実行します。

    Note

    az apic コマンドには、apic-extensionAzure CLI 拡張機能が必要です。 az apic コマンドを使用していない場合は、最初の az apic コマンドの実行時に拡張機能を動的にインストールするか、拡張機能を手動でインストールできます。 Azure CLI 拡張機能の詳細については、こちらを参照してください。

    apic-extension の最新の変更と更新については、リリース ノートを参照してください。

Microsoft.ApiCenter プロバイダーを登録する

まだ使用していない場合は、サブスクリプション内で Microsoft.ApiCenter リソース プロバイダーを登録する必要があります。 リソース プロバイダーを登録する必要があるのは 1 回のみです。

Azure CLI を使用してサブスクリプション内でリソース プロバイダーを登録するには、次の az provider register コマンドを実行します。

az provider register --namespace Microsoft.ApiCenter

登録の状態を確認するには、次の az provider show コマンドを実行します。

az provider show --namespace Microsoft.ApiCenter

リソース グループの作成

Azure API Center インスタンスは、すべての Azure リソースのように、リソース グループにデプロイする必要があります。 リソース グループを使用すると、関連する Azure リソースを整理して管理できます。

az group create コマンドを使用して、リソース グループを作成します。 次の例では、MyGroup というグループを East US リージョンに作成します。

az group create --name MyGroup --location eastus

API センターを作成する

az apic create コマンドを使用して、API センターを作成します。

次オン例では、MyApiCenter という API センターを MyGroup リソース グループに作成します。 この例では、API センターが West Europe リージョンにデプロイされています。 任意の API センター名に置き換えて、API センターで使用可能な場所のいずれかを入力します。

az apic create --name MyApiCenter --resource-group MyGroup --location westeurope

コマンドからの出力は、次のようになります。 既定では、API センターは Free プランで作成されます。

{
  "dataApiHostname": "myapicenter.data.westeurope.azure-apicenter.ms",
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/mygroup/providers/Microsoft.ApiCenter/services/myapicenter",
  "location": "westeurope",
  "name": "myapicenter",
  "resourceGroup": "mygroup",
  "sku": {
    "name": "Free"
  },
  "systemData": {
    "createdAt": "2024-06-22T21:40:35.2541624Z",
    "lastModifiedAt": "2024-06-22T21:40:35.2541624Z"
  },
  "tags": {},
  "type": "Microsoft.ApiCenter/services"
}

デプロイ後に API センターを使用する準備ができます。

次のステップ

これで、API センターでインベントリへの情報の追加を開始できます。 API やその他の情報を整理するには、まず API センターでカスタム メタデータを定義します。

カスタム メタデータを定義する