Admin - Groups GetGroupsAsAdmin

organizationのワークスペースの一覧を返します。

アクセス許可

  • ユーザーは管理者権限 (Office 365グローバル管理者や Power BI サービス管理者など) を持っているか、サービス プリンシパルを使用して認証する必要があります。
  • 委任されたアクセス許可がサポートされています。

サービス の prinicipal 認証で実行する場合、アプリには、Azure portalで Power BI に対して管理者の同意が必要な事前使用許可が設定されていない必要があります

必要なスコープ

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

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

制限事項

テナントあたり 1 時間あたり最大 50 要求。 この呼び出しは、Power BI サービスへの悪影響を防ぐために 30 秒後にもタイムアウトします。

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$top={$top}
GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}

URI パラメーター

名前 / 必須 説明
$top
query True

integer

int32

最初の n 個の結果のみを返します。 このパラメーターは必須であり、1 から 5000 の範囲である必要があります。

$expand
query

string

応答でインラインで展開されるデータ型のコンマ区切りのリストを受け入れます。 、reports、、、dashboardsdatasetsdataflows、および がサポートされていますusersworkbooks

$filter
query

string

ブール条件に基づいて結果をフィルター処理する

$skip
query

integer

int32

最初の n 個の結果をスキップします。 top で を使用して、最初の 5000 を超える結果をフェッチします。

応答

名前 説明
200 OK

AdminGroups

OK

Get deleted workspaces example.
Get orphaned workspaces example.
Get workspaces with their 'dashboards' expanded example
Get workspaces with their 'datasets' expanded example
Get workspaces with their 'datasets' expanded example.
Get workspaces with their 'reports' expanded example
Get workspaces with their 'users' expanded example.
Get workspaces with their 'workbooks' expanded example

Get deleted workspaces example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$filter=state eq 'Deleted'&$top=100

Sample Response

{
  "value": [
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted"
    }
  ]
}

Get orphaned workspaces example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=users&$filter=(not users/any()) or (not users/any(u: u/groupUserAccessRight eq Microsoft.PowerBI.ServiceContracts.Api.GroupUserAccessRight'Admin'))&$top=100

Sample Response

{
  "value": [
    {
      "id": "d5caa808-8c91-400a-911d-06af08dbcc31",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Orphaned Group",
      "description": "Sample orphan group",
      "type": "Workspace",
      "state": "Active",
      "hasWorkspaceLevelSettings": false,
      "users": []
    }
  ]
}

Get workspaces with their 'dashboards' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=dashboards&$top=100

Sample Response

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "hasWorkspaceLevelSettings": false,
      "dashboards": [
        {
          "id": "4668133c-ae3f-42fb-ad7c-214a8623280c",
          "displayName": "SQlAzure-Refresh.pbix",
          "isReadOnly": false
        },
        {
          "id": "a8f18ca7-63e8-4220-bc1c-f576ec180b98",
          "displayName": "cdvc",
          "isReadOnly": false
        }
      ]
    }
  ]
}

Get workspaces with their 'datasets' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=datasets&$top=100

Sample Response

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "hasWorkspaceLevelSettings": false,
      "datasets": [
        {
          "id": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523",
          "name": "SQlAzure-Refresh",
          "addRowsAPIEnabled": false,
          "configuredBy": "admin@granularcontrols.ccsctp.net",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "targetStorageMode": "Abf",
          "createdDate": "2019-04-30T21:35:15.867-07:00",
          "ContentProviderType": "PbixInImportMode",
          "isInPlaceSharingEnabled": false
        },
        {
          "id": "7d6a4f72-1906-4e08-a469-bd6bc1ab7b69",
          "name": "NESGames",
          "addRowsAPIEnabled": false,
          "configuredBy": "admin@granularcontrols.ccsctp.net",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "targetStorageMode": "Abf",
          "createdDate": "2019-04-30T21:35:15.867-07:00",
          "ContentProviderType": "PbixInImportMode",
          "isInPlaceSharingEnabled": false
        }
      ]
    }
  ]
}

Get workspaces with their 'datasets' expanded example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=datasets

Sample Response

{
  "value": [
    {
      "id": "e380d1d0-1fa6-460b-9a90-1a5c6b02414c",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "name": "Sample Group 1",
      "description": "Sample group",
      "type": "Workspace",
      "state": "Active",
      "hasWorkspaceLevelSettings": true,
      "datasets": [
        {
          "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
          "name": "SalesMarketing",
          "addRowsAPIEnabled": false,
          "configuredBy": "john@contoso.com",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "isInPlaceSharingEnabled": false,
          "encryption": {
            "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
            "encryptionStatus": "InSyncWithWorkspace"
          }
        }
      ]
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted",
      "datasets": []
    }
  ]
}

