Compartilhar via

configure comando

Configure propriedades de runtime e fonte de dados que não sejam de 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).

Sintaxe

dab configure [options]

Observação

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

Olhar rápido

Opção Resumo
-c, --config Caminho para o arquivo de configuração (padrão dab-config.json).
--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 o contexto da sessão.
--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.
--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.
--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.dml-tools.enabled Habilitar ou desabilitar todas as ferramentas DML do MCP.
--runtime.mcp.dml-tools.describe-entities.enabled Habilite ou desabilite a ferramenta de descrever entidades.
--runtime.mcp.dml-tools.create-record.enabled Habilite ou desabilite a ferramenta create-record.
--runtime.mcp.dml-tools.read-records.enabled Habilite ou desabilite a ferramenta de registros de leitura.
--runtime.mcp.dml-tools.update-record.enabled Habilite ou desabilite a ferramenta de registro de atualização.
--runtime.mcp.dml-tools.delete-record.enabled Habilite ou desabilite a ferramenta de exclusão de registro.
--runtime.mcp.dml-tools.execute-entity.enabled Habilite ou desabilite a ferramenta execute-entity.
--runtime.cache.enabled Habilitar ou desabilitar o cache global.
--runtime.cache.ttl-seconds TTL de cache global em segundos.
--runtime.host.mode Defina o modo de host: Desenvolvimento ou Produção.
--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.
--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.
--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.
--help Exibir esta tela de ajuda.
--version Exibir informações de versão.

-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
  • 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;"

--data-source.options.database

Nome do banco de dados do Cosmos DB para NoSql.

Example

dab configure \
  --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

--data-source.options.schema

Caminho do esquema para o Cosmos DB para NoSql.

Example

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

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

Habilitar o contexto da sessão.

Valores permitidos:

  • true (padrão)
  • false

Example

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

Configuração resultante

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

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

--runtime.graphql.path

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

Example

dab configure \
  --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

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

--runtime.rest.enabled

Habilite o ponto de extremidade REST do DAB.

Example

dab configure \
  --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

--runtime.mcp.enabled

Habilite o ponto de extremidade MCP do DAB.

Observação

Essa opção está disponível apenas na CLI de pré-lançamento v1.7 (atualmente RC). Instalar 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 apenas na CLI de pré-lançamento v1.7 (atualmente RC). Instalar com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Configuração resultante

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

--runtime.mcp.dml-tools.enabled

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

Observação

Essa opção está disponível apenas na CLI de pré-lançamento v1.7 (atualmente RC). Instalar com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Habilite a ferramenta de descrever entidades do MCP do DAB.

Observação

Essa opção está disponível apenas na CLI de pré-lançamento v1.7 (atualmente RC). Instalar com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

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

Observação

Essa opção está disponível apenas na CLI de pré-lançamento v1.7 (atualmente RC). Instalar com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Habilite a ferramenta de registro de leitura MCP do DAB.

Observação

Essa opção está disponível apenas na CLI de pré-lançamento v1.7 (atualmente RC). Instalar com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

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

Observação

Essa opção está disponível apenas na CLI de pré-lançamento v1.7 (atualmente RC). Instalar com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

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

Observação

Essa opção está disponível apenas na CLI de pré-lançamento v1.7 (atualmente RC). Instalar com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

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

Observação

Essa opção está disponível apenas na CLI de pré-lançamento v1.7 (atualmente RC). Instalar com dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

--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.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.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

--runtime.host.authentication.provider

Configure o nome do provedor de autenticação.

Example

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

--runtime.host.authentication.jwt.audience

Configure os destinatários pretendidos do token JWT.

Example

dab configure \
  --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"
        }
      }
    }
  }
}

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

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

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

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

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

--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.azure-log-analytics.enabled

Habilitar ou desabilitar o Azure Log Analytics.

Example

dab configure \
  --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

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

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

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

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

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

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

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

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

--help

Exibir esta tela de ajuda.

Example

dab configure \
  --help

--version

Exibir informações de versão.

Example

dab configure \
  --version
  • Last updated on