Comando configure

Configure las propiedades en tiempo de ejecución y origen de datos que no son específicas de la 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).

Acrónimos usados en esta referencia: Model Context Protocol (MCP), data manipulation language (DML), time to live (TTL), JSON Web Token (JWT), release candidate (RC), data collection rule (DCR) y data collection endpoint (DCE).

Nota:

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

Syntax

dab configure [options]

Importante

La configuración de OpenTelemetry y Application Insights se configuran con dab add-telemetry, no dab configure. Consulte concept/monitor/open-telemetry.md y concept/monitor/application-insights.md.

Vista rápida

Opción Resumen
-c, --config Ruta de acceso al archivo de configuración (valor predeterminado dab-config.json).

Sección Origen de datos

Opción Resumen
--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 o deshabilite el contexto de sesión. Predeterminado: false.
--data-source.health.enabled Habilite o deshabilite la comprobación de estado del origen de datos.
--data-source.health.name Identificador del origen de datos en el informe de comprobación de estado.
--data-source.health.threshold-ms Umbral de consulta de comprobación de estado en milisegundos.
--data-source.user-delegated-auth.enabled Habilite la autenticación delegada por el usuario de OBO.
--data-source.user-delegated-auth.provider Establezca el proveedor de identidades de OBO.
--data-source.user-delegated-auth.database-audience Audiencia de destino para el token de SQL de bajada.
--data-source-files Haga referencia a archivos de configuración de orígenes de datos adicionales.

Sección graphQL

Opción Resumen
--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.

Sección REST

Opción Resumen
--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.

Sección de paginación

Opción Resumen
--runtime.pagination.max-page-size Tamaño máximo de página para los resultados paginados.
--runtime.pagination.default-page-size Tamaño de página predeterminado para los resultados paginados.
--runtime.pagination.next-link-relative Use direcciones URL relativas en los vínculos siguientes de paginación REST.

Sección MCP

Opción Resumen
--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.description Establezca la descripción del servidor MCP.
--runtime.mcp.dml-tools Habilite o deshabilite todas las herramientas de MCP DML.
--runtime.mcp.dml-tools.describe-entities Habilite o deshabilite la herramienta describe-entities.
--runtime.mcp.dml-tools.create-record Habilite o deshabilite la herramienta create-record.
--runtime.mcp.dml-tools.read-records Habilite o deshabilite la herramienta de registros de lectura.
--runtime.mcp.dml-tools.update-record Habilite o deshabilite la herramienta update-record.
--runtime.mcp.dml-tools.delete-record Habilite o deshabilite la herramienta delete-record.
--runtime.mcp.dml-tools.execute-entity Habilite o deshabilite la herramienta execute-entity.
--runtime.mcp.dml-tools.aggregate-records Habilite o deshabilite la herramienta de registros agregados.
--runtime.mcp.dml-tools.aggregate-records.query-timeout Tiempo de espera de ejecución en segundos para los registros agregados.

Sección caché

Opción Resumen
--runtime.cache.enabled Habilite o deshabilite la caché global.
--runtime.cache.ttl-seconds TTL de caché global en segundos.
--runtime.compression.level Establezca el nivel de compresión de respuesta HTTP.

Sección host

Opción Resumen
--runtime.host.mode Establecer el modo de host: desarrollo o producción.
--runtime.host.max-response-size-mb Tamaño máximo de respuesta en megabytes.
--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.

Sección de mantenimiento

Opción Resumen
--runtime.health.enabled Habilite o deshabilite el punto de conexión de mantenimiento global.
--runtime.health.cache-ttl-seconds Almacenar en caché TTL para los informes de comprobación de estado.
--runtime.health.max-query-parallelism Número máximo de consultas de comprobación de estado simultáneas.
--runtime.health.roles Roles permitidos para ver los resultados completos del estado.

Permisos efectivos

Opción Resumen
--show-effective-permissions Mostrar permisos resueltos para todas las entidades.

Sección Key Vault

Opción Resumen
--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 Se agota el tiempo de espera de las llamadas de red.

Sección telemetría

Opción Resumen
--runtime.telemetry.log-level Configure el nivel de detalle del registro por espacio de nombres.
--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.

-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
  • DWSQL
  • PostgreSQL
  • CosmosDB_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;"

Configuración resultante

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

