Compartilhar via

Admin - Pipelines GetPipelinesAsAdmin

Serviço:
Power BI REST APIs
Versão da API:
v1.0

Retorna uma lista de pipelines de implantação para a organização.

Permissões

O usuário deve ter direitos de administrador ou autenticar usando uma entidade de serviço.

Escopo necessário

Tenant.Read.All ou Tenant.ReadWrite.All

Limitações

Máximo de 200 solicitações por hora. 

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
$expand
 query

string

Aceita uma lista separada por vírgulas de tipos de dados, que será expandida embutida na resposta. Oferece suporte para users e stages.
$filter
 query

string

Filtra os resultados com base em uma condição booliana. Essa API só dá suporte à filtragem para pipelines de implantação órfãos. Filtros sem suporte retornarão resultados não filtrados.
$skip
 query

integer (int32)

Ignora os primeiros n resultados. Use com a parte superior para buscar resultados além dos primeiros 5000.
$top
 query

integer (int32)

minimum: 1
maximum: 5000

Retorna apenas os primeiros n resultados. Esse parâmetro deve estar no intervalo de 1 a 5000.

Respostas

Nome Tipo Description
200 OK

AdminPipelines

OKEY

Exemplos

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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
AdminPipeline

Um pipeline do Power BI retornado por APIs de usuário
AdminPipelines

Wrapper de resposta OData para uma coleção de pipelines de implantação do Power BI
PipelineStage

Um estágio de pipeline de implantação do Power BI
PipelineUser

Uma entrada certa de acesso de usuário do Power BI para um pipeline de implantação
PipelineUserAccessRight

Obrigatório O direito de acesso que um usuário tem para o pipeline de implantação.
PrincipalType

O tipo principal

AdminPipeline

Objeto

Um pipeline do Power BI retornado por APIs de usuário

Nome Tipo Description
description

string

A descrição do pipeline de implantação
displayName

string

O nome de exibição do pipeline de implantação
id

string (uuid)

A ID do pipeline de implantação
stages

PipelineStage[]

A coleção de estágios de pipeline de implantação. Retornado somente quando $expand é definido como stages na solicitação.
users

PipelineUser[]

A coleção de usuários do pipeline de implantação. Retornado somente quando $expand é definido como users na solicitação.

AdminPipelines

Objeto

Wrapper de resposta OData para uma coleção de pipelines de implantação do Power BI

Nome Tipo Description
@odata.context

string

Contexto OData
value

AdminPipeline[]

A coleção de pipelines de implantação

PipelineStage

Objeto

Um estágio de pipeline de implantação do Power BI

Nome Tipo Description
order

integer

A ordem do estágio, começando a partir de zero.
workspaceId

string (uuid)

A ID do workspace atribuída. Aplicável somente quando houver um workspace atribuído.
workspaceName

string

O nome do workspace atribuído. Aplicável somente quando há um workspace atribuído e o usuário tem acesso ao workspace.

PipelineUser

Objeto

Uma entrada certa de acesso de usuário do Power BI para um pipeline de implantação

Nome Tipo Description
accessRight

PipelineUserAccessRight

Obrigatório O direito de acesso que um usuário tem para o pipeline de implantação.
identifier

string

Para Userde tipo principal, forneça o UPN. Caso contrário, forneça o de ID do objeto da entidade de segurança.
principalType

PrincipalType

O tipo principal

PipelineUserAccessRight

Enumeração

Obrigatório O direito de acesso que um usuário tem para o pipeline de implantação.

Valor Description
Admin

Concede direitos de administrador a um pipeline de implantação

PrincipalType

Enumeração

O tipo principal

Valor Description
None

Nenhum tipo de entidade de segurança. Use todo o acesso ao nível da organização.
User

Tipo de entidade de usuário
Group

Tipo de entidade de grupo
App

Tipo de entidade de serviço