Freigeben über


Kopieren von Daten aus Square mithilfe von Azure Data Factory oder Synapse Analytics

GILT FÜR: Azure Data Factory Azure Synapse Analytics

Tipp

Testen Sie Data Factory in Microsoft Fabric, eine All-in-One-Analyselösung für Unternehmen. In Microsoft Fabric können Sie alle erforderlichen Aufgaben ausführen, von der Datenverschiebung bis hin zu Data Science, Echtzeitanalysen, Business Intelligence und Berichterstellung. Erfahren Sie, wie Sie kostenlos eine neue Testversion starten!

In diesem Artikel wird beschrieben, wie Sie die Copy-Aktivität in Azure Data Factory- oder Azure Synapse Analytics-Pipelines verwenden, um Daten aus Square zu kopieren. Er baut auf dem Artikel zur Übersicht über die Kopieraktivität auf, der eine allgemeine Übersicht über die Kopieraktivität enthält.

Wichtig

Die Square-Connector-Version 1.0 befindet sich in der Außerbetriebnahmephase. Sie werden empfohlen, den Square-Connector von Version 1.0 auf 2.0 zu aktualisieren.

Unterstützte Funktionen

Dieser Square-Anschluss wird für die folgenden Funktionen unterstützt:

Unterstützte Funktionen IR
Kopieraktivität (Quelle/-) (1) (2)
Lookup-Aktivität (1) (2)

① Azure Integration Runtime ② Selbstgehostete Integration Runtime

Eine Liste der als Quellen/Senken unterstützten Datenspeicher finden Sie in der Tabelle Unterstützte Datenspeicher.

Der Dienst bietet einen eingebauten Treiber, um die Verbindung zu ermöglichen, so dass Sie keinen Treiber manuell installieren müssen.

Der Connector unterstützt die Windows-Versionen in diesem Artikel.

Voraussetzungen

Wenn sich Ihr Datenspeicher in einem lokalen Netzwerk, in einem virtuellen Azure-Netzwerk oder in einer virtuellen privaten Amazon-Cloud befindet, müssen Sie eine selbstgehostete Integration Runtime konfigurieren, um eine Verbindung herzustellen.

Handelt es sich bei Ihrem Datenspeicher um einen verwalteten Clouddatendienst, können Sie die Azure Integration Runtime verwenden. Ist der Zugriff auf IP-Adressen beschränkt, die in den Firewallregeln genehmigt sind, können Sie Azure Integration Runtime-IPs zur Positivliste hinzufügen.

Sie können auch das Feature managed virtual network integration runtime (Integration Runtime für verwaltete virtuelle Netzwerke) in Azure Data Factory verwenden, um auf das lokale Netzwerk zuzugreifen, ohne eine selbstgehostete Integration Runtime zu installieren und zu konfigurieren.

Weitere Informationen zu den von Data Factory unterstützten Netzwerksicherheitsmechanismen und -optionen finden Sie unter "Datenzugriffsstrategien".

Hinweis

Version 2.0 wird mit der selbst gehosteten Integrationslaufzeit version 5.56.0.0 oder höher unterstützt.

Erste Schritte

Zum Ausführen der Kopieraktivität mit einer Pipeline können Sie eines der folgenden Tools oder SDKs verwenden:

Erstellen eines verknüpften Diensts für Square über die Benutzeroberfläche

Führen Sie die folgenden Schritte aus, um über die Benutzeroberfläche des Azure-Portals einen verknüpften Dienst für Square zu erstellen.

  1. Navigieren Sie in Ihrem Azure Data Factory- oder Synapse-Arbeitsbereich zur Registerkarte „Verwalten“, wählen Sie „Verknüpfte Dienste“ aus, und klicken Sie dann auf „Neu“:

  2. Suchen Sie nach Square, und wählen Sie den Square-Connector aus.

    Screenshot des Square-Connectors

  3. Konfigurieren Sie die Dienstdetails, testen Sie die Verbindung, und erstellen Sie den neuen verknüpften Dienst.

    Screenshot der Konfiguration eines verknüpften Diensts für Square

Details zur Connectorkonfiguration

Die folgenden Abschnitte enthalten Details zu Eigenschaften, die zum Definieren von Data Factory-Entitäten speziell für den Square-Connector verwendet werden.

