External Data Shares Provider - List External Data Shares

Başvuru

Hizmet:: Admin

API Sürümü:: v1

Kiracıdaki dış veri paylaşımlarını listeler.

Bu API, sayfalandırmadestekler.

İzinler

Çağıranın Doku yöneticisi olması veya hizmet sorumlusu kullanarak kimlik doğrulaması yapması gerekir.

Gerekli Temsilci Kapsamları

Tenant.ReadWrite.All

Gerekli Kiracı Ayarları

Bu API'yi kullanmak için çağrı sorumlusu için Dış veri paylaşımı yönetici anahtarını etkinleştirin.

Sınırlamalar

Dakikada en fazla 10 istek.

Microsoft Entra destekli kimlikler

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

Kimlik	Destek
Kullanıcı	Evet
Hizmet sorumlusu ve yönetilen kimlikler	Evet

Arayüz

GET https://api.fabric.microsoft.com/v1/admin/items/externalDataShares

İsteğe bağlı parametrelerle:

GET https://api.fabric.microsoft.com/v1/admin/items/externalDataShares?continuationToken={continuationToken}

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
continuationToken	query		string	Sonuçların sonraki sayfasını almak için bir belirteç.

Yanıtlar

Name	Tür	Description
200 OK	ExternalDataShares	İstek başarıyla tamamlandı.
Other Status Codes	ErrorResponse	Yaygın hata kodları: UnknownError - Bir hata oluştu.

Name

Tür

Description

200 OK

ExternalDataShares

İstek başarıyla tamamlandı.

Other Status Codes

ErrorResponse

Yaygın hata kodları:

UnknownError - Bir hata oluştu.

Örnekler

List external data shares in the tenant example

Örnek isteği

HTTP

GET https://api.fabric.microsoft.com/v1/admin/items/externalDataShares

Örnek yanıt

Durum kodu:: 200

{
  "value": [
    {
      "id": "dccc162f-7a41-4720-83c3-5c7e81187959",
      "paths": [
        "Files/Sales/Contoso_Sales_2023"
      ],
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@contoso.com"
        }
      },
      "recipient": {
        "userPrincipalName": "lisa@fabrikam.com"
      },
      "status": "Pending",
      "expirationTimeUtc": "2024-12-13T00:00:00.000Z",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "itemId": "5b218778-e7a5-4d73-8187-f10824047715",
      "invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?providerTenantId=34f92457-fe9d-4c36-92a8-499fdfaf0f8f&shareId=dccc162f-7a41-4720-83c3-5c7e81187959"
    },
    {
      "id": "96c21561-65b8-4b23-bb9a-ee8cef945c45",
      "paths": [
        "Files/Sales/Contoso_Sales_2023"
      ],
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@contoso.com"
        }
      },
      "recipient": {
        "userPrincipalName": "lisa@fabrikam.com"
      },
      "status": "Active",
      "expirationTimeUtc": "2024-08-31T00:00:00.000Z",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "itemId": "5b218778-e7a5-4d73-8187-f10824047715",
      "invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?providerTenantId=34f92457-fe9d-4c36-92a8-499fdfaf0f8f&shareId=96c21561-65b8-4b23-bb9a-ee8cef945c45",
      "acceptedByTenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b"
    },
    {
      "id": "0f40aeca-8f78-4a6f-a552-e5c45faadc60",
      "paths": [
        "Files/Sales/Contoso_Sales_2023"
      ],
      "creatorPrincipal": {
        "id": "81fac5e1-2a81-421b-a168-110b1c72fa11",
        "displayName": "Eric Solomon",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "eric@contoso.com"
        }
      },
      "recipient": {
        "userPrincipalName": "lisa@fabrikam.com"
      },
      "status": "InvitationExpired",
      "expirationTimeUtc": "2024-01-01T00:00:00.000Z",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "itemId": "5b218778-e7a5-4d73-8187-f10824047715",
      "invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?providerTenantId=34f92457-fe9d-4c36-92a8-499fdfaf0f8f&shareId=0f40aeca-8f78-4a6f-a552-e5c45faadc60"
    },
    {
      "id": "89e82a82-0140-4837-8eee-9c919e3e5952",
      "paths": [
        "Files/Sales/Contoso_Sales_2023"
      ],
      "creatorPrincipal": {
        "id": "81fac5e1-2a81-421b-a168-110b1c72fa11",
        "displayName": "Eric Solomon",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "eric@contoso.com"
        }
      },
      "recipient": {
        "userPrincipalName": "lisa@fabrikam.com"
      },
      "status": "Revoked",
      "expirationTimeUtc": "2024-12-01T00:00:00.000Z",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "itemId": "5b218778-e7a5-4d73-8187-f10824047715",
      "invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?providerTenantId=34f92457-fe9d-4c36-92a8-499fdfaf0f8f&shareId=89e82a82-0140-4837-8eee-9c919e3e5952",
      "acceptedByTenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b"
    }
  ]
}

