チュートリアル: プログラムで Grafana API を呼び出す

  • [アーティクル]

このチュートリアルでは、次の作業を行う方法について説明します。

  • アプリケーションのサービス プリンシパルに Azure Managed Grafana ロールを割り当てる
  • アプリケーションの詳細を取得する
  • アクセス トークンを取得する
  • Grafana API を呼び出す

前提条件

Azure へのサインイン

Azure アカウントで Azure Portal (https://portal.azure.com/) にサインインします。

アプリケーションのサービス プリンシパルに Azure Managed Grafana ロールを割り当てる

  1. Azure portal で Managed Grafana インスタンスを開きます。

  2. ナビゲーション メニューで [アクセス制御 (IAM)] を選択します。

  3. [追加] 、 [ロールの割り当ての追加] の順に選択します。

  4. [Grafana 編集者] ロールを選択し、[次へ] を選択します。

  5. [アクセス権の割り当て先] で、[User, group, or service principal](ユーザー、グループ、またはサービス プリンシパル) を選択します。

  6. [メンバーを選択する] を選択し、サービス プリンシパルを選択して、[選択] をクリックします。

  7. [レビューと割り当て] を選択します。

    Azure プラットフォームでの [ロールの割り当ての追加] のスクリーンショット。

アプリケーションの詳細を取得する

次に、Grafana API アクセス トークンを取得し、Grafana API を呼び出すために使用するいくつかの情報を収集する必要があります。

  1. 次のようにテナント ID を見つけます。

    1. Azure portal で [リソース、サービス、ドキュメントの検索 (G+ /)] に「Microsoft Entra ID」と入力します。
    2. [Microsoft Entra ID] を選びます。
    3. 左側のメニューで [プロパティ] を選択します。
    4. [テナント ID] フィールドを見つけて、その値を保存します。

    Azure portal でのテナント ID の取得のスクリーンショット。

  2. 次のようにクライアント ID を見つけます。

    1. Azure portal の Microsoft Entra ID で、左側のメニューから [アプリの登録] を選択します。
    2. アプリを選択します。
    3. [概要] で、[アプリケーション (クライアント) ID] フィールドを見つけて、その値を保存します。

    Azure portal でのクライアント ID の取得のスクリーンショット。

  3. 次のようにアプリケーション シークレットを作成します。

    1. Azure portal の Microsoft Entra ID で、左側のメニューから [アプリの登録] を選択します。
    2. アプリを選択します。
    3. 左メニューから [証明書とシークレット] を選択します。
    4. [新しいクライアント シークレット] を選択します。
    5. 新しいクライアント シークレットを作成し、その値を保存します。

    Azure portal でのシークレットの作成のスクリーンショット。

    Note

    シークレットの値には、作成直後にのみアクセスできます。 このチュートリアルの次の手順で使用するために、ページを離れる前に値をコピーしてください。

  4. 次のように Grafana エンドポイントの URL を見つけます。

    1. Azure portal で [リソース、サービス、ドキュメントの検索 (G+ /)] バーに「Azure Managed Grafana」と入力します。
    2. [Azure Managed Grafana] を選択し、Managed Grafana ワークスペースを開きます。
    3. 左側のメニューから [概要] を選択し、[エンドポイント] の値を保存します。

    Azure プラットフォームのスクリーンショット。[概要] ページで [エンドポイント] が表示されています。

アクセス トークンを取得する

Grafana API にアクセスするには、アクセス トークンを取得する必要があります。 アクセス トークンは、Azure CLI を使用するか、POST 要求を行って取得できます。

az login コマンドを実行して Azure CLI にサインインし、<client-id>、<client-secret>、<tenant-id> を前の手順で収集したアプリケーション (クライアント) ID、クライアント シークレット、テナント ID に置き換えます。

az login --service-principal --username "<client-id>" --password "<client-secret>" --tenant "<tenant-id>"

コマンド az grafana api-key create を使用してキーを作成します。 出力例を次に示します。

az grafana api-key create --key keyname --name <name> --resource-group <rg> --role editor --output json

{
  "id": 3,
  "key": "<redacted>",
  "name": "keyname"
}

Note

このキーは、ここで 1 回だけ表示できます。 安全な場所に保存してください。

Grafana API を呼び出す

これで、前のステップで取得したアクセス トークンを Authorization ヘッダーとして使って、Grafana API を呼び出すことができます。 次に例を示します。

curl -X GET \
-H 'Authorization: Bearer <access-token>' \
https://<grafana-url>/api/user

<access-token> および <grafana-url> は、前の手順で取得したアクセス トークンおよび Grafana インスタンスのエンドポイントの URL に置き換えてください。 たとえば、「 https://my-grafana-abcd.cuse.grafana.azure.com 」のように指定します。

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

これらのリソースを引き続き使用する予定がなければ、次の手順で削除します。

  1. 次のように Azure Managed Grafana を削除します。

    1. Azure portal の Azure Managed Grafana で、左側のメニューから [概要] を選択します。
    2. [削除] を選択します。
    3. リソース名を入力して削除を確認し、[削除] を選択します。

  2. Microsoft Entra アプリケーションを削除する:

    1. Azure portal の Microsoft Entra ID で、左側のメニューから [アプリの登録] を選択します。
    2. アプリを選択します。
    3. [概要] タブで [削除] を選択します。
    4. [削除] を選択します。

次のステップ

データ ソースを構成する方法