Items - Update Logical Id

Service:
Core
Versione API:
v1

Aggiorna l'ID logico per l'elemento specificato.
Le istanze di elemento corrispondenti condividono lo stesso ID logico. Usare questa operazione per risolvere i conflitti di ID logici. Prima di modificare l'ID logico, esaminare tutte le automazione che si basano sul valore corrente e aggiornarle in base alle esigenze. In caso contrario, tali automazione potrebbero non riuscire a individuare l'elemento o non riuscire a causa di un nome visualizzato duplicato. Per altre informazioni, vedere Risolvere i conflitti di ID logici in Microsoft Fabric.

Permissions

Il chiamante deve disporre delle autorizzazioni di lettura e scrittura per l'elemento.

Ambiti delegati obbligatori

Per le API degli elementi, usare uno dei tipi di ambito seguenti:

  • Ambito generico: Item.ReadWrite.All.
  • Ambito specifico: itemType. ReadWrite.All ,ad esempio Notebook.ReadWrite.All.

Per altre informazioni sugli ambiti, vedere Ambiti.

Limitazioni

  • L'ID logico non può essere un GUID vuoto (00000000-0000-0000-0000-000000000000).
  • L'ID logico deve essere univoco all'interno dell'area di lavoro.
  • L'operazione non è supportata mentre un'operazione CI/CD è attiva nell'area di lavoro.

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identity Support
Utente Sì
Principale del servizio e Identità gestite Sì

Interface

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
itemId
 path True

string (uuid)

ID elemento.
workspaceId
 path True

string (uuid)

L’ID dell’area di lavoro.

Corpo della richiesta

Nome Necessario Tipo Descrizione
logicalId True

string (uuid)

ID logico da aggiornare per l'elemento.

Risposte

Nome Tipo Descrizione
200 OK

LogicalIdResponse

Richiesta completata correttamente.
429 Too Many Requests

ErrorResponse

È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione Retry-After che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive.

Intestazioni

Retry-After: integer
Other Status Codes

ErrorResponse

Codici di errore comuni:

  • ItemNotFound: l'elemento richiesto non è stato trovato.

  • ActiveCiCdOperationInProgress: un'operazione CI/CD è attiva nell'area di lavoro.

Esempio

Update logical ID example

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
200 
{
  "logicalId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}

Definizioni

Nome Descrizione
ErrorParameter

Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.
ErrorRelatedResource

Oggetto dei dettagli della risorsa relativo all'errore.
ErrorResponse

Risposta di errore.
ErrorResponseDetails

Dettagli della risposta di errore.
LogicalIdResponse

Risposta CON ID logico.
UpdateLogicalIdRequest

Aggiornare il payload della richiesta ID logico.

ErrorParameter

Oggetto

Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.

Nome Tipo Descrizione
message

string

Descrizione leggibile del significato del parametro.
name

string

L'identificatore dei parametri.
value

string

Valore del parametro.

ErrorRelatedResource

Oggetto

Oggetto dei dettagli della risorsa relativo all'errore.

Nome Tipo Descrizione
resourceId

string

ID risorsa coinvolto nell'errore.
resourceType

string

Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome Tipo Descrizione
errorCode

string

Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
isRetriable

boolean

Se true, la richiesta può essere ritentata. Usare l'intestazione della Retry-After risposta per determinare il ritardo, se disponibile.
message

string

Rappresentazione leggibile dell'errore.
moreDetails

ErrorResponseDetails[]

Elenco di dettagli aggiuntivi sull'errore.
parameters

ErrorParameter[]

Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource

ErrorRelatedResource

Dettagli della risorsa correlati all'errore.
requestId

string (uuid)

ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome Tipo Descrizione
errorCode

string

Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message

string

Rappresentazione leggibile dell'errore.
parameters

ErrorParameter[]

Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource

ErrorRelatedResource

Dettagli della risorsa correlati all'errore.

LogicalIdResponse

Oggetto

Risposta CON ID logico.

Nome Tipo Descrizione
logicalId

string (uuid)

ID logico dell'elemento.

UpdateLogicalIdRequest

Oggetto

Aggiornare il payload della richiesta ID logico.

Nome Tipo Descrizione
logicalId

string (uuid)

ID logico da aggiornare per l'elemento.