Jaa

Items - Associate Identity (beta)

Palvelu:
Core
Ohjelmointirajapinnan versio:
v1

Liittää oletusarvoiset käyttäjätiedot kohteeseen.

Muistio

Tämä ohjelmointirajapinta on osa beetaversiota, ja se on saatavilla vain arviointi- ja kehitystarkoituksiin. Muutos saattaa perustua palautteeseen, eikä sitä suositella tuotantokäyttöön. Kun kutsut tätä ohjelmointirajapintaa, kutsujien on määritettävä true kyselyparametrin betaarvoksi .

Tämä ohjelmointirajapinta tukee pitkäkestoisia toimintoja.

Tätä ohjelmointirajapintaa tuetaan useissa kohdetyypeissä. Se etsii tuettuja kohdetyyppejä ja tietoja niiden määritysrakenteesta kohdasta Kohdehallinnan yleiskatsaus.

Käyttöoikeudet

Soittajalla on oltava kohteen luku- ja kirjoitusoikeudet .

Vaaditut delegoidut vaikutusalueet

Kohteiden ohjelmointirajapinnoilla voit käyttää seuraavia vaikutusaluetyyppejä:

  • Yleinen vaikutusalue: Item.ReadWrite.All
  • Tietty vaikutusalue: itemType. ReadWrite.All (esimerkiksi: Notebook.ReadWrite.All)

Lisätietoja vaikutusalueista on artikkelissa vaikutusalueet.

tuettujen käyttäjätietojen Microsoft Entra

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft identities.

Identiteetti Tuki
Käyttäjä Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen Kun kutsun kohdetyyppiä tuetaan. Tarkista vastaava ohjelmointirajapinta kohdetyypille, jota kutsut, ja tarkista, tuetaanko kutsuasi.

Käyttöliittymä

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

URI-parametrit

Nimi Kohteessa Pakollinen Tyyppi Description
itemId
 path True

string (uuid)

Kohdetunnus.
workspaceId
 path True

string (uuid)

Työtilan tunnus.
beta
 query True

boolean

Tämä pakollinen parametri on määritettävä, jotta true voit käyttää tätä ohjelmointirajapintaa, joka on tällä hetkellä beetaversiossa.

Pyynnön leipäteksti

Nimi Pakollinen Tyyppi Description
assignmentType True

IdentityAssignmentEntityType

Liitännäisen käyttäjätietopyynnön tekevän aiheen tyyppi.

Vastaukset

Nimi Tyyppi Description
200 OK

UpdateItemIdentityResponse

Pyynnön valmistuttua.
202 Accepted

Pyyntö hyväksytty, käyttäjätietojen yhdistäminen on käynnissä.

Otsikot

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

ErrorResponse

Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka Retry-After ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään.

Otsikot

Retry-After: integer
Other Status Codes

ErrorResponse

Yleiset virhekoodit:

  • ItemNotFound – Pyydettyä kohdetta ei löytynyt.

  • InvalidRequest – Virheellinen liittämispyyntö.

Esimerkit

Associate identity example

Mallipyyntö

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

Mallivastaus

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

Määritelmät

Nimi Description
ErrorRelatedResource

Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse

Virhevastaus.
ErrorResponseDetails

Virheen vastauksen tiedot.
IdentityAssignmentEntityType

Liitännäisen käyttäjätietopyynnön tekevän aiheen tyyppi.
IdentityAssignmentStatusType

Käyttäjätietojen määrityksen tila. Lisätilaa voidaan lisätä ajan mittaan.
ItemAssignmentStatus

Käyttäjätietojen määrityksen tila kohteelle.
UpdateItemIdentityRequest

Liitä käyttäjätietopyynnön tiedot.
UpdateItemIdentityResponse

Liitä käyttäjätietojen vastaus.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi Tyyppi Description
resourceId

string

Virheestä liittyvä resurssitunnus.
resourceType

string

Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi Tyyppi Description
errorCode

string

Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message

string

Ihmisen luettavissa oleva esitys virheestä.
moreDetails

ErrorResponseDetails[]

Luettelo virheiden lisätiedoista.
relatedResource

ErrorRelatedResource

Virheisiin liittyvät resurssitiedot.
requestId

string (uuid)

Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi Tyyppi Description
errorCode

string

Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message

string

Ihmisen luettavissa oleva esitys virheestä.
relatedResource

ErrorRelatedResource

Virheisiin liittyvät resurssitiedot.

IdentityAssignmentEntityType

Luettelointi

Liitännäisen käyttäjätietopyynnön tekevän aiheen tyyppi.

Arvo Description
Caller

Käyttäjä tai palvelun päänimi, joka tekee kumppanin käyttäjätietopyynnön.

IdentityAssignmentStatusType

Luettelointi

Käyttäjätietojen määrityksen tila. Lisätilaa voidaan lisätä ajan mittaan.

Arvo Description
Succeeded

Käyttäjätiedot on määritetty onnistuneesti kohteelle.
Failed

Käyttäjätietojen määritys epäonnistui.

ItemAssignmentStatus

Kohde

Käyttäjätietojen määrityksen tila kohteelle.

Nimi Tyyppi Description
errorInfo

ErrorResponseDetails

Virhetietoja, jos käyttäjätietojen määritys epäonnistui.
itemId

string (uuid)

Kohteen tunnus.
parentItemId

string (uuid)

Pääkohteen tunnus.
status

IdentityAssignmentStatusType

Käyttäjätietojen määrityksen tila. Lisätilaa voidaan lisätä ajan mittaan.

UpdateItemIdentityRequest

Kohde

Liitä käyttäjätietopyynnön tiedot.

Nimi Tyyppi Description
assignmentType

IdentityAssignmentEntityType

Liitännäisen käyttäjätietopyynnön tekevän aiheen tyyppi.

UpdateItemIdentityResponse

Kohde

Liitä käyttäjätietojen vastaus.

Nimi Tyyppi Description
assignmentStatus

ItemAssignmentStatus[]

Kohteelle päivityksen jälkeen määritetyt käyttäjätiedot.