Items - Associate Identity (beta)

Service:: Core

API-versie:: v1

Koppelt de standaardidentiteit aan een item.

Opmerking

Deze API maakt deel uit van een bètaversie en is alleen beschikbaar voor evaluatie- en ontwikkelingsdoeleinden. Het kan veranderen op basis van feedback en wordt niet aanbevolen voor productiegebruik. Bij het aanroepen van deze API moeten aanroepers de waarde voor de queryparameter trueopgevenbeta.

Deze API ondersteunt langlopende bewerkingen (LRO).

Deze API wordt ondersteund voor een aantal itemtypen, zoek de ondersteunde itemtypen en informatie over de definitiestructuur in Overzicht van itembeheer.

toestemmingen

De aanroeper moet lees- en schrijfmachtigingen voor het item hebben.

Vereiste gedelegeerde bevoegdheden

Voor item-API's worden deze bereiktypen gebruikt:

Algemeen bereik: Item.ReadWrite.All
Specifiek bereik: itemType. ReadWrite.All (bijvoorbeeld: Notebook.ReadWrite.All)

Zie voor meer informatie over bereiken: artikel bereiken.

Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft identities die in deze sectie worden vermeld.

Identiteit	Support
Gebruiker	Ja
serviceprincipal en beheerde identiteiten	Wanneer het itemtype in de aanroep wordt ondersteund. Controleer de bijbehorende API voor het itemtype dat u aanroept om te zien of uw aanroep wordt ondersteund.

Interface

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

URI-parameters

Name	In	Vereist	Type	Description
itemId	path	True	string (uuid)	De item-id.
workspaceId	path	True	string (uuid)	De werkruimte-ID.
beta	query	True	boolean	Deze vereiste parameter moet worden ingesteld voor `true` toegang tot deze API, die momenteel in bèta is.

Aanvraagbody

Name	Vereist	Type	Description
assignmentType	True	IdentityAssignmentEntityType	Het type onderwerp dat een associaste-identiteitsaanvraag doet.

Antwoorden

Name	Type	Description
200 OK	UpdateItemIdentityResponse	De aanvraag is voltooid.
202 Accepted		Aanvraag geaccepteerd, identiteitskoppeling wordt uitgevoerd. Kopteksten Location: string Retry-After: integer
429 Too Many Requests	ErrorResponse	De servicesnelheidslimiet is overschreden. De server retourneert een `Retry-After` header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden. Kopteksten Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: ItemNotFound : het aangevraagde item is niet gevonden. InvalidRequest - Ongeldige koppelingsaanvraag.

Voorbeelden

Associate identity example

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 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."
      }
    }
  ]
}

Statuscode:: 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

Definities

Name	Description
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	De foutreactie.
ErrorResponseDetails	De details van het foutbericht.
IdentityAssignmentEntityType	Het type onderwerp dat een associaste-identiteitsaanvraag doet.
IdentityAssignmentStatusType	De status van de identiteitstoewijzing. Er kan na verloop van tijd extra status worden toegevoegd.
ItemAssignmentStatus	De status van een identiteitstoewijzing aan een item.
UpdateItemIdentityRequest	Nettolading voor identiteitsaanvragen koppelen.
UpdateItemIdentityResponse	Identiteitsantwoord koppelen.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-ID die betrokken is bij het probleem.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

De foutreactie.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	Details van de foutgerelateerde resource.
requestId	string (uuid)	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	Details van de foutgerelateerde resource.

IdentityAssignmentEntityType

Opsomming

Het type onderwerp dat een associaste-identiteitsaanvraag doet.

Waarde	Description
Caller	Gebruiker of service-principal die de id-aanvraag voor de associate doet.

IdentityAssignmentStatusType

Opsomming

De status van de identiteitstoewijzing. Er kan na verloop van tijd extra status worden toegevoegd.

Waarde	Description
Succeeded	De identiteit is toegewezen aan het item.
Failed	De identiteitstoewijzing is mislukt.

ItemAssignmentStatus

Object

De status van een identiteitstoewijzing aan een item.

Name	Type	Description
errorInfo	ErrorResponseDetails	De foutinformatie als de identiteitstoewijzing is mislukt.
itemId	string (uuid)	De id van het item.
parentItemId	string (uuid)	De id van het bovenliggende item.
status	IdentityAssignmentStatusType	De status van de identiteitstoewijzing. Er kan na verloop van tijd extra status worden toegevoegd.

UpdateItemIdentityRequest

Object

Nettolading voor identiteitsaanvragen koppelen.

Name	Type	Description
assignmentType	IdentityAssignmentEntityType	Het type onderwerp dat een associaste-identiteitsaanvraag doet.

UpdateItemIdentityResponse

Object

Identiteitsantwoord koppelen.

Name	Type	Description
assignmentStatus	ItemAssignmentStatus[]	De identiteit die na de update aan het item is toegewezen.