Ir para o conteúdo

Detalhes da Conexão do Microsoft OneDrive

Introdução

Versão do conector

Esta documentação é baseada na versão 21.0.8257 do conector.

Começando

Suporte à versão do OneDrive

As contas OneDrive e OneDrive for Business são suportadas por meio da API do Microsoft Graph v1.0.

Estabelecendo uma Conexão

Conectando-se ao Microsoft OneDrive

Autenticação Usando a Entidade de Serviço do Azure

A Entidade de Serviço do Azure é um tipo de conexão que passa por OAuth. Defina seu AuthScheme para AzureServicePrincipal e consulte Usando a Autenticação Principal de Serviço do Azure para obter um guia de autenticação.

Usando Autenticação OAuth

OAuth requer que o usuário autenticado interaja com o OneDrive usando o navegador. O conector facilita isso de várias maneiras, conforme descrito abaixo.

Credenciais Incorporadas

Consulte Credenciais incorporadas para se conectar com as credenciais incorporadas do conector e pule a criação de um aplicativo OAuth personalizado.

Credenciais Personalizadas

Em vez de se conectar com as credenciais incorporadas do conector, você pode registrar um aplicativo com Custom Credentials para obter o OAuthClientId e OAuthClientSecret.

Quando Criar um Aplicativo OAuth Personalizado

A criação de um aplicativo OAuth personalizado é opcional, pois o conector já está registrado no OneDrive e você pode se conectar com suas credenciais incorporadas. Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem logon no endpoint OneDrive OAuth para conceder permissões ao conector.

Criando um Aplicativo OAuth Personalizado

Consulte Criando um aplicativo OAuth personalizado para um procedimento.

Credenciais Incorporadas

Autenticar Usando as Credenciais OAuth Incorporadas
Autenticação de Desktop com o Aplicativo OAuth Integrado

Você pode se conectar sem definir nenhuma propriedade de conexão para suas credenciais de usuário.

Quando você se conecta, o conector abre o endpoint OAuth em seu navegador padrão. Faça login e conceda permissões ao aplicativo. O conector então conclui o processo OAuth.

  1. Extrai o token de acesso do URL de retorno de chamada e autentica as solicitações.
  2. Obtém um novo token de acesso quando o antigo expira.
  3. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.

Credenciais Personalizadas

Existem dois tipos de autenticação de aplicativo disponíveis: usando um segredo do cliente e usando um certificado. Você pode usar qualquer um deles dependendo da autenticação de aplicativo configurada.

Autenticação de Área de Trabalho com Seu Aplicativo OAuth

Siga as etapas abaixo para autenticar com as credenciais de um aplicativo OAuth personalizado. Consulte Criando um aplicativo OAuth personalizado.

Obtenha um Token de Acesso OAuth

Você está pronto para se conectar após definir um dos grupos de propriedades de conexão abaixo, dependendo do tipo de autenticação.

  1. Authenticating using a Client Secret
    • OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
    • OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.
    • CallbackURL: Defina isso para o URL de redirecionamento nas configurações do aplicativo.
    • AuthScheme: Defina isso como "AzureAD" nas configurações do aplicativo.
    • InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar a repetição da troca OAuth e definir manualmente o OAuthAccessToken..
  2. Authenticating using a Certificate
    • OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
    • OAuthJWTCert: Defina isso para o armazenamento de certificados JWT.
    • OAuthJWTCertType: Defina isso para o tipo de armazenamento de certificado especificado por OAuthJWTCert.
    • CallbackURL: Defina isso para o URL de redirecionamento nas configurações do aplicativo.
    • AuthScheme: Defina isso como "AzureAD" nas configurações do aplicativo.
    • InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken..

Quando você conecta, o conector abre o endpoint OAuth em seu navegador padrão. Faça login e conceda permissões ao aplicativo. O conector então conclui o processo OAuth:

  1. Extrai o token de acesso da URL de retorno de chamada e autentica as solicitações.
  2. Obtém um novo token de acesso quando o antigo expira.
  3. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.

Máquinas Sem Cabeça

Usando OAuth em uma Máquina Sem Cabeça

Para criar fontes de dados do OneDrive em servidores headless ou outras máquinas nas quais o conector não pode abrir um navegador, você precisa autenticar em outra máquina. A autenticação é um processo de duas etapas.

  1. Ao invés de instalar o conector em outra máquina, você pode seguir os passos abaixo para obter o OAuthVerifier valor. Ou você pode instalar o conector em outra máquina e transferir os valores de autenticação OAuth, depois de autenticar por meio do fluxo normal baseado em navegador.
  2. Em seguida, você pode configurar o conector para atualizar automaticamente o token de acesso da máquina sem periféricos.

Você pode seguir o fluxo de autenticação OAuth headless usando as credenciais OAuth incorporadas do conector ou usando as credenciais OAuth para seu aplicativo OAuth personalizado.

Usando as Credenciais para um Aplicativo OAuth Personalizado

Crie um aplicativo OAuth personalizado

Consulte Criando um aplicativo OAuth personalizado para um procedimento. Você pode seguir os procedimentos abaixo para autenticar e conectar-se aos dados.

Obtenha um código verificador

Na máquina sem periféricos, defina um dos seguintes grupos de propriedades, dependendo do tipo de autenticação:

  1. Authenticating using a Client Secret
    • InitiateOAuth: Defina como DESLIGADO.
    • OAuthClientId: Defina isso como o ID do aplicativo nas configurações do aplicativo.
    • OAuthClientSecret: Defina isso como o Segredo do aplicativo nas configurações do aplicativo.
  2. Authenticating using a Certificate
    • InitiateOAuth: Defina como DESLIGADO.
    • OAuthClientId: Defina isso como o ID do aplicativo nas configurações do aplicativo.
    • OAuthJWTCert: Defina isso para o armazenamento de certificados JWT.
    • OAuthJWTCertType: Defina isso para o tipo de armazenamento de certificado especificado por OAuthJWTCert.

Você pode seguir as etapas abaixo para autenticar em outra máquina e obter o OAuthVerifier propriedade de conexão.

  1. Chame o GetOAuthAuthorizationURL procedimento armazenado* com o parâmetro de entrada CallbackURL definido para o URI de redirecionamento exato que você especificou nas configurações do aplicativo.
  2. Abra o URL retornado em um navegador. Faça login e conceda permissões ao conector. Você será redirecionado para a URL de retorno de chamada. A página da Web indicará que o site não pôde ser acessado.
  3. Inspecione o URL da página deste site e encontre o code valor. Ele estará presente na URL no formato code=XXXXXX (terminado com &, que denota o próximo parâmetro da URL) O valor após o "code=" é o código do verificador.
  4. Salve o valor do código do verificador. Você definirá isso no OAuthVerifier propriedade de conexão.

Na máquina sem periféricos, defina um dos seguintes grupos de propriedades de conexão dependendo do tipo de autenticação para obter os valores de autenticação OAuth:

  • OAuthClientId: Defina isso como a chave do consumidor nas configurações do aplicativo.
  • OAuthClientSecret: Defina isso como o segredo do consumidor nas configurações do aplicativo.
  • OAuthVerifier: Defina isso para o código do verificador.
  • OAuthSettingsLocation: Defina para manter os valores de autenticação OAuth criptografados no arquivo especificado.
  • InitiateOAuth: Defina como REFRESH.

Conecte-se aos dados

Depois que o arquivo de configurações OAuth for gerado, defina as seguintes propriedades para se conectar aos dados:

  • OAuthSettingsLocation: Defina isso para o arquivo que contém os valores de autenticação OAuth criptografados. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao provedor para ativar a atualização automática do token de acesso.
  • InitiateOAuth: Configure para ATUALIZAR.

Configurações de transferência OAuth

Siga as etapas abaixo para instalar o conector em outra máquina, autenticar e depois transferir os valores OAuth resultantes.

Em uma segunda máquina, instale o conector e conecte-se a um dos seguintes grupos de propriedades, dependendo do tipo de autenticação:

  1. Authenticating using a Client Secret
    • OAuthSettingsLocation: Defina isso como um arquivo de texto gravável.
    • InitiateOAuth: Defina como GETANDREFRESH.
    • OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
    • OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.
    • CallbackURL: Defina isso para o URL de retorno de chamada nas configurações do aplicativo.
  2. Authenticating using a Certificate
    • OAuthSettingsLocation: Defina isso como um arquivo de texto gravável.
    • InitiateOAuth: Defina como GETANDREFRESH.
    • OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
    • OAuthJWTCert: Defina isso para o armazenamento de certificados JWT.
    • OAuthJWTCertType: Defina isso para o tipo de armazenamento de certificado especificado por OAuthJWTCert.
    • CallbackURL: Defina isso para o URL de retorno de chamada nas configurações do aplicativo.

Teste a conexão para autenticar. Os valores de autenticação resultantes são gravados, criptografados, no caminho especificado por OAuthSettingsLocation. Depois de testar a conexão com sucesso, copie o arquivo de configurações OAuth para sua máquina sem periféricos. Na máquina sem periféricos, defina as seguintes propriedades de conexão para se conectar aos dados:

  • InitiateOAuth: Configure para ATUALIZAR.
  • OAuthSettingsLocation: Defina isso como o caminho para o arquivo de configurações OAuth. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao conector para habilitar a atualização automática do token de acesso.

Criando um Aplicativo OAuth Personalizado

Quando Criar um Aplicativo OAuth Personalizado

A criação de um aplicativo OAuth personalizado é opcional, pois o conector já está registrado no OneDrive e você pode se conectar com suas credenciais incorporadas.

Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem logon no endpoint OneDrive OAuth para conceder permissões ao conector.

Siga as etapas abaixo para criar um aplicativo OAuth personalizado e obter as propriedades de conexão em um fluxo de autenticação OAuth específico.

Etapas para Criar um Aplicativo OAuth Personalizado

Siga as etapas abaixo para obter os valores OAuth para seu aplicativo, o OAuthClientId e OAuthClientSecret.

  1. Faça login em https://portal.azure.com.
  2. No painel de navegação à esquerda, selecione Azure Active Directory, em seguida, Registros de aplicativos e clique no botão Novo registro.
  3. Insira um nome de aplicativo e defina o botão de opção para a configuração de locatário desejada. Ao criar um aplicativo OAuth personalizado no Azure Active Directory, você pode definir se o aplicativo é único ou multilocatário. Se você selecionar a opção padrão "Somente contas neste diretório organizacional", precisará definir o AzureTenant propriedade de conexão para a ID do locatário do Azure AD ao estabelecer uma conexão com o conector Jitterbit para OneDrive. Caso contrário, a tentativa de autenticação falhará com um erro. Se seu aplicativo for apenas para uso privado, "Somente contas neste diretório da organização" deve ser suficiente. Caso contrário, se você quiser distribuir seu aplicativo, escolha uma das opções multilocatário.
  4. Em seguida, defina o URL de redirecionamento para algo como http://localhost:33333, o padrão do conector. Ou defina uma porta diferente de sua escolha e defina CallbackURL para o URL de resposta exato que você definiu.
  5. Defina o tipo de autenticação do aplicativo na seção Certificados e segredos. Existem dois tipos de autenticação disponíveis: usando um segredo do cliente e usando um certificado. O método de autenticação recomendado é por meio de um certificado, mas você também pode criar um segredo de aplicativo.
    • Option 1 - Upload a certificate: Na seção Certificados e Segredos, selecione Carregar certificado e selecione o certificado para carregar de sua máquina local.
    • Option 2 - Create a new application secret: Na seção Certificates & Secrets, selecione New Client Secret para o aplicativo e selecione sua duração. Depois de salvar o segredo do cliente, o valor da chave é exibido. Copie este valor, pois ele é exibido apenas uma vez e é usado como OAuthClientSecret.
  6. Selecione Permissões de API e clique em Adicionar. Se você planeja que seu aplicativo se conecte sem um contexto de usuário, selecione as Permissões do aplicativo (OAuthGrantType = CLIENTE). Caso contrário, ao selecionar permissões, use as permissões delegadas.
  7. Selecione a API do Microsoft Graph e adicione as permissões delegadas Files.ReadWrite.All ou Files.Read.All. Clique no botão 'Conceder consentimento do administrador' para que as novas permissões entrem em vigor.
  8. Salve suas alterações.
  9. Se você optou por usar permissões que exigem consentimento do administrador (como as Permissões do aplicativo), você pode concedê-las do locatário atual na página Permissões da API. Caso contrário, siga as etapas em Consentimento do administrador.

Consentimento do Administrador

O consentimento do administrador refere-se a quando o administrador de um locatário do Azure Active Directory concede permissões a um aplicativo que exige que um administrador consinta com o caso de uso. O aplicativo incorporado no conector Jitterbit para OneDrive não contém permissões que exijam o consentimento do administrador. Portanto, essas informações se aplicam apenas a aplicativos personalizados.

