Admin - WorkspaceInfo GetScanResult

サービス:: Power BI REST APIs

API バージョン:: v1.0

指定したスキャンのスキャン結果を取得します。

この API 呼び出しは、GetScanStatus API 呼び出し成功した後にのみ行います。スキャン結果は 24 時間使用できます。

権限

ユーザーは、ファブリック管理者であるか、サービスプリンシパルを使用して認証されている必要があります。

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

必要なスコープ

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

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

制限

1 時間あたり最大 500 要求。

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

URI パラメーター

名前	/	必須	型	説明
scanId	path	True	string (uuid)	スキャンをトリガーしたワークスペースまたは Admin - WorkspaceInfo PostWorkspaceInfo API 呼び出しからの応答に含まれるスキャン ID。

応答

名前	型	説明
200 OK	WorkspaceInfoResponse	わかりました

例

Example

要求のサンプル

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

応答のサンプル

状態コード:: 200

{
  "workspaces": [
    {
      "id": "d507422c-8d6d-4361-ac7a-30074a8cd0a1",
      "name": "V2 shared",
      "type": "Workspace",
      "state": "Active",
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "reports": [
        {
          "id": "c6d072d1-ed20-4b60-8329-16c4b934203b",
          "name": "CompositeModelParams-RLS",
          "datasetId": "132593c4-bf8d-4548-8f25-1ebb16a1613c",
          "createdDateTime": "2020-06-16T08:22:49.14",
          "modifiedDateTime": "2020-06-16T08:22:49.14",
          "modifiedBy": "john@contoso.com",
          "reportType": "PaginatedReport",
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "sensitivityLabel": {
            "labelId": "85b38049-4259-43a2-8feb-244e222d96c0"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ],
          "tags": [
            "3b4b36a5-7895-4548-93b7-924e6e65833e",
            "8ce91ed7-8423-4492-b831-48906997aab2"
          ]
        }
      ],
      "dashboards": [
        {
          "id": "80814ece-9302-49e3-b6bc-bad2f7a86c1a",
          "displayName": "CompositeModelParamsDashboard",
          "isReadOnly": false,
          "tiles": [
            {
              "id": "e687cc21-5b32-48f5-8c5e-4b844f190579",
              "title": "CompositeModelParamsDashboard",
              "reportId": "c6d072d1-ed20-4b60-8329-16c4b934203b",
              "datasetId": "132593c4-bf8d-4548-8f25-1ebb16a1613c"
            }
          ],
          "sensitivityLabel": {
            "labelId": "d9b9581a-0594-4c39-81c5-91ddf40baeda"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ],
          "tags": [
            "3b4b36a5-7895-4548-93b7-924e6e65833e",
            "8ce91ed7-8423-4492-b831-48906997aab2"
          ]
        }
      ],
      "datasets": [
        {
          "id": "e7e8a355-e77b-4418-a7b8-ae5972fdaa03",
          "name": "ExportB",
          "tables": [
            {
              "name": "DW_Revenues",
              "columns": [
                {
                  "name": "RowNumber-2662979B-1795-4F74-8F37-6A1BA8059B61",
                  "dataType": "Int64",
                  "isHidden": true
                }
              ],
              "measures": [
                {
                  "name": "MyMeasure",
                  "expression": "CALCULATE(SELECTEDVALUE('DW_Revenues DW_RevenuesTestToBeDeleted'[Numbers])*10)",
                  "description": "My measure",
                  "isHidden": false
                }
              ],
              "isHidden": false,
              "description": "My table",
              "source": [
                {
                  "expression": "let\n    Source = Revenues,\n    Param = RevenuesParam\nin\n    Source"
                }
              ]
            }
          ],
          "relationships": [],
          "configuredBy": "john@contoso.com",
          "targetStorageMode": "Abf",
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "expressions": [
            {
              "name": "Revenues",
              "description": "revenues",
              "expression": "let\n    Source = Sql.Database(\"sqlserver.database.windows.net\", \"DB\"),\n    RevenuesTable = Source{[Schema=\"DB_SCHEMA\",Item=\"DB_SCHEMA_ITEM\"]}[Data]\nin\n    RevenuesTable"
            },
            {
              "name": "RevenuesParam",
              "description": "revenues param",
              "expression": "\"revenues param value\" meta [IsParameterQuery=true, Type=\"Text\", IsParameterQueryRequired=true]"
            }
          ],
          "roles": [
            {
              "name": "Teams",
              "modelPermission": "Read",
              "members": [
                {
                  "memberName": "john@contoso.com",
                  "memberId": "ee96296b-fb71-4f65-a8af-c0ec5a7daced",
                  "memberType": "User",
                  "identityProvider": "AzureAD"
                },
                {
                  "memberName": "group@contoso.com",
                  "memberId": "0a1cdbc3-f82c-4001-8b96-be04ae9d25a3",
                  "memberType": "Group",
                  "identityProvider": "AzureAD"
                }
              ],
              "tablePermissions": [
                {
                  "name": "DW_Revenues DW_RevenuesTest",
                  "filterExpression": "[InTeams] = \"True\""
                }
              ]
            }
          ],
          "upstreamDataflows": [
            {
              "targetDataflowId": "a842dbb1-32ca-46b0-9648-498b2c2d5e38",
              "groupId": "b7416115-7421-42c0-b525-1505ce40d2f0"
            },
            {
              "targetDataflowId": "06898194-2eaf-4122-bacc-133db1f8585d",
              "groupId": "7263838d-80d7-4b8d-a1f6-50fc27e74a97"
            }
          ],
          "datasourceUsages": [
            {
              "datasourceInstanceId": "c79ad907-df19-43fe-a0f7-d9f365d67070"
            }
          ],
          "misconfiguredDatasourceUsages": [
            {
              "datasourceInstanceId": "80ec28bc-fe81-43ea-be52-a07a95cfbcab"
            }
          ],
          "sensitivityLabel": {
            "labelId": "bf3dc57d-d796-41c0-bbe9-a47f5ee3331e"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ],
          "tags": [
            "3b4b36a5-7895-4548-93b7-924e6e65833e",
            "8ce91ed7-8423-4492-b831-48906997aab2"
          ]
        }
      ],
      "dataflows": [
        {
          "objectId": "a842dbb1-32ca-46b0-9648-498b2c2d5e38",
          "name": "Azure SQL",
          "description": "Azure SQL dataflow",
          "configuredBy": "john@contoso.com",
          "modifiedBy": "john@contoso.com",
          "modifiedDateTime": "2020-06-16T08:27:47.783Z",
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "datasourceUsages": [
            {
              "datasourceInstanceId": "c79ad907-df19-43fe-a0f7-d9f365d67070"
            }
          ],
          "misconfiguredDatasourceUsages": [
            {
              "datasourceInstanceId": "80ec28bc-fe81-43ea-be52-a07a95cfbcab"
            }
          ],
          "sensitivityLabel": {
            "labelId": "5c9f8c24-2a94-4fd2-a105-9a8b096c5af1"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ],
          "tags": [
            "3b4b36a5-7895-4548-93b7-924e6e65833e",
            "8ce91ed7-8423-4492-b831-48906997aab2"
          ]
        }
      ],
      "datamarts": [
        {
          "id": "9df8d63c-db5b-44c3-a8e3-9f8c8ec1eec2",
          "name": "MyDatamart",
          "description": "SQL datamart",
          "type": "Sql",
          "configuredBy": "john@contoso.com",
          "configuredById": "5c9f8c24-2a94-4fd2-a105-9a8b096cdsew",
          "modifiedBy": "john@contoso.com",
          "modifiedDateTime": "2020-06-16T08:27:47.783Z",
          "sensitivityLabel": {
            "labelId": "5c9f8c24-2a94-4fd2-a105-9a8b096c5af1"
          },
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "UpstreamDataflows": [
            {
              "targetDataflowId": "5c9f8c24-2a94-34fd-a105-9a8b096c4555",
              "groupId": "5c9f8c24-4dsc-4fd2-a105-9a8b096c4fgt"
            }
          ],
          "datasourceUsages": [
            {
              "datasourceInstanceId": "c79ad907-df19-43fe-a0f7-d9f365d67070"
            }
          ],
          "Users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User",
              "userType": "User",
              "profile": {
                "id": "45416453",
                "displayName": "John's profile"
              },
              "datamartUserAccessRight": "Read"
            }
          ],
          "tags": [
            "3b4b36a5-7895-4548-93b7-924e6e65833e",
            "8ce91ed7-8423-4492-b831-48906997aab2"
          ]
        }
      ],
      "users": [
        {
          "displayName": "John Nick",
          "emailAddress": "john@contoso.com",
          "appUserAccessRight": "ReadExplore",
          "identifier": "john@contoso.com",
          "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
          "principalType": "User"
        }
      ]
    }
  ],
  "datasourceInstances": [
    {
      "datasourceType": "Sql",
      "connectionDetails": {
        "server": "qlserver.database.windows.net",
        "database": "dbo.largest_table"
      },
      "datasourceId": "c79ad907-df19-43fe-a0f7-d9f365d67070",
      "gatewayId": "e820592e-f8cf-4a6f-b1ed-566799d29565"
    }
  ],
  "misconfiguredDatasourceInstances": [
    {
      "datasourceType": "Sql",
      "connectionDetails": {
        "server": "sqlserver.database.windows.net",
        "database": "dbo.table"
      },
      "datasourceId": "80ec28bc-fe81-43ea-be52-a07a95cfbcab",
      "gatewayId": "505a19c1-4190-4e8e-a4f6-dd72722feced"
    }
  ]
}

