Admin - WorkspaceInfo GetScanResult

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

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

アクセス許可

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

サービス プリンシパル認証で実行する場合、アプリには、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

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

応答

名前 説明
200 OK

WorkspaceInfoResponse

OK

Example

Sample Request

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

Sample Response

{
  "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"
            }
          ]
        }
      ],
      "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"
            }
          ]
        }
      ],
      "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"
            }
          ]
        }
      ],
      "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"
            }
          ]
        }
      ],
      "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"
            }
          ]
        }
      ],
      "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

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

名前 説明
expression

string

ソース式

Column

データセット列

名前 説明
dataCategory

string

省略可能。 この列内のデータを記述するデータ カテゴリに使用される文字列値。

dataType

string

列データ型

formatString

string

省略可能。 FORMAT_STRINGで指定された列の形式。

isHidden

boolean

省略可能。 列が非表示かどうか。 既定値は、false です。

name

string

列名

sortByColumn

string

省略可能。 同一テーブル内の列の文字列名であり、現在の列を並べ替えるために使用されます。

summarizeBy

string

省略可能。 この列の集計に使用する集計関数。

DashboardUser

ダッシュボードの 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

string

ダッシュボード内のコンテンツに対するアクセス許可がない

Owner

string

レポート内のコンテンツへの読み取り、書き込み、再共有のアクセス権を付与します

Read

string

ダッシュボード内のコンテンツへの読み取りアクセス権を付与します

ReadCopy

string

ダッシュボード内のコンテンツへの読み取りとコピーのアクセス権を付与します

ReadReshare

string

ダッシュボード内のコンテンツへの読み取りと再共有のアクセス権を付与します

ReadWrite

string

ダッシュボード内のコンテンツへの読み取りと書き込みのアクセス権を付与します

DataflowUser

データフローの 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

string

データフロー内のコンテンツに対するアクセス許可を削除します

Owner

string

データフロー内のコンテンツへの読み取り、書き込み、再共有アクセスを許可します

Read

string

データフロー内のコンテンツへの読み取りアクセス権を付与します

ReadReshare

string

データフロー内のコンテンツへの読み取りと再共有のアクセスを許可します

ReadWrite

string

データフロー内のコンテンツに対する読み取りおよび書き込みアクセス権を付与します

datamartState

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

名前 説明
Active

string

データマートがアクティブです

Deleted

string

データマートが削除されました

Evicted

string

データマートが削除されました

Initialized

string

データマートが初期化されました

Invalid

string

データマートの状態が無効です

Migrating

string

データマートが移行中

datamartStatus

データマートの状態

名前 説明
Available

string

データマートを使用できます

Error

string

データマートにエラー状態がある

InProgress

string

データマートが進行中です

Invalid

string

データマートの状態が無効です

NoCapacity

string

データマートに容量がありません

OutOfRegion

string

データマートがリージョン外である

SuspendedInCriticalPhase

string

データマートがクリティカル フェーズで中断される

datamartType

データマートの種類

名前 説明
Dataverse

string

データマートは Dataverse 型です

Datawarehouse

string

データマートは Datawarehouse 型です

Ignore

string

データマートに型がありません

Lakehouse

string

データマートは Lakehouse 型です

Sql

string

データマートは Sql 型です

Unset

string

データマートの種類が未設定でした

DatamartUser

レポートの 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

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

名前 説明
Explore

string

データマート内のコンテンツへのアクセスを探索する許可

None

string

データマート内のコンテンツに対するアクセス許可なし

Read

string

データマート内のコンテンツへの読み取りアクセス権を付与します

ReadExplore

string

データマート内のコンテンツへの読み取りと探索アクセスを許可します

ReadReshare

string

データマート内のコンテンツへの読み取りと再共有アクセスを許可します

ReadReshareExplore

string

データマート内のコンテンツへの読み取りと再共有と探索のアクセスを許可します

ReadWrite

string

データマート内のコンテンツへの読み取りと書き込みのアクセス権を付与します

ReadWriteExplore

string

データマート内のコンテンツへの読み取りと書き込みアクセスを許可します

ReadWriteReshare

string

データマート内のコンテンツへの読み取りおよび書き込みおよび再共有アクセスを許可します

ReadWriteReshareExplore

string

データマート内のコンテンツへの読み取りと書き込み、再共有と探索のアクセスを許可します

Reshare

string

データマート内のコンテンツへの再共有アクセスを許可する

Write

string

データマート内のコンテンツへの書き込みアクセスを許可する

DatasetUser

データセットの 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

string

データセット内のコンテンツに対するアクセス許可を削除します

