configure comando

Configure propriedades de runtime e de fonte de dados que não sejam específicas de cada entidade num ficheiro de configuração existente do Data API Builder. Opções não especificadas deixam os valores existentes inalterados. Se qualquer opção fornecida for inválida, toda a atualização falhará (tudo ou nada).

Acrónimos usados nesta referência: Model Context Protocol (MCP), linguagem de manipulação de dados (DML), time to live (TTL), JSON Web Token (JWT), release candidate (RC), data collection rule (DCR) e data collection endpoint (DCE).

Observação

Este comando não altera a entities secção. Use dab update para alterações de entidade.

Sintaxe

dab configure [options]

Importante

As definições do OpenTelemetry e do Application Insights estão configuradas com dab add-telemetry, não dab configure. Veja concept/monitor/open-telemetry.md e concept/monitor/application-insights.md.

Visão rápida

Opção Resumo
-c, --config Caminho para o arquivo de configuração (padrão dab-config.json).

Secção de fonte de dados

Opção Resumo
--data-source.database-type Define o tipo de base de dados.
--data-source.connection-string Defina a cadeia de conexão do banco de dados.
--data-source.options.database Nome do banco de dados para Cosmos DB para NoSql.
--data-source.options.container Nome do contêiner para Cosmos DB para NoSql.
--data-source.options.schema Caminho de esquema para Cosmos DB para NoSql.
--data-source.options.set-session-context Ativar ou desativar o contexto da sessão. Padrão: false.
--data-source.health.enabled Ative ou desative a verificação de saúde da fonte de dados.
--data-source.health.name Identificador da fonte dos dados no relatório de verificação de saúde.
--data-source.health.threshold-ms Limiar de consulta de verificação de saúde em milissegundos.
--data-source.user-delegated-auth.enabled Ativar a autenticação delegada pelo utilizador do OBO.
--data-source.user-delegated-auth.provider Defina o fornecedor de identidade do OBO.
--data-source.user-delegated-auth.database-audience Público-alvo para o token SQL a jusante.
--data-source-files Referenciar ficheiros de configuração adicionais de fontes de dados.

Secção GraphQL

Opção Resumo
--runtime.graphql.depth-limit Limite a profundidade máxima da consulta.
--runtime.graphql.enabled Habilite ou desative o ponto de extremidade GraphQL.
--runtime.graphql.path Personaliza o caminho do endpoint do GraphQL.
--runtime.graphql.allow-introspection Permitir ou negar a introspeção do GraphQL.
--runtime.graphql.multiple-mutations.create.enabled Permitir múltiplas mutações.

Secção REST

Opção Resumo
--runtime.rest.enabled Habilite ou desabilite o ponto de extremidade REST.
--runtime.rest.path Personaliza o caminho do endpoint REST.
--runtime.rest.request-body-strict Aplicar uma validação rigorosa do corpo dos pedidos REST.

Secção de paginação

Opção Resumo
--runtime.pagination.max-page-size Tamanho máximo de página para resultados paginados.
--runtime.pagination.default-page-size Tamanho padrão da página para resultados paginados.
--runtime.pagination.next-link-relative Use URLs relativos na paginação REST dos próximos links.

Secção MCP

Opção Resumo
--runtime.mcp.enabled Habilite ou desabilite o ponto de extremidade MCP.
--runtime.mcp.path Personaliza o caminho do endpoint MCP.
--runtime.mcp.description Define a descrição do servidor MCP.
--runtime.mcp.dml-tools Habilite ou desabilite todas as ferramentas MCP DML.
--runtime.mcp.dml-tools.describe-entities Habilite ou desabilite a ferramenta describe-entities.
--runtime.mcp.dml-tools.create-record Habilite ou desabilite a ferramenta create-record.
--runtime.mcp.dml-tools.read-records Habilite ou desabilite a ferramenta de registros de leitura.
--runtime.mcp.dml-tools.update-record Habilite ou desabilite a ferramenta de registro de atualização.
--runtime.mcp.dml-tools.delete-record Habilite ou desabilite a ferramenta de registro de exclusão.
--runtime.mcp.dml-tools.execute-entity Habilite ou desabilite a ferramenta de entidade de execução.
--runtime.mcp.dml-tools.aggregate-records Ative ou desative a ferramenta de registos agregados.
--runtime.mcp.dml-tools.aggregate-records.query-timeout Tempo limite de execução em segundos para recordes agregados.