Ao criar um novo aplicativo OAuth no Portal do Azure, você deve especificar quais permissões o aplicativo exigirá. Algumas permissões podem ser marcadas informando "Consentimento do administrador necessário". Por exemplo, todas as permissões de grupos exigem consentimento do administrador. Se seu aplicativo exigir consentimento do administrador, há algumas maneiras de fazer isso.

A maneira mais fácil de conceder consentimento de administrador é apenas fazer com que um administrador faça logon em portal.azure.com e navegue até o aplicativo que você criou em Registros de aplicativos. Em Permissões da API, haverá um botão para Conceder consentimento. Você pode consentir aqui para que seu aplicativo tenha permissões no locatário sob o qual foi criado.

Se sua organização tiver vários locatários ou o aplicativo precisar receber permissões para outros locatários fora de sua organização, o GetAdminConsentURL pode ser usado para gerar o URL de autorização do administrador. Ao contrário do GetOAuthAuthorizationURL, não haverá informações importantes retornadas desse endpoint. Se conceder acesso, ele simplesmente retornará um booleano indicando que as permissões foram concedidas.

Depois que um administrador concede o consentimento, a autenticação pode ser realizada normalmente.

Credenciais do Cliente

As credenciais do cliente referem-se a um fluxo no OAuth em que não ocorre nenhuma autenticação direta do usuário. Em vez disso, as credenciais são criadas apenas para o próprio aplicativo. Todas as tarefas executadas pelo aplicativo são realizadas sem um contexto de usuário padrão. Isso torna o fluxo de autenticação um pouco diferente do padrão.

Fluxo OAuth do Cliente

Todas as permissões relacionadas ao fluxo oauth do cliente exigem o consentimento do administrador. Isso significa que o aplicativo incorporado com o Jitterbit Connector for OneDrive não pode ser usado no fluxo de autenticação do cliente. Você deve criar seu próprio aplicativo OAuth para usar as credenciais do cliente. Consulte Criando um aplicativo OAuth personalizado para mais detalhes.

Em seu registro de aplicativo em portal.azure.com, navegue até API Permissions e selecione as permissões do Microsoft Graph. Existem dois conjuntos distintos de permissões - Permissões delegadas e de aplicativos. As permissões usadas durante a autenticação da credencial do cliente estão em Permissões do aplicativo. Selecione as permissões aplicáveis necessárias para sua integração.

Você está pronto para se conectar após definir um dos grupos de propriedades de conexão abaixo, dependendo do tipo de autenticação.

  1. Authenticating using a Client Secret
    • InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.
    • AzureTenant: Defina isso para o inquilino ao qual você deseja se conectar.
    • OAuthGrantType: Defina como CLIENTE.
    • OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
    • OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.
  2. Authenticating using a Certificate
    • InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.
    • AzureTenant: Defina isso para o inquilino ao qual você deseja se conectar.
    • OAuthGrantType: Defina como CLIENTE.
    • OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
    • OAuthJWTCert: Defina isso para o armazenamento de certificados JWT.
    • OAuthJWTCertType: Defina isso para o tipo de armazenamento de certificado especificado por OAuthJWTCert.

A autenticação com as credenciais do cliente ocorrerá automaticamente como qualquer outra conexão, exceto que não haverá nenhuma janela aberta solicitando ao usuário. Como não há contexto do usuário, não há necessidade de um pop-up do navegador. As conexões ocorrerão e serão tratadas internamente.

Usando a Autenticação Principal de Serviço do Azure

A autenticação como Entidade de Serviço do Azure é tratada por meio do fluxo de Credenciais do Cliente OAuth e não envolve autenticação direta do usuário. Em vez disso, as credenciais são criadas apenas para o próprio aplicativo. Todas as tarefas executadas pelo aplicativo são feitas sem um contexto de usuário padrão, mas com base nas funções atribuídas. O acesso do aplicativo aos recursos é controlado por meio das permissões das funções atribuídas.

Credenciais Personalizadas

Você precisará registrar um aplicativo OAuth para obter os valores de propriedade OAuth antes da conexão com a fonte de dados do OneDrive. Você pode verificar as Credenciais personalizadas guia sobre como definir as propriedades OAuth.

Criando um Aplicativo OAuth Personalizado

Consulte Criando um aplicativo OAuth personalizado para um procedimento.

Criando um Aplicativo OAuth Personalizado

A criação de um aplicativo OAuth personalizado e uma entidade de serviço que pode acessar os recursos necessários é necessária ao autenticar usando uma entidade de serviço do Azure.

Siga as etapas abaixo para criar um aplicativo OAuth personalizado e obter as propriedades de conexão para a autenticação da Entidade de Serviço do Azure.

Etapas para Criar um Aplicativo OAuth Personalizado

Siga as etapas abaixo para obter os valores OAuth para seu aplicativo.

  1. Faça login em <https://portal.azure.com>.
  2. No painel de navegação à esquerda, selecione Azure Active Directory, em seguida, Registros de aplicativos e clique no botão Novo registro.
  3. Insira um nome de aplicativo e defina o botão de opção para "Qualquer diretório do Azure AD - multilocatário". Em seguida, defina o URL de redirecionamento para algo como http://localhost:33333, o padrão do conector.
  4. Copie o valor do ID do aplicativo (cliente) exibido na seção Visão geral após criar o aplicativo, pois esse valor é usado como OAuthClientId
  5. Defina o tipo de autenticação do aplicativo na seção Certificados e segredos. Existem dois tipos de autenticação disponíveis: usando um segredo do cliente e usando um certificado. O método de autenticação recomendado é por meio de um certificado, mas você também pode criar um segredo de aplicativo.
    • Option 1 - Upload a certificate: Na seção Certificados e Segredos, selecione Carregar certificado e selecione o certificado para carregar de sua máquina local.
    • Option 2 - Create a new application secret: Na seção Certificates & Secrets, selecione New Client Secret para o aplicativo e selecione sua duração. Depois de salvar o segredo do cliente, o valor da chave é exibido. Copie este valor, pois ele é exibido apenas uma vez e é usado como OAuthClientSecret.
  6. Na aba Autenticação, certifique-se de marcar a opção: Tokens de acesso (usados para fluxos implícitos).
  7. Abra a página Assinaturas pesquisando e selecionando o serviço Assinaturas na barra de pesquisa.
  8. Selecione a assinatura específica à qual atribuir o aplicativo, abra a seção Controle de acesso (IAM) e clique no botão Adicionar atribuição de papel.
  9. Selecione Proprietário como a papel a ser atribuída ao aplicativo OAuth criado.

Credenciais Personalizadas

Siga as etapas abaixo para autenticar com as credenciais de um aplicativo OAuth personalizado. Consulte Criando um aplicativo OAuth personalizado.

Autenticação com Seu Aplicativo OAuth

Atualmente, apenas o uso de um segredo do cliente tem suporte para autenticação.

Obtenha um Token de Acesso OAuth

Você está pronto para se conectar depois de definir as seguintes propriedades de conexão:

  • Authenticating using a Client Secret
    • AuthScheme: Defina isso como "AzureServicePrincipal" nas configurações do aplicativo.
    • InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.
    • AzureTenant: Defina isso para o inquilino ao qual você deseja se conectar.
    • OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
    • OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.

Acesso a Dados de Ajuste Fino

Acesso a Dados de Ajuste Fino

  • DirectoryRetrievalDepth: quantas pastas você deseja obter resultados para tabelas de pastas, arquivos, recursos compartilhados e permissões.
  • DriveId: O ID do Drive que você deseja usar ao obter dados para as tabelas Arquivos, Pastas, SharedResources e Permissões.
  • ListGroupDrives: Indica se você gostaria de listar as unidades do seu grupo ou não ao consultar a tabela Unidades. Útil se você estiver usando uma conta do OneDrive for Business.

Anotações Importantes

Procedimentos Armazenados

  • Os recursos de procedimentos armazenados descritos nesta documentação não são suportados no momento.
  • Como os procedimentos armazenados não são suportados atualmente, qualquer recurso dependente de procedimentos armazenados também não é suportado atualmente.

Arquivos de Configuração e Seus Caminhos

  • Todas as referências para adicionar arquivos de configuração e seus caminhos referem-se a arquivos e locais no Harmony Agente onde o conector está instalado. Esses caminhos devem ser ajustados conforme apropriado, dependendo do agente e do sistema operacional. Se vários agentes forem usados em um grupo de agentes, arquivos idênticos serão necessários em cada agente.

Características Avançadas

Esta seção detalha uma seleção de recursos avançados do conector OneDrive.

Visualizações definidas pelo usuário

O conector permite definir tabelas virtuais, denominadas visualizações definidas pelo usuário, cujo conteúdo é decidido por uma consultar pré-configurada. Essas exibições são úteis quando você não pode controlar diretamente as consultas enviadas aos drivers. Consulte Visualizações definidas pelo usuário para obter uma visão geral da criação e configuração de exibições personalizadas.

Configuração SSL

Use Configuração SSL para ajustar como o conector lida com as negociações de certificado TLS/SSL. Você pode escolher entre vários formatos de certificado; Veja o SSLServerCert propriedade em "Opções de cadeia de conexão" para obter mais informações.

Procurador

Para configurar o conector usando configurações de proxy do Agente Privado, selecione os Use Proxy Settings caixa de seleção na tela de configuração da conexão.

Visualizações Definidas pelo Usuário

O Jitterbit Connector for OneDrive permite definir uma tabela virtual cujo conteúdo é decidido por uma consultar pré-configurada. Elas são chamadas de Visualizações Definidas pelo Usuário, que são úteis em situações onde você não pode controlar diretamente a consultar que está sendo emitida para o driver, por exemplo, ao usar o driver do Jitterbit. As Visualizações Definidas pelo Usuário podem ser usadas para definir predicados que são sempre aplicados. Se você especificar predicados adicionais na consultar para a visualização, eles serão combinados com a consultar já definida como parte da visualização.

Há duas maneiras de criar exibições definidas pelo usuário:

  • Crie um arquivo de configuração em formato JSON definindo as visualizações desejadas.
  • declarações DDL.

Definindo Visualizações Usando um Arquivo de Configuração

As visualizações definidas pelo usuário são definidas em um arquivo de configuração formatado em JSON chamado UserDefinedViews.json. O conector detecta automaticamente as visualizações especificadas neste arquivo.

Você também pode ter várias definições de exibição e controlá-las usando o UserDefinedViews propriedade de conexão. Quando você usa essa propriedade, apenas as exibições especificadas são vistas pelo conector.

Este arquivo de configuração de exibição definida pelo usuário é formatado da seguinte forma:

  • Cada elemento raiz define o nome de uma visualização.
  • Cada elemento raiz contém um elemento filho, chamado query, que contém a consultar SQL personalizada para a exibição.

Por exemplo:

