Freigeben über

Admin - Pipelines GetPipelinesAsAdmin

Dienst:
Power BI REST APIs
API-Version:
v1.0

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

Erlaubnisse

Der Benutzer muss über Administratorrechte verfügen oder sich mit einem Dienstprinzipal 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
Mit optionalen Parametern: 
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 inline in der Antwort 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. Wird mit oben verwendet, um Ergebnisse über die ersten 5000 abzurufen.
$top
 query

integer (int32)

minimum: 1
maximum: 5000

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

Antworten

Name Typ Beschreibung
200 OK

AdminPipelines

OKAY

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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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-Antwortwrapper für eine Sammlung von Power BI-Bereitstellungspipelines
PipelineStage

Eine Power BI-Bereitstellungspipelinephase
PipelineUser

Ein Power BI-Benutzerzugriffsrecht für eine Bereitstellungspipeline
PipelineUserAccessRight

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

Der Prinzipaltyp

AdminPipeline

Objekt

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

Name Typ Beschreibung
description

string

Beschreibung der Bereitstellungspipeline
displayName

string

Anzeigename der Bereitstellungspipeline
id

string (uuid)

Die Bereitstellungspipeline-ID
stages

PipelineStage[]

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

PipelineUser[]

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

AdminPipelines

Objekt

OData-Antwortwrapper für eine Sammlung von Power BI-Bereitstellungspipelines

Name Typ Beschreibung
@odata.context

string

OData-Kontext
value

AdminPipeline[]

Die Sammlung von Bereitstellungspipelines

PipelineStage

Objekt

Eine Power BI-Bereitstellungspipelinephase

Name Typ Beschreibung
order

integer

Die Phasenreihenfolge beginnend mit Null.
workspaceId

string (uuid)

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

Objekt

Ein Power BI-Benutzerzugriffsrecht 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. Stellen Sie andernfalls die Objekt-ID des Prinzipals bereit.
principalType

PrincipalType

Der Prinzipaltyp

PipelineUserAccessRight

Enumeration

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

Wert Beschreibung
Admin

Gewährt Administratorrechten für eine Bereitstellungspipeline

PrincipalType

Enumeration

Der Prinzipaltyp

Wert Beschreibung
None

Kein Prinzipaltyp. Wird für den Zugriff auf ganze Organisationsebene verwendet.
User

Benutzerprinzipaltyp
Group

Gruppenprinzipaltyp
App

Dienstprinzipaltyp