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

Имя	В	Тип	Описание
$expand	query	string	Принимает разделенный запятыми список типов данных, который будет развернут в ответе. Поддерживает `users` и `stages`.
$filter	query	string	Фильтрует результаты по логическому условию. Этот API поддерживает фильтрацию только для потерянных конвейеров развертывания. Неподдерживаемые фильтры будут возвращать неотфильтрованные результаты.
$skip	query	integer int32	Пропускает первые n результатов. Используйте с top, чтобы получить результаты за пределами первых 5000.
$top	query	integer int32	Возвращает только первые n результатов. Этот параметр должен находиться в диапазоне от 1 до 5000.

Ответы

Имя	Тип	Описание
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": []
    }
  ]
}

Определения

Имя	Описание
AdminPipeline	Конвейер Power BI, возвращаемый пользовательскими API
AdminPipelines	Оболочка ответа OData для коллекции конвейеров развертывания Power BI
PipelineStage	Этап конвейера развертывания Power BI
PipelineUser	Запись права доступа пользователя Power BI для конвейера развертывания
PipelineUserAccessRight	Обязательный. Право доступа, которое пользователь имеет для конвейера развертывания.
PrincipalType	Тип участника

AdminPipeline

Конвейер Power BI, возвращаемый пользовательскими API

Имя	Тип	Описание
description	string	Описание конвейера развертывания
displayName	string	Отображаемое имя конвейера развертывания
id	string	Идентификатор конвейера развертывания
stages	PipelineStage[]	Коллекция этапов конвейера развертывания. Возвращается только в том случае, если `$expand` для задано значение `stages` в запросе.
users	PipelineUser[]	Коллекция пользователей конвейера развертывания. Возвращается только в том случае, если `$expand` для задано значение `users` в запросе.

AdminPipelines

Оболочка ответа OData для коллекции конвейеров развертывания Power BI

Имя	Тип	Описание
odata.context	string	Контекст OData
value	AdminPipeline[]	Коллекция конвейеров развертывания

PipelineStage

Этап конвейера развертывания Power BI

Имя	Тип	Описание
order	integer	Порядок этапов, начиная с нуля.
workspaceId	string	Идентификатор назначенной рабочей области. Применимо только при наличии назначенной рабочей области.
workspaceName	string	Имя назначенной рабочей области. Применимо только при наличии назначенной рабочей области и у пользователя есть доступ к ней.

PipelineUser

Запись права доступа пользователя Power BI для конвейера развертывания

Имя	Тип	Описание
accessRight	PipelineUserAccessRight	Обязательный. Право доступа, которое пользователь имеет для конвейера развертывания.
identifier	string	Для типа `User`субъекта укажите имя участника-пользователя. В противном случае укажите идентификатор объекта субъекта.
principalType	PrincipalType	Тип участника

PipelineUserAccessRight

Обязательный. Право доступа, которое пользователь имеет для конвейера развертывания.

Имя	Тип	Описание
Admin	string	Предоставляет права администратора конвейеру развертывания

PrincipalType

Тип участника

Имя	Тип	Описание
App	string	Тип субъекта-службы
Group	string	Тип участника группы
None	string	Нет типа субъекта. Используйте для доступа на уровне всей организации.
User	string	Тип участника-пользователя

Поделиться через

Admin - Pipelines GetPipelinesAsAdmin

Разрешения

Требуемая область

Ограничения

Параметры URI

Ответы

Примеры

Get deployment pipelines example

Sample Request

Sample Response

Get deployment pipelines with their 'stages' expanded example

Sample Request

Sample Response

Get deployment pipelines with their 'users' expanded example

Sample Request

Sample Response

Get orphaned deployment pipelines example

Sample Request

Sample Response

Определения

AdminPipeline

AdminPipelines

PipelineStage

PipelineUser

PipelineUserAccessRight

PrincipalType

Дополнительные ресурсы