Копирование данных из Square с помощью Фабрики данных Azure или Synapse Analytics (предварительная версия)

Статья
01/05/2024

Область применения:Фабрика данных Azure Azure Synapse Analytics

Совет

Попробуйте использовать фабрику данных в Microsoft Fabric, решение для аналитики с одним интерфейсом для предприятий. Microsoft Fabric охватывает все, от перемещения данных до обработки и анализа данных в режиме реального времени, бизнес-аналитики и отчетности. Узнайте, как бесплатно запустить новую пробную версию !

В этой статье описывается, как с помощью действия Copy в конвейере Фабрики данных Azure или Synapse Analytics копировать данные из Square. Это продолжение статьи об обзоре действия копирования, в которой представлены общие сведения о действии копирования.

Важно!

Сейчас этот соединитель доступен в режиме предварительной версии. Попробуйте поработать с ним и оставьте свой отзыв. Если вы хотите использовать в своем решении зависимость от соединителей в предварительной версии, обратитесь в службу поддержки Azure.

Примечание.

В настоящее время этот соединитель не поддерживает учетные записи "песочницы".

Поддерживаемые возможности

Этот соединитель Square поддерживает следующие возможности:

Поддерживаемые возможности	IR
Действие копирования (источник/-)	① ②
Действие поиска	① ②

① Среда выполнения интеграции Azure ② Локальная среда выполнения интеграции

Список хранилищ данных, которые поддерживаются в качестве источников/приемников, см. в таблице Поддерживаемые хранилища данных.

Служба предоставляет встроенный драйвер для обеспечения подключения, поэтому вам не нужно вручную устанавливать какой-либо драйвер с помощью этого соединителя.

Начало работы

Чтобы выполнить действие копирования с конвейером, можно воспользоваться одним из приведенных ниже средств или пакетов SDK:

Создание связанной службы для Square с помощью пользовательского интерфейса

Выполните следующие действия, чтобы создать связанную службу для Square с помощью пользовательского интерфейса на портале Azure.

Перейдите на вкладку "Управление" в рабочей области Фабрики данных Azure или Synapse и выберите "Связанные службы", после чего нажмите "Создать":
- Фабрика данных Azure
- Azure Synapse
Найдите Square и выберите соединитель Square.
Настройте сведения о службе, проверьте подключение и создайте связанную службу.

Сведения о конфигурации соединителя

Следующие разделы содержат сведения о свойствах, используемых для определения сущностей фабрики данных, относящихся к соединителю Square.

Свойства связанной службы

Для связанной службы Square поддерживаются следующие свойства:

Свойство	Описание:	Обязательное поле
type	Для свойства type необходимо задать значение Square	Да
connectionProperties	Группа свойств, определяющих способ подключения к Square.	Да
В разделе `connectionProperties`:
host	URL-адрес экземпляра Square. (т. е. mystore.mysquare.com)	Да
clientId	Идентификатор клиента, связанный с приложением Square.	Да
clientSecret	Секрет клиента, связанный с приложением Square. Пометьте это поле как SecureString, чтобы безопасно хранить его, или добавьте ссылку на секрет, хранящийся в Azure Key Vault.	Да
accessToken	Маркер доступа, полученный из Square. Предоставляет ограниченный доступ к учетной записи Square, запрашивая у пользователя, прошедшего проверку подлинности, явные разрешения. Срок действия маркеров доступа OAuth истекает через 30 дней после выдачи, но срок действия маркеров обновления не истекает. Маркеры доступа могут обновляться маркером обновления. Пометьте это поле как SecureString, чтобы безопасно хранить его, или добавьте ссылку на секрет, хранящийся в Azure Key Vault.	Да
refreshtoken	Маркер обновления, полученный из Square. Используется для получения новых маркеров доступа при истечении срока действия текущего. Установите для этого поля метку SecureString для его безопасного хранения или добавьте ссылку на секрет, хранящийся в Azure Key Vault.	No
useEncryptedEndpoints	Указывает, шифруются ли конечные точки источника данных с помощью протокола HTTPS. Значение по умолчанию — true.	No
useHostVerification	Указывает, следует ли требовать, чтобы имя узла в сертификате сервера совпадало с именем узла сервера при подключении по протоколу TLS. Значение по умолчанию — true.	No
usePeerVerification	Указывает, следует ли проверять удостоверение сервера при подключении по протоколу TLS. Значение по умолчанию — true.	No

Square поддерживает два типа маркера доступа: личный и OAuth.

Личные маркеры доступа используются для получения неограниченного доступа через API подключения к ресурсам в своей учетной записи Square.
Маркеры доступа OAuth используются для получения доступа к любой учетной записи Square через API подключения с проверкой подлинности и с заданной областью. Используйте их, когда приложение обращается к ресурсам в других учетных записях Square от имени владельцев учетных записей. Маркеры доступа OAuth также можно использовать для доступа к ресурсам в своей учетной записи Square.

Важно!

Чтобы выполнить тестовое подключение в связанной службе, MERCHANT_PROFILE_READ должен получить маркер доступа OAuth с заданной областью действия. Разрешения на доступ к другим таблицам описаны в справочнике по разрешениям Square OAuth.

Проверка подлинности с помощью личного маркера доступа требует только accessToken, тогда как для проверки подлинности с помощью OAuth необходимы accessToken и refreshToken. Узнайте, как получить маркер доступа, здесь.

Пример:

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

Свойства набора данных

Полный список разделов и свойств, доступных для определения наборов данных, см. в статье о наборах данных. В этом разделе содержится список свойств, поддерживаемых набором данных Square.

Чтобы скопировать данные из Square, установите свойство type набора данных SquareObject. Поддерживаются следующие свойства:

Свойство	Описание:	Обязательное поле
type	Свойство type для набора данных должно иметь значение SquareObject	Да
tableName	Имя таблицы.	Нет (если свойство query указано в источнике действия)

Пример

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

Свойства действия копирования

Полный список разделов и свойств, используемых для определения действий, см. в статье Конвейеры и действия в фабрике данных Azure. В этом разделе содержится список свойств, поддерживаемых источником Square.

Square в качестве источника

Чтобы скопировать данные из Square, задайте тип источника SquareSource в действии копирования. В разделе source действия копирования поддерживаются следующие свойства:

Свойство	Описание:	Обязательное поле
type	Свойство type источника действия копирования должно иметь значение SquareSource	Да
query	Используйте пользовательский SQL-запрос для чтения данных. Например: `"SELECT * FROM Business"`.	Нет (если для набора данных задано свойство tableName)

Пример:

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

Свойства действия поиска

Подробные сведения об этих свойствах см. в разделе Действие поиска.

Список хранилищ данных, которые поддерживаются в качестве источников и приемников для действия Copy, приведен в таблице Поддерживаемые хранилища данных и форматы.