Items - Associate Identity (beta)

Servizio:: Core

Versione API:: v1

Associa l'identità predefinita a un elemento.

Annotazioni

Questa API fa parte di una versione beta e viene fornita solo a scopo di valutazione e sviluppo. Può cambiare in base al feedback e non è consigliato per l'uso in produzione. Quando si chiama questa API, i chiamanti devono specificare true come valore per il parametro betadi query .

Questa API supporta operazioni con esecuzione prolungata (LRO).

Questa API è supportata per diversi tipi di elemento, trovare i tipi di elemento supportati e le informazioni sulla relativa struttura di definizione in panoramica della gestione degli elementi.

Autorizzazioni

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

Ambiti delegati obbligatori

Per le API degli elementi, usare questi tipi di ambito:

Ambito generico: Item.ReadWrite.All
Ambito specifico: itemType. ReadWrite.All (ad esempio: Notebook.ReadWrite.All)

Per altre informazioni sugli ambiti, vedere l'articolo relativo agli ambiti di .

Microsoft Entra identità supportate

Questa API supporta i Microsoft identities elencati in questa sezione.

Identità	Support
User	Sì
Principale del servizio e Identità gestite	Quando il tipo di elemento nella chiamata è supportato. Controllare l'API corrispondente per il tipo di elemento che si sta chiamando per verificare se la chiamata è supportata.

Interfaccia

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

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.
beta	query	True	boolean	Questo parametro obbligatorio deve essere impostato su per accedere a `true` questa API, attualmente in versione beta.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
assignmentType	True	IdentityAssignmentEntityType	Tipo di oggetto che effettua una richiesta di identità associaste.

Risposte

Nome	Tipo	Descrizione
200 OK	UpdateItemIdentityResponse	Richiesta completata correttamente.
202 Accepted		Richiesta accettata, associazione di identità in corso. Intestazioni Location: string Retry-After: integer
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. InvalidRequest: richiesta di associazione non valida.

Esempio

Associate identity example

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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."
      }
    }
  ]
}

Codice di stato:: 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

Definizioni

Nome	Descrizione
ErrorRelatedResource	Oggetto dei dettagli della risorsa relativo all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
IdentityAssignmentEntityType	Tipo di oggetto che effettua una richiesta di identità associaste.
IdentityAssignmentStatusType	Stato dell'assegnazione di identità. È possibile aggiungere lo stato aggiuntivo nel tempo.
ItemAssignmentStatus	Stato di un'assegnazione di identità a un elemento.
UpdateItemIdentityRequest	Associare il payload della richiesta di identità.
UpdateItemIdentityResponse	Associare la risposta di identità.

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.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi 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.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

IdentityAssignmentEntityType

Enumerazione

Tipo di oggetto che effettua una richiesta di identità associaste.

Valore	Descrizione
Caller	Utente o entità servizio che effettua la richiesta di identità associata.

IdentityAssignmentStatusType

Enumerazione

Stato dell'assegnazione di identità. È possibile aggiungere lo stato aggiuntivo nel tempo.

Valore	Descrizione
Succeeded	L'identità viene assegnata correttamente all'elemento.
Failed	L'assegnazione di identità non è riuscita.

ItemAssignmentStatus

Oggetto

Stato di un'assegnazione di identità a un elemento.

Nome	Tipo	Descrizione
errorInfo	ErrorResponseDetails	Informazioni sull'errore se l'assegnazione di identità non è riuscita.
itemId	string (uuid)	ID dell'elemento.
parentItemId	string (uuid)	ID dell'elemento padre.
status	IdentityAssignmentStatusType	Stato dell'assegnazione di identità. È possibile aggiungere lo stato aggiuntivo nel tempo.

UpdateItemIdentityRequest

Oggetto

Associare il payload della richiesta di identità.

Nome	Tipo	Descrizione
assignmentType	IdentityAssignmentEntityType	Tipo di oggetto che effettua una richiesta di identità associaste.

UpdateItemIdentityResponse

Oggetto

Associare la risposta di identità.

Nome	Tipo	Descrizione
assignmentStatus	ItemAssignmentStatus[]	Identità assegnata all'elemento dopo l'aggiornamento.

Condividi tramite

Items - Associate Identity (beta)

Autorizzazioni

Ambiti delegati obbligatori

Microsoft Entra identità supportate

Interfaccia

Parametri dell'URI

Corpo della richiesta

Risposte

Esempio

Associate identity example

Esempio di richiesta

Risposta di esempio

Definizioni

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

IdentityAssignmentEntityType

IdentityAssignmentStatusType

ItemAssignmentStatus

UpdateItemIdentityRequest

UpdateItemIdentityResponse