通过

Deployment Pipelines - Add Deployment Pipeline Role Assignment

服务:
Core
API 版本:
v1

添加部署管道角色分配。

权限

调用方必须具有 管理员 部署管道角色。

所需的委派范围

Pipeline.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份 支持
用户 是的
服务主体 和 托管标识 是的

接口

POST https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}/roleAssignments

URI 参数

名称 在 必需 类型 说明
deploymentPipelineId
 path True

string (uuid)

部署管道 ID。

请求正文

名称 必需 类型 说明
principal True

Principal

主体。
role True

DeploymentPipelineRole

主体的部署管道角色。

响应

名称 类型 说明
200 OK

DeploymentPipelineRoleAssignment

请求成功完成。
Other Status Codes

ErrorResponse

常见错误代码：

  • UnknownError - 发生错误

示例

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

Add a group role assignment to a deployment pipeline example

示例请求

POST https://api.fabric.microsoft.com/v1/deploymentPipelines/8ce96c50-85a0-4db3-85c6-7ccc3ed46523/roleAssignments

{
  "principal": {
    "id": "154aef10-47b8-48c4-ab97-f0bf9d5f8fcf",
    "type": "Group"
  },
  "role": "Admin"
}

示例响应

状态代码:
200 
{
  "id": "154aef10-47b8-48c4-ab97-f0bf9d5f8fcf",
  "principal": {
    "id": "154aef10-47b8-48c4-ab97-f0bf9d5f8fcf",
    "type": "Group"
  },
  "role": "Admin"
}

Add a service principal role assignment to a deployment pipeline example

示例请求

POST https://api.fabric.microsoft.com/v1/deploymentPipelines/8ce96c50-85a0-4db3-85c6-7ccc3ed46523/roleAssignments

{
  "principal": {
    "id": "a35d842b-90d5-59a1-c56a-5f8fcff0bf9d",
    "type": "ServicePrincipal"
  },
  "role": "Admin"
}

示例响应

状态代码:
200 
{
  "id": "a35d842b-90d5-59a1-c56a-5f8fcff0bf9d",
  "principal": {
    "id": "a35d842b-90d5-59a1-c56a-5f8fcff0bf9d",
    "type": "ServicePrincipal"
  },
  "role": "Admin"
}

Add a user role assignment to a deployment pipeline example

示例请求

POST https://api.fabric.microsoft.com/v1/deploymentPipelines/8ce96c50-85a0-4db3-85c6-7ccc3ed46523/roleAssignments

{
  "principal": {
    "id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
    "type": "User"
  },
  "role": "Admin"
}

示例响应

状态代码:
200 
{
  "id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
  "principal": {
    "id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
    "type": "User"
  },
  "role": "Admin"
}

定义

名称 说明
AddDeploymentPipelineRoleAssignmentRequest

添加部署管道角色分配请求有效负载。
DeploymentPipelineRole

部署管道角色。 可能会随着时间的推移添加其他部署管道角色。
DeploymentPipelineRoleAssignment

部署管道的 Fabric 主体角色分配。
ErrorRelatedResource

与错误相关的资源详细信息对象。
ErrorResponse

错误响应。
ErrorResponseDetails

错误响应详细信息。
GroupDetails

组特定详细信息。 当主体类型 Group时适用。
GroupType

组的类型。 可能会随着时间的推移添加其他组类型。
Principal

表示标识或Microsoft Entra 组。
PrincipalType

主体的类型。 可能会随着时间的推移添加其他主体类型。
ServicePrincipalDetails

服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。
ServicePrincipalProfileDetails

服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。
UserDetails

用户主体特定详细信息。 当主体类型 User时适用。

AddDeploymentPipelineRoleAssignmentRequest

Object

添加部署管道角色分配请求有效负载。

名称 类型 说明
principal

Principal

主体。
role

DeploymentPipelineRole

主体的部署管道角色。

DeploymentPipelineRole

枚举

部署管道角色。 可能会随着时间的推移添加其他部署管道角色。

值 说明
Admin

启用对部署管道的管理访问权限。

DeploymentPipelineRoleAssignment

Object

部署管道的 Fabric 主体角色分配。

名称 类型 说明
id

string (uuid)

部署管道角色分配 ID。
principal

Principal

主体。
role

DeploymentPipelineRole

主体的部署管道角色。

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称 类型 说明
resourceId

string

错误中涉及的资源 ID。
resourceType

string

错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
moreDetails

ErrorResponseDetails[]

其他错误详细信息的列表。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。
requestId

string

与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。

GroupDetails

Object

组特定详细信息。 当主体类型 Group时适用。

名称 类型 说明
groupType

GroupType

组的类型。 可能会随着时间的推移添加其他组类型。

GroupType

枚举

组的类型。 可能会随着时间的推移添加其他组类型。

值 说明
Unknown

主体组类型未知。
SecurityGroup

主体是安全组。
DistributionList

主体是通讯组列表。

Principal

Object

表示标识或Microsoft Entra 组。

名称 类型 说明
displayName

string

主体的显示名称。
groupDetails

GroupDetails

组特定详细信息。 当主体类型 Group时适用。
id

string (uuid)

主体的 ID。
servicePrincipalDetails

ServicePrincipalDetails

服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。
type

PrincipalType

主体的类型。 可能会随着时间的推移添加其他主体类型。
userDetails

UserDetails

用户主体特定详细信息。 当主体类型 User时适用。

PrincipalType

枚举

主体的类型。 可能会随着时间的推移添加其他主体类型。

值 说明
User

主体是Microsoft Entra 用户主体。
ServicePrincipal

主体是Microsoft Entra 服务主体。
Group

主体是安全组。
ServicePrincipalProfile

主体是服务主体配置文件。
EntireTenant

主体表示所有租户用户。

ServicePrincipalDetails

Object

服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。

名称 类型 说明
aadAppId

string (uuid)

服务主体的 Microsoft Entra AppId。

ServicePrincipalProfileDetails

Object

服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。

名称 类型 说明
parentPrincipal

Principal

服务主体配置文件的父主体。

UserDetails

Object

用户主体特定详细信息。 当主体类型 User时适用。

名称 类型 说明
userPrincipalName

string

用户主体名称。