Propriedades de cadeia de conexão

Aplica-se a: SQL Server Analysis Services Azure Analysis Services Fabric/Power BI Premium

Este artigo descreve cadeia de conexão propriedades usadas por aplicativos cliente que se conectam e consultam modelos semânticos Azure Analysis Services (Azure AS), SQL Server Analysis Services (SSAS) e Power BI Premium. Essas propriedades são usadas pelas bibliotecas de cliente do Analysis Services, ADOMD.NET, AMO e provedor OLE DB (MSOLAP) para o Analysis Services. A maioria das propriedades cadeia de conexão pode ser usada com todas as três bibliotecas de cliente. As exceções são destacadas na descrição.

Use o seletor De versão acima do sumário à esquerda para ver apenas as propriedades que se aplicam a uma determinada plataforma ou versão.

Propriedades da conexão

fonte de dados

Especifica a instância do servidor. Esta propriedade é necessária para todas as conexões.

Os valores válidos para Azure Analysis Services incluem <protocol>://<region>/<servername> onde o protocolo é cadeia asazure de caracteres oulink, ao usar um alias de nome de servidor, a região é o Uri em que o servidor foi criado (por exemplo, westus.asazure.windows.net) e servername é o nome do servidor exclusivo dentro da região.

Exemplo Descrição
Data source=asazure://westus.asazure.windows.net/myasserver Azure Analysis Services.
Data source=link://friendlyname.salesapp.azurewebsites.net/ Azure Analysis Services usando alias de nome do servidor.

Os valores válidos para Power BI Premium incluem <protocol>://api.powerbi.com/v1.0/[tenant name]/[workspace name] onde o protocolo é cadeia powerbide caracteres , Uri é api.powerbi.com, nome do locatário é o nome do locatário da organização ou myorg, e o nome do workspace é o nome de um workspace atribuído a uma capacidade dedicada.

Exemplo Descrição
Data source=powerbi://api.powerbi.com/v1.0/contoso.com/Sales Workspace Power BI Premium workspace.

Os valores válidos para SQL Server Analysis Services incluem o nome da rede ou endereço IP do servidor, local ou localhost para conexões locais, uma URL se o servidor estiver configurado para acesso HTTP ou HTTPS ou o nome de um arquivo de cubo local (.cub).

Exemplo Descrição
Data source=AW-SRV01 Instância e porta padrão do SSAS (TCP 2383).
Data source=AW-SRV01\Finance Instância nomeada do SSAS.
Data source=AW-SRV01:8081 Instância padrão do SSAS, porta especificada.
Data source=AW-SRV01.corp.Adventure-Works.com SSAS nome de domínio totalmente qualificado, instância padrão e porta.
Data source=172.16.254.1 Endereço IP SSAS do servidor, ignorando a pesquisa do servidor DNS. Útil para solucionar problemas de conexão.
Provedor

Essa propriedade é necessária no cadeia de conexão ao usar um provedor OLE DB como MSOLAP. Ele permite que você use um provedor independente de versão (geralmente o mais recente), como "Provider=MSOLAP", ou você também pode especificar um provedor dependente de versão como "Provider=MSOLAP.7". Os valores dependentes de versão válidos seguem o padrão MSOLAP.<versão>, em que <a versão> é 7 ou 8. Por exemplo, MSOLAP.7 lançado no SQL Server 2016. A versão ".8" é a mais recente e considerada "evergreen". Espera-se que continue atualizando com a compatibilidade com versões anteriores mantida. Números de versão anteriores também são possíveis, mas essas versões do MSOLAP agora estão fora do suporte padrão.

Essa propriedade é opcional para ADOMD.NET e AMO. Ele é permitido para conveniência ao copiar um cadeia de conexão MSOLAP para usar com ADOMD.NET e AMO.

Exemplo Descrição
Provider=MSOLAP.7 Connections exigindo SQL Server versão 2016 do provedor OLE DB para o Analysis Services.
Cubo

Nome do cubo ou da perspectiva. Um banco de dados pode conter vários cubos e perspectivas. Quando vários destinos forem possíveis, inclua o nome do cubo ou da perspectiva na cadeia de conexão.

Exemplo Descrição
Cube=Sales Um cubo chamado Sales.
Cube=SalesPerspective Uma perspectiva chamada SalesPerspective.

Propriedades de segurança e autenticação

