Items - Associate Identity (beta)

Hizmet:: Core

API Sürümü:: v1

Varsayılan kimliği bir öğeyle ilişkilendirir.

Uyarı

Bu API, Beta sürümünün bir parçasıdır ve yalnızca değerlendirme ve geliştirme amacıyla sağlanır. Geri bildirim temelinde değişebilir ve üretim kullanımı için önerilmez. Bu API'yi çağırırken, çağıranların sorgu parametresinin truedeğeri olarak belirtmesi beta gerekir.

Bu API, uzun süre çalışan işlemleri (LRO)destekler.

Bu API bir dizi öğe türü için desteklenir, desteklenen öğe türlerini ve tanım yapısı hakkındaki bilgileri Öğe yönetimine genel bakış.

İzinler

Çağıranın öğe için okuma ve yazma izinleri olmalıdır.

Gerekli Devredilen Kapsamlar

Öğe API'leri için şu kapsam türlerini kullanın:

Genel kapsam: Item.ReadWrite.All
Belirli kapsam: itemType. ReadWrite.All (örneğin: Notebook.ReadWrite.All)

kapsamlar hakkında daha fazla bilgi için bkz. kapsamlar makalesi.

Desteklenen kimlikleri Microsoft Entra

Bu API, bu bölümde listelenen Microsoft identities destekler.

Identity	Support
User	Evet
Hizmet sorumlusu ve yönetilen kimlikler	Çağrıdaki öğe türü desteklendiğinde. Aramanızın desteklenip desteklenmediğini görmek için çağırdığınız öğe türü için ilgili API'yi denetleyin.

Arayüz

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
itemId	path	True	string (uuid)	Öğe kimliği.
workspaceId	path	True	string (uuid)	Çalışma alanı kimliği.
beta	query	True	boolean	Şu anda beta sürümünde olan bu API'ye erişmek için bu gerekli parametre olarak ayarlanmalıdır `true` .

İstek Gövdesi

Name	Gerekli	Tür	Description
assignmentType	True	IdentityAssignmentEntityType	Associaste kimlik isteğinde bulunan konu türü.

Yanıtlar

Name	Tür	Description
200 OK	UpdateItemIdentityResponse	İstek başarıyla tamamlandı.
202 Accepted		İstek kabul edildi, kimlik ilişkilendirmesi devam ediyor. Üst Bilgiler Location: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Hizmet fiyatı sınırı aşıldı. Sunucu, istemcinin ek istek göndermeden önce ne kadar beklemesi gerektiğini saniye cinsinden belirten bir `Retry-After` üst bilgi döndürür. Üst Bilgiler Retry-After: integer
Other Status Codes	ErrorResponse	Yaygın hata kodları: ItemNotFound - İstenen öğe bulunamadı. InvalidRequest - Geçersiz ilişkilendirme isteği.

Örnekler

Associate identity example

Örnek isteği

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

Örnek yanıt

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

Durum kodu:: 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

Tanımlar

Name	Description
ErrorRelatedResource	Hata ile ilişkili kaynak ayrıntıları nesnesi.
ErrorResponse	Hata yanıtı.
ErrorResponseDetails	Hata yanıtı ayrıntıları.
IdentityAssignmentEntityType	Associaste kimlik isteğinde bulunan konu türü.
IdentityAssignmentStatusType	Kimlik atamasının durumu. Zaman içinde ek durum eklenebilir.
ItemAssignmentStatus	Bir öğeye kimlik atamasının durumu.
UpdateItemIdentityRequest	Kimlik isteği yükünü ilişkilendirin.
UpdateItemIdentityResponse	Kimlik yanıtlarını ilişkilendirin.

ErrorRelatedResource

Nesne

Hata ile ilişkili kaynak ayrıntıları nesnesi.

Name	Tür	Description
resourceId	string	Hataya dahil olan kaynak kimliği.
resourceType	string	Hataya dahil olan kaynağın türü.

ErrorResponse

Nesne

Hata yanıtı.

Name	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
isRetriable	boolean	True olduğunda istek yeniden denenebilir. Varsa gecikmeyi `Retry-After` belirlemek için yanıt üst bilgisini kullanın.
message	string	Hatanın insan tarafından okunabilir bir temsilidir.
moreDetails	ErrorResponseDetails[]	Ek hata ayrıntılarının listesi.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.
requestId	string (uuid)	Hatayla ilişkili isteğin kimliği.

ErrorResponseDetails

Nesne

Hata yanıtı ayrıntıları.

Name	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message	string	Hatanın insan tarafından okunabilir bir temsilidir.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.

IdentityAssignmentEntityType

Numaralandırma

Associaste kimlik isteğinde bulunan konu türü.

Değer	Description
Caller	İlişkili kimlik isteğinde bulunan kullanıcı veya hizmet sorumlusu.

IdentityAssignmentStatusType

Numaralandırma

Kimlik atamasının durumu. Zaman içinde ek durum eklenebilir.

Değer	Description
Succeeded	Kimlik, öğeye başarıyla atanır.
Failed	Kimlik ataması başarısız oldu.

ItemAssignmentStatus

Nesne

Bir öğeye kimlik atamasının durumu.

Name	Tür	Description
errorInfo	ErrorResponseDetails	Kimlik ataması başarısız olduysa hata bilgileri.
itemId	string (uuid)	Öğenin kimliği.
parentItemId	string (uuid)	Üst öğenin kimliği.
status	IdentityAssignmentStatusType	Kimlik atamasının durumu. Zaman içinde ek durum eklenebilir.

UpdateItemIdentityRequest

Nesne

Kimlik isteği yükünü ilişkilendirin.

Name	Tür	Description
assignmentType	IdentityAssignmentEntityType	Associaste kimlik isteğinde bulunan konu türü.

UpdateItemIdentityResponse

Nesne

Kimlik yanıtlarını ilişkilendirin.

Name	Tür	Description
assignmentStatus	ItemAssignmentStatus[]	Güncelleştirmeden sonra öğeye atanan kimlik.