Power BI REST API を使用する
Power BI REST API は、埋め込み、管理、ガバナンス、およびユーザー リソースのサービス エンドポイントを提供します。
Power BI REST API を使用すると、次の操作を行うことができます。
Power BI コンテンツを管理する
管理者操作を実行する
Power BI コンテンツを埋め込む
注意
一部の Power BI API は、ワークスペースをグループとして参照します。 グループへの参照は、ワークスペースを操作していることを意味します。
Power BI REST API にアクセスする場合、要求と応答のコンテンツとデータは、Power BI テナントのホーム リージョン以外のリージョンのデータ センターによって処理される場合があります。
スコープ
Power BI REST API を使用するには、Azure Active Directory (Azure AD) アプリケーションを Azure に登録する必要があります。 Azure AD アプリで Power BI REST リソースのアクセス許可を確立し、Power BI REST API にアクセスできるようにします。 アプリを登録する方法については、「 Power BI で使用する Azure AD アプリケーションを登録する」を参照してください。
Azure AD アプリを登録したら、Azure AD (v1.0;ADAL) またはMicrosoft ID プラットフォーム (v2.0;MSAL) エンドポイント。 これらの認証方法のしくみの詳細については、「Microsoft ID プラットフォーム (v2.0) に更新する理由」を参照してください。
Power BI アクセス許可の詳細については、「Microsoft ID プラットフォーム エンドポイントでのアクセス許可と同意」を参照してください。
サービス プリンシパルの使用
サービス プリンシパルを使用している場合、スコープは必要ありません。 Power BI でサービス プリンシパルを使用できるようにすると、アプリケーションの AD アクセス許可は有効になりません。 サービス プリンシパルを使用する場合、アプリケーションのアクセス許可は Power BI 管理ポータルで管理されます。 詳細については、「Power BI サービス管理者設定を有効にする」を参照してください。
スコープの追加
Azure AD アプリにアクセス許可を追加するには、次の手順に従います。
Azure でアプリを開きます。
左側の [ 管理] で、[ API のアクセス許可] を選択します。
[アクセス許可の追加] を選択します。
[ API のアクセス許可の要求 ] ウィンドウで、[ Power BI サービス] を選択します。
[委任されたアクセス許可] を選択します。 API の一覧が表示されます。
アクセス許可を追加する API を展開し、追加するアクセス許可を選択します。
[アクセス許可の追加] を選択します.
スコープの削除
Azure AD アプリからアクセス許可を削除するには、次の手順に従います。
Azure でアプリを開きます。
左側の [ 管理] で、[ API のアクセス許可] を選択します。
[コンテキスト] メニュー (アクセス許可の省略記号) を選択します。
[アクセス許可の削除] を選択します。
Throttling
Power BI では、調整を使用して最適なパフォーマンスと信頼性を維持します。 Power BI では、1 人のユーザーからのリソースの過剰使用を防ぐために、ユーザーごとの時間枠内の API 呼び出しの数を制限します。
ユーザーが時間枠内に事前に定義された制限を超える要求の数を送信すると、Power BI は、そのユーザーからのそれ以上の要求を短期間調整します。
アプリケーションで調整が発生すると、Power BI は HTTP 状態コード 429 (要求の数が多すぎます) を返し、応答に Retry-After HTTP ヘッダーが付きます。これは、呼び出し元のアプリケーションが新しい要求を行うまでに待機する必要がある秒数を示します。
REST 操作グループ
次の表に、Power BI REST API 操作グループの一覧を示します。
| 操作グループ | Description |
|---|---|
| 管理者 | 管理タスクに関する作業を行うための操作。 |
| アプリ | アプリに関する作業を行うための操作。 |
| 利用可能な機能 | 利用可能な機能を返す操作。 |
| Capacities | 容量に関する作業を行うための操作。 |
| ダッシュボード | ダッシュボードに関する作業を行うための操作。 |
| データフロー ストレージ アカウント | データフロー ストレージ アカウントに関する作業を行うための操作。 |
| データフロー | データフローに関する作業を行うための操作。 |
| データセット | データセットに関する作業を行うための操作。 |
| 埋め込みトークン | 埋め込みトークンに関する作業を行うための操作。 |
| ゲートウェイ | ゲートウェイに関する作業を行うための操作。 |
| グループ | グループに関する作業を行うための操作。 |
| インポートする | インポートに関する作業を行うための操作。 |
| パイプライン | デプロイ パイプラインを操作するための操作。 |
| プッシュ データセット | プッシュ データセットに関する作業を行うための操作。 |
| レポート | レポートに関する作業を行うための操作。 |
| テンプレート アプリ | テンプレート アプリに関する作業を個なうために操作。 |
| ユーザー | ユーザーに関する作業を行うための操作。 |