Admin - Groups GetGroupsAsAdmin

Reference

Service:: Power BI REST APIs

API Version:: v1.0

Vrátí seznam pracovních prostorů pro organizaci.

Oprávnění

Uživatel musí mít oprávnění správce (například Office 365 globálního správce nebo správce služby Power BI) nebo ověřování pomocí instančního objektu.
Delegovaná oprávnění jsou podporovaná.

Při spuštění v rámci původního ověřování služby nesmí mít aplikace v Azure Portal nastavená žádná oprávnění vyžadovaná správcem pro Power BI.

Požadovaný obor

Tenant.Read.All nebo Tenant.ReadWrite.All

Relevantní pouze při ověřování prostřednictvím standardního delegovaného přístupového tokenu správce. Nesmí být k dispozici při použití ověřování prostřednictvím instančního objektu.

Omezení

Maximálně 50 požadavků za hodinu nebo 15 požadavků za minutu na tenanta. Časový limit tohoto volání také po 30 sekundách vyprší, aby se zabránilo nežádoucímu dopadu na služba Power BI.

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

With optional parameters:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
$top	query	True	integer int32	Vrátí pouze prvních n výsledků. Tento parametr je povinný a musí být v rozsahu od 1 do 5000.
$expand	query		string	Přijímá seznam datových typů oddělený čárkami, který se v odpovědi rozbalí. Podporuje `users`, , `dashboardsreports`, `datasets`, `dataflows`a `workbooks`.
$filter	query		string	Filtruje výsledky na základě logické podmínky.
$skip	query		integer int32	Přeskočí prvních n výsledků. Pokud chcete načíst výsledky nad rámec prvních 5 000, použijte s horní.

Odpovědi

Name	Typ	Description
200 OK	AdminGroups	OK

Příklady

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

Status code:: 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.

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

Status code:: 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

Sample Request

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

Sample Response

Status code:: 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

Sample Request

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

Sample Response

Status code:: 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.

Sample Request

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

Sample Response

Status code:: 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

Sample Request

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

Sample Response

Status code:: 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.

Sample Request

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

Sample Response

Status code:: 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

Sample Request

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

Sample Response

Status code:: 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"
        }
      ]
    }
  ]
}

Definice

Name	Description
AdminDashboard	Řídicí panel Power BI vrácený rozhraními API Správa Rozhraní API vrátí podmnožinu následujícího seznamu vlastností řídicího panelu. Podmnožina závisí na volaného rozhraní API, oprávněních volajícího a dostupnosti dat v databázi Power BI.
AdminDataflow	Metadata toku dat vrácená rozhraními API Správa. Níže je seznam vlastností, které se můžou vrátit pro tok dat. V závislosti na volaných rozhraní API, oprávněních volajícího a dostupnosti dat v databázi Power BI se vrátí jenom podmnožina vlastností.
AdminDataset	Datová sada Power BI vrácená rozhraními SPRÁVA API. Rozhraní API vrátí podmnožinu z následujícího seznamu vlastností datové sady. Podmnožina závisí na volaných rozhraní API, oprávněních volajícího a dostupnosti dat v databázi Power BI.
AdminGroup	Skupina Power BI vrácená rozhraními API pro správu
AdminGroups	Obálka odpovědi OData pro seznam skupin Power BI vrácených rozhraními SPRÁVA API
AdminReport	Sestava Power BI vrácená rozhraními SPRÁVA API Rozhraní API vrátí podmnožinu z následujícího seznamu vlastností sestavy. Podmnožina závisí na volaného rozhraní API, oprávněních volajícího a dostupnosti dat v databázi Power BI.
AdminTile	Dlaždice Power BI vrácená rozhraními API Správa.
AzureResource	Odpověď s podrobnostmi o prostředku Azure vlastněného uživatelem, jako je pracovní prostor služby Log Analytics.
DashboardUser	Položka přístupového práva uživatele Power BI pro řídicí panel
DashboardUserAccessRight	Přístupové právo, které má uživatel k řídicímu panelu (úroveň oprávnění)
DataflowUser	Přístupová práva uživatele Power BI pro tok dat
DataflowUserAccessRight	Přístupové právo, které má uživatel k toku dat (úroveň oprávnění)
DatasetQueryScaleOutSettings	Dotaz na nastavení škálování datové sady na více instancí
DatasetUser	Položka přístupového práva uživatele Power BI pro datovou sadu
DatasetUserAccessRight	Přístupové právo, které má uživatel k datové sadě (úroveň oprávnění)
DefaultDatasetStorageFormat	Výchozí formát úložiště datové sady ve skupině
DependentDataflow	Tok dat závislý na Power BI
Encryption	Informace o šifrování datové sady
EncryptionStatus	Stav šifrování datové sady
GroupType	Typ skupiny
GroupUser	Uživatel Power BI s přístupem k pracovnímu prostoru
GroupUserAccessRight	Přístupová práva (úroveň oprávnění), která má uživatel k pracovnímu prostoru
PrincipalType	Typ objektu zabezpečení
ReportUser	Přístupová práva uživatele Power BI pro sestavu
ReportUserAccessRight	Přístupové právo, které má uživatel k sestavě (úroveň oprávnění)
ServicePrincipalProfile	Profil objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty.
Subscription	E-mailový odběr položky Power BI (například sestavy nebo řídicího panelu)
SubscriptionUser	Uživatel e-mailového předplatného Power BI
Workbook	Sešit Power BI