Read

string

データセット内のコンテンツへの読み取りアクセス権を付与します

ReadExplore

string

データセット内のコンテンツへの読み取りと探索のアクセス権を付与します

ReadReshare

string

データセット内のコンテンツへの読み取りと再共有のアクセス権を付与します

ReadReshareExplore

string

データセット内のコンテンツへの読み取り、再共有、探索アクセスを許可します

ReadWrite

string

データセット内のコンテンツへの読み取りと書き込みのアクセス権を付与します

ReadWriteExplore

string

データセット内のコンテンツへの読み取り、書き込み、探索のアクセス権を付与します

ReadWriteReshare

string

データセット内のコンテンツへの読み取り、書き込み、再共有のアクセス権を付与します

ReadWriteReshareExplore

string

データセット内のコンテンツへの読み取り、書き込み、再共有、探索アクセスを許可します

Datasource

Power BI データ ソース

名前 説明
connectionDetails

DatasourceConnectionDetails

データ ソース接続の詳細

connectionString

string

(非推奨)データ ソース接続文字列。 DirectQuery でのみ使用できます。

datasourceId

string

バインドされたデータ ソース ID。ゲートウェイにバインドされていない場合は空です

datasourceType

string

データ ソースの種類

gatewayId

string

バインドされたゲートウェイ ID。ゲートウェイにバインドされていない場合は空です。 ゲートウェイ クラスターを使用する場合、ゲートウェイ ID はクラスター内のプライマリ (最初の) ゲートウェイを参照し、ゲートウェイ クラスター ID と似ています。

name

string

(非推奨)データ ソース名。 DirectQuery でのみ使用できます。

DatasourceConnectionDetails

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

名前 説明
account

string

接続アカウント

classInfo

string

接続クラス情報

database

string

接続データベース

domain

string

接続ドメイン

emailAddress

string

接続メール アドレス

kind

string

接続の種類

loginServer

string

接続ログイン サーバー

path

string

接続パス

server

string

接続サーバー

url

string

接続 URL

DatasourceUsage

データ ソースの使用状況

名前 説明
datasourceInstanceId

string

データ ソース インスタンス ID

DefaultDatasetStorageFormat

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

名前 説明
Large

string

大規模なデータセットのストレージ形式

Small

string

小さなデータセットのストレージ形式

DependentDataflow

Power BI 依存データフロー

名前 説明
groupId

string

ターゲット グループ ID

targetDataflowId

string

ターゲット データフロー ID

DependentDatamart

Power BI 依存データマート

名前 説明
groupId

string

ターゲット グループ ID

targetDatamartId

string

ターゲット データマート ID

DependentDataset

Power BI 依存データセット

名前 説明
groupId

string

ターゲット グループ ID

targetDatasetId

string

ターゲット データセット ID

EndorsementDetails

Power BI の保証の詳細

名前 説明
certifiedBy

string

Power BI アイテムを認定したユーザー (レポートやダッシュボードなど)

endorsement

string

保証の状態

Expression

データセット式

名前 説明
description

string

式の説明

expression

ASMashupExpression

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

name

string

式名

GroupUser

ワークスペースにアクセスできる 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

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

名前 説明
Admin

string

ワークスペース コンテンツに対する管理者権限

Contributor

string

ワークスペース コンテンツへの読み取りと探索 (ReadExplore) アクセス

Member

string

ワークスペース コンテンツに対する読み取り、再共有、探索 (ReadReshareExplore) アクセス権

None

string

ワークスペース のコンテンツにアクセスできない

Viewer

string

ワークスペース コンテンツへの読み取り専用 (読み取り) アクセス

Measure

Power BI メジャー

名前 説明
description

string

省略可能。 メジャーの説明。

expression

string

有効な DAX 式

formatString

string

省略可能。 FORMAT_STRINGで指定されたとおりに値を表示する場合の書式設定方法を説明する文字列。

isHidden

boolean

省略可能。 メジャーが非表示かどうか。

name

string

メジャー名

PrincipalType

プリンシパルの種類

名前 説明
App

string

サービス プリンシパルの種類

Group

string

グループ プリンシパルの種類

None

string

プリンシパルの種類はありません。 organization レベル全体のアクセスに使用します。

User

string

ユーザー プリンシパルの種類

ReportUser

レポートの 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

string

レポート内のコンテンツに対するアクセス許可がない

Owner

string

レポート内のコンテンツへの読み取り、書き込み、再共有のアクセス権を付与します

Read

string

レポート内のコンテンツへの読み取りアクセス権を付与します

ReadCopy

string