--data-source-files

Haga referencia a archivos de configuración de orígenes de datos adicionales desde el archivo de configuración raíz.

Example

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

Configuración resultante

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

--data-source.options.database

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

Example

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

Configuración resultante

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

Configuración resultante

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

Configuración resultante

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

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

Habilite el contexto de sesión.

Valores permitidos:

  • true
  • false (valor predeterminado)

Example

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

Configuración resultante

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

--data-source.health.enabled

Habilite o deshabilite la comprobación de estado del origen de datos. El valor predeterminado es true.

Example

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

Configuración resultante

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

--data-source.health.name

Identificador del origen de datos en el informe de comprobación de estado.

Example

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

Configuración resultante

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

--data-source.health.threshold-ms

Duración máxima en milisegundos para la consulta de comprobación de estado del origen de datos. El valor predeterminado es 1000.

Example

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

Configuración resultante

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

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

Habilite o deshabilite la autenticación delegada por el usuario enBehalf-Of (OBO). Solo se admite para mssql orígenes de datos.

Nota:

La funcionalidad de Data API Builder 2.0 descrita en esta sección se encuentra actualmente en versión preliminar y podría cambiar antes de la disponibilidad general. Para obtener más información, consulte Novedades de la versión 2.0.

Example

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

Configuración resultante

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

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

Establezca el proveedor de identidades para la autenticación delegada por el usuario enBehalf-Of (OBO). Actualmente, solo se admite EntraId.

Nota:

La funcionalidad de Data API Builder 2.0 descrita en esta sección se encuentra actualmente en versión preliminar y podría cambiar antes de la disponibilidad general. Para obtener más información, consulte Novedades de la versión 2.0.

Example

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

Configuración resultante

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

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

Establezca la audiencia de destino para el token sql de nivel inferior cuando se habilite OBO.

Example

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

Configuración resultante

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

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

Configuración resultante

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

Configuración resultante

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

Configuración resultante

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

Configuración resultante

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

Configuración resultante

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

Configuración resultante

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

--runtime.pagination.max-page-size

Tamaño máximo de página para los resultados paginados. El valor predeterminado es 100000. El valor mínimo es 1.

Example

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

Configuración resultante

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

--runtime.pagination.default-page-size

Tamaño de página predeterminado para los resultados paginados. El valor predeterminado es 100. El valor mínimo es 1.

Example

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

Configuración resultante

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

--runtime.pagination.next-link-relative

Use direcciones URL relativas en lugar de direcciones URL absolutas en valores de paginación nextLink REST. El valor predeterminado es false.

Example

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

Configuración resultante

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

--runtime.mcp.enabled

Habilite el punto de conexión MCP de DAB.

Nota:

Esta opción está disponible en la CLI de la versión preliminar de Data API Builder 2.0. Instale la versión preliminar más reciente 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 está disponible en la CLI de la versión preliminar de Data API Builder 2.0. Instale la versión preliminar más reciente con dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Configuración resultante

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

--runtime.mcp.description

Establezca la descripción del servidor MCP que se expondrá en la respuesta inicializada.

Nota:

Esta opción está disponible en la CLI de la versión preliminar de Data API Builder 2.0. Instale la versión preliminar más reciente con dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Configuración resultante

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

--runtime.mcp.dml-tools

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

Nota:

Esta opción está disponible en la CLI de la versión preliminar de Data API Builder 2.0. Instale la versión preliminar más reciente con dotnet tool install microsoft.dataapibuilder --prerelease.

Para obtener más información sobre las herramientas de MCP DML, consulte HERRAMIENTAS del lenguaje de manipulación de datos de SQL MCP Server.

Example

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

Configuración resultante

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

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

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

Nota:

Esta opción está disponible en la CLI de la versión preliminar de Data API Builder 2.0. Instale la versión preliminar más reciente con dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Configuración resultante

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

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

Habilite la herramienta de creación de registros MCP de DAB.

Nota:

Esta opción está disponible en la CLI de la versión preliminar de Data API Builder 2.0. Instale la versión preliminar más reciente con dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Configuración resultante

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

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

Habilite la herramienta de registro de lectura MCP de DAB.

Nota:

Esta opción está disponible en la CLI de la versión preliminar de Data API Builder 2.0. Instale la versión preliminar más reciente con dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Configuración resultante

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

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