AdminDashboard

Řídicí panel Power BI vrácený rozhraními API Správa Rozhraní API vrátí podmnožinu následujícího seznamu vlastností řídicího panelu. Podmnožina závisí na volaného rozhraní API, oprávněních volajícího a dostupnosti dat v databázi Power BI.

Name	Typ	Description
appId	string	ID aplikace, které se vrátí jenom v případě, že řídicí panel patří aplikaci
displayName	string	Zobrazovaný název řídicího panelu
embedUrl	string	Adresa URL řídicího panelu pro vložení
id	string	ID řídicího panelu
isReadOnly	boolean	Jestli je řídicí panel jen pro čtení
subscriptions	Subscription[]	(Prázdná hodnota) Podrobnosti o předplatném pro položku Power BI (například sestavu nebo řídicí panel). Tato vlastnost bude odebrána z odpovědi datové části v nadcházející verzi. Informace o předplatném pro sestavu Power BI můžete načíst pomocí volání Získat odběry sestav jako Správa rozhraní API.
tiles	AdminTile[]	Dlaždice, které patří do řídicího panelu
users	DashboardUser[]	(Prázdná hodnota) Podrobnosti o přístupu uživatele řídicího panelu Tato vlastnost bude odebrána z odpovědi datové části v nadcházející verzi. Informace o uživatelích na řídicím panelu Power BI můžete načíst pomocí volání Získat uživatele řídicího panelu jako Správa rozhraní API nebo volání rozhraní API PostWorkspaceInfo s parametrem `getArtifactUsers` .
webUrl	string	Webová adresa URL řídicího panelu
workspaceId	string	ID (GUID) pracovního prostoru řídicího panelu. Tato vlastnost se vrátí pouze v GetDashboardsAsAdmin.

AdminDataflow

Metadata toku dat vrácená rozhraními API Správa. Níže je seznam vlastností, které se můžou vrátit pro tok dat. V závislosti na volaných rozhraní API, oprávněních volajícího a dostupnosti dat v databázi Power BI se vrátí jenom podmnožina vlastností.

Name	Typ	Description
configuredBy	string	Vlastník toku dat
description	string	Popis toku dat
modelUrl	string	Adresa URL definičního souboru toku dat (model.json)
modifiedBy	string	Uživatel, který tok dat upravil
modifiedDateTime	string	Datum a čas poslední změny toku dat
name	string	Název toku dat
objectId	string	ID toku dat
users	DataflowUser[]	(Prázdná hodnota) Podrobnosti o přístupu uživatele k toku dat Tato vlastnost se odebere z odpovědi datové části v nadcházející verzi. Informace o uživatelích v toku dat Power BI můžete načíst pomocí volání Získat uživatele toku dat jako volání rozhraní API Správa nebo volání rozhraní API PostWorkspaceInfo s parametrem `getArtifactUser` .
workspaceId	string	ID pracovního prostoru toku dat.

AdminDataset

Datová sada Power BI vrácená rozhraními SPRÁVA API. Rozhraní API vrátí podmnožinu z následujícího seznamu vlastností datové sady. Podmnožina závisí na volaných rozhraní API, oprávněních volajícího a dostupnosti dat v databázi Power BI.