Eigenschaften des verknüpften Diensts

Der quadratische Verbinder unterstützt jetzt Version 2.0. In diesem Abschnitt erfahren Sie, wie Sie Ihre Square-Connectorversion von Version 1.0 aktualisieren. Einzelheiten zur Eigenschaft finden Sie in den entsprechenden Abschnitten.

Version 2.0

Der gekoppelte Dienst Square unterstützt die folgenden Eigenschaften bei Anwendung der Version 2.0:

Eigenschaft Beschreibung Erforderlich
type Die „type“-Eigenschaft muss auf Square festgelegt werden. Ja
version Die von Ihnen angegebene Version. Der Wert ist 2.0. Ja
host Die URL der Square-Instanz. (mystore.mysquare.com) Ja
clientId Die Client-ID, die Ihrer Square-Anwendung zugeordnet ist. Ja
clientSecret Der geheime Clientschlüssel, der Ihrer Square-Anwendung zugeordnet ist. Markieren Sie dieses Feld als einen „SecureString“, um es sicher zu speichern, oder verweisen Sie auf ein in Azure Key Vault gespeichertes Geheimnis. Ja
accessToken Das von Square erhaltene Zugriffstoken. Gewährt eingeschränkten Zugriff auf ein Square-Konto, indem ein authentifizierter Benutzer um explizite Berechtigungen gebeten wird. OAuth-Zugriffstoken laufen 30 Tage nach der Ausgabe ab, Aktualisierungstoken laufen hingegen nicht ab. Zugriffstoken können durch Aktualisierungstoken aktualisiert werden.
Markieren Sie dieses Feld als einen „SecureString“, um es sicher zu speichern, oder verweisen Sie auf ein in Azure Key Vault gespeichertes Geheimnis. Weitere Informationen zu Zugriffstokentypen finden Sie unter Zugriffstokentypen.
Ja
refreshToken Das von Square erhaltene Aktualisierungstoken. Wird zum Abrufen neuer Zugriffstoken verwendet, wenn die aktuellen ablaufen.
Markieren Sie dieses Feld als „SecureString“, um es sicher zu speichern, oder verweisen Sie auf ein in Azure Key Vault gespeichertes Geheimnis.
Nein
connectVia Die Integrationslaufzeit, die zum Herstellen einer Verbindung mit dem Datenspeicher verwendet werden muss. Wenn keine Option angegeben ist, wird die standardmäßige Azure Integration Runtime verwendet. Sie können die selbstgehostete Integration Runtime (mindestens Version 5.56.0.0) verwenden. Nein

Beispiel:

