Admin - Pipelines GetPipelinesAsAdmin

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

Devuelve una lista de canalizaciones de implementación para la organización.

Permisos

El usuario debe tener derechos de administrador o autenticarse mediante una entidad de servicio.

Ámbito requerido

Tenant.Read.All o Tenant.ReadWrite.All

Limitaciones

Máximo de 200 solicitudes por hora. 

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}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
$expand
 query

string

Acepta una lista separada por comas de tipos de datos, que se expandirán en línea en la respuesta. Admite users y stages.
$filter
 query

string

Filtra los resultados en función de una condición booleana. Esta API solo admite el filtrado de canalizaciones de implementación huérfanas. Los filtros no admitidos devolverán resultados sin filtrar.
$skip
 query

integer

int32

Omite los primeros n resultados. Use con top para capturar los resultados más allá de los primeros 5000.
$top
 query

integer

int32

Devuelve solo los primeros n resultados. Este parámetro debe estar en el intervalo de 1 a 5000.

Respuestas

Nombre Tipo Description
200 OK

AdminPipelines

Aceptar

Ejemplos

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

Definiciones

Nombre Description
AdminPipeline

Una canalización de Power BI devuelta por las API de usuario
AdminPipelines

Contenedor de respuesta de OData para una colección de canalizaciones de implementación de Power BI
PipelineStage

Una fase de canalización de implementación de Power BI
PipelineUser

Una entrada correcta de acceso de usuario de Power BI para una canalización de implementación
PipelineUserAccessRight

Necesario. El derecho de acceso que tiene un usuario para la canalización de implementación.
PrincipalType

Tipo de entidad de seguridad

AdminPipeline

Una canalización de Power BI devuelta por las API de usuario

Nombre Tipo Description
description

string

Descripción de la canalización de implementación
displayName

string

El nombre para mostrar de la canalización de implementación
id

string

Identificador de canalización de implementación
stages

PipelineStage[]

Colección de fases de canalización de implementación. Solo se devuelve cuando $expand se establece stages en en la solicitud.
users

PipelineUser[]

Colección de usuarios de canalización de implementación. Solo se devuelve cuando $expand se establece users en en la solicitud.

AdminPipelines

Contenedor de respuesta de OData para una colección de canalizaciones de implementación de Power BI

Nombre Tipo Description
odata.context

string

Contexto de OData
value

AdminPipeline[]

La colección de canalizaciones de implementación

PipelineStage

Una fase de canalización de implementación de Power BI

Nombre Tipo Description
order

integer

Orden de fase, a partir de cero.
workspaceId

string

Identificador del área de trabajo asignada. Solo es aplicable cuando hay un área de trabajo asignada.
workspaceName

string

Nombre del área de trabajo asignada. Solo es aplicable cuando hay un área de trabajo asignada y el usuario tiene acceso al área de trabajo.

PipelineUser

Una entrada correcta de acceso de usuario de Power BI para una canalización de implementación

Nombre Tipo Description
accessRight

PipelineUserAccessRight

Necesario. El derecho de acceso que tiene un usuario para la canalización de implementación.
identifier

string

Para el tipo Userde entidad de seguridad , proporcione el UPN. De lo contrario, proporcione el identificador de objeto de la entidad de seguridad.
principalType

PrincipalType

Tipo de entidad de seguridad

PipelineUserAccessRight

Necesario. El derecho de acceso que tiene un usuario para la canalización de implementación.

Nombre Tipo Description
Admin

string

Concede derechos de administrador a una canalización de implementación

PrincipalType

Tipo de entidad de seguridad

Nombre Tipo Description
App

string

Tipo de entidad de servicio
Group

string

Tipo de entidad de seguridad de grupo
None

string

No hay ningún tipo de entidad de seguridad. Use para el acceso de nivel de organización completo.
User

string

Tipo de entidad de seguridad de usuario