Gegevens kopiëren van Square met behulp van Azure Data Factory of Synapse Analytics

VAN TOEPASSING OP: Azure Data Factory Azure Synapse Analytics

Tip

Probeer Data Factory uit in Microsoft Fabric, een alles-in-één analyseoplossing voor ondernemingen. Microsoft Fabric omvat alles, van gegevensverplaatsing tot gegevenswetenschap, realtime analyses, business intelligence en rapportage. Meer informatie over het gratis starten van een nieuwe proefversie .

In dit artikel wordt beschreven hoe u de kopieeractiviteit gebruikt in een Azure Data Factory- of Synapse Analytics-pijplijn om gegevens van Square te kopiëren. Het is gebaseerd op het artikel over het overzicht van kopieeractiviteiten met een algemeen overzicht van de kopieeractiviteit.

Belangrijk

De Square connector versie 1.0 bevindt zich in de verwijderingsfase. U wordt aangeraden om de Square-connector te upgraden van versie 1.0 naar 2.0.

Ondersteunde mogelijkheden

Deze vierkante connector wordt ondersteund voor de volgende mogelijkheden:

Ondersteunde mogelijkheden	IR
Copy-activiteit (bron/-)	(1) (2)
Activiteit Lookup	(1) (2)

(1) Azure Integration Runtime (2) Zelf-hostende Integration Runtime

Zie de tabel Ondersteunde gegevensarchieven voor een lijst met gegevensarchieven die worden ondersteund als bronnen/sinks.

De service biedt een ingebouwd stuurprogramma om connectiviteit in te schakelen, daarom hoeft u geen stuurprogramma handmatig te installeren met behulp van deze connector.

De connector ondersteunt de Windows-versies in dit artikel.

Vereiste voorwaarden

Als uw gegevensarchief zich in een on-premises netwerk, een virtueel Azure-netwerk of een virtuele particuliere cloud van Amazon bevindt, moet u een zelf-hostende Integration Runtime configureren om er verbinding mee te maken.

Als uw gegevensarchief een beheerde cloudgegevensservice is, kunt u De Azure Integration Runtime gebruiken. Als de toegang is beperkt tot IP-adressen die zijn goedgekeurd in de firewallregels, kunt u IP-adressen van Azure Integration Runtime toevoegen aan de acceptatielijst.

U kunt ook de beheerde functie voor integratieruntime voor virtuele netwerken in Azure Data Factory gebruiken om toegang te krijgen tot het on-premises netwerk zonder een zelf-hostende Integration Runtime te installeren en te configureren.

Zie Strategieën voor gegevenstoegang voor meer informatie over de netwerkbeveiligingsmechanismen en -opties die door Data Factory worden ondersteund.

Notitie

Versie 2.0 wordt ondersteund met de zelf-hostende Integration Runtime versie 5.56.0.0 of hoger.

Aan de slag

Als u de kopieeractiviteit wilt uitvoeren met een pijplijn, kunt u een van de volgende hulpprogramma's of SDK's gebruiken:

• Tool Gegevens kopiëren
• Azure-portal
• .NET SDK
• Python SDK
• Azure PowerShell
• REST API
• Azure Resource Manager-sjabloon

Een gekoppelde service maken met Square met behulp van de gebruikersinterface

Gebruik de volgende stappen om een gekoppelde service te maken naar Square in de gebruikersinterface van Azure Portal.

1. Blader naar het tabblad Beheren in uw Azure Data Factory- of Synapse-werkruimte en selecteer Gekoppelde services en klik vervolgens op Nieuw:

   Azure Data Factory

   

   Azure Synapse

   

2. Zoek naar Square en selecteer de vierkante verbindingslijn.

   

3. Configureer de servicedetails, test de verbinding en maak de nieuwe gekoppelde service.

   

Configuratiedetails van connector

De volgende secties bevatten details over eigenschappen die worden gebruikt voor het definiëren van Data Factory-entiteiten die specifiek zijn voor square-connector.

Eigenschappen van gekoppelde service

De Square-connector ondersteunt nu versie 2.0. Raadpleeg deze sectie om de versie van uw Square-connector te upgraden vanaf versie 1.0. Raadpleeg de desbetreffende secties voor de details van de eigendom.

• Versie 2.0
• versie 1.0

Versie 2.0

De gekoppelde service Square ondersteunt de volgende eigenschappen wanneer versie 2.0 wordt toegepast:

