Copiar dados do QuickBooks Online 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 do QuickBooks Online. 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 QuickBooks é suportado para as seguintes capacidades:

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 QuickBooks OAuth 2.0.

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 QuickBooks usando a interface do usuário

Use as etapas a seguir para criar um serviço vinculado ao QuickBooks 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 QuickBooks e selecione o conector QuickBooks.
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 conector QuickBooks.

Propriedades do serviço vinculado

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

Propriedade	Descrição	Necessário
tipo	A propriedade type deve ser definida como: QuickBooks	Sim
connectionProperties	Um grupo de propriedades que define como se conectar ao QuickBooks.	Sim
Em `connectionProperties`:
endpoint	O ponto de extremidade do servidor QuickBooks Online. (ou seja, quickbooks.api.intuit.com)	Sim
identificação da empresa	O ID da empresa da empresa QuickBooks a autorizar. Para obter informações sobre como encontrar o ID da empresa, consulte Como encontrar o ID da empresa.	Sim
consumerKey [en]	A ID do cliente do seu aplicativo QuickBooks Online para autenticação OAuth 2.0. Saiba mais aqui.	Sim
consumidorSegredo	O segredo do cliente do seu aplicativo QuickBooks Online para autenticação OAuth 2.0. 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
refreshToken	O token de atualização OAuth 2.0 associado ao aplicativo QuickBooks. Saiba mais aqui. O token de atualização da nota expirará após 180 dias. O cliente precisa atualizar regularmente o token de atualização. 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

Exemplo:

{
    "name": "QuickBooksLinkedService",
    "properties": {
        "type": "QuickBooks",
        "typeProperties": {
            "connectionProperties": {
                "endpoint": "quickbooks.api.intuit.com",
                "companyId": "<company id>",
                "consumerKey": "<consumer key>", 
                "consumerSecret": {
                     "type": "SecureString",
                     "value": "<clientSecret>"
            	},
                "refreshToken": {
                     "type": "SecureString",
                     "value": "<refresh token>"
            	},
                "useEncryptedEndpoints": 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 QuickBooks.

Para copiar dados do QuickBooks Online, defina a propriedade type do conjunto de dados como QuickBooksObject. As seguintes propriedades são suportadas:

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

Exemplo

{
    "name": "QuickBooksDataset",
    "properties": {
        "type": "QuickBooksObject",
        "typeProperties": {},
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<QuickBooks 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 pela fonte do QuickBooks.

QuickBooks como fonte

Para copiar dados do QuickBooks Online, defina o tipo de origem na atividade de cópia como QuickBooksSource. 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: QuickBooksSource	Sim
query	Use a consulta SQL personalizada para ler dados. Por exemplo: `"SELECT * FROM "Bill" WHERE Id = '123'"`.	Não (se "tableName" no conjunto de dados for especificado)

Exemplo:

"activities":[
    {
        "name": "CopyFromQuickBooks",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<QuickBooks input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "QuickBooksSource",
                "query": "SELECT * FROM \"Bill\" WHERE Id = '123' "
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Copiar dados do Quickbooks Desktop

A atividade de cópia no serviço não pode copiar dados diretamente do Quickbooks Desktop. Para copiar dados do Quickbooks Desktop, exporte seus dados do Quickbooks para um arquivo CSV (valores separados por vírgula) e carregue o arquivo no Armazenamento de Blobs do Azure. A partir daí, você pode usar o serviço para copiar os dados para o coletor de sua escolha.

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.