Habilite la herramienta de registro de actualización MCP de DAB.

Nota:

Esta opción está disponible en la CLI de la versión preliminar de Data API Builder 2.0. Instale la versión preliminar más reciente con dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Configuración resultante

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

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

Habilite la herramienta de eliminación de registros MCP de DAB.

Nota:

Esta opción está disponible en la CLI de la versión preliminar de Data API Builder 2.0. Instale la versión preliminar más reciente con dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Configuración resultante

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

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

Habilite la herramienta de ejecución de entidad MCP de DAB.

Nota:

Esta opción está disponible en la CLI de la versión preliminar de Data API Builder 2.0. Instale la versión preliminar más reciente con dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Configuración resultante

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

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

Habilite la herramienta de registros agregados MCP de DAB.

Nota:

Esta opción está disponible en la CLI de la versión preliminar de Data API Builder 2.0. Instale la versión preliminar más reciente con dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Configuración resultante

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

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

Establezca el tiempo de espera de ejecución en segundos para la herramienta MCP de registros agregados.

Predeterminado: 30. Intervalo: de 1 a 600.

Nota:

Esta opción está disponible en la CLI de la versión preliminar de Data API Builder 2.0. Instale la versión preliminar más reciente con dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Configuración resultante

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

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

Nota:

La funcionalidad de Data API Builder 2.0 descrita en esta sección se encuentra actualmente en versión preliminar y podría cambiar antes de la disponibilidad general. Para obtener más información, consulte Novedades de la versión 2.0.

Establezca el nivel de compresión de respuesta HTTP.

Valores permitidos:

  • optimal: equilibra la relación de compresión y la velocidad (valor predeterminado)
  • fastest: da prioridad a la velocidad de compresión por encima de la relación
  • none: deshabilita la compresión.

Example

dab configure \
  --runtime.compression.level optimal

Configuración resultante

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

--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.max-response-size-mb

Tamaño máximo en megabytes para una respuesta de base de datos en un único resultado. El valor predeterminado es 158.

Example

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

Configuración resultante

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

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

Configuración resultante

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

Configuración resultante

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

--runtime.host.authentication.jwt.audience

Configure uno o varios destinatarios previstos del token JWT.

Example

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

Configuración resultante

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

--runtime.health.enabled

Habilite o deshabilite el punto de conexión de mantenimiento global. El valor predeterminado es true.

Example

dab configure \
  --runtime.health.enabled true

Configuración resultante

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

--runtime.health.cache-ttl-seconds

Período de vida en segundos para los informes de comprobación de estado almacenados en caché. El valor predeterminado es 5. El valor mínimo es 0.

Example

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

Configuración resultante

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

--runtime.health.max-query-parallelism

Número máximo de consultas de comprobación de estado simultáneas. El valor predeterminado es 4. Los valores se fijan en el intervalo admitido de a través 8de 1 .

Example

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

Configuración resultante

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

--runtime.health.roles

Roles permitidos para ver los resultados completos del estado. En modo de producción, configure al menos un rol.

Example

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

Configuración resultante

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

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

Configuración resultante

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

Configuración resultante

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

Configuración resultante

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

Configuración resultante

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

Configuración resultante

{
  "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.log-level

Configure el nivel de detalle del registro por espacio de nombres. Use default para el nivel de reserva global o especifique un espacio de nombres o un nombre de clase después --runtime.telemetry.log-level.de .

Valores permitidos: Trace, Debug, Information, WarningError, , Critical, . None

Example

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

Configuración resultante

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

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

Habilite o deshabilite Azure Log Analytics.

Example

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

Configuración resultante

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

Configuración resultante

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

Configuración resultante

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

Configuración resultante

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

Configuración resultante

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

Configuración resultante

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

Configuración resultante

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

Configuración resultante

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

Configuración resultante

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

--show-effective-permissions

Muestra los permisos resueltos para cada entidad después de aplicar la herencia de roles. Use esta opción para ver qué puede hacer realmente cada rol sin razonar manualmente a través de la configuración.

Nota:

La funcionalidad de Data API Builder 2.0 descrita en esta sección se encuentra actualmente en versión preliminar y podría cambiar antes de la disponibilidad general. Para obtener más información, consulte Novedades de la versión 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

Salida de ejemplo

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