Copiar dados do Zoho usando o Azure Data Factory ou o Synapse Analytics (Visualização)

Artigo
11/16/2023

APLICA-SE A: Azure Data Factory Azure Synapse Analytics

Gorjeta

Experimente o Data Factory no Microsoft Fabric, uma solução de análise tudo-em-um para empresas. O Microsoft Fabric abrange tudo, desde a movimentação de dados até ciência de dados, análises em tempo real, business intelligence e relatórios. Saiba como iniciar uma nova avaliação gratuitamente!

Este artigo descreve como usar a Atividade de Cópia em um pipeline do Azure Data Factory ou do Synapse Analytics para copiar dados da Zoho. Ele se baseia no artigo de visão geral da atividade de cópia que apresenta uma visão geral da atividade de cópia.

Importante

Este conector está atualmente em pré-visualização. Você pode experimentá-lo e nos dar feedback. Se quiser realizar uma dependência em conectores de pré-visualização na sua solução, contacte o Suporte do Azure.

Capacidades suportadas

Este conector Zoho é suportado para os seguintes recursos:

Capacidades suportadas	IR
Atividade de cópia (fonte/-)	① ②
Atividade de Pesquisa	① ②

(1) Tempo de execução de integração do Azure (2) Tempo de execução de integração auto-hospedado

Para obter uma lista de armazenamentos de dados suportados como fontes/coletores, consulte a tabela Armazenamentos de dados suportados.

Este conector suporta autenticação de token de acesso Xero e autenticação OAuth 2.0.

O serviço fornece um driver interno para habilitar a conectividade, portanto, você não precisa instalar manualmente nenhum driver usando esse conector.

Introdução

Para executar a atividade Copiar com um pipeline, você pode usar uma das seguintes ferramentas ou SDKs:

Criar um serviço vinculado ao Zoho usando a interface do usuário

Use as etapas a seguir para criar um serviço vinculado à Zoho na interface do usuário do portal do Azure.

Navegue até a guia Gerenciar em seu espaço de trabalho do Azure Data Factory ou Synapse e selecione Serviços Vinculados e clique em Novo:
- Fábrica de Dados do Azure
- Azure Synapse
Procure Zoho e selecione o conector Zoho.
Configure os detalhes do serviço, teste a conexão e crie o novo serviço vinculado.

Detalhes de configuração do conector

As seções a seguir fornecem detalhes sobre as propriedades usadas para definir entidades do Data Factory específicas para o Zoho Connector.

Propriedades do serviço vinculado

As seguintes propriedades são suportadas para o serviço vinculado Zoho:

Propriedade	Descrição	Necessário
tipo	A propriedade type deve ser definida como: Zoho	Sim
connectionProperties	Um grupo de propriedades que define como se conectar à Zoho.	Sim
Em `connectionProperties`:
endpoint	O ponto de extremidade do servidor Zoho (`crm.zoho.com/crm/private`).	Sim
authenticationType	Os valores permitidos são `OAuth_2.0` e `Access Token`.	Sim
clientId	O ID do cliente associado ao seu aplicativo Zoho.	Sim para autenticação OAuth 2.0
clientSecrect	O clientsecret associado ao seu aplicativo Zoho. Marque este campo como um SecureString para armazená-lo com segurança ou faça referência a um segredo armazenado no Cofre de Chaves do Azure.	Sim para autenticação OAuth 2.0
refreshToken	O token de atualização OAuth 2.0 associado ao seu aplicativo Zoho, usado para atualizar o token de acesso quando ele expira. O token de atualização nunca expirará. Para obter um token de atualização, você deve solicitar o `offline` access_type, saiba mais neste artigo. Marque este campo como um SecureString para armazená-lo com segurança ou faça referência a um segredo armazenado no Cofre de Chaves do Azure.	Sim para autenticação OAuth 2.0
accessToken	O token de acesso para autenticação Zoho. Marque este campo como um SecureString para armazená-lo com segurança ou faça referência a um segredo armazenado no Cofre de Chaves do Azure.	Sim
useEncryptedEndpoints	Especifica se os pontos de extremidade da fonte de dados são criptografados usando HTTPS. O valor predefinido é true.	Não
useHostVerification	Especifica se o nome do host no certificado do servidor deve corresponder ao nome do host do servidor ao se conectar por TLS. O valor predefinido é true.	Não
usePeerVerification	Especifica se a identidade do servidor deve ser verificada ao se conectar por TLS. O valor predefinido é true.	Não

Exemplo: autenticação 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
            }
        }
    }
}

Exemplo: autenticação de token de acesso

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

Propriedades do conjunto de dados

Para obter uma lista completa de seções e propriedades disponíveis para definir conjuntos de dados, consulte o artigo sobre conjuntos de dados. Esta seção fornece uma lista de propriedades suportadas pelo conjunto de dados Zoho.

Para copiar dados da Zoho, defina a propriedade type do conjunto de dados como ZohoObject. As seguintes propriedades são suportadas:

Propriedade	Descrição	Necessário
tipo	A propriedade type do conjunto de dados deve ser definida como: ZohoObject	Sim
tableName	Nome da tabela.	Não (se "consulta" na fonte da atividade for especificado)

Exemplo

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

Propriedades da atividade Copy

Para obter uma lista completa de seções e propriedades disponíveis para definir atividades, consulte o artigo Pipelines . Esta seção fornece uma lista de propriedades suportadas pelo Zoho Source.

Zoho como fonte

Para copiar dados da Zoho, defina o tipo de origem na atividade de cópia como ZohoSource. As seguintes propriedades são suportadas na seção de origem da atividade de cópia:

Propriedade	Descrição	Necessário
tipo	A propriedade type da fonte de atividade de cópia deve ser definida como: ZohoSource	Sim
query	Use a consulta SQL personalizada para ler dados. Por exemplo: `"SELECT * FROM Accounts"`.	Não (se "tableName" no conjunto de dados for especificado)

Exemplo:

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

Propriedades da atividade de pesquisa

Para saber detalhes sobre as propriedades, verifique Atividade de pesquisa.

Para obter uma lista de armazenamentos de dados suportados como fontes e coletores pela atividade de cópia, consulte Armazenamentos de dados suportados.