Tanımlar

Name	Description
ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları nesnesi.
ErrorResponse	Hata yanıtı.
ErrorResponseDetails	Hata yanıtı ayrıntıları.
ExternalDataShare	Dış veri paylaşımı nesnesi.
ExternalDataShareRecipient	Dış veri paylaşımı alıcısının gösterimi.
ExternalDataShares	Devamlılık belirteciyle dış veri paylaşımlarının listesi.
ExternalDataShareStatus	Belirli bir dış veri paylaşımının durumu. Zaman içinde ek `ExternalDataShareStatus` türleri eklenebilir.
GroupDetails	Belirli ayrıntıları gruplandırma. Sorumlu türü `Group`olduğunda geçerlidir.
GroupType	Grubun türü. Zaman içinde ek grup türleri eklenebilir.
Principal	Bir kimliği veya Microsoft Entra grubunu temsil eder.
PrincipalType	Sorumlunun türü. Zaman içinde ek sorumlu türleri eklenebilir.
ServicePrincipalDetails	Hizmet sorumlusuna özgü ayrıntılar. Sorumlu türü `ServicePrincipal`olduğunda geçerlidir.
ServicePrincipalProfileDetails	Hizmet sorumlusu profili ayrıntıları. Sorumlu türü `ServicePrincipalProfile`olduğunda geçerlidir.
UserDetails	Kullanıcı sorumlusuna özgü ayrıntılar. Sorumlu türü `User`olduğunda geçerlidir.

ErrorRelatedResource

Object

Hatayla ilgili 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

Object

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ı.
message	string	Hatanın okunabilir bir gösterimi.
moreDetails	ErrorResponseDetails[]	Ek hata ayrıntılarının listesi.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.
requestId	string	Hatayla ilişkili isteğin kimliği.

ErrorResponseDetails

Object

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 okunabilir bir gösterimi.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.

ExternalDataShare

Object

Dış veri paylaşımı nesnesi.

Name	Tür	Description
acceptedByTenantId	string (uuid)	Dış veri paylaşımının kabul edildiği kiracı kimliği.
creatorPrincipal	Principal	Dış veri paylaşımını oluşturan sorumlu.
expirationTimeUtc	string (date-time)	Dış veri paylaşımı davetinin son kullanma tarihi ve saati (UTC).
id	string (uuid)	Dış veri paylaşımı kimliği.
invitationUrl	string (uri)	Dış veri paylaşımı davetini kabul etme URL'si.
itemId	string (uuid)	Öğe kimliği.
paths	string[]	Dış olarak paylaşılan yolların yolu veya listesi.
recipient	ExternalDataShareRecipient	Dış veri paylaşımını kabul etmeye davet edilen alıcı.
status	ExternalDataShareStatus	Dış veri paylaşımının durumu.
workspaceId	string (uuid)	Çalışma alanı kimliği.

ExternalDataShareRecipient

Object

Dış veri paylaşımı alıcısının gösterimi.

Name	Tür	Description
tenantId	string (uuid)	Alıcının kiracı kimliği.
userPrincipalName	string maxLength: 256	Alıcının e-posta adresi.

ExternalDataShares

Object

Devamlılık belirteciyle dış veri paylaşımlarının listesi.