Name	Typ	Description
ContentProviderType	string	Typ poskytovatele obsahu pro datovou sadu
CreateReportEmbedURL	string	Adresa URL pro vložení sestavy pro vytvoření datové sady
CreatedDate	string	Datum a čas vytvoření datové sady
Encryption	Encryption	Informace o šifrování datové sady. Platí pouze v případě, že `$expand` je zadána hodnota .
IsEffectiveIdentityRequired	boolean	Jestli datová sada vyžaduje efektivní identitu, kterou musíte odeslat voláním rozhraní API GenerateToken .
IsEffectiveIdentityRolesRequired	boolean	Určuje, jestli je v souboru .pbix Power BI definované zabezpečení na úrovni řádků. Pokud ano, musíte zadat roli.
IsInPlaceSharingEnabled	boolean	Jestli je možné datovou sadu sdílet s externími uživateli, aby ji mohli využívat ve svém vlastním tenantovi
IsOnPremGatewayRequired	boolean	Jestli datová sada vyžaduje místní bránu dat
IsRefreshable	boolean	Jestli je datová sada aktualizovatelná nebo ne. Aktualizovatelná datová sada Power BI je datová sada, která se aspoň jednou aktualizovala nebo pro kterou existuje platný plán aktualizace.
QnaEmbedURL	string	Adresa URL pro vložení Q&A datové sady
addRowsAPIEnabled	boolean	Jestli datová sada umožňuje přidávání nových řádků
configuredBy	string	Vlastník datové sady
description	string	Popis datové sady
id	string	ID datové sady
name	string	Název datové sady
queryScaleOutSettings	DatasetQueryScaleOutSettings	Nastavení škálování dotazu na více instancí datové sady
targetStorageMode	string	Režim úložiště datové sady
upstreamDataflows	DependentDataflow[]	Seznam všech toků dat, na které tato položka závisí
users	DatasetUser[]	(Prázdná hodnota) Podrobnosti o přístupu uživatele k datové sadě Tato vlastnost se odebere z odpovědi datové části v nadcházející verzi. Informace o uživatelích z položky Power BI (například sestavy nebo řídicího panelu) můžete načíst pomocí rozhraní API Get Dataset Users as Správa nebo rozhraní API PostWorkspaceInfo s parametrem `getArtifactUsers` .
webUrl	string	Webová adresa URL datové sady
workspaceId	string	ID pracovního prostoru datové sady. Tato vlastnost se vrátí jenom v GetDatasetsAsAdmin.

AdminGroup

Skupina Power BI vrácená rozhraními API pro správu

Name	Typ	Description
capacityId	string	ID kapacity
dashboards	AdminDashboard[]	Řídicí panely, které patří do skupiny
dataflowStorageId	string	ID účtu úložiště toku dat Power BI
dataflows	AdminDataflow[]	Toky dat, které patří do skupiny
datasets	AdminDataset[]	Datové sady, které patří do skupiny
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	Výchozí formát úložiště datové sady v pracovním prostoru Vráceno pouze v případech, kdy `isOnDedicatedCapacity` je `true`
description	string	Popis skupiny
hasWorkspaceLevelSettings	boolean	Určuje, jestli má pracovní prostor vlastní nastavení.
id	string	ID pracovního prostoru
isOnDedicatedCapacity	boolean	Jestli je skupina přiřazená k vyhrazené kapacitě
isReadOnly	boolean	Jestli je skupina jen pro čtení
logAnalyticsWorkspace	AzureResource	Pracovní prostor služby Log Analytics přiřazený ke skupině Vrátí se pouze při načítání jedné skupiny.
name	string	Název skupiny
pipelineId	string	ID kanálu nasazení, ke kterému je pracovní prostor přiřazen.
reports	AdminReport[]	Sestavy, které patří do skupiny
state	string	Stav skupiny
type	GroupType	Typ vrácené skupiny
users	GroupUser[]	(Prázdná hodnota) Uživatelé, kteří patří do skupiny, a jejich přístupová práva. Tato vlastnost bude odebrána z odpovědi datové části v nadcházející verzi. Informace o uživatelích z položky Power BI (například sestavy nebo řídicího panelu) můžete načíst pomocí volání rozhraní API Get Group Users As Správa nebo volání rozhraní API PostWorkspaceInfo s parametrem`getArtifactUsers`.
workbooks	Workbook[]	Sešity, které patří do skupiny

