Admin - Groups GetGroupsAsAdmin

Riferimento

Service:: Power BI REST APIs

API Version:: v1.0

Restituisce un elenco di aree di lavoro per l'organizzazione.

Autorizzazioni

L'utente deve avere diritti di amministratore, ad esempio Office 365 amministratore globale o amministratore del servizio Power BI, oppure eseguire l'autenticazione usando un'entità servizio.
Le autorizzazioni delegate sono supportate.

Quando è in esecuzione nell'autenticazione prinicipal del servizio, un'app non deve disporre di premissioni necessarie per il consenso amministratore per Power BI impostata nel portale di Azure.

Ambito obbligatorio

Tenant.Read.All o Tenant.ReadWrite.All

Pertinente solo quando si esegue l'autenticazione tramite un token di accesso amministratore delegato standard. Non deve essere presente quando viene usata l'autenticazione tramite un'entità servizio.

Limitazioni

Massimo 50 richieste all'ora o 15 richieste al minuto, per tenant. Questa chiamata eseguirà anche il timeout dopo 30 secondi per evitare effetti negativi sulla servizio 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}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
$top	query	True	integer int32	Restituisce solo i primi n risultati. Questo parametro è obbligatorio e deve essere compreso nell'intervallo compreso tra 1 e 5000.
$expand	query		string	Accetta un elenco delimitato da virgole di tipi di dati, che verranno espansi inline nella risposta. Supporta `users`, `reports`, `dashboards`, `datasets`, `dataflows`e `workbooks`.
$filter	query		string	Filtra i risultati in base a una condizione booleana
$skip	query		integer int32	Ignora i primi n risultati. Usare con top per recuperare i risultati oltre i primi 5000.

Risposte

Nome	Tipo	Descrizione
200 OK	AdminGroups	OK

Esempio

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

Definizioni

Nome	Descrizione
AdminDashboard	Un dashboard di Power BI restituito dalle API di Amministrazione. L'API restituisce un subset dell'elenco seguente di proprietà del dashboard. Il subset dipende dall'API denominata, dalle autorizzazioni del chiamante e dalla disponibilità dei dati nel database di Power BI.
AdminDataflow	Metadati di un flusso di dati restituito dalle API Amministrazione. Di seguito è riportato un elenco di proprietà che possono essere restituite per un flusso di dati. Solo un subset delle proprietà verrà restituito a seconda dell'API chiamata, delle autorizzazioni del chiamante e della disponibilità dei dati nel database di Power BI.
AdminDataset	Set di dati di Power BI restituito dalle API di Amministrazione. L'API restituisce un subset dell'elenco seguente di proprietà del set di dati. Il subset dipende dall'API denominata, dalle autorizzazioni del chiamante e dalla disponibilità dei dati nel database di Power BI.
AdminGroup	Un gruppo di Power BI restituito dalle API di amministrazione
AdminGroups	Wrapper di risposta OData per un elenco di gruppi di Power BI restituiti dalle API di Amministrazione
AdminReport	Report di Power BI restituito dalle API di Amministrazione. L'API restituisce un subset dell'elenco seguente di proprietà del report. Il subset dipende dall'API denominata, dalle autorizzazioni del chiamante e dalla disponibilità dei dati nel database di Power BI.
AdminTile	Riquadro di Power BI restituito dalle API di Amministrazione.
AzureResource	Risposta che illustra in dettaglio una risorsa di Azure di proprietà dell'utente, ad esempio un'area di lavoro Log Analytics.
DashboardUser	Voce di accesso dell'utente di Power BI per un dashboard
DashboardUserAccessRight	Diritto di accesso che l'utente ha per il dashboard (livello di autorizzazione)
DataflowUser	Voce di accesso dell'utente di Power BI per un flusso di dati
DataflowUserAccessRight	Diritto di accesso che un utente ha per il flusso di dati (livello di autorizzazione)
DatasetQueryScaleOutSettings	Eseguire query su impostazioni di scalabilità orizzontale di un set di dati
DatasetUser	Voce a destra dell'accesso utente di Power BI per un set di dati
DatasetUserAccessRight	Diritto di accesso che l'utente ha per il set di dati (livello di autorizzazione)
DefaultDatasetStorageFormat	Formato di archiviazione del set di dati predefinito nel gruppo
DependentDataflow	Flusso di dati dipendente da Power BI
Encryption	Informazioni di crittografia per un set di dati
EncryptionStatus	Stato della crittografia dei set di dati
GroupType	Tipo di gruppo
GroupUser	Un utente di Power BI con accesso all'area di lavoro
GroupUserAccessRight	Diritto di accesso (livello di autorizzazione) di un utente nell'area di lavoro
PrincipalType	Tipo di entità
ReportUser	Voce di diritto di accesso utente di Power BI per un report
ReportUserAccessRight	Diritto di accesso che l'utente ha per il report (livello di autorizzazione)
ServicePrincipalProfile	Profilo principale servizio Power BI. Rilevante solo per Power BI Embedded soluzione multi-tenancy.
Subscription	Sottoscrizione di posta elettronica per un elemento di Power BI (ad esempio un report o un dashboard)
SubscriptionUser	Utente della sottoscrizione di posta elettronica di Power BI
Workbook	Una cartella di lavoro di Power BI

