ガイド付きセットアップを使用して Azure API Management の API サービスグラフコネクタ を構成します

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間:14分
  • Azure API Management データを CMDB にプルするようにスケジュール済みインポートジョブを設定します。

    始める前に

    重要:
    ガイド付きセットアップ方法は廃止されるため、問題がない限り、 SGC セントラル ビューを使用してください。ガイド付きセットアップを使用して接続を構成すると、接続が SGC セントラル ビューに表示されないことがあります。
    依存関係と要件:
    • 自動的にインストールされる CMDB 共通統合ストアアプリ。「Integration Commons for CMDB」を参照してください。
    • 自動的にインストールされる CMDB CI クラスモデルストアアプリ。「CMDB CI クラスモデル」を参照してください。
    • ITOM ディスカバリーライセンスプラグイン (com.snc.itom.discovery.license)。このプラグインを有効にする必要があります。
    • ITOM Licensing プラグイン (com.snc.itom.license)。「Request Discovery」を参照してください。
    Azure アドミニストレーターから OAuth 認証情報を取得します。次の詳細情報をメモします。
    • アプリケーション (クライアント) ID
    • クライアントシークレット
    • ディレクトリー (テナント) ID
    • 接続 URL

    必要なロール:admin

    手順

    1. アプリケーションピッカーを使用して、アプリケーションスコープを Azure API Management の API サービスグラフコネクタ アプリケーションに設定します。
      詳細については、「アプリケーションピッカー」を参照してください。
    2. 次のように移動する。 All (すべて) > Service Graph Connector > Azure API 管理 > セットアップ.
    3. Azure API Management の API サービスグラフコネクタ ページで、[クイックスタート] オプションが選択されていることを確認し、[続行] を選択します。
    4. Azure API Management アプリケーションに要求を送信するための認証情報を構成します。
      1. [Azure API Management の API サービスグラフコネクタ] ページの [接続と認証情報の構成] セクションで、[開始] を選択します。
      2. 接続を構成します。
        1. タスク [Azure 認証情報を構成 (Configure Azure authentication credentials)] を選択します。
        2. [ ここをクリック ] を選択して、別のブラウザタブで [接続] ページを開きます。
        3. Azure API Management 接続[編集] を検索して選択します。
        4. [接続を編集 (Edit Connection)] ウィンドウの [接続情報 (Connection Information)] セクションで、フィールドに入力します。
          表 : 1. 接続情報
          フィールド 説明
          Azure API Management 接続名 Azure API Management接続レコードを識別する名前です。

          Azure API Management 接続がデフォルトの認証情報エイリアス名です。複数の Azure API Management インスタンスを追加することができます。ただし、デフォルトの接続名は変更しないようにしてください。

          接続 URL Azure API Management サービスに接続するベース URL。
          Azure クライアントアプリケーションのリージョンに基づいて、次のいずれかの形式で URL を入力します。
          • グローバル
            https://management.azure.com
          • 米国政府
            htttps://management.usgovcloudapi.net
          • 中国
            https://management.chinacloudapi.cn
          • ドイツ
            https://management.microsoftazure.de/
        5. [接続を編集 (Edit Connection)] ウィンドウの [認証情報 (Credential Information)] セクションで、フィールドに入力します。
          表 : 2. 認証情報
          フィールド 説明
          OAuth クライアント ID [事前準備 (Before you bigin)] セクションに記載されている Azure クライアントアプリケーションのアプリケーション (クライアント) ID。
          OAuth クライアントシークレット [事前準備 (Before you bigin)] セクションに記載されている Azure クライアントアプリケーションのクライアントシークレット。
          OAuth トークン URL Azure クライアントアプリケーションのトークン URL。
          Azure クライアントアプリケーションの地域に基づいて、次のいずれかの形式でトークン URL を入力します。
          • グローバル
            https://login.microsoftonline.com/<tenantid>/oauth2/v2.0/token
          • 米国政府
            https://login.microsoftonline.us/<tenantid>/oauth2/v2.0/token
          • 中国
            https://login.partner.microsoftonline.cn/<tenantid>/oauth2/v2.0/token
          • ドイツ
            https://login.microsoftonline.de/<tenantid>/oauth2/v2.0/token
          <tenantid>[事前準備 (Before you bigin)] セクションに記載されている Azure クライアントアプリケーションのテナント ID です。
        6. [OAuth トークンを編集して取得] を選択します。
        7. [更新] を選択します。
        8. OAuth トークンフローが正常に完了したら、ガイド付きセットアップページに戻り、[完了としてマーク (Mark as complete)] チェックボックスをオンにして [Azure 認証情報を構成 (Configure Azure authentication credentials)] タスクを完了し、[続行] を選択します。
      3. Azure API Management を介して Azure リソースを管理するための接続を構成します。
        1. [ プロパティを構成 ] タスクを選択します。
        2. [サービスグラフ接続のプロパティ] 関連リストで、プロパティの値を入力します。
          表 : 3. サービスグラフ接続のプロパティ
          プロパティ 説明
          CollectionPeriod(日数) API 使用状況データを収集する期間 (日数)。
          使用状況データの収集 指定した期間の API 使用状況データを取得するには、使用状況データ収集を有効にします。
          ディスカバリースコープ Azure クライアントアプリケーションのディスカバリースコープ。使用可能なオプションは、次のとおりです。
          管理グループ
          ServiceNowサービスアカウントがAzure管理グループ内のデータにアクセスできる場合は、[管理グループ] を選択します。
          サブスクリプション
          ServiceNowサービスアカウントがAzureサブスクリプション内のデータにのみアクセスできる場合は、[サブスクリプション] を選択します。
          ExcludeServices 接続から除外する必要がある Azure API Management サービス

          サービスが複数ある場合は、カンマで区切ります。ExcludeServices プロパティにリストされているものを除くすべてのゲートウェイがフェッチされます。

          GetNestedGroupSubscriptions 管理グループがディスカバリースコープとして設定されている場合に、ネストされたすべての子サブスクリプションからデータを取得できるようにします。

          ネストされた子サブスクリプションを除外するには、プロパティを false に設定します。

          ManagementGroupId Azure API Management サービスの管理グループ ID。

          管理グループが複数ある場合は、カンマで区切ります。

          パーティションサイズ 並列ロードが有効になっている場合の Azure マネージド API のパーティションサイズ。

          0 より大きい数値を受け入れます。空のままにすると、値が自動的に計算されます。

          ResourceGroups Azure API Management サービスのリソースグループ名。

          リソースグループが複数ある場合は、名前をカンマで区切ります。このフィールドを空のままにすると、コネクタ内のデータソースは、使用可能なすべてのリソースグループからデータをインポートします。

          SubscriptionId Azure API Management サービスのサブスクリプション ID

          サブスクリプション ID が複数ある場合は、カンマで区切ります。ディスカバリースコープが [サブスクリプション ] に設定されていて、このフィールドを空白のままにすると、認証情報内の指定されたテナントのすべてのサブスクリプションが検出されます。

          ヒント:
          プロパティ値を入力するには、ダブルクリック (またはキーボードショートカットを使用) して、プロパティの [値] セルに値を入力します。
        3. [完了としてマーク] チェックボックスをオンにして [プロパティの構成] タスクを完了に設定し、[続行] を選択します。
      4. 接続をテストします。
        1. [テスト接続] タスクを選択します。
        2. [テスト接続] 関連リンクを選択して、接続をテストします。

          接続のテストには少し時間がかかる場合があります。ページが更新され、テスト結果が表示されます。

        3. [ステータス] フィールドが [成功] に設定されている場合は、[更新] を選択します。

          いずれかのテストでエラーが発生した場合は、修正の提案に従ってください。

        4. [完了としてマーク] チェックボックスをオンにして、[テスト接続] タスクを完了に設定し、[続行] を選択します。
    5. オプション: 複数の Azure API Management インスタンスと統合します。
      1. [Azure API Management の API サービスグラフコネクタ] ページの [複数のインスタンスを追加] セクションで [開始] を選択します。
      2. 新しい Azure API Management接続のデータソースの作成を有効にします。
        1. データソース [sys_data_source] テーブルの編集権限があることを確認します。
        2. [データソースアクセスを更新] タスクを選択します。
        3. レコードを編集するには、アプリケーションピッカーから [グローバル] アプリケーションスコープを選択します。
        4. 別のタブで表示される [データソース] フォームの [アプリケーションのアクセス] 関連リストで、[作成可能][更新可能]、および [削除可能] チェックボックスをオンにします。
        5. [更新] を選択します。
        6. アプリケーションピッカーを使用して、API Service Graph Connector for Azure API Management アプリケーションスコープを選択します。
        7. [完了としてマーク] チェックボックスをオンにして、[データソースアクセスを更新] タスクを完了に設定し、[続行] を選択します。
      3. 新しい Azure API Management接続のスケジュール済みインポートジョブの作成を有効にします。
        1. 予定されているデータインポート [scheduled_import_set] テーブルの編集権限があることを確認してください。
        2. [予定されているデータインポートアクセスを更新] タスクを選択します。
        3. レコードを編集するには、アプリケーションピッカーから [グローバル] アプリケーションスコープを選択します。
        4. [予定されているデータインポート] フォームの [アプリケーションのアクセス] 関連リストで、[作成可能][更新可能]、および [削除可能] チェックボックスをオンにします。
        5. [更新] を選択します。
        6. アプリケーションピッカーを使用して、API Service Graph Connector for Azure API Management アプリケーションスコープを選択します。
        7. [完了としてマーク (Mark as complete)] チェックボックスをオンにして、[予定されているデータインポートアクセスを更新] タスクを完了に設定し、[続行] を選択します。
      4. データソース [sys_data_source] テーブルと予定されているデータインポート [scheduled_import_set] テーブルのキャッシュをクリアします。
        1. [データソースおよび予定されているデータインポートテーブルのキャッシュをクリア] タスクを選択します。
        2. レコードを編集するには、アプリケーションピッカーから [グローバル] アプリケーションスコープを選択します。
        3. [スクリプトを実行] フィールドに次のコードを入力します。
          GlideTableManager.invalidateTable("sys_data_source");
          GlideCacheManager.flushTable("sys_data_source");
          GlideTableManager.invalidateTable("scheduled_import_set");
          GlideCacheManager.flushTable("scheduled_import_set");
          GlideTableManager.invalidateTable("sys_db_object");
          GlideCacheManager.flushTable("sys_db_object");
        4. [スクリプトを実行] を選択します。
        5. アプリケーションピッカーを使用して、API Service Graph Connector for Azure API Management アプリケーションスコープを選択します。
        6. [データソースおよび予定されているデータインポートテーブルのキャッシュをクリア] タスクで、[完了としてマーク] を選択して、完了に設定します。
      5. 新しい Azure API Management インスタンスに別の接続を追加します。
        1. アプリケーションピッカーを使用して、アプリケーションスコープが API Service Graph Connector for Azure API Management アプリケーションに設定されていることを確認します。
        2. [別の接続を追加] タスクを選択し、[ここをクリック] を選択します。
        3. 新しいブラウザタブで開かれた [接続] ページで、[接続を追加] を選択します。
        4. [接続を作成] ウィンドウで、接続、認証情報、およびサブスクリプション ID の詳細を入力します。
        5. [OAuth トークンを作成して取得] を選択します。
        6. [接続] ページを閉じて、ガイド付きセットアップページタブに戻ります。
        7. [完了としてマーク] チェックボックスをオンにして、[別の接続を追加] タスクを完了に設定し、[続行] を選択します。
      6. 新しい接続のプロパティを追加します。
        1. アプリケーションピッカーを使用して、アプリケーションスコープが API Service Graph Connector for Azure API Management アプリケーションに設定されていることを確認します。
        2. [プロパティを新しい接続に追加 (Add Properties to New Connections)] タスクを選択します。
        3. [名前] 列から、ステップ 5.e で作成した接続名を選択します。
        4. [サービスグラフ接続のプロパティ] 関連リストで、プロパティの値を入力します。

          プロパティの詳細については、「4.c.ii」を参照してください。

          ヒント:
          プロパティ値を入力するには、ダブルクリック (またはキーボードショートカットを使用) して、プロパティの [値] セルに値を入力します。
        5. [完了としてマーク (Mark as complete)] チェックボックスをオンにして、[プロパティを新しい接続に追加 (Add Properties to New Connections)] タスクを完了に設定し、[続行] を選択します。
      7. 新しい接続をテストします。
        1. [新しい接続をテスト] タスクを選択します。
        2. [名前] 列から、ステップ 5.e で作成した接続名を選択します。
        3. [テスト接続] 関連リンクを選択して、接続をテストします。

          接続のテストには少し時間がかかる場合があります。ページが更新され、テスト結果が表示されます。

        4. [ステータス] フィールドが [成功] に設定されている場合は、[更新] を選択します。

          いずれかのテストでエラーが発生した場合は、修正の提案に従ってください。

        5. [完了としてマーク] チェックボックスをオンにして、[新しい接続をテスト] タスクを完了に設定し、[続行] を選択します。
    6. Azure API Management データをインポートするためのスケジュール済みジョブを構成します。
      1. Azure API Management の API サービスグラフコネクタページの [スケジュール済みインポートジョブを設定 (Set up Scheduled Import Jobs)] セクションで、[開始] を選択します。
      2. [SGA Azure API Management Services] スケジュール済みジョブを選択します。
        複数のインスタンスをセットアップする場合は、ステップ 5.e の接続で作成されたスケジュール済みインポートを選択します。
      3. [予定されているデータインポート] フォームで、フィールド値を確認します。

        詳細については、「Schedule a data import」を参照してください。

      4. [アクティブ] チェックボックスをオンにして、スケジュール済みジョブをアクティブ化します。
      5. [実行] フィールドで、[定期的] を選択して、ジョブの実行頻度を指定します。
      6. [更新] を選択します。
      7. [完了としてマーク] チェックボックスをオンにして、[スケジュール済みインポートジョブを設定 (Set up Scheduled Import Jobs)] タスクを完了に設定し、[続行] を選択します。
    7. Azure API Management の API サービスグラフコネクタページで、[完了] を選択して変更を保存します。
    8. [セットアップの完了] ダイアログボックスで、[完了] を選択してセットアップを完了します。
    9. 表示されるメッセージボックスで、 [完了] を選択します。