レポート内のコンテンツへの読み取りとコピーのアクセス権を付与します

ReadReshare

string

レポート内のコンテンツへの読み取りと再共有のアクセス権を付与します

ReadWrite

string

レポート内のコンテンツに対する読み取りと書き込みのアクセス権を付与します

Role

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

名前 説明
members

RoleMember

ロールのメンバーを一覧表示する配列

modelPermission

string

データセットに対するロールのアクセス許可。 たとえば、Read

name

string

ロールの名前

tablePermissions

RoleTablePermission

ロールに定義されているすべてのフィルターを一覧表示する配列

RoleMember

ロール メンバー

名前 説明
identityProvider

string

ロール メンバー ID プロバイダー

memberId

string

ID プロバイダーによって割り当てられたロール メンバー GUID

memberName

string

ロール メンバーの名前

memberType

string

ロール メンバーの種類 (ユーザーまたはグループ)

RoleTablePermission

ロール フィルター

名前 説明
filterExpression

string

フィルターで指定されたテーブルをフィルター処理する式

name

string

フィルターで指定されたテーブルの名前

Row

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

名前 説明
id

string

一意の行 ID

SensitivityLabel

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

名前 説明
labelId

string

秘密度ラベル ID

ServicePrincipalProfile

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

名前 説明
displayName

string

サービス プリンシパル プロファイル名

id

string

サービス プリンシパル プロファイル ID

Table

データセット テーブル

名前 説明
columns

Column[]

このテーブルの列スキーマ

description

string

テーブルの説明

isHidden

boolean

省略可能。 このデータセット テーブルが非表示になっているかどうか。

measures

Measure[]

このテーブル内のメジャー

name

string

テーブル名

rows

Row[]

このテーブル内のデータ行

source

ASMashupExpression[]

テーブル ソース

WorkspaceInfo

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

名前 説明
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

ワークスペース オブジェクト ID

isOnDedicatedCapacity

boolean

ワークスペースが専用容量に割り当てられているかどうか

name

string

ワークスペース名

reports

WorkspaceInfoReport[]

このワークスペースに関連付けられているレポート。 返されるレポート プロパティの一覧は API 呼び出しによって異なるため、API 応答にすべてのレポート プロパティが表示されない場合があります。

state

string

ワークスペースの状態

type

string

ワークスペースの種類

users

GroupUser[]

ワークスペースにアクセスできるユーザー。 リストは、明示的に要求された場合にのみ返されます。 クラシック ワークスペースのユーザーの一覧を取得するには、Azure Active Directory Graph APIを使用します。

WorkspaceInfoDashboard

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

名前 説明
appId

string

ダッシュボードがアプリに属している場合にのみ返されるアプリ ID

dataClassification

string

Power BI アイテムのデータ分類タグ (レポートやダッシュボードなど)

displayName

string

ダッシュボードの表示名

id

string

ダッシュボード ID

isReadOnly

boolean

ダッシュボードが読み取り専用かどうか

sensitivityLabel

SensitivityLabel

秘密度ラベル

tiles

WorkspaceInfoTile[]

ダッシュボードに属するタイル

users

DashboardUser[]

(空の値)ダッシュボードのユーザー アクセスの詳細。 このプロパティは、今後のリリースでペイロード応答から削除されます。 Power BI ダッシュボードでユーザー情報を取得するには、[ダッシュボード ユーザーを 管理 API 呼び出しとして取得する] または パラメーターを指定した PostWorkspaceInfo API 呼び出しをgetArtifactUsers使用します。

WorkspaceInfoDataflow

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

名前 説明
configuredBy

string

データフロー所有者

datasourceUsages

DatasourceUsage[]

データ ソースの使用状況

description

string

データフローの説明

endorsementDetails

EndorsementDetails

保証の詳細

misconfiguredDatasourceUsages

DatasourceUsage[]

データ ソースの使用状況が正しく構成されていません

modelUrl

string

データフロー定義ファイルの URL (model.json)

modifiedBy

string

データフローを変更したユーザー

modifiedDateTime

string

データフローが最後に変更された日時

name

string

データフロー名

objectId

string

データフロー ID

sensitivityLabel

SensitivityLabel

秘密度ラベル

upstreamDataflows

DependentDataflow[]

この項目が依存するすべてのデータフローの一覧

upstreamDatamarts

DependentDatamart[]

この項目が依存するすべてのデータマートの一覧

users

DataflowUser[]

(空の値)データフロー ユーザー アクセスの詳細。 このプロパティは、今後のリリースでペイロード応答から削除されます。 Power BI データフローのユーザー情報を取得するには、管理 API 呼び出しとしてデータフロー ユーザーを取得するか、 パラメーターを指定して PostWorkspaceInfo API 呼び出しをgetArtifactUser使用します。

