Items - Update Logical Id

Service:: Core

API バージョン:: v1

指定した項目の論理 ID を更新します。
対応する項目インスタンスは、同じ論理 ID を共有します。論理 ID の競合を解決するには、この操作を使用します。論理 ID を変更する前に、現在の値に依存する自動化を確認し、必要に応じて更新します。そうしないと、表示名が重複しているため、これらの自動化で項目の検索が失敗したり、失敗したりする可能性があります。詳細については、「Microsoft Fabricでの論理 ID の競合を解決する」を参照してください。

Permissions

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

必要な委任スコープ

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

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

スコープの詳細については、「スコープ」を参照してください。

制限事項

論理 ID を空の GUID (00000000-0000-0000-0000-000000000000) にすることはできません。
論理 ID は、ワークスペース内で一意である必要があります。
CI/CD 操作がワークスペースでアクティブになっている間、この操作はサポートされていません。

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

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

Identity	サポート
ユーザー	イエス
サービスプリンシパルとマネージド ID	イエス

Interface

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/logicalId

URI パラメーター

Name	/	必須	型	説明
itemId	path	True	string (uuid)	アイテム ID。
workspaceId	path	True	string (uuid)	ワークスペース ID。

要求本文

Name	必須	型	説明
logicalId	True	string (uuid)	アイテムの更新する論理 ID。

応答

Name 型説明

200 OK

Name	型	説明
200 OK	LogicalIdResponse	要求は正常に完了しました。
429 Too Many Requests	ErrorResponse	サービスレートの制限を超えました。サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す `Retry-After` ヘッダーを返します。ヘッダー Retry-After: integer
Other Status Codes	ErrorResponse	一般的なエラーコード: ItemNotFound - 要求された項目が見つかりませんでした。 ActiveCiCdOperationInProgress - CI/CD 操作がワークスペースでアクティブです。

LogicalIdResponse

要求は正常に完了しました。

429 Too Many Requests

ErrorResponse

サービスレートの制限を超えました。サーバーは、クライアントが追加の要求を送信するまでに待機する必要がある時間を秒単位で示す Retry-After ヘッダーを返します。

ヘッダー

Retry-After: integer

Other Status Codes

ErrorResponse

一般的なエラーコード:

ItemNotFound - 要求された項目が見つかりませんでした。
ActiveCiCdOperationInProgress - CI/CD 操作がワークスペースでアクティブです。

例

Update logical ID example

要求のサンプル

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/5b218778-e7a5-4d73-8187-f10824047715/logicalId

{
  "logicalId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}

応答のサンプル

状態コード:: 200

{
  "logicalId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}

定義

Name	説明
ErrorParameter	エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
LogicalIdResponse	論理 ID 応答。
UpdateLogicalIdRequest	論理 ID 要求ペイロードを更新します。

ErrorParameter

Object

エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。

Name	型	説明
message	string	パラメーターの意味を人間が判読できる説明。
name	string	パラメータ識別子です。
value	string	パラメーターの値を指定します。

ErrorRelatedResource

Object

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

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

ErrorResponse

Object

エラー応答。

Name	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
isRetriable	boolean	true の場合、要求を再試行できます。 `Retry-After`応答ヘッダーを使用して、遅延 (使用可能な場合) を決定します。
message	string	エラーの人間が理解可能な表現。
moreDetails	ErrorResponseDetails[]	その他のエラーの詳細の一覧。
parameters	ErrorParameter[]	エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。
requestId	string (uuid)	エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

Name	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が理解可能な表現。
parameters	ErrorParameter[]	エラーに関する追加のコンピューター読み取り可能なコンテキストを提供する構造化パラメーター。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。

LogicalIdResponse

Object

論理 ID 応答。

Name	型	説明
logicalId	string (uuid)	項目の論理 ID。

UpdateLogicalIdRequest

Object

論理 ID 要求ペイロードを更新します。

Name	型	説明
logicalId	string (uuid)	アイテムの更新する論理 ID。