定義

名前	説明
ASMashupExpression	データセットテーブルソース
Column	データセット列
DashboardUser	ダッシュボードの Power BI ユーザーアクセス権エントリ
DashboardUserAccessRight	ユーザーがダッシュボードに対して持っているアクセス権 (アクセス許可レベル)
DataflowUser	データフローの Power BI ユーザーアクセス権エントリ
DataflowUserAccessRight	ユーザーがデータフローに対して持っているアクセス権 (アクセス許可レベル)
datamartState	データマートの現在の状態
datamartStatus	データマートの状態
datamartType	データマート型
DatamartUser	レポートの Power BI ユーザーアクセス権エントリ
DatamartUserAccessRight	ユーザーがデータマートに対して持っているアクセス権 (アクセス許可レベル)
DatasetUser	データセットの Power BI ユーザーアクセス権エントリ
DatasetUserAccessRight	ユーザーがデータセットに対して持っているアクセス権 (アクセス許可レベル)
Datasource	Power BI データソース
DatasourceConnectionDetails	Power BI データソース接続の詳細。「データソースの取得」または「グループでデータソースを取得」の例を参照してください。
DatasourceUsage	データソースの使用状況
DefaultDatasetStorageFormat	グループ内の既定のデータセットストレージ形式
DependentDataflow	Power BI 依存データフロー
DependentDatamart	Power BI 依存データマート
DependentDataset	Power BI 依存データセット
EndorsementDetails	Power BI の保証の詳細
Expression	データセット式
GroupUser	ワークスペースにアクセスできる Power BI ユーザー
GroupUserAccessRight	ユーザーがワークスペースに対して持っているアクセス権 (アクセス許可レベル)
Measure	Power BI メジャー
PrincipalType	プリンシパルの種類
ReportUser	レポートの Power BI ユーザーアクセス権エントリ
ReportUserAccessRight	ユーザーがレポートに対して持っているアクセス権 (アクセス許可レベル)
Role	データセットの RLS 構成のロール
RoleMember	ロールメンバー
RoleTablePermission	ロールフィルター
Row	データセット内のデータ行
SensitivityLabel	Power BI アイテムの秘密度ラベル情報 (レポートやダッシュボードなど)
ServicePrincipalProfile	Power BI サービスプリンシパルプロファイル。 Power BI Embedded マルチテナントソリューションにのみ関連します。
Table	データセットテーブル
WorkspaceInfo	ワークスペース情報の詳細
WorkspaceInfoDashboard	WorkspaceInfo API によって返される Power BI ダッシュボード。この API は、次のダッシュボードプロパティの一覧のサブセットを返します。サブセットは、呼び出された API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に依存します。
WorkspaceInfoDataflow	ワークスペース情報 API によって返されるデータフローのメタデータ。データフローに対して返される可能性があるプロパティの一覧を次に示します。呼び出される API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に応じて、プロパティのサブセットのみが返されます。
WorkspaceInfoDatamart	ワークスペース情報 API によって返される Power BI データマート。この API は、次のデータマートプロパティの一覧のサブセットを返します。サブセットは、呼び出された API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に依存します。
WorkspaceInfoDataset	WorkspaceInfo API によって返される Power BI データセット。この API は、次のデータセットプロパティの一覧のサブセットを返します。サブセットは、呼び出された API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に依存します。
WorkspaceInfoReport	ワークスペース情報 API によって返される Power BI レポート。この API は、次のレポートプロパティの一覧のサブセットを返します。サブセットは、呼び出された API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に依存します。
WorkspaceInfoResponse	ワークスペース情報の応答
WorkspaceInfoTile	WorkspaceInfo API によって返される Power BI タイル