Azure Analysis Services e Power BI Premium usam Microsoft Entra ID – Universal com MFA (recomendado), autenticação Microsoft Entra com nome de usuário e senha, tokens de acesso Microsoft Entra ou autenticação do Windows.

SQL Server Analysis Services usa apenas autenticação do Windows. A autenticação básica e a autenticação anônima poderão ser usadas se o acesso HTTP estiver habilitado por meio de MSMDPUMP.dll, conforme explicado no artigo Configurar o acesso HTTP ao Analysis Services no IIS 8.0. Consulte a Etapa 3: configurar a autenticação do IIS para obter detalhes sobre como configurar métodos de autenticação com suporte para o Analysis Services via HTTP.

As propriedades são listadas em ordem alfabética.

EffectiveUserName

Use quando uma identidade de usuário precisar ser representada no servidor. Para SSAS, especifique em um formato de domínio\usuário. Para AS e Power BI Premium do Azure, especifique no formato UPN. Para usar essa propriedade, o chamador deve ter permissões administrativas no Analysis Services. Em Power BI Premium, o chamador deve ser um administrador de workspace onde o modelo semântico está localizado.

CustomData

Um valor de cadeia de caracteres a ser passado para o mecanismo no cadeia de conexão e recuperado usando a função MDX CustomData() ou a função DAX CUSTOMDATA(). Mais comumente usado para passar um userID ou nome de usuário como um valor e, em seguida, especificar esse valor na definição de uma expressão de segurança.

Criptografar Senha

Especifica se uma senha local será usada para criptografar cubos locais. Os valores válidos são True ou False. O padrão é False.

Senha de Criptografia

A senha usada para descriptografar um cubo local criptografado. O valor padrão é vazio. Esse valor deve ser explicitamente definido pelo usuário.

Nível de Representação

Indica o nível de representação que o servidor pode usar ao representar o cliente. Os valores válidos incluem:

  • Anônimo. O cliente é anônimo ao servidor. O processo do servidor não pode obter informações sobre o cliente, nem o cliente pode ser representado.
  • Identifique. O processo do servidor pode obter a identidade do cliente. O servidor pode representar a identidade do cliente para fins de autorização, mas não pode acessar objetos do sistema como o cliente.
  • Representar. Esse é o valor padrão. A identidade do cliente pode ser representada, mas somente quando a conexão é estabelecida, e não em cada chamada.
  • Delegado. O processo do servidor pode representar o contexto de segurança do cliente ao atuar em nome do cliente. O processo do servidor também pode fazer chamadas de saída para outros servidores ao atuar em nome do cliente.
Segurança Integrada

A identidade do Windows do chamador é usada para se conectar ao Analysis Services. Os valores válidos são SSPI, blank, Basic e ClaimsToken*.

SSPI é o valor padrão para conexões TCP, permitindo a autenticação NTLM, Kerberos ou Anonymous. Para o AS do Azure e Power BI Premium, o SSPI indica a Tradução do AD. Ao usar o SSPI, a propriedade ProtectionLevel deve ser definida como Connect, Pkt Integrity ou Pkt Privacy.

blank é o valor padrão para conexões HTTP.

*O ClaimsToken tem suporte para o Azure AS e Power BI Premium.

Informações de Persistência de Segurança

Os valores válidos são True ou False. Quando definidas como True, as informações de segurança, como a identidade do usuário ou a senha especificada anteriormente na cadeia de conexão, poderão ser obtidas na conexão depois que ela for estabelecida. O valor padrão é False.

Nível de proteção

Determina o nível de segurança usado na conexão. Os valores com suporte dependem do transporte subjacente. Os valores válidos são:

  • None. Conexões não autenticadas ou anônimas. Não realiza nenhuma autenticação nos dados enviados ao servidor.
  • Conecte-se. Conexões autenticadas. Realiza a autenticação somente quando o cliente estabelece uma relação com um servidor.
  • Integridade do pkt. Conexões criptografadas. Verifica se todos os dados são recebidos do cliente e se eles não foram alterados em trânsito.
  • Privacidade do pkt. Criptografia assinada, com suporte apenas para TCP. Verifica se todos os dados são recebidos do cliente, se eles não foram alterados em trânsito e protege a privacidade dos dados criptografando-os.

Para saber mais, confira Estabelecendo Connections seguros no ADOMD.NET

Funções

