Freigeben über

configure-Befehl

Konfigurieren sie nicht entitätsbezogene Laufzeit- und Datenquelleneigenschaften in einer vorhandenen Konfigurationsdatei des Daten-API-Generators. Nicht angegebene Optionen lassen vorhandene Werte unverändert. Wenn eine bereitgestellte Option ungültig ist, schlägt das gesamte Update fehl (alles oder nichts).

Syntax

dab configure [options]

Hinweis

Dieser Befehl ändert den entities Abschnitt nicht. Wird für Entitätsänderungen verwendet dab update .

Schnellblick

Option Zusammenfassung
-c, --config Pfad zur Konfigurationsdatei (Standard dab-config.json).
--data-source.database-type Legen Sie den Datenbanktyp fest.
--data-source.connection-string Legen Sie die Datenbankverbindungszeichenfolge fest.
--data-source.options.database Datenbankname für Cosmos DB für NoSql.
--data-source.options.container Containername für Cosmos DB für NoSql.
--data-source.options.schema Schemapfad für Cosmos DB für NoSql.
--data-source.options.set-session-context Aktivieren sie den Sitzungskontext.
--runtime.graphql.depth-limit Maximale Abfragetiefe beschränken.
--runtime.graphql.enabled Aktivieren oder Deaktivieren des GraphQL-Endpunkts.
--runtime.graphql.path Passen Sie den GraphQL-Endpunktpfad an.
--runtime.graphql.allow-introspection Zulassen oder Verweigern der GraphQL-Introspektion.
--runtime.graphql.multiple-mutations.create.enabled Aktivieren Von Mutationen mit mehrfacher Erstellung.
--runtime.rest.enabled Aktivieren oder Deaktivieren des REST-Endpunkts.
--runtime.rest.path Passen Sie den REST-Endpunktpfad an.
--runtime.rest.request-body-strict Erzwingen der strengen ÜBERPRÜFUNG des REST-Anforderungstexts.
--runtime.mcp.enabled Aktivieren oder Deaktivieren des MCP-Endpunkts.
--runtime.mcp.path Passen Sie den MCP-Endpunktpfad an.
--runtime.mcp.dml-tools.enabled Aktivieren oder deaktivieren Sie alle MCP-DML-Tools.
--runtime.mcp.dml-tools.describe-entities.enabled Aktivieren oder deaktivieren Sie das Tool zur Beschreibung von Entitäten.
--runtime.mcp.dml-tools.create-record.enabled Aktivieren oder deaktivieren Sie das Create-Record-Tool.
--runtime.mcp.dml-tools.read-records.enabled Aktivieren oder deaktivieren Sie das Tool zum Lesen von Datensätzen.
--runtime.mcp.dml-tools.update-record.enabled Aktivieren oder deaktivieren Sie das Update-Datensatztool.
--runtime.mcp.dml-tools.delete-record.enabled Aktivieren oder deaktivieren Sie das Tool zum Löschen von Datensätzen.
--runtime.mcp.dml-tools.execute-entity.enabled Aktivieren oder Deaktivieren des Execute-Entity-Tools.
--runtime.cache.enabled Aktivieren oder Deaktivieren des globalen Caches.
--runtime.cache.ttl-seconds Globaler Cache-TTL in Sekunden.
--runtime.host.mode Hostmodus festlegen: Entwicklung oder Produktion.
--runtime.host.cors.origins Zulässige CORS-Ursprünge.
--runtime.host.cors.allow-credentials Legen Sie CORS-Zulassungsanmeldeinformationen fest.
--runtime.host.authentication.provider Authentifizierungsanbieter.
--runtime.host.authentication.jwt.audience JWT-Zielgruppenanspruch.
--runtime.host.authentication.jwt.issuer JWT-Ausstelleranspruch.
--azure-key-vault.endpoint Azure Key Vault-Basisendpunkt.
--azure-key-vault.retry-policy.mode Wiederholen Sie den Richtlinienmodus.
--azure-key-vault.retry-policy.max-count Max. Wiederholungsversuche.
--azure-key-vault.retry-policy.delay-seconds Verzögerung zwischen Wiederholungen.
--azure-key-vault.retry-policy.max-delay-seconds Maximale Verzögerung für exponentielle Wiederholungen.
--azure-key-vault.retry-policy.network-timeout-seconds Timeout für Netzwerkanrufe.
--runtime.telemetry.azure-log-analytics.enabled Aktivieren Sie die Azure Log Analytics-Telemetrie.
--runtime.telemetry.azure-log-analytics.dab-identifier Unterscheiden des Protokollursprungs.
--runtime.telemetry.azure-log-analytics.flush-interval-seconds Spülungsrhythmen in Sekunden.
--runtime.telemetry.azure-log-analytics.auth.custom-table-name Benutzerdefinierter Tabellenname.
--runtime.telemetry.azure-log-analytics.auth.dcr-immutable-id Datensammlungsregel-ID.
--runtime.telemetry.azure-log-analytics.auth.dce-endpoint Datensammlungsendpunkt.
--runtime.telemetry.file.enabled Aktivieren Sie die Telemetrie der Dateisenke.
--runtime.telemetry.file.path Pfad zur Protokolldatei.
--runtime.telemetry.file.rolling-interval Rollintervall.
--runtime.telemetry.file.retained-file-count-limit Maximale Anzahl der aufbewahrten Dateien.
--runtime.telemetry.file.file-size-limit-bytes Maximale Größe pro Datei vor dem Rollen.
--help Zeigen Sie diesen Hilfebildschirm an.
--version Versionsinformationen anzeigen.