AdminDashboard

Un dashboard di Power BI restituito dalle API di Amministrazione. L'API restituisce un subset dell'elenco seguente di proprietà del dashboard. Il subset dipende dall'API denominata, dalle autorizzazioni del chiamante e dalla disponibilità dei dati nel database di Power BI.

Nome	Tipo	Descrizione
appId	string	ID app, restituito solo se il dashboard appartiene a un'app
displayName	string	Nome visualizzato del dashboard
embedUrl	string	URL di incorporamento del dashboard
id	string	The dashboard ID
isReadOnly	boolean	Indica se il dashboard è di sola lettura
subscriptions	Subscription[]	(Valore vuoto) Dettagli della sottoscrizione per un elemento di Power BI, ad esempio un report o un dashboard. Questa proprietà verrà rimossa dalla risposta del payload in una versione futura. È possibile recuperare le informazioni sulla sottoscrizione per un report di Power BI usando Get Report Subscriptions (Ottieni sottoscrizioni report) come Amministrazione chiamata API.
tiles	AdminTile[]	Riquadri che appartengono al dashboard
users	DashboardUser[]	(Valore vuoto) Dettagli di accesso utente del dashboard. Questa proprietà verrà rimossa dalla risposta del payload in una versione futura. È possibile recuperare le informazioni utente in un dashboard di Power BI usando Get Dashboard Users (Ottieni utenti dashboard) come chiamata API Amministrazione o l'API PostWorkspaceInfo con il `getArtifactUsers` parametro .
webUrl	string	URL Web del dashboard
workspaceId	string	ID area di lavoro (GUID) del dashboard. Questa proprietà verrà restituita solo in GetDashboardsAsAdmin.

AdminDataflow

Metadati di un flusso di dati restituito dalle API Amministrazione. Di seguito è riportato un elenco di proprietà che possono essere restituite per un flusso di dati. Solo un subset delle proprietà verrà restituito a seconda dell'API chiamata, delle autorizzazioni del chiamante e della disponibilità dei dati nel database di Power BI.

Nome	Tipo	Descrizione
configuredBy	string	Proprietario del flusso di dati
description	string	Descrizione del flusso di dati
modelUrl	string	URL del file di definizione del flusso di dati (model.json)
modifiedBy	string	Utente che ha modificato il flusso di dati
modifiedDateTime	string	Data e ora dell'ultima modifica del flusso di dati
name	string	Nome del flusso di dati
objectId	string	ID del flusso di dati
users	DataflowUser[]	(Valore vuoto) Dettagli di accesso utente del flusso di dati. Questa proprietà verrà rimossa dalla risposta del payload in una versione futura. È possibile recuperare informazioni utente su un flusso di dati di Power BI usando Recupera utenti flusso di dati come chiamata API Amministrazione o l'API PostWorkspaceInfo con il `getArtifactUser` parametro .
workspaceId	string	ID dell'area di lavoro del flusso di dati.

AdminDataset

Set di dati di Power BI restituito dalle API di Amministrazione. L'API restituisce un subset dell'elenco seguente di proprietà del set di dati. Il subset dipende dall'API denominata, dalle autorizzazioni del chiamante e dalla disponibilità dei dati nel database di Power BI.

