Items - Associate Identity (beta)

Služba:: Core

Verze rozhraní API:: v1

Přidruží výchozí identitu k položce.

Poznámka:

Toto rozhraní API je součástí beta verze a poskytuje se pouze pro účely vyhodnocení a vývoje. Může se změnit na základě zpětné vazby a nedoporučuje se pro produkční použití. Při volání tohoto rozhraní API musí volající zadat true hodnotu parametru betadotazu .

Toto rozhraní API podporuje dlouhotrvajících operací (LRO).

Toto rozhraní API je podporováno pro řadu typů položek, vyhledání podporovaných typů položek a informace o jejich definiční struktuře v přehledu správy položek .

Povolení

Volající musí mít oprávnění ke čtení a zápisu položky.

Požadované delegované rozsahy

Pro rozhraní API položek se používají tyto typy oborů:

Obecný obor: Item.ReadWrite.All
Specifický obor: itemType. ReadWrite.All (například Notebook.ReadWrite.All)

Další informace o oborech naleznete v článku obory .

Microsoft Entra podporované identity

Toto rozhraní API podporuje Microsoft identity uvedené v této části.

Identita	Podpora
User	Ano
Hlavní služba a Spravované identity	Je-li podporován typ položky ve volání. Zkontrolujte odpovídající rozhraní API pro typ položky, který voláte, a zjistěte, jestli je volání podporované.

Rozhraní

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
itemId	path	True	string (uuid)	ID položky.
workspaceId	path	True	string (uuid)	Identifikátor pracovního prostoru.
beta	query	True	boolean	Tento povinný parametr musí být nastavený tak, aby `true` měl přístup k tomuto rozhraní API, který je aktuálně v beta verzi.

Text požadavku

Name	Vyžadováno	Typ	Description
assignmentType	True	IdentityAssignmentEntityType	Typ předmětu, který vytvoří asociaci žádosti o identitu.

Odpovědi

Name	Typ	Description
200 OK	UpdateItemIdentityResponse	Žádost byla úspěšně dokončena.
202 Accepted		Žádost byla přijata, probíhá přidružení identity. Hlavičky Location: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Byl překročen limit přenosové rychlosti služby. Server vrátí hlavičku `Retry-After` udávající, kolik sekund musí klient čekat před odesláním dalších požadavků. Hlavičky Retry-After: integer
Other Status Codes	ErrorResponse	Běžné kódy chyb: ItemNotFound – Požadovaná položka nebyla nalezena. InvalidRequest – Neplatná žádost o přidružení

Příklady

Associate identity example

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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."
      }
    }
  ]
}

Stavový kód:: 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

Definice

Name	Description
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
IdentityAssignmentEntityType	Typ předmětu, který vytvoří asociaci žádosti o identitu.
IdentityAssignmentStatusType	Stav přiřazení identity. V průběhu času se může přidat další stav.
ItemAssignmentStatus	Stav přiřazení identity k položce
UpdateItemIdentityRequest	Přidružte datovou část žádosti o identitu.
UpdateItemIdentityResponse	Přidružte odpověď identity.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name	Typ	Description
resourceId	string	ID prostředku, které je součástí chyby.
resourceType	string	Typ prostředku, který se podílí na chybě.

ErrorResponse

Objekt

Odpověď na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
isRetriable	boolean	Pokud je hodnota true, je možné požadavek opakovat. Pomocí hlavičky `Retry-After` odpovědi určete zpoždění, pokud je k dispozici.
message	string	Lidské čitelné vyjádření chyby.
moreDetails	ErrorResponseDetails[]	Seznam dalších podrobností o chybě
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou
requestId	string (uuid)	ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou

IdentityAssignmentEntityType

Výčet

Typ předmětu, který vytvoří asociaci žádosti o identitu.

Hodnota	Description
Caller	Uživatel nebo instanční objekt, který vytvoří žádost o přidružení identity.

IdentityAssignmentStatusType

Výčet

Stav přiřazení identity. V průběhu času se může přidat další stav.

Hodnota	Description
Succeeded	Identita je úspěšně přiřazena k položce.
Failed	Přiřazení identity se nezdařilo.

ItemAssignmentStatus

Objekt

Stav přiřazení identity k položce

Name	Typ	Description
errorInfo	ErrorResponseDetails	Informace o chybě, pokud přiřazení identity selhalo.
itemId	string (uuid)	ID položky.
parentItemId	string (uuid)	ID nadřazené položky.
status	IdentityAssignmentStatusType	Stav přiřazení identity. V průběhu času se může přidat další stav.

UpdateItemIdentityRequest

Objekt

Přidružte datovou část žádosti o identitu.

Name	Typ	Description
assignmentType	IdentityAssignmentEntityType	Typ předmětu, který vytvoří asociaci žádosti o identitu.

UpdateItemIdentityResponse

Objekt

Přidružte odpověď identity.

Name	Typ	Description
assignmentStatus	ItemAssignmentStatus[]	Identita přiřazená k položce po aktualizaci.