Share via

Admin - Pipelines GetPipelinesAsAdmin

  • Odwołanie
Service:
Power BI REST APIs
API Version:
v1.0

Zwraca listę potoków wdrażania dla organizacji.

Uprawnienia

Użytkownik musi mieć uprawnienia administratora lub uwierzytelnić się przy użyciu jednostki usługi.

Zakres wymagany

Tenant.Read.All lub Tenant.ReadWrite.All

Ograniczenia

Maksymalna liczba żądań na godzinę wynosi 200. 

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}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
$expand
 query

string

Akceptuje rozdzielaną przecinkami listę typów danych, które zostaną rozwinięte w tekście w odpowiedzi. Obsługuje funkcje users i stages.
$filter
 query

string

Filtruje wyniki na podstawie warunku logicznego. Ten interfejs API obsługuje tylko filtrowanie dla oddzielonych potoków wdrażania. Nieobsługiwane filtry będą zwracać niefiltrowane wyniki.
$skip
 query

integer

int32

Pomija pierwsze n wyników. Użyj funkcji z góry, aby pobrać wyniki poza pierwsze 5000.
$top
 query

integer

int32

Zwraca tylko pierwsze n wyników. Ten parametr musi należeć do zakresu od 1 do 5000.

Odpowiedzi

Nazwa Typ Opis
200 OK

AdminPipelines

OK

Przykłady

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

Definicje

Nazwa Opis
AdminPipeline

Potok usługi Power BI zwracany przez interfejsy API użytkownika
AdminPipelines

Otoka odpowiedzi OData dla kolekcji potoków wdrażania usługi Power BI
PipelineStage

Etap potoku wdrażania usługi Power BI
PipelineUser

Wpis prawa dostępu użytkownika usługi Power BI dla potoku wdrażania
PipelineUserAccessRight

Wymagane. Prawo dostępu użytkownika dla potoku wdrażania.
PrincipalType

Typ podmiotu zabezpieczeń

AdminPipeline

Potok usługi Power BI zwracany przez interfejsy API użytkownika

Nazwa Typ Opis
description

string

Opis potoku wdrażania
displayName

string

Nazwa wyświetlana potoku wdrażania
id

string

Identyfikator potoku wdrażania
stages

PipelineStage[]

Kolekcja etapów potoku wdrażania. Zwracane tylko wtedy, gdy $expand jest ustawiona na stages wartość w żądaniu.
users

PipelineUser[]

Kolekcja użytkowników potoku wdrażania. Zwracane tylko wtedy, gdy $expand jest ustawiona na users wartość w żądaniu.

AdminPipelines

Otoka odpowiedzi OData dla kolekcji potoków wdrażania usługi Power BI

Nazwa Typ Opis
odata.context

string

Kontekst OData
value

AdminPipeline[]

Kolekcja potoków wdrażania

PipelineStage

Etap potoku wdrażania usługi Power BI

Nazwa Typ Opis
order

integer

Kolejność etapu, począwszy od zera.
workspaceId

string

Identyfikator przypisanego obszaru roboczego. Ma zastosowanie tylko wtedy, gdy istnieje przypisany obszar roboczy.
workspaceName

string

Przypisana nazwa obszaru roboczego. Ma zastosowanie tylko wtedy, gdy istnieje przypisany obszar roboczy, a użytkownik ma dostęp do obszaru roboczego.

PipelineUser

Wpis prawa dostępu użytkownika usługi Power BI dla potoku wdrażania

Nazwa Typ Opis
accessRight

PipelineUserAccessRight

Wymagane. Prawo dostępu użytkownika dla potoku wdrażania.
identifier

string

W przypadku typu podmiotu Userzabezpieczeń podaj nazwę UPN. W przeciwnym razie podaj identyfikator obiektu podmiotu zabezpieczeń.
principalType

PrincipalType

Typ podmiotu zabezpieczeń

PipelineUserAccessRight

Wymagane. Prawo dostępu użytkownika dla potoku wdrażania.

Nazwa Typ Opis
Admin

string

Przyznaje uprawnienia administratora do potoku wdrażania

PrincipalType

Typ podmiotu zabezpieczeń

Nazwa Typ Opis
App

string

Typ jednostki usługi
Group

string

Typ podmiotu zabezpieczeń grupy
None

string

Brak typu podmiotu zabezpieczeń. Służy do uzyskiwania dostępu na poziomie całej organizacji.
User

string

Typ podmiotu zabezpieczeń użytkownika