Condividi tramite

Admin - Pipelines GetPipelinesAsAdmin

  • Riferimento
Service:
Power BI REST APIs
API Version:
v1.0

Restituisce un elenco di pipeline di distribuzione per l'organizzazione.

Autorizzazioni

L'utente deve avere diritti di amministratore o autenticare usando un'entità servizio.

Ambito obbligatorio

Tenant.Read.All o Tenant.ReadWrite.All

Limitazioni

Massimo 200 richieste all'ora. 

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
$expand
 query

string

Accetta un elenco delimitato da virgole dei tipi di dati, che verrà espanso inline nella risposta. Supporta users e stages.
$filter
 query

string

Filtra i risultati in base a una condizione booleana. Questa API supporta solo il filtro per le pipeline di distribuzione orfane. I filtri non supportati restituiranno risultati non filtrati.
$skip
 query

integer

int32

Ignora i primi n risultati. Usare con la parte superiore per recuperare i risultati oltre i primi 5000.
$top
 query

integer

int32

Restituisce solo i primi n risultati. Questo parametro deve trovarsi nell'intervallo di 1-5000.

Risposte

Nome Tipo Descrizione
200 OK

AdminPipelines

OK

Esempio

Get deployment pipelines example
Get deployment pipelines with their 'stages' expanded example
Get deployment pipelines with their 'users' expanded example
Get orphaned deployment pipelines example

Get deployment pipelines example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage marketing reports"
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "displayName": "Financing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage financing reports"
    }
  ]
}

Get deployment pipelines with their 'stages' expanded example

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage marketing reports",
      "stages": [
        {
          "order": "0",
          "workspaceId": "5dba60b0-d9a7-42a3-b12c-6d9d51e7739a",
          "workspaceName": "SQlAzure-Refresh"
        },
        {
          "order": "1",
          "workspaceId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523",
          "workspaceName": "SQlAzure-Refresh[Test]"
        },
        {
          "order": "2"
        }
      ]
    }
  ]
}

Get deployment pipelines with their 'users' expanded example

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage marketing reports",
      "users": [
        {
          "identifier": "john@contoso.com",
          "accessRight": "Admin",
          "principalType": "User"
        },
        {
          "identifier": "154aef10-47b8-48c4-ab97-f0bf9d5f8fcf",
          "accessRight": "Admin",
          "principalType": "Group"
        },
        {
          "identifier": "a35d842b-90d5-59a1-c56a-5f8fcff0bf9d",
          "accessRight": "Admin",
          "principalType": "App"
        }
      ]
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "displayName": "Financing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage financing reports",
      "users": []
    }
  ]
}

Get orphaned deployment pipelines example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines?$expand=users&$filter=(not users/any())&$top=100

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "displayName": "Financing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage financing reports",
      "users": []
    }
  ]
}

Definizioni

Nome Descrizione
AdminPipeline

Una pipeline di Power BI restituita dalle API utente
AdminPipelines

Wrapper di risposta OData per una raccolta di pipeline di distribuzione di Power BI
PipelineStage

Fase della pipeline di distribuzione di Power BI
PipelineUser

Voce a destra dell'accesso utente di Power BI per una pipeline di distribuzione
PipelineUserAccessRight

Obbligatorio. Il diritto di accesso di un utente ha per la pipeline di distribuzione.
PrincipalType

Tipo principale

AdminPipeline

Una pipeline di Power BI restituita dalle API utente

Nome Tipo Descrizione
description

string

Descrizione della pipeline di distribuzione
displayName

string

Nome visualizzato della pipeline di distribuzione
id

string

ID della pipeline di distribuzione
stages

PipelineStage[]

Raccolta di fasi della pipeline di distribuzione. Restituito solo quando $expand è impostato su stages nella richiesta.
users

PipelineUser[]

Raccolta di utenti della pipeline di distribuzione. Restituito solo quando $expand è impostato su users nella richiesta.

AdminPipelines

Wrapper di risposta OData per una raccolta di pipeline di distribuzione di Power BI

Nome Tipo Descrizione
odata.context

string

Contesto OData
value

AdminPipeline[]

Raccolta di pipeline di distribuzione

PipelineStage

Fase della pipeline di distribuzione di Power BI

Nome Tipo Descrizione
order

integer

Ordine di fase, a partire da zero.
workspaceId

string

ID area di lavoro assegnata. Applicabile solo quando è presente un'area di lavoro assegnata.
workspaceName

string

Nome dell'area di lavoro assegnato. Applicabile solo quando è presente un'area di lavoro assegnata e l'utente ha accesso all'area di lavoro.

PipelineUser

Voce a destra dell'accesso utente di Power BI per una pipeline di distribuzione

Nome Tipo Descrizione
accessRight

PipelineUserAccessRight

Obbligatorio. Il diritto di accesso di un utente ha per la pipeline di distribuzione.
identifier

string

Per il tipo principale User, specificare l'UPN. In caso contrario, specificare l'ID oggetto dell'entità.
principalType

PrincipalType

Tipo principale

PipelineUserAccessRight

Obbligatorio. Il diritto di accesso di un utente ha per la pipeline di distribuzione.

Nome Tipo Descrizione
Admin

string

Concede diritti di amministratore a una pipeline di distribuzione

PrincipalType

Tipo principale

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 organizzazione intero.
User

string

Tipo di entità utente