Nome	Tipo	Descrizione
ContentProviderType	string	Tipo di provider di contenuti per il set di dati
CreateReportEmbedURL	string	URL di incorporamento del report creato dal set di dati
CreatedDate	string	Data e ora di creazione del set di dati
Encryption	Encryption	Informazioni sulla crittografia del set di dati. Applicabile solo quando `$expand` viene specificato.
IsEffectiveIdentityRequired	boolean	Indica se il set di dati richiede un'identità effettiva, che è necessario inviare in una chiamata API GenerateToken .
IsEffectiveIdentityRolesRequired	boolean	Indica se la sicurezza a livello di riga è definita all'interno del file con estensione pbix di Power BI. In tal caso, è necessario specificare un ruolo.
IsInPlaceSharingEnabled	boolean	Indica se il set di dati può essere condiviso con utenti esterni da utilizzare nel proprio tenant
IsOnPremGatewayRequired	boolean	Indica se il set di dati richiede un gateway dati locale
IsRefreshable	boolean	Indica se il set di dati è aggiornabile o meno. Un set di dati aggiornabile di Power BI è un set di dati che è stato aggiornato almeno una volta o per cui esiste una pianificazione di aggiornamento valida.
QnaEmbedURL	string	Il set di dati Q&UN URL di incorporamento
addRowsAPIEnabled	boolean	Indica se il set di dati consente l'aggiunta di nuove righe
configuredBy	string	Proprietario del set di dati
description	string	Descrizione del set di dati
id	string	ID del set di dati
name	string	Nome del set di dati
queryScaleOutSettings	DatasetQueryScaleOutSettings	Eseguire query su impostazioni di scalabilità orizzontale di un set di dati
targetStorageMode	string	Modalità di archiviazione del set di dati
upstreamDataflows	DependentDataflow[]	L'elenco di tutti i flussi di dati da cui dipende questo elemento
users	DatasetUser[]	(Valore vuoto) Dettagli di accesso utente del set di dati. Questa proprietà verrà rimossa dalla risposta del payload in una versione futura. È possibile recuperare informazioni utente su un elemento di Power BI , ad esempio un report o un dashboard, usando l'API Get Dataset Users (Ottieni utenti del set di dati) come API Amministrazione o l'API PostWorkspaceInfo con il `getArtifactUsers` parametro .
webUrl	string	URL Web del set di dati
workspaceId	string	ID area di lavoro del set di dati. Questa proprietà verrà restituita solo in GetDatasetsAsAdmin.

AdminGroup

Un gruppo di Power BI restituito dalle API di amministrazione

Nome	Tipo	Descrizione
capacityId	string	ID della capacità
dashboards	AdminDashboard[]	Dashboard che appartengono al gruppo
dataflowStorageId	string	ID dell'account di archiviazione del flusso di dati di Power BI
dataflows	AdminDataflow[]	Flussi di dati appartenenti al gruppo
datasets	AdminDataset[]	Set di dati che appartengono al gruppo
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	Formato di archiviazione del set di dati predefinito nell'area di lavoro. Restituito solo quando `isOnDedicatedCapacity` è `true`
description	string	Descrizione del gruppo
hasWorkspaceLevelSettings	boolean	Indica se l'area di lavoro ha impostazioni personalizzate
id	string	ID area di lavoro
isOnDedicatedCapacity	boolean	Indica se il gruppo è assegnato a una capacità dedicata
isReadOnly	boolean	Indica se il gruppo è di sola lettura
logAnalyticsWorkspace	AzureResource	Area di lavoro Log Analytics assegnata al gruppo. Viene restituito solo quando si recupera un singolo gruppo.
name	string	Nome del gruppo
pipelineId	string	ID della pipeline di distribuzione a cui è assegnata l'area di lavoro.
reports	AdminReport[]	Report che appartengono al gruppo
state	string	Stato del gruppo
type	GroupType	Tipo di gruppo restituito.
users	GroupUser[]	(Valore vuoto) Gli utenti che appartengono al gruppo e i relativi diritti di accesso. Questa proprietà verrà rimossa dalla risposta del payload in una versione futura. È possibile recuperare informazioni utente su un elemento di Power BI (ad esempio un report o un dashboard) usando la chiamata API Get Group Users As Amministrazione o l'API PostWorkspaceInfo con il `getArtifactUsers` parametro .
workbooks	Workbook[]	Cartelle di lavoro che appartengono al gruppo

