Origem de dados

A data-source seção define os detalhes de acesso ao banco de dados. Ele também define 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>"]
}

Origem 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 da conexão

O construtor de API de dados usa o Backoff Exponencial para repetir solicitações de banco de dados após erros transitórios.

Identidades de serviço gerenciado (MSI)

As Identidades de Serviço Gerenciado (MSI) são suportadas com DefaultAzureCredential as definidas na Azure.Identity biblioteca. Saiba mais sobre identidades gerenciadas no Microsoft Entra para Azure SQL.

User-Assigned identidades gerenciadas (UAMI)

Para a Identidade Gerida Atribuída pelo Utilizador, adicione as propriedades de Autenticação e ID de Utilizador à sua cadeia de ligação enquanto substitui o ID do cliente da Identidade Gerida Atribuída pelo Utilizador: Authentication=Active Directory Managed Identity; User Id=<UMI_CLIENT_ID>;.

System-Assigned Identidade Gerenciada (SAMI)

Para Identidade Gerida Atribuída ao Sistema, adicione a propriedade de Autenticação e exclua os argumentos UserID e Password da sua string de ligação: Authentication=Active Directory Managed Identity;.

Saúde (Fonte de dados)

O construtor de API de dados suporta 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 de 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 apenas no relatório de integridade.

Verificar o comportamento

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

Format

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

Autenticação delegada pelo utilizador

On-Behalf-Of (OBO) autenticação delegada pelo utilizador para SQL Server e Azure SQL. Quando ativado, o DAB troca o token de utilizador recebido por um token SQL a jusante para que a base de dados se autentique como o utilizador efetivo que chama. Esta funcionalidade é suportada apenas para mssql fontes de dados e requer autenticação Entra ID a montante.

Propriedades aninhadas

• enabled—liga ou desliga o OBO.
• provider—o fornecedor de identidade para a troca de tokens. Atualmente, apenas EntraId é suportada.
• database-audience—o público-alvo do token SQL a jusante (por exemplo, https://database.windows.net).

Variáveis de ambiente necessárias

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

Pooling de ligações por utilizador

Quando o OBO está ativado, o DAB mantém pools de ligação SQL separados por utilizador, para que o token de acesso de um utilizador nunca seja reutilizado para o pedido de outro utilizador.

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"
    }
  }
}