Eigenschappen	Beschrijving	Vereist
type	De eigenschap type moet worden ingesteld op: Vierkant	Ja
version	De versie die je opgeeft. De waarde is 2.0.	Ja
host	De URL van het vierkante exemplaar. (dat wil mystore.mysquare.com)	Ja
clientId	De client-id die is gekoppeld aan uw Square-toepassing.	Ja
clientSecret	Het clientgeheim dat is gekoppeld aan uw Square-toepassing. Markeer dit veld als SecureString om het veilig op te slaan of verwijs naar een geheim dat is opgeslagen in Azure Key Vault.	Ja
accessToken	Het toegangstoken dat is verkregen van Square. Verleent beperkte toegang tot een Square-account door een geverifieerde gebruiker om expliciete machtigingen te vragen. OAuth-toegangstokens verlopen 30 dagen nadat ze zijn uitgegeven, maar vernieuwingstokens verlopen niet. Toegangstokens kunnen worden vernieuwd door een vernieuwingstoken. Markeer dit veld als SecureString om het veilig op te slaan of verwijs naar een geheim dat is opgeslagen in Azure Key Vault. Zie Toegangstokentypen voor meer informatie over typen toegangstokens.	Ja
refreshToken	Het vernieuwingstoken dat is verkregen van Square. Wordt gebruikt om nieuwe toegangstokens te verkrijgen wanneer de huidige is verlopen. Markeer dit veld als SecureString om het veilig op te slaan of verwijs naar een geheim dat is opgeslagen in Azure Key Vault.	Nee
connectVia	De Integration Runtime die gebruikt moet worden om verbinding te maken met de datastore. Als dit niet is opgegeven, wordt de standaard Azure Integration Runtime gebruikt. U kunt de zelf-hostende Integration Runtime gebruiken en de bijbehorende versie moet 5.56.0.0 of hoger zijn.	Nee

Voorbeeld:

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

Versie 1.0

De gekoppelde service Square ondersteunt de volgende eigenschappen wanneer versie 1.0 wordt toegepast:

Eigenschappen	Beschrijving	Vereist
type	De eigenschap type moet worden ingesteld op: Vierkant	Ja
connectionProperties	Een groep eigenschappen die definieert hoe u verbinding maakt met Square.	Ja
Onder connectionProperties:
host	De URL van het vierkante exemplaar. (dat wil mystore.mysquare.com)	Ja
clientId	De client-id die is gekoppeld aan uw Square-toepassing.	Ja
clientSecret	Het clientgeheim dat is gekoppeld aan uw Square-toepassing. Markeer dit veld als SecureString om het veilig op te slaan of verwijs naar een geheim dat is opgeslagen in Azure Key Vault.	Ja
accessToken	Het toegangstoken dat is verkregen van Square. Verleent beperkte toegang tot een Square-account door een geverifieerde gebruiker om expliciete machtigingen te vragen. OAuth-toegangstokens verlopen 30 dagen nadat ze zijn uitgegeven, maar vernieuwingstokens verlopen niet. Toegangstokens kunnen worden vernieuwd door een vernieuwingstoken. Markeer dit veld als SecureString om het veilig op te slaan of verwijs naar een geheim dat is opgeslagen in Azure Key Vault. Zie Toegangstokentypen voor meer informatie over typen toegangstokens.	Ja
refreshToken	Het vernieuwingstoken dat is verkregen van Square. Wordt gebruikt om nieuwe toegangstokens te verkrijgen wanneer de huidige is verlopen. Markeer dit veld als SecureString om het veilig op te slaan of verwijs naar een geheim dat is opgeslagen in Azure Key Vault.	Nee
useEncryptedEndpoints	Hiermee geeft u op of de eindpunten van de gegevensbron zijn versleuteld met HTTPS. De standaardwaarde is waar.	Nee
useHostVerification	Hiermee geeft u op of de hostnaam in het certificaat van de server moet overeenkomen met de hostnaam van de server wanneer u verbinding maakt via TLS. De standaardwaarde is waar.	Nee
usePeerVerification	Hiermee geeft u op of de identiteit van de server moet worden gecontroleerd bij het maken van verbinding via TLS. De standaardwaarde is waar.	Nee
connectVia	De Integration Runtime die gebruikt moet worden om verbinding te maken met de datastore. Als dit niet is opgegeven, wordt de standaard Azure Integration Runtime gebruikt.	Nee

Voorbeeld:

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

Typen toegangstokens

Square ondersteunt twee typen toegangstokens: persoonlijk en OAuth.

• Persoonlijke toegangstokens worden gebruikt om onbeperkte Connect API-toegang te krijgen tot resources in uw eigen Square-account.

• OAuth-toegangstokens worden gebruikt om geverifieerde en scoped Connect API-toegang te krijgen tot elk Square-account. Gebruik deze wanneer uw app namens accounteigenaren toegang heeft tot resources in andere Square-accounts. OAuth-toegangstokens kunnen ook worden gebruikt voor toegang tot resources in uw eigen Square-account.

  Belangrijk

  Als u de verbinding Testen in de gekoppelde service wilt uitvoeren, MERCHANT_PROFILE_READ moet u een bereik van een OAuth-toegangstoken ophalen. Zie De naslaginformatie over square OAuth-machtigingen voor machtigingen voor toegang tot andere tabellen.

