Partager via

Commande configure

Configurez les propriétés du runtime et de la source de données non-entité dans un fichier de configuration existant du générateur d’API de données. Les options non spécifiées conservent les valeurs existantes inchangées. Si une option fournie n’est pas valide, la mise à jour entière échoue (tout ou rien).

Syntaxe

dab configure [options]

Note

Cette commande ne modifie pas la entities section. Utiliser dab update pour les modifications d’entité.

Aperçu rapide

Choix Résumé
-c, --config Chemin d’accès au fichier de configuration (par défaut dab-config.json).
--data-source.database-type Définissez le type de base de données.
--data-source.connection-string Définissez la chaîne de connexion de base de données.
--data-source.options.database Nom de la base de données pour Cosmos DB pour NoSql.
--data-source.options.container Nom du conteneur pour Cosmos DB pour NoSql.
--data-source.options.schema Chemin du schéma pour Cosmos DB pour NoSql.
--data-source.options.set-session-context Activez le contexte de session.
--runtime.graphql.depth-limit Limitez la profondeur maximale de requête.
--runtime.graphql.enabled Activez ou désactivez le point de terminaison GraphQL.
--runtime.graphql.path Personnalisez le chemin du point de terminaison GraphQL.
--runtime.graphql.allow-introspection Autoriser ou refuser l’introspection GraphQL.
--runtime.graphql.multiple-mutations.create.enabled Activez plusieurs mutations de création.
--runtime.rest.enabled Activez ou désactivez le point de terminaison REST.
--runtime.rest.path Personnalisez le chemin du point de terminaison REST.
--runtime.rest.request-body-strict Appliquez la validation stricte du corps de la demande REST.
--runtime.mcp.enabled Activez ou désactivez le point de terminaison MCP.
--runtime.mcp.path Personnalisez le chemin du point de terminaison MCP.
--runtime.mcp.dml-tools.enabled Activez ou désactivez tous les outils DML MCP.
--runtime.mcp.dml-tools.describe-entities.enabled Activez ou désactivez l’outil describe-entities.
--runtime.mcp.dml-tools.create-record.enabled Activez ou désactivez l’outil create-record.
--runtime.mcp.dml-tools.read-records.enabled Activez ou désactivez l’outil d’enregistrement en lecture.
--runtime.mcp.dml-tools.update-record.enabled Activez ou désactivez l’outil update-record.
--runtime.mcp.dml-tools.delete-record.enabled Activez ou désactivez l’outil delete-record.
--runtime.mcp.dml-tools.execute-entity.enabled Activez ou désactivez l’outil d’exécution-entité.
--runtime.cache.enabled Activez ou désactivez le cache global.
--runtime.cache.ttl-seconds Durée de vie du cache global en secondes.
--runtime.host.mode Définir le mode hôte : développement ou production.
--runtime.host.cors.origins Origines CORS autorisées.
--runtime.host.cors.allow-credentials Définissez les informations d’identification autorisées CORS.
--runtime.host.authentication.provider Fournisseur d’authentification.
--runtime.host.authentication.jwt.audience Revendication du public JWT.
--runtime.host.authentication.jwt.issuer Revendication de l’émetteur JWT.
--azure-key-vault.endpoint Point de terminaison de base Azure Key Vault.
--azure-key-vault.retry-policy.mode Réessayez le mode de stratégie.
--azure-key-vault.retry-policy.max-count Nombre maximal de tentatives.
--azure-key-vault.retry-policy.delay-seconds Délai entre les nouvelles tentatives.
--azure-key-vault.retry-policy.max-delay-seconds Délai maximal pour les nouvelles tentatives exponentielles.
--azure-key-vault.retry-policy.network-timeout-seconds Délai d’expiration des appels réseau.
--runtime.telemetry.azure-log-analytics.enabled Activez la télémétrie Azure Log Analytics.
--runtime.telemetry.azure-log-analytics.dab-identifier Distinguer l’origine du journal.
--runtime.telemetry.azure-log-analytics.flush-interval-seconds Cadence de vidage en secondes.
--runtime.telemetry.azure-log-analytics.auth.custom-table-name Nom de table personnalisé.
--runtime.telemetry.azure-log-analytics.auth.dcr-immutable-id ID de règle de collecte de données.
--runtime.telemetry.azure-log-analytics.auth.dce-endpoint Point de terminaison de collecte de données.
--runtime.telemetry.file.enabled Activez la télémétrie du récepteur de fichiers.
--runtime.telemetry.file.path Chemin d’accès au fichier journal.
--runtime.telemetry.file.rolling-interval Intervalle propagé.
--runtime.telemetry.file.retained-file-count-limit Nombre maximal de fichiers conservés.
--runtime.telemetry.file.file-size-limit-bytes Taille maximale par fichier avant le déploiement.
--help Affichez cet écran d’aide.
--version Affichez les informations de version.

