Del via

Items - Associate Identity (beta)

Tjeneste:
Core
API-version:
v1

Knytter standardidentiteten til et element.

Bemærkning

Denne API er en del af en betaversion og leveres kun til evaluerings- og udviklingsformål. Det kan ændre sig baseret på feedback og anbefales ikke til produktionsbrug. Når du kalder denne API, skal kaldere angive true som værdien for forespørgselsparameteren beta.

Denne API understøtter LRO-handlinger (Long Running Operations).

Denne API understøttes for en række elementtyper. Find de understøttede elementtyper og oplysninger om deres definitionsstruktur i oversigt over elementstyring.

Tilladelser

Den, der ringer op, skal have læse- og skriverettigheder til elementet.

Påkrævede delegerede områder

For element-API'er skal du bruge disse områdetyper:

  • Standardområde: Item.ReadWrite.All
  • Bestemt område: itemType. ReadWrite.All (f.eks. Notebook.ReadWrite.All)

Du kan få flere oplysninger om områder i artiklen områder.

Microsoft Entra understøttede identiteter

Denne API understøtter de Microsoft identities, der er angivet i dette afsnit.

Identitet Støtte
Bruger Ja
tjenesteprincipal og administrerede identiteter Når elementtypen i opkaldet understøttes. Kontrollér den tilsvarende API for den elementtype, du ringer til, for at se, om dit opkald understøttes.

Brugerflade

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

URI-parametre

Name I Påkrævet Type Beskrivelse
itemId
 path True

string (uuid)

Element-id'et.
workspaceId
 path True

string (uuid)

Arbejdsområde-id'et.
beta
 query True

boolean

Denne påkrævede parameter skal angives til for at true få adgang til denne API, som i øjeblikket er i beta.

Brødtekst for anmodning

Name Påkrævet Type Beskrivelse
assignmentType True

IdentityAssignmentEntityType

Den type emne, der opretter en associaste identitetsanmodning.

Svar

Name Type Beskrivelse
200 OK

UpdateItemIdentityResponse

Anmodningen blev fuldført.
202 Accepted

Anmodningen er accepteret. Identitetstilknytningen er i gang.

Headere

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

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer
Other Status Codes

ErrorResponse

Almindelige fejlkoder:

  • ItemNotFound – Det ønskede element blev ikke fundet.

  • InvalidRequest - Ugyldig tilknytningsanmodning.

Eksempler

Associate identity example

Eksempelanmodning

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

Definitioner

Name Beskrivelse
ErrorRelatedResource

Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse

Fejlsvaret.
ErrorResponseDetails

Oplysninger om fejlsvar.
IdentityAssignmentEntityType

Den type emne, der opretter en associaste identitetsanmodning.
IdentityAssignmentStatusType

Status for identitetstildelingen. Der kan tilføjes yderligere status over tid.
ItemAssignmentStatus

Status for en identitetstildeling til et element.
UpdateItemIdentityRequest

Tilknyt nyttedata for identitetsanmodning.
UpdateItemIdentityResponse

Tilknyt identitetssvar.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name Type Beskrivelse
resourceId

string

Det ressource-id, der er involveret i fejlen.
resourceType

string

Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message

string

En menneskelig læsbar gengivelse af fejlen.
moreDetails

ErrorResponseDetails[]

Liste over yderligere oplysninger om fejl.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.
requestId

string (uuid)

Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message

string

En menneskelig læsbar gengivelse af fejlen.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.

IdentityAssignmentEntityType

Optælling

Den type emne, der opretter en associaste identitetsanmodning.

Værdi Beskrivelse
Caller

Den bruger eller tjenesteprincipal, der foretager anmodningen om tilknytningsidentitet.

IdentityAssignmentStatusType

Optælling

Status for identitetstildelingen. Der kan tilføjes yderligere status over tid.

Værdi Beskrivelse
Succeeded

Identiteten er tildelt elementet.
Failed

Identitetstildelingen mislykkedes.

ItemAssignmentStatus

Objekt

Status for en identitetstildeling til et element.

Name Type Beskrivelse
errorInfo

ErrorResponseDetails

Fejloplysningerne, hvis identitetstildelingen mislykkedes.
itemId

string (uuid)

Id'et for elementet.
parentItemId

string (uuid)

Id'et for det overordnede element.
status

IdentityAssignmentStatusType

Status for identitetstildelingen. Der kan tilføjes yderligere status over tid.

UpdateItemIdentityRequest

Objekt

Tilknyt nyttedata for identitetsanmodning.

Name Type Beskrivelse
assignmentType

IdentityAssignmentEntityType

Den type emne, der opretter en associaste identitetsanmodning.

UpdateItemIdentityResponse

Objekt

Tilknyt identitetssvar.

Name Type Beskrivelse
assignmentStatus

ItemAssignmentStatus[]

Den identitet, der er tildelt elementet efter opdateringen.