Share via

Admin - Pipelines GetPipelinesAsAdmin

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

조직의 배포 파이프라인 목록을 반환합니다.

사용 권한

사용자에게 관리자 권한이 있거나 서비스 주체를 사용하여 인증해야 합니다.

필수 범위

Tenant.Read.All 또는 Tenant.ReadWrite.All

제한 사항

시간당 최대 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}

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
$expand
 query

string

응답에서 인라인으로 확장되는 쉼표로 구분된 데이터 형식 목록을 허용합니다. 및 stages를 지원합니다users.
$filter
 query

string

부울 조건에 따라 결과를 필터링합니다. 이 API는 분리된 배포 파이프라인에 대한 필터링만 지원합니다. 지원되지 않는 필터는 필터링되지 않은 결과를 반환합니다.
$skip
 query

integer

int32

첫 번째 n개의 결과를 건너뜁니다. 맨 위와 함께 를 사용하여 처음 5000개 이후의 결과를 가져옵니다.
$top
 query

integer

int32

첫 번째 n 결과만 반환합니다. 이 매개 변수는 1-5000 범위여야 합니다.

응답

Name 형식 Description
200 OK

AdminPipelines

확인

예제

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

정의

Name Description
AdminPipeline

사용자 API에서 반환된 Power BI 파이프라인
AdminPipelines

Power BI 배포 파이프라인 컬렉션에 대한 OData 응답 래퍼
PipelineStage

Power BI 배포 파이프라인 단계
PipelineUser

배포 파이프라인에 대한 Power BI 사용자 액세스 권한 항목
PipelineUserAccessRight

필수 사항입니다. 배포 파이프라인에 대해 사용자가 사용할 수 있는 액세스 권한입니다.
PrincipalType

보안 주체 유형

AdminPipeline

사용자 API에서 반환된 Power BI 파이프라인

Name 형식 Description
description

string

배포 파이프라인 설명
displayName

string

배포 파이프라인 표시 이름
id

string

배포 파이프라인 ID
stages

PipelineStage[]

배포 파이프라인 단계의 컬렉션입니다. 요청에서 가 로 stages 설정된 경우에만 반환 $expand 됩니다.
users

PipelineUser[]

배포 파이프라인 사용자의 컬렉션입니다. 요청에서 가 로 users 설정된 경우에만 반환 $expand 됩니다.

AdminPipelines

Power BI 배포 파이프라인 컬렉션에 대한 OData 응답 래퍼

Name 형식 Description
odata.context

string

OData 컨텍스트
value

AdminPipeline[]

배포 파이프라인 컬렉션

PipelineStage

Power BI 배포 파이프라인 단계

Name 형식 Description
order

integer

0부터 시작하는 스테이지 순서입니다.
workspaceId

string

할당된 작업 영역 ID입니다. 할당된 작업 영역이 있는 경우에만 적용됩니다.
workspaceName

string

할당된 작업 영역 이름입니다. 할당된 작업 영역이 있고 사용자가 작업 영역에 액세스할 수 있는 경우에만 적용됩니다.

PipelineUser

배포 파이프라인에 대한 Power BI 사용자 액세스 권한 항목

Name 형식 Description
accessRight

PipelineUserAccessRight

필수 사항입니다. 배포 파이프라인에 대해 사용자가 사용할 수 있는 액세스 권한입니다.
identifier

string

보안 주체 형식 User의 경우 UPN을 제공합니다. 그렇지 않으면 보안 주체의 개체 ID 를 제공합니다.
principalType

PrincipalType

보안 주체 유형

PipelineUserAccessRight

필수 사항입니다. 배포 파이프라인에 대해 사용자가 사용할 수 있는 액세스 권한입니다.

Name 형식 Description
Admin

string

배포 파이프라인에 관리자 권한 부여

PrincipalType

보안 주체 유형

Name 형식 Description
App

string

서비스 주체 유형
Group

string

그룹 보안 주체 유형
None

string

보안 주체 유형이 없습니다. 전체 조직 수준 액세스에 사용합니다.
User

string

사용자 계정 유형