Compartir a través de

Comando configure

Configure las propiedades de origen de datos y runtime que no son de entidad en un archivo de configuración de Data API Builder existente. Las opciones no especificadas dejan los valores existentes sin modificar. Si alguna opción proporcionada no es válida, se produce un error en toda la actualización (todo o nada).

Syntax

dab configure [options]

Nota:

Este comando no modifica la entities sección. Use dab update para los cambios de entidad.

Vista rápida

Opción Resumen
-c, --config Ruta de acceso al archivo de configuración (valor predeterminado dab-config.json).
--data-source.database-type Establezca el tipo de base de datos.
--data-source.connection-string Establezca la cadena de conexión de la base de datos.
--data-source.options.database Nombre de la base de datos de Cosmos DB para NoSql.
--data-source.options.container Nombre del contenedor para Cosmos DB para NoSql.
--data-source.options.schema Ruta de acceso de esquema para Cosmos DB para NoSql.
--data-source.options.set-session-context Habilite el contexto de sesión.
--runtime.graphql.depth-limit Limitar la profundidad máxima de la consulta.
--runtime.graphql.enabled Habilite o deshabilite el punto de conexión de GraphQL.
--runtime.graphql.path Personalice la ruta de acceso del punto de conexión de GraphQL.
--runtime.graphql.allow-introspection Permitir o denegar la introspección de GraphQL.
--runtime.graphql.multiple-mutations.create.enabled Habilite las mutaciones de varias creaciones.
--runtime.rest.enabled Habilite o deshabilite el punto de conexión rest.
--runtime.rest.path Personalice la ruta de acceso del punto de conexión de REST.
--runtime.rest.request-body-strict Aplique la validación estricta del cuerpo de la solicitud REST.
--runtime.mcp.enabled Habilite o deshabilite el punto de conexión de MCP.
--runtime.mcp.path Personalice la ruta de acceso del punto de conexión de MCP.
--runtime.mcp.dml-tools.enabled Habilite o deshabilite todas las herramientas de MCP DML.
--runtime.mcp.dml-tools.describe-entities.enabled Habilite o deshabilite la herramienta describe-entities.
--runtime.mcp.dml-tools.create-record.enabled Habilite o deshabilite la herramienta create-record.
--runtime.mcp.dml-tools.read-records.enabled Habilite o deshabilite la herramienta de registros de lectura.
--runtime.mcp.dml-tools.update-record.enabled Habilite o deshabilite la herramienta update-record.
--runtime.mcp.dml-tools.delete-record.enabled Habilite o deshabilite la herramienta delete-record.
--runtime.mcp.dml-tools.execute-entity.enabled Habilite o deshabilite la herramienta execute-entity.
--runtime.cache.enabled Habilite o deshabilite la caché global.
--runtime.cache.ttl-seconds TTL de caché global en segundos.
--runtime.host.mode Establecer el modo de host: desarrollo o producción.
--runtime.host.cors.origins Orígenes cors permitidos.
--runtime.host.cors.allow-credentials Establezca credenciales permitidas de CORS.
--runtime.host.authentication.provider Proveedor de autenticación.
--runtime.host.authentication.jwt.audience Notificación de audiencia de JWT.
--runtime.host.authentication.jwt.issuer Notificación del emisor de JWT.
--azure-key-vault.endpoint Punto de conexión base de Azure Key Vault.
--azure-key-vault.retry-policy.mode Modo de directiva de reintento.
--azure-key-vault.retry-policy.max-count Número máximo de reintentos.
--azure-key-vault.retry-policy.delay-seconds Retraso entre reintentos.
--azure-key-vault.retry-policy.max-delay-seconds Retraso máximo para reintentos exponenciales.
--azure-key-vault.retry-policy.network-timeout-seconds Tiempo de espera de las llamadas de red.
--runtime.telemetry.azure-log-analytics.enabled Habilite la telemetría de Azure Log Analytics.
--runtime.telemetry.azure-log-analytics.dab-identifier Distinguir el origen del registro.
--runtime.telemetry.azure-log-analytics.flush-interval-seconds Cadencia de vaciado en segundos.
--runtime.telemetry.azure-log-analytics.auth.custom-table-name Nombre de tabla personalizado.
--runtime.telemetry.azure-log-analytics.auth.dcr-immutable-id Identificador de regla de recopilación de datos.
--runtime.telemetry.azure-log-analytics.auth.dce-endpoint Punto de conexión de recopilación de datos.
--runtime.telemetry.file.enabled Habilite la telemetría del receptor de archivos.
--runtime.telemetry.file.path Ruta de acceso al archivo de registro.
--runtime.telemetry.file.rolling-interval Intervalo gradual.
--runtime.telemetry.file.retained-file-count-limit Número máximo de archivos retenidos.
--runtime.telemetry.file.file-size-limit-bytes Tamaño máximo por archivo antes de la puesta al día.
--help Muestra esta pantalla de ayuda.
--version Mostrar información de versión.