ASMashupExpression

Object

データセットテーブルソース

名前	型	説明
expression	string	ソース式

Column

Object

データセット列

名前	型	説明
dataCategory	string	随意。この列内のデータを記述するデータカテゴリに使用する文字列値。
dataType	string	列のデータ型
formatString	string	随意。 FORMAT_STRINGで指定されている列の形式。
isHidden	boolean	随意。列が非表示かどうか。既定値は `false`です。
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	列名
sortByColumn	string	随意。現在の列の順序付けに使用する同じテーブル内の列の文字列名。
summarizeBy	string	随意。この列の集計に使用する集計関数。

DashboardUser

Object

ダッシュボードの Power BI ユーザーアクセス権エントリ

名前	型	説明
dashboardUserAccessRight	DashboardUserAccessRight	ユーザーがダッシュボードに対して持っているアクセス権 (アクセス許可レベル)
displayName	string	プリンシパルの表示名
emailAddress	string	ユーザーのメールアドレス
graphId	string	Microsoft Graph のプリンシパルの識別子。管理者 API でのみ使用できます。
identifier	string	プリンシパルの識別子
principalType	PrincipalType	プリンシパルの種類
profile	ServicePrincipalProfile	Power BI サービスプリンシパルプロファイル。 Power BI Embedded マルチテナントソリューションにのみ関連します。
userType	string	ユーザーの種類。

DashboardUserAccessRight

列挙

ユーザーがダッシュボードに対して持っているアクセス権 (アクセス許可レベル)

値	説明
None	ダッシュボード内のコンテンツに対するアクセス許可がない
Read	ダッシュボード内のコンテンツへの読み取りアクセス権を付与します
ReadWrite	ダッシュボード内のコンテンツに対する読み取りと書き込みのアクセス権を付与します
ReadReshare	ダッシュボード内のコンテンツへの読み取りと再共有のアクセス権を付与します
ReadCopy	ダッシュボード内のコンテンツへの読み取りとコピーのアクセス権を付与します
Owner	レポート内のコンテンツへの読み取り、書き込み、および再共有アクセスを許可します

