メイン コンテンツをスキップする 補完的コンテンツへスキップ

Azure API ManagementでAPI定義をアップデート

ファイルをAzure API Managementにインポートし、既存の定義をアップデートできるようにします。

始める前に

  • Azure API Manangementにアクセスできること。
  • Microsoft PowerShellがインストール済みであること。詳細は、Microsoft PowerShellドキュメンテーションを参照してください。
  • Azure PowerShellモジュールがインストール済みであること。詳細は、Microsoft Azureドキュメンテーションを参照してください。
  • API定義をエクスポート済みであること。
  • API定義の以前のバージョンがAzure API Managementにアップロード済みであること。
  • コンテキストパラメーターが変数として設定済みであること。詳細は、以上の手順を参照してください。

手順

  1. コマンドラインを開き、次のコマンドを入力してファイルをアップロードします: 
    Import-AzApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "{format}" -SpecificationPath "{yourfile}" -ApiId "{api-id}" -Path "{api-url-suffix}"
  2. 正しいパラメーターを追加します:
    パラメーター 説明
    {format} インポートするAPI定義の形式。値は次のようになります:
    • Swagger (推奨)
    • Wadl
    • Wsdl
    • OpenApi
    {yourfile} エクスポートしたAPI定義のパスとファイル名。
    {api-id} アップデートするAPIのAzure API Management ID。
    {api-url-suffix} 使用するAPIのパブリックURLの最後に追加するWeb APIパス。
  3. コマンドを実行します。

タスクの結果

お使いのAPI定義がインポートされ、以前のバージョンのファイルが新しいバージョンに置き換えられました。Azureポータルでアップデートをチェックできます。

この例では、Contacts APIという名前を持ち、5個のオペレーションが含まれているAPI定義の最初のバージョンがアップロードされました。このバージョンはその後、10個の操作が含まれているContacts API V2という名前の新しい定義に置き換えられました。

アップデートされたAPI定義のスクリーンショット。

Import-AzApiManagementApiコマンドの詳細は、Azureドキュメンテーションを参照してください。

このページは役に立ちましたか?

このページまたはコンテンツにタイポ、ステップの省略、技術的エラーなどの問題が見つかった場合はお知らせください。

こちらにフィードバックをお寄せください