-c, --config

Ruta de acceso al archivo de configuración. El valor predeterminado es a dab-config.json menos que dab-config.<DAB_ENVIRONMENT>.json exista, donde DAB_ENVIRONMENT es una variable de entorno.

Example

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

--data-source.database-type

Tipo de base de datos.

Valores permitidos:

  • MSSQL
  • PostgreSQL
  • CosmosDB_NoSQL
  • MySQL

Example

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

Configuración resultante

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

--data-source.connection-string

Cadena de conexión para el origen de datos.

Example

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

--data-source.options.database

Nombre de la base de datos de Cosmos DB para NoSql.

Example

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

--data-source.options.container

Nombre del contenedor para Cosmos DB para NoSql.

Example

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

--data-source.options.schema

Ruta de acceso de esquema para Cosmos DB para NoSql.

Example

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

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

Habilite el contexto de sesión.

Valores permitidos:

  • true (valor predeterminado)
  • false

Example

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

Configuración resultante

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

--runtime.graphql.depth-limit

Profundidad máxima permitida de la consulta anidada.

Valores permitidos:

  • $(0,2147483647]$ (inclusive)
  • -1 para quitar el límite

Example

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

Configuración resultante

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

--runtime.graphql.enabled

Habilite el punto de conexión de GraphQL de DAB.

Example

dab configure \
  --runtime.graphql.enabled false

--runtime.graphql.path

Personalice la ruta de acceso del punto de conexión de GraphQL de DAB. Ruta de acceso de prefijo con /.

Example

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

--runtime.graphql.allow-introspection

Permitir o denegar solicitudes de introspección de GraphQL.

Example

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

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

Habilite o deshabilite las operaciones de creación de varias mutaciones en el esquema de GraphQL generado.

Example

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

--runtime.rest.enabled

Habilite el punto de conexión REST de DAB.

Example

dab configure \
  --runtime.rest.enabled false

--runtime.rest.path

Personalice la ruta de acceso del punto de conexión REST de DAB. Ruta de acceso de prefijo con /.

Example

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

Configuración resultante

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

--runtime.rest.request-body-strict

Prohibir campos de cuerpo de solicitud REST extraños.

Example

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

--runtime.mcp.enabled

Habilite el punto de conexión MCP de DAB.

Nota:

Esta opción solo está disponible en la CLI de versión preliminar v1.7 (actualmente RC). Instale con dotnet tool install microsoft.dataapibuilder --prerelease.

Example

dab configure \
  --runtime.mcp.enabled false

Configuración resultante

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

--runtime.mcp.path

Personalice la ruta de acceso del punto de conexión de MCP de DAB. Ruta de acceso de prefijo con /.

Nota:

Esta opción solo está disponible en la CLI de versión preliminar v1.7 (actualmente RC). Instale con dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Configuración resultante

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

--runtime.mcp.dml-tools.enabled

Habilite el punto de conexión de herramientas de MCP DML de DAB.

