Fonte de dados

A data-source seção define os detalhes de acesso ao banco de dados. Ele também define as opções de banco de dados.

Configurações da fonte de dados

Visão geral do formato

{
  "data-source": {
    "database-type": <string>,
    "connection-string": <string>,
    "options": {
      // mssql only
      "set-session-context": <true> (default) | <false>,
      // cosmosdb_nosql only
      "database": <string>,
      "container": <string>,
      "schema": <string>
    },
    "health": {
      "enabled": <true> (default) | <false>,
      "name": <string>,
      "threshold-ms": <integer; default: 1000>
    },
    "user-delegated-auth": {
      "enabled": <true> | <false> (default),
      "provider": <string>,
      "database-audience": <string>
    }
  },
  "data-source-files": ["<string>"]
}

Fonte de dados

Propriedades aninhadas

Valores de propriedade

Format

{
  "data-source": {
    "database-type": <string>,
    "connection-string": <string>,
    "options": {
      "<key-name>": <string>
    }
  }
}

Exemplo: SQL do Azure & SQL Server

"data-source": {
  "database-type": "mssql",
  "connection-string": "Server=tcp:myserver.database.windows.net,1433;Initial Catalog=MyDatabase;User ID=MyUser;Password=MyPassword;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;",
    "options": {
      "set-session-context": true
    }
}

Consumir SESSION_CONTEXT

Para o SQL do Azure e o SQL Server, o construtor de API de Dados pode incluir informações de Declarações no SQL.SESSION_CONTEXT

CREATE PROC GetUser @userId INT AS
BEGIN
    -- Use claims
    IF SESSION_CONTEXT(N'user_role') = 'admin' 
    BEGIN
        RAISERROR('Unauthorized access', 16, 1);
    END

    SELECT Id, Name, Age, IsAdmin
    FROM Users
    WHERE Id = @userId;
END;

Exemplo: Azure Cosmos DB

"data-source": {
  "database-type": "cosmosdb_nosql",
  "connection-string": "@env('SQL_CONNECTION_STRING')",
  "options": {
    "database": "Your_CosmosDB_Database_Name",
    "container": "Your_CosmosDB_Container_Name",
    "schema": "Path_to_Your_GraphQL_Schema_File"
  }
}

Variáveis de ambiente

Use variáveis de ambiente para manter segredos de texto sem formatação fora do arquivo de configuração.

"data-source": {
  "database-type": "mssql",
  "connection-string": "@env('SQL_CONNECTION_STRING')"
}

Resiliência de conexão

O Construtor de API de Dados usa a Retirada Exponencial para tentar novamente solicitações de banco de dados após erros transitórios.

MSI (Identidades de Serviço Gerenciado)

As MSI (Identidades de Serviço Gerenciadas) têm suporte com DefaultAzureCredential definido na Azure.Identity biblioteca. Saiba mais sobre identidades gerenciadas no Microsoft Entra para SQL do Azure.

User-Assigned identidades gerenciadas (UAMI)

Para a Identidade Gerenciada Atribuída pelo Usuário, acrescente as propriedades de Autenticação e ID de Usuário à cadeia de conexão, substituindo na ID do cliente da identidade gerenciada atribuída pelo usuário: Authentication=Active Directory Managed Identity; User Id=<UMI_CLIENT_ID>;.

System-Assigned IDENTIDADE Gerenciada (SAMI)

Para a Identidade Gerenciada Atribuída pelo Sistema, acrescente a propriedade Autenticação e exclua os argumentos UserId e Password da cadeia de conexão: Authentication=Active Directory Managed Identity;.

Integridade (fonte de dados)

O Construtor de API de Dados dá suporte a vários arquivos de configuração, cada um com sua própria fonte de dados. Esse bloco de configuração permite que cada fonte de dados tenha sua própria configuração de integridade.

Propriedades aninhadas

Nome da verificação

Como vários arquivos de configuração podem apontar para fontes de dados do mesmo tipo, essas fontes de dados não podem ser distinguidas no relatório de integridade. Use name para atribuir um rótulo exclusivo e identificável usado somente no relatório de integridade.

Verificar o comportamento

A consulta mais simples possível, específica ao tipo de banco de dados, é executada na fonte de dados fornecida para validar se a conexão pode ser aberta. Use a threshold-ms propriedade para configurar a duração máxima aceitável (em milissegundos) para que essa consulta seja concluída.

Format

{
  "data-source": {
    "health": {
      "enabled": <true> (default) | <false>,
      "name": <string>,
      "threshold-ms": <integer; default: 1000>
    }
  }
}

Autenticação delegada pelo usuário

Autenticação delegada pelo usuário do OBO (On-Behalf-Of) para SQL Server e SQL do Azure. Quando habilitado, o DAB troca o token de usuário de entrada por um token SQL downstream para que o banco de dados se autentique como o usuário de chamada real. Esse recurso tem suporte apenas para mssql fontes de dados e requer a autenticação de ID do Entra upstream.

Propriedades aninhadas

• enabled— ativa ou desativa o OBO.
• provider— o provedor de identidade para a troca de tokens. Atualmente, há suporte apenas para EntraId.
• database-audience— o público-alvo do token SQL downstream (por exemplo, https://database.windows.net).

Variáveis de ambiente necessárias

Quando o OBO está habilitado, o DAB lê as seguintes variáveis de ambiente para a troca de tokens:

Pool de conexões por usuário

Quando o OBO está habilitado, o DAB mantém pools de conexão SQL separados por usuário para que o token de acesso de um usuário nunca seja reutilizado para a solicitação de outro usuário.

Format

{
  "data-source": {
    "database-type": "mssql",
    "connection-string": "@env('SQL_CONNECTION_STRING')",
    "user-delegated-auth": {
      "enabled": <true> | <false> (default),
      "provider": <string>,
      "database-audience": <string>
    }
  }
}

Exemplo

{
  "data-source": {
    "database-type": "mssql",
    "connection-string": "@env('SQL_CONNECTION_STRING')",
    "user-delegated-auth": {
      "enabled": true,
      "provider": "EntraId",
      "database-audience": "https://database.windows.net"
    }
  }
}