Secção de cache

Opção Resumo
--runtime.cache.enabled Habilite ou desabilite o cache global.
--runtime.cache.ttl-seconds TTL de cache global em segundos.
--runtime.compression.level Defina o nível de compressão da resposta HTTP.

Secção de apresentadores

Opção Resumo
--runtime.host.mode Definir modo host: Desenvolvimento ou Produção.
--runtime.host.max-response-size-mb Tamanho máximo de resposta em megabytes.
--runtime.host.cors.origins Origens CORS permitidas.
--runtime.host.cors.allow-credentials Defina credenciais de CORS almet.
--runtime.host.authentication.provider Provedor de autenticação.
--runtime.host.authentication.jwt.audience Reivindicação do público JWT.
--runtime.host.authentication.jwt.issuer Reclamação do emissor JWT.

Secção de Saúde

Opção Resumo
--runtime.health.enabled Ativar ou desativar o endpoint de saúde global.
--runtime.health.cache-ttl-seconds Armazene TTL em cache para relatórios de verificação de saúde.
--runtime.health.max-query-parallelism Número máximo de consultas de verificação de saúde concorrentes.
--runtime.health.roles Papéis permitidos para visualizar resultados abrangentes de saúde.

Permissões efetivas

Opção Resumo
--show-effective-permissions Mostrar permissões resolvidas para todas as entidades.

Secção do Cofre da Chave

Opção Resumo
--azure-key-vault.endpoint Ponto de extremidade base do Azure Key Vault.
--azure-key-vault.retry-policy.mode Retentar o modo de política.
--azure-key-vault.retry-policy.max-count Max tentativas de repetição.
--azure-key-vault.retry-policy.delay-seconds Atraso entre tentativas.
--azure-key-vault.retry-policy.max-delay-seconds Atraso máximo para tentativas exponenciais.
--azure-key-vault.retry-policy.network-timeout-seconds Pausa para chamadas na rede.

Secção de Telemetria

Opção Resumo
--runtime.telemetry.log-level Configure a verbosidade dos registos por namespace.
--runtime.telemetry.azure-log-analytics.enabled Habilite a telemetria do Azure Log Analytics.
--runtime.telemetry.azure-log-analytics.dab-identifier Distinguir a origem do tronco.
--runtime.telemetry.azure-log-analytics.flush-interval-seconds Nivele a cadência em segundos.
--runtime.telemetry.azure-log-analytics.auth.custom-table-name Nome da tabela personalizada.
--runtime.telemetry.azure-log-analytics.auth.dcr-immutable-id ID da Regra de Recolha de Dados.
--runtime.telemetry.azure-log-analytics.auth.dce-endpoint Ponto de extremidade de coleta de dados.
--runtime.telemetry.file.enabled Habilite a telemetria do coletor de arquivos.
--runtime.telemetry.file.path Caminho para o arquivo de log.
--runtime.telemetry.file.rolling-interval Intervalo em movimento.
--runtime.telemetry.file.retained-file-count-limit Número máximo de arquivos retidos.
--runtime.telemetry.file.file-size-limit-bytes Tamanho máximo por arquivo antes de rolar.

-c, --config

Caminho para o arquivo de configuração. Por defeito, dab-config.json a menos que dab-config.<DAB_ENVIRONMENT>.json exista, onde DAB_ENVIRONMENT é uma variável de ambiente.

Example

dab configure \
  --config ./dab-config.json \
  --runtime.rest.enabled true

--data-source.database-type

Tipo de base de dados.

Valores permitidos:

  • MSSQL
  • DWSQL
  • PostgreSQL
  • CosmosDB_PostgreSQL
  • CosmosDB_NoSQL
  • MySQL

Example

dab configure \
  --data-source.database-type PostgreSQL

Configuração resultante

{
  "data-source": {
    "database-type": "postgresql"
  }
}

--data-source.connection-string

String de ligação para a fonte de dados.

Example

dab configure \
  --data-source.connection-string "Server=myserver;Database=mydb;User Id=myuser;Password=mypassword;"

Configuração resultante

{
  "data-source": {
    "connection-string": "Server=myserver;Database=mydb;User Id=myuser;Password=mypassword;"
  }
}

--data-source-files

Referenciar ficheiros de configuração adicionais de fonte de dados a partir do ficheiro de configuração raiz.

Example

