Azure Data Factory または Azure Synapse Analytics を使用して Zoho からデータをコピーする (プレビュー)

[アーティクル]
10/20/2023

適用対象: Azure Data Factory Azure Synapse Analytics

ヒント

企業向けのオールインワン分析ソリューション、Microsoft Fabric の Data Factory をお試しください。 Microsoft Fabric は、データ移動からデータサイエンス、リアルタイム分析、ビジネスインテリジェンス、レポートまで、あらゆるものをカバーしています。無料で新しい試用版を開始する方法について説明します。

この記事では、Azure Data Factory および Azure Synapse Analytics パイプラインで Copy アクティビティを使用して、Zoho からデータをコピーする方法について説明します。この記事は、コピーアクティビティの概要を示しているコピーアクティビティの概要に関する記事に基づいています。

重要

このコネクタは、現在プレビューの段階です。実際にお試しいただき、フィードバックをお寄せください。ソリューションでプレビュー版コネクタの依存関係を取得したい場合、Azure サポートにお問い合わせください。

サポートされる機能

この Zoho コネクタでは、次の機能がサポートされます。

サポートされる機能	IR
Copy アクティビティ (ソース/-)	1.1
Lookup アクティビティ	1.1

① Azure 統合ランタイム ② セルフホステッド統合ランタイム

ソースおよびシンクとしてサポートされているデータストアの一覧については、「サポートされているデータストア」の表を参照してください。

このコネクタでは、Xero アクセストークン認証と OAuth 2.0 認証がサポートされています。

このサービスでは接続を有効にする組み込みのドライバーが提供されるので、このコネクタを使用してドライバーを手動でインストールする必要はありません。

作業の開始

パイプラインでコピーアクティビティを実行するには、次のいずれかのツールまたは SDK を使用します。

UI を使用して Zoho のリンクサービスを作成する

次の手順を使用して、Azure portal UI で Zoho のリンクサービスを作成します。

Azure Data Factory または Synapse ワークスペースの [管理] タブに移動し、[リンクされたサービス] を選択して、[新規] をクリックします。
- Azure Data Factory
- Azure Synapse
Zoho を検索し、Zoho コネクタを選択します。
サービスの詳細を構成し、接続をテストして、新しいリンクサービスを作成します。

コネクタの構成の詳細

次のセクションでは、Zoho コネクタに固有の Data Factory エンティティの定義に使用されるプロパティについて詳しく説明します。

リンクされたサービスのプロパティ

Zoho のリンクされたサービスでは、次のプロパティがサポートされます。

プロパティ	Description	必須
type	type プロパティは、次のように設定する必要があります:Zoho	はい
connectionProperties	Zoho への接続方法を定義するプロパティのグループ。	はい
`connectionProperties` の下:
endpoint	Zoho サーバーのエンドポイント (`crm.zoho.com/crm/private`)。	はい
authenticationType	使用できる値は `OAuth_2.0` と `Access Token` です。	はい
clientId	Zoho アプリケーションに関連付けられているクライアント ID。	はい (OAuth 2.0 認証の場合)
clientSecrect	Zoho アプリケーションに関連付けられているクライアントシークレット。このフィールドを SecureString とマークして安全に保存するか、Azure Key Vault に保存されているシークレットを参照します。	OAuth 2.0 認証の場合、はい
refreshToken	Zoho アプリケーションに関連付けられている OAuth 2.0 更新トークン。アクセストークンの有効期限切れ時にその更新のために使用されます。更新トークンは期限切れになりません。更新トークンを取得するには、`offline` access_type を要求する必要があります。詳細については、こちら記事を参照してください。このフィールドを SecureString とマークして安全に保存するか、Azure Key Vault に保存されているシークレットを参照します。	はい (OAuth 2.0 認証の場合)
accessToken	Zoho 認証のアクセストークン。このフィールドを SecureString とマークして安全に保存するか、Azure Key Vault に保存されているシークレットを参照します。	はい
useEncryptedEndpoints	データソースのエンドポイントが HTTPS を使用して暗号化されるかどうかを指定します。既定値は、true です。	いいえ
useHostVerification	TLS 経由で接続するときに、サーバーの証明書内のホスト名がサーバーのホスト名と一致する必要があるかどうか指定します。既定値は、true です。	いいえ
usePeerVerification	TLS 経由で接続するときに、サーバーの ID を検証するかどうかを指定します。既定値は、true です。	いいえ

例:OAuth 2.0 認証

{
    "name": "ZohoLinkedService",
    "properties": {
        "type": "Zoho",
        "typeProperties": {
            "connectionProperties": { 
                "authenticationType":"OAuth_2.0", 
                "endpoint": "crm.zoho.com/crm/private", 
                "clientId": "<client ID>", 
                "clientSecrect": {
                    "type": "SecureString",
                    "value": "<client secret>"
                },
                "accessToken": {
                    "type": "SecureString",
                    "value": "<access token>"
                }, 
                "refreshToken": {
                    "type": "SecureString",
                    "value": "<refresh token>"
                }, 
                "useEncryptedEndpoints": true,
                "useHostVerification": true, 
                "usePeerVerification": true
            }
        }
    }
}

例: アクセストークン認証

{
    "name": "ZohoLinkedService",
    "properties": {
        "type": "Zoho",
        "typeProperties": {
            "connectionProperties": { 
                "authenticationType":"Access Token", 
                "endpoint": "crm.zoho.com/crm/private", 
                "accessToken": {
                    "type": "SecureString",
                    "value": "<access token>"
                }, 
                "useEncryptedEndpoints": true, 
                "useHostVerification": true, 
                "usePeerVerification": true
            }
        }
    }
}

データセットのプロパティ

データセットを定義するために使用できるセクションとプロパティの完全な一覧については、データセットに関する記事をご覧ください。このセクションでは、Zoho データセットでサポートされるプロパティの一覧を示します。

Zoho からデータをコピーするには、データセットの type プロパティを ZohoObject に設定します。次のプロパティがサポートされています。

プロパティ	Description	必須
type	データセットの type プロパティは、次のように設定する必要があります:ZohoObject	はい
tableName	テーブルの名前。	いいえ (アクティビティソースの "query" が指定されている場合)

例

{
    "name": "ZohoDataset",
    "properties": {
        "type": "ZohoObject",
        "typeProperties": {},
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<Zoho linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

コピーアクティビティのプロパティ

アクティビティの定義に利用できるセクションとプロパティの完全な一覧については、パイプラインに関する記事を参照してください。このセクションでは、Zoho ソースでサポートされるプロパティの一覧を示します。

ソースとしての Zoho

Zoho からデータをコピーするは、コピーアクティビティのソースの種類を ZohoSource に設定します。コピーアクティビティの source セクションでは、次のプロパティがサポートされます。

プロパティ	Description	必須
type	コピーアクティビティのソースの type プロパティは、次のように設定する必要があります:ZohoSource	はい
query	カスタム SQL クエリを使用してデータを読み取ります。 (例: `"SELECT * FROM Accounts"`)。	いいえ (データセットの "tableName" が指定されている場合)

例:

"activities":[
    {
        "name": "CopyFromZoho",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<Zoho input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "ZohoSource",
                "query": "SELECT * FROM Accounts"
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Lookup アクティビティのプロパティ

プロパティの詳細については、Lookup アクティビティに関するページを参照してください。

Copy アクティビティでソースおよびシンクとしてサポートされるデータストアの一覧については、サポートされるデータストアに関するセクションを参照してください。