Admin - WorkspaceInfo GetScanStatus

  • リファレンス
Service:
Power BI REST APIs
API Version:
v1.0

指定したスキャンのスキャン状態を取得します。

アクセス許可

ユーザーは管理者権限 (Microsoft 365 グローバル管理者や Power BI サービス管理者など) を持っているか、サービス プリンシパルを使用して認証する必要があります。

サービス プリンシパル認証で実行する場合、アプリには、Azure portalで Power BI に対して管理者の同意が必要なアクセス許可が設定されている必要はありません。

必要なスコープ

Tenant.Read.All または Tenant.ReadWrite.All

標準の委任された管理者アクセス トークンを使用して認証する場合にのみ関連します。 サービス プリンシパルによる認証を使用する場合は、存在しない必要があります。

制限事項

1 時間あたり最大 10,000 件の要求。 

GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/scanStatus/{scanId}

URI パラメーター

名前 / 必須 型 説明
scanId
 path True

string

uuid

スキャンをトリガーしたワークスペースまたは 管理 - WorkspaceInfo PostWorkspaceInfo API 呼び出しからの応答に含まれるスキャン ID。

応答

名前 型 説明
200 OK

ScanRequest

OK

例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/scanStatus/e7d03602-4873-4760-b37e-1563ef5358e3

Sample Response

Status code:
200 
{
  "id": "e7d03602-4873-4760-b37e-1563ef5358e3",
  "createdDateTime": "2020-06-15T16:46:28.0487687Z",
  "status": "Succeeded"
}

定義

名前 説明
PowerBIApiErrorResponseDetail

Power BI エラー応答に関する詳細情報
ScanRequest

スキャン要求

PowerBIApiErrorResponseDetail

Power BI エラー応答に関する詳細情報

名前 型 説明
code

string

エラー コード
message

string

エラー メッセージ
target

string

エラーターゲット

ScanRequest

スキャン要求

名前 型 説明
createdDateTime

string

スキャンの作成日時
error

PowerBIApiErrorResponseDetail

スキャン エラー (存在する場合)
id

string

スキャン ID
status

string

スキャンの状態