AdminGroups

Obálka odpovědi OData pro seznam skupin Power BI vrácených rozhraními SPRÁVA API

Name	Typ	Description
odata.context	string	Kontext OData
value	AdminGroup[]	Seznam skupin

AdminReport

Sestava Power BI vrácená rozhraními SPRÁVA API Rozhraní API vrátí podmnožinu z následujícího seznamu vlastností sestavy. Podmnožina závisí na volaného rozhraní API, oprávněních volajícího a dostupnosti dat v databázi Power BI.

Name	Typ	Description
appId	string	ID aplikace, které se vrátí jenom v případě, že sestava patří aplikaci
createdBy	string	Vlastník sestavy. K dispozici pouze pro sestavy vytvořené po červnu 2019.
createdDateTime	string	Datum a čas vytvoření sestavy
datasetId	string	ID datové sady sestavy
description	string	Popis sestavy
embedUrl	string	Adresa URL pro vložení sestavy
id	string	ID sestavy
isOwnedByMe	boolean	Určete, jestli sestavu vytvořil aktuální uživatel.
modifiedBy	string	Poslední uživatel, který sestavu upravil
modifiedDateTime	string	Datum a čas poslední změny sestavy
name	string	Název sestavy
originalReportId	string	Skutečné ID sestavy při publikování pracovního prostoru jako aplikace
reportType	enum: PaginatedReport PowerBIReport	Typ sestavy
subscriptions	Subscription[]	(Prázdná hodnota) Podrobnosti o předplatném pro položku Power BI (například sestavu nebo řídicí panel). Tato vlastnost bude odebrána z odpovědi datové části v nadcházející verzi. Informace o předplatném pro sestavu Power BI můžete načíst pomocí volání Získat odběry sestav jako Správa rozhraní API.
users	ReportUser[]	(Prázdná hodnota) Podrobnosti o přístupu uživatele k sestavě Power BI Tato vlastnost bude odebrána z odpovědi datové části v nadcházející verzi. Informace o uživatelích v sestavě Power BI můžete načíst pomocí volání Rozhraní API Get Report Users as Správa nebo pomocí volání rozhraní API PostWorkspaceInfo s parametrem`getArtifactUsers`.
webUrl	string	Webová adresa URL sestavy
workspaceId	string	ID (GUID) pracovního prostoru sestavy. Tato vlastnost bude vrácena pouze v GetReportsAsAdmin.

AdminTile

Dlaždice Power BI vrácená rozhraními API Správa.

Name	Typ	Description
colSpan	integer	Počet sloupců rozpětí dlaždic
datasetId	string	ID datové sady. K dispozici pouze pro dlaždice vytvořené ze sestavy nebo pomocí datové sady, jako jsou dlaždice Q&A.
embedData	string	Data pro vložení dlaždice
embedUrl	string	Adresa URL dlaždice pro vložení
id	string	ID dlaždice
reportId	string	ID sestavy. K dispozici pouze pro dlaždice vytvořené ze sestavy.
rowSpan	integer	Počet řádků rozpětí dlaždic
title	string	Zobrazovaný název dlaždice

AzureResource

Odpověď s podrobnostmi o prostředku Azure vlastněného uživatelem, jako je pracovní prostor služby Log Analytics.

Name	Typ	Description
id	string	Identifikátor prostředku v Power BI.
resourceGroup	string	Skupina prostředků v rámci předplatného, ve kterém se prostředek nachází.
resourceName	string	Název prostředku.
subscriptionId	string	Předplatné Azure, ve kterém se prostředek nachází.

DashboardUser

Položka přístupového práva uživatele Power BI pro řídicí panel

Name	Typ	Description
dashboardUserAccessRight	DashboardUserAccessRight	Přístupové právo, které má uživatel k řídicímu panelu (úroveň oprávnění)
displayName	string	Zobrazovaný název objektu zabezpečení
emailAddress	string	E-mailová adresa uživatele
graphId	string	Identifikátor objektu zabezpečení v Microsoft Graphu. K dispozici pouze pro rozhraní API pro správu.
identifier	string	Identifikátor objektu zabezpečení
principalType	PrincipalType	Typ objektu zabezpečení
profile	ServicePrincipalProfile	Profil objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty.
userType	string	Typ uživatele.