Especifique uma lista delimitada por vírgulas de funções predefinidas a serem conectadas a um servidor ou banco de dados usando as permissões transmitidas por essa função. Se essa propriedade for omitida, todas as funções serão usadas, e as permissões efetivas serão a combinação de todas as funções. Definir a propriedade como um valor vazio, por exemplo, Roles=' ' significa que a conexão do cliente não tem associação de função.

Um administrador que usa essa propriedade se conecta usando as permissões transmitidas por essa função. Alguns comandos poderão falhar se a função não fornecer permissão suficiente.

Se estiver especificando funções ao se conectar a um workspace Power BI Premium, use funções de workspace do modelo de segurança do Power BI.

SSPI

Especifica explicitamente qual pacote de segurança será usado para autenticação do cliente quando a Integrated Security for definida como SSPI. O SSPI oferece suporte a vários pacotes, mas você pode usar esta propriedade para especificar um pacote específico. Os valores válidos são:

  • Negotiate
  • Kerberos
  • NTLM
  • Usuário Anônimo

Se essa propriedade não estiver definida, todos os pacotes estarão disponíveis para a conexão.

Usar Criptografia para Dados

Criptografa as transmissões de dados. Os valores válidos são True ou False.

ID do usuário=...; Password=

As propriedades ID de Usuário e Senha fornecem as credenciais apropriadas para o servidor quando o usuário ativo atual no aplicativo cliente não pode ser propagado automaticamente para o servidor. O comportamento depende do protocolo de transporte e do servidor que está sendo conectado a:

  • Ao se conectar via TCP ao SSAS, a biblioteca de clientes representará o usuário do Windows usando o nome de usuário e a senha especificados e, em seguida, se conectará como de costume ao servidor.

  • Ao se conectar via HTTP(S) ao SSAS, as credenciais são fornecidas ao servidor Web com base no modo de autenticação configurado no servidor Web, por exemplo, autenticação básica ou autenticação do Windows. O servidor Web executará a representação apropriada do Windows antes de se conectar ao servidor SSAS, fornecendo o fluxo de credenciais correto para o servidor.

  • Ao se conectar ao AS do Azure ou Power BI Premium, a ID de Usuário e a Senha são usadas para obter um token de Microsoft Entra que, em seguida, é apresentado ao serviço durante a autenticação. Microsoft Entra ID também pode exigir autenticação multifator (MFA), o que pode exigir interação adicional do usuário antes que o token possa ser gerado.

  • Se você já adquiriu um token de acesso válido Microsoft Entra ID portador de seu próprio aplicativo, poderá definir a propriedade AccessToken do objeto AdomdConnection antes de estabelecer a conexão. Na propriedade AccessToken do objeto de conectividade relevante (AdomdConnection, Server etc.), defina o token de acesso e especifique o tempo de expiração. A autenticação tem suporte para tokens de portador adquiridos interativamente para um usuário e usando o fluxo On-Behalf-Of do OAuth 2.0 (por exemplo, um aplicativo Web de camada intermediária que se conecta ao Analysis Services em nome do usuário). Omita o tipo de token ao passar o token de acesso na propriedade AccessToken . As bibliotecas de clientes do Analysis Services adicionam automaticamente o valor de esquema de autenticação "Portador" ao token de acesso. Lembre-se de ter o seguinte em mente:

    • Microsoft Entra tokens de acesso de portador têm um tempo de vida limitado. Por padrão, entre 60 e 90 minutos. Se o aplicativo executar operações de execução longa que excedem o tempo de vida do token de acesso, você poderá fornecer uma função de retorno de chamada por meio da propriedade OnAccessTokenExpired do objeto AdomdConnection para atualizar o token de acesso quando o token de acesso atual estiver prestes a expirar. Como alternativa, você pode atualizar a propriedade AccessToken diretamente sem a ajuda de uma função de retorno de chamada. O uso de uma função de retorno de chamada é recomendado para garantir que o token de acesso seja atualizado dentro do tempo de vida do token de acesso atual.
    • Não é recomendável usar a propriedade cadeia de conexão senha para passar um token de acesso. Você ainda pode omitir a propriedade ID de Usuário no cadeia de conexão e especificar apenas o token de acesso na propriedade Password, mas nesses casos o token de acesso não pode ser atualizado. Use a propriedade AccessToken para que você possa fornecer um novo token de acesso para uma conexão existente quando necessário. Não há suporte para a configuração da propriedade Password e da propriedade AccessToken .