DataflowUser

Object

データフローの Power BI ユーザーアクセス権エントリ

名前	型	説明
DataflowUserAccessRight	DataflowUserAccessRight	ユーザーがデータフローに対して持っているアクセス権 (アクセス許可レベル)
displayName	string	プリンシパルの表示名
emailAddress	string	ユーザーのメールアドレス
graphId	string	Microsoft Graph のプリンシパルの識別子。管理者 API でのみ使用できます。
identifier	string	プリンシパルの識別子
principalType	PrincipalType	プリンシパルの種類
profile	ServicePrincipalProfile	Power BI サービスプリンシパルプロファイル。 Power BI Embedded マルチテナントソリューションにのみ関連します。
userType	string	ユーザーの種類。

DataflowUserAccessRight

列挙

ユーザーがデータフローに対して持っているアクセス権 (アクセス許可レベル)

値	説明
None	データフロー内のコンテンツへのアクセス許可を削除します
Read	データフロー内のコンテンツへの読み取りアクセスを許可します
ReadWrite	データフロー内のコンテンツへの読み取りと書き込みアクセスを許可します
ReadReshare	データフロー内のコンテンツへの読み取りと再共有アクセスを許可します
Owner	データフロー内のコンテンツへの読み取り、書き込み、および再共有アクセスを許可します

datamartState

列挙

データマートの現在の状態

値	説明
Invalid	データマートの状態が無効です
Initialized	データマートが初期化されました
Active	データマートがアクティブである
Migrating	データマートは移行中です
Evicted	データマートが削除されました
Deleted	データマートが削除されました

datamartStatus

列挙

データマートの状態

値	説明
Invalid	データマートの状態が無効です
Available	データマートが利用可能です
SuspendedInCriticalPhase	データマートがクリティカルフェーズで中断される
InProgress	データマートが進行中です
Error	データマートにエラー状態がある
OutOfRegion	データマートがリージョン外である
NoCapacity	データマートに容量がない

datamartType

列挙

データマート型

値	説明
Unset	データマート型が未設定だった
Ignore	データマートに型がありません
Sql	datamart は Sql 型です
Lakehouse	データマートは Lakehouse 型です
Dataverse	Datamart は Dataverse 型です
Datawarehouse	Datamart は Datawarehouse 型です

DatamartUser

Object

レポートの Power BI ユーザーアクセス権エントリ

名前	型	説明
datamartUserAccessRight	DatamartUserAccessRight	ユーザーがデータマートに対して持っているアクセス権 (アクセス許可レベル)
displayName	string	プリンシパルの表示名
emailAddress	string	ユーザーのメールアドレス
graphId	string	Microsoft Graph のプリンシパルの識別子。管理者 API でのみ使用できます。
identifier	string	プリンシパルの識別子
principalType	PrincipalType	プリンシパルの種類
profile	ServicePrincipalProfile	Power BI サービスプリンシパルプロファイル。 Power BI Embedded マルチテナントソリューションにのみ関連します。
userType	string	ユーザーの種類。

DatamartUserAccessRight

列挙

ユーザーがデータマートに対して持っているアクセス権 (アクセス許可レベル)

値	説明
None	datamart 内のコンテンツに対するアクセス許可がない
Read	datamart 内のコンテンツへの読み取りアクセスを許可します
Write	datamart のコンテンツへの書き込みアクセスを許可する
Reshare	datamart 内のコンテンツへの再共有アクセスを許可します
Explore	Datamart のコンテンツへのアクセスを探索する権限を付与します
ReadWrite	datamart 内のコンテンツへの読み取りと書き込みアクセスを許可します
ReadReshare	datamart 内のコンテンツへの読み取りと再共有アクセスを許可します
ReadWriteReshare	datamart 内のコンテンツへの読み取りと書き込みおよび再共有アクセスを許可します
ReadExplore	datamart 内のコンテンツへの読み取りと探索のアクセスを許可します
ReadReshareExplore	datamart のコンテンツへの読み取りと再共有と探索アクセスを許可します
ReadWriteExplore	datamart 内のコンテンツへの読み取りと書き込みアクセスを許可します
ReadWriteReshareExplore	datamart のコンテンツへの読み取りと書き込み、再共有、および探索アクセスを許可します

DatasetUser

Object

データセットの Power BI ユーザーアクセス権エントリ

名前	型	説明
datasetUserAccessRight	DatasetUserAccessRight	ユーザーがデータセットに対して持っているアクセス権 (アクセス許可レベル)
displayName	string	プリンシパルの表示名
emailAddress	string	ユーザーのメールアドレス
graphId	string	Microsoft Graph のプリンシパルの識別子。管理者 API でのみ使用できます。
identifier	string	プリンシパルの識別子
principalType	PrincipalType	プリンシパルの種類
profile	ServicePrincipalProfile	Power BI サービスプリンシパルプロファイル。 Power BI Embedded マルチテナントソリューションにのみ関連します。
userType	string	ユーザーの種類。

DatasetUserAccessRight

列挙

