Items - Associate Identity (beta)

サービス:: Core

API バージョン:: v1

既定の ID を項目に関連付けます。

注

この API はベータリリースの一部であり、評価と開発のみを目的として提供されます。フィードバックに基づいて変更される可能性があり、運用環境での使用はお勧めしません。 この API を呼び出すとき、呼び出し元はクエリパラメーター trueの値としてbetaを指定する必要があります。

この API は、実行時間の長い操作 (LRO)をサポートします。

この API は、多数の項目の種類でサポートされており、サポートされている項目の種類とその定義構造に関する情報は、項目管理の概要で確認できます。

アクセス許可

呼び出し元には、アイテムの 読み取りと書き込みの アクセス許可が必要です。

必要な委任スコープ

項目 API の場合は、次のスコープの種類を使用します。

汎用スコープ: Item.ReadWrite.All
特定のスコープ: itemType。ReadWrite.All (例: Notebook.ReadWrite.All)

スコープの詳細については、scopes に関する記事を参照してください。

サポートされている ID をMicrosoft Entraする

この API では、このセクションに記載されている Microsoft identities がサポートされています。

アイデンティティ	サポート
User	はい
サービスプリンシパルとマネージド ID	呼び出しの項目の種類がサポートされている場合。呼び出しがサポートされているかどうかを確認するには、呼び出す項目の種類に対応する 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	この API にアクセスするには、この必須パラメーターを `true` に設定する必要があります。これは現在ベータ版です。

要求本文

名前	必須	型	説明
assignmentType	True	IdentityAssignmentEntityType	associaste ID 要求を行うサブジェクトの種類。

応答

名前	型	説明
200 OK	UpdateItemIdentityResponse	要求は正常に完了しました。
202 Accepted		承認された要求、ID の関連付けが進行中です。ヘッダー 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 ID 要求を行うサブジェクトの種類。
IdentityAssignmentStatusType	ID 割り当ての状態。追加の状態は、時間の経過と同時に追加される場合があります。
ItemAssignmentStatus	アイテムへの ID 割り当ての状態。
UpdateItemIdentityRequest	ID 要求ペイロードを関連付けます。
UpdateItemIdentityResponse	ID 応答を関連付けます。

ErrorRelatedResource

Object

エラー関連のリソース詳細オブジェクト。

名前	型	説明
resourceId	string	エラーに関係するリソース ID。
resourceType	string	エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が理解可能な表現。
moreDetails	ErrorResponseDetails[]	その他のエラーの詳細の一覧。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。
requestId	string (uuid)	エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が理解可能な表現。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。

IdentityAssignmentEntityType

列挙

associaste ID 要求を行うサブジェクトの種類。

値	説明
Caller	関連付け ID 要求を行うユーザーまたはサービスプリンシパル。

IdentityAssignmentStatusType

列挙

ID 割り当ての状態。追加の状態は、時間の経過と同時に追加される場合があります。

値	説明
Succeeded	ID がアイテムに正常に割り当てられます。
Failed	ID の割り当てが失敗しました。

ItemAssignmentStatus

Object

アイテムへの ID 割り当ての状態。

名前	型	説明
errorInfo	ErrorResponseDetails	ID の割り当てが失敗した場合のエラー情報。
itemId	string (uuid)	項目の ID。
parentItemId	string (uuid)	親アイテムの ID。
status	IdentityAssignmentStatusType	ID 割り当ての状態。追加の状態は、時間の経過と同時に追加される場合があります。

UpdateItemIdentityRequest

Object

ID 要求ペイロードを関連付けます。

名前	型	説明
assignmentType	IdentityAssignmentEntityType	associaste ID 要求を行うサブジェクトの種類。

UpdateItemIdentityResponse

Object

ID 応答を関連付けます。

名前	型	説明
assignmentStatus	ItemAssignmentStatus[]	更新後にアイテムに割り当てられた ID。