AdminGroups

Wrapper di risposta OData per un elenco di gruppi di Power BI restituiti dalle API di Amministrazione

Nome	Tipo	Descrizione
odata.context	string	Contesto OData
value	AdminGroup[]	Elenco di gruppi

AdminReport

Report di Power BI restituito dalle API di Amministrazione. L'API restituisce un subset dell'elenco seguente di proprietà del report. Il subset dipende dall'API denominata, dalle autorizzazioni del chiamante e dalla disponibilità dei dati nel database di Power BI.

Nome	Tipo	Descrizione
appId	string	ID app, restituito solo se il report appartiene a un'app
createdBy	string	Proprietario del report. Disponibile solo per i report creati dopo giugno 2019.
createdDateTime	string	Data e ora di creazione del report
datasetId	string	ID del set di dati del report
description	string	Descrizione del report
embedUrl	string	URL di incorporamento del report
id	string	The report ID
modifiedBy	string	Ultimo utente che ha modificato il report
modifiedDateTime	string	Data e ora dell'ultima modifica del report
name	string	Nome del report
originalReportId	string	ID del report effettivo quando l'area di lavoro viene pubblicata come app.
reportType	enum: PaginatedReport PowerBIReport	Tipo di report
subscriptions	Subscription[]	(Valore vuoto) Dettagli della sottoscrizione per un elemento di Power BI, ad esempio un report o un dashboard. Questa proprietà verrà rimossa dalla risposta del payload in una versione futura. È possibile recuperare le informazioni sulla sottoscrizione per un report di Power BI usando Get Report Subscriptions (Ottieni sottoscrizioni report) come Amministrazione chiamata API.
users	ReportUser[]	(Valore vuoto) Dettagli di accesso utente per un report di Power BI. Questa proprietà verrà rimossa dalla risposta del payload in una versione futura. È possibile recuperare le informazioni utente in un report di Power BI usando Get Report Users (Ottieni utenti report) come chiamata API Amministrazione o l'API PostWorkspaceInfo con il `getArtifactUsers` parametro .
webUrl	string	URL Web del report
workspaceId	string	ID area di lavoro (GUID) del report. Questa proprietà verrà restituita solo in GetReportsAsAdmin.

AdminTile

Riquadro di Power BI restituito dalle API di Amministrazione.

Nome	Tipo	Descrizione
colSpan	integer	Numero di colonne dell'intervallo di riquadri
datasetId	string	ID del set di dati. Disponibile solo per i riquadri creati da un report o usando un set di dati, ad esempio Q&riquadri A.
embedData	string	Dati di incorporamento per il riquadro
embedUrl	string	URL di incorporamento del riquadro
id	string	ID riquadro
reportId	string	ID report. Disponibile solo per i riquadri creati da un report.
rowSpan	integer	Numero di righe dell'intervallo di riquadri
title	string	Nome visualizzato del riquadro

AzureResource

Risposta che illustra in dettaglio una risorsa di Azure di proprietà dell'utente, ad esempio un'area di lavoro Log Analytics.

Nome	Tipo	Descrizione
id	string	Identificatore della risorsa all'interno di Power BI.
resourceGroup	string	Gruppo di risorse all'interno della sottoscrizione in cui risiede la risorsa.
resourceName	string	Nome della risorsa.
subscriptionId	string	Sottoscrizione di Azure in cui risiede la risorsa.

DashboardUser

Voce di accesso dell'utente di Power BI per un dashboard

Nome	Tipo	Descrizione
dashboardUserAccessRight	DashboardUserAccessRight	Diritto di accesso che l'utente ha per il dashboard (livello di autorizzazione)
displayName	string	Nome visualizzato dell'entità
emailAddress	string	Indirizzo di posta elettronica dell'utente
graphId	string	Identificatore dell'entità in Microsoft Graph. Disponibile solo per le API di amministrazione.
identifier	string	Identificatore dell'entità
principalType	PrincipalType	Tipo principale
profile	ServicePrincipalProfile	Profilo entità servizio Power BI. Solo pertinente per Power BI Embedded soluzione multi-tenancy.
userType	string	Tipo dell'utente.