ユーザーがデータセットに対して持っているアクセス権 (アクセス許可レベル)

値	説明
None	データセット内のコンテンツへのアクセス許可を削除します
Read	データセット内のコンテンツへの読み取りアクセス権を付与します
ReadWrite	データセット内のコンテンツに対する読み取りと書き込みのアクセス権を付与します
ReadReshare	データセット内のコンテンツへの読み取りと再共有のアクセス権を付与します
ReadWriteReshare	データセット内のコンテンツへの読み取り、書き込み、および再共有アクセスを許可します
ReadExplore	データセット内のコンテンツへの読み取りと探索のアクセス権を付与します
ReadReshareExplore	データセット内のコンテンツへの読み取り、再共有、探索アクセスを許可します
ReadWriteExplore	データセット内のコンテンツへの読み取り、書き込み、探索のアクセス権を付与します
ReadWriteReshareExplore	データセット内のコンテンツへの読み取り、書き込み、再共有、探索アクセスを許可します

Datasource

Object

Power BI データソース

名前	型	説明
connectionDetails	DatasourceConnectionDetails	データソース接続の詳細
connectionString	string	(非推奨)データソース接続文字列。 DirectQuery でのみ使用できます。
datasourceId	string (uuid)	バインドされたデータソース ID。ゲートウェイにバインドされていない場合は空です
datasourceType	string	データソースの種類
gatewayId	string (uuid)	バインドされたゲートウェイ ID。ゲートウェイにバインドされていない場合は空です。ゲートウェイクラスターを使用する場合、ゲートウェイ ID はクラスター内のプライマリ (最初の) ゲートウェイを参照し、ゲートウェイクラスター ID と似ています。
name	string	(非推奨)データソース名。 DirectQuery でのみ使用できます。

DatasourceConnectionDetails

Object

Power BI データソース接続の詳細。「データソースの取得」または「グループでデータソースを取得」の例を参照してください。

名前	型	説明
account	string	接続アカウント
classInfo	string	接続クラス情報
database	string	接続データベース
domain	string	接続ドメイン
emailAddress	string	接続メールアドレス
kind	string	接続の種類
loginServer	string	接続ログインサーバー
path	string	接続パス
server	string	接続サーバー
url	string	接続 URL

DatasourceUsage

Object

データソースの使用状況

名前	型	説明
datasourceInstanceId	string (uuid)	データソースインスタンス ID

DefaultDatasetStorageFormat

列挙

グループ内の既定のデータセットストレージ形式

値	説明
Small	小さなデータセットストレージ形式
Large	大規模なデータセットストレージ形式

DependentDataflow

Object

Power BI 依存データフロー

名前	型	説明
groupId	string	ターゲットグループ ID
targetDataflowId	string	ターゲットデータフロー ID

DependentDatamart

Object

Power BI 依存データマート

名前	型	説明
groupId	string	ターゲットグループ ID
targetDatamartId	string	ターゲットデータマート ID

DependentDataset

Object

Power BI 依存データセット

名前	型	説明
groupId	string	ターゲットグループ ID
targetDatasetId	string	ターゲットデータセット ID

EndorsementDetails

Object

Power BI の保証の詳細

名前	型	説明
certifiedBy	string	Power BI アイテムを認定したユーザー (レポートやダッシュボードなど)
endorsement	string	保証の状態

Expression

Object

データセット式

名前	型	説明
description	string	式の説明
expression	string	式の値
name	string	式の名前

GroupUser

Object

ワークスペースにアクセスできる Power BI ユーザー

名前	型	説明
displayName	string	プリンシパルの表示名
emailAddress	string	ユーザーのメールアドレス
graphId	string	Microsoft Graph のプリンシパルの識別子。管理者 API でのみ使用できます。
groupUserAccessRight	GroupUserAccessRight	ユーザーがワークスペースに対して持っているアクセス権 (アクセス許可レベル)
identifier	string	プリンシパルの識別子
principalType	PrincipalType	プリンシパルの種類
profile	ServicePrincipalProfile	Power BI サービスプリンシパルプロファイル。 Power BI Embedded マルチテナントソリューションにのみ関連します。
userType	string	ユーザーの種類。

GroupUserAccessRight

列挙

ユーザーがワークスペースに対して持っているアクセス権 (アクセス許可レベル)

値	説明
None	ワークスペースコンテンツにアクセスできない
Member	ワークスペースコンテンツに対する読み取り、再共有、探索 (ReadReshareExplore) アクセス権
Admin	ワークスペースコンテンツに対する管理者権限
Contributor	ワークスペースコンテンツへの読み取りと探索 (ReadExplore) アクセス
Viewer	ワークスペースコンテンツへの読み取り専用 (読み取り) アクセス

Measure

Object

Power BI メジャー

名前	型	説明
description	string	随意。メジャーの説明。
expression	string	有効な DAX 式
formatString	string	随意。 FORMAT_STRINGで指定されているように値を表示する場合の書式設定方法を説明する文字列。
isHidden	boolean	随意。メジャーが非表示かどうか。
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	メジャー名

PrincipalType

列挙

プリンシパルの種類