-c, --config

Pfad zur Konfigurationsdatei. Der Standardwert ist, dab-config.json sofern nicht dab-config.<DAB_ENVIRONMENT>.json vorhanden, wobei DAB_ENVIRONMENT es sich um eine Umgebungsvariable handelt.

Example

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

--data-source.database-type

Datenbanktyp.

Zulässige Werte:

  • MSSQL
  • PostgreSQL
  • CosmosDB_NoSQL
  • MySQL

Example

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

Resultierende Konfiguration

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

--data-source.connection-string

Verbindungszeichenfolge für die Datenquelle.

Example

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

--data-source.options.database

Datenbankname für Cosmos DB für NoSql.

Example

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

--data-source.options.container

Containername für Cosmos DB für NoSql.

Example

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

--data-source.options.schema

Schemapfad für Cosmos DB für NoSql.

Example

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

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

Aktivieren sie den Sitzungskontext.

Zulässige Werte:

  • true (Standardwert)
  • false

Example

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

Resultierende Konfiguration

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

--runtime.graphql.depth-limit

Maximale zulässige Tiefe der geschachtelten Abfrage.

Zulässige Werte:

  • $(0,2147483647]$ (einschließlich)
  • -1 zum Entfernen des Grenzwerts

Example

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

Resultierende Konfiguration

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

--runtime.graphql.enabled

Aktivieren Sie den GraphQL-Endpunkt von DAB.

Example

dab configure \
  --runtime.graphql.enabled false

--runtime.graphql.path

Passen Sie den GraphQL-Endpunktpfad von DAB an. Präfixpfad mit /.

Example

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

--runtime.graphql.allow-introspection

Zulassen oder Verweigern von GraphQL-Introspection-Anforderungen.

Example

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

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

Aktivieren oder Deaktivieren von Erstellungsvorgängen mit mehreren Mutationen im generierten GraphQL-Schema.

Example

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

--runtime.rest.enabled

Aktivieren Sie den REST-Endpunkt von DAB.

Example

dab configure \
  --runtime.rest.enabled false

--runtime.rest.path

Passen Sie den REST-Endpunktpfad von DAB an. Präfixpfad mit /.

Example

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

Resultierende Konfiguration

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

--runtime.rest.request-body-strict

Verbieten Sie zusätzliche REST-Anforderungstextfelder.

Example

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

--runtime.mcp.enabled

Aktivieren Sie den MCP-Endpunkt von DAB.

Hinweis

Diese Option ist nur in der v1.7 Prerelease CLI (derzeit RC) verfügbar. Installieren mit dotnet tool install microsoft.dataapibuilder --prerelease.

Example

dab configure \
  --runtime.mcp.enabled false

Resultierende Konfiguration

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

--runtime.mcp.path

Passen Sie den MCP-Endpunktpfad von DAB an. Präfixpfad mit /.

Hinweis

Diese Option ist nur in der v1.7 Prerelease CLI (derzeit RC) verfügbar. Installieren mit dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Resultierende Konfiguration

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

--runtime.mcp.dml-tools.enabled

Aktivieren Sie den MCP-DML-Tools-Endpunkt von DAB.

Hinweis

Diese Option ist nur in der v1.7 Prerelease CLI (derzeit RC) verfügbar. Installieren mit dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Aktivieren Sie das MCP von DAB zur Beschreibung von Entitäten.

Hinweis

Diese Option ist nur in der v1.7 Prerelease CLI (derzeit RC) verfügbar. Installieren mit dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Aktivieren Sie das MCP-Erstellungstool von DAB.

Hinweis

