Copiar dados do Zoho usando Azure Data Factory (versão prévia)Copy data from Zoho using Azure Data Factory (Preview)

APLICA-SE A: Azure Data Factory Azure Synapse Analytics

Este artigo descreve como usar a atividade de cópia no Azure Data Factory para copiar dados de e para o Zoho.This article outlines how to use the Copy Activity in Azure Data Factory to copy data from Zoho. Ele amplia o artigo Visão geral da atividade de cópia que apresenta uma visão geral da atividade de cópia.It builds on the copy activity overview article that presents a general overview of copy activity.

Importante

Atualmente, esse conector está em versão prévia.This connector is currently in preview. Você pode experimentá-lo e oferecer comentários.You can try it out and give us feedback. Se você quiser uma dependência de conectores em versão prévia em sua solução, entre em contato com suporte do Azure.If you want to take a dependency on preview connectors in your solution, please contact Azure support.

Funcionalidades com suporteSupported capabilities

Este conector do Zoho tem suporte para as seguintes atividades:This Zoho connector is supported for the following activities:

Você pode copiar dados do Zoho para qualquer armazenamento de dados de coletor com suporte.You can copy data from Zoho to any supported sink data store. Para obter uma lista de armazenamentos de dados com suporte como origens/coletores da atividade de cópia, confira a tabela Armazenamentos de dados com suporte.For a list of data stores that are supported as sources/sinks by the copy activity, see the Supported data stores table.

Este conector dá suporte à autenticação de token de acesso Xero e à autenticação OAuth 2,0.This connector supports Xero access token authentication and OAuth 2.0 authentication.

Azure Data Factory fornece um driver interno para habilitar a conectividade, portanto, não é necessário instalar manualmente qualquer driver usando esse conector.Azure Data Factory provides a built-in driver to enable connectivity, therefore you don't need to manually install any driver using this connector.

IntroduçãoGetting started

Para executar a atividade de Cópia com um pipeline, será possível usar as ferramentas ou os SDKs abaixo:To perform the Copy activity with a pipeline, you can use one of the following tools or SDKs:

As seções a seguir fornecem detalhes sobre as propriedades usadas para definir entidades do Data Factory específicas ao conector do Zoho.The following sections provide details about properties that are used to define Data Factory entities specific to Zoho connector.

Propriedades do serviço vinculadoLinked service properties

As propriedades a seguir têm suporte para o serviço vinculado do Zoho:The following properties are supported for Zoho linked service:

PropriedadeProperty DescriçãoDescription ObrigatórioRequired
typetype A propriedade type deve ser definida como: ZohoThe type property must be set to: Zoho SimYes
connectionPropertiesconnectionProperties Um grupo de propriedades que define como se conectar ao Zoho.A group of properties that defines how to connect to Zoho. SimYes
Em connectionProperties :Under connectionProperties:
endpointendpoint O endpoint do servidor do Zoho (crm.zoho.com/crm/private).The endpoint of the Zoho server (crm.zoho.com/crm/private). SimYes
authenticationTypeauthenticationType Os valores permitidos são OAuth_2.0 e Access Token .Allowed values are OAuth_2.0 and Access Token. SimYes
clientIdclientId A ID do cliente associada ao aplicativo Zoho.The client ID associated with your Zoho application. Sim para autenticação OAuth 2,0Yes for OAuth 2.0 authentication
clientSecrectclientSecrect O clientsecret associado ao seu aplicativo Zoho.The clientsecret associated with your Zoho application. Marque este campo como uma SecureString para armazená-la com segurança no Data Factory ou faça referência a um segredo armazenado no 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. Sim para autenticação OAuth 2,0Yes for OAuth 2.0 authentication
refreshTokenrefreshToken O token de atualização do OAuth 2,0 associado ao aplicativo Zoho, usado para atualizar o token de acesso quando ele expirar.The OAuth 2.0 refresh token associated with your Zoho application, used to refresh the access token when it expires. O token de atualização nunca expirará.Refresh token will never expire. Para obter um token de atualização, você deve solicitar o offline access_type, saiba mais neste artigo.To get a refresh token, you must request the offline access_type, learn more from this article.
Marque este campo como uma SecureString para armazená-la com segurança no Data Factory ou faça referência a um segredo armazenado no 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.
Sim para autenticação OAuth 2,0Yes for OAuth 2.0 authentication
accessTokenaccessToken O token de acesso para autenticação Zoho.The access token for Zoho authentication. Marque este campo como uma SecureString para armazená-la com segurança no Data Factory ou faça referência a um segredo armazenado no 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. SimYes
useEncryptedEndpointsuseEncryptedEndpoints Especifica se os endpoints de fonte de dados são criptografados usando HTTPS.Specifies whether the data source endpoints are encrypted using HTTPS. O valor padrão é true.The default value is true. NãoNo
useHostVerificationuseHostVerification Especifica se deve ser necessário o nome do host no certificado do servidor para corresponder ao nome do host do servidor ao se conectar via TLS.Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over TLS. O valor padrão é true.The default value is true. NãoNo
usePeerVerificationusePeerVerification Especifica se a identidade do servidor deve ser verificada ao se conectar via TLS.Specifies whether to verify the identity of the server when connecting over TLS. O valor padrão é true.The default value is true. NãoNo