DashboardUserAccessRight

Diritto di accesso che l'utente ha per il dashboard (livello di autorizzazione)

Nome	Tipo	Descrizione
None	string	Nessuna autorizzazione per il contenuto nel dashboard
Owner	string	Concede l'accesso in lettura, scrittura e ricondividi al contenuto nel report
Read	string	Concede l'accesso in lettura al contenuto nel dashboard
ReadCopy	string	Concede l'accesso in lettura e copia al contenuto nel dashboard
ReadReshare	string	Concede l'accesso in lettura e ricondividi al contenuto nel dashboard
ReadWrite	string	Concede l'accesso in lettura e scrittura al contenuto nel dashboard

DataflowUser

Voce di accesso dell'utente di Power BI per un flusso di dati

Nome	Tipo	Descrizione
DataflowUserAccessRight	DataflowUserAccessRight	Diritto di accesso che un utente ha per il flusso di dati (livello di autorizzazione)
displayName	string	Nome visualizzato dell'entità
emailAddress	string	Indirizzo di posta elettronica dell'utente
graphId	string	Identificatore dell'entità in Microsoft Graph. Disponibile solo per le API di amministrazione.
identifier	string	Identificatore dell'entità
principalType	PrincipalType	Tipo principale
profile	ServicePrincipalProfile	Profilo entità servizio Power BI. Solo pertinente per Power BI Embedded soluzione multi-tenancy.
userType	string	Tipo dell'utente.

DataflowUserAccessRight

Diritto di accesso che un utente ha per il flusso di dati (livello di autorizzazione)

Nome	Tipo	Descrizione
None	string	Rimuove l'autorizzazione per il contenuto nel flusso di dati
Owner	string	Concede l'accesso in lettura, scrittura e ricondividi al contenuto nel flusso di dati
Read	string	Concede l'accesso in lettura al contenuto nel flusso di dati
ReadReshare	string	Concede l'accesso in lettura e rishare al contenuto nel flusso di dati
ReadWrite	string	Concede l'accesso in lettura e scrittura al contenuto nel flusso di dati

DatasetQueryScaleOutSettings

Eseguire query su impostazioni di scalabilità orizzontale di un set di dati

Nome	Tipo	Descrizione
autoSyncReadOnlyReplicas	boolean	Se il set di dati sincronizza automaticamente le repliche di sola lettura
maxReadOnlyReplicas	integer	Numero massimo di repliche di sola lettura per il set di dati (0-64, -1 per il numero automatico di repliche)

DatasetUser

Voce a destra dell'accesso utente di Power BI per un set di dati

Nome	Tipo	Descrizione
datasetUserAccessRight	DatasetUserAccessRight	Diritto di accesso che l'utente ha per il set di dati (livello di autorizzazione)
displayName	string	Nome visualizzato dell'entità
emailAddress	string	Indirizzo di posta elettronica dell'utente
graphId	string	Identificatore dell'entità in Microsoft Graph. Disponibile solo per le API di amministrazione.
identifier	string	Identificatore dell'entità
principalType	PrincipalType	Tipo principale
profile	ServicePrincipalProfile	Profilo entità servizio Power BI. Solo pertinente per Power BI Embedded soluzione multi-tenancy.
userType	string	Tipo dell'utente.

DatasetUserAccessRight

Diritto di accesso che l'utente ha per il set di dati (livello di autorizzazione)

Nome	Tipo	Descrizione
None	string	Rimuove l'autorizzazione per il contenuto nel set di dati
Read	string	Concede l'accesso in lettura al contenuto nel set di dati
ReadExplore	string	Concede l'accesso in lettura ed esplora al contenuto nel set di dati
ReadReshare	string	Concede l'accesso in lettura e rishare al contenuto nel set di dati
ReadReshareExplore	string	Concede lettura, ricondividi e Esplora l'accesso al contenuto nel set di dati
ReadWrite	string	Concede l'accesso in lettura e scrittura al contenuto nel set di dati
ReadWriteExplore	string	Concede l'accesso in lettura, scrittura ed esplora al contenuto nel set di dati
ReadWriteReshare	string	Concede l'accesso in lettura, scrittura e ricondividi al contenuto nel set di dati
ReadWriteReshareExplore	string	Concede lettura, scrittura, ricondividi e esplora l'accesso al contenuto nel set di dati