DashboardUserAccessRight

Přístupové právo, které má uživatel k řídicímu panelu (úroveň oprávnění)

Name	Typ	Description
None	string	Žádná oprávnění k obsahu na řídicím panelu
Owner	string	Uděluje přístup ke čtení, zápisu a sdílení obsahu v sestavě.
Read	string	Udělí oprávnění ke čtení obsahu na řídicím panelu.
ReadCopy	string	Uděluje přístup ke čtení a kopírování obsahu na řídicím panelu.
ReadReshare	string	Uděluje přístup ke čtení a sdílení obsahu na řídicím panelu.
ReadWrite	string	Uděluje přístup ke čtení a zápisu k obsahu na řídicím panelu.

DataflowUser

Přístupová práva uživatele Power BI pro tok dat

Name	Typ	Description
DataflowUserAccessRight	DataflowUserAccessRight	Přístupové právo, které má uživatel k toku dat (úroveň oprávnění)
displayName	string	Zobrazovaný název objektu zabezpečení
emailAddress	string	E-mailová adresa uživatele
graphId	string	Identifikátor objektu zabezpečení v Microsoft Graphu. K dispozici pouze pro rozhraní API pro správu.
identifier	string	Identifikátor objektu zabezpečení
principalType	PrincipalType	Typ objektu zabezpečení
profile	ServicePrincipalProfile	Profil objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty.
userType	string	Typ uživatele.

DataflowUserAccessRight

Přístupové právo, které má uživatel k toku dat (úroveň oprávnění)

Name	Typ	Description
None	string	Odebere oprávnění k obsahu v toku dat.
Owner	string	Uděluje přístup ke čtení, zápisu a sdílení obsahu v toku dat.
Read	string	Uděluje přístup ke čtení obsahu v toku dat.
ReadReshare	string	Uděluje přístup ke čtení a sdílení obsahu v toku dat.
ReadWrite	string	Uděluje přístup ke čtení a zápisu k obsahu v toku dat.

DatasetQueryScaleOutSettings

Dotaz na nastavení škálování datové sady na více instancí

Name	Typ	Description
autoSyncReadOnlyReplicas	boolean	Jestli datová sada automaticky synchronizuje repliky jen pro čtení
maxReadOnlyReplicas	integer	Maximální počet replik jen pro čtení pro datovou sadu (0–64, -1 pro automatický počet replik)

DatasetUser

Položka přístupového práva uživatele Power BI pro datovou sadu

Name	Typ	Description
datasetUserAccessRight	DatasetUserAccessRight	Přístupové právo, které má uživatel k datové sadě (úroveň oprávnění)
displayName	string	Zobrazovaný název objektu zabezpečení
emailAddress	string	E-mailová adresa uživatele
graphId	string	Identifikátor objektu zabezpečení v Microsoft Graphu. K dispozici pouze pro rozhraní API pro správu.
identifier	string	Identifikátor objektu zabezpečení
principalType	PrincipalType	Typ objektu zabezpečení
profile	ServicePrincipalProfile	Profil objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty.
userType	string	Typ uživatele.

DatasetUserAccessRight

Přístupové právo, které má uživatel k datové sadě (úroveň oprávnění)

Name	Typ	Description
None	string	Odebere oprávnění k obsahu v datové sadě.
Read	string	Udělí oprávnění ke čtení obsahu v datové sadě.
ReadExplore	string	Udělí přístup ke čtení a prozkoumání obsahu v datové sadě.
ReadReshare	string	Uděluje přístup ke čtení a sdílení obsahu v datové sadě.
ReadReshareExplore	string	Uděluje přístup ke čtení, sdílení a prozkoumání obsahu v datové sadě.
ReadWrite	string	Uděluje přístup ke čtení a zápisu k obsahu v datové sadě.
ReadWriteExplore	string	Uděluje přístup ke čtení, zápisu a prozkoumání obsahu v datové sadě.
ReadWriteReshare	string	Uděluje přístup ke čtení, zápisu a sdílení obsahu v datové sadě.
ReadWriteReshareExplore	string	Uděluje přístup ke čtení, zápisu, sdílení a prozkoumání obsahu v datové sadě.

