Admin - Pipelines GetPipelinesAsAdmin

Returns a list of deployment pipelines for the organization.

Permissions

The user must have administrator rights or authenticate using a service principal.

Required Scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

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

URI Parameters

Name In Required Type Description
$expand
query
  • string

Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports users and stages.

$filter
query
  • string

Filters the results based on a boolean condition.

$skip
query
  • integer
int32

Skips the first n results. Use with top to fetch results beyond the first 5000.

$top
query
  • integer
int32

Returns only the first n results. This parameter must be in the range of 1-5000.

Responses

Name Type Description
200 OK

OK

Examples

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

{
  "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

{
  "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

{
  "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

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

Definitions

AdminPipeline

A Power BI pipeline returned by user APIs

AdminPipelines

OData response wrapper for a collection of Power BI deployment pipelines

PipelineStage

A Power BI deployment pipeline stage

PipelineUser

A Power BI user access right entry for a deployment pipeline

PipelineUserAccessRight

Required. The access right a user has for the deployment pipeline.

PrincipalType

The principal type

AdminPipeline

A Power BI pipeline returned by user APIs

Name Type Description
description
  • string

The deployment pipeline description

displayName
  • string

The deployment pipeline display name

id
  • string

The deployment pipeline ID

stages

The collection of deployment pipeline stages. Only returned when $expand is set to stages in the request.

users

The collection of deployment pipeline users. Only returned when $expand is set to users in the request.

AdminPipelines

OData response wrapper for a collection of Power BI deployment pipelines

Name Type Description
odata.context
  • string

OData context

value

The collection of deployment pipelines

PipelineStage

A Power BI deployment pipeline stage

Name Type Description
order
  • integer

The stage order, starting from zero.

workspaceId
  • string

The assigned workspace ID. Only applicable when there's an assigned workspace.

workspaceName
  • string

The assigned workspace name. Only applicable when there's an assigned workspace and the user has access to the workspace.

PipelineUser

A Power BI user access right entry for a deployment pipeline

Name Type Description
accessRight

Required. The access right a user has for the deployment pipeline.

identifier
  • string

For principal type User, provide the UPN. Otherwise provide the object ID of the principal.

principalType

The principal type

PipelineUserAccessRight

Required. The access right a user has for the deployment pipeline.

Name Type Description
Admin
  • string

Grants administrator rights to a deployment pipeline

PrincipalType

The principal type

Name Type Description
App
  • string

Service principal type

Group
  • string

Group principal type

None
  • string

No principal type. Use for whole organization level access.

User
  • string

User principal type