Nota: "ID de usuário" tem um espaço inserido. Um alias alternativo para id de usuário é UID e um alias alternativo para Senha é PWD.

Propriedades de finalidade especial

Essas propriedades são usadas para garantir comportamentos de conexão específicos exigidos por um aplicativo. As propriedades são listadas em ordem alfabética.

Nome do Aplicativo

Define o nome do aplicativo associado à conexão. Esse valor pode ser útil para monitorar eventos de rastreamento, especialmente quando você tem vários aplicativos que acessam os mesmos bancos de dados. Por exemplo, adicionar Application Name='test' a um cadeia de conexão faz com que 'test' apareça em um rastreamento de SQL Server Profiler. Os aliases dessa propriedade incluem SspropInitAppName, AppName. Para saber mais, confira Nome do aplicativo para SQL Server Connections.

Período de Sincronização Automática

Define a frequência (em milissegundos) de sincronização do cache do cliente e do servidor. O ADOMD.NET fornece armazenamento em cache do cliente para os objetos mais usados que tenham uma sobrecarga mínima de memória. Isso ajuda a reduzir o número de viagens de ida e volta ao servidor. O padrão é 10.000 milissegundos (ou 10 segundos). Quando definida como nula ou 0, a sincronização automática é desativada.

Por motivos de desempenho, as bibliotecas de cliente armazenam em cache algumas informações do servidor, por exemplo, determinados conjuntos de linhas de esquema. O Período de Sincronização Automática permite que um usuário altere o período de tempo após o qual a biblioteca de clientes verifica com o servidor se os caches precisam ou não ser esvaziados. Em geral, você não deve precisar alterar o valor do padrão.

Codificação de Caracteres

Define como os caracteres são codificados na solicitação. Os valores válidos são Default ou UTF-8 (são equivalentes) e UTF-16.

CommitTimeout

Uma propriedade XMLA. Determina, em milissegundos, quanto tempo a fase de confirmação de um comando que está sendo executado no momento espera antes da reversão. Quando for maior que 0, substitui o valor da propriedade CommitTimeout correspondente na configuração do servidor.

CompareCaseSensitiveStringFlags

Ajusta comparações de cadeia de caracteres com diferenciação de maiúsculas e minúsculas em uma localidade especificada.

Nível de Compactação

Se TransportCompression for compactado, você poderá definir o nível de compactação para controlar a quantidade de compactação usada. Os valores válidos são de 0 a 9, sendo 0 com menos compactação e 9 com mais compactação. Quanto maior o nível de compactação, menos satisfatório será o desempenho. O valor padrão é 0.

Connect Timeout

Determina a quantidade máxima de tempo (em segundos) em que o cliente tenta uma conexão antes de atingir o tempo limite. Se uma conexão não for bem-sucedida dentro desse período, o cliente encerrará a tentativa de se conectar e gerará um erro.

DbpropMsmdRequestMemoryLimit

Substitui o valor da propriedade de servidor Memory\QueryMemoryLimit para uma conexão.

Especificada em quilobytes, essa propriedade pode reduzir a quantidade de memória usada durante uma consulta da memória máxima permitida (especificada como uma porcentagem) em QueryMemoryLimit. Ele não pode aumentar a quantidade de memória usada além da memória máxima permitida especificada em QueryMemoryLimit.

Modo Visual MDX padrão

Defina essa propriedade para controlar como os membros serão agregados quando a segurança da dimensão for aplicada.

No caso dos dados de cubo que todos podem ver, a agregação de todos os membros faz sentido porque todos os valores que contribuem para o total ficam visíveis. No entanto, se você filtrar ou restringir as dimensões com base na identidade do usuário, a exibição de um total com base em todos os membros (combinando valores restritos e permitidos em um único total) pode ser confusa ou mostrar mais informações do que devem ser reveladas.

Para especificar como os membros serão agregados quando a segurança da dimensão for aplicada, você poderá definir essa propriedade como True para usar somente os valores permitidos na agregação ou como False para excluir os valores restritos do total.

Quando definido na cadeia de conexão, esse valor se aplicará ao nível do cubo ou da perspectiva. Em um modelo, você pode controlar os totais visuais em um nível mais granular.