値	説明
None	プリンシパルの種類はありません。組織全体レベルのアクセスに使用します。
User	ユーザープリンシパルの種類
Group	グループプリンシパルの種類
App	サービスプリンシパルの種類

ReportUser

Object

レポートの Power BI ユーザーアクセス権エントリ

名前	型	説明
displayName	string	プリンシパルの表示名
emailAddress	string	ユーザーのメールアドレス
graphId	string	Microsoft Graph のプリンシパルの識別子。管理者 API でのみ使用できます。
identifier	string	プリンシパルの識別子
principalType	PrincipalType	プリンシパルの種類
profile	ServicePrincipalProfile	Power BI サービスプリンシパルプロファイル。 Power BI Embedded マルチテナントソリューションにのみ関連します。
reportUserAccessRight	ReportUserAccessRight	ユーザーがレポートに対して持っているアクセス権 (アクセス許可レベル)
userType	string	ユーザーの種類。

ReportUserAccessRight

列挙

ユーザーがレポートに対して持っているアクセス権 (アクセス許可レベル)

値	説明
None	レポート内のコンテンツに対するアクセス許可がない
Read	レポート内のコンテンツへの読み取りアクセス権を付与します
ReadWrite	レポート内のコンテンツに対する読み取りと書き込みのアクセス権を付与します
ReadReshare	レポート内のコンテンツへの読み取りと再共有のアクセス権を付与します
ReadCopy	レポート内のコンテンツへの読み取りとコピーのアクセス権を付与します
Owner	レポート内のコンテンツへの読み取り、書き込み、および再共有アクセスを許可します

Role

Object

データセットの RLS 構成のロール

名前	型	説明
members	RoleMember	ロールのメンバーを一覧表示する配列
modelPermission	string	ロールがデータセットに対して持つアクセス許可。たとえば、読み取り
name	string	ロールの名前
tablePermissions	RoleTablePermission	ロールに定義されているすべてのフィルターを一覧表示する配列

RoleMember

Object

ロールメンバー

名前	型	説明
identityProvider	string	ロールメンバー ID プロバイダー
memberId	string	ID プロバイダーによって割り当てられたロールメンバー GUID
memberName	string	ロールメンバーの名前
memberType	string	ロールメンバーの種類 (ユーザーまたはグループ)

RoleTablePermission

Object

ロールフィルター

名前	型	説明
filterExpression	string	フィルターで指定されたテーブルをフィルター処理する式
name	string	フィルターで指定されたテーブルの名前

Row

Object

データセット内のデータ行

名前	型	説明
id	string	一意の行 ID

SensitivityLabel

Object

Power BI アイテムの秘密度ラベル情報 (レポートやダッシュボードなど)

名前	型	説明
labelId	string (uuid)	秘密度ラベル ID

ServicePrincipalProfile

Object

Power BI サービスプリンシパルプロファイル。 Power BI Embedded マルチテナントソリューションにのみ関連します。

名前	型	説明
displayName	string	サービスプリンシパルプロファイル名
id	string (uuid)	サービスプリンシパルプロファイル ID

Table

Object

データセットテーブル

名前	型	説明
columns	Column[]	このテーブルの列スキーマ
description	string	テーブルの説明
isHidden	boolean	随意。このデータセットテーブルが非表示かどうか。
measures	Measure[]	この表内のメジャー
name	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$	テーブル名
rows	Row[]	このテーブル内のデータ行
source	ASMashupExpression[]	テーブルソース

WorkspaceInfo

Object

ワークスペース情報の詳細

名前	型	説明
capacityId	string	ワークスペースの容量 ID
dashboards	WorkspaceInfoDashboard[]	このワークスペースに関連付けられているダッシュボード。返されるダッシュボードプロパティの一覧は API 呼び出しによって異なるため、API 応答にすべてのダッシュボードプロパティが表示されない場合があります。
dataRetrievalState	string	ワークスペースデータの取得状態
dataflows	WorkspaceInfoDataflow[]	このワークスペースに関連付けられているデータフロー。返されるデータフロープロパティの一覧は API 呼び出しによって異なるため、API 応答にすべてのデータフロープロパティが表示されない場合があります。
datamarts	WorkspaceInfoDatamart[]	このワークスペースに関連付けられているデータマート。返されるデータマートプロパティの一覧は API 呼び出しによって異なるため、API 応答にすべてのデータマートプロパティが表示されない場合があります。
datasets	WorkspaceInfoDataset[]	このワークスペースに関連付けられているデータセット。返されるデータセットプロパティの一覧は API 呼び出しによって異なるため、API 応答にすべてのデータセットプロパティが表示されない場合があります。
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	ワークスペース内の既定のデータセットストレージ形式。 `isOnDedicatedCapacity` が `true` されている場合にのみ返されます
description	string	ワークスペースの説明
id	string (uuid)	ワークスペースオブジェクト ID
isOnDedicatedCapacity	boolean	ワークスペースが専用容量に割り当てられているかどうか
name	string	ワークスペース名
reports	WorkspaceInfoReport[]	このワークスペースに関連付けられているレポート。返されるレポートプロパティの一覧は API 呼び出しによって異なるため、API 応答にすべてのレポートプロパティが表示されない場合があります。
state	string	ワークスペースの状態
type	string	ワークスペースの種類
users	GroupUser[]	ワークスペースにアクセスできるユーザー。リストは、明示的に要求された場合にのみ返されます。クラシックワークスペースのユーザーの一覧を取得するには、Azure Active Directory Graph API を使用します。

