Azure API ManagementでのAPI定義の更新 - Cloud

Talend Cloud API Designerの例

author
Talend Documentation Team
EnrichVersion
Cloud
EnrichProdName
Talend Cloud
task
ジョブデザインと開発 > Designing APIs
EnrichPlatform
Talend API Designer

ファイルを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という名前の新しい定義に置き換えられました。

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