Diese Option ist nur in der v1.7 Prerelease CLI (derzeit RC) verfügbar. Installieren mit dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Aktivieren Sie das MCP-Lesedatensatztool von DAB.

Hinweis

Diese Option ist nur in der v1.7 Prerelease CLI (derzeit RC) verfügbar. Installieren mit dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Aktivieren Sie das MCP-Updatedatensatztool von DAB.

Hinweis

Diese Option ist nur in der v1.7 Prerelease CLI (derzeit RC) verfügbar. Installieren mit dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Aktivieren Sie das MCP-Löschdatensatztool von DAB.

Hinweis

Diese Option ist nur in der v1.7 Prerelease CLI (derzeit RC) verfügbar. Installieren mit dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Aktivieren Sie das MCP-Tool zum Ausführen der Entität von DAB.

Hinweis

Diese Option ist nur in der v1.7 Prerelease CLI (derzeit RC) verfügbar. Installieren mit dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

--runtime.cache.enabled

Aktivieren Sie den CACHE von DAB global. Sie müssen auch die Zwischenspeicherung für jede Entität aktivieren.

Example

dab configure \
  --runtime.cache.enabled true

Resultierende Konfiguration

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

--runtime.cache.ttl-seconds

Passen Sie die globale Standardzeit des DAB-Caches in Sekunden an.

Example

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

Resultierende Konfiguration

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

--runtime.host.mode

Legen Sie den Hostausführungsmodus von DAB fest.

Zulässige Werte:

  • Development
  • Production

Example

dab configure \
  --runtime.host.mode Development

Resultierende Konfiguration

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

--runtime.host.cors.origins

Überschreiben zulässiger Ursprünge in CORS. Stellen Sie Werte als durch Leerzeichen getrennte Liste bereit.

Example

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

Resultierende Konfiguration

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

--runtime.host.cors.allow-credentials

Legen Sie den Wert für die Access-Control-Allow-Credentials Kopfzeile fest.

Example

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

--runtime.host.authentication.provider

Konfigurieren Sie den Namen des Authentifizierungsanbieters.

Example

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

--runtime.host.authentication.jwt.audience

Konfigurieren Sie die vorgesehenen Empfänger des JWT-Tokens.

Example

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

--runtime.host.authentication.jwt.issuer

Konfigurieren Sie die Entität, die das JWT-Token ausgestellt hat.

Example

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

Resultierende Konfiguration

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

--azure-key-vault.endpoint

Konfigurieren Sie die Azure Key Vault-Endpunkt-URL.

Example

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

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

Konfigurieren Sie den Wiederholungsrichtlinienmodus.

Zulässige Werte:

  • fixed
  • exponential

Example

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

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

Konfigurieren Sie die maximale Anzahl von Wiederholungsversuchen.

Example

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

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

Konfigurieren Sie die anfängliche Verzögerung zwischen Wiederholungen in Sekunden.

Example

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

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

Konfigurieren Sie die maximale Verzögerung zwischen Wiederholungen in Sekunden (für den exponentiellen Modus).

Example

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

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

Konfigurieren Sie das Netzwerktimeout für Anforderungen in Sekunden.

Example

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

Resultierende Konfiguration

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

Aktivieren oder deaktivieren Sie Azure Log Analytics.

Example

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

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

Konfigurieren Sie eine IN Azure Log Analytics verwendete DAB-Bezeichnerzeichenfolge.

Example

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

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

Konfigurieren Sie das Leerintervall in Sekunden für Azure Log Analytics.

Example

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

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

Konfigurieren des benutzerdefinierten Tabellennamens für 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

Konfigurieren Sie DCR unveränderliche ID für 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

Konfigurieren sie den DCE-Endpunkt für Azure Log Analytics.

Example

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

Resultierende Konfiguration

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

Aktivieren oder deaktivieren Sie die Dateisenkenprotokollierung.

Example

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

--runtime.telemetry.file.path

Konfigurieren Sie den Pfad für die Dateisenkenprotokollierung.

Example

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

--runtime.telemetry.file.rolling-interval

Konfigurieren Sie das Rollintervall für die Dateisenkenprotokollierung.

Zulässige Werte:

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

Example

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

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

Maximale Anzahl aufbewahrter Dateien konfigurieren.

Example

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

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

Maximale Dateigrößenbeschränkung in Bytes konfigurieren.

Example

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

Resultierende Konfiguration

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

Zeigen Sie diesen Hilfebildschirm an.

Example

dab configure \
  --help

--version

Versionsinformationen anzeigen.

Example

dab configure \
  --version
  • Last updated on