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

  • Artikel

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. Microsoft Fabric deckt alle Aufgaben ab, 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

Dieser Connector befindet sich derzeit in der Vorschauversion. Sie können ihn ausprobieren und uns Feedback geben. Wenden Sie sich an den Azure-Support, wenn Sie in Ihrer Lösung eine Abhängigkeit von Connectors verwenden möchten, die sich in der Vorschauphase befinden.

Hinweis

Derzeit unterstützt dieser Connector keine Sandboxkonten.

Unterstützte Funktionen

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

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

① Azure Integration Runtime ② Selbstgehostete Integration Runtime

Eine Liste der Datenspeicher, die als Quellen/Senken unterstützt werden, finden Sie in der Tabelle Unterstützte Datenspeicher.

Der Dienst enthält einen integrierten Treiber zum Herstellen der Konnektivität. Daher müssen Sie keinen Treiber manuell installieren, wenn dieser Connector verwendet wird.

Erste Schritte

Sie können eines der folgenden Tools oder SDKs verwenden, um die Kopieraktivität mit einer Pipeline zu 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 of the Square connector.

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

    Screenshot of linked service configuration for Square.

Details zur Connector-Konfiguration

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

Folgende Eigenschaften werden für den mit Square verknüpften Dienst unterstützt:

Eigenschaft Beschreibung Erforderlich
type Die type-Eigenschaft muss auf Folgendes festgelegt werden: Square 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.		 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

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.

Beispiel:

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

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. Nein (wenn „query“ 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 Folgendes festgelegt werden: SquareSource Ja
Abfrage Verwendet die benutzerdefinierte SQL-Abfrage zum Lesen von Daten. Beispiel: "SELECT * FROM Business". Nein (wenn „tableName“ im Dataset angegeben ist)

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

Eigenschaften der Lookup-Aktivität

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

Zugehöriger Inhalt

Eine Liste der Datenspeicher, die als Quelles und Senken für die Kopieraktivität unterstützt werden, finden Sie in der Dokumentation für Unterstützte Datenspeicher.