Get workspaces with their 'reports' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=reports&$top=100

Sample Response

{
  "value": [
    {
      "id": "EC1EE11F-845D-495E-82A3-9DAC2072305A",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "cvcv",
      "type": "Workspace",
      "state": "Active",
      "name": "WSv2Test12",
      "hasWorkspaceLevelSettings": true,
      "reports": []
    },
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "hasWorkspaceLevelSettings": false,
      "reports": [
        {
          "id": "5DBA60B0-D9A7-42AE-B12C-6D9D51E7739A",
          "reportType": "PowerBIReport",
          "name": "SQlAzure-Refresh",
          "datasetId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523"
        },
        {
          "id": "197E5C3C-D2F3-42D8-A536-875FB6D7D48C",
          "reportType": "PowerBIReport",
          "name": "NESGames",
          "datasetId": "7d6a4f72-1906-4e08-a469-bd6bc1ab7b69"
        }
      ]
    }
  ]
}

Get workspaces with their 'users' expanded example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=users&$top=100

Sample Response

{
  "value": [
    {
      "id": "e380d1d0-1fa6-460b-9a90-1a5c6b02414c",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "name": "Sample Group 1",
      "description": "Sample group",
      "type": "Workspace",
      "state": "Active",
      "hasWorkspaceLevelSettings": false,
      "users": [
        {
          "emailAddress": "john@contoso.com",
          "groupUserAccessRight": "Admin"
        }
      ]
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted",
      "users": []
    }
  ]
}

Get workspaces with their 'workbooks' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=workbooks&$top=100

Sample Response

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "hasWorkspaceLevelSettings": false,
      "name": "a",
      "workbooks": [
        {
          "name": "My Excel sheet",
          "datasetId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523"
        }
      ]
    }
  ]
}

定義

名前 説明
AdminDashboard

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

AdminDataflow

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

AdminDataset

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

AdminGroup

管理者 API によって返される Power BI グループ

AdminGroups

管理 API によって返される Power BI グループの一覧の OData 応答ラッパー

AdminReport

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

AdminTile

管理 API によって返される Power BI タイル。

AzureResource

Log Analytics ワークスペースなどのユーザー所有の Azure リソースを詳しく説明する応答。

DashboardUser

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

DashboardUserAccessRight

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

DataflowUser

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

DataflowUserAccessRight

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

DatasetQueryScaleOutSettings

データセットのスケールアウト設定のクエリ

DatasetUser

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

DatasetUserAccessRight

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

DefaultDatasetStorageFormat

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

DependentDataflow

Power BI 依存データフロー

Encryption

データセットの暗号化情報

EncryptionStatus

データセットの暗号化の状態

GroupType

グループの種類

GroupUser

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

GroupUserAccessRight

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

PrincipalType

プリンシパルの種類

ReportUser

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

ReportUserAccessRight

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

ServicePrincipalProfile

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

Subscription

Power BI アイテム (レポートやダッシュボードなど) のメール サブスクリプション

SubscriptionUser

Power BI メール サブスクリプション ユーザー

Workbook

Power BI ブック

AdminDashboard

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

名前 説明
appId

string

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

displayName

string

ダッシュボードの表示名

embedUrl

string

ダッシュボードの埋め込み URL

id

string

ダッシュボード ID

isReadOnly

boolean

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

subscriptions

Subscription[]

(空の値)Power BI アイテム (レポートやダッシュボードなど) のサブスクリプションの詳細。 このプロパティは、今後のリリースでペイロード応答から削除されます。 Power BI レポートのサブスクリプション情報を取得するには、API 呼び出しとしてレポート サブスクリプションの取得管理使用します。

tiles

AdminTile[]

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

users

DashboardUser[]

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

webUrl

string

ダッシュボードの Web URL

workspaceId

string

ダッシュボードのワークスペース ID (GUID)。 このプロパティは、GetDashboardsAsAdmin でのみ返されます。

AdminDataflow

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

名前 説明
configuredBy

string

データフローの所有者

description

string

データフローの説明

modelUrl

string

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

modifiedBy

string

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

modifiedDateTime

string

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

name

string

データフロー名

objectId

string

データフロー ID

users

DataflowUser[]

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

workspaceId

string

データフロー ワークスペース ID。

AdminDataset

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

名前 説明
ContentProviderType

