Copiar dados do Zoho usando o Azure Data Factory ou o Synapse Analytics (versão prévia)

Artigo
12/09/2023

APLICA-SE A: Azure Data Factory Azure Synapse Analytics

Dica

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

Este artigo descreve como usar a atividade de cópia nos pipelines do Azure Data Factory ou do Azure Synapse Analytics para copiar dados de uma tabela do Zoho. Ele amplia o artigo Visão geral da atividade de cópia que apresenta uma visão geral da atividade de cópia.

Importante

Atualmente, esse conector está em versão prévia. Você pode experimentá-lo e oferecer comentários. Se você quiser uma dependência de conectores em versão prévia em sua solução, entre em contato com suporte do Azure.

Funcionalidades com suporte

Este conector Zoho é compatível com as seguintes funcionalidades:

Funcionalidades com suporte	IR
Atividade de cópia (origem/-)	6/6
Atividade de pesquisa	6/6

① Runtime de integração do Azure ② Runtime de integração auto-hospedada

Para obter uma lista de armazenamentos de dados com suporte como origens e coletores, confira a tabela Armazenamentos de dados com suporte.

Esse conector dá suporte à autenticação de token de acesso do Xero e à autenticação OAuth 2.0.

O serviço fornece um driver interno para habilitar a conectividade, portanto, não é necessário instalar manualmente qualquer driver usando esse conector.

Introdução

Para executar a atividade de Cópia com um pipeline, será possível usar as ferramentas ou os SDKs abaixo:

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

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

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

Detalhes da configuração do conector

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

Propriedades do serviço vinculado

As propriedades a seguir têm suporte para o serviço vinculado do Zoho:

Propriedade	Descrição	Obrigatório
type	A propriedade type deve ser definida como: Zoho	Sim
connectionProperties	Um grupo de propriedades que define como se conectar ao Zoho.	Sim
Em `connectionProperties`:
endpoint	O endpoint do servidor do Zoho (`crm.zoho.com/crm/private`).	Sim
authenticationType	Os valores permitidos são `OAuth_2.0` e `Access Token`.	Sim
clientId	A ID de cliente associada 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 referencie um segredo armazenado no Azure Key Vault.	Sim para autenticação OAuth 2.0
refreshToken	O token de atualização do 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 referencie um segredo armazenado no Azure Key Vault.	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 referencie um segredo armazenado no Azure Key Vault.	Sim
useEncryptedEndpoints	Especifica se os endpoints de fonte de dados são criptografados usando HTTPS. O valor padrão é true.	Não
useHostVerification	Especifica se o nome do host no certificado do servidor precisa ser igual ao nome do host do servidor nas conexões por TLS. O valor padrão é true.	Não
usePeerVerification	Especifica se a identidade do servidor deve ser verificada nas conexões por TLS. O valor padrão é 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 das seções e propriedades disponíveis para definir os conjuntos de dados, confira o artigo sobre conjuntos de dados. Esta seção fornece uma lista das propriedades com suporte pelo conjunto de dados do Zoho.

Para copiar dados do Zoho, defina a propriedade type do conjunto de dados como ZohoObject. Há suporte para as seguintes propriedades:

Propriedade	Descrição	Obrigatório
type	A propriedade de tipo do conjunto de dados deve ser definido para: ZohoObject	Sim
tableName	Nome da tabela.	Não (se "query" na fonte da atividade for especificada)

Exemplo

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

Propriedades da atividade de cópia

Para obter uma lista completa das seções e propriedades disponíveis para definir atividades, confia o artigo Pipelines. Esta seção fornece uma lista das propriedades com suporte pela origem do Zoho.

Zoho como origem

Para copiar dados de Zoho, defina o tipo de fonte na atividade de cópia como ZohoSource. As propriedades a seguir têm suporte na seção source da atividade de cópia:

Propriedade	Descrição	Obrigatório
type	A propriedade type da fonte da atividade de cópia deve ser definida como: ZohoSource	Sim
Consulta	Utiliza a consulta SQL personalizada para ler os 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>"
            }
        }
    }
]

Pesquisar propriedades de atividade

Para saber detalhes sobre as propriedades, verifique Pesquisar atividade.

Para obter uma lista de armazenamentos de dados com suporte como coletores e fontes da atividade de cópia, confira os armazenamentos de dados com suporte.