DefaultDatasetStorageFormat

Formato di archiviazione del set di dati predefinito nel gruppo

Nome	Tipo	Descrizione
Large	string	Formato di archiviazione del set di dati Large
Small	string	Formato di archiviazione di set di dati di piccole dimensioni

DependentDataflow

Flusso di dati dipendente da Power BI

Nome	Tipo	Descrizione
groupId	string	ID gruppo di destinazione
targetDataflowId	string	ID flusso di dati di destinazione

Encryption

Informazioni di crittografia per un set di dati

Nome	Tipo	Descrizione
EncryptionStatus	EncryptionStatus	Stato della crittografia dei set di dati

EncryptionStatus

Stato della crittografia dei set di dati

Nome	Tipo	Descrizione
InSyncWithWorkspace	string	La crittografia è supportata ed è sincronizzata con le impostazioni di crittografia
NotInSyncWithWorkspace	string	La crittografia è supportata ma non è sincronizzata con le impostazioni di crittografia
NotSupported	string	La crittografia non è supportata per questo set di dati
Unknown	string	Lo stato della crittografia è sconosciuto a causa del danneggiamento del set di dati

GroupType

Tipo di gruppo

Nome	Tipo	Descrizione
Group	string	Versione V1 dell'area di lavoro condivisa. Questo tipo di aree di lavoro verrà deprecato perché Microsoft esegue la migrazione di tutte le aree di lavoro alla versione più recente dell'area di lavoro condivisa
Personal	string	Tipo speciale di area di lavoro destinata all'elenco di SharePoint e all'integrazione di OneDrive
PersonalGroup	string	"Area di lavoro personale", nota anche come area di lavoro personale
Workspace	string	Area di lavoro condivisa o area di lavoro semplice usata per condividere contenuto con altri utenti dell'organizzazione

GroupUser

Un utente di Power BI con accesso all'area di lavoro

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità
emailAddress	string	Indirizzo di posta elettronica dell'utente
graphId	string	Identificatore dell'entità in Microsoft Graph. Disponibile solo per le API di amministrazione.
groupUserAccessRight	GroupUserAccessRight	Diritto di accesso (livello di autorizzazione) di un utente nell'area di lavoro
identifier	string	Identificatore dell'entità
principalType	PrincipalType	Tipo di entità
profile	ServicePrincipalProfile	Profilo principale servizio Power BI. Rilevante solo per Power BI Embedded soluzione multi-tenancy.
userType	string	Tipo di utente.

GroupUserAccessRight

Diritto di accesso (livello di autorizzazione) di un utente nell'area di lavoro

Nome	Tipo	Descrizione
Admin	string	Diritti di amministratore per il contenuto dell'area di lavoro
Contributor	string	Accesso in lettura ed esplorazione (ReadExplore) al contenuto dell'area di lavoro
Member	string	Diritti di accesso di lettura, ricondivisione ed esplorazione (ReadReshareExplore) al contenuto dell'area di lavoro
None	string	Nessun accesso al contenuto dell'area di lavoro
Viewer	string	Accesso di sola lettura (lettura) al contenuto dell'area di lavoro

PrincipalType

Tipo di entità

Nome	Tipo	Descrizione
App	string	Tipo di entità servizio
Group	string	Tipo di entità gruppo
None	string	Nessun tipo di entità. Usare per l'accesso a livello di intera organizzazione.
User	string	Tipo di entità utente

ReportUser