-c, --config

Chemin d’accès au fichier de configuration. Par défaut, dab-config.json sauf dab-config.<DAB_ENVIRONMENT>.json s’il existe, où DAB_ENVIRONMENT est une variable d’environnement.

Example

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

--data-source.database-type

Type de base de données.

Valeurs autorisées :

  • MSSQL
  • PostgreSQL
  • CosmosDB_NoSQL
  • MySQL

Example

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

Configuration résultante

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

--data-source.connection-string

Chaîne de connexion pour la source de données.

Example

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

--data-source.options.database

Nom de la base de données pour Cosmos DB pour NoSql.

Example

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

--data-source.options.container

Nom du conteneur pour Cosmos DB pour NoSql.

Example

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

--data-source.options.schema

Chemin du schéma pour Cosmos DB pour NoSql.

Example

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

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

Activez le contexte de session.

Valeurs autorisées :

  • true (valeur par défaut)
  • false

Example

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

Configuration résultante

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

--runtime.graphql.depth-limit

Profondeur maximale autorisée de la requête imbriquée.

Valeurs autorisées :

  • $(0,2147483647]$ (inclus)
  • -1 pour supprimer la limite

Example

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

Configuration résultante

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

--runtime.graphql.enabled

Activez le point de terminaison GraphQL de DAB.

Example

dab configure \
  --runtime.graphql.enabled false

--runtime.graphql.path

Personnalisez le chemin du point de terminaison GraphQL de DAB. Chemin d’accès de préfixe avec /.

Example

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

--runtime.graphql.allow-introspection

Autoriser ou refuser les demandes d’introspection GraphQL.

Example

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

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

Activez ou désactivez les opérations de création de mutations multiples dans le schéma GraphQL généré.

Example

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

--runtime.rest.enabled

Activez le point de terminaison REST de DAB.

Example

dab configure \
  --runtime.rest.enabled false

--runtime.rest.path

Personnalisez le chemin du point de terminaison REST de DAB. Chemin d’accès de préfixe avec /.

Example

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

Configuration résultante

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

--runtime.rest.request-body-strict

Interdire les champs de corps de requête REST superflus.

Example

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

--runtime.mcp.enabled

Activez le point de terminaison MCP de DAB.

Note

Cette option est disponible uniquement dans l’interface CLI de préversion v1.7 (actuellement RC). Installer avec dotnet tool install microsoft.dataapibuilder --prerelease.

Example

dab configure \
  --runtime.mcp.enabled false

Configuration résultante

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

--runtime.mcp.path

Personnalisez le chemin du point de terminaison MCP de DAB. Chemin d’accès de préfixe avec /.

Note

Cette option est disponible uniquement dans l’interface CLI de préversion v1.7 (actuellement RC). Installer avec dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Configuration résultante

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

--runtime.mcp.dml-tools.enabled

Activez le point de terminaison des outils DML MCP de DAB.

Note

Cette option est disponible uniquement dans l’interface CLI de préversion v1.7 (actuellement RC). Installer avec dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Activez l’outil MCP de DAB pour décrire les entités.

Note

Cette option est disponible uniquement dans l’interface CLI de préversion v1.7 (actuellement RC). Installer avec dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Activez l’outil MCP de création d’enregistrement de DAB.

Note

Cette option est disponible uniquement dans l’interface CLI de préversion v1.7 (actuellement RC). Installer avec dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Activez l’outil d’enregistrement de lecture MCP de DAB.

