Items - Update Logical Id

Tjänst:

Core

API-version:

v1

Uppdaterar det logiska ID:t för det angivna objektet.
Motsvarande objektinstanser delar samma logiska ID. Använd den här åtgärden för att lösa logiska ID-konflikter. Innan du ändrar det logiska ID:t granskar du alla automatiseringar som förlitar sig på dess aktuella värde och uppdaterar dem efter behov. Annars kan dessa automatiseringar misslyckas med att hitta objektet eller misslyckas på grund av ett duplicerat visningsnamn. Mer information finns i Lösa logiska ID-konflikter i Microsoft Fabric.

Permissions

Anroparen måste ha läs- och skrivbehörighet för objektet.

Obligatoriska delegerade omfång

För objekt-API:er använder du någon av följande omfångstyper:

• Allmänt omfång: Item.ReadWrite.All.
• Specifikt omfång: itemType. ReadWrite.All (till exempel Notebook.ReadWrite.All).

Mer information om omfång finns i Omfång.

Limitations

• Det logiska ID:t får inte vara ett tomt GUID (00000000-0000-0000-0000-000000000000).
• Det logiska ID:t måste vara unikt på arbetsytan.
• Åtgärden stöds inte när en CI/CD-åtgärd är aktiv på arbetsytan.

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Support
User	Yes
Tjänsthuvudnamn och hanterade identiteter	Yes

Gränssnitt

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
itemId	path	True	string (uuid)	Objekt-ID:t.
workspaceId	path	True	string (uuid)	Arbetsyte-ID.

Begärandetext

Name	Obligatorisk	Typ	Description
logicalId	True	string (uuid)	Det logiska ID som ska uppdateras för objektet.

Svar

Name	Typ	Description
200 OK	LogicalIdResponse	Begäran har slutförts.
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: ItemNotFound – Det begärda objektet hittades inte. ActiveCiCdOperationInProgress – En CI/CD-åtgärd är aktiv på arbetsytan.

Exempel

Update logical ID example

Exempelbegäran

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"
}

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
ErrorParameter	En strukturerad parameter som ger ytterligare datorläsbar kontext om ett fel.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Detaljer om felsvaret.
LogicalIdResponse	Svar på logiskt ID.
UpdateLogicalIdRequest	Uppdatera nyttolasten för logisk ID-begäran.

ErrorParameter

Objekt

En strukturerad parameter som ger ytterligare datorläsbar kontext om ett fel.

Name	Typ	Description
message	string	En beskrivning av parameterns betydelse som kan läsas av människor.
name	string	Parameteridentifieraren.
value	string	Parametervärdet.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Resurs-ID:t som är inblandat i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
isRetriable	boolean	När det är sant kan begäran göras på nytt. Använd svarshuvudet Retry-After för att fastställa fördröjningen, om den är tillgänglig.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
parameters	ErrorParameter[]	Strukturerade parametrar som ger ytterligare datorläsbar kontext om felet.
relatedResource	ErrorRelatedResource	Detaljer om resursen relaterad till felet.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Detaljer om felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
parameters	ErrorParameter[]	Strukturerade parametrar som ger ytterligare datorläsbar kontext om felet.
relatedResource	ErrorRelatedResource	Detaljer om resursen relaterad till felet.

LogicalIdResponse

Objekt

Svar på logiskt ID.

Name	Typ	Description
logicalId	string (uuid)	Objektets logiska ID.

UpdateLogicalIdRequest

Objekt

Uppdatera nyttolasten för logisk ID-begäran.

Name	Typ	Description
logicalId	string (uuid)	Det logiska ID som ska uppdateras för objektet.