Verificatie via persoonlijk toegangstoken heeft alleen nodig accessToken, terwijl verificatie via OAuth vereist is accessToken en refreshToken. Meer informatie over het ophalen van toegangstokens hier.

Eigenschappen van gegevensset

Zie het artikel gegevenssets voor een volledige lijst met secties en eigenschappen die beschikbaar zijn voor het definiëren van gegevenssets . Deze sectie bevat een lijst met eigenschappen die worden ondersteund door de Square-gegevensset.

Als u gegevens van Square wilt kopiëren, stelt u de typeeigenschap van de gegevensset in op SquareObject. De volgende eigenschappen worden ondersteund:

Eigenschappen	Beschrijving	Vereist
type	De typeeigenschap van de gegevensset moet zijn ingesteld op: SquareObject	Ja
tableName	Naam van de tabel.	Ja voor versie 2.0. Nee voor versie 1.0 (als 'query' in de activiteitsbron is opgegeven)

Voorbeeld

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

Eigenschappen van de kopieeractiviteit

Zie het artikel Pijplijnen voor een volledige lijst met secties en eigenschappen die beschikbaar zijn voor het definiëren van activiteiten. Deze sectie bevat een lijst met eigenschappen die worden ondersteund door square source.

Vierkant als bron

Als u gegevens van Square wilt kopiëren, stelt u het brontype in de kopieeractiviteit in op SquareSource. De volgende eigenschappen worden ondersteund in de sectie bron van kopieeractiviteit:

Eigenschappen	Beschrijving	Vereist
type	De typeeigenschap van de bron van de kopieeractiviteit moet worden ingesteld op: SquareSource	Ja
query	Gebruik de aangepaste SQL-query om gegevens te lezen. Voorbeeld: "SELECT * FROM Business".	Nee (als 'tableName' in de gegevensset is opgegeven)

Notitie

query wordt niet ondersteund in versie 2.0.

Voorbeeld:

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

Toewijzing van gegevenstypen voor Square

Wanneer u gegevens kopieert uit Square, zijn de volgende toewijzingen van de gegevenstypen van Square van toepassing op de interne gegevenstypen die door de service worden gebruikt. Zie Schema- en gegevenstypetoewijzingen voor meer informatie over hoe de kopieeractiviteit het bronschema en het gegevenstype toewijst aan de sink.

Vierkant gegevenstype	Tussentijds servicedatatype (voor versie 2.0)	Interim service-gegevenssoort (voor versie 1.0)
String	String	String
Integer	Int32	Int32
Long	Int64	Int64
Booleaan	Booleaan	Booleaan
Datum	String	Wordt niet ondersteund.
Tijdstempel	String	Wordt niet ondersteund.
Tijdstempel met offset	String	Wordt niet ondersteund.
Duur (vol)	String	String
Duur (alleen tijd)	String	String
Geld	Int64	Int64

Eigenschappen van opzoekactiviteit

Als u meer wilt weten over de eigenschappen, controleert u de lookup-activiteit.

Levenscyclus en upgrade van vierkante connector

In de volgende tabel ziet u de releasefase en wijzigingslogboeken voor verschillende versies van de Square-connector:

Versie	Releasefase	Wijzigingslogboek
Versie 1.0	Removed	Niet van toepassing.
Versie 2.0	Algemene beschikbaarheid	• De zelf-hostende Integration Runtime-versie moet 5.56.0.0 of hoger zijn. • Datum, tijdstempel en tijdstempel met offset worden gelezen als gegevenstype Tekenreeks. • useEncryptedEndpoints, useHostVerificationworden usePeerVerification niet ondersteund in de gekoppelde service. • query wordt niet ondersteund.

De Square-connector upgraden van versie 1.0 naar versie 2.0

1. Selecteer op de pagina Gekoppelde service bewerken 2.0 voor versie. Zie de eigenschappen van gekoppelde serviceversie 2.0 voor meer informatie.

2. De toewijzing van het gegevenstype voor de gekoppelde Square-service versie 2.0 verschilt van die voor versie 1.0. Zie Gegevenstypetoewijzing voor Square voor meer informatie over de meest recente toewijzing van gegevenstypen.

3. Pas een zelf-hostende Integration Runtime toe met versie 5.56.0.0 of hoger.

4. query wordt alleen ondersteund in versie 1.0. U moet de tableName in plaats van query in versie 2.0 gebruiken.

Gerelateerde inhoud

Zie ondersteunde gegevensarchieven voor een lijst met gegevensarchieven die worden ondersteund als bronnen en sinks door de kopieeractiviteit.