Pipelines - Update Pipeline User

  • Referência
Service:
Power BI REST APIs
API Version:
v1.0

Concede permissões de usuário ao pipeline de implantação especificado.

Escopo Necessário

Pipeline.ReadWrite.All

POST https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}/users

Parâmetros de URI

Nome Em Obrigatório Tipo Description
pipelineId
 path True

string

uuid

A ID do pipeline de implantação

Corpo da solicitação

Nome Obrigatório Tipo Description
identifier True

string

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

PrincipalType

O tipo principal
accessRight

PipelineUserAccessRight

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

Respostas

Nome Tipo Description
200 OK

OK

Exemplos

Add a group to a deployment pipeline example
Add a service principal to a deployment pipeline example
Add a user to a deployment pipeline example

Add a group to a deployment pipeline example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/pipelines/8ce96c50-85a0-4db3-85c6-7ccc3ed46523/users
Request Body
{
  "identifier": "154aef10-47b8-48c4-ab97-f0bf9d5f8fcf",
  "accessRight": "Admin",
  "principalType": "Group"
}

Sample Response

Status code:
200

Add a service principal to a deployment pipeline example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/pipelines/8ce96c50-85a0-4db3-85c6-7ccc3ed46523/users
Request Body
{
  "identifier": "a35d842b-90d5-59a1-c56a-5f8fcff0bf9d",
  "accessRight": "Admin",
  "principalType": "App"
}

Sample Response

Status code:
200

Add a user to a deployment pipeline example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/pipelines/8ce96c50-85a0-4db3-85c6-7ccc3ed46523/users
Request Body
{
  "identifier": "john@contoso.com",
  "accessRight": "Admin",
  "principalType": "User"
}

Sample Response

Status code:
200

Definições

Nome Description
PipelineUser

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

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

O tipo principal

PipelineUser

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

Nome Tipo Description
accessRight

PipelineUserAccessRight

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

string

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

PrincipalType

O tipo principal

PipelineUserAccessRight

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

Nome Tipo Description
Admin

string

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

PrincipalType

O tipo principal

Nome Tipo Description
App

string

Tipo de entidade de serviço
Group

string

Tipo de entidade de grupo
None

string

Nenhum tipo de entidade de segurança. Use para acesso em nível de organização inteiro.
User

string

Tipo de entidade de usuário