Voce di diritto di accesso utente di Power BI per un report

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità
emailAddress	string	Indirizzo di posta elettronica dell'utente
graphId	string	Identificatore dell'entità in Microsoft Graph. Disponibile solo per le API di amministrazione.
identifier	string	Identificatore dell'entità
principalType	PrincipalType	Tipo di entità
profile	ServicePrincipalProfile	Profilo principale servizio Power BI. Rilevante solo per Power BI Embedded soluzione multi-tenancy.
reportUserAccessRight	ReportUserAccessRight	Diritto di accesso a cui l'utente ha per il report (livello di autorizzazione)
userType	string	Tipo di utente.

ReportUserAccessRight

Diritto di accesso che l'utente ha per il report (livello di autorizzazione)

Nome	Tipo	Descrizione
None	string	Nessuna autorizzazione per il contenuto nel report
Owner	string	Concede l'accesso in lettura, scrittura e ricondividi al contenuto nel report
Read	string	Concede l'accesso in lettura al contenuto nel report
ReadCopy	string	Concede l'accesso in lettura e copia al contenuto nel report
ReadReshare	string	Concede l'accesso in lettura e ricondividi al contenuto nel report
ReadWrite	string	Concede l'accesso in lettura e scrittura al contenuto nel report

ServicePrincipalProfile

Profilo principale servizio Power BI. Rilevante solo per Power BI Embedded soluzione multi-tenancy.

Nome	Tipo	Descrizione
displayName	string	Nome del profilo dell'entità servizio
id	string	ID del profilo dell'entità servizio

Subscription

Sottoscrizione di posta elettronica per un elemento di Power BI (ad esempio un report o un dashboard)

Nome	Tipo	Descrizione
artifactDisplayName	string	Nome dell'elemento di Power BI sottoscritto , ad esempio un report o un dashboard.
artifactId	string	ID dell'elemento di Power BI sottoscritto (ad esempio un report o un dashboard)
artifactType	string	Tipo di elemento di Power BI ( ad esempio `Report`, `Dashboard`o `Dataset`)
attachmentFormat	string	Formato del report allegato nella sottoscrizione di posta elettronica
endDate	string	Data e ora di fine della sottoscrizione di posta elettronica
frequency	string	Frequenza della sottoscrizione di posta elettronica
id	string	ID sottoscrizione
isEnabled	boolean	Indica se la sottoscrizione di posta elettronica è abilitata
linkToContent	boolean	Indica se esiste un collegamento di sottoscrizione nella sottoscrizione di posta elettronica
previewImage	boolean	Indica se nella sottoscrizione di posta elettronica è presente uno screenshot del report
startDate	string	Data e ora di inizio della sottoscrizione di posta elettronica
subArtifactDisplayName	string	Nome della pagina dell'elemento di Power BI sottoscritto, se si tratta di un report.
title	string	Nome dell'app
users	SubscriptionUser[]	Dettagli di ogni sottoscrittore di posta elettronica. Quando si usa la chiamata api Get User Subscriptions As Amministrazione, il valore restituito è una matrice vuota (null). Questa proprietà verrà rimossa dalla risposta del payload in una versione futura. È possibile recuperare le informazioni sulla sottoscrizione in un report o un dashboard di Power BI usando get report subscriptions As Amministrazione (Ottieni sottoscrizioni report) o Get Dashboard Subscriptions As Amministrazione API calls (Ottieni sottoscrizioni report come Amministrazione chiamate API).

SubscriptionUser

Utente della sottoscrizione di posta elettronica di Power BI

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità
emailAddress	string	Indirizzo di posta elettronica dell'utente
graphId	string	Identificatore dell'entità in Microsoft Graph. Disponibile solo per le API di amministrazione.
identifier	string	Identificatore dell'entità
principalType	PrincipalType	Tipo principale
profile	ServicePrincipalProfile	Profilo entità servizio Power BI. Solo pertinente per Power BI Embedded soluzione multi-tenancy.
userType	string	Tipo dell'utente.

Workbook

Una cartella di lavoro di Power BI

Nome	Tipo	Descrizione
datasetId	string	ID del set di dati associato a una cartella di lavoro. Si applica solo se la cartella di lavoro ha un set di dati associato.
name	string	Nome della cartella di lavoro

Admin - Groups GetGroupsAsAdmin

Autorizzazioni

Ambito obbligatorio

Limitazioni

Parametri dell'URI

Risposte

Esempio

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

Definizioni

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

Risorse aggiuntive