Kopiowanie danych z listy usługi SharePoint Online przy użyciu usługi Azure Data Factory lub Azure Synapse Analytics

DOTYCZY: Azure Data Factory Azure Synapse Analytics

W tym artykule opisano sposób używania działania kopiowania w potokach usługi Azure Data Factory i Usługi Azure Synapse do kopiowania danych z listy usługi SharePoint Online. Artykuł opiera się na działaniu kopiowania, które przedstawia ogólne omówienie działania kopiowania.

Obsługiwane możliwości

Ten łącznik listy usługi SharePoint Online jest obsługiwany w następujących funkcjach:

(1) Środowisko Azure Integration Runtime (2) Self-hosted Integration Runtime

Aby uzyskać listę magazynów danych obsługiwanych jako źródła lub ujścia, zobacz tabelę Obsługiwane magazyny danych.

W szczególności ten łącznik usługi SharePoint List Online używa uwierzytelniania jednostki usługi i pobiera dane za pośrednictwem protokołu OData.

Wprowadzenie

Aby wykonać działanie kopiowania za pomocą pipeline'u, możesz użyć jednego z następujących narzędzi lub zestawów SDK:

• Narzędzie do kopiowania danych
• Portal Azure
• zestawu SDK platformy .NET
• Zestaw SDK dla języka Python
• Azure PowerShell
• API REST
• Szablon usługi Azure Resource Manager

Tworzenie połączonej usługi z listą usługi SharePoint Online przy użyciu interfejsu użytkownika

Wykonaj poniższe kroki, aby utworzyć połączoną usługę z listą usługi SharePoint Online w interfejsie użytkownika witryny Azure Portal.

1. Przejdź do karty Zarządzanie w obszarze roboczym usługi Azure Data Factory lub Synapse i wybierz pozycję Połączone usługi, a następnie wybierz pozycję Nowe:

   • Azure Data Factory
   • Azure Synapse

   

2. Wyszukaj program SharePoint i wybierz łącznik listy usługi SharePoint Online.

   

3. Skonfiguruj szczegóły usługi, przetestuj połączenie i utwórz nową połączoną usługę.

   

Szczegóły konfiguracji łącznika

Poniższe sekcje zawierają szczegółowe informacje o właściwościach, których można użyć do definiowania jednostek specyficznych dla łącznika listy usługi SharePoint Online.

Właściwości połączonej usługi

Następujące właściwości są obsługiwane dla połączonej usługi listy usługi SharePoint Online:

Przykład 1: Używanie uwierzytelniania klucza jednostki usługi