DefaultDatasetStorageFormat

Výchozí formát úložiště datové sady ve skupině

Name	Typ	Description
Large	string	Velký formát úložiště datové sady
Small	string	Formát úložiště malých datových sad

DependentDataflow

Tok dat závislý na Power BI

Name	Typ	Description
groupId	string	ID cílové skupiny
targetDataflowId	string	ID cílového toku dat

Encryption

Informace o šifrování datové sady

Name	Typ	Description
EncryptionStatus	EncryptionStatus	Stav šifrování datové sady

EncryptionStatus

Stav šifrování datové sady

Name	Typ	Description
InSyncWithWorkspace	string	Šifrování se podporuje a synchronizuje se s nastavením šifrování.
NotInSyncWithWorkspace	string	Šifrování se podporuje, ale není synchronizované s nastavením šifrování.
NotSupported	string	U této datové sady se nepodporuje šifrování.
Unknown	string	Stav šifrování je neznámý kvůli poškození datové sady.

GroupType

Typ skupiny

Name	Typ	Description
Group	string	Verze 1 sdíleného pracovního prostoru. Tento typ pracovních prostorů bude zastaralý, protože Microsoft migruje všechny pracovní prostory na nejnovější verzi sdíleného pracovního prostoru.
Personal	string	Speciální typ pracovního prostoru určený pro seznam SharePointu a integraci s OneDrivem
PersonalGroup	string	"Můj pracovní prostor", označovaný také jako osobní pracovní prostor
Workspace	string	Sdílený pracovní prostor nebo jednoduchý pracovní prostor používaný ke sdílení obsahu s jinými uživateli v organizaci

GroupUser

Uživatel Power BI s přístupem k pracovnímu prostoru

Name	Typ	Description
displayName	string	Zobrazovaný název objektu zabezpečení
emailAddress	string	E-mailová adresa uživatele
graphId	string	Identifikátor objektu zabezpečení v Microsoft Graphu. K dispozici pouze pro rozhraní API pro správu.
groupUserAccessRight	GroupUserAccessRight	Přístupové právo (úroveň oprávnění), které má uživatel v pracovním prostoru
identifier	string	Identifikátor objektu zabezpečení
principalType	PrincipalType	Typ objektu zabezpečení
profile	ServicePrincipalProfile	Profil objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty.
userType	string	Typ uživatele.

GroupUserAccessRight

Přístupová práva (úroveň oprávnění), která má uživatel k pracovnímu prostoru

Name	Typ	Description
Admin	string	Práva správce k obsahu pracovního prostoru
Contributor	string	Čtení a zkoumání přístupu (ReadExplore) k obsahu pracovního prostoru
Member	string	Číst, sdílet a zkoumat přístupová práva (ReadReshareExplore) k obsahu pracovního prostoru
None	string	Žádný přístup k obsahu pracovního prostoru
Viewer	string	Přístup jen pro čtení k obsahu pracovního prostoru

PrincipalType

Typ objektu zabezpečení

Name	Typ	Description
App	string	Typ instančního objektu
Group	string	Typ objektu zabezpečení skupiny
None	string	Žádný typ objektu zabezpečení. Použijte pro přístup na úrovni celé organizace.
User	string	Typ objektu zabezpečení uživatele

ReportUser

Přístupová práva uživatele Power BI pro sestavu

Name	Typ	Description
displayName	string	Zobrazovaný název objektu zabezpečení
emailAddress	string	E-mailová adresa uživatele
graphId	string	Identifikátor objektu zabezpečení v Microsoft Graphu. K dispozici pouze pro rozhraní API pro správu.
identifier	string	Identifikátor objektu zabezpečení
principalType	PrincipalType	Typ objektu zabezpečení
profile	ServicePrincipalProfile	Profil objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty.
reportUserAccessRight	ReportUserAccessRight	Přístupová práva, která má uživatel k sestavě (úroveň oprávnění)
userType	string	Typ uživatele.

ReportUserAccessRight

Přístupové právo, které má uživatel k sestavě (úroveň oprávnění)