{
    "name": "SquareLinkedService",
    "properties": {
        "type": "Square",
        "version": "2.0",
        "typeProperties": {
            "host": "<e.g. mystore.mysquare.com>", 
            "clientId": "<client ID>", 
            "clientSecret": {
                "type": "SecureString",
                "value": "<clientSecret>"
            }, 
            "accessToken": {
                "type": "SecureString",
                "value": "<access token>"
            }, 
            "refreshToken": {
                "type": "SecureString",
                "value": "<refresh token>"
            }
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

Version 1.0

Der verknüpfte Square-Dienst unterstützt die folgenden Eigenschaften bei Version 1.0:

Eigenschaft Beschreibung Erforderlich
type Die „type“-Eigenschaft muss auf Square festgelegt werden. Ja
connectionProperties Eine Gruppe von Eigenschaften zum Definieren, wie eine Verbindung mit Square hergestellt werden soll. Ja
Unter connectionProperties:
host Die URL der Square-Instanz. (mystore.mysquare.com) Ja
clientId Die Client-ID, die Ihrer Square-Anwendung zugeordnet ist. Ja
clientSecret Der geheime Clientschlüssel, der Ihrer Square-Anwendung zugeordnet ist. Markieren Sie dieses Feld als einen „SecureString“, um es sicher zu speichern, oder verweisen Sie auf ein in Azure Key Vault gespeichertes Geheimnis. Ja
accessToken Das von Square erhaltene Zugriffstoken. Gewährt eingeschränkten Zugriff auf ein Square-Konto, indem ein authentifizierter Benutzer um explizite Berechtigungen gebeten wird. OAuth-Zugriffstoken laufen 30 Tage nach der Ausgabe ab, Aktualisierungstoken laufen hingegen nicht ab. Zugriffstoken können durch Aktualisierungstoken aktualisiert werden.
Markieren Sie dieses Feld als einen „SecureString“, um es sicher zu speichern, oder verweisen Sie auf ein in Azure Key Vault gespeichertes Geheimnis. Weitere Informationen zu Zugriffstokentypen finden Sie unter Zugriffstokentypen.
Ja
refreshToken Das von Square erhaltene Aktualisierungstoken. Wird zum Abrufen neuer Zugriffstoken verwendet, wenn die aktuellen ablaufen.
Markieren Sie dieses Feld als „SecureString“, um es sicher zu speichern, oder verweisen Sie auf ein in Azure Key Vault gespeichertes Geheimnis.
Nein
useEncryptedEndpoints Gibt an, ob die Endpunkte der Datenquelle mit HTTPS verschlüsselt sind. Der Standardwert lautet „true“. Nein
useHostVerification Gibt an, ob der Hostname im Zertifikat des Servers mit dem Hostnamen des Servers übereinstimmen muss, wenn eine Verbindung über TLS hergestellt wird. Der Standardwert lautet „true“. Nein
usePeerVerification Gibt an, ob die Identität des Servers überprüft werden soll, wenn eine Verbindung über TLS hergestellt wird. Der Standardwert lautet „true“. Nein
connectVia Die Integrationslaufzeit, die zum Herstellen einer Verbindung mit dem Datenspeicher verwendet werden muss. Wenn keine Option angegeben ist, wird die standardmäßige Azure Integration Runtime verwendet. Nein

Beispiel:

{
    "name": "SquareLinkedService",
    "properties": {
        "type": "Square",
        "typeProperties": {
            "connectionProperties": {
                "host": "<e.g. mystore.mysquare.com>", 
                "clientId": "<client ID>", 
                "clientSecret": {
                    "type": "SecureString",
                    "value": "<clientSecret>"
                }, 
                "accessToken": {
                    "type": "SecureString",
                    "value": "<access token>"
                }, 
                "refreshToken": {
                    "type": "SecureString",
                    "value": "<refresh token>"
                }, 
                "useEncryptedEndpoints": true, 
                "useHostVerification": true, 
                "usePeerVerification": true 
            }
        }
    }
}

Zugriffstokentypen

Square unterstützt zwei Arten von Zugriffstoken: persönlich und OAuth.

  • Persönliche Zugriffstoken werden verwendet, um unbegrenzten Connect-API-Zugriff auf Ressourcen in Ihrem eigenen Square-Konto zu erhalten.

  • OAuth-Zugriffstoken werden verwendet, um authentifizierten und bereichsbezogenen Connect-API-Zugriff auf ein beliebiges Square-Konto zu erhalten. Verwenden Sie diese, wenn Ihre App im Namen der Kontobesitzer auf Ressourcen in anderen Square-Konten zugreift. OAuth-Zugriffstoken können auch für den Zugriff auf Ressourcen in Ihrem eigenen Square-Konto verwendet werden.

    Wichtig

    Zum Ausführen der Testverbindung im verknüpften Dienst ist es erforderlich, MERCHANT_PROFILE_READ ein bereichsbezogenes OAuth-Zugriffstoken abzurufen. Informationen zum Zugriff auf andere Tabellen finden Sie unter Square OAuth-Berechtigungsreferenz.

Für die Authentifizierung über das persönliche Zugriffstoken ist nur accessToken erforderlich, während für die Authentifizierung über OAuth accessToken und refreshToken benötigt werden. Hier erfahren Sie, wie Sie Zugriffstoken abrufen.

Dataset-Eigenschaften

Eine vollständige Liste mit den Abschnitten und Eigenschaften, die zum Definieren von Datasets zur Verfügung stehen, finden Sie im Artikel zu Datasets. Dieser Abschnitt enthält eine Liste der Eigenschaften, die vom Square-Dataset unterstützt werden.

Legen Sie zum Kopieren von Daten aus Square die „type“-Eigenschaft des Datasets auf SquareObject fest. Folgende Eigenschaften werden unterstützt:

Eigenschaft Beschreibung Erforderlich
type Die type-Eigenschaft des Datasets muss auf folgenden Wert festgelegt werden: SquareObject. Ja
tableName Der Name der Tabelle. Ja für Version 2.0.
Nein für Version 1.0 (wenn "Abfrage" in der Aktivitätsquelle angegeben ist)

Beispiel

{
    "name": "SquareDataset",
    "properties": {
        "type": "SquareObject",
        "typeProperties": {},
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<Square linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

Eigenschaften der Kopieraktivität

Eine vollständige Liste mit den Abschnitten und Eigenschaften zum Definieren von Aktivitäten finden Sie im Artikel Pipelines. Dieser Abschnitt enthält eine Liste der Eigenschaften, die von der Square-Quelle unterstützt werden.

Square als Quelle

Legen Sie zum Kopieren von Daten aus Square den Quellentyp in der Kopieraktivität auf SquareSourceSource fest. Folgende Eigenschaften werden im Abschnitt source der Kopieraktivität unterstützt:

Eigenschaft Beschreibung Erforderlich
type Die „type“-Eigenschaft der Quelle der Kopieraktivität muss auf SquareSource festgelegt werden. Ja
Abfrage Verwendet die benutzerdefinierte SQL-Abfrage zum Lesen von Daten. Beispiel: "SELECT * FROM Business". Nein (wenn „tableName“ im Dataset angegeben ist)

Hinweis

query wird in Version 2.0 nicht unterstützt.

Beispiel:

"activities":[
    {
        "name": "CopyFromSquare",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<Square input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "SquareSource",
                "query": "SELECT * FROM Business"
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Datentypzuordnung für Square

Beim Kopieren von Daten aus Square gelten die folgenden Zuordnungen von Square-Datentypen zu den vom Dienst verwendeten internen Datentypen. Informationen dazu, wie die Kopieraktivität das Quellschema und den Datentyp der Spüle zuordnet, finden Sie unter Schema- und Datentypzuordnungen.

Square-Datentyp Zwischendienstdatentyp (für Version 2.0) Zwischendienstdatentyp (für Version 1.0)
String String String
Integer Int32 Int32
Lang Int64 Int64
Boolean Boolean Boolean
Datum String Nicht unterstützt.
Zeitstempel String Nicht unterstützt.
Zeitstempel mit Offset String Nicht unterstützt.
Dauer (vollständig) String String
Dauer (nur Zeit) String String
Geld Int64 Int64

Eigenschaften der Lookup-Aktivität

Ausführliche Informationen zu den Eigenschaften finden Sie unter Lookup-Aktivität.

Connectorlebenszyklus und -upgrade für Square

Die folgende Tabelle zeigt die Releasestufe und Änderungsprotokolle für verschiedene Versionen des Square-Connectors:

Version Freigabestufe Änderungsprotokoll
Version 1.0 Entfernt Nicht zutreffend.
Version 2.0 Allgemeine Verfügbarkeit • Die selbstgehostete Integration Runtime sollte mindestens Version 5.56.0.0 sein.

• Datum, Zeitstempel und Zeitstempel mit Offset werden als String-Datentyp gelesen.

useEncryptedEndpoints, useHostVerification, usePeerVerification werden im verknüpften Dienst nicht unterstützt.

query wird nicht unterstützt.

Aktualisieren des quadratischen Connectors von Version 1.0 auf Version 2.0

  1. Wählen Sie auf der Seite "Verknüpften Dienst bearbeiten " 2.0 für die Version aus. Weitere Informationen finden Sie in den Eigenschaften der verknüpften Dienstversion 2.0.

  2. Die Zuordnung der Datentypen für die Version 2.0 des verknüpften Dienstes von Square unterscheidet sich von der Zuordnung für die Version 1.0. Informationen zur neuesten Datentypzuordnung finden Sie unter Datentypzuordnung für Square.

  3. Richten Sie eine selbstgehostete Integration Runtime mit Version 5.56.0.0 oder höher ein.

  4. query wird nur in Version 1.0 unterstützt. Sie sollten in Version 2.0 tableName anstelle von query verwenden.

Eine Liste der Datenspeicher, die als Quellen und Senken für die Copy-Aktivität unterstützt werden, finden Sie in der Dokumentation zu unterstützten Datenspeichern.