{
    "name": "SharePointOnlineList",
    "properties": {
        "type": "SharePointOnlineList",
        "typeProperties": {
            "siteUrl": "<site URL>",
            "servicePrincipalId": "<service principal id>",
            "servicePrincipalCredentialType":  "ServicePrincipalKey",
            "servicePrincipalKey": {
                "type": "SecureString",
                "value": "<service principal key>"
            },
            "tenantId": "<tenant ID>"
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

Przykład 2: Używanie uwierzytelniania certyfikatu jednostki usługi

{
    "name": "SharePointOnlineList",
    "properties": {
        "type": "SharePointOnlineList",
        "typeProperties": {
            "siteUrl": "<site URL>",
            "servicePrincipalId": "<service principal id>",
            "servicePrincipalCredentialType": "ServicePrincipalCert",
            "servicePrincipalEmbeddedCert": { 
                "type": "SecureString", 
                "value": "<base64 encoded string of (.pfx) certificate data>"
            },
            "servicePrincipalEmbeddedCertPassword": { 
                "type": "SecureString", 
                "value": "<password of your certificate>"
            },
            "tenantId": "<tenant ID>"
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

Udzielanie uprawnień do korzystania z klucza jednostki usługi

Łącznik usługi SharePoint List Online używa uwierzytelniania jednostki usługi do nawiązywania połączenia z programem SharePoint. Wykonaj następujące kroki, aby go skonfigurować:

1. Zarejestruj aplikację w Platforma tożsamości Microsoft. Aby dowiedzieć się, jak to zrobić, zobacz Szybki start: rejestrowanie aplikacji przy użyciu Platforma tożsamości Microsoft. Zanotuj te wartości, których użyjesz do zdefiniowania połączonej usługi:

   • Identyfikator aplikacji
   • Klucz aplikacji
   • Identyfikator dzierżawy

2. Udziel uprawnień witryny usługi SharePoint Online do zarejestrowanej aplikacji, wykonując poniższe kroki. W tym celu potrzebna jest rola administratora witryny.

   1. Otwórz link witryny usługi SharePoint Online. Na przykład adres URL w formacie https://<your-site-url>/_layouts/15/appinv.aspx , w którym symbol zastępczy <your-site-url> to Twoja witryna.

   2. Przeszukaj zarejestrowany identyfikator aplikacji, wypełnij puste pola i wybierz pozycję "Utwórz".

      • Domena aplikacji: contoso.com

      • Adres URL przekierowania: https://www.contoso.com

      • Plik XML żądania uprawnień:

        <AppPermissionRequests AllowAppOnlyPolicy="true">
            <AppPermissionRequest Scope="http://sharepoint/content/sitecollection/web" Right="Read"/>
        </AppPermissionRequests>
        

        

      Note

      W kontekście konfigurowania łącznika programu SharePoint "Domena aplikacji" i "Adres URL przekierowania" odnoszą się do aplikacji programu SharePoint zarejestrowanej w usłudze Microsoft Entra ID, aby zezwolić na dostęp do danych programu SharePoint. "Domena aplikacji" to domena, w której jest hostowana witryna programu SharePoint. Jeśli na przykład witryna programu SharePoint znajduje się w lokalizacji "https://contoso.sharepoint.com", wówczas "Domena aplikacji" będzie miała wartość "contoso.sharepoint.com". "Adres URL przekierowania" to adres URL, do którego aplikacja programu SharePoint zostanie przekierowana po uwierzytelnieniu użytkownika i udzieleniu uprawnień do aplikacji. Ten adres URL powinien być stroną w witrynie programu SharePoint, do której aplikacja ma uprawnienia dostępu. Można na przykład użyć adresu URL strony, która wyświetla listę plików w bibliotece lub stronę wyświetlającą zawartość dokumentu.

   3. Wybierz pozycję "Ufaj jej" dla tej aplikacji.

Właściwości zestawu danych

Aby uzyskać pełną listę sekcji i właściwości dostępnych do definiowania zestawów danych, zobacz Zestawy danych i połączone usługi. Poniższa sekcja zawiera listę właściwości obsługiwanych przez zestaw danych tabeli SAP.

Example

{
    "name": "SharePointOnlineListDataset",
    "properties":
    {
        "type": "SharePointOnlineListResource",
        "linkedServiceName": {
            "referenceName": "<SharePoint Online List linked service name>",
            "type": "LinkedServiceReference"
        },
        "typeProperties":
        {
            "listName": "<name of the list>"
        }
    }
}

Właściwości działania kopiowania

Aby uzyskać pełną listę sekcji i właściwości dostępnych do definiowania działań, zobacz Pipelines (Potoki). Poniższa sekcja zawiera listę właściwości obsługiwanych przez źródło listy usługi SharePoint Online.

Lista usługi SharePoint Online jako źródło

Aby skopiować dane z listy usługi SharePoint Online, w sekcji Źródło działania kopiowania są obsługiwane następujące właściwości:

Example

"activities":[
    {
        "name": "CopyFromSharePointOnlineList",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<SharePoint Online List input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "SharePointOnlineListSource",
                "query": "<OData query e.g. $top=10&$select=Title,Number>"
            }, 
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Mapowanie typów danych dla listy usługi SharePoint Online

Podczas kopiowania danych z listy usługi SharePoint Online następujące mapowania są używane między typami danych listy usługi SharePoint Online i tymczasowymi typami danych używanymi przez usługę wewnętrznie.

Kopiowanie pliku z usługi SharePoint Online

Plik z usługi SharePoint Online można skopiować przy użyciu działania sieci Web, aby uwierzytelnić i pobrać token dostępu z usługi SPO, a następnie przekazać do kolejnych działanie Kopiuj, aby skopiować dane za pomocą łącznika HTTP jako źródła.

1. Postępuj zgodnie z sekcją Udzielanie uprawnień do korzystania z klucza jednostki usługi, aby utworzyć aplikację Firmy Microsoft Entra i udzielić uprawnień do usługi SharePoint Online.

2. Utwórz działanie sieci Web, aby uzyskać token dostępu z usługi SharePoint Online:

   • Adres URL: https://accounts.accesscontrol.windows.net/[Tenant-ID]/tokens/OAuth/2. Zastąp identyfikator dzierżawy.
   • , metoda: POST
   • Headers:
     • Content-Type: application/x-www-form-urlencoded
   • Treść: grant_type=client_credentials&client_id=[Client-ID]@[Tenant-ID]&client_secret=[Client-Secret]&resource=00000003-0000-0ff1-ce00-000000000000/[Tenant-Name].sharepoint.com@[Tenant-ID]. Zastąp identyfikator klienta (identyfikator aplikacji), klucz tajny klienta (klucz aplikacji), identyfikator dzierżawy i nazwę dzierżawy (dzierżawy programu SharePoint).

   Caution

   Ustaw opcję Bezpieczne dane wyjściowe na wartość true w działaniu sieci Web, aby uniemożliwić logowanie wartości tokenu w postaci zwykłego tekstu. Wszelkie dalsze działania, które używają tej wartości, powinny mieć ustawioną opcję Secure Input na wartość true.

3. Utwórz łańcuch z działanie Kopiuj z łącznikiem HTTP jako źródłem, aby skopiować zawartość pliku usługi SharePoint Online:

   • Połączona usługa HTTP:
     • Podstawowy adres URL: https://[site-url]/_api/web/GetFileByServerRelativeUrl('[relative-path-to-file]')/$value. Zastąp adres URL witryny i ścieżkę względną do pliku. Pamiętaj, aby uwzględnić adres URL witryny programu SharePoint wraz z nazwą domeny, taką jak https://[sharepoint-domain-name].sharepoint.com/sites/[sharepoint-site]/_api/web/GetFileByServerRelativeUrl('/sites/[sharepoint-site]/[relative-path-to-file]')/$value.
     • Typ uwierzytelniania: Anonimowy (aby użyć tokenu elementu nośnego skonfigurowanego w źródle działania kopiowania później)
   • Zestaw danych: wybierz odpowiedni format. Aby skopiować plik w stanie rzeczywistym, wybierz typ "Binary".
   • źródło działanie Kopiuj:
     • Metoda żądania: GET
     • Dodatkowy nagłówek: użyj następującego wyrażenia@{concat('Authorization: Bearer ', activity('<Web-activity-name>').output.access_token)}, które używa tokenu elementu nośnego wygenerowanego przez nadrzędne działanie sieci Web jako nagłówek autoryzacji. Zastąp nazwę działania sieci Web.
   • Skonfiguruj ujście działania kopiowania dla dowolnego obsługiwanego miejsca docelowego ujścia.

Właściwości działania wyszukiwania

Aby dowiedzieć się więcej o właściwościach, sprawdź działanie Wyszukiwania.

Treści powiązane

Aby uzyskać listę magazynów danych obsługiwanych przez działanie kopiowania jako źródła i ujścia, zobacz Obsługiwane magazyny danych i formaty.