Partilhar via

configure comando

Configure o tempo de execução sem entidade e as propriedades da fonte de dados em um arquivo de configuração existente do construtor de API de dados. 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

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

Visão rápida

Opção Resumo
-c, --config Caminho para o arquivo de configuração (padrão dab-config.json).
--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 o contexto da sessão.
--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.
--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.
--runtime.mcp.enabled Habilite ou desabilite o ponto de extremidade MCP.
--runtime.mcp.path Personaliza o caminho do endpoint MCP.
--runtime.mcp.dml-tools.enabled Habilite ou desabilite todas as ferramentas MCP DML.
--runtime.mcp.dml-tools.describe-entities.enabled Habilite ou desabilite a ferramenta describe-entities.
--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 registro de exclusão.
--runtime.mcp.dml-tools.execute-entity.enabled Habilite ou desabilite a ferramenta de entidade de execução.
--runtime.cache.enabled Habilite ou desabilite o cache global.
--runtime.cache.ttl-seconds TTL de cache global em segundos.
--runtime.host.mode Definir modo host: Desenvolvimento ou Produção.
--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.
--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 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 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.
--help Mostra este ecrã de ajuda.
--version Mostrar a informação da versão.

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

--data-source.options.database

Nome do banco de dados para Cosmos DB para NoSql.

Example

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

--data-source.options.schema

Caminho de esquema para Cosmos DB para NoSql.

Example

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

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

Ativar 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

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

--runtime.graphql.path

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

Example

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

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

--runtime.rest.enabled

Ativar o endpoint REST do DAB.

Example

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

--runtime.mcp.enabled

Ativar o endpoint MCP do DAB.

Observação

Esta opção está disponível apenas na CLI de pré-lançamento v1.7 (atualmente RC). Instale 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 apenas na CLI de pré-lançamento v1.7 (atualmente RC). Instale 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

Ativar o endpoint das ferramentas MCP DML do DAB.

Observação

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

Example

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

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

Ative a ferramenta MCP de descrever entidades do DAB.

Observação

Esta opção está disponível apenas na CLI de pré-lançamento v1.7 (atualmente RC). Instale 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

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

Observação

Esta opção está disponível apenas na CLI de pré-lançamento v1.7 (atualmente RC). Instale 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

Ative a ferramenta MCP de registo de leitura do DAB.

Observação

Esta opção está disponível apenas na CLI de pré-lançamento v1.7 (atualmente RC). Instale 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

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

Observação

Esta opção está disponível apenas na CLI de pré-lançamento v1.7 (atualmente RC). Instale 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

Ativa a ferramenta MCP de eliminar registos do DAB.

Observação

Esta opção está disponível apenas na CLI de pré-lançamento v1.7 (atualmente RC). Instale 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

Ativar a ferramenta MCP execute entity do DAB.

Observação

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

Example

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

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

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

--runtime.host.authentication.provider

Configure o nome do fornecedor de autenticação.

Example

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

--runtime.host.authentication.jwt.audience

Configure o(s) destinatário(s) pretendido(s) 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 endpoint do Azure Key Vault.

Example

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

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

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

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

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

Ativar ou desativar 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 identificadores 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 limpeza 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 de tabela personalizado 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 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

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

--runtime.telemetry.file.path

Configurar o caminho para o registo de ficheiros.

Example

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

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

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

--help

Mostra este ecrã de ajuda.

Example

dab configure \
  --help

--version

Mostrar a informação da versão.

Example

dab configure \
  --version
  • Last updated on