string

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

CreateReportEmbedURL

string

データセット作成レポートの埋め込み URL

CreatedDate

string

データセットの作成日時

Encryption

Encryption

データセットの暗号化情報。 が指定されている場合 $expand にのみ適用されます。

IsEffectiveIdentityRequired

boolean

データセットに有効な ID が必要かどうか。 これは GenerateToken API 呼び出しで送信する必要があります。

IsEffectiveIdentityRolesRequired

boolean

Power BI .pbix ファイル内で行レベルのセキュリティが定義されているかどうか。 その場合は、ロールを指定する必要があります。

IsInPlaceSharingEnabled

boolean

データセットを外部ユーザーと共有して自分のテナントで使用できるかどうか

IsOnPremGatewayRequired

boolean

データセットにオンプレミス データ ゲートウェイが必要かどうか

IsRefreshable

boolean

データセットが更新可能かどうか。 Power BI の更新可能なデータセットは、少なくとも 1 回更新されたデータセット、または有効な更新スケジュールが存在するデータセットです。

QnaEmbedURL

string

データセット Q&埋め込み URL

addRowsAPIEnabled

boolean

データセットで新しい行の追加が許可されるかどうか

configuredBy

string

データセットの所有者

description

string

データセットの説明

id

string

データセット ID

name

string

データセット名

queryScaleOutSettings

DatasetQueryScaleOutSettings

データセットのクエリ スケールアウト設定

targetStorageMode

string

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

upstreamDataflows

DependentDataflow[]

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

users

DatasetUser[]

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

webUrl

string

データセットの Web URL

workspaceId

string

データセット ワークスペース ID。 このプロパティは、GetDatasetsAsAdmin でのみ返されます。

AdminGroup

管理者 API によって返される Power BI グループ

名前 説明
capacityId

string

容量 ID

dashboards

AdminDashboard[]

グループに属するダッシュボード

dataflowStorageId

string

Power BI データフロー ストレージ アカウント ID

dataflows

AdminDataflow[]

グループに属するデータフロー

datasets

AdminDataset[]

グループに属するデータセット

defaultDatasetStorageFormat

DefaultDatasetStorageFormat

ワークスペース内の既定のデータセット ストレージ形式。 が の場合 isOnDedicatedCapacity にのみ返されます true

description

string

グループの説明

hasWorkspaceLevelSettings

boolean

ワークスペースにカスタム設定があるかどうか

id

string

ワークスペース ID

isOnDedicatedCapacity

boolean

グループが専用容量に割り当てられているかどうか

isReadOnly

boolean

グループが読み取り専用かどうか

logAnalyticsWorkspace

AzureResource

グループに割り当てられている Log Analytics ワークスペース。 これは、1 つのグループを取得する場合にのみ返されます。

name

string

グループ名

pipelineId

string

ワークスペースが割り当てられているデプロイ パイプライン ID。

reports

AdminReport[]

グループに属するレポート

state

string

グループの状態

type

GroupType

返されるグループの種類。

users

GroupUser[]

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

workbooks

Workbook[]

グループに属するブック

AdminGroups

管理 API によって返される Power BI グループの一覧の OData 応答ラッパー

名前 説明
odata.context

string

OData コンテキスト

value

AdminGroup[]

グループの一覧

AdminReport

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

名前 説明
appId

string

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

createdBy

string

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

createdDateTime

string

レポートの作成日時

datasetId

string

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

description

string

レポートの説明

embedUrl

string

レポートの埋め込み URL

id

string

レポート ID

modifiedBy

string

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

modifiedDateTime

string

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

name

string

レポートの名前

originalReportId

string

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

reportType enum:
  • PaginatedReport
  • PowerBIReport

レポートの種類

subscriptions

Subscription[]

(空の値)Power BI アイテム (レポートやダッシュボードなど) のサブスクリプションの詳細。 このプロパティは、今後のリリースでペイロード応答から削除されます。 Power BI レポートのサブスクリプション情報を取得するには、API 呼び出しとしてレポート サブスクリプションの取得管理使用します。

users

ReportUser[]

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

webUrl

string

レポートの Web URL

workspaceId

string

レポートのワークスペース ID (GUID)。 このプロパティは、GetReportsAsAdmin でのみ返されます。

AdminTile

管理 API によって返される Power BI タイル。

名前 説明
colSpan

integer

タイルスパン列の数

datasetId

string

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

embedData

string

タイルの埋め込みデータ

embedUrl

string

タイルの埋め込み URL

id

string

タイル ID

reportId