dab configure \
  --data-source-files ./dab-config.sales.json

Configuração resultante

{
  "data-source-files": [
    "./dab-config.sales.json"
  ]
}

--data-source.options.database

Nome do banco de dados para Cosmos DB para NoSql.

Example

dab configure \
  --data-source.options.database MyCosmosDatabase

Configuração resultante

{
  "data-source": {
    "options": {
      "database": "MyCosmosDatabase"
    }
  }
}

--data-source.options.container

Nome do contêiner para Cosmos DB para NoSql.

Example

dab configure \
  --data-source.options.container MyCosmosContainer

Configuração resultante

{
  "data-source": {
    "options": {
      "container": "MyCosmosContainer"
    }
  }
}

--data-source.options.schema

Caminho de esquema para Cosmos DB para NoSql.

Example

dab configure \
  --data-source.options.schema ./schema.gql

Configuração resultante

{
  "data-source": {
    "options": {
      "schema": "./schema.gql"
    }
  }
}

--data-source.options.set-session-context

Ativar o contexto da sessão.

Valores permitidos:

  • true
  • false (padrão)

Example

dab configure \
  --data-source.options.set-session-context false

Configuração resultante

{
  "data-source": {
    "options": {
      "set-session-context": false
    }
  }
}

--data-source.health.enabled

Ative ou desative a verificação de saúde da fonte de dados. A predefinição é true.

Example

dab configure \
  --data-source.health.enabled false

Configuração resultante

{
  "data-source": {
    "health": {
      "enabled": false
    }
  }
}

--data-source.health.name

Identificador da fonte dos dados no relatório de verificação de saúde.

Example

dab configure \
  --data-source.health.name my-sql-health

Configuração resultante

{
  "data-source": {
    "health": {
      "name": "my-sql-health"
    }
  }
}

--data-source.health.threshold-ms

Duração máxima em milissegundos para a consulta de verificação de saúde da fonte de dados. A predefinição é 1000.

Example

dab configure \
  --data-source.health.threshold-ms 750

Configuração resultante

{
  "data-source": {
    "health": {
      "threshold-ms": 750
    }
  }
}

--data-source.user-delegated-auth.enabled

Ative ou desative a autenticação delegada pelo utilizador On-Behalf-Of (OBO). Suportado apenas para mssql fontes de dados.

Observação

A funcionalidade Data API builder 2.0 descrita nesta secção está atualmente em pré-visualização e pode mudar antes da disponibilidade geral. Para mais informações, consulte O que há de novo na versão 2.0.

Example

dab configure \
  --data-source.user-delegated-auth.enabled true

Configuração resultante

{
  "data-source": {
    "user-delegated-auth": {
      "enabled": true
    }
  }
}

--data-source.user-delegated-auth.provider

Defina o fornecedor de identidade para autenticação delegada pelo utilizador On-Behalf-Of (OBO). Atualmente, apenas EntraId é suportado.

Observação

A funcionalidade Data API builder 2.0 descrita nesta secção está atualmente em pré-visualização e pode mudar antes da disponibilidade geral. Para mais informações, consulte O que há de novo na versão 2.0.

Example

dab configure \
  --data-source.user-delegated-auth.provider EntraId

Configuração resultante

{
  "data-source": {
    "user-delegated-auth": {
      "provider": "EntraId"
    }
  }
}

--data-source.user-delegated-auth.database-audience

Defina o público-alvo para o token SQL a jusante quando o OBO estiver ativado.

Example

dab configure \
  --data-source.user-delegated-auth.database-audience "https://database.windows.net"

Configuração resultante

{
  "data-source": {
    "user-delegated-auth": {
      "database-audience": "https://database.windows.net"
    }
  }
}

--runtime.graphql.depth-limit

Max permitiu profundidade na consulta aninhada.

Valores permitidos:

  • $(0,2147483647]$ (inclusive)
  • -1 para remover o limite

Example

dab configure \
  --runtime.graphql.depth-limit 3

Configuração resultante

{
  "runtime": {
    "graphql": {
      "depth-limit": 3
    }
  }
}

--runtime.graphql.enabled

Ativar o endpoint GraphQL do DAB.

Example

dab configure \
  --runtime.graphql.enabled false

Configuração resultante

{
  "runtime": {
    "graphql": {
      "enabled": false
    }
  }
}

--runtime.graphql.path

