Items - Associate Identity (beta)

服务:: Core

API 版本:: v1

将默认标识与项相关联。

注释

此 API 是 Beta 版的一部分，仅用于评估和开发目的。它可能会根据反馈进行更改，不建议将其用于生产。 调用此 API 时，调用方必须指定 true 为查询参数 beta的值。

此 API 支持长时间运行的作（LRO）。

许多项类型都支持此 API，可在项管理概述中找到支持的项类型和有关其定义结构的信息。

权限

调用方必须具有项的 读取和写入 权限。

所需的委派范围

对于项 API，请使用以下范围类型：

泛型范围：Item.ReadWrite.All
特定范围：itemType。ReadWrite.All（例如：Notebook.ReadWrite.All）

有关范围的详细信息，请参阅：范围文章。

Microsoft Entra支持的标识

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

身份	支持
用户	是的
服务主体和托管标识	支持调用中的项类型时。检查要调用的项目类型的相应 API，以查看调用是否受支持。

接口

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/identities/default/assign?beta={beta}

URI 参数

名称	在	必需	类型	说明
itemId	path	True	string (uuid)	项 ID。
workspaceId	path	True	string (uuid)	工作区 ID。
beta	query	True	boolean	必须将此必需参数设置为 `true` 访问此 API，该 API 目前为 beta 版。

请求正文

名称	必需	类型	说明
assignmentType	True	IdentityAssignmentEntityType	发出 associaste 标识请求的主题类型。

响应

名称	类型	说明
200 OK	UpdateItemIdentityResponse	请求成功完成。
202 Accepted		请求已接受，标识关联正在进行中。标头 Location: string Retry-After: integer
429 Too Many Requests	ErrorResponse	超出服务速率限制。服务器返回一个 `Retry-After` 标头，指示客户端在发送其他请求之前必须等待的时间（以秒为单位）。标头 Retry-After: integer
Other Status Codes	ErrorResponse	常见错误代码： ItemNotFound - 找不到请求的项目。 InvalidRequest - 关联请求无效。

示例

Associate identity example

示例请求

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/identities/default/assign?beta=True

{
  "assignmentType": "Caller"
}

示例响应

状态代码:: 200

{
  "assignmentStatus": [
    {
      "itemId": "eab1679a-8cab-40d6-9ba6-5c2a07a7ce81",
      "status": "Succeeded"
    },
    {
      "itemId": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
      "parentItemId": "eab1679a-8cab-40d6-9ba6-5c2a07a7ce81",
      "status": "Succeeded"
    },
    {
      "itemId": "83b128a3-f58f-4eee-ab0b-e7e25a748f54",
      "parentItemId": "eab1679a-8cab-40d6-9ba6-5c2a07a7ce81",
      "status": "Failed",
      "errorInfo": {
        "errorCode": "AssignmentFailed",
        "message": "The assignment operation failed due to insufficient permissions."
      }
    }
  ]
}

状态代码:: 202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

定义

名称	说明
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
IdentityAssignmentEntityType	发出 associaste 标识请求的主题类型。
IdentityAssignmentStatusType	标识分配的状态。可能会随着时间的推移添加其他状态。
ItemAssignmentStatus	对项的标识分配的状态。
UpdateItemIdentityRequest	关联标识请求有效负载。
UpdateItemIdentityResponse	关联标识响应。

ErrorRelatedResource

对象

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

名称	类型	说明
resourceId	string	错误中涉及的资源 ID。
resourceType	string	错误中涉及的资源的类型。

ErrorResponse

对象

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string (uuid)	与错误关联的请求的 ID。

ErrorResponseDetails

对象

错误响应详细信息。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。

IdentityAssignmentEntityType

枚举

发出 associaste 标识请求的主题类型。

值	说明
Caller	发出关联标识请求的用户或服务主体。

IdentityAssignmentStatusType

枚举

标识分配的状态。可能会随着时间的推移添加其他状态。

值	说明
Succeeded	标识已成功分配给该项。
Failed	标识分配失败。

ItemAssignmentStatus

对象

对项的标识分配的状态。

名称	类型	说明
errorInfo	ErrorResponseDetails	标识分配失败时的错误信息。
itemId	string (uuid)	项的 ID。
parentItemId	string (uuid)	父项的 ID。
status	IdentityAssignmentStatusType	标识分配的状态。可能会随着时间的推移添加其他状态。

UpdateItemIdentityRequest

对象

关联标识请求有效负载。

名称	类型	说明
assignmentType	IdentityAssignmentEntityType	发出 associaste 标识请求的主题类型。

UpdateItemIdentityResponse

对象

关联标识响应。

名称	类型	说明
assignmentStatus	ItemAssignmentStatus[]	更新后分配给项的标识。

通过