Nota:

Esta opción solo está disponible en la CLI de versión preliminar v1.7 (actualmente RC). Instale con dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Habilite la herramienta MCP de MCP de DAB para describir entidades.

Nota:

Esta opción solo está disponible en la CLI de versión preliminar v1.7 (actualmente RC). Instale con 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 la herramienta de creación de registros MCP de DAB.

Nota:

Esta opción solo está disponible en la CLI de versión preliminar v1.7 (actualmente RC). Instale con 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 la herramienta de registro de lectura MCP de DAB.

Nota:

Esta opción solo está disponible en la CLI de versión preliminar v1.7 (actualmente RC). Instale con 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 la herramienta de registro de actualización MCP de DAB.

Nota:

Esta opción solo está disponible en la CLI de versión preliminar v1.7 (actualmente RC). Instale con 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 la herramienta de eliminación de registros MCP de DAB.

Nota:

Esta opción solo está disponible en la CLI de versión preliminar v1.7 (actualmente RC). Instale con 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 la herramienta de ejecución de entidad MCP de DAB.

Nota:

Esta opción solo está disponible en la CLI de versión preliminar v1.7 (actualmente RC). Instale con dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

--runtime.cache.enabled

Habilite la caché de DAB globalmente. También debe habilitar el almacenamiento en caché para cada entidad.

Example

dab configure \
  --runtime.cache.enabled true

Configuración resultante

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

--runtime.cache.ttl-seconds

Personalice el tiempo predeterminado global de la caché DAB para que viva en segundos.

Example

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

Configuración resultante

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

--runtime.host.mode

Establezca el modo de ejecución del host de DAB.

Valores permitidos:

  • Development
  • Production

Example

dab configure \
  --runtime.host.mode Development

Configuración resultante

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

--runtime.host.cors.origins

Sobrescribir los orígenes permitidos en CORS. Proporcione valores como una lista separada por espacios.

Example

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

Configuración resultante

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

--runtime.host.cors.allow-credentials

Establezca el valor del Access-Control-Allow-Credentials encabezado.

Example

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

--runtime.host.authentication.provider

Configure el nombre del proveedor de autenticación.

Example

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

--runtime.host.authentication.jwt.audience

Configure los destinatarios previstos del token JWT.

Example

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

--runtime.host.authentication.jwt.issuer

Configure la entidad que emitió el token JWT.

Example

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

Configuración resultante

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

--azure-key-vault.endpoint

Configure la dirección URL del punto de conexión de Azure Key Vault.

Example

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

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

Configure el modo de directiva de reintento.

Valores permitidos:

  • fixed
  • exponential

Example

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

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

Configure el número máximo de reintentos.

Example

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

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

Configure el retraso inicial entre reintentos en segundos.

Example

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

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

Configure el retraso máximo entre reintentos en segundos (para el modo exponencial).

Example

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

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

Configure el tiempo de espera de red para las solicitudes en segundos.

Example

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

Configuración 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

Habilite o deshabilite Azure Log Analytics.

Example

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

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

Configure una cadena de identificador DAB usada en Azure Log Analytics.

Example

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

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

Configure el intervalo de vaciado en segundos para 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 el nombre de tabla personalizado para 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 el identificador inmutable de DCR para 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 el punto de conexión de DCE para Azure Log Analytics.

Example

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

Configuración 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

Habilite o deshabilite el registro del receptor de archivos.

Example

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

--runtime.telemetry.file.path

Configure la ruta de acceso para el registro del receptor de archivos.

Example

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

--runtime.telemetry.file.rolling-interval

Configure el intervalo gradual para el registro del receptor de archivos.

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 el número máximo de archivos retenidos.

Example

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

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

Configure el límite máximo de tamaño de archivo en bytes.

Example

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

Configuración 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

Muestra esta pantalla de ayuda.

Example

dab configure \
  --help

--version

Mostrar información de versión.

Example

dab configure \
  --version
  • Last updated on