WorkspaceInfoDashboard

Object

WorkspaceInfo API によって返される Power BI ダッシュボード。この API は、次のダッシュボードプロパティの一覧のサブセットを返します。サブセットは、呼び出された API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に依存します。

名前	型	説明
appId	string	ダッシュボードがアプリに属している場合にのみ返されるアプリ ID
dataClassification	string	Power BI アイテムのデータ分類タグ (レポートやダッシュボードなど)
displayName	string	ダッシュボードの表示名
id	string (uuid)	ダッシュボード ID
isReadOnly	boolean	ダッシュボードが読み取り専用かどうか
sensitivityLabel	SensitivityLabel	秘密度ラベル
tags	string[] (uuid)	アイテムに適用されるタグの一意識別子。
tiles	WorkspaceInfoTile[]	ダッシュボードに属するタイル
users	DashboardUser[]	(空の値)ダッシュボードのユーザーアクセスの詳細。このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI ダッシュボードでユーザー情報を取得するには、管理 API 呼び出しとしてダッシュボードユーザーを取得するか、パラメーターを使用した `getArtifactUsers` API 呼び出しを使用します。

WorkspaceInfoDataflow

Object

ワークスペース情報 API によって返されるデータフローのメタデータ。データフローに対して返される可能性があるプロパティの一覧を次に示します。呼び出される API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に応じて、プロパティのサブセットのみが返されます。

名前	型	説明
configuredBy	string	データフローの所有者
datasourceUsages	DatasourceUsage[]	データソースの使用状況
description	string	データフローの説明
endorsementDetails	EndorsementDetails	保証の詳細
misconfiguredDatasourceUsages	DatasourceUsage[]	データソースの使用状況が正しく構成されていません
modelUrl	string	データフロー定義ファイルへの URL (model.json)
name	string	データフロー名
objectId	string (uuid)	データフロー ID
sensitivityLabel	SensitivityLabel	秘密度ラベル
tags	string[] (uuid)	アイテムに適用されるタグの一意識別子。
upstreamDataflows	DependentDataflow[]	この項目が依存するすべてのデータフローの一覧
upstreamDatamarts	DependentDatamart[]	この項目が依存するすべてのデータマートのリスト
users	DataflowUser[]	(空の値)データフローユーザーアクセスの詳細。このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI データフローに関するユーザー情報を取得するには、Admin API 呼び出しとしてデータフローユーザーを取得するか、パラメーターを使用して `getArtifactUser` API 呼び出しを使用します。

WorkspaceInfoDatamart

Object

ワークスペース情報 API によって返される Power BI データマート。この API は、次のデータマートプロパティの一覧のサブセットを返します。サブセットは、呼び出された API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に依存します。

名前	型	説明
configuredBy	string	データマート所有者の名前
configuredById	string	データマート所有者の ID
datasourceUsages	DatasourceUsage[]	データソースの使用状況
description	string	datamart の説明
endorsementDetails	EndorsementDetails	データマートの保証の詳細
id	string (uuid)	データマート ID
modifiedBy	string	データマートを最後に変更したユーザー
modifiedById	string	データマートを変更した最後のユーザーの ID
modifiedDateTime	string (date-time)	データマートが最後に変更された日時
name	string	データマート名
sensitivityLabel	SensitivityLabel	データマート秘密度ラベル
state	datamartState	データマートの現在の状態
status	datamartStatus	データマートの状態
suspendedBatchId	string	datamart suspended batch id
tags	string[] (uuid)	アイテムに適用されるタグの一意識別子。
type	datamartType	データマート型
upstreamDataflows	DependentDataflow[]	この項目が依存するすべてのデータフローの一覧
upstreamDatamarts	DependentDatamart[]	この項目が依存するすべてのデータマートのリスト
users	DatamartUser[]	Power BI データマートのユーザーアクセスの詳細。

WorkspaceInfoDataset

Object

WorkspaceInfo API によって返される Power BI データセット。この API は、次のデータセットプロパティの一覧のサブセットを返します。サブセットは、呼び出された API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に依存します。

