Admin - Groups GetGroupsAsAdmin

サービス:

Power BI REST APIs

API バージョン:

v1.0

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

権限

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

サービス 特権認証で実行する場合、アプリ は、Azure portal で Power BI に対して管理者の同意が必要な事前使用許可を設定 することはできません。

必要なスコープ

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

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

制限

テナントあたり、1 時間あたり最大 50 要求、または 1 分あたり 15 要求。 この呼び出しは、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) minimum: 1 maximum: 5000	最初の n 個の結果のみを返します。 このパラメーターは必須であり、1 から 5000 の範囲である必要があります。
$expand	query		string	応答でインラインで展開されるデータ型のコンマ区切りのリストを受け入れます。 users、reports、dashboards、datasets、dataflows、および workbooksをサポートします。
$filter	query		string	Odata フィルター クエリ パラメーター条件 基づいて、結果のサブセットを返します。
$skip	query		integer (int32)	最初の n 個の結果をスキップします。 top と共に使用して、最初の 5000 を超える結果をフェッチします。

応答

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

例

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.

要求のサンプル

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

応答のサンプル

状態コード:

200

{
  "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.

要求のサンプル

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

応答のサンプル

状態コード:

200

{
  "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

要求のサンプル

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

応答のサンプル

状態コード:

200

{
  "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

要求のサンプル

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

応答のサンプル

状態コード:

200

{
  "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.

要求のサンプル

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

応答のサンプル

状態コード:

200

{
  "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

要求のサンプル

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

応答のサンプル

状態コード:

200

{
  "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.

要求のサンプル

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

応答のサンプル

状態コード:

200

{
  "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

要求のサンプル

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

応答のサンプル

状態コード:

200

{
  "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

Object

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

名前	型	説明
appId	string	ダッシュボードがアプリに属している場合にのみ返されるアプリ ID
displayName	string	ダッシュボードの表示名
embedUrl	string	ダッシュボードの埋め込み URL
id	string (uuid)	ダッシュボード ID
isReadOnly	boolean	ダッシュボードが読み取り専用かどうか
subscriptions	Subscription[]	(空の値)Power BI アイテム (レポートやダッシュボードなど) のサブスクリプションの詳細。 このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI レポートのサブスクリプション情報を取得するには、レポート サブスクリプションを管理者として取得 API 呼び出しを使用します。
tiles	AdminTile[]	ダッシュボードに属するタイル
users	DashboardUser[]	(空の値)ダッシュボード のユーザー アクセスの詳細。 このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI ダッシュボードでユーザー情報を取得するには、管理 API 呼び出しとしてダッシュボード ユーザーを取得するか、 パラメーターを使用した getArtifactUsers API 呼び出しを使用します。
webUrl	string	ダッシュボードの Web URL
workspaceId	string (uuid)	ダッシュボードのワークスペース ID (GUID)。 このプロパティは GetDashboardsAsAdmin でのみ返されます。

AdminDataflow

Object

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

名前	型	説明
configuredBy	string	データフローの所有者
description	string	データフローの説明
modelUrl	string	データフロー定義ファイルへの URL (model.json)
name	string	データフロー名
objectId	string (uuid)	データフロー ID
users	DataflowUser[]	(空の値)データフロー ユーザー アクセスの詳細。 このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI データフローに関するユーザー情報を取得するには、Admin API 呼び出しとしてデータフロー ユーザーを取得するか、 パラメーターを使用して getArtifactUser API 呼び出しを使用します。
workspaceId	string (uuid)	データフロー ワークスペース ID。

AdminDataset

Object

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

名前	型	説明
ContentProviderType	string	無視する必要がある非推奨のプロパティ。
Encryption	Encryption	データセットの暗号化情報。 $expand が指定されている場合にのみ適用されます。
IsEffectiveIdentityRequired	boolean	データセットに有効な ID が必要かどうか。これは、GenerateToken API 呼び出しで送信する必要があります。
IsEffectiveIdentityRolesRequired	boolean	行レベルのセキュリティが Power BI .pbix ファイル内で定義されているかどうか。 その場合は、ロールを指定する必要があります。
IsInPlaceSharingEnabled	boolean	データセットを外部ユーザーと共有して自分のテナントで使用できるかどうかを指定します。
IsOnPremGatewayRequired	boolean	データセットにオンプレミス データ ゲートウェイが必要かどうか
IsRefreshable	boolean	このフィールドは、データセットが最近更新されたとき、または自動更新用に構成され、接続モードが特に "インポート" に設定されている場合に、true を返します。 この値は、データセットが手動で更新されるか、自動更新用に設定されているかに関係なく、'DirectQuery' や 'LiveConnection' などの他の接続モードの false を返します。
addRowsAPIEnabled	boolean	データセットで新しい行の追加が許可されるかどうか
configuredBy	string	データセットの所有者
createReportEmbedURL	string	データセット作成レポートの埋め込み URL
createdDate	string (date-time)	データセットの作成日時
description	string	データセットの説明
id	string	データセット ID
name	string	データセット名
qnaEmbedURL	string	データセット Q&A 埋め込み URL
queryScaleOutSettings	DatasetQueryScaleOutSettings	データセットのスケールアウト設定のクエリ
targetStorageMode	string	データセットストレージモード
upstreamDataflows	DependentDataflow[]	この項目が依存するすべてのデータフローの一覧
users	DatasetUser[]	(空の値)データセット のユーザー アクセスの詳細。 このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI アイテム (レポートやダッシュボードなど) のユーザー情報を取得するには、Admin API としてデータセット ユーザーを取得するか、 パラメーターを使用して getArtifactUsers API を使用します。
webUrl	string	データセットの Web URL
workspaceId	string (uuid)	データセット ワークスペース ID。 このプロパティは、GetDatasetsAsAdmin でのみ返されます。

AdminGroup

Object

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

名前	型	説明
capacityId	string (uuid)	容量 ID
dashboards	AdminDashboard[]	グループに属するダッシュボード
dataflowStorageId	string (uuid)	Power BI データフロー ストレージ アカウント ID
dataflows	AdminDataflow[]	グループに属するデータフロー
datasets	AdminDataset[]	グループに属するデータセット
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	ワークスペース内の既定のデータセット ストレージ形式。 isOnDedicatedCapacity が true されている場合にのみ返されます
description	string	グループの説明
hasWorkspaceLevelSettings	boolean	ワークスペースにカスタム設定があるかどうか
id	string (uuid)	ワークスペース ID
isOnDedicatedCapacity	boolean	グループが専用容量に割り当てられているかどうか
isReadOnly	boolean	グループが読み取り専用かどうか
logAnalyticsWorkspace	AzureResource	グループに割り当てられている Log Analytics ワークスペース。 これは、1 つのグループを取得する場合にのみ返されます。
name	string	グループ名
pipelineId	string (uuid)	ワークスペースが割り当てられているデプロイ パイプライン ID。
reports	AdminReport[]	グループに属するレポート
state	string	グループの状態
type	GroupType	返されるグループの種類。
users	GroupUser[]	(空の値)グループに属するユーザーとそのアクセス権。 このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI アイテム (レポートやダッシュボードなど) のユーザー情報を取得するには、管理者としてグループ ユーザーを取得 API 呼び出しを使用するか、 パラメーターを使用して getArtifactUsers API 呼び出しを使用します。
workbooks	Workbook[]	グループに属するブック

AdminGroups

Object

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

名前	型	説明
@odata.context	string	OData コンテキスト
value	AdminGroup[]	グループの一覧

AdminReport

Object

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

名前	型	説明
appId	string	レポートがアプリに属している場合にのみ返されるアプリ ID
createdBy	string	レポートの所有者。 2019 年 6 月以降に作成されたレポートでのみ使用できます。
createdDateTime	string (date-time)	レポートの作成日時
datasetId	string	レポートのデータセット ID
description	string	レポートの説明
embedUrl	string	レポートの埋め込み URL
id	string (uuid)	レポート ID
isOwnedByMe	boolean	現在のユーザーがレポートのコピーを変更または作成できるかどうかを示します。
modifiedBy	string	レポートを最後に変更したユーザー
modifiedDateTime	string (date-time)	レポートが最後に変更された日時
name	string	レポートの名前。 アプリ レポートはプレフィックス [App] で始まります。
originalReportId	string (uuid)	ワークスペースがアプリとして発行されたときの実際のレポート ID。
reportType	enum: PaginatedReport PowerBIReport	レポートの種類
subscriptions	Subscription[]	(空の値)Power BI アイテム (レポートやダッシュボードなど) のサブスクリプションの詳細。 このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI レポートのサブスクリプション情報を取得するには、レポート サブスクリプションを管理者として取得 API 呼び出しを使用します。
users	ReportUser[]	(空の値)Power BI レポートのユーザー アクセスの詳細。 このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI レポートのユーザー情報を取得するには、Admin API 呼び出しとしてレポート ユーザーを取得するか、 パラメーターを使用した getArtifactUsers API 呼び出しを使用します。
webUrl	string	レポートの Web URL
workspaceId	string (uuid)	レポートのワークスペース ID (GUID)。 このプロパティは、GetReportsAsAdmin でのみ返されます。

AdminTile

Object

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

名前	型	説明
colSpan	integer	タイルスパン列の数
datasetId	string	データセット ID。 レポートから作成されたタイル、または Q&A タイルなどのデータセットを使用して作成されたタイルでのみ使用できます。
embedData	string	タイルの埋め込みデータ
embedUrl	string	タイルの埋め込み URL
id	string (uuid)	タイル ID
reportId	string (uuid)	レポート ID。 レポートから作成されたタイルでのみ使用できます。
rowSpan	integer	タイルスパン行の数
title	string	タイルの表示名

AzureResource

Object

Log Analytics ワークスペースなどのユーザー所有の Azure リソースの詳細を示す応答。

名前	型	説明
id	string (uuid)	Power BI 内のリソースの識別子。
resourceGroup	string	リソースが存在するサブスクリプション内のリソース グループ。
resourceName	string	リソースの名前。
subscriptionId	string (uuid)	リソースが存在する Azure サブスクリプション。

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

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	データフロー内のコンテンツへのアクセス許可を削除します
Owner	データフロー内のコンテンツへの読み取り、書き込み、および再共有アクセスを許可します
Read	データフロー内のコンテンツへの読み取りアクセスを許可します
ReadReshare	データフロー内のコンテンツへの読み取りと再共有アクセスを許可します
ReadWrite	データフロー内のコンテンツへの読み取りと書き込みアクセスを許可します

DatasetQueryScaleOutSettings

Object

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

名前	型	説明
autoSyncReadOnlyReplicas	boolean	データセットが読み取り専用レプリカを自動的に同期するかどうか
maxReadOnlyReplicas	integer minimum: -1 maximum: 64	データセットの読み取り専用レプリカの最大数 (レプリカの自動数の場合は 0 から 64、-1)

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	データセット内のコンテンツへの読み取りアクセス権を付与します
ReadExplore	データセット内のコンテンツへの読み取りと探索のアクセス権を付与します
ReadReshare	データセット内のコンテンツへの読み取りと再共有のアクセス権を付与します
ReadReshareExplore	データセット内のコンテンツへの読み取り、再共有、探索アクセスを許可します
ReadWrite	データセット内のコンテンツに対する読み取りと書き込みのアクセス権を付与します
ReadWriteExplore	データセット内のコンテンツへの読み取り、書き込み、探索のアクセス権を付与します
ReadWriteReshare	データセット内のコンテンツへの読み取り、書き込み、および再共有アクセスを許可します
ReadWriteReshareExplore	データセット内のコンテンツへの読み取り、書き込み、再共有、探索アクセスを許可します

DefaultDatasetStorageFormat

列挙

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

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

DependentDataflow

Object

Power BI 依存データフロー

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

Encryption

Object

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

名前	型	説明
EncryptionStatus	EncryptionStatus	データセットの暗号化の状態

EncryptionStatus

列挙

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

値	説明
InSyncWithWorkspace	暗号化はサポートされており、暗号化設定と同期されています
NotInSyncWithWorkspace	暗号化はサポートされていますが、暗号化設定と同期されていません
NotSupported	このデータセットでは暗号化はサポートされていません
Unknown	データセットの破損により、暗号化の状態が不明です

GroupType

列挙

グループの種類

値	説明
AdminWorkspace	ファブリック管理者の管理者の監視
Group	V1 バージョンの共有ワークスペース。 Microsoft はすべてのワークスペースを最新バージョンの共有ワークスペースに移行するため、この種類のワークスペースは非推奨になります
Personal	SharePoint リストと OneDrive 統合用の特別な種類のワークスペース
PersonalGroup	"マイ ワークスペース" (個人用ワークスペースとも呼ばれます)
Workspace	組織内の他のユーザーとコンテンツを共有するために使用される共有ワークスペースまたは単純なワークスペース

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

列挙

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

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

PrincipalType

列挙

プリンシパルの種類

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

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

ServicePrincipalProfile

Object

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

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

Subscription

Object

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

名前	型	説明
artifactDisplayName	string	サブスクライブされている Power BI アイテムの名前 (レポートやダッシュボードなど)
artifactId	string (uuid)	サブスクライブした Power BI アイテムの ID (レポートやダッシュボードなど)
artifactType	string	Power BI 項目の種類 (Report、Dashboard、Datasetなど)
attachmentFormat	string	電子メール サブスクリプションに添付されているレポートの形式
endDate	string (date-time)	電子メール サブスクリプションの終了日時
frequency	string	電子メール サブスクリプションの頻度
id	string (uuid)	サブスクリプション ID
isEnabled	boolean	電子メール サブスクリプションが有効になっているかどうか
linkToContent	boolean	電子メール サブスクリプションにサブスクリプション リンクが存在するかどうか
previewImage	boolean	レポートのスクリーンショットが電子メール サブスクリプションに存在するかどうか
startDate	string (date-time)	電子メール サブスクリプションの開始日時
subArtifactDisplayName	string	サブスクライブした Power BI アイテムのページ名 (レポートの場合)。
title	string	アプリ名
users	SubscriptionUser[]	各メール サブスクライバーの詳細。 Get User Subscriptions As Admin API 呼び出しを使用する場合、返される値は空の配列 (null) です。 このプロパティは、今後のリリースでペイロードの応答から削除されます。 Power BI レポートまたはダッシュボードでサブスクリプション情報を取得するには、[レポート サブスクリプションを管理者として取得] を使用するか、[ダッシュボード サブスクリプションを管理者として取得] API 呼び出しを します。

SubscriptionUser

Object

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

Object

Power BI ブック

名前	型	説明
datasetId	string	ブックに関連付けられているデータセットの ID。 ブックにデータセットが関連付けられている場合にのみ適用されます。
name	string	ブック名