Os valores válidos são:

  • 0 é o padrão. Atualmente, o comportamento padrão é equivalente a 2, no qual as agregações incluem valores que ficam ocultos para o usuário.
  • 1 exclui valores ocultos do total. Esse é o padrão para Excel.
  • 2 inclui valores ocultos no total. Esse é o valor padrão no servidor.

O alias dessa propriedade é VisualMode.

Compatibilidade com MDX

O objetivo dessa propriedade é assegurar um conjunto consistente de comportamentos MDX para aplicativos que emitem consultas MDX. O Excel, que usa consultas MDX para preencher e calcular uma Tabela Dinâmica conectada ao Analysis Services, define essa propriedade para 1 para assegurar que os membros de espaço reservado em hierarquias desbalanceadas fiquem visíveis em uma Tabela Dinâmica. Os valores válidos são 0, 1 e 2.

Os valores 0 e 1 expõem os membros de espaço reservado; o valor 2 não expõe. Se essa propriedade estiver vazia, o valor 0 será assumido.

Modo de Membro Ausente MDX

Indica se sentindo os membros ausentes são ignorados em instruções MDX. Os valores válidos são Padrão, Erro e Ignorar. Default usa um valor definido pelo servidor. O erro gera um erro quando um membro não existe. Ignore especifica que os valores ausentes devem ser ignorados.

Otimizar a Resposta

Um bitmask que indica quais das otimizações de resposta de consulta a seguir são habilitadas.

  • 0x01 Usar o NormalTupleSet (padrão).
  • 0x02 Usar quando as segmentações estiverem vazias.
Tamanho do Pacote

Aplica-se apenas a conexões TCP. Um tamanho de pacote de rede (em bytes) entre 512 e 32.767. O tamanho do pacote de rede padrão é 4096.

Formato de Protocolo

Define o formato do XML usado pelo protocolo de comunicação XMLA. Os valores válidos são Default, XML ou Binary. Você pode especificar que o XML seja enviado em um formato binário ou como XML de texto. O formato binário codifica os elementos e atributos XML, tornando-os menores. Além disso, a compactação também pode ser habilitada para que as mensagens reduzam o tamanho das solicitações e respostas usando a opção Compactação de Transporte. Solicitações e respostas podem usar formatos de protocolo diferentes dependendo do que o cliente e o servidor dão suporte. Por exemplo, uma biblioteca de clientes só pode dar suporte a binários para respostas, mas não para solicitações, ou um servidor pode ter desabilitado binário para solicitações de entrada.

O provedor OLE DB pode formatar as solicitações e as respostas em formato binário ou compactado. AMO e ADOMD.NET formatam as solicitações como Texto, mas aceitam respostas em formato binário ou compactado.

Essa propriedade de cadeia de conexão é equivalente às configurações de servidor EnableBinaryXML e EnableCompression .

Olap em Tempo Real

Defina essa propriedade para ignorar o cache, fazendo com que todas as consultas de armazenamento busquem dados do sistema de origem. Por padrão, essa propriedade não é definida.

Opções de Segurança

Define o nível de segurança das ações e funções definidas pelo usuário. Os valores válidos são 0, 1, 2. Em uma conexão do Excel, essa propriedade é Opções de Segurança=2. Detalhes sobre essa opção podem ser encontrados em ConnectionString.

SQLQueryMode

Especifica se as consultas SQL incluem cálculos. Os valores válidos são Data, Calculated, IncludeEmpty. Data significa que não serão permitidos cálculos. Calculated permite cálculos. IncludeEmpty permite cálculos e que sejam retornadas linhas vazias no resultado da consulta.

Tempo limite

Especifica quanto tempo (em segundos) a biblioteca de cliente esperará a conclusão de um comando antes de gerar um erro.

Compactação de Transporte

Define como as comunicações de cliente e servidor são compactadas. Os valores válidos são Padrão, Nenhum, Compactado. Nenhum indica que nenhuma compactação é usada. Compactado usa compactação XPRESS.

UseExistingFile

Usado ao conectar-se a um cubo local. Essa propriedade especifica se o cubo local será substituído. Os valores válidos são True ou False. Se definido como True, o arquivo de cubo deve existir. O arquivo existente será o destino da conexão. Se for definido como False, o arquivo de cubo será substituído.

Confira também

Classes fundamentais amo – objetos de servidor
Classe AdomdConnection – Propriedades