Admin - Groups GetGroupsAsAdmin

Reference

Služba:: Power BI REST APIs

Verze rozhraní API:: v1.0

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

Dovolení

Uživatel musí být správcem infrastruktury nebo se musí ověřit pomocí instančního objektu.
Delegovaná oprávnění jsou podporována.

Při spuštění v rámci ověřování prinicipal služby nesmí aplikace nesmí mít na webu Azure Portal nastavené žádné žádosti o udělení souhlasu správce 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. Při ověřování pomocí instančního objektu nesmí být k dispozici.

Omezení

Maximálně 50 požadavků za hodinu nebo 15 požadavků za minutu na tenanta. Toto volání také vyprší po 30 sekundách, aby se zabránilo nepříznivým účinkům na službu Power BI.

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

S volitelnými parametry:

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í n výsledků. Tento parametr je povinný a musí být v rozsahu od 1 do 5000.
$expand	query		string	Přijme čárkami oddělený seznam datových typů, který se v odpovědi rozbalí. Podporuje `users`, `reports`, `dashboards`, `datasets`, `dataflows`a `workbooks`.
$filter	query		string	Vrátí podmnožinu výsledků na základě Odata podmínky parametru dotazu filtru.
$skip	query		integer int32	Přeskočí první n výsledků. Pomocí horní části můžete načíst výsledky nad rámec prvních 5 000.

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.

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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.

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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.

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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.

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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 pro správu Rozhraní API vrátí podmnožinu následujících vlastností řídicího panelu. Podmnožina závisí na rozhraní API volaného, oprávnění volajícího a dostupnosti dat v databázi Power BI.
AdminDataflow	Metadata toku dat vrácená rozhraními API pro správu. Níže je seznam vlastností, které mohou být vráceny pro tok dat. V závislosti na volaného rozhraní API se vrátí jenom podmnožina vlastností, oprávnění volajícího a dostupnost dat v databázi Power BI.
AdminDataset	Datová sada Power BI vrácená rozhraními API pro správu Rozhraní API vrátí podmnožinu následujících vlastností datové sady. Podmnožina závisí na rozhraní API volaného, oprávnění 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 API pro správu
AdminReport	Sestava Power BI vrácená rozhraními API pro správu Rozhraní API vrátí podmnožinu následujících vlastností sestavy. Podmnožina závisí na rozhraní API volaného, oprávnění volajícího a dostupnosti dat v databázi Power BI.
AdminTile	Dlaždice Power BI vrácená rozhraními API pro správu
AzureResource	Odpověď s podrobnostmi o prostředku Azure vlastněného uživatelem, jako je pracovní prostor služby Log Analytics.
DashboardUser	Položka práva pro přístup uživatele Power BI k řídicímu panelu
DashboardUserAccessRight	Přístupové právo, které má uživatel pro řídicí panel (úroveň oprávnění)
DataflowUser	Přístup uživatele Power BI ke správnému zadání toku dat
DataflowUserAccessRight	Přístupové právo, které má uživatel pro tok dat (úroveň oprávnění)
DatasetQueryScaleOutSettings	Dotazování na nastavení horizontálního navýšení kapacity datové sady
DatasetUser	Přístup uživatele Power BI ke správné položce pro datovou sadu
DatasetUserAccessRight	Přístupové právo, které má uživatel pro datovou sadu (ú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ávo (úroveň oprávnění), které má uživatel v pracovním prostoru
PrincipalType	Typ objektu zabezpečení
ReportUser	Přístup uživatele Power BI ke správné položce pro sestavu
ReportUserAccessRight	Přístupové právo, které má uživatel pro sestavu (úroveň oprávnění)
ServicePrincipalProfile	Profil instančního objektu Power BI. Relevantní pouze pro víceklientské řešení Power BI Embedded.
Subscription	Odběr e-mailu pro položku Power BI (například sestavu nebo řídicí panel)
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 pro správu Rozhraní API vrátí podmnožinu následujících vlastností řídicího panelu. Podmnožina závisí na rozhraní API volaného, oprávnění volajícího a dostupnosti dat v databázi Power BI.

Name	Typ	Description
appId	string	ID aplikace, vrácené pouze v případě, že řídicí panel patří do aplikace
displayName	string	Zobrazovaný název řídicího panelu
embedUrl	string	Adresa URL pro vložení řídicího panelu
id	string	ID řídicího panelu
isReadOnly	boolean	Jestli je řídicí panel jen pro čtení
subscriptions	Subscription[]	(Prázdná hodnota) Podrobnosti předplatného 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 sestavy Power BI můžete načíst pomocí Získat odběry sestav jako volání rozhraní API pro správce.
tiles	AdminTile[]	Dlaždice, které patří na řídicí panel
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í Získat uživatele řídicího panelu jako volání rozhraní API pro správu nebo volání rozhraní API PostWorkspaceInfo pomocí parametru `getArtifactUsers`.
webUrl	string	Webová adresa URL řídicího panelu
workspaceId	string	ID (GUID) pracovního prostoru řídicího panelu. Tato vlastnost bude vrácena pouze v GetDashboardsAsAdmin.

AdminDataflow

Metadata toku dat vrácená rozhraními API pro správu. Níže je seznam vlastností, které mohou být vráceny pro tok dat. V závislosti na volaného rozhraní API se vrátí jenom podmnožina vlastností, oprávnění volajícího a dostupnost dat v databázi Power BI.

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)
name	string	Název toku dat
objectId	string	ID toku dat
users	DataflowUser[]	(Prázdná hodnota) Podrobnosti o přístupu uživatele toku dat. Tato vlastnost bude odebrána 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í rozhraní API Získat tok dat jako správce rozhraní API nebo volání rozhraní API PostWorkspaceInfo rozhraní API s parametrem `getArtifactUser`.
workspaceId	string	ID pracovního prostoru toku dat.