Exemplo: Autenticação OAuth 2,0Example: OAuth 2.0 authentication

{
    "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 acessoExample: access token authentication

{
    "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 dadosDataset properties

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.For a full list of sections and properties available for defining datasets, see the datasets article. Esta seção fornece uma lista das propriedades com suporte pelo conjunto de dados do Zoho.This section provides a list of properties supported by Zoho dataset.

Para copiar dados do Zoho, defina a propriedade type do conjunto de dados como ZohoObject.To copy data from Zoho, set the type property of the dataset to ZohoObject. Há suporte para as seguintes propriedades:The following properties are supported:

PropriedadeProperty DescriçãoDescription ObrigatórioRequired
typetype A propriedade Type do conjunto de conjuntos deve ser definida como: ZohoObjectThe type property of the dataset must be set to: ZohoObject SimYes
tableNametableName Nome da tabela.Name of the table. Não (se "query" na fonte da atividade for especificada)No (if "query" in activity source is specified)

ExemploExample

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

Propriedades da atividade de cópiaCopy activity properties

Para obter uma lista completa das seções e propriedades disponíveis para definir atividades, confia o artigo Pipelines.For a full list of sections and properties available for defining activities, see the Pipelines article. Esta seção fornece uma lista das propriedades com suporte pela origem do Zoho.This section provides a list of properties supported by Zoho source.

Zoho como origemZoho as source

Para copiar dados de Zoho, defina o tipo de fonte na atividade de cópia como ZohoSource.To copy data from Zoho, set the source type in the copy activity to ZohoSource. As propriedades a seguir têm suporte na seção source da atividade de cópia:The following properties are supported in the copy activity source section:

PropriedadeProperty DescriçãoDescription ObrigatórioRequired
typetype A propriedade type da fonte da atividade de cópia deve ser definida como: ZohoSourceThe type property of the copy activity source must be set to: ZohoSource SimYes
Consultaquery Utiliza a consulta SQL personalizada para ler os dados.Use the custom SQL query to read data. Por exemplo: "SELECT * FROM Accounts".For example: "SELECT * FROM Accounts". Não (se "tableName" no conjunto de dados for especificado)No (if "tableName" in dataset is specified)

Exemplo:Example:

"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 atividadeLookup activity properties

Para saber detalhes sobre as propriedades, verifique Pesquisar atividade.To learn details about the properties, check Lookup activity.

Próximas etapasNext steps

Para obter uma lista de armazenamentos de dados com suporte como origens e coletores pela atividade de cópia no Azure Data Factory, consulte Armazenamentos de dados com suporte.For a list of data stores supported as sources and sinks by the copy activity in Azure Data Factory, see supported data stores.