使用 Azure 数据工厂(预览版)从 HubSpot 复制数据Copy data from HubSpot using Azure Data Factory (Preview)

本文概述了如何使用 Azure 数据工厂中的复制活动从 HubSpot 复制数据。This article outlines how to use the Copy Activity in Azure Data Factory to copy data from HubSpot. 它是基于概述复制活动总体的复制活动概述一文。It builds on the copy activity overview article that presents a general overview of copy activity.

Important

此连接器目前提供预览版。This connector is currently in preview. 欢迎试用并提供反馈。You can try it out and give us feedback. 若要在解决方案中使用预览版连接器的依赖项,请联系 Azure 客户支持If you want to take a dependency on preview connectors in your solution, please contact Azure support.

支持的功能Supported capabilities

以下活动支持此 HubSpot 连接器:This HubSpot connector is supported for the following activities:

可以将数据从 HubSpot 复制到任何支持的接收器数据存储。You can copy data from HubSpot to any supported sink data store. 有关复制活动支持作为源/接收器的数据存储列表,请参阅支持的数据存储表。For a list of data stores that are supported as sources/sinks by the copy activity, see the Supported data stores table.

Azure 数据工厂提供内置的驱动程序用于启用连接,因此无需使用此连接器手动安装任何驱动程序。Azure Data Factory provides a built-in driver to enable connectivity, therefore you don't need to manually install any driver using this connector.

入门Getting started

可以通过以下工具或 SDK 之一结合使用复制活动和管道。You can use one of the following tools or SDKs to use the copy activity with a pipeline. 选择链接,查看分步说明:Select a link for step-by-step instructions:

对于特定于 HubSpot 连接器的数据工厂实体,以下部分提供有关用于定义这些实体的属性的详细信息。The following sections provide details about properties that are used to define Data Factory entities specific to HubSpot connector.

链接服务属性Linked service properties

HubSpot 链接服务支持以下属性:The following properties are supported for HubSpot linked service:

属性Property 说明Description 必选Required
typetype type 属性必须设置为:Hubspot The type property must be set to: Hubspot Yes
clientIdclientId 与 Hubspot 应用程序关联的客户端 ID。The client ID associated with your Hubspot application. Yes
clientSecretclientSecret 与 Hubspot 应用程序关联的客户端密码。The client secret associated with your Hubspot application. 将此字段标记为 SecureString 以安全地将其存储在数据工厂中或引用存储在 Azure Key Vault 中的机密Mark this field as a SecureString to store it securely in Data Factory, or reference a secret stored in Azure Key Vault. Yes
accessTokenaccessToken 最初进行 OAuth 集成身份验证时获得的访问令牌。The access token obtained when initially authenticating your OAuth integration. 将此字段标记为 SecureString 以安全地将其存储在数据工厂中或引用存储在 Azure Key Vault 中的机密Mark this field as a SecureString to store it securely in Data Factory, or reference a secret stored in Azure Key Vault. Yes
refreshTokenrefreshToken 最初进行 OAuth 集成身份验证时获得的刷新令牌。The refresh token obtained when initially authenticating your OAuth integration. 将此字段标记为 SecureString 以安全地将其存储在数据工厂中或引用存储在 Azure Key Vault 中的机密Mark this field as a SecureString to store it securely in Data Factory, or reference a secret stored in Azure Key Vault. Yes
useEncryptedEndpointsuseEncryptedEndpoints 指定是否使用 HTTPS 加密数据源终结点。Specifies whether the data source endpoints are encrypted using HTTPS. 默认值为 true。The default value is true. No
useHostVerificationuseHostVerification 指定通过 SSL 连接时是否需要服务器证书中的主机名匹配服务器的主机名。Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. 默认值为 true。The default value is true. No
usePeerVerificationusePeerVerification 指定通过 SSL 连接时是否要验证服务器的标识。Specifies whether to verify the identity of the server when connecting over SSL. 默认值为 true。The default value is true. No

示例:Example:

{
    "name": "HubspotLinkedService",
    "properties": {
        "type": "Hubspot",
        "typeProperties": {
            "clientId" : "<clientId>",
            "clientSecret": {
                "type": "SecureString",
                "value": "<clientSecret>"
            },
            "accessToken": {
                "type": "SecureString",
                "value": "<accessToken>"
            },
            "refreshToken": {
                "type": "SecureString",
                "value": "<refreshToken>"
            }
        }
    }
}

数据集属性Dataset properties

有关可用于定义数据集的各部分和属性的完整列表,请参阅数据集一文。For a full list of sections and properties available for defining datasets, see the datasets article. 本部分提供 HubSpot 数据集支持的属性列表。This section provides a list of properties supported by HubSpot dataset.

要从 HubSpot 复制数据,请将数据集的 type 属性设置为“HubspotObject” 。To copy data from HubSpot, set the type property of the dataset to HubspotObject. 支持以下属性:The following properties are supported:

属性Property 说明Description 必选Required
typetype 数据集的 type 属性必须设置为:HubspotObject The type property of the dataset must be set to: HubspotObject Yes
tableNametableName 表名称。Name of the table. 否(如果指定了活动源中的“query”)No (if "query" in activity source is specified)

示例Example

{
    "name": "HubspotDataset",
    "properties": {
        "type": "HubspotObject",
        "typeProperties": {},
        "schema": [],        
        "linkedServiceName": {
            "referenceName": "<Hubspot linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

复制活动属性Copy activity properties

有关可用于定义活动的各部分和属性的完整列表,请参阅管道一文。For a full list of sections and properties available for defining activities, see the Pipelines article. 本部分提供 HubSpot 数据源支持的属性列表。This section provides a list of properties supported by HubSpot source.

以 HubspotSource 作为源HubspotSource as source

要从 HubSpot 复制数据,请将复制活动中的源类型设置为“HubspotSource” 。To copy data from HubSpot, set the source type in the copy activity to HubspotSource. 复制活动source部分支持以下属性:The following properties are supported in the copy activity source section:

属性Property 说明Description 必选Required
typetype 复制活动源的 type 属性必须设置为:HubspotSource The type property of the copy activity source must be set to: HubspotSource Yes
queryquery 使用自定义 SQL 查询读取数据。Use the custom SQL query to read data. 例如:"SELECT * FROM Companies where Company_Id = xxx"For example: "SELECT * FROM Companies where Company_Id = xxx". 否(如果指定了数据集中的“tableName”)No (if "tableName" in dataset is specified)

示例:Example:

"activities":[
    {
        "name": "CopyFromHubspot",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<Hubspot input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "HubspotSource",
                "query": "SELECT * FROM Companies where Company_Id = xxx"
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Lookup 活动属性Lookup activity properties

若要了解有关属性的详细信息,请查看 Lookup 活动To learn details about the properties, check Lookup activity.

后续步骤Next steps

有关 Azure 数据工厂中复制活动支持作为源和接收器的数据存储的列表,请参阅支持的数据存储For a list of data stores supported as sources and sinks by the copy activity in Azure Data Factory, see supported data stores.