string

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

rowSpan

integer

タイルスパン行の数

title

string

タイルの表示名

AzureResource

Log Analytics ワークスペースなどのユーザー所有の Azure リソースを詳しく説明する応答。

名前 説明
id

string

Power BI 内のリソースの識別子。

resourceGroup

string

リソースが存在するサブスクリプション内のリソース グループ。

resourceName

string

リソースの名前。

subscriptionId

string

リソースが存在する Azure サブスクリプション。

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

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

DatasetQueryScaleOutSettings

データセットのスケールアウト設定のクエリ

名前 説明
autoSyncReadOnlyReplicas

boolean

データセットが読み取り専用レプリカを自動的に同期するかどうか

maxReadOnlyReplicas

integer

データセットの読み取り専用レプリカの最大数 (レプリカの自動数の場合は 0 から 64、-1)

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

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

DefaultDatasetStorageFormat

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

名前 説明
Large

string

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

Small

string

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

DependentDataflow

Power BI 依存データフロー

名前 説明
groupId

string

ターゲット グループ ID

targetDataflowId

string

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

Encryption

データセットの暗号化情報

名前 説明
EncryptionStatus

EncryptionStatus

データセットの暗号化の状態

EncryptionStatus

データセットの暗号化の状態

名前 説明
InSyncWithWorkspace

string

暗号化はサポートされており、暗号化設定と同期しています

NotInSyncWithWorkspace

string

暗号化はサポートされていますが、暗号化設定と同期されていません

NotSupported

string

このデータセットの暗号化はサポートされていません

Unknown

string

データセットの破損により、暗号化の状態が不明です

GroupType

グループの種類

名前 説明
Group

string

V1 バージョンの共有ワークスペース。 Microsoft はすべてのワークスペースを最新バージョンの共有ワークスペースに移行するため、この種類のワークスペースは非推奨になります

Personal

string

SharePoint リストと OneDrive 統合用の特別な種類のワークスペース

PersonalGroup

string

"マイ ワークスペース" (個人用ワークスペースとも呼ばれます)

Workspace

string

organization内の他のユーザーとコンテンツを共有するために使用される共有ワークスペースまたは単純なワークスペース

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

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

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

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

ServicePrincipalProfile

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

名前 説明
displayName

string

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

id

string

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

Subscription

Power BI アイテム (レポートやダッシュボードなど) のメール サブスクリプション

名前 説明
artifactDisplayName

string

サブスクライブした Power BI アイテムの名前 (レポートやダッシュボードなど)

artifactId

string

サブスクライブした Power BI アイテムの ID (レポートやダッシュボードなど)

artifactType

string

Power BI 項目の種類 (、、Dashboardまたは DatasetなどReport)

attachmentFormat

string

メール サブスクリプションに添付されているレポートの形式

endDate

string

メール サブスクリプションの終了日時

frequency

string

メール サブスクリプションの頻度

id

string

サブスクリプション ID

isEnabled

boolean

メール サブスクリプションが有効になっているかどうか

linkToContent

boolean

メール サブスクリプションにサブスクリプション リンクが存在するかどうか

previewImage

boolean

レポートのスクリーンショットがメール サブスクリプションに存在するかどうか

startDate

string

電子メール サブスクリプションの開始日時

subArtifactDisplayName

string

サブスクライブした Power BI アイテムのページ名 (レポートの場合)。

title

string

アプリの名前

users

SubscriptionUser[]

各メール サブスクライバーの詳細。 Get User Subscriptions As 管理 API 呼び出しを使用する場合、返される値は空の配列 (null) です。 このプロパティは、今後のリリースでペイロード応答から削除されます。 Power BI レポートまたはダッシュボードでサブスクリプション情報を取得するには、[レポート サブスクリプションを管理として取得] または [ダッシュボード サブスクリプションを取得する] 管理 API 呼び出しを使用します。

SubscriptionUser

Power BI メール サブスクリプション ユーザー

名前 説明
displayName

string

プリンシパルの表示名

emailAddress

string

ユーザーの電子メール アドレス

graphId

string

Microsoft Graph のプリンシパルの識別子。 管理者 API でのみ使用できます。

identifier

string

プリンシパルの識別子

principalType

PrincipalType

プリンシパルの種類

profile

ServicePrincipalProfile

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

userType

string

ユーザーの種類。

Workbook

Power BI ブック

名前 説明
datasetId

string

ブックに関連付けられているデータセットの ID。 ブックにデータセットが関連付けられている場合にのみ適用されます。

name

string

ブック名