WorkspaceInfoDatamart

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

名前 説明
configuredBy

string

データマート所有者の名前

configuredById

string

データマート所有者の ID

datasourceUsages

DatasourceUsage[]

データ ソースの使用状況

description

string

データマートの説明

endorsementDetails

EndorsementDetails

データマートの保証の詳細

id

string

データマート ID

modifiedBy

string

データマートを最後に変更したユーザー

modifiedById

string

データマートを最後に変更したユーザーの ID

modifiedDateTime

string

データマートが最後に変更された日時

name

string

データマート名

sensitivityLabel

SensitivityLabel

データマートの秘密度ラベル

state

datamartState

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

status

datamartStatus

データマートの状態

suspendedBatchId

string

datamart の中断されたバッチ ID

type

datamartType

データマート型

upstreamDataflows

DependentDataflow[]

この項目が依存するすべてのデータフローの一覧

upstreamDatamarts

DependentDatamart[]

この項目が依存するすべてのデータマートの一覧

users

DatamartUser[]

Power BI データマートのユーザー アクセスの詳細。

WorkspaceInfoDataset

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

名前 説明
ContentProviderType

string

データセットのコンテンツ プロバイダーの種類

CreatedDate

string

データセットの作成日時

configuredBy

string

データセットの所有者

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[]

データセット テーブル

targetStorageMode

string

データセットストレージモード

upstreamDataflows

DependentDataflow[]

この項目が依存するすべてのデータフローの一覧

upstreamDatamarts

DependentDatamart[]

この項目が依存するすべてのデータマートの一覧

upstreamDatasets

DependentDataset[]

アップストリーム データセット

users

DatasetUser[]

(空の値)データセットのユーザー アクセスの詳細。 このプロパティは、今後のリリースでペイロード応答から削除されます。 Power BI アイテム (レポートやダッシュボードなど) のユーザー情報を取得するには、管理 API としてデータセット ユーザーを取得するか、 パラメーターを指定して PostWorkspaceInfo API をgetArtifactUsers使用します。

WorkspaceInfoReport

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

名前 説明
appId

string

レポートがアプリに属している場合にのみ返されるアプリ ID

createdBy

string

レポートの所有者。 2019 年 6 月以降に作成されたレポートでのみ使用できます。

createdById

string

レポート所有者の ID。 2019 年 6 月以降に作成されたレポートでのみ使用できます。

createdDateTime

string

レポートの作成日時

datasetId

string

レポートのデータセット ID

datasetWorkspaceId

string

関連するデータセットが別のワークスペースに属している場合にのみ返される、関連データセットのワークスペース ID

description

string

レポートの説明

endorsementDetails

EndorsementDetails

保証の詳細

id

string

レポート ID

modifiedBy

string

レポートを最後に変更したユーザー

modifiedById

string

レポートを最後に変更したユーザーの ID

modifiedDateTime

string

レポートが最後に変更された日時

name

string

レポートの名前

originalReportId

string

ワークスペースがアプリとして発行されたときの実際のレポート ID。

reportType enum:
  • PaginatedReport
  • PowerBIReport

レポートの種類

sensitivityLabel

SensitivityLabel

秘密度ラベル

users

ReportUser[]

(空の値)Power BI レポートのユーザー アクセスの詳細。 このプロパティは、今後のリリースでペイロード応答から削除されます。 Power BI レポートのユーザー情報を取得するには、管理 API 呼び出しとしてレポート ユーザーを取得するか、 パラメーターを使用した PostWorkspaceInfo API 呼び出しをgetArtifactUsers使用します。

WorkspaceInfoResponse

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

名前 説明
datasourceInstances

Datasource[]

このスキャンに関連付けられているデータ ソース インスタンス

misconfiguredDatasourceInstances

Datasource[]

このスキャンに関連付けられているデータ ソースの正しく構成されていないインスタンス

workspaces

WorkspaceInfo[]

このスキャンに関連付けられているワークスペース情報

WorkspaceInfoTile

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

名前 説明
datasetId

string

データセット ID。 レポートから作成されたタイル、または Q&A タイルなどのデータセットを使用して作成されたタイルでのみ使用できます。

datasetWorkspaceId

string

関連するデータセットが別のワークスペースに属している場合にのみ返される、関連データセットのワークスペース ID

id

string

タイル ID

reportId

string

レポート ID。 レポートから作成されたタイルでのみ使用できます。

title

string

タイルの表示名