Admin - Pipelines GetPipelinesAsAdmin

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

Gibt eine Liste der Bereitstellungspipelines für die Organisation zurück.

Berechtigungen

Der Benutzer muss über Administratorrechte verfügen oder sich mithilfe eines Dienstprinzipals authentifizieren.

Erforderlicher Bereich

Tenant.Read.All oder Tenant.ReadWrite.All

Einschränkungen

Maximal 200 Anforderungen pro Stunde. 

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}

URI-Parameter

Name In Erforderlich Typ Beschreibung
$expand
 query

string

Akzeptiert eine durch Trennzeichen getrennte Liste von Datentypen, die in der Antwort inline erweitert wird. Unterstützt users und stages.
$filter
 query

string

Filtert die Ergebnisse basierend auf einer booleschen Bedingung. Diese API unterstützt nur das Filtern nach verwaisten Bereitstellungspipelines. Nicht unterstützte Filter geben ungefilterte Ergebnisse zurück.
$skip
 query

integer

int32

Überspringt die ersten n-Ergebnisse. Verwenden Sie mit top, um Ergebnisse ab den ersten 5000 abzurufen.
$top
 query

integer

int32

Gibt nur die ersten n-Ergebnisse zurück. Dieser Parameter muss im Bereich von 1 bis 5000 liegen.

Antworten

Name Typ Beschreibung
200 OK

AdminPipelines

OK

Beispiele

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

Definitionen

Name Beschreibung
AdminPipeline

Eine von Benutzer-APIs zurückgegebene Power BI-Pipeline
AdminPipelines

OData-Antwort-Wrapper für eine Sammlung von Power BI-Bereitstellungspipelines
PipelineStage

Eine Power BI-Bereitstellungspipelinephase
PipelineUser

Ein Power BI-Benutzerzugriffsrechteintrag für eine Bereitstellungspipeline
PipelineUserAccessRight

Erforderlich. Das Zugriffsrecht, das ein Benutzer für die Bereitstellungspipeline hat.
PrincipalType

Der Prinzipaltyp

AdminPipeline

Eine von Benutzer-APIs zurückgegebene Power BI-Pipeline

Name Typ Beschreibung
description

string

Beschreibung der Bereitstellungspipeline
displayName

string

Anzeigename der Bereitstellungspipeline
id

string

Die Bereitstellungspipeline-ID
stages

PipelineStage[]

Die Auflistung der Bereitstellungspipelinephasen. Wird nur zurückgegeben, wenn $expand in der Anforderung auf stages festgelegt ist.
users

PipelineUser[]

Die Sammlung der Benutzer der Bereitstellungspipeline. Wird nur zurückgegeben, wenn $expand in der Anforderung auf users festgelegt ist.

AdminPipelines

OData-Antwort-Wrapper für eine Sammlung von Power BI-Bereitstellungspipelines

Name Typ Beschreibung
odata.context

string

OData-Kontext
value

AdminPipeline[]

Die Sammlung von Bereitstellungspipelines

PipelineStage

Eine Power BI-Bereitstellungspipelinephase

Name Typ Beschreibung
order

integer

Die Phasenreihenfolge, beginnend bei 0.
workspaceId

string

Die zugewiesene Arbeitsbereichs-ID. Gilt nur, wenn ein zugewiesener Arbeitsbereich vorhanden ist.
workspaceName

string

Der zugewiesene Arbeitsbereichsname. Gilt nur, wenn ein zugewiesener Arbeitsbereich vorhanden ist und der Benutzer Zugriff auf den Arbeitsbereich hat.

PipelineUser

Ein Power BI-Benutzerzugriffsrechteintrag für eine Bereitstellungspipeline

Name Typ Beschreibung
accessRight

PipelineUserAccessRight

Erforderlich. Das Zugriffsrecht, das ein Benutzer für die Bereitstellungspipeline hat.
identifier

string

Geben Sie für den Prinzipaltyp Userden UPN an. Geben Sie andernfalls die Objekt-ID des Prinzipals an.
principalType

PrincipalType

Der Prinzipaltyp

PipelineUserAccessRight

Erforderlich. Das Zugriffsrecht, das ein Benutzer für die Bereitstellungspipeline hat.

Name Typ Beschreibung
Admin

string

Zuweisung von Administratorrechten für eine Bereitstellungspipeline

PrincipalType

Der Prinzipaltyp

Name Typ Beschreibung
App

string

Dienstprinzipaltyp
Group

string

Gruppenprinzipaltyp
None

string

Kein Prinzipaltyp. Verwenden Sie dies für den gesamten Zugriff auf Organisationsebene.
User

string

Benutzerprinzipaltyp