名前	型	説明
ContentProviderType	string	無視する必要がある非推奨のプロパティ。
configuredBy	string	データセットの所有者
createdDate	string (date-time)	データセットの作成日時
datasourceUsages	DatasourceUsage[]	データソースの使用状況
description	string	データセットの説明
endorsementDetails	EndorsementDetails	保証の詳細
expressions	Expression[]	データセット式
id	string	データセット ID
misconfiguredDatasourceUsages	DatasourceUsage[]	データソースの使用状況が正しく構成されていません
name	string	データセット名
roles	Role[]	データセットロール
schemaMayNotBeUpToDate	boolean	データセットスキーマが最新ではない可能性があるかどうか
schemaRetrievalError	string	データセットスキーマの取得エラー
sensitivityLabel	SensitivityLabel	秘密度ラベル
tables	Table[]	データセットテーブル
tags	string[] (uuid)	アイテムに適用されるタグの一意識別子。
targetStorageMode	string	データセットストレージモード
upstreamDataflows	DependentDataflow[]	この項目が依存するすべてのデータフローの一覧
upstreamDatamarts	DependentDatamart[]	この項目が依存するすべてのデータマートのリスト
upstreamDatasets	DependentDataset[]	アップストリームデータセット
users	DatasetUser[]	(空の値)データセットのユーザーアクセスの詳細。このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI アイテム (レポートやダッシュボードなど) のユーザー情報を取得するには、Admin API としてデータセットユーザーを取得するか、パラメーターを使用して `getArtifactUsers` API を使用します。

WorkspaceInfoReport

Object

ワークスペース情報 API によって返される Power BI レポート。この API は、次のレポートプロパティの一覧のサブセットを返します。サブセットは、呼び出された API、呼び出し元のアクセス許可、および Power BI データベース内のデータの可用性に依存します。

名前	型	説明
appId	string	レポートがアプリに属している場合にのみ返されるアプリ ID
createdBy	string	レポートの所有者。 2019 年 6 月以降に作成されたレポートでのみ使用できます。
createdById	string	レポート所有者の ID。 2019 年 6 月以降に作成されたレポートでのみ使用できます。
createdDateTime	string (date-time)	レポートの作成日時
datasetId	string	レポートのデータセット ID
datasetWorkspaceId	string (uuid)	関連するデータセットが別のワークスペースに属している場合にのみ返される、関連データセットのワークスペース ID
description	string	レポートの説明
endorsementDetails	EndorsementDetails	保証の詳細
format	string	レポート定義の形式の種類。 PowerBIReport の場合: PBIR PBIR-Legacy PaginatedReport の場合: `RDL`
id	string (uuid)	レポート ID
isOwnedByMe	boolean	現在のユーザーがレポートのコピーを変更または作成できるかどうかを示します。
modifiedBy	string	レポートを最後に変更したユーザー
modifiedById	string	レポートを変更した最後のユーザーの ID
modifiedDateTime	string (date-time)	レポートが最後に変更された日時
name	string	レポートの名前。アプリレポートはプレフィックス [App] で始まります。
originalReportId	string (uuid)	ワークスペースがアプリとして発行されたときの実際のレポート ID。
reportType	enum: PaginatedReport PowerBIReport	レポートの種類
sensitivityLabel	SensitivityLabel	秘密度ラベル
tags	string[] (uuid)	アイテムに適用されるタグの一意識別子。
users	ReportUser[]	(空の値)Power BI レポートのユーザーアクセスの詳細。このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI レポートのユーザー情報を取得するには、Admin API 呼び出しとしてレポートユーザーを取得するか、パラメーターを使用した `getArtifactUsers` API 呼び出しを使用します。

WorkspaceInfoResponse

Object

ワークスペース情報の応答

名前	型	説明
datasourceInstances	Datasource[]	このスキャンに関連付けられているデータソースインスタンス
misconfiguredDatasourceInstances	Datasource[]	このスキャンに関連付けられているデータソースのインスタンスが正しく構成されていません
workspaces	WorkspaceInfo[]	このスキャンに関連付けられているワークスペース情報

WorkspaceInfoTile

Object

WorkspaceInfo API によって返される Power BI タイル

名前	型	説明
datasetId	string	データセット ID。レポートから作成されたタイル、または Q&A タイルなどのデータセットを使用して作成されたタイルでのみ使用できます。
datasetWorkspaceId	string (uuid)	関連するデータセットが別のワークスペースに属している場合にのみ返される、関連データセットのワークスペース ID
id	string (uuid)	タイル ID
reportId	string (uuid)	レポート ID。レポートから作成されたタイルでのみ使用できます。
title	string	タイルの表示名

次の方法で共有

Admin - WorkspaceInfo GetScanResult

権限

必要なスコープ

制限

URI パラメーター

応答

例

Example

要求のサンプル

応答のサンプル

定義

ASMashupExpression

Column

DashboardUser

DashboardUserAccessRight

DataflowUser

DataflowUserAccessRight

datamartState

datamartStatus

datamartType

DatamartUser

DatamartUserAccessRight

DatasetUser

DatasetUserAccessRight

Datasource

DatasourceConnectionDetails

DatasourceUsage

DefaultDatasetStorageFormat

DependentDataflow

DependentDatamart

DependentDataset

EndorsementDetails

Expression

GroupUser

GroupUserAccessRight

Measure

PrincipalType

ReportUser

ReportUserAccessRight

Role

RoleMember

RoleTablePermission

Row

SensitivityLabel

ServicePrincipalProfile

Table

WorkspaceInfo

WorkspaceInfoDashboard

WorkspaceInfoDataflow

WorkspaceInfoDatamart

WorkspaceInfoDataset

WorkspaceInfoReport

WorkspaceInfoResponse

WorkspaceInfoTile