Sdílet prostřednictvím

Admin - Pipelines GetPipelinesAsAdmin

  • Reference
Služba:
Power BI REST APIs
Verze rozhraní API:
v1.0

Vrátí seznam kanálů nasazení pro organizaci.

Oprávnění

Uživatel musí mít práva správce nebo se musí ověřit pomocí instančního objektu.

Požadovaný obor

Tenant.Read.All nebo Tenant.ReadWrite.All

Omezení

Maximálně 200 požadavků za hodinu. 

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines
S volitelnými parametry: 
GET https://api.powerbi.com/v1.0/myorg/admin/pipelines?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
$expand
 query

string

Přijímá seznam datových typů oddělených čárkami, který se v odpovědi rozbalí. Podporuje users a stages.
$filter
 query

string

Filtruje výsledky na základě logické podmínky. Toto rozhraní API podporuje pouze filtrování osamocených kanálů nasazení. Nepodporované filtry vrátí nefiltrované výsledky.
$skip
 query

integer

int32

Přeskočí prvních n výsledků. Pokud chcete načíst výsledky nad rámec prvních 5000, použijte s horní.
$top
 query

integer

int32

Vrátí pouze prvních n výsledků. Tento parametr musí být v rozsahu 1–5000.

Odpovědi

Name Typ Description
200 OK

AdminPipelines

OK

Příklady

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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
AdminPipeline

Kanál Power BI vrácený uživatelskými rozhraními API
AdminPipelines

Obálka odpovědí OData pro kolekci kanálů nasazení Power BI
PipelineStage

Fáze kanálu nasazení Power BI
PipelineUser

Položka přístupového práva uživatele Power BI pro kanál nasazení
PipelineUserAccessRight

Povinná hodnota. Přístupové právo, které má uživatel pro kanál nasazení.
PrincipalType

Typ objektu zabezpečení

AdminPipeline

Kanál Power BI vrácený uživatelskými rozhraními API

Name Typ Description
description

string

Popis kanálu nasazení
displayName

string

Zobrazovaný název kanálu nasazení
id

string

ID kanálu nasazení
stages

PipelineStage[]

Kolekce fází kanálu nasazení Vráceno pouze při $expand nastavení na hodnotu stages v požadavku.
users

PipelineUser[]

Kolekce uživatelů kanálu nasazení. Vráceno pouze při $expand nastavení na hodnotu users v požadavku.

AdminPipelines

Obálka odpovědí OData pro kolekci kanálů nasazení Power BI

Name Typ Description
@odata.context

string

Kontext OData
value

AdminPipeline[]

Kolekce kanálů nasazení

PipelineStage

Fáze kanálu nasazení Power BI

Name Typ Description
order

integer

Pořadí fází od nuly
workspaceId

string

ID přiřazeného pracovního prostoru. Platí jenom v případě, že je k dispozici přiřazený pracovní prostor.
workspaceName

string

Název přiřazeného pracovního prostoru. Platí jenom v případě, že je k dispozici přiřazený pracovní prostor a uživatel má k pracovnímu prostoru přístup.

PipelineUser

Položka přístupového práva uživatele Power BI pro kanál nasazení

Name Typ Description
accessRight

PipelineUserAccessRight

Povinná hodnota. Přístupové právo, které má uživatel pro kanál nasazení.
identifier

string

Jako typ Userobjektu zabezpečení zadejte hlavní název uživatele (UPN). V opačném případě zadejte ID objektu zabezpečení.
principalType

PrincipalType

Typ objektu zabezpečení

PipelineUserAccessRight

Povinná hodnota. Přístupové právo, které má uživatel pro kanál nasazení.

Name Typ Description
Admin

string

Uděluje oprávnění správce ke kanálu nasazení.

PrincipalType

Typ objektu zabezpečení

Name Typ Description
App

string

Typ instančního objektu
Group

string

Typ objektu zabezpečení skupiny
None

string

Žádný typ objektu zabezpečení. Používá se pro přístup na úrovni celé organizace.
User

string

Typ objektu zabezpečení uživatele