{
    "MyView": {
        "query": "SELECT * FROM Files WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use o UserDefinedViews propriedade de conexão para especificar a localização do seu arquivo de configuração JSON. Por exemplo:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Esquema para Exibições Definidas pelo Usuário

As visualizações definidas pelo usuário são expostas no UserViews esquema por padrão. Isso é feito para evitar que o nome da exibição entre em conflito com uma entidade real no modelo de dados. Você pode alterar o nome do esquema usado para UserViews definindo o UserViewsSchemaName propriedade.

Trabalhando com Exibições Definidas pelo Usuário

Por exemplo, uma instrução SQL com uma Visualização Definida pelo Usuário chamada UserViews.RCustomers lista apenas clientes em Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Exemplo de consultar ao driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resultando na consultar efetiva à fonte:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Esse é um exemplo muito simples de uma consultar a uma exibição definida pelo usuário que é efetivamente uma combinação da consultar de exibição e da definição de exibição. É possível compor essas consultas em padrões bem mais complexos. Todas as operações SQL são permitidas em ambas as consultas e são combinadas quando apropriado.

Configuração SSL

Personalizando a Configuração SSL

Por padrão, o conector tenta negociar SSL/TLS verificando o certificado do servidor em relação ao armazenamento de certificados confiáveis do sistema.

Para especificar outro certificado, consulte o SSLServerCert propriedade para os formatos disponíveis para fazê-lo.

Modelo de Dados

O conector modela a API do OneDrive como tabelas relacionais. Quaisquer alterações nos dados remotos são refletidas imediatamente em suas consultas; as definições da tabela são recuperadas dinamicamente. Quando você se conecta, o conector se conecta ao OneDrive e obtém a lista de tabelas e os metadados das tabelas chamando os serviços Web apropriados.

Características principais

  • O conector modela entidades do OneDrive como arquivos e pastas como exibições relacionais, permitindo que você escreva SQL para consultar dados do OneDrive.
  • Procedimentos armazenados* permitem executar operações no OneDrive, incluindo recuperar o token de acesso e mantê-lo atualizado no OAuth 2.0.
  • A conectividade ao vivo com esses objetos significa que quaisquer alterações em sua conta do OneDrive são refletidas imediatamente ao usar o conector.

Visualizações

Visualizações mostra as definições de um site OneDrive de amostra. O modelo de dados real será obtido dinamicamente com base em suas credenciais de usuário e site.

Procedimentos armazenados

NOTE: Procedimentos armazenados não são suportados atualmente. Veja a nota para detalhes.

Procedimentos armazenados são interfaces semelhantes a funções para o OneDrive. Eles podem ser usados para pesquisar, atualizar e modificar informações no OneDrive.

Processamento de consulta colaborativa

O conector descarrega o máximo possível do processamento da instrução SELECT no OneDrive e, em seguida, processa o restante da consultar na memória (do lado do cliente).

Isso é feito através do SupportEnhancedSQL propriedade, que é habilitada por padrão. Você pode desativá-lo para desativar a execução do lado do cliente. Isso retornará as informações não filtradas, portanto, os resultados podem estar incorretos.

Visualizações

As exibições são compostas por colunas e pseudocolunas. As exibições são semelhantes às tabelas na forma como os dados são representados; no entanto, as exibições não oferecem suporte a atualizações. Entidades que são representadas como exibições são normalmente entidades somente leitura. Frequentemente, um procedimento armazenado* está disponível para atualizar os dados se tal funcionalidade for aplicável à fonte de dados.

As consultas podem ser executadas em uma exibição como se fosse uma tabela normal, e os dados retornados são semelhantes nesse aspecto. Para saber mais sobre tabelas e procedimentos armazenados, navegue até as entradas correspondentes neste documento de ajuda.

Conector Jitterbit para Exibições do OneDrive

Nome Descrição
Drives As Unidades de visualização do OneDrive, que lista todas as unidades às quais o usuário tem acesso.
Files A tabela OneDrive Arquivos na qual você pode exibir todos os arquivos em uma unidade.
Folders A tabela Pastas do OneDrive, que mostra todas as pastas em uma unidade.
Permissions A tabela Permissões do OneDrive, que mostra todas as permissões concedidas a um recurso da unidade.
SharedResources A tabela SharedResources do OneDrive, que mostra todos os recursos compartilhados em uma unidade.
Users A tabela Usuários do OneDrive na qual um usuário administrador pode exibir os detalhes dos usuários.

Unidades

A exibição Unidades do OneDrive, que lista todas as unidades às quais o usuário tem acesso.

Informações Específicas da Tabela

Devido às limitações da API, todos os operadores nesta exibição são executados no lado do cliente.

Colunas
Nome Tipo Referências Descrição
driveType String
owner_application_displayName String
owner_application_id String
quota_deleted Long
quota_remaining Long
quota_state String
quota_storagePlanInformation_upgradeAvailable Bool
quota_total Long
quota_used Long
sharePointIds_listId String
sharePointIds_listItemId String
sharePointIds_listItemUniqueId String
sharePointIds_siteId String
sharePointIds_siteUrl String
sharePointIds_tenantId String
sharePointIds_webId String
Linkedfollowing String
Linkeditems String
Linkedlist String
Linkedroot String
Linkedspecial String
ParentReference String
Id [KEY] String
Name String
Description String
owner_user_id String

Arquivos

A tabela OneDrive Arquivos na qual você pode exibir todos os arquivos em uma unidade.

Informações Específicas da Tabela

A projeção é feita do lado do servidor. Além disso, as consultas que incluem o ID da chave primária e IN são executadas no lado do servidor, por exemplo:

SELECT Id, Name, audio_album, audio_title FROM Files WHERE ID IN ('B1E6BJ084A9133KB1!101', 'APF9D2K6WFA524Y')

A listagem de arquivos é feita recursivamente através do DirectoryRetrievalDepth propriedade. O valor padrão desta propriedade é 5, o que significa que ela obterá dados apenas para os primeiros 6 níveis do 'Drive' que você escolheu (porque o primeiro nível está localizado em DirectoryRetrievalDepth=0).

Você pode especificar o valor -1 para obter todos os arquivos no 'Drive', independentemente da profundidade em que estão localizados.

Embora os arquivos possam ser listados nesta exibição, o conteúdo dos arquivos pode ser trabalhado usando procedimentos armazenados* como:

Colunas
Nome Tipo Referências Descrição
id [KEY] String
Etag String
createdBy_user_id String
createdBy_user_displayName String
lastModifiedBy_user_id String
lastModifiedBy_user_displayName String
createdBy_application_displayName String
createdBy_application_id String
createdDateTime Datetime
description String
lastModifiedBy_application_displayName String
lastModifiedBy_application_id String
lastModifiedDateTime Datetime
name String
parentReference_driveId String
parentReference_driveType String
parentReference_id String
parentReference_name String
parentReference_path String
parentReference_shareId String
parentReference_sharepointIds_listId String
parentReference_sharepointIds_listItemId String
parentReference_sharepointIds_listItemUniqueId String
parentReference_sharepointIds_siteId String
parentReference_sharepointIds_siteUrl String
parentReference_sharepointIds_tenantId String
parentReference_sharepointIds_webId String
parentReference_siteId String
webUrl String
LinkedcreatedByUser String
LinkedlastModifiedByUser String
audio_album String
audio_albumArtist String
audio_artist String
audio_bitrate Long
audio_composers String
audio_copyright String
audio_disc Int
audio_discCount Int
audio_duration Long
audio_genre String
audio_hasDrm Bool
audio_isVariableBitrate Bool
audio_title String
audio_track Int
audio_trackCount Int
audio_year Int
content String
cTag String
deleted_state String
file_hashes_crc32Hash String
file_hashes_quickXorHash String
file_hashes_sha1Hash String
file_hashes_sha256Hash String
file_mimeType String
file_processingMetadata Bool
fileSystemInfo_createdDateTime Datetime
fileSystemInfo_lastAccessedDateTime Datetime
fileSystemInfo_lastModifiedDateTime Datetime
folder_childCount Int
folder_view_sortBy String
folder_view_sortOrder String
folder_view_viewType String
image_height Int
image_width Int
location_altitude Double
location_latitude Double
location_longitude Double
package_type String
pendingOperations_pendingContentUpdate_queuedDateTime Datetime
photo_cameraMake String
photo_cameraModel String
photo_exposureDenominator Double
photo_exposureNumerator Double
photo_fNumber Double
photo_focalLength Double
photo_iso Int
photo_orientation Int
photo_takenDateTime Datetime
publication_level String
publication_versionId String
remoteItem_createdBy_application_displayName String
remoteItem_createdBy_application_id String
remoteItem_createdDateTime Datetime
remoteItem_file_hashes_crc32Hash String
remoteItem_file_hashes_quickXorHash String
remoteItem_file_hashes_sha1Hash String
remoteItem_file_hashes_sha256Hash String
remoteItem_file_mimeType String
remoteItem_file_processingMetadata Bool
remoteItem_fileSystemInfo_createdDateTime Datetime
remoteItem_fileSystemInfo_lastAccessedDateTime Datetime
remoteItem_fileSystemInfo_lastModifiedDateTime Datetime
remoteItem_folder_childCount Int
remoteItem_folder_view_sortBy String
remoteItem_folder_view_sortOrder String
remoteItem_folder_view_viewType String
remoteItem_id String
remoteItem_image_height Int
remoteItem_image_width Int
remoteItem_lastModifiedDateTime Datetime
remoteItem_name String
remoteItem_package_type String
remoteItem_parentReference_driveId String
remoteItem_parentReference_driveType String
remoteItem_parentReference_id String
remoteItem_parentReference_name String
remoteItem_parentReference_path String
remoteItem_parentReference_shareId String
remoteItem_parentReference_sharepointIds_listId String
remoteItem_parentReference_sharepointIds_listItemId String
remoteItem_parentReference_sharepointIds_listItemUniqueId String
remoteItem_parentReference_sharepointIds_siteId String
remoteItem_parentReference_sharepointIds_siteUrl String
remoteItem_parentReference_sharepointIds_tenantId String
remoteItem_parentReference_sharepointIds_webId String
remoteItem_parentReference_siteId String
remoteItem_shared_scope String
remoteItem_shared_sharedDateTime Datetime
remoteItem_size Long
remoteItem_specialFolder_name String
remoteItem_video_audioBitsPerSample Int
remoteItem_video_audioChannels Int
remoteItem_video_audioFormat String
remoteItem_video_audioSamplesPerSecond Int
remoteItem_video_bitrate Int
remoteItem_video_duration Long
remoteItem_video_fourCC String
remoteItem_video_frameRate Double
remoteItem_video_height Int
remoteItem_video_width Int
remoteItem_webDavUrl String
remoteItem_webUrl String
searchResult_onClickTelemetryUrl String
shared_owner_application_displayName String
shared_owner_application_id String
shared_scope String
shared_sharedDateTime Datetime
sharepointIds_listId String
sharepointIds_listItemId String
sharepointIds_listItemUniqueId String
sharepointIds_siteId String
sharepointIds_siteUrl String
sharepointIds_tenantId String
sharepointIds_webId String
size Long
specialFolder_name String
video_audioBitsPerSample Int
video_audioChannels Int
video_audioFormat String
video_audioSamplesPerSecond Int
video_bitrate Int
video_duration Long
video_fourCC String
video_frameRate Double
video_height Int
video_width Int
webDavUrl String
Linkedanalytics String
Linkedchildren String
LinkedlistItem String
Linkedpermissions String
Linkedsubscriptions String
Linkedthumbnails String
Linkedversions String
Linkedworkbook String

Pastas

A tabela Pastas do OneDrive, que mostra todas as pastas em uma unidade.

Informações Específicas da Tabela

Nota: Consulte CriarPasta para criar uma pasta.

A projeção é feita do lado do servidor. Além disso, as consultas que incluem o ID da chave primária e IN são executadas no lado do servidor, por exemplo:

SELECT Id, Name, Size, Description FROM Folders WHERE ID IN ('B1E6BJ084A9133KB1!122', 'APF9D2K6WFAAPX9')

A listagem de pastas é feita recursivamente através do DirectoryRetrievalDepth propriedade. O valor padrão desta propriedade é 5, o que significa que ela obterá dados apenas para os primeiros 6 níveis do 'Drive' que você escolheu (porque o primeiro nível está localizado em DirectoryRetrievalDepth=0).

Você pode especificar o valor -1 para obter todas as pastas no 'Drive', independentemente da profundidade em que estão localizadas.

Embora as pastas possam ser listadas nesta exibição, o conteúdo das pastas pode ser trabalhado usando procedimentos armazenados* como:

  • CopiarRecurso - Copie um arquivo/pasta de um diretório em sua unidade para outro.
  • ExcluirRecurso - Exclua um arquivo/pasta de sua unidade.
  • MoverRecurso - Mova um arquivo/pasta de um diretório em sua unidade para outro.
Colunas
Nome Tipo Referências Descrição
id [KEY] String
Etag String
createdBy_user_id String
createdBy_user_displayName String
lastModifiedBy_user_id String
lastModifiedBy_user_displayName String
createdBy_application_displayName String
createdBy_application_id String
createdDateTime Datetime
description String
lastModifiedBy_application_displayName String
lastModifiedBy_application_id String
lastModifiedDateTime Datetime
name String
parentReference_driveId String
parentReference_driveType String
parentReference_id String
parentReference_name String
parentReference_path String
parentReference_shareId String
parentReference_sharepointIds_listId String
parentReference_sharepointIds_listItemId String
parentReference_sharepointIds_listItemUniqueId String
parentReference_sharepointIds_siteId String
parentReference_sharepointIds_siteUrl String
parentReference_sharepointIds_tenantId String
parentReference_sharepointIds_webId String
parentReference_siteId String
webUrl String
LinkedcreatedByUser String
LinkedlastModifiedByUser String
audio_album String
audio_albumArtist String
audio_artist String
audio_bitrate Long
audio_composers String
audio_copyright String
audio_disc Int
audio_discCount Int
audio_duration Long
audio_genre String
audio_hasDrm Bool
audio_isVariableBitrate Bool
audio_title String
audio_track Int
audio_trackCount Int
audio_year Int
content String
cTag String
deleted_state String
file_hashes_crc32Hash String
file_hashes_quickXorHash String
file_hashes_sha1Hash String
file_hashes_sha256Hash String
file_mimeType String
file_processingMetadata Bool
fileSystemInfo_createdDateTime Datetime
fileSystemInfo_lastAccessedDateTime Datetime
fileSystemInfo_lastModifiedDateTime Datetime
folder_childCount Int
folder_view_sortBy String
folder_view_sortOrder String
folder_view_viewType String
image_height Int
image_width Int
location_altitude Double
location_latitude Double
location_longitude Double
package_type String
pendingOperations_pendingContentUpdate_queuedDateTime Datetime
photo_cameraMake String
photo_cameraModel String
photo_exposureDenominator Double
photo_exposureNumerator Double
photo_fNumber Double
photo_focalLength Double
photo_iso Int
photo_orientation Int
photo_takenDateTime Datetime
publication_level String
publication_versionId String
remoteItem_createdBy_application_displayName String
remoteItem_createdBy_application_id String
remoteItem_createdDateTime Datetime
remoteItem_file_hashes_crc32Hash String
remoteItem_file_hashes_quickXorHash String
remoteItem_file_hashes_sha1Hash String
remoteItem_file_hashes_sha256Hash String
remoteItem_file_mimeType String
remoteItem_file_processingMetadata Bool
remoteItem_fileSystemInfo_createdDateTime Datetime
remoteItem_fileSystemInfo_lastAccessedDateTime Datetime
remoteItem_fileSystemInfo_lastModifiedDateTime Datetime
remoteItem_folder_childCount Int
remoteItem_folder_view_sortBy String
remoteItem_folder_view_sortOrder String
remoteItem_folder_view_viewType String
remoteItem_id String
remoteItem_image_height Int
remoteItem_image_width Int
remoteItem_lastModifiedDateTime Datetime
remoteItem_name String
remoteItem_package_type String
remoteItem_parentReference_driveId String
remoteItem_parentReference_driveType String
remoteItem_parentReference_id String
remoteItem_parentReference_name String
remoteItem_parentReference_path String
remoteItem_parentReference_shareId String
remoteItem_parentReference_sharepointIds_listId String
remoteItem_parentReference_sharepointIds_listItemId String
remoteItem_parentReference_sharepointIds_listItemUniqueId String
remoteItem_parentReference_sharepointIds_siteId String
remoteItem_parentReference_sharepointIds_siteUrl String
remoteItem_parentReference_sharepointIds_tenantId String
remoteItem_parentReference_sharepointIds_webId String
remoteItem_parentReference_siteId String
remoteItem_shared_scope String
remoteItem_shared_sharedDateTime Datetime
remoteItem_size Long
remoteItem_specialFolder_name String
remoteItem_video_audioBitsPerSample Int
remoteItem_video_audioChannels Int
remoteItem_video_audioFormat String
remoteItem_video_audioSamplesPerSecond Int
remoteItem_video_bitrate Int
remoteItem_video_duration Long
remoteItem_video_fourCC String
remoteItem_video_frameRate Double
remoteItem_video_height Int
remoteItem_video_width Int
remoteItem_webDavUrl String
remoteItem_webUrl String
searchResult_onClickTelemetryUrl String
shared_owner_application_displayName String
shared_owner_application_id String
shared_scope String
shared_sharedDateTime Datetime
sharepointIds_listId String
sharepointIds_listItemId String
sharepointIds_listItemUniqueId String
sharepointIds_siteId String
sharepointIds_siteUrl String
sharepointIds_tenantId String
sharepointIds_webId String
size Long
specialFolder_name String
video_audioBitsPerSample Int
video_audioChannels Int
video_audioFormat String
video_audioSamplesPerSecond Int
video_bitrate Int
video_duration Long
video_fourCC String
video_frameRate Double
video_height Int
video_width Int
webDavUrl String
Linkedanalytics String
Linkedchildren String
LinkedlistItem String
Linkedpermissions String
Linkedsubscriptions String
Linkedthumbnails String
Linkedversions String
Linkedworkbook String

Permissões

A tabela Permissões do OneDrive, que mostra todas as permissões concedidas a um recurso da unidade.

Informações Específicas da Tabela

Devido às limitações da API, todos os operadores nesta exibição são executados no lado do cliente.

Colunas
Nome Tipo Referências Descrição
id [KEY] String
Etag String
ResourceId [KEY] String
grantedTo_user_displayName String
grantedTo_user_email String
grantedTo_user_id String
expirationDateTime Datetime
grantedTo_application_displayName String
grantedTo_application_id String
grantedToIdentities String
hasPassword Bool
inheritedFrom_driveId String
inheritedFrom_driveType String
inheritedFrom_id String
inheritedFrom_name String
inheritedFrom_path String
inheritedFrom_shareId String
inheritedFrom_sharepointIds_listId String
inheritedFrom_sharepointIds_listItemId String
inheritedFrom_sharepointIds_listItemUniqueId String
inheritedFrom_sharepointIds_siteId String
inheritedFrom_sharepointIds_siteUrl String
inheritedFrom_sharepointIds_tenantId String
inheritedFrom_sharepointIds_webId String
inheritedFrom_siteId String
invitation_email String
invitation_invitedBy_application_displayName String
invitation_invitedBy_application_id String
invitation_redeemedBy String
invitation_signInRequired Bool
link_application_displayName String
link_application_id String
link_preventsDownload Bool
link_scope String
link_type String
link_webHtml String
link_webUrl String
roles String
shareId String

Recursos Compartilhados

A tabela SharedResources do OneDrive, que mostra todos os recursos compartilhados em uma unidade.

Informações Específicas da Tabela

A projeção é feita do lado do servidor. Além disso, as consultas que incluem o ID da chave primária e IN são executadas no lado do servidor, por exemplo:

SELECT Id, Name, Size, Shared_Scope FROM SharedResources WHERE ID IN ('B1E6BJ084A9133KB1!122', 'APF9D2K6WFAAPX9')

A listagem de SharedResources é feita recursivamente por meio do DirectoryRetrievalDepth propriedade. O valor padrão desta propriedade é 5, o que significa que ela obterá dados apenas para os primeiros 6 níveis do 'Drive' que você escolheu (porque o primeiro nível está localizado em DirectoryRetrievalDepth=0).

Você pode especificar o valor -1 para obter todos os recursos compartilhados no 'Drive', independentemente da profundidade em que estão localizados.

Colunas
Nome Tipo Referências Descrição
id [KEY] String
Etag String
createdBy_user_id String
createdBy_user_displayName String
lastModifiedBy_user_id String
lastModifiedBy_user_displayName String
createdBy_application_displayName String
createdBy_application_id String
createdDateTime Datetime
description String
lastModifiedBy_application_displayName String
lastModifiedBy_application_id String
lastModifiedDateTime Datetime
name String
parentReference_driveId String
parentReference_driveType String
parentReference_id String
parentReference_name String
parentReference_path String
parentReference_shareId String
parentReference_sharepointIds_listId String
parentReference_sharepointIds_listItemId String
parentReference_sharepointIds_listItemUniqueId String
parentReference_sharepointIds_siteId String
parentReference_sharepointIds_siteUrl String
parentReference_sharepointIds_tenantId String
parentReference_sharepointIds_webId String
parentReference_siteId String
webUrl String
LinkedcreatedByUser String
LinkedlastModifiedByUser String
audio_album String
audio_albumArtist String
audio_artist String
audio_bitrate Long
audio_composers String
audio_copyright String
audio_disc Int
audio_discCount Int
audio_duration Long
audio_genre String
audio_hasDrm Bool
audio_isVariableBitrate Bool
audio_title String
audio_track Int
audio_trackCount Int
audio_year Int
content String
cTag String
deleted_state String
file_hashes_crc32Hash String
file_hashes_quickXorHash String
file_hashes_sha1Hash String
file_hashes_sha256Hash String
file_mimeType String
file_processingMetadata Bool
fileSystemInfo_createdDateTime Datetime
fileSystemInfo_lastAccessedDateTime Datetime
fileSystemInfo_lastModifiedDateTime Datetime
folder_childCount Int
folder_view_sortBy String
folder_view_sortOrder String
folder_view_viewType String
image_height Int
image_width Int
location_altitude Double
location_latitude Double
location_longitude Double
package_type String
pendingOperations_pendingContentUpdate_queuedDateTime Datetime
photo_cameraMake String
photo_cameraModel String
photo_exposureDenominator Double
photo_exposureNumerator Double
photo_fNumber Double
photo_focalLength Double
photo_iso Int
photo_orientation Int
photo_takenDateTime Datetime
publication_level String
publication_versionId String
remoteItem_createdBy_application_displayName String
remoteItem_createdBy_application_id String
remoteItem_createdDateTime Datetime
remoteItem_file_hashes_crc32Hash String
remoteItem_file_hashes_quickXorHash String
remoteItem_file_hashes_sha1Hash String
remoteItem_file_hashes_sha256Hash String
remoteItem_file_mimeType String
remoteItem_file_processingMetadata Bool
remoteItem_fileSystemInfo_createdDateTime Datetime
remoteItem_fileSystemInfo_lastAccessedDateTime Datetime
remoteItem_fileSystemInfo_lastModifiedDateTime Datetime
remoteItem_folder_childCount Int
remoteItem_folder_view_sortBy String
remoteItem_folder_view_sortOrder String
remoteItem_folder_view_viewType String
remoteItem_id String
remoteItem_image_height Int
remoteItem_image_width Int
remoteItem_lastModifiedDateTime Datetime
remoteItem_name String
remoteItem_package_type String
remoteItem_parentReference_driveId String
remoteItem_parentReference_driveType String
remoteItem_parentReference_id String
remoteItem_parentReference_name String
remoteItem_parentReference_path String
remoteItem_parentReference_shareId String
remoteItem_parentReference_sharepointIds_listId String
remoteItem_parentReference_sharepointIds_listItemId String
remoteItem_parentReference_sharepointIds_listItemUniqueId String
remoteItem_parentReference_sharepointIds_siteId String
remoteItem_parentReference_sharepointIds_siteUrl String
remoteItem_parentReference_sharepointIds_tenantId String
remoteItem_parentReference_sharepointIds_webId String
remoteItem_parentReference_siteId String
remoteItem_shared_scope String
remoteItem_shared_sharedDateTime Datetime
remoteItem_size Long
remoteItem_specialFolder_name String
remoteItem_video_audioBitsPerSample Int
remoteItem_video_audioChannels Int
remoteItem_video_audioFormat String
remoteItem_video_audioSamplesPerSecond Int
remoteItem_video_bitrate Int
remoteItem_video_duration Long
remoteItem_video_fourCC String
remoteItem_video_frameRate Double
remoteItem_video_height Int
remoteItem_video_width Int
remoteItem_webDavUrl String
remoteItem_webUrl String
searchResult_onClickTelemetryUrl String
shared_owner_application_displayName String
shared_owner_application_id String
shared_scope String
shared_sharedDateTime Datetime
sharepointIds_listId String
sharepointIds_listItemId String
sharepointIds_listItemUniqueId String
sharepointIds_siteId String
sharepointIds_siteUrl String
sharepointIds_tenantId String
sharepointIds_webId String
size Long
specialFolder_name String
video_audioBitsPerSample Int
video_audioChannels Int
video_audioFormat String
video_audioSamplesPerSecond Int
video_bitrate Int
video_duration Long
video_fourCC String
video_frameRate Double
video_height Int
video_width Int
webDavUrl String
Linkedanalytics String
Linkedchildren String
LinkedlistItem String
Linkedpermissions String
Linkedsubscriptions String
Linkedthumbnails String
Linkedversions String
Linkedworkbook String

Usuários

A tabela Usuários do OneDrive na qual um usuário administrador pode exibir os detalhes dos usuários.

Informações dos Usuários

A projeção é feita do lado do servidor. A consultar de seleção básica é suportada, por exemplo:

SELECT * FROM Users

Usando esta visualização, um usuário administrador pode listar todos os detalhes de outros usuários.

Colunas
Nome Tipo Referências Descrição
id [KEY] String
Etag String
createdBy_user_id String
createdBy_user_displayName String
lastModifiedBy_user_id String
lastModifiedBy_user_displayName String
deletedDateTime Datetime
aboutMe String
accountEnabled Bool
ageGroup String
assignedLicenses String
assignedPlans String
birthday Datetime
businessPhones String
city String
companyName String
consentProvidedForMinor String
country String
createdDateTime Datetime
creationType String
department String
deviceEnrollmentLimit Int
displayName String
employeeHireDate Datetime
employeeId String
employeeOrgData_costCenter String
employeeOrgData_division String
employeeType String
externalUserState String
externalUserStateChangeDateTime Datetime
faxNumber String
givenName String
hireDate Datetime
identities String
imAddresses String
interests String
isResourceAccount Bool
jobTitle String
lastPasswordChangeDateTime Datetime
legalAgeGroupClassification String
licenseAssignmentStates String
mail String
mailboxSettings_archiveFolder String
mailboxSettings_automaticRepliesSetting_externalAudience String
mailboxSettings_automaticRepliesSetting_externalReplyMessage String
mailboxSettings_automaticRepliesSetting_internalReplyMessage String
mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_dateTime Datetime
mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_timeZone String
mailboxSettings_automaticRepliesSetting_status String
mailboxSettings_dateFormat String
mailboxSettings_delegateMeetingMessageDeliveryOptions String
mailboxSettings_language_displayName String
mailboxSettings_language_locale String
mailboxSettings_timeFormat String
mailboxSettings_timeZone String
mailboxSettings_workingHours_daysOfWeek String
mailboxSettings_workingHours_endTime Time
mailboxSettings_workingHours_startTime Time
mailboxSettings_workingHours_timeZone_name String
mailNickname String
mobilePhone String
mySite String
officeLocation String
onPremisesDistinguishedName String
onPremisesDomainName String
onPremisesExtensionAttributes_extensionAttribute1 String
onPremisesExtensionAttributes_extensionAttribute10 String
onPremisesExtensionAttributes_extensionAttribute11 String
onPremisesExtensionAttributes_extensionAttribute12 String
onPremisesExtensionAttributes_extensionAttribute13 String
onPremisesExtensionAttributes_extensionAttribute14 String
onPremisesExtensionAttributes_extensionAttribute15 String
onPremisesExtensionAttributes_extensionAttribute2 String
onPremisesExtensionAttributes_extensionAttribute3 String
onPremisesExtensionAttributes_extensionAttribute4 String
onPremisesExtensionAttributes_extensionAttribute5 String
onPremisesExtensionAttributes_extensionAttribute6 String
onPremisesExtensionAttributes_extensionAttribute7 String
onPremisesExtensionAttributes_extensionAttribute8 String
onPremisesExtensionAttributes_extensionAttribute9 String
onPremisesImmutableId String
onPremisesLastSyncDateTime Datetime
onPremisesProvisioningErrors String
onPremisesSamAccountName String
onPremisesSecurityIdentifier String
onPremisesSyncEnabled Bool
onPremisesUserPrincipalName String
otherMails String
passwordPolicies String
passwordProfile_forceChangePasswordNextSignIn Bool
passwordProfile_forceChangePasswordNextSignInWithMfa Bool
passwordProfile_password String
pastProjects String
postalCode String
preferredLanguage String
preferredName String
provisionedPlans String
proxyAddresses String
responsibilities String
schools String
showInAddressList Bool
signInSessionsValidFromDateTime Datetime
skills String
state String
streetAddress String
surname String
usageLocation String
userPrincipalName String
userType String
Linkedactivities String
LinkedappRoleAssignments String
Linkedauthentication String
Linkedcalendar String
LinkedcalendarGroups String
Linkedcalendars String
LinkedcalendarView String
Linkedchats String
LinkedcontactFolders String
Linkedcontacts String
LinkedcreatedObjects String
LinkeddeviceManagementTroubleshootingEvents String
LinkeddirectReports String
Linkeddrive String
Linkeddrives String
Linkedevents String
Linkedextensions String
LinkedfollowedSites String
LinkedInferenceClassification String
LinkedInsights String
LinkedjoinedTeams String
LinkedlicenseDetails String
LinkedmailFolders String
LinkedmanagedAppRegistrations String
LinkedmanagedDevices String
Linkedmanager String
LinkedmemberOf String
Linkedmessages String
Linkedoauth2PermissionGrants String
Linkedonenote String
LinkedonlineMeetings String
Linkedoutlook String
LinkedownedDevices String
LinkedownedObjects String
Linkedpeople String
Linkedphoto String
Linkedphotos String
Linkedplanner String
Linkedpresence String
LinkedregisteredDevices String
LinkedscopedRoleMemberOf String
Linkedsettings String
Linkedteamwork String
Linkedtodo String
LinkedtransitiveMemberOf String
ParentReference String

Procedimentos Armazenados

Procedimentos armazenados* estão disponíveis para complementar os dados disponíveis no Modelo de Dados. Pode ser necessário atualizar os dados disponíveis em uma exibição usando um procedimento armazenado* porque os dados não fornecem atualizações bidirecionais diretas, semelhantes a tabelas. Nessas situações, a recuperação dos dados é feita usando a visualização ou tabela apropriada, enquanto a atualização é feita chamando um procedimento armazenado. Procedimentos armazenados* pega uma lista de parâmetros e retorna um conjunto de dados que contém a coleção de tuplas que constituem a resposta.

Conector Jitterbit para Procedimentos Armazenados do OneDrive

CopyResource

Copie um recurso de um diretório em sua unidade para outro.

Entrada
Nome Tipo Obrigatório Descrição
ParentID String Verdade O ID da pasta para a qual você deseja copiar o recurso.
NewName String Falso O novo nome do recurso copiado. Se não for especificado, o recurso será copiado com o mesmo nome que já possui e para o diretório em que está atualmente, independentemente do valor de ParentID.
ResourcePath String Falso A localização do recurso.
ResourceId String Falso ID do recurso.
SourceDriveId String Falso O ID da unidade em que o recurso está localizado, se for diferente da unidade do usuário atual.
DestinationDriveId String Falso A ID da unidade para a qual copiar o recurso, se for diferente de SourceDriveId.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Resultados da cópia de arquivo.

Criar Pasta

Crie uma nova pasta em sua unidade.

Entrada
Nome Tipo Obrigatório Descrição
FolderName String Verdade Nome da pasta a ser criada.
RenameIfExists String Falso Defina como 'true' quando quiser renomear a pasta quando existir outra pasta com o mesmo nome.
ParentId String Falso ID da pasta onde você deseja que a nova pasta seja criada.
DriveId String Falso O ID da unidade em que o recurso está localizado, se for diferente da unidade do usuário atual.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Id String ID do Foler criado.

CriarAssinatura

Assina um aplicativo de escuta para receber notificações quando os dados são alterados.

Entrada
Nome Tipo Obrigatório Descrição
ChangeType String Verdade Indica o tipo de alteração no recurso assinado que gerará uma notificação de alteração. Os valores suportados são: criado, atualizado, excluído. Vários valores podem ser combinados usando uma lista separada por vírgulas.
NotificationUrl String Verdade A URL do endpoint que receberá as notificações de alteração. Essa URL deve fazer uso do protocolo HTTPS.
Resource String Verdade Especifica o recurso que será monitorado quanto a mudanças. Não inclua a URL base ( https://graph.microsoft.com/v1.0/).
ExpirationDateTime String Falso A data e a hora em UTC em que a assinatura expirará. Consulte a documentação da Microsoft para obter a duração máxima de cada tipo de endpoint https://docs.microsoft.com/en-us/graph/api/resources/subscription?view=graph-rest-1.0.
ClientState String Falso Especifica o valor da propriedade clientState enviada pelo serviço em cada notificação de alteração. O comprimento máximo é de 128 caracteres. O cliente pode verificar se a notificação de alteração veio do serviço comparando o valor da propriedade clientState enviado com a assinatura com o valor da propriedade clientState recebido a cada notificação de alteração.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Id String ID da assinatura criada.

DeleteResource

Exclua um recurso de sua unidade.

Entrada
Nome Tipo Obrigatório Descrição
ResourcePath String Falso A localização do recurso.
ResourceId String Falso ID do recurso.
DriveId String Falso O ID da unidade em que o recurso está localizado, se for diferente da unidade do usuário atual.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Resultados de exclusão de arquivo.

Excluir Assinatura

Assina um aplicativo de escuta para receber notificações quando os dados são alterados.

Entrada
Nome Tipo Obrigatório Descrição
Id String Verdade ID da assinatura criada.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Resultados de exclusão de assinatura.

⇬ Fazer Download do Arquivo

Baixe um arquivo existente de sua unidade.

Entrada
Nome Tipo Obrigatório Descrição
ResourcePath String Falso A localização do recurso.
ResourceId String Falso O ID do recurso a ser baixado.
DriveId String Falso O ID da unidade em que o recurso está localizado, se for diferente da unidade do usuário atual.
LocalFile String Falso O caminho do arquivo local, incluindo o nome do arquivo para o local onde o arquivo será salvo no disco. Deixe em branco para manter o arquivo na memória.
Encoding String Falso Se a entrada LocalFile for deixada em branco, os dados serão enviados para FileData na codificação especificada. Os valores permitidos são NONE, BASE64. O valor padrão é BASE64.
Overwrite String Falso O que fazer quando o arquivo baixado existe. Defina true para substituir.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
FileData String Se a entrada LocalFile estiver vazia, os dados do arquivo serão gerados no formato especificado pela entrada Encoding.
Success String Resultados do download do arquivo.

GetAdminConsentURL

Obtém a URL de consentimento do administrador que deve ser aberta separadamente por um administrador de um determinado domínio para conceder acesso ao seu aplicativo. Necessário apenas ao usar credenciais OAuth personalizadas.

Entrada
Nome Tipo Obrigatório Descrição
CallbackUrl String Falso A URL para a qual o usuário será redirecionado após autorizar seu aplicativo. Esse valor deve corresponder à URL de resposta nas configurações do aplicativo Azure AD.
State String Falso O mesmo valor para o estado que você enviou quando solicitou o código de autorização.
Scope String Falso Uma lista separada por espaços de escopos a serem solicitados ao administrador. o valor padrão é *https://graph.microsoft.com/files.readwrite.all*.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
URL String O URL de autorização, inserido em um navegador da Web para obter o token do verificador e autorizar seu aplicativo.

GetOAuthAccessToken

Obtém um token de autenticação do OneDrive.

Entrada
Nome Tipo Obrigatório Descrição
AuthMode String Falso O tipo de modo de autenticação a ser usado. Selecione App para obter tokens de autenticação por meio de um aplicativo de desktop. Selecione Web para obter tokens de autenticação por meio de um aplicativo Web. Os valores permitidos são APP, WEB. O valor padrão é APP.
CallbackUrl String Falso A URL para a qual o usuário será redirecionado após autorizar seu aplicativo. Esse valor deve corresponder à URL de resposta que você especificou nas configurações do aplicativo Azure AD.
Verifier String Falso O verificador retornou do Azure AD depois que o usuário autorizou seu aplicativo a ter acesso aos dados dele. Esse valor será retornado como um parâmetro para a URL de retorno de chamada.
Scope String Falso Uma lista separada por espaços de escopos a serem solicitados ao usuário quando OAuthGrantType='CODE'. Quando OAuthGrantType='CLIENT', um escopo de 'https://graph.microsoft.com/.default' é usado. '/.default' seleciona todas as permissões que seu aplicativo já possui. O valor padrão é *offline_access https://graph.microsoft.com/files.readwrite.all*.
State String Falso Uma string arbitrária de sua escolha que é retornada ao seu aplicativo; uma ida e volta bem-sucedida dessa string ajuda a garantir que seu aplicativo iniciou a solicitação.
Prompt String Falso O padrão é 'select_account', que solicita que o usuário selecione a conta durante a autenticação. Defina como 'Nenhum', para nenhum prompt, 'login' para forçar o usuário a inserir suas credenciais ou 'consentimento' para acionar a caixa de diálogo de consentimento OAuth depois que o usuário entrar, solicitando que ele conceda permissões ao aplicativo.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
OAuthAccessToken String O token de acesso usado para comunicação com o OneDrive.
ExpiresIn String O tempo de vida restante no token de acesso. Um -1 denota que não irá expirar.
OAuthRefreshToken String Atualizar token para renovar o token de acesso.

GetOAuthAuthorizationURL

Obtém a URL de autorização que deve ser aberta separadamente pelo usuário para conceder acesso ao seu aplicativo. Necessário apenas ao desenvolver aplicativos da Web. Você solicitará o token de autenticação deste URL.

Entrada
Nome Tipo Obrigatório Descrição
CallbackUrl String Falso A URL para a qual o usuário será redirecionado após autorizar seu aplicativo. Esse valor deve corresponder à URL de resposta nas configurações do aplicativo Azure AD.
State String Falso O mesmo valor para o estado que você enviou quando solicitou o código de autorização.
Scope String Falso Uma lista separada por espaços de escopos a serem solicitados ao usuário quando OAuthGrantType='CODE'. Quando OAuthGrantType='CLIENT', um escopo de 'https://graph.microsoft.com/.default' é usado. '/.default' seleciona todas as permissões que seu aplicativo já possui. O valor padrão é *offline_access https://graph.microsoft.com/files.readwrite.all*.
Prompt String Falso O padrão é 'select_account', que solicita que o usuário selecione a conta durante a autenticação. Defina como 'Nenhum', para nenhum prompt, 'login' para forçar o usuário a inserir suas credenciais ou 'consentimento' para acionar a caixa de diálogo de consentimento OAuth depois que o usuário entrar, solicitando que ele conceda permissões ao aplicativo.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
URL String O URL de autorização, inserido em um navegador da Web para obter o token do verificador e autorizar seu aplicativo.

Modificar Assinatura

Assina um aplicativo de escuta para receber notificações quando os dados são alterados.

Entrada
Nome Tipo Obrigatório Descrição
ExpirationDateTime String Verdade A data e a hora em UTC em que a assinatura expirará.
Id String Verdade ID da assinatura criada.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Id String ID da assinatura criada.
ChangeType String Nome da pasta a ser criada.
NotificationUrl String O endpoint do Webhook no qual você deseja se inscrever.
Resource String O caminho do recurso para os detalhes da assinatura.
ExpirationDateTime String A data e a hora em UTC em que a assinatura expirará.
ClientState String Seqüência de caracteres codificada que contém os dados de estados de exibição e controle da página da Web

MoveResource

Mova um recurso de um diretório em sua unidade para outro.

Entrada
Nome Tipo Obrigatório Descrição
DestinationID String Verdade O ID da pasta para a qual você deseja mover o recurso.
ResourcePath String Falso A localização do recurso.
ResourceId String Falso ID do recurso.
DriveId String Falso O ID da unidade em que o recurso está localizado, se for diferente da unidade do usuário atual.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Resultados da movimentação de arquivos.

RefreshOAuthAccessToken

Atualiza o token de acesso OAuth usado para autenticação com vários serviços do Office 365.

Entrada
Nome Tipo Obrigatório Descrição
OAuthRefreshToken String Verdade O token de atualização retornado da troca do código de autorização original.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
OAuthAccessToken String O token de autenticação retornado do Azure AD. Isso pode ser usado em chamadas subseqüentes para outras operações para este serviço específico.
OAuthRefreshToken String Um token que pode ser usado para obter um novo token de acesso.
ExpiresIn String O tempo de vida restante no token de acesso.

Subir Arquivo

Carregue um novo arquivo ou atualize o conteúdo de um arquivo existente.

Entrada
Nome Tipo Obrigatório Descrição
FileName String Verdade Nome do arquivo para o qual você enviará o conteúdo.
ParentId String Verdade Em qual pai carregar o arquivo.
DriveId String Falso O ID da unidade para carregar o arquivo se for diferente da unidade do usuário atual.
Content String Falso Conteúdo do arquivo a ser carregado.
LocalFile String Falso Arquivo local contendo o conteúdo a ser carregado.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Resultados do upload do arquivo.

Tabelas do Sistema

Você pode consultar as tabelas do sistema descritas nesta seção para acessar informações de esquema, informações sobre a funcionalidade da fonte de dados e estatísticas de operação em lote.

Tabelas de Esquema

As tabelas a seguir retornam metadados de banco de dados para OneDrive:

Tabelas de Fonte de Dados

As tabelas a seguir retornam informações sobre como se conectar e consultar a fonte de dados:

  • sys_connection_props: Retorna informações sobre as propriedades de conexão disponíveis.
  • sys_sqlinfo: Descreve as consultas SELECT que o conector pode descarregar para a fonte de dados.

Consultar Tabelas de Informações

A tabela a seguir retorna estatísticas de consultar para consultas de modificação de dados:

  • sys_identity: Retorna informações sobre operações em lote ou atualizações únicas.

Sys_catalogs

Lista os bancos de dados disponíveis.

A consultar a seguir recupera todos os bancos de dados determinados pela string de conexão:

SELECT * FROM sys_catalogs
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados.

Sys_schemas

Lista os esquemas disponíveis.

A consultar a seguir recupera todos os esquemas disponíveis:

SELECT * FROM sys_schemas
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados.
SchemaName String O nome do esquema.

Sys_tables

Lista as tabelas disponíveis.

A consultar a seguir recupera as tabelas e exibições disponíveis:

SELECT * FROM sys_tables
Colunas
Nome Tipo Descrição
CatalogName String O banco de dados que contém a tabela ou exibição.
SchemaName String O esquema que contém a tabela ou exibição.
TableName String O nome da tabela ou exibição.
TableType String O tipo de tabela (tabela ou exibição).
Description String Uma descrição da tabela ou exibição.
IsUpdateable Boolean Se a tabela pode ser atualizada.

Sys_tablecolumns

Descreve as colunas das tabelas e exibições disponíveis.

A consultar a seguir retorna as colunas e os tipos de dados da tabela Arquivos:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Files'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a tabela ou exibição.
SchemaName String O esquema que contém a tabela ou exibição.
TableName String O nome da tabela ou exibição que contém a coluna.
ColumnName String O nome da coluna.
DataTypeName String O nome do tipo de dados.
DataType Int32 Um número inteiro indicando o tipo de dados. Esse valor é determinado no tempo de execução com base no ambiente.
Length Int32 O tamanho de armazenamento da coluna.
DisplaySize Int32 A largura máxima normal da coluna designada em caracteres.
NumericPrecision Int32 O número máximo de dígitos em dados numéricos. O comprimento da coluna em caracteres para caracteres e dados de data e hora.
NumericScale Int32 A escala da coluna ou o número de dígitos à direita do ponto decimal.
IsNullable Boolean Se a coluna pode conter null.
Description String Uma breve descrição da coluna.
Ordinal Int32 O número de sequência da coluna.
IsAutoIncrement String Se o valor da coluna é atribuído em incrementos fixos.
IsGeneratedColumn String Se a coluna é gerada.
IsHidden Boolean Se a coluna está oculta.
IsArray Boolean Se a coluna é uma matriz.

Sys_procedures

Lista os procedimentos armazenados disponíveis.

A consultar a seguir recupera os procedimentos armazenados disponíveis:

SELECT * FROM sys_procedures
Colunas
Nome Tipo Descrição
CatalogName String O banco de dados que contém o procedimento armazenado.
SchemaName String O esquema que contém o procedimento armazenado.
ProcedureName String O nome do procedimento armazenado.
Description String Uma descrição do procedimento armazenado.
ProcedureType String O tipo do procedimento, como PROCEDURE ou FUNCTION.

Sys_procedureparameters

Descreve procedimento armazenado* parâmetros.

A consultar a seguir retorna informações sobre todos os parâmetros de entrada para o procedimento armazenado DownloadResource:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='DownloadResource' AND Direction=1 OR Direction=2
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém o procedimento armazenado.
SchemaName String O nome do esquema que contém o procedimento armazenado.
ProcedureName String O nome do procedimento armazenado* contendo o parâmetro.
ColumnName String O nome do procedimento armazenado* parâmetro.
Direction Int32 Um número inteiro correspondente ao tipo do parâmetro: entrada (1), entrada/saída (2) ou saída (4). parâmetros de tipo de entrada/saída podem ser parâmetros de entrada e saída.
DataTypeName String O nome do tipo de dados.
DataType Int32 Um número inteiro indicando o tipo de dados. Esse valor é determinado no tempo de execução com base no ambiente.
Length Int32 O número de caracteres permitido para dados de caractere. O número de dígitos permitidos para dados numéricos.
NumericPrecision Int32 A precisão máxima para dados numéricos. O comprimento da coluna em caracteres para caracteres e dados de data e hora.
NumericScale Int32 O número de dígitos à direita do ponto decimal em dados numéricos.
IsNullable Boolean Se o parâmetro pode conter null.
IsRequired Boolean Se o parâmetro é necessário para a execução do procedimento.
IsArray Boolean Se o parâmetro é uma matriz.
Description String A descrição do parâmetro.
Ordinal Int32 O índice do parâmetro.

Sys_keycolumns

Descreve as chaves primárias e estrangeiras. A consultar a seguir recupera a chave primária da tabela Arquivos:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Files'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a chave.
SchemaName String O nome do esquema que contém a chave.
TableName String O nome da tabela que contém a chave.
ColumnName String O nome da coluna chave.
IsKey Boolean Se a coluna é uma chave primária na tabela referenciada no campo TableName.
IsForeignKey Boolean Se a coluna é uma chave estrangeira referenciada no campo TableName.
PrimaryKeyName String O nome da chave primária.
ForeignKeyName String O nome da chave estrangeira.
ReferencedCatalogName String O banco de dados que contém a chave primária.
ReferencedSchemaName String O esquema que contém a chave primária.
ReferencedTableName String A tabela que contém a chave primária.
ReferencedColumnName String O nome da coluna da chave primária.

Sys_foreignkeys

Descreve as chaves estrangeiras. A consultar a seguir recupera todas as chaves estrangeiras que se referem a outras tabelas:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a chave.
SchemaName String O nome do esquema que contém a chave.
TableName String O nome da tabela que contém a chave.
ColumnName String O nome da coluna chave.
PrimaryKeyName String O nome da chave primária.
ForeignKeyName String O nome da chave estrangeira.
ReferencedCatalogName String O banco de dados que contém a chave primária.
ReferencedSchemaName String O esquema que contém a chave primária.
ReferencedTableName String A tabela que contém a chave primária.
ReferencedColumnName String O nome da coluna da chave primária.
ForeignKeyType String Designa se a chave estrangeira é uma chave de importação (aponta para outras tabelas) ou de exportação (referenciada de outras tabelas).

Sys_indexes

Descreve os índices disponíveis. Ao filtrar por índices, você pode escrever consultas mais seletivas com tempos de resposta de consultar mais rápidos.

A consultar a seguir recupera todos os índices que não são chaves primárias:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém o índice.
SchemaName String O nome do esquema que contém o índice.
TableName String O nome da tabela que contém o índice.
IndexName String O nome do índice.
ColumnName String O nome da coluna associada ao índice.
IsUnique Boolean True se o índice for exclusivo. Falso caso contrário.
IsPrimary Boolean Verdadeiro se o índice for uma chave primária. Falso caso contrário.
Type Int16 Um valor inteiro correspondente ao tipo de índice: estatística (0), agrupado (1), hash (2) ou outro (3).
SortOrder String A ordem de classificação: A para crescente ou D para decrescente.
OrdinalPosition Int16 O número de sequência da coluna no índice.

Sys_connection_props

Retorna informações sobre as propriedades de conexão disponíveis e as definidas na string de conexão.

Ao consultar esta tabela, a string de conexão de configuração deve ser usada:

jdbc:cdata:onedrive:config:

Esta string de conexão permite que você consultar esta tabela sem uma conexão válida.

A consultar a seguir recupera todas as propriedades de conexão que foram definidas na string de conexão ou definidas por meio de um valor padrão:

SELECT * FROM sys_connection_props WHERE Value <> ''
Colunas
Nome Tipo Descrição
Name String O nome da propriedade de conexão.
ShortDescription String Uma breve descrição.
Type String O tipo de dados da propriedade de conexão.
Default String O valor padrão, se não houver um definido explicitamente.
Values String Uma lista separada por vírgulas de valores possíveis. Um erro de validação é lançado se outro valor for especificado.
Value String O valor que você definiu ou um padrão pré-configurado.
Required Boolean Se a propriedade é necessária para se conectar.
Category String A categoria da propriedade de conexão.
IsSessionProperty String Se a propriedade é uma propriedade de sessão, usada para salvar informações sobre a conexão atual.
Sensitivity String O nível de sensibilidade da propriedade. Isso informa se a propriedade está ofuscada nos formulários de registro e autenticação.
PropertyName String Uma forma truncada em camel case do nome da propriedade de conexão.
Ordinal Int32 O índice do parâmetro.
CatOrdinal Int32 O índice da categoria do parâmetro.
Hierarchy String Mostra as propriedades dependentes associadas que precisam ser definidas juntamente com esta.
Visible Boolean Informa se a propriedade está visível na UI da conexão.
ETC String Diversas informações diversas sobre o imóvel.

Sys_sqlinfo

Descreve o processamento da consultar SELECT que o conector pode transferir para a fonte de dados.

Processamento de Consultas Colaborativas

Ao trabalhar com fontes de dados que não suportam SQL-92, você pode consultar a exibição sys_sqlinfo para determinar os recursos de consultar das APIs subjacentes, expressas na sintaxe SQL. O conector transfere o máximo possível do processamento da instrução SELECT para o servidor e, em seguida, processa o restante da consultar na memória.

Descobrindo os Recursos SELECT da Fonte de Dados

Abaixo está um exemplo de conjunto de dados de recursos SQL. O conjunto de resultados a seguir indica a funcionalidade SELECT que o conector pode descarregar para a fonte de dados ou processar o lado do cliente. Sua fonte de dados pode suportar sintaxe SQL adicional. Alguns aspectos da funcionalidade SELECT são retornados em uma lista separada por vírgulas, se suportados; caso contrário, a coluna contém NO.

Nome Descrição Valores Possíveis
AGGREGATE_FUNCTIONS Funções de agregação suportadas. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Se a função COUNT é suportada. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR O caractere de abertura usado para escapar de um identificador. [
IDENTIFIER_QUOTE_CLOSE_CHAR O caractere de fechamento usado para escapar de um identificador. ]
SUPPORTED_OPERATORS Uma lista de operadores SQL com suporte. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Se GROUP BY é compatível e, em caso afirmativo, o grau de suporte. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Funções de string suportadas. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Funções numéricas suportadas. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Funções de data/hora suportadas. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indica tabelas ignoradas durante a replicação.
REPLICATION_TIMECHECK_COLUMNS Uma matriz de string contendo uma lista de colunas que serão usadas para verificar (na ordem especificada) para usar como uma coluna modificada durante a replicação.
IDENTIFIER_PATTERN Valor de string que indica qual string é válida para um identificador.
SUPPORT_TRANSACTION Indica se o provedor oferece suporte a transações como confirmação e reversão. YES, NO
DIALECT Indica o dialeto SQL a ser usado.
KEY_PROPERTIES Indica as propriedades que identificam o banco de dados uniforme.
SUPPORTS_MULTIPLE_SCHEMAS Indica se vários esquemas podem existir para o provedor. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indica se vários catálogos podem existir para o provedor. YES, NO
DATASYNCVERSION A versão do Data Sync necessária para acessar este driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY A categoria Data Sync deste driver. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Se a funcionalidade SQL aprimorada além do que é oferecido pela API é suportada. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Se as operações em lote são suportadas. YES, NO
SQL_CAP Todos os recursos SQL suportados para este driver. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS Um valor de string especifica o cacheOptions preferencial.
ENABLE_EF_ADVANCED_QUERY Indica se o driver oferece suporte direto a consultas avançadas provenientes do Entity Framework. Caso contrário, as consultas serão tratadas no lado do cliente. YES, NO
PSEUDO_COLUMNS Uma matriz de cadeia de caracteres que indica as pseudocolunas disponíveis.
MERGE_ALWAYS Se o valor for verdadeiro, o modo de mesclagem será executado à força no Data Sync. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY Uma consultar de seleção para retornar a data e hora de início da replicação.
REPLICATION_MIN_FUNCTION Permite que um provedor especifique o nome da fórmula a ser usado para executar um min do lado do servidor.
REPLICATION_START_DATE Permite que um provedor especifique uma data de início de replicação.
REPLICATION_MAX_DATE_QUERY Uma consultar de seleção para retornar a data e hora de término da replicação.
REPLICATION_MAX_FUNCTION Permite que um provedor especifique o nome da fórmula a ser usado para executar um máximo do lado do servidor.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE Uma lista de tabelas que ignorará a divisão da replicação em blocos na replicação inicial.
CHECKCACHE_USE_PARENTID Indica se a instrução CheckCache deve ser executada na coluna de chave pai. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indica procedimentos armazenados* que pode ser usado para gerar arquivos de esquema.

A consultar a seguir recupera os operadores que podem ser usados na cláusula WHERE:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Observe que tabelas individuais podem ter diferentes limitações ou requisitos na cláusula WHERE; consulte o Modelo de Dados para obter mais informações.

Colunas
Nome Tipo Descrição
NAME String Um componente da sintaxe SQL ou um recurso que pode ser processado no servidor.
VALUE String Detalhes sobre a sintaxe SQL ou SQL suportada.

Sys_identity

Retorna informações sobre tentativas de modificação.

A consultar a seguir recupera os IDs das linhas modificadas em uma operação em lote:

SELECT * FROM sys_identity
Colunas
Nome Tipo Descrição
Id String O ID gerado pelo banco de dados retornado de uma operação de modificação de dados.
Batch String Um identificador para o lote. 1 para uma única operação.
Operation String O resultado da operação no lote: INSERTED, UPDATED ou DELETED.
Message String SUCCESS ou uma mensagem de erro se a atualização no lote falhou.

Mapeamento de Tipo de Dados

Mapeamentos de Tipo de Dados

O conector mapeia os tipos da fonte de dados para o tipo de dados correspondente disponível no esquema. A tabela abaixo documenta esses mapeamentos.

OneDrive (OData V4) Esquema
Edm.Binary binário
Edm.Boolean bool
Edm.Date data e hora
Edm.DateTimeOffset data e hora
Edm.Decimal decimal
Edm.Double duplo
Edm.Guid guia
Edm.Int32 int
Edm.String cadeia
Edm.TimeOfDay tempo

Propriedades de Configurações Avançadas

As propriedades de configurações avançadas são as várias opções que podem ser usadas para estabelecer uma conexão. Esta seção fornece uma lista completa das opções que você pode configurar. Clique nos links para mais detalhes.

Autenticação

Propriedade Descrição
AuthScheme O tipo de autenticação a ser usado ao conectar-se ao Microsoft OneDrive.

Autenticação do Azure

Propriedade Descrição
AzureTenant O locatário do Microsoft Online sendo usado para acessar dados. Se não for especificado, seu tentante padrão será usado.
AzureEnvironment O ambiente do Azure a ser usado ao estabelecer uma conexão.

OAuth

Propriedade Descrição
InitiateOAuth Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.
OAuthClientId O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthClientSecret O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthGrantType O tipo de concessão para o fluxo OAuth.

SSL

Propriedade Descrição
SSLServerCert O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

Exploração madeireira

Propriedade Descrição
Logfile Um caminho de arquivo que designa o nome e a localização do arquivo de log.
Verbosity O nível de detalhamento que determina a quantidade de detalhes incluídos no arquivo de log.
LogModules Módulos principais a serem incluídos no arquivo de log.
MaxLogFileSize Uma string especificando o tamanho máximo em bytes para um arquivo de log (por exemplo, 10 MB).
MaxLogFileCount Uma string especificando a contagem máxima de arquivos de log.

Esquema

Propriedade Descrição
Location Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.
BrowsableSchemas Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA, TableB, TableC.
Views Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC.

Diversos

Propriedade Descrição
DirectoryRetrievalDepth Especifique quantas pastas você deseja obter resultados para as tabelas Pastas, Arquivos, SharedResources e Permissions. Os recursos diretamente na raiz estão localizados na profundidade 0. Os recursos uma pasta mais abaixo estão localizados na profundidade 1 e assim por diante. Você pode especificar um valor de -1 para obter todos os dados em uma unidade, independentemente da profundidade em que estão.TABLEROWEND
DriveId O ID do Drive que você deseja usar.
ListGroupDrives Escolha se deseja listar suas unidades de grupo ou não ao consultar a tabela de Unidades.
MaxRows Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.
Other Essas propriedades ocultas são usadas apenas em casos de uso específicos.
PseudoColumns Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.
Timeout O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

Autenticação

Esta seção fornece uma lista completa de propriedades de autenticação que você pode configurar.

Propriedade Descrição
AuthScheme O tipo de autenticação a ser usado ao conectar-se ao OneDrive.

AuthScheme

O tipo de autenticação a ser usado ao conectar-se ao Microsoft OneDrive. Atualmente, apenas AzureServicePrincipal é suportado

Valores Possíveis

AzureServicePrincipal

Tipo de Dados

string

Valor Padrão

"AzureServicePrincipal"

Observações
  • AzureServicePrincipal: defina isso para autenticar como uma Entidade de Serviço do Azure.

Autenticação do Azure

Esta seção fornece uma lista completa das propriedades de autenticação do Azure que você pode configurar.

Propriedade Descrição
AzureTenant O locatário do Microsoft Online sendo usado para acessar dados. Se não for especificado, seu tentante padrão será usado.
AzureEnvironment O ambiente do Azure a ser usado ao estabelecer uma conexão.

AzureTenant

O locatário do Microsoft Online sendo usado para acessar dados. Se não for especificado, seu tentante padrão será usado.

Tipo de Dados

string

Valor Padrão

""

Observações

O locatário do Microsoft Online sendo usado para acessar dados. Por exemplo, "example.onmicrosoft.com". Como alternativa, especifique o ID do locatário. Esse valor é a ID do diretório no Portal do Azure > Azure Active Directory > Propriedades.

Normalmente não é necessário especificar o inquilino. Isso pode ser determinado automaticamente pela Microsoft ao usar o OAuthGrantType definido como CODE (padrão). No entanto, pode falhar caso o usuário pertença a vários locatários. Por exemplo, se um administrador do domínio A convidar um usuário do domínio B para ser um usuário convidado. O usuário agora pertencerá a ambos os locatários. É uma boa prática especificar o inquilino, embora em geral as coisas funcionem normalmente sem ter que especificá-lo.

O AzureTenant é necessário ao definir OAuthGrantType ao CLIENTE. Ao usar credenciais de cliente, não há contexto de usuário. As credenciais são obtidas do contexto do próprio aplicativo. Embora a Microsoft ainda permita que as credenciais do cliente sejam obtidas sem especificar qual locatário, ela tem uma probabilidade muito menor de escolher o locatário específico com o qual deseja trabalhar. Por este motivo, exigimos AzureTenant a ser declarado explicitamente para todas as conexões de credenciais do cliente para garantir que você obtenha credenciais aplicáveis ao domínio ao qual pretende se conectar.

Ambiente Azure

O ambiente do Azure a ser usado ao estabelecer uma conexão.

Valores Possíveis

GLOBAL, CHINA, GERMANY, USGOVT, USGOVTDOD

Tipo de Dados

string

Valor Padrão

"GLOBAL"

Observações

Na maioria dos casos, deixar o ambiente definido como global funcionará. No entanto, se sua conta do Azure tiver sido adicionada a um ambiente diferente, o AzureEnvironment pode ser usado para especificar qual ambiente. Os valores disponíveis são GLOBAL, CHINA, GERMANY, USGOVT e USGOVTDOD.

OAuth

Esta seção fornece uma lista completa de propriedades OAuth que você pode configurar.

Propriedade Descrição
InitiateOAuth Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.
OAuthClientId O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthClientSecret O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthGrantType O tipo de concessão para o fluxo OAuth.

InitiateOAuth

Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.

Valores Possíveis

GETANDREFRESH

Tipo de Dados

string

Valor Padrão

"GETANDREFRESH"

Observações

A seguinte opção é suportada:

  • GETANDREFRESH: Indica que todo o fluxo OAuth será tratado pelo conector. Se nenhum token existir atualmente, ele será obtido. Se existir um token, ele será atualizado quando aplicável.

OAuthClientId

O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId valor, às vezes também chamado de chave do consumidor, e um segredo do cliente, o OAuthClientSecret.

OAuthClientSecret

O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o segredo do cliente, também chamado de segredo do consumidor. Defina o segredo do cliente como OAuthClientSecret propriedade.

Você também receberá um OAuthClientId, também chamada de chave do consumidor.

OAuthAccessToken

O token de acesso para conexão usando OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

O OAuthAccessToken propriedade é usada para conectar usando OAuth. O OAuthAccessToken é recuperado do servidor OAuth como parte do processo de autenticação. Ele tem um tempo limite dependente do servidor e pode ser reutilizado entre as solicitações.

O token de acesso é usado no lugar do seu nome de usuário e senha. O token de acesso protege suas credenciais, mantendo-as no servidor.

OAuthGrantType

O tipo de concessão para o fluxo OAuth.

Valores Possíveis

CLIENT

Tipo de Dados

string

Valor Padrão

"CLIENT"

Observações

O tipo de concessão para o fluxo OAuth. Apenas o CLIENT opção é suportada.

URL de Retorno

O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.

Tipo de Dados

string

Valor Padrão

""

Observações

Durante o processo de autenticação, o servidor de autorização OAuth redireciona o usuário para esta URL. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.

OAuthVerifier

O código do verificador retornado da URL de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

O código do verificador retornado da URL de autorização OAuth. Isso pode ser usado em sistemas em que um navegador não pode ser iniciado, como sistemas headless.

Autenticação em Máquinas Sem Cabeça

Consulte para obter o OAuthVerifier valor.

Defina OAuthSettingsLocation juntamente com OAuthVerifier. Quando você conecta, o conector troca o OAuthVerifier para os tokens de autenticação OAuth e os salva, criptografados, no arquivo especificado. Definir InitiateOAuth para GETANDREFRESH automatizar a troca.

Depois que o arquivo de configurações OAuth for gerado, você poderá remover OAuthVerifier nas propriedades de conexão e conecte-se com OAuthSettingsLocation definir.

Para atualizar automaticamente os valores do token OAuth, defina OAuthSettingsLocation e adicionalmente defina InitiateOAuth para ATUALIZAR.

OAuthRefreshToken

O token de atualização OAuth para o token de acesso OAuth correspondente.

Tipo de Dados

string

Valor Padrão

""

Observações

O OAuthRefreshToken a propriedade é usada para atualizar o OAuthAccessToken ao usar a autenticação OAuth.

OAuthExpiresIn

O tempo de vida em segundos do OAuth AccessToken.

Tipo de Dados

string

Valor Padrão

""

Observações

Emparelhe com OAuthTokenTimestamp para determinar quando o AccessToken expirará.

OAuthTokenTimestamp

O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

Tipo de Dados

string

Valor Padrão

""

Observações

Emparelhe com OAuthExpiresIn para determinar quando o AccessToken expirará.

JWT OAuth

Esta seção fornece uma lista completa das propriedades JWT OAuth que você pode configurar.

Propriedade Descrição
OAuthJWTCert A loja de certificados JWT.
OAuthJWTCertType O tipo de armazenamento de chaves que contém o certificado JWT.
OAuthJWTCertPassword A senha para o certificado OAuth JWT.
OAuthJWTCertSubject O assunto do certificado OAuth JWT.
OAuthJWTIssuer O emissor do Java Web Token.
OAuthJWTSubject O assunto do usuário para o qual o aplicativo está solicitando acesso delegado.

OAuthJWTCert

A loja de certificados JWT.

Tipo de Dados

string

Valor Padrão

""

Observações

O nome do armazenamento de certificados para o certificado do cliente.

O OAuthJWTCertType campo especifica o tipo de armazenamento de certificado especificado por OAuthJWTCert. Se o armazenamento estiver protegido por senha, especifique a senha em OAuthJWTCertPassword.

OAuthJWTCert é usado em conjunto com o OAuthJWTCertSubject para especificar os certificados do cliente. Se OAuthJWTCert tem um valor e OAuthJWTCertSubject for definido, uma pesquisa por um certificado será iniciada. Consulte OAuthJWTCertSubject para obter detalhes.

As designações de armazenamentos de certificados dependem da plataforma.

A seguir estão as designações dos armazenamentos de certificados de Usuário e Máquina mais comuns no Windows:

Propriedade Descrição
MY Um armazenamento de certificados que contém certificados pessoais com suas chaves privadas associadas.
CA Certificados de autoridade certificadora.
ROOT Certificados raiz.
SPC Certificados de editor de software.

Em Java, o armazenamento de certificados normalmente é um arquivo contendo certificados e chaves privadas opcionais.

Quando o tipo de armazenamento de certificado for PFXFile, essa propriedade deverá ser configurada para o nome do arquivo. Quando o tipo é PFXBlob, a propriedade deve ser configurada para o conteúdo binário de um arquivo PFX (ou seja, armazenamento de certificados PKCS12).

OAuthJWTCertType

O tipo de armazenamento de chaves que contém o certificado JWT.

Valores Possíveis

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB

Tipo de Dados

string

Valor Padrão

"USER"

Observações

Esta propriedade pode assumir um dos seguintes valores:

Propriedade Descrição
USER Para Windows, isso especifica que o armazenamento de certificados é um armazenamento de certificados pertencente ao usuário atual. Nota: Este tipo de loja não está disponível em Java.
MACHINE Para Windows, isso especifica que o armazenamento de certificados é um armazenamento de máquina. Nota: este tipo de loja não está disponível em Java.
PFXFILE O armazenamento de certificados é o nome de um arquivo PFX (PKCS12) que contém certificados.
PFXBLOB O armazenamento de certificados é uma string (codificada em base 64) que representa um armazenamento de certificados no formato PFX (PKCS12).
JKSFILE O armazenamento de certificados é o nome de um arquivo de armazenamento de chaves Java (JKS) que contém certificados. Nota: este tipo de loja só está disponível em Java.
JKSBLOB O armazenamento de certificados é uma sequência (codificada em base 64) que representa um armazenamento de certificados no formato Java key store (JKS). Nota: este tipo de loja só está disponível em Java.
PEMKEY_FILE O armazenamento de certificados é o nome de um arquivo codificado por PEM que contém uma chave privada e um certificado opcional.
PEMKEY_BLOB O armazenamento de certificados é uma string (codificada em base64) que contém uma chave privada e um certificado opcional.
PUBLIC_KEY_FILE O armazenamento de certificados é o nome de um arquivo que contém um certificado de chave pública codificado por PEM ou DER.
PUBLIC_KEY_BLOB O armazenamento de certificados é uma string (codificada em base 64) que contém um certificado de chave pública codificado em PEM ou DER.
SSHPUBLIC_KEY_FILE O armazenamento de certificados é o nome de um arquivo que contém uma chave pública de estilo SSH.
SSHPUBLIC_KEY_BLOB O armazenamento de certificados é uma string (codificada em base 64) que contém uma chave pública de estilo SSH.
P7BFILE O armazenamento de certificados é o nome de um arquivo PKCS7 contendo certificados.
PPKFILE O armazenamento de certificados é o nome de um arquivo que contém um PPK (PuTTY Private Key).
XMLFILE O armazenamento de certificados é o nome de um arquivo que contém um certificado no formato XML.
XMLBLOB O armazenamento de certificados é uma string que contém um certificado no formato XML.

OAuthJWTCertPassword

A senha para o certificado OAuth JWT.

Tipo de Dados

string

Valor Padrão

""

Observações

Se o armazenamento de certificados for de um tipo que requer uma senha, essa propriedade será usada para especificar essa senha para abrir o armazenamento de certificados.

OAuthJWTCertSubject

O assunto do certificado OAuth JWT.

Tipo de Dados

string

Valor Padrão

"\*"

Observações

Ao carregar um certificado, o assunto é usado para localizar o certificado na loja.

Se uma correspondência exata não for encontrada, a loja é pesquisada em busca de assuntos que contenham o valor da propriedade.

Se uma correspondência ainda não for encontrada, a propriedade será definida como uma string vazia e nenhum certificado será selecionado.

O valor especial "*" seleciona o primeiro certificado no armazenamento de certificados.

O assunto do certificado é uma lista separada por vírgulas de campos e valores de nomes distintos. Por exemplo, "CN=www.server.com, OU=test, C=US, E=support@jitterbit.com". Os campos comuns e seus significados são exibidos abaixo.

Campo Significado
CN Nome comum. Geralmente, é um nome de hospedar como www.server.com.
O Organização
OU Unidade Organizacional
L Localidade
S Estado
C País
E Endereço E-mail

Se um valor de campo contiver uma vírgula, ela deverá ser colocada entre aspas.

OAuthJWTIssuer

O emissor do Java Web Token.

Tipo de Dados

string

Valor Padrão

""

Observações

O emissor do Java Web Token. Normalmente, é o ID do cliente ou o endereço E-mail do aplicativo OAuth.

OAuthJWTSubject

O assunto do usuário para o qual o aplicativo está solicitando acesso delegado.

Tipo de Dados

string

Valor Padrão

""

Observações

O assunto do usuário para o qual o aplicativo está solicitando acesso delegado. Normalmente, o nome da conta do usuário ou endereço de e-mail.

SSL

Esta seção fornece uma lista completa de propriedades SSL que você pode configurar.

Propriedade Descrição
SSLServerCert O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

SSLServerCert

O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

Tipo de Dados

string

Valor Padrão

""

Observações

Se estiver usando uma conexão TLS/SSL, esta propriedade pode ser usada para especificar o certificado TLS/SSL a ser aceito do servidor. Qualquer outro certificado que não seja confiável para a máquina é rejeitado.

Esta propriedade pode assumir as seguintes formas:

Descrição Exemplo
Um certificado PEM completo (exemplo abreviado para concisão) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
Um caminho para um arquivo local contendo o certificado C:\cert.cer
A chave pública (exemplo abreviado para concisão) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
O Thumbprint MD5 (os valores hexadecimais também podem ser separados por espaço ou dois-pontos) ecadbdda5a1529c58a1e9e09828d70e4
A impressão digital SHA1 (os valores hexadecimais também podem ser separados por espaço ou dois-pontos) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Se não for especificado, qualquer certificado confiável pela máquina será aceito.

Os certificados são validados como confiáveis pela máquina com base no armazenamento confiável do sistema. O armazenamento confiável usado é o valor 'javax.net.ssl.trustStore' especificado para o sistema. Se nenhum valor for especificado para esta propriedade, o armazenamento confiável padrão do Java será usado (por exemplo, JAVA_HOME\lib\security\cacerts).

Use '*' para indicar a aceitação de todos os certificados. Observe que isso não é recomendado devido a questões de segurança.

Esquema

Esta seção fornece uma lista completa de propriedades de esquema que você pode configurar.

Propriedade Descrição
Location Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.
BrowsableSchemas Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA, TableB, TableC.
Views Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC.

Localização

Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.

Tipo de Dados

string

Valor Padrão

"%APPDATA%\\\OneDrive Data Provider\\Schema"

Observações

O caminho para um diretório que contém os arquivos de esquema para o conector (arquivos .rsd para tabelas e exibições, arquivos .rsb para procedimentos armazenados). A localização da pasta pode ser um caminho relativo a partir da localização do executável. O Location a propriedade só é necessária se você quiser personalizar definições (por exemplo, alterar um nome de coluna, ignorar uma coluna e assim por diante) ou estender o modelo de dados com novas tabelas, exibições ou procedimentos armazenados.

Se não for especificado, o local padrão é "%APPDATA%\\OneDrive Data Provider\Schema" com %APPDATA% sendo definido para o diretório de configuração do usuário:

Plataforma %APPDATA%
Windows O valor da variável de ambiente APPDATA
Mac ~/Biblioteca/Suporte de aplicativos
Linux ~/.config

Esquemas Navegáveis

Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar os esquemas de bancos de dados pode ser caro. Fornecer uma lista de esquemas na string de conexão melhora o desempenho.

Tabelas

Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tabelas=TabelaA,TabelaB,TabelaC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar as tabelas de alguns bancos de dados pode ser caro. Fornecer uma lista de tabelas na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitos para trabalhar.

Especifique as tabelas que deseja em uma lista separada por vírgulas. Cada tabela deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Visualizações

Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA,ViewB,ViewC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar as exibições de alguns bancos de dados pode ser caro. Fornecer uma lista de exibições na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitas para trabalhar.

Especifique as exibições desejadas em uma lista separada por vírgulas. Cada exibição deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Diversos

Esta seção fornece uma lista completa de diversas propriedades que você pode configurar.

Propriedade Descrição
DirectoryRetrievalDepth Especifique quantas pastas você deseja obter resultados para as tabelas Pastas, Arquivos, Recursos Compartilhados e Permissões. Os recursos diretamente na raiz estão localizados na profundidade 0. Os recursos uma pasta mais abaixo estão localizados na profundidade 1 e assim por diante. Você pode especificar o valor -1 para obter todos os dados em uma unidade, independentemente da profundidade em que estão.TABLEROWEND
DriveId O ID do Drive que você deseja usar.
ListGroupDrives Escolha se deseja listar suas unidades de grupo ou não ao consultar a tabela de Unidades.
MaxRows Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.
Other Essas propriedades ocultas são usadas apenas em casos de uso específicos.
PseudoColumns Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.
Timeout O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

DirectoryRetrievalDepth

Especifique quantas pastas você deseja obter resultados para as tabelas Pastas, Arquivos, SharedResources e Permissions. Os recursos diretamente na raiz estão localizados na profundidade 0. Os recursos uma pasta mais abaixo estão localizados na profundidade 1 e assim por diante. Você pode especificar um valor de -1 para obter todos os dados em uma unidade, independentemente da profundidade em que estão.

Tipo de Dados

string

Valor Padrão

"5"

Observações

Essa propriedade deve ser definida na string de conexão ou o driver usará um padrão de DirectoryRetrievalDepth=5.

DriveId

O ID do Drive que você deseja usar.

Tipo de Dados

string

Valor Padrão

""

Observações

Por padrão, o provedor usará a unidade principal do usuário logado.

Você pode descobrir todos os DriveIDs possíveis consultando a tabela "Drives".

ListGroupDrives

Escolha se deseja listar suas unidades de grupo ou não ao consultar a tabela de Unidades.

Tipo de Dados

string

Valor Padrão

"false"

Observações

Por padrão, o provedor mostrará apenas as unidades do usuário.

MaxRows

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Tipo de Dados

int

Valor Padrão

-1

Observações

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Outro

Essas propriedades ocultas são usadas apenas em casos de uso específicos.

Tipo de Dados

string

Valor Padrão

""

Observações

As propriedades listadas abaixo estão disponíveis para casos de uso específicos. Casos de uso de driver normal e funcionalidade não devem exigir essas propriedades.

Especifique várias propriedades em uma lista separada por ponto e vírgula.

Integração e Formatação
Propriedade Descrição
DefaultColumnSize Define o comprimento padrão dos campos de string quando a fonte de dados não fornece o comprimento da coluna nos metadados. O valor padrão é 2000. Voltar para o início
ConvertDateTimeToGMT Determina se os valores de data e hora devem ser convertidos em GMT, em vez da hora local da máquina.
RecordToFile=filename Registra a transferência de dados do soquete subjacente para o arquivo especificado.

Pseudocolunas

Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.

Tipo de Dados

string

Valor Padrão

""

Observações

Essa configuração é particularmente útil no Entity Framework, que não permite definir um valor para uma pseudocoluna, a menos que seja uma coluna de tabela. O valor dessa configuração de conexão está no formato "Table1=Column1, Table1=Column2, Table2=Column3". Você pode usar o caractere "*" para incluir todas as tabelas e todas as colunas; por exemplo, "*=*".

Tempo Esgotado

O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

Tipo de Dados

int

Valor Padrão

60

Observações

Se Timeout = 0, as operações não expiram. As operações são executadas até serem concluídas com êxito ou até encontrarem uma condição de erro.

Se Timeout expira e a operação ainda não está concluída, o conector lança uma exceção.