AdminDataset

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

Name	Typ	Description
ContentProviderType	string	Typ zprostředkovatele obsahu pro datovou sadu
CreateReportEmbedURL	string	Adresa URL pro vložení sestavy pro vytvoření datové sady
Encryption	Encryption	Informace o šifrování datové sady Platí pouze v případě, že je zadán `$expand`.
IsEffectiveIdentityRequired	boolean	Určuje, jestli datová sada vyžaduje efektivní identitu, kterou musíte odeslat ve volání rozhraní API GenerateToken.
IsEffectiveIdentityRolesRequired	boolean	Určuje, jestli je zabezpečení na úrovni řádků definováno v souboru Power BI .pbix. Pokud ano, musíte zadat roli.
IsInPlaceSharingEnabled	boolean	Určuje, jestli se datová sada dá sdílet s externími uživateli, kteří se mají využívat ve svém vlastním tenantovi.
IsOnPremGatewayRequired	boolean	Jestli datová sada vyžaduje místní bránu dat
IsRefreshable	boolean	Toto pole vrátí `true`, když se datová sada buď nedávno aktualizuje, nebo je nakonfigurovaná pro automatickou aktualizaci. Režim připojení je speciálně nastavený na Import. Hodnota vrátí `false` pro jiné režimy připojení, například DirectQuery a LiveConnection, bez ohledu na to, jestli se datová sada aktualizuje ručně nebo je nastavená pro automatickou aktualizaci.
QnaEmbedURL	string	Adresa URL pro vložení Q&datové sady
addRowsAPIEnabled	boolean	Určuje, jestli datová sada umožňuje přidávat nové řádky.
configuredBy	string	Vlastník datové sady
createdDate	string	Datum a čas vytvoření datové sady
description	string	Popis datové sady
id	string	ID datové sady
name	string	Název datové sady
queryScaleOutSettings	DatasetQueryScaleOutSettings	Dotazování na nastavení horizontálního navýšení kapacity datové sady
targetStorageMode	string	Režim úložiště datové sady
upstreamDataflows	DependentDataflow[]	Seznamvšechch
users	DatasetUser[]	(Prázdná hodnota) Podrobnosti o přístupu uživatele k datové sadě. Tato vlastnost bude odebrána z odpovědi datové části v nadcházející verzi. Informace o uživateli položky Power BI (například sestavy nebo řídicího panelu) můžete načíst pomocí rozhraní API Získat uživatele datové sady jako rozhraní API pro správu nebo rozhraní API PostWorkspaceInfo pomocí parametru `getArtifactUsers`.
webUrl	string	Webová adresa URL datové sady
workspaceId	string	ID pracovního prostoru datové sady. Tato vlastnost bude vrácena pouze 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 `isOnDedicatedCapacitytrue`
description	string	Popis skupiny
hasWorkspaceLevelSettings	boolean	Určuje, jestli má pracovní prostor vlastní nastavení.
id	string	ID pracovního prostoru
isOnDedicatedCapacity	boolean	Určuje, jestli je skupina přiřazená k vyhrazené kapacitě.
isReadOnly	boolean	Jestli je skupina určená jen pro čtení
logAnalyticsWorkspace	AzureResource	Pracovní prostor služby Log Analytics přiřazený ke skupině. Tato funkce se vrátí 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živateli pro položku Power BI (například sestavu nebo řídicí panel) můžete načíst pomocí volání rozhraní API Získat uživatele skupiny jako správce rozhraní API nebo pomocí volání rozhraní API PostWorkspaceInfo`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 API pro správu

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

AdminReport

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

Name	Typ	Description
appId	string	ID aplikace, vrácené pouze v případě, že sestava patří do aplikace
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čuje, jestli je sestava vytvořená aktuálním uživatelem.
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 předplatného 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 sestavy Power BI můžete načíst pomocí Získat odběry sestav jako volání rozhraní API pro správce.
users	ReportUser[]	(Prázdná hodnota) Podrobnosti o přístupu uživatele pro sestavu Power BI. Tato vlastnost bude odebrána z odpovědi datové části v nadcházející verzi. Informace o uživateli v sestavě Power BI můžete načíst pomocí volání rozhraní API Získat uživatele sestavy jako volání rozhraní API pro správu nebo volání rozhraní API PostWorkspaceInfo rozhraní API s parametrem `getArtifactUsers`.
webUrl	string	Webová adresa URL sestavy
workspaceId	string	ID pracovního prostoru (GUID) sestavy. Tato vlastnost bude vrácena pouze v GetReportsAsAdmin.

AdminTile

Dlaždice Power BI vrácená rozhraními API pro správu

Name	Typ	Description
colSpan	integer	Početsloupcůchch
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 vložení pro dlaždici
embedUrl	string	Adresa URL pro vložení dlaždice
id	string	ID dlaždice
reportId	string	ID sestavy. K dispozici pouze pro dlaždice vytvořené ze sestavy.
rowSpan	integer	Počet řádků mezi dlaždicemi
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 práva pro přístup uživatele Power BI k řídicímu panelu

Name	Typ	Description
dashboardUserAccessRight	DashboardUserAccessRight	Přístupové právo, které má uživatel pro řídicí panel (ú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 instančního objektu Power BI. Relevantní pouze pro víceklientské řešení Power BI Embedded.
userType	string	Typ uživatele

DashboardUserAccessRight

Přístupové právo, které má uživatel pro řídicí panel (ú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 opětovnému sdílení obsahu v sestavě.
Read	string	Uděluje přístup pro čtení k 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 pro čtení a zápis k obsahu na řídicím panelu.

DataflowUser

Přístup uživatele Power BI ke správnému zadání toku dat

Name	Typ	Description
DataflowUserAccessRight	DataflowUserAccessRight	Přístupové právo, které má uživatel pro tok 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 instančního objektu Power BI. Relevantní pouze pro víceklientské řešení Power BI Embedded.
userType	string	Typ uživatele

DataflowUserAccessRight

Přístupové právo, které má uživatel pro tok 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 opětovnému sdílení obsahu v toku dat.
Read	string	Uděluje přístup pro čtení k 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 pro čtení a zápis k obsahu v toku dat.

DatasetQueryScaleOutSettings

Dotazování na nastavení horizontálního navýšení kapacity datové sady

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

Přístup uživatele Power BI ke správné položce pro datovou sadu

Name	Typ	Description
datasetUserAccessRight	DatasetUserAccessRight	Přístupové právo, které má uživatel pro datovou sadu (ú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 instančního objektu Power BI. Relevantní pouze pro víceklientské řešení Power BI Embedded.
userType	string	Typ uživatele

DatasetUserAccessRight

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

Name	Typ	Description
None	string	Odebere oprávnění k obsahu v datové sadě.
Read	string	Uděluje přístup pro čtení k obsahu v datové sadě.
ReadExplore	string	Uděluje přístup ke čtení a prozkoumání obsahu v datové sadě.
ReadReshare	string	Uděluje přístup ke čtení a opětovnému sdílení obsahu v datové sadě.
ReadReshareExplore	string	Uděluje přístup ke čtení, opětovnému sdílení a prozkoumání obsahu v datové sadě.
ReadWrite	string	Uděluje přístup pro čtení a zápis 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 opětovnému sdílení obsahu v datové sadě.
ReadWriteReshareExplore	string	Uděluje přístup ke čtení, zápisu, opětovnému sdílení a prozkoumání přístupu k obsahu v datové sadě.

DefaultDatasetStorageFormat

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

Name	Typ	Description
Large	string	Formát úložiště velkých datových sad
Small	string	Malý formát úložiště 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 je synchronizované s nastavením šifrování.
NotInSyncWithWorkspace	string	Šifrování se podporuje, ale nesynchronizuje se s nastavením šifrování.
NotSupported	string	Pro tuto datovou sadu není podporováno šifrování.
Unknown	string	Stav šifrování není znám kvůli poškození datové sady.

GroupType

Typ skupiny

Name	Typ	Description
AdminWorkspace	string	Monitorování správy pro správce prostředků infrastruktury
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 integraci sharepointového seznamu a OneDrivu
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 ostatní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 instančního objektu Power BI. Relevantní pouze pro víceklientské řešení Power BI Embedded.
userType	string	Typ uživatele

GroupUserAccessRight

Přístupové právo (úroveň oprávnění), které má uživatel v pracovním 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	Čtení, opětovné sdílení a zkoumání přístupových práv k obsahu pracovního prostoru (ReadReshareExplore)
None	string	Žádný přístup k obsahu pracovního prostoru
Viewer	string	Přístup k obsahu pracovního prostoru jen pro čtení (jen pro čtení)

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žívá se pro přístup na úrovni celé organizace.
User	string	Typ objektu zabezpečení uživatele

ReportUser

Přístup uživatele Power BI ke správné položce 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 instančního objektu Power BI. Relevantní pouze pro víceklientské řešení Power BI Embedded.
reportUserAccessRight	ReportUserAccessRight	Přístupové právo, které má uživatel pro sestavu (úroveň oprávnění)
userType	string	Typ uživatele

ReportUserAccessRight

Přístupové právo, které má uživatel pro sestavu (ú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 opětovnému sdílení obsahu v sestavě.
Read	string	Uděluje přístup pro čtení k 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 pro čtení a zápis k obsahu v sestavě.

ServicePrincipalProfile

Profil instančního objektu Power BI. Relevantní pouze pro víceklientské řešení Power BI Embedded.

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

Subscription

Odběr e-mailu pro položku Power BI (například sestavu nebo řídicí panel)

Name	Typ	Description
artifactDisplayName	string	Název odebírané položky Power BI (například sestava nebo řídicí panel)
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é e-mailové předplatné
linkToContent	boolean	Jestli odkaz na odběr existuje v e-mailovém předplatném
previewImage	boolean	Jestli v odběru e-mailu existuje snímek obrazovky sestavy
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í získání uživatelských předplatných jako správce volání rozhraní API je vrácená hodnota prázdné pole (null). Tato vlastnost bude odebrána z odpovědi datové části v nadcházející verzi. Informace o předplatném můžete načíst na sestavě nebo řídicím panelu Power BI pomocí Získat předplatná sestav jako správce nebo získat předplatná řídicích panelů jako volání rozhraní API pro správce.

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 instančního objektu Power BI. Relevantní pouze pro víceklientské řešení Power BI Embedded.
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 obsahuje přidruženou datovou sadu.
name	string	Název sešitu

Sdílet prostřednictvím

Admin - Groups GetGroupsAsAdmin

Dovolení

Požadovaný obor

Omezení

Parametry identifikátoru URI

Odpovědi

Příklady

Get deleted workspaces example.

Ukázkový požadavek

Ukázková odpověď

Get orphaned workspaces example.

Ukázkový požadavek

Ukázková odpověď

Get workspaces with their 'dashboards' expanded example

Ukázkový požadavek

Ukázková odpověď

Get workspaces with their 'datasets' expanded example

Ukázkový požadavek

Ukázková odpověď

Get workspaces with their 'datasets' expanded example.

Ukázkový požadavek

Ukázková odpověď

Get workspaces with their 'reports' expanded example

Ukázkový požadavek

Ukázková odpověď

Get workspaces with their 'users' expanded example.

Ukázkový požadavek

Ukázková odpověď

Get workspaces with their 'workbooks' expanded example

Ukázkový požadavek

Ukázková odpověď

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