Personalize o caminho do endpoint GraphQL do DAB. Prefixo path com /.

Example

dab configure \
  --runtime.graphql.path /graphql

Configuração resultante

{
  "runtime": {
    "graphql": {
      "path": "/graphql"
    }
  }
}

--runtime.graphql.allow-introspection

Permitir ou negar pedidos de introspeção do GraphQL.

Example

dab configure \
  --runtime.graphql.allow-introspection false

Configuração resultante

{
  "runtime": {
    "graphql": {
      "allow-introspection": false
    }
  }
}

--runtime.graphql.multiple-mutations.create.enabled

Ative ou desative as operações de criação de múltiplas mutações no esquema GraphQL gerado.

Example

dab configure \
  --runtime.graphql.multiple-mutations.create.enabled true

Configuração resultante

{
  "runtime": {
    "graphql": {
      "multiple-mutations": {
        "create": {
          "enabled": true
        }
      }
    }
  }
}

--runtime.rest.enabled

Ativar o endpoint REST do DAB.

Example

dab configure \
  --runtime.rest.enabled false

Configuração resultante

{
  "runtime": {
    "rest": {
      "enabled": false
    }
  }
}

--runtime.rest.path

Personaliza o caminho do endpoint REST do DAB. Prefixo path com /.

Example

dab configure \
  --runtime.rest.path /myapi

Configuração resultante

{
  "runtime": {
    "rest": {
      "path": "/myapi"
    }
  }
}

--runtime.rest.request-body-strict

Proíbe campos corporais de pedidos REST superfluos.

Example

dab configure \
  --runtime.rest.request-body-strict true

Configuração resultante

{
  "runtime": {
    "rest": {
      "request-body-strict": true
    }
  }
}

--runtime.pagination.max-page-size

Tamanho máximo de página para resultados paginados. A predefinição é 100000. O mínimo é 1.

Example

dab configure \
  --runtime.pagination.max-page-size 50000

Configuração resultante

{
  "runtime": {
    "pagination": {
      "max-page-size": 50000
    }
  }
}

--runtime.pagination.default-page-size

Tamanho padrão da página para resultados paginados. A predefinição é 100. O mínimo é 1.

Example

dab configure \
  --runtime.pagination.default-page-size 50

Configuração resultante

{
  "runtime": {
    "pagination": {
      "default-page-size": 50
    }
  }
}

--runtime.pagination.next-link-relative

Use URLs relativas em vez de URLs absolutas nos valores de paginação nextLink REST. A predefinição é false.

Example

dab configure \
  --runtime.pagination.next-link-relative true

Configuração resultante

{
  "runtime": {
    "pagination": {
      "next-link-relative": true
    }
  }
}

--runtime.mcp.enabled

Ativar o endpoint MCP do DAB.

Observação

Esta opção está disponível na CLI de pré-visualização do Data API builder 2.0. Instale o último pré-lançamento com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

dab configure \
  --runtime.mcp.enabled false

Configuração resultante

{
  "runtime": {
    "mcp": {
      "enabled": false
    }
  }
}

--runtime.mcp.path

Personaliza o caminho do endpoint MCP do DAB. Prefixo path com /.

Observação

Esta opção está disponível na CLI de pré-visualização do Data API builder 2.0. Instale o último pré-lançamento com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

dab configure \
  --runtime.mcp.path /mcp2

Configuração resultante

{
  "runtime": {
    "mcp": {
      "path": "/mcp2"
    }
  }
}

--runtime.mcp.description

Defina a descrição do servidor MCP para ser exposta na resposta inicializada.

Observação

Esta opção está disponível na CLI de pré-visualização do Data API builder 2.0. Instale o último pré-lançamento com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

dab configure \
  --runtime.mcp.description "My MCP Server"

Configuração resultante

{
  "runtime": {
    "mcp": {
      "description": "My MCP Server"
    }
  }
}

--runtime.mcp.dml-tools

Ativar o endpoint das ferramentas MCP DML do DAB.

Observação

Esta opção está disponível na CLI de pré-visualização do Data API builder 2.0. Instale o último pré-lançamento com dotnet tool install microsoft.dataapibuilder --prerelease.

Para mais informações sobre as ferramentas MCP DML, consulte as ferramentas de linguagem de manipulação de dados SQL MCP Server.

Example

dab configure \
  --runtime.mcp.dml-tools false

Configuração resultante

