Del via

Items - Associate Identity (beta)

Tjeneste:
Core
API-versjon:
v1

Knytter standardidentiteten til et element.

Bemerkning

Denne API-en er en del av en betaversjon og leveres bare for evaluerings- og utviklingsformål. Det kan endres basert på tilbakemelding og anbefales ikke for produksjonsbruk. Når du kaller opp denne API-en, må innringere angi true som verdi for spørringsparameteren beta.

Denne API-en støtter langvarige operasjoner (LRO).

Denne API-en støttes for en rekke elementtyper, finner de støttede elementtypene og informasjon om definisjonsstrukturen i Oversikt over elementbehandling.

Tillatelser

Innringeren må ha lese- og skrivetillatelser for elementet.

Nødvendige delegerte omfang

For element-API-er bruker du disse omfangstypene:

  • Generelt omfang: Item.ReadWrite.All
  • Bestemt omfang: itemType. ReadWrite.All (for eksempel: Notebook.ReadWrite.All)

Hvis du vil ha mer informasjon om omfang, kan du se: omfangsartikkel.

Microsoft Entra støttede identiteter

Denne API-en støtter Microsoft identiteter oppført i denne delen.

Identitet Kundestøtte
Bruker Ja
tjenestekontohaver og administrerte identiteter Når elementtypen i samtalen støttes. Kontroller den tilsvarende API-en for elementtypen du ringer, for å se om samtalen støttes.

Grensesnitt

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

URI-parametere

Navn I Obligatorisk Type Beskrivelse
itemId
 path True

string (uuid)

Element-ID-en.
workspaceId
 path True

string (uuid)

Arbeidsområde-ID-en.
beta
 query True

boolean

Denne nødvendige parameteren må angis for å få tilgang til true denne API-en, som for øyeblikket er i betaversjon.

Brødtekst for forespørsel

Navn Obligatorisk Type Beskrivelse
assignmentType True

IdentityAssignmentEntityType

Typen emne som gjør en forespørsel om associaste-identitet.

Svar

Navn Type Beskrivelse
200 OK

UpdateItemIdentityResponse

Forespørselen er fullført.
202 Accepted

Forespørsel godtatt, identitetstilknytning pågår.

Overskrifter

  • Location: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer
Other Status Codes

ErrorResponse

Vanlige feilkoder:

  • ItemNotFound – Finner ikke det forespurte elementet.

  • InvalidRequest – ugyldig tilknytningsforespørsel.

Eksempler

Associate identity example

Eksempelforespørsel

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

Eksempelsvar

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

Definisjoner

Navn Beskrivelse
ErrorRelatedResource

Objektet for feilrelaterte ressursdetaljer.
ErrorResponse

Feilsvaret.
ErrorResponseDetails

Feilsvardetaljene.
IdentityAssignmentEntityType

Typen emne som gjør en forespørsel om associaste-identitet.
IdentityAssignmentStatusType

Statusen for identitetstilordningen. Tilleggsstatus kan legges til over tid.
ItemAssignmentStatus

Statusen for en identitetstilordning til et element.
UpdateItemIdentityRequest

Tilknytt nyttelast for identitetsforespørsel.
UpdateItemIdentityResponse

Knytt identitetssvar.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Navn Type Beskrivelse
resourceId

string

Ressurs-ID-en som er involvert i feilen.
resourceType

string

Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
moreDetails

ErrorResponseDetails[]

Liste over flere feildetaljer.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.
requestId

string (uuid)

ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.

IdentityAssignmentEntityType

Opplisting

Typen emne som gjør en forespørsel om associaste-identitet.

Verdi Beskrivelse
Caller

Bruker- eller tjenestekontohaver som gjør forespørselen om tilknytting av identitet.

IdentityAssignmentStatusType

Opplisting

Statusen for identitetstilordningen. Tilleggsstatus kan legges til over tid.

Verdi Beskrivelse
Succeeded

Identiteten er tilordnet elementet.
Failed

Identitetstilordningen mislyktes.

ItemAssignmentStatus

Objekt

Statusen for en identitetstilordning til et element.

Navn Type Beskrivelse
errorInfo

ErrorResponseDetails

Feilinformasjonen hvis identitetstilordningen mislyktes.
itemId

string (uuid)

ID-en for elementet.
parentItemId

string (uuid)

ID-en for det overordnede elementet.
status

IdentityAssignmentStatusType

Statusen for identitetstilordningen. Tilleggsstatus kan legges til over tid.

UpdateItemIdentityRequest

Objekt

Tilknytt nyttelast for identitetsforespørsel.

Navn Type Beskrivelse
assignmentType

IdentityAssignmentEntityType

Typen emne som gjør en forespørsel om associaste-identitet.

UpdateItemIdentityResponse

Objekt

Knytt identitetssvar.

Navn Type Beskrivelse
assignmentStatus

ItemAssignmentStatus[]

Identiteten som er tilordnet elementet etter oppdatering.