Name	Typ	Description
None	string	Žádná oprávnění k obsahu v sestavě
Owner	string	Uděluje přístup ke čtení, zápisu a sdílení obsahu v sestavě.
Read	string	Uděluje oprávnění ke čtení obsahu v sestavě.
ReadCopy	string	Uděluje přístup ke čtení a kopírování obsahu v sestavě.
ReadReshare	string	Uděluje přístup ke čtení a opětovnému sdílení obsahu v sestavě.
ReadWrite	string	Uděluje přístup ke čtení a zápisu k obsahu v sestavě.

ServicePrincipalProfile

Profil objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty.

Name	Typ	Description
displayName	string	Název profilu instančního objektu
id	string	ID profilu instančního objektu

Subscription

E-mailový odběr položky Power BI (například sestavy nebo řídicího panelu)

Name	Typ	Description
artifactDisplayName	string	Název odebírané položky Power BI (například sestavy nebo řídicího panelu)
artifactId	string	ID odebírané položky Power BI (například sestavy nebo řídicího panelu)
artifactType	string	Typ položky Power BI (například `Report`, `Dashboard`nebo `Dataset`)
attachmentFormat	string	Formát sestavy připojené k odběru e-mailu
endDate	string	Koncové datum a čas odběru e-mailu
frequency	string	Frekvence odběru e-mailů
id	string	ID předplatného
isEnabled	boolean	Jestli je povolený odběr e-mailu
linkToContent	boolean	Jestli v e-mailovém odběru existuje odkaz na odběr
previewImage	boolean	Jestli v odběru e-mailu existuje snímek obrazovky se sestavou
startDate	string	Počáteční datum a čas odběru e-mailu
subArtifactDisplayName	string	Název stránky odebírané položky Power BI, pokud se jedná o sestavu.
title	string	Název aplikace
users	SubscriptionUser[]	Podrobnosti o každém odběrateli e-mailu. Při použití volání rozhraní API Get User Subscriptions As Správa je vrácenou hodnotou prázdné pole (null). Tato vlastnost se odebere z odpovědi datové části v nadcházející verzi. Informace o předplatném sestavy nebo řídicího panelu Power BI můžete načíst pomocí volání rozhraní API Získat odběry sestav jako Správa nebo Získat odběry řídicího panelu jako Správa.

SubscriptionUser

Uživatel e-mailového předplatného Power BI

Name	Typ	Description
displayName	string	Zobrazovaný název objektu zabezpečení
emailAddress	string	E-mailová adresa uživatele
graphId	string	Identifikátor objektu zabezpečení v Microsoft Graphu. K dispozici pouze pro rozhraní API pro správu.
identifier	string	Identifikátor objektu zabezpečení
principalType	PrincipalType	Typ objektu zabezpečení
profile	ServicePrincipalProfile	Profil objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty.
userType	string	Typ uživatele.

Workbook

Sešit Power BI

Name	Typ	Description
datasetId	string	ID datové sady přidružené k sešitu. Platí jenom v případě, že sešit má přidruženou datovou sadu.
name	string	Název sešitu

Sdílet prostřednictvím

Admin - Groups GetGroupsAsAdmin

Oprávnění

Požadovaný obor

Omezení

Parametry identifikátoru URI

Odpovědi

Příklady

Get deleted workspaces example.

Sample Request

Sample Response

Get orphaned workspaces example.

Sample Request

Sample Response

Get workspaces with their 'dashboards' expanded example

Sample Request

Sample Response

Get workspaces with their 'datasets' expanded example

Sample Request

Sample Response

Get workspaces with their 'datasets' expanded example.

Sample Request

Sample Response

Get workspaces with their 'reports' expanded example

Sample Request

Sample Response

Get workspaces with their 'users' expanded example.

Sample Request

Sample Response

Get workspaces with their 'workbooks' expanded example

Sample Request

Sample Response

Definice

AdminDashboard

AdminDataflow

AdminDataset

AdminGroup

AdminGroups

AdminReport

AdminTile

AzureResource

DashboardUser

DashboardUserAccessRight

DataflowUser

DataflowUserAccessRight

DatasetQueryScaleOutSettings

DatasetUser

DatasetUserAccessRight

DefaultDatasetStorageFormat

DependentDataflow

Encryption

EncryptionStatus

GroupType

GroupUser

GroupUserAccessRight

PrincipalType

ReportUser

ReportUserAccessRight

ServicePrincipalProfile

Subscription

SubscriptionUser

Workbook

Další materiály