{
  "runtime": {
    "mcp": {
      "dml-tools": false
    }
  }
}

--runtime.mcp.dml-tools.describe-entities

Ative a ferramenta MCP de descrever entidades do DAB.

Observação

Esta opção está disponível na CLI de pré-visualização do Data API builder 2.0. Instale o último pré-lançamento com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

dab configure \
  --runtime.mcp.dml-tools.describe-entities false

Configuração resultante

{
  "runtime": {
    "mcp": {
      "dml-tools": {
        "describe-entities": false
      }
    }
  }
}

--runtime.mcp.dml-tools.create-record

Ative a ferramenta MCP de criação de registo do DAB.

Observação

Esta opção está disponível na CLI de pré-visualização do Data API builder 2.0. Instale o último pré-lançamento com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

dab configure \
  --runtime.mcp.dml-tools.create-record false

Configuração resultante

{
  "runtime": {
    "mcp": {
      "dml-tools": {
        "create-record": false
      }
    }
  }
}

--runtime.mcp.dml-tools.read-records

Ative a ferramenta MCP de registo de leitura do DAB.

Observação

Esta opção está disponível na CLI de pré-visualização do Data API builder 2.0. Instale o último pré-lançamento com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

dab configure \
  --runtime.mcp.dml-tools.read-records false

Configuração resultante

{
  "runtime": {
    "mcp": {
      "dml-tools": {
        "read-records": false
      }
    }
  }
}

--runtime.mcp.dml-tools.update-record

Ativar a ferramenta de registo de atualização MCP do DAB.

Observação

Esta opção está disponível na CLI de pré-visualização do Data API builder 2.0. Instale o último pré-lançamento com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

dab configure \
  --runtime.mcp.dml-tools.update-record false

Configuração resultante

{
  "runtime": {
    "mcp": {
      "dml-tools": {
        "update-record": false
      }
    }
  }
}

--runtime.mcp.dml-tools.delete-record

Ativa a ferramenta MCP de eliminar registos do DAB.

Observação

Esta opção está disponível na CLI de pré-visualização do Data API builder 2.0. Instale o último pré-lançamento com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

dab configure \
  --runtime.mcp.dml-tools.delete-record false

Configuração resultante

{
  "runtime": {
    "mcp": {
      "dml-tools": {
        "delete-record": false
      }
    }
  }
}

--runtime.mcp.dml-tools.execute-entity

Ativar a ferramenta MCP execute entity do DAB.

Observação

Esta opção está disponível na CLI de pré-visualização do Data API builder 2.0. Instale o último pré-lançamento com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

dab configure \
  --runtime.mcp.dml-tools.execute-entity false

Configuração resultante

{
  "runtime": {
    "mcp": {
      "dml-tools": {
        "execute-entity": false
      }
    }
  }
}

--runtime.mcp.dml-tools.aggregate-records

Ative a ferramenta de registos agregados MCP do DAB.

Observação

Esta opção está disponível na CLI de pré-visualização do Data API builder 2.0. Instale o último pré-lançamento com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

dab configure \
  --runtime.mcp.dml-tools.aggregate-records false

Configuração resultante

{
  "runtime": {
    "mcp": {
      "dml-tools": {
        "aggregate-records": false
      }
    }
  }
}

--runtime.mcp.dml-tools.aggregate-records.query-timeout

Defina o timeout de execução em segundos para a ferramenta MCP de registos agregados.

Padrão: 30. Alcance: 1–600.

Observação

Esta opção está disponível na CLI de pré-visualização do Data API builder 2.0. Instale o último pré-lançamento com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

dab configure \
  --runtime.mcp.dml-tools.aggregate-records.query-timeout 60

Configuração resultante

{
  "runtime": {
    "mcp": {
      "dml-tools": {
        "aggregate-records": {
          "enabled": true,
          "query-timeout": 60
        }
      }
    }
  }
}

--runtime.cache.enabled

Ativar a cache do DAB globalmente. Também deve ativar a cache para cada entidade.

Example

dab configure \
  --runtime.cache.enabled true

Configuração resultante

{
  "runtime": {
    "cache": {
      "enabled": true
    }
  }
}

--runtime.cache.ttl-seconds

Personaliza o tempo global padrão da cache DAB para viver em segundos.

Example

dab configure \
  --runtime.cache.ttl-seconds 30

Configuração resultante

{
  "runtime": {
    "cache": {
      "enabled": false,
      "ttl-seconds": 30
    }
  }
}

--runtime.compression.level

Observação

A funcionalidade Data API builder 2.0 descrita nesta secção está atualmente em pré-visualização e pode mudar antes da disponibilidade geral. Para mais informações, consulte O que há de novo na versão 2.0.

Defina o nível de compressão da resposta HTTP.

Valores permitidos:

  • optimal—equilibra a taxa de compressão e a velocidade (por defeito)
  • fastest—prioriza a velocidade de compressão em detrimento da razão
  • none—desativa a compressão

Example

dab configure \
  --runtime.compression.level optimal

Configuração resultante

{
  "runtime": {
    "compression": {
      "level": "optimal"
    }
  }
}

--runtime.host.mode

Defina o modo de execução do host do DAB.

Valores permitidos:

  • Development
  • Production

Example

dab configure \
  --runtime.host.mode Development

Configuração resultante

{
  "runtime": {
    "host": {
      "mode": "development"
    }
  }
}

--runtime.host.max-response-size-mb

Tamanho máximo em megabytes para uma resposta de base de dados num único resultado. A predefinição é 158.

Example

dab configure \
  --runtime.host.max-response-size-mb 256

Configuração resultante

{
  "runtime": {
    "host": {
      "max-response-size-mb": 256
    }
  }
}

--runtime.host.cors.origins

Sobrescrever origens permitidas no CORS. Fornecer valores como uma lista separada por espaço.

Example

dab configure \
  --runtime.host.cors.origins \
  https://contoso.com \
  https://fabrikam.com

Configuração resultante

{
  "runtime": {
    "host": {
      "cors": {
        "origins": [
          "https://contoso.com",
          "https://fabrikam.com"
        ]
      }
    }
  }
}

--runtime.host.cors.allow-credentials

Defina o valor do Access-Control-Allow-Credentials cabeçalho.

Example

dab configure \
  --runtime.host.cors.allow-credentials true

Configuração resultante

{
  "runtime": {
    "host": {
      "cors": {
        "allow-credentials": true
      }
    }
  }
}

--runtime.host.authentication.provider

Configure o nome do fornecedor de autenticação.

Example

dab configure \
  --runtime.host.authentication.provider AppService

Configuração resultante

{
  "runtime": {
    "host": {
      "authentication": {
        "provider": "AppService"
      }
    }
  }
}

--runtime.host.authentication.jwt.audience

Configure um ou mais destinatários pretendidos do token JWT.

Example

dab configure \
  --runtime.host.authentication.jwt.audience api://my-app

Configuração resultante

{
  "runtime": {
    "host": {
      "authentication": {
        "jwt": {
          "audience": "api://my-app"
        }
      }
    }
  }
}

--runtime.host.authentication.jwt.issuer

Configure a entidade que emitiu o token JWT.

Example

dab configure \
  --runtime.host.authentication.jwt.issuer https://login.microsoftonline.com/common/v2.0

Configuração resultante

{
  "runtime": {
    "host": {
      "authentication": {
        "provider": "AppService",
        "jwt": {
          "audience": "api://my-app",
          "issuer": "https://login.microsoftonline.com/common/v2.0"
        }
      }
    }
  }
}

--runtime.health.enabled

Ativar ou desativar o endpoint de saúde global. A predefinição é true.

Example

dab configure \
  --runtime.health.enabled true

Configuração resultante

{
  "runtime": {
    "health": {
      "enabled": true
    }
  }
}

--runtime.health.cache-ttl-seconds

Tempo de viver em segundos para relatórios de verificação de saúde em cache. A predefinição é 5. O mínimo é 0.

Example

dab configure \
  --runtime.health.cache-ttl-seconds 10

Configuração resultante

{
  "runtime": {
    "health": {
      "cache-ttl-seconds": 10
    }
  }
}

--runtime.health.max-query-parallelism

Número máximo de consultas de verificação de saúde concorrentes. A predefinição é 4. Os valores são fixados ao intervalo suportado de 1 através 8de .

Example

dab configure \
  --runtime.health.max-query-parallelism 6

Configuração resultante

{
  "runtime": {
    "health": {
      "max-query-parallelism": 6
    }
  }
}

--runtime.health.roles

Papéis permitidos para visualizar resultados abrangentes de saúde. No modo de produção, configura pelo menos uma função.

Example

dab configure \
  --runtime.health.roles admin support

Configuração resultante

{
  "runtime": {
    "health": {
      "roles": [ "admin", "support" ]
    }
  }
}

--azure-key-vault.endpoint

Configure a URL do endpoint do Azure Key Vault.

Example

dab configure \
  --azure-key-vault.endpoint https://my-vault.vault.azure.net

Configuração resultante

{
  "azure-key-vault": {
    "endpoint": "https://my-vault.vault.azure.net"
  }
}

--azure-key-vault.retry-policy.mode

Configura o modo de política de retentativa.

Valores permitidos:

  • fixed
  • exponential

Example

dab configure \
  --azure-key-vault.retry-policy.mode fixed

Configuração resultante

{
  "azure-key-vault": {
    "retry-policy": {
      "mode": "fixed"
    }
  }
}

--azure-key-vault.retry-policy.max-count

Configure o número máximo de tentativas de retentativa.

Example

dab configure \
  --azure-key-vault.retry-policy.max-count 5

Configuração resultante

{
  "azure-key-vault": {
    "retry-policy": {
      "max-count": 5
    }
  }
}

--azure-key-vault.retry-policy.delay-seconds

Configure o atraso inicial entre tentativas em segundos.

Example

dab configure \
  --azure-key-vault.retry-policy.delay-seconds 2

Configuração resultante

{
  "azure-key-vault": {
    "retry-policy": {
      "delay-seconds": 2
    }
  }
}

--azure-key-vault.retry-policy.max-delay-seconds

Configure o atraso máximo entre tentativas em segundos (para modo exponencial).

Example

dab configure \
  --azure-key-vault.retry-policy.max-delay-seconds 30

Configuração resultante

{
  "azure-key-vault": {
    "retry-policy": {
      "max-delay-seconds": 30
    }
  }
}

--azure-key-vault.retry-policy.network-timeout-seconds

Configure o timeout da rede para pedidos em segundos.

Example

dab configure \
  --azure-key-vault.retry-policy.network-timeout-seconds 20

Configuração resultante

{
  "azure-key-vault": {
    "retry-policy": {
      "mode": "fixed",
      "max-count": 5,
      "delay-seconds": 2,
      "max-delay-seconds": 30,
      "network-timeout-seconds": 20
    }
  }
}

--runtime.telemetry.log-level

Configure a verbosidade dos registos por namespace. Use default para o nível de reserva global ou especifique um namespace ou nome de classe após --runtime.telemetry.log-level..

Valores permitidos: Trace, Debug, Information, Warning, Error, Critical, None.

Example

dab configure \
  --runtime.telemetry.log-level.default Warning \
  --runtime.telemetry.log-level.Azure.DataApiBuilder.Core Information

Configuração resultante

{
  "runtime": {
    "telemetry": {
      "log-level": {
        "default": "warning",
        "Azure.DataApiBuilder.Core": "information"
      }
    }
  }
}

--runtime.telemetry.azure-log-analytics.enabled

Ativar ou desativar o Azure Log Analytics.

Example

dab configure \
  --runtime.telemetry.azure-log-analytics.enabled true

Configuração resultante

{
  "runtime": {
    "telemetry": {
      "azure-log-analytics": {
        "enabled": true
      }
    }
  }
}

--runtime.telemetry.azure-log-analytics.dab-identifier

Configure uma cadeia de identificadores DAB usada no Azure Log Analytics.

Example

dab configure \
  --runtime.telemetry.azure-log-analytics.dab-identifier MyDab

Configuração resultante

{
  "runtime": {
    "telemetry": {
      "azure-log-analytics": {
        "dab-identifier": "MyDab"
      }
    }
  }
}

--runtime.telemetry.azure-log-analytics.flush-interval-seconds

Configure o intervalo de limpeza em segundos para o Azure Log Analytics.

Example

dab configure \
  --runtime.telemetry.azure-log-analytics.flush-interval-seconds 10

Configuração resultante

{
  "runtime": {
    "telemetry": {
      "azure-log-analytics": {
        "flush-interval-seconds": 10
      }
    }
  }
}

--runtime.telemetry.azure-log-analytics.auth.custom-table-name

Configure o nome de tabela personalizado para o Azure Log Analytics.

Example

dab configure \
  --runtime.telemetry.azure-log-analytics.auth.custom-table-name MyDabLogs

Configuração resultante

{
  "runtime": {
    "telemetry": {
      "azure-log-analytics": {
        "auth": {
          "custom-table-name": "MyDabLogs"
        }
      }
    }
  }
}

--runtime.telemetry.azure-log-analytics.auth.dcr-immutable-id

Configure o ID imutável do DCR para o Azure Log Analytics.

Example

dab configure \
  --runtime.telemetry.azure-log-analytics.auth.dcr-immutable-id dcr-123

Configuração resultante

{
  "runtime": {
    "telemetry": {
      "azure-log-analytics": {
        "auth": {
          "dcr-immutable-id": "dcr-123"
        }
      }
    }
  }
}

--runtime.telemetry.azure-log-analytics.auth.dce-endpoint

Configurar o endpoint DCE para Azure Log Analytics.

Example

dab configure \
  --runtime.telemetry.azure-log-analytics.auth.dce-endpoint https://example.eastus-1.ingest.monitor.azure.com

Configuração resultante

{
  "runtime": {
    "telemetry": {
      "azure-log-analytics": {
        "enabled": true,
        "auth": {
          "custom-table-name": "MyDabLogs",
          "dcr-immutable-id": "dcr-123",
          "dce-endpoint": "https://example.eastus-1.ingest.monitor.azure.com"
        },
        "dab-identifier": "MyDab",
        "flush-interval-seconds": 10
      }
    }
  }
}

--runtime.telemetry.file.enabled

Ativar ou desativar o registo do ficheiro.

Example

dab configure \
  --runtime.telemetry.file.enabled true

Configuração resultante

{
  "runtime": {
    "telemetry": {
      "file": {
        "enabled": true
      }
    }
  }
}

--runtime.telemetry.file.path

Configurar o caminho para o registo de ficheiros.

Example

dab configure \
  --runtime.telemetry.file.path C:\\logs\\dab-log.txt

Configuração resultante

{
  "runtime": {
    "telemetry": {
      "file": {
        "path": "C:\\logs\\dab-log.txt"
      }
    }
  }
}

--runtime.telemetry.file.rolling-interval

Configura o intervalo de rolling para o registo de ficheiros.

Valores permitidos:

  • Minute
  • Hour
  • Day
  • Month
  • Year
  • Infinite

Example

dab configure \
  --runtime.telemetry.file.rolling-interval Month

Configuração resultante

{
  "runtime": {
    "telemetry": {
      "file": {
        "rolling-interval": "Month"
      }
    }
  }
}

--runtime.telemetry.file.retained-file-count-limit

Configure o número máximo de ficheiros retidos.

Example

dab configure \
  --runtime.telemetry.file.retained-file-count-limit 5

Configuração resultante

{
  "runtime": {
    "telemetry": {
      "file": {
        "retained-file-count-limit": 5
      }
    }
  }
}

--runtime.telemetry.file.file-size-limit-bytes

Configure o limite máximo de tamanho dos ficheiros em bytes.

Example

dab configure \
  --runtime.telemetry.file.file-size-limit-bytes 2097152

Configuração resultante

{
  "runtime": {
    "telemetry": {
      "file": {
        "enabled": true,
        "path": "C:\\logs\\dab-log.txt",
        "rolling-interval": "Month",
        "retained-file-count-limit": 5,
        "file-size-limit-bytes": 2097152
      }
    }
  }
}

--show-effective-permissions

Mostrar as permissões resolvidas para cada entidade após a aplicação da herança de papel. Usa esta opção para veres o que cada função pode realmente fazer sem teres de raciocinar manualmente na configuração.

Observação

A funcionalidade Data API builder 2.0 descrita nesta secção está atualmente em pré-visualização e pode mudar antes da disponibilidade geral. Para mais informações, consulte O que há de novo na versão 2.0.

Example

dab configure \
  --show-effective-permissions

dab configure \
  --show-effective-permissions --config my-config.json

dab configure ^
  --show-effective-permissions --config my-config.json

Exemplo de saída

Entity: Book
	Role: anonymous        | Actions: Read
	Role: authenticated    | Actions: Read (inherited from: anonymous)
	Unconfigured roles inherit from: anonymous

Entity: Order
	Role: admin            | Actions: Create, Read, Update, Delete
	Role: anonymous        | Actions: Read
	Role: authenticated    | Actions: Read (inherited from: anonymous)
	Unconfigured roles inherit from: authenticated
  • Last updated on