Note

Cette option est disponible uniquement dans l’interface CLI de préversion v1.7 (actuellement RC). Installer avec dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Activez l’outil d’enregistrement de mise à jour MCP de DAB.

Note

Cette option est disponible uniquement dans l’interface CLI de préversion v1.7 (actuellement RC). Installer avec dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Activez l’outil d’enregistrement de suppression MCP de DAB.

Note

Cette option est disponible uniquement dans l’interface CLI de préversion v1.7 (actuellement RC). Installer avec dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Activez l’outil d’entité d’exécution MCP de DAB.

Note

Cette option est disponible uniquement dans l’interface CLI de préversion v1.7 (actuellement RC). Installer avec dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

--runtime.cache.enabled

Activez le cache de DAB globalement. Vous devez également activer la mise en cache pour chaque entité.

Example

dab configure \
  --runtime.cache.enabled true

Configuration résultante

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

--runtime.cache.ttl-seconds

Personnalisez l’heure par défaut globale du cache DAB en secondes.

Example

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

Configuration résultante

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

--runtime.host.mode

Définissez le mode d’exécution de l’hôte de DAB.

Valeurs autorisées :

  • Development
  • Production

Example

dab configure \
  --runtime.host.mode Development

Configuration résultante

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

--runtime.host.cors.origins

Remplacer les origines autorisées dans CORS. Fournissez des valeurs sous la forme d’une liste séparée par des espaces.

Example

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

Configuration résultante

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

--runtime.host.cors.allow-credentials

Définissez la valeur de l’en-tête Access-Control-Allow-Credentials .

Example

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

--runtime.host.authentication.provider

Configurez le nom du fournisseur d’authentification.

Example

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

--runtime.host.authentication.jwt.audience

Configurez le ou les destinataires prévus du jeton JWT.

Example

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

--runtime.host.authentication.jwt.issuer

Configurez l’entité qui a émis le jeton JWT.

Example

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

Configuration résultante

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

--azure-key-vault.endpoint

Configurez l’URL du point de terminaison Azure Key Vault.

Example

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

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

Configurez le mode de stratégie de nouvelle tentative.

Valeurs autorisées :

  • fixed
  • exponential

Example

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

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

Configurez le nombre maximal de nouvelles tentatives.

Example

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

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

Configurez le délai initial entre les nouvelles tentatives en secondes.

Example

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

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

Configurez le délai maximal entre les nouvelles tentatives en secondes (pour le mode exponentiel).

Example

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

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

Configurez le délai d’expiration du réseau pour les requêtes en secondes.

Example

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

Configuration résultante

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

Activez ou désactivez Azure Log Analytics.

Example

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

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

Configurez une chaîne d’identificateur DAB utilisée dans Azure Log Analytics.

Example

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

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

Configurez l’intervalle de vidage en secondes pour Azure Log Analytics.

Example

dab configure \
  --runtime.telemetry.azure-log-analytics.flush-interval-seconds 10

--runtime.telemetry.azure-log-analytics.auth.custom-table-name

Configurez le nom de table personnalisé pour 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

Configurez l’ID immuable DCR pour 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

Configurez le point de terminaison DCE pour Azure Log Analytics.

Example

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

Configuration résultante

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

Activez ou désactivez la journalisation du récepteur de fichiers.

Example

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

--runtime.telemetry.file.path

Configurez le chemin d’accès pour la journalisation du récepteur de fichiers.

Example

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

--runtime.telemetry.file.rolling-interval

Configurez l’intervalle de déploiement pour la journalisation du récepteur de fichiers.

Valeurs autorisées :

  • Minute
  • Hour
  • Day
  • Month
  • Year
  • Infinite

Example

dab configure \
  --runtime.telemetry.file.rolling-interval Month

--runtime.telemetry.file.retained-file-count-limit

Configurez le nombre maximal de fichiers conservés.

Example

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

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

Configurez la limite maximale de taille de fichier en octets.

Example

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

Configuration résultante

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

Affichez cet écran d’aide.

Example

dab configure \
  --help

--version

Affichez les informations de version.

Example

dab configure \
  --version
  • Last updated on