Azure Data Factory または Azure Synapse Analytics を使用して Xero からデータをコピーする

適用対象: Azure Data Factory Azure Synapse Analytics

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

サポートされる機能

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

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

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

具体的には、この Xero コネクタは以下をサポートします。

• OAuth 2.0 および OAuth 1.0 認証。 OAuth 1.0 の場合、コネクタでは Xero のプライベート アプリケーションはサポートされますが、パブリック アプリケーションはサポートされていません。
• "Reports" を除くすべて Xero テーブル (API エンドポイント)。

作業の開始

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

• データ コピー ツール
• Azure ポータル
• .NET SDK
• Python SDK
• Azure PowerShell
• REST API
• Azure Resource Manager テンプレート

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

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

1. Azure Data Factory または Synapse ワークスペースの [管理] タブに移動し、[リンクされたサービス] を選択して、[新規] をクリックします。

   • Azure Data Factory
   • Azure Synapse

   

2. Xero を検索し、Xero コネクタを選択します。

   

3. サービスの詳細を構成し、接続をテストして、新しいリンク サービスを作成します。

   

コネクタの構成の詳細

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

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

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

例:OAuth 2.0 認証

{
    "name": "XeroLinkedService",
    "properties": {
        "type": "Xero",
        "typeProperties": {
            "connectionProperties": { 
                "host": "api.xero.com",
                "authenticationType":"OAuth_2.0", 
                "consumerKey": {
                    "type": "SecureString",
                    "value": "<client ID>"
                },
                "privateKey": {
                    "type": "SecureString",
                    "value": "<client secret>"
                },
                "tenantId": "<tenant ID>", 
                "refreshToken": {
                    "type": "SecureString",
                    "value": "<refresh token>"
                }, 
                "useEncryptedEndpoints": true, 
                "useHostVerification": true, 
                "usePeerVerification": true
            }            
        }
    }
}

例:OAuth 1.0 認証

{
    "name": "XeroLinkedService",
    "properties": {
        "type": "Xero",
        "typeProperties": {
            "connectionProperties": {
                "host": "api.xero.com", 
                "authenticationType":"OAuth_1.0", 
                "consumerKey": {
                    "type": "SecureString",
                    "value": "<consumer key>"
                },
                "privateKey": {
                    "type": "SecureString",
                    "value": "<private key>"
                }, 
                "useEncryptedEndpoints": true,
                "useHostVerification": true,
                "usePeerVerification": true
            }
        }
    }
}

サンプル秘密キー値:

Unix の改行文字 (\n) も含め、.pem ファイルのすべてのテキストを含めます。

"-----BEGIN RSA PRIVATE KEY-----\nMII***************************************************P\nbu****************************************************s\nU/****************************************************B\nA*****************************************************W\njH****************************************************e\nsx*****************************************************l\nq******************************************************X\nh*****************************************************i\nd*****************************************************s\nA*****************************************************dsfb\nN*****************************************************M\np*****************************************************Ly\nK*****************************************************Y=\n-----END RSA PRIVATE KEY-----"

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

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

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

例

{
    "name": "XeroDataset",
    "properties": {
        "type": "XeroObject",
        "typeProperties": {},
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<Xero linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

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

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

ソースとしての Xero

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

例:

"activities":[
    {
        "name": "CopyFromXero",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<Xero input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "XeroSource",
                "query": "SELECT * FROM Contacts"
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Xero クエリを指定する際には、次の点に注意してください。

• 複雑な項目を含むテーブルは、複数のテーブルに分割されます。 たとえば、銀行トランザクションには複雑なデータ構造 "LineItems" が含まれるため、銀行トランザクションのデータはテーブル Bank_Transaction および Bank_Transaction_Line_Items にマップされ、それらをリンクするための外部キーとして Bank_Transaction_ID が使用されます。

• Xero データは 2 つのスキーマを通じて使用できます。Minimal (既定) と Complete です。 Complete スキーマには、目的のクエリを実行する前に追加データ (例: ID 列) を必要とする、前提条件呼び出しテーブルが含まれます。

次のテーブルは、Minimal スキーマと Complete スキーマで同じ情報を持ちます。 API 呼び出しの数を減らすには、Minimal スキーマ (既定) を使用します。

• Bank_Transactions
• Contact_Groups
• 連絡先
• Contacts_Sales_Tracking_Categories
• Contacts_Phones
• Contacts_Addresses
• Contacts_Purchases_Tracking_Categories
• Credit_Notes
• Credit_Notes_Allocations
• Expense_Claims
• Expense_Claim_Validation_Errors
• Invoices
• Invoices_Credit_Notes
• Invoices_ Prepayments
• Invoices_Overpayments
• Manual_Journals
• Overpayments
• Overpayments_Allocations
• Prepayments
• Prepayments_Allocations
• Receipts
• Receipt_Validation_Errors
• Tracking_Categories

次のテーブルは、Complete スキーマでのみ照会できます。

• Complete.Bank_Transaction_Line_Items
• Complete.Bank_Transaction_Line_Item_Tracking
• Complete.Contact_Group_Contacts
• Complete.Contacts_Contact_ Persons
• Complete.Credit_Note_Line_Items
• Complete.Credit_Notes_Line_Items_Tracking
• Complete.Expense_Claim_ Payments
• Complete.Expense_Claim_Receipts
• Complete.Invoice_Line_Items
• Complete.Invoices_Line_Items_Tracking
• Complete.Manual_Journal_Lines
• Complete.Manual_Journal_Line_Tracking
• Complete.Overpayment_Line_Items
• Complete.Overpayment_Line_Items_Tracking
• Complete.Prepayment_Line_Items
• Complete.Prepayment_Line_Item_Tracking
• Complete.Receipt_Line_Items
• Complete.Receipt_Line_Item_Tracking
• Complete.Tracking_Category_Options

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

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

関連するコンテンツ

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