Name	Tür	Description
continuationToken	string	Sonraki sonuç kümesi toplu işleminin belirteci. Başka kayıt yoksa yanıttan kaldırılır.
continuationUri	string	Sonraki sonuç kümesi toplu işleminin URI'sini. Başka kayıt yoksa yanıttan kaldırılır.
value	ExternalDataShare[]	Dış veri paylaşımlarının listesi.

ExternalDataShareStatus

Listeleme

Belirli bir dış veri paylaşımının durumu. Zaman içinde ek ExternalDataShareStatus türleri eklenebilir.

Değer	Description
Active	Davet alıcı tarafından kabul edildi ve dış veri paylaşımı etkin.
InvitationExpired	Davetin süresi doldu ve artık alıcı tarafından kabul edilemeyecek.
Pending	Bir davet oluşturuldu ve artık alıcı tarafından kabul edilmesini bekliyor.
Revoked	Dış veri paylaşımı iptal edildi.

GroupDetails

Object

Belirli ayrıntıları gruplandırma. Sorumlu türü Groupolduğunda geçerlidir.

Name	Tür	Description
groupType	GroupType	Grubun türü. Zaman içinde ek grup türleri eklenebilir.

GroupType

Listeleme

Grubun türü. Zaman içinde ek grup türleri eklenebilir.

Değer	Description
DistributionList	Sorumlu bir dağıtım listesidir.
SecurityGroup	Sorumlu bir güvenlik grubudur.
Unknown	Asıl grup türü bilinmiyor.

Principal

Object

Bir kimliği veya Microsoft Entra grubunu temsil eder.

Name	Tür	Description
displayName	string	Sorumlunun görünen adı.
groupDetails	GroupDetails	Belirli ayrıntıları gruplandırma. Sorumlu türü `Group`olduğunda geçerlidir.
id	string (uuid)	Sorumlunun kimliği.
servicePrincipalDetails	ServicePrincipalDetails	Hizmet sorumlusuna özgü ayrıntılar. Sorumlu türü `ServicePrincipal`olduğunda geçerlidir.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Hizmet sorumlusu profili ayrıntıları. Sorumlu türü `ServicePrincipalProfile`olduğunda geçerlidir.
type	PrincipalType	Sorumlunun türü. Zaman içinde ek sorumlu türleri eklenebilir.
userDetails	UserDetails	Kullanıcı sorumlusuna özgü ayrıntılar. Sorumlu türü `User`olduğunda geçerlidir.

PrincipalType

Listeleme

Sorumlunun türü. Zaman içinde ek sorumlu türleri eklenebilir.

Değer	Description
Group	Sorumlu bir güvenlik grubudur.
ServicePrincipal	Sorumlu bir Microsoft Entra hizmet sorumlusudur.
ServicePrincipalProfile	Sorumlu bir hizmet sorumlusu profilidir.
User	Sorumlu bir Microsoft Entra kullanıcı sorumlusudur.

ServicePrincipalDetails

Object

Hizmet sorumlusuna özgü ayrıntılar. Sorumlu türü ServicePrincipalolduğunda geçerlidir.

Name	Tür	Description
aadAppId	string (uuid)	Hizmet sorumlusunun Microsoft Entra AppId değeridir.

ServicePrincipalProfileDetails

Object

Hizmet sorumlusu profili ayrıntıları. Sorumlu türü ServicePrincipalProfileolduğunda geçerlidir.

Name	Tür	Description
parentPrincipal	Principal	Hizmet sorumlusu profilinin üst sorumlusu.

UserDetails

Object

Kullanıcı sorumlusuna özgü ayrıntılar. Sorumlu türü Userolduğunda geçerlidir.

Name	Tür	Description
userPrincipalName	string	Kullanıcı asıl adı.

Aracılığıyla paylaş

External Data Shares Provider - List External Data Shares

İzinler

Gerekli Temsilci Kapsamları

Gerekli Kiracı Ayarları

Sınırlamalar

Microsoft Entra destekli kimlikler

Arayüz

URI Parametreleri

Yanıtlar

Örnekler

List external data shares in the tenant example

Örnek isteği

Örnek yanıt

Tanımlar

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExternalDataShare

ExternalDataShareRecipient

ExternalDataShares

ExternalDataShareStatus

GroupDetails

GroupType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails