configure comando

Configure propriedades de runtime e fonte de dados que não são específicas da entidade em um arquivo de configuração existente do construtor de API de Dados. As 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: Protocolo de Contexto de Modelo (MCP), DML (linguagem de manipulação de dados), TTL (tempo de vida útil), JWT (Token Web JSON), RC (release candidate), DCR (regra de coleta de dados) e ponto de extremidade de coleta de dados (DCE).

Observação

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

Sintaxe

dab configure [options]

Importante

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

Olhar rápido

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

Seção Fonte de dados

Opção Resumo
--data-source.database-type Defina o tipo de banco 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 do Cosmos DB para NoSql.
--data-source.options.container Nome do contêiner do Cosmos DB para NoSql.
--data-source.options.schema Caminho do esquema para o Cosmos DB para NoSql.
--data-source.options.set-session-context Habilitar ou desabilitar o contexto da sessão. Padrão: false.
--data-source.health.enabled Habilite ou desabilite a verificação de integridade da fonte de dados.
--data-source.health.name Identificador da fonte de dados no relatório de verificação de integridade.
--data-source.health.threshold-ms Limite de consulta de verificação de integridade em milissegundos.
--data-source.user-delegated-auth.enabled Habilite a autenticação delegada pelo usuário do OBO.
--data-source.user-delegated-auth.provider Defina o provedor de identidade OBO.
--data-source.user-delegated-auth.database-audience Público-alvo para o token SQL downstream.
--data-source-files Referenciar arquivos de configuração de fonte de dados adicionais.

Seção GraphQL

Opção Resumo
--runtime.graphql.depth-limit Limite a profundidade máxima da consulta.
--runtime.graphql.enabled Habilitar ou desabilitar o ponto de extremidade do GraphQL.
--runtime.graphql.path Personalize o caminho do ponto de extremidade do GraphQL.
--runtime.graphql.allow-introspection Permitir ou negar a introspecção do GraphQL.
--runtime.graphql.multiple-mutations.create.enabled Habilitar mutações de criação múltipla.

Seção REST

Opção Resumo
--runtime.rest.enabled Habilitar ou desabilitar o ponto de extremidade REST.
--runtime.rest.path Personalize o caminho do ponto de extremidade REST.
--runtime.rest.request-body-strict Imponha a validação estrita do corpo da solicitação REST.

Seção Paginação

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

Seção MCP

Opção Resumo
--runtime.mcp.enabled Habilitar ou desabilitar o ponto de extremidade MCP.
--runtime.mcp.path Personalize o caminho do ponto de extremidade DO MCP.
--runtime.mcp.description Defina a descrição do servidor MCP.
--runtime.mcp.dml-tools Habilitar ou desabilitar todas as ferramentas DML do MCP.
--runtime.mcp.dml-tools.describe-entities Habilite ou desabilite a ferramenta de descrever entidades.
--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 exclusão de registro.
--runtime.mcp.dml-tools.execute-entity Habilite ou desabilite a ferramenta execute-entity.
--runtime.mcp.dml-tools.aggregate-records Habilite ou desabilite a ferramenta de registros agregados.
--runtime.mcp.dml-tools.aggregate-records.query-timeout Tempo limite de execução em segundos para registros agregados.

Seção Cache

Opção Resumo
--runtime.cache.enabled Habilitar ou desabilitar o cache global.
--runtime.cache.ttl-seconds TTL de cache global em segundos.
--runtime.compression.level Defina o nível de compactação de resposta HTTP.

Seção Host

Opção Resumo
--runtime.host.mode Defina o modo de host: Desenvolvimento ou Produção.
--runtime.host.max-response-size-mb Tamanho máximo da resposta em megabytes.
--runtime.host.cors.origins Origens de CORS permitidas.
--runtime.host.cors.allow-credentials Defina as credenciais de permissão do CORS.
--runtime.host.authentication.provider Provedor de autenticação.
--runtime.host.authentication.jwt.audience Declaração de audiência JWT.
--runtime.host.authentication.jwt.issuer Declaração do emissor JWT.

Seção Integridade

Opção Resumo
--runtime.health.enabled Habilite ou desabilite o ponto de extremidade de integridade global.
--runtime.health.cache-ttl-seconds TTL de cache para relatórios de verificação de integridade.
--runtime.health.max-query-parallelism Consultas de verificação de integridade simultânea máximas.
--runtime.health.roles Funções permitidas para exibir resultados abrangentes de integridade.

Permissões efetivas

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

Seção Key Vault

Opção Resumo
--azure-key-vault.endpoint Ponto de extremidade base do Azure Key Vault.
--azure-key-vault.retry-policy.mode Modo de política de repetição.
--azure-key-vault.retry-policy.max-count Tentativas máximas de repetição.
--azure-key-vault.retry-policy.delay-seconds Atraso entre novas tentativas.
--azure-key-vault.retry-policy.max-delay-seconds Atraso máximo para novas tentativas exponencial.
--azure-key-vault.retry-policy.network-timeout-seconds Tempo limite para chamadas de rede.

Seção Telemetria

Opção Resumo
--runtime.telemetry.log-level Configure a verbosidade de log 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 log.
--runtime.telemetry.azure-log-analytics.flush-interval-seconds Liberar 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 coleta de dados.
--runtime.telemetry.azure-log-analytics.auth.dce-endpoint Ponto de extremidade de coleta de dados.
--runtime.telemetry.file.enabled Habilitar a telemetria do coletor de arquivos.
--runtime.telemetry.file.path Caminho para o arquivo de log.
--runtime.telemetry.file.rolling-interval Intervalo sem interrupção.
--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. O padrão é, a dab-config.json menos que dab-config.<DAB_ENVIRONMENT>.json exista, onde DAB_ENVIRONMENT está uma variável de ambiente.

Example

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

--data-source.database-type

Tipo de banco 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

Cadeia de conexã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

Faça referência a arquivos de configuração de fonte de dados adicionais do arquivo 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 do 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 do 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 do esquema para o 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

Habilitar 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

Habilite ou desabilite a verificação de integridade da fonte de dados. O padrã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 de dados no relatório de verificação de integridade.

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 integridade da fonte de dados. O padrã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

Habilitar ou desabilitar a autenticação delegada pelo usuário do OBO (On-Behalf-Of). Com suporte apenas para mssql fontes de dados.

Observação

A funcionalidade do Construtor de API de Dados 2.0 descrita nesta seção está atualmente em versão prévia e pode ser alterada antes da disponibilidade geral. Para obter 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 provedor de identidade para autenticação delegada pelo usuário do OBO (On-Behalf-Of). Atualmente, há suporte apenas para EntraId.

Observação

A funcionalidade do Construtor de API de Dados 2.0 descrita nesta seção está atualmente em versão prévia e pode ser alterada antes da disponibilidade geral. Para obter 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 downstream quando o OBO estiver habilitado.

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

Profundidade máxima permitida da 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

Habilite o ponto de extremidade do GraphQL do DAB.

Example

dab configure \
  --runtime.graphql.enabled false

Configuração resultante

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

--runtime.graphql.path

Personalize o caminho do ponto de extremidade graphQL do DAB. Caminho de prefixo com /.

Example

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

Configuração resultante

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

--runtime.graphql.allow-introspection

Permitir ou negar solicitações de introspecçã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

Habilite ou desabilite operações de criação de várias mutações no esquema do 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

Habilite o ponto de extremidade REST do DAB.

Example

dab configure \
  --runtime.rest.enabled false

Configuração resultante

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

--runtime.rest.path

Personalize o caminho do ponto de extremidade REST do DAB. Caminho de prefixo com /.

Example

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

Configuração resultante

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

--runtime.rest.request-body-strict

Proibir campos de corpo da solicitação REST extraneous.

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 da página para resultados paginados. O padrã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 da página padrão para resultados paginados. O padrã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 em valores de paginação nextLink REST. O padrão é false.

Example

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

Configuração resultante

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

--runtime.mcp.enabled

Habilite o ponto de extremidade MCP do DAB.

Observação

Essa opção está disponível na CLI de versão prévia do Construtor de API de Dados 2.0. Instale o pré-lançamento mais recente com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

dab configure \
  --runtime.mcp.enabled false

Configuração resultante

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

--runtime.mcp.path

Personalize o caminho do ponto de extremidade MCP do DAB. Caminho de prefixo com /.

Observação

Essa opção está disponível na CLI de versão prévia do Construtor de API de Dados 2.0. Instale o pré-lançamento mais recente 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 a ser exposta na resposta inicializada.

Observação

Essa opção está disponível na CLI de versão prévia do Construtor de API de Dados 2.0. Instale o pré-lançamento mais recente 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

Habilite o ponto de extremidade de ferramentas do MCP DML do DAB.

Observação

Essa opção está disponível na CLI de versão prévia do Construtor de API de Dados 2.0. Instale o pré-lançamento mais recente com dotnet tool install microsoft.dataapibuilder --prerelease.

Para obter mais informações sobre as ferramentas DML do MCP, consulte as ferramentas de linguagem de manipulação de dados do 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

Habilite a ferramenta de descrever entidades do MCP do DAB.

Observação

Essa opção está disponível na CLI de versão prévia do Construtor de API de Dados 2.0. Instale o pré-lançamento mais recente 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

Habilite a ferramenta de registro de criação do MCP do DAB.

Observação

Essa opção está disponível na CLI de versão prévia do Construtor de API de Dados 2.0. Instale o pré-lançamento mais recente 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

Habilite a ferramenta de registro de leitura MCP do DAB.

Observação

Essa opção está disponível na CLI de versão prévia do Construtor de API de Dados 2.0. Instale o pré-lançamento mais recente 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

Habilite a ferramenta de registro de atualização MCP do DAB.

Observação

Essa opção está disponível na CLI de versão prévia do Construtor de API de Dados 2.0. Instale o pré-lançamento mais recente 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

Habilite a ferramenta de registro de exclusão mcp do DAB.

Observação

Essa opção está disponível na CLI de versão prévia do Construtor de API de Dados 2.0. Instale o pré-lançamento mais recente 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

Habilite a ferramenta de entidade de execução do MCP do DAB.

Observação

Essa opção está disponível na CLI de versão prévia do Construtor de API de Dados 2.0. Instale o pré-lançamento mais recente 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

Habilite a ferramenta de registros de agregação MCP do DAB.

Observação

Essa opção está disponível na CLI de versão prévia do Construtor de API de Dados 2.0. Instale o pré-lançamento mais recente 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 tempo limite de execução em segundos para a ferramenta MCP de registros agregados.

Padrão: 30. Intervalo: 1 a 600.

Observação

Essa opção está disponível na CLI de versão prévia do Construtor de API de Dados 2.0. Instale o pré-lançamento mais recente 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

Habilite o cache do DAB globalmente. Você também deve habilitar o cache para cada entidade.

Example

dab configure \
  --runtime.cache.enabled true

Configuração resultante

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

--runtime.cache.ttl-seconds

Personalize o tempo padrão global do 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 do Construtor de API de Dados 2.0 descrita nesta seção está atualmente em versão prévia e pode ser alterada antes da disponibilidade geral. Para obter mais informações, consulte o que há de novo na versão 2.0.

Defina o nível de compactação de resposta HTTP.

Valores permitidos:

  • optimal— equilibra a taxa de compactação e a velocidade (padrão)
  • fastest— prioriza a velocidade da compactação em relação à taxa
  • none— desabilita a compactaçã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 banco de dados em um único resultado. O padrã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

Substitua as origens permitidas no CORS. Forneça 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 provedor 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

Habilite ou desabilite o ponto de extremidade de integridade global. O padrão é true.

Example

dab configure \
  --runtime.health.enabled true

Configuração resultante

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

--runtime.health.cache-ttl-seconds

Tempo de vida em segundos para relatórios de verificação de integridade armazenados em cache. O padrã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

Consultas de verificação de integridade simultânea máximas. O padrão é 4. Os valores são fixados ao intervalo com suporte de 1 até 8.

Example

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

Configuração resultante

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

--runtime.health.roles

Funções permitidas para exibir resultados abrangentes de integridade. No modo de produção, configure 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 ponto de extremidade 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

Configure o modo de política de repetição.

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 repetição.

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 novas 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 repetições em segundos (para o 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 tempo limite de rede para solicitações 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 de log por namespace. Use default para o nível de fallback 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

Habilitar ou desabilitar 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 caracteres de identificador do 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 liberação 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 da tabela personalizada 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 a 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

Configure o ponto de extremidade DCE para o 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

Habilitar ou desabilitar o registro em log do coletor de arquivos.

Example

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

Configuração resultante

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

--runtime.telemetry.file.path

Configure o caminho para o registro em log do coletor de arquivos.

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

Configure o intervalo de rolagem para o registro em log do coletor de arquivos.

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 arquivos 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 do arquivo 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

Exiba as permissões resolvidas para cada entidade após a aplicação da herança de função. Use essa opção para ver o que cada função pode realmente fazer sem raciocínio por meio da configuração manualmente.

Observação

A funcionalidade do Construtor de API de Dados 2.0 descrita nesta seção está atualmente em versão prévia e pode ser alterada antes da disponibilidade geral. Para obter 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

Saída de exemplo

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