Condividi tramite

configure comando

Configurare le proprietà di runtime e origine dati che non sono specifiche dell'entità in un file di configurazione di Generatore API dati esistente. Le opzioni non specificate lasciano invariati i valori esistenti. Se un'opzione specificata non è valida, l'intero aggiornamento ha esito negativo (tutto o niente).

Acronimi usati in questo riferimento:

MCP è l'acronimo di Model Context Protocol. DML è l'acronimo di Data Manipulation Language. TTL è l'acronimo di time to live. JWT è l'acronimo di JSON Web Token(Token Web JSON). RC è l'acronimo di release candidate. DCR è l'acronimo di Data Collection Rule. DCE è l'acronimo di endpoint di raccolta dati.

Sintassi

dab configure [options]

Annotazioni

Questo comando non modifica la entities sezione. Usare dab update per le modifiche delle entità.

Annotazioni

Le impostazioni di OpenTelemetry e Application Insights sono configurate con dab add-telemetry, non dab configure. Vedere concept/monitor/open-telemetry.md e concept/monitor/application-insights.md.

Sguardo rapido

Opzione Riassunto
-c, --config Percorso del file di configurazione (impostazione predefinita dab-config.json).
--data-source.database-type Impostare il tipo di database.
--data-source.connection-string Impostare la stringa di connessione del database.
--data-source.options.database Nome del database per Cosmos DB per NoSql.
--data-source.options.container Nome del contenitore per Cosmos DB per NoSql.
--data-source.options.schema Percorso dello schema per Cosmos DB per NoSql.
--data-source.options.set-session-context Abilitare il contesto della sessione.
--runtime.graphql.depth-limit Limitare la profondità massima della query.
--runtime.graphql.enabled Abilitare o disabilitare l'endpoint GraphQL.
--runtime.graphql.path Personalizzare il percorso dell'endpoint GraphQL.
--runtime.graphql.allow-introspection Consentire o negare l'introspezione graphQL.
--runtime.graphql.multiple-mutations.create.enabled Abilitare le mutazioni a più creazione.
--runtime.rest.enabled Abilitare o disabilitare l'endpoint REST.
--runtime.rest.path Personalizzare il percorso dell'endpoint REST.
--runtime.rest.request-body-strict Applicare la rigorosa convalida del corpo della richiesta REST.
--runtime.mcp.enabled Abilitare o disabilitare l'endpoint MCP.
--runtime.mcp.path Personalizzare il percorso dell'endpoint MCP.
--runtime.mcp.dml-tools.enabled Abilitare o disabilitare tutti gli strumenti DML MCP.
--runtime.mcp.dml-tools.describe-entities.enabled Abilitare o disabilitare lo strumento describe-entities.
--runtime.mcp.dml-tools.create-record.enabled Abilitare o disabilitare lo strumento create-record.
--runtime.mcp.dml-tools.read-records.enabled Abilitare o disabilitare lo strumento read-records.
--runtime.mcp.dml-tools.update-record.enabled Abilitare o disabilitare lo strumento update-record.
--runtime.mcp.dml-tools.delete-record.enabled Abilitare o disabilitare lo strumento delete-record.
--runtime.mcp.dml-tools.execute-entity.enabled Abilitare o disabilitare lo strumento execute-entity.
--runtime.cache.enabled Abilitare o disabilitare la cache globale.
--runtime.cache.ttl-seconds Durata (TTL) della cache globale in secondi.
--runtime.host.mode Impostare la modalità host: sviluppo o produzione.
--runtime.host.cors.origins Origini CORS consentite.
--runtime.host.cors.allow-credentials Impostare CORS allow-credentials (Credenziali consentite CORS).
--runtime.host.authentication.provider Provider di autenticazione.
--runtime.host.authentication.jwt.audience Attestazione del gruppo di destinatari JWT.
--runtime.host.authentication.jwt.issuer Attestazione dell'autorità di certificazione JWT.
--azure-key-vault.endpoint Endpoint di base di Azure Key Vault.
--azure-key-vault.retry-policy.mode Modalità dei criteri di ripetizione dei tentativi.
--azure-key-vault.retry-policy.max-count Numero massimo di tentativi.
--azure-key-vault.retry-policy.delay-seconds Ritardo tra i tentativi.
--azure-key-vault.retry-policy.max-delay-seconds Ritardo massimo per i tentativi esponenziali.
--azure-key-vault.retry-policy.network-timeout-seconds Timeout per le chiamate di rete.
--runtime.telemetry.azure-log-analytics.enabled Abilitare i dati di telemetria di Azure Log Analytics.
--runtime.telemetry.azure-log-analytics.dab-identifier Distinguere l'origine del log.
--runtime.telemetry.azure-log-analytics.flush-interval-seconds Frequenza di scaricamento in secondi.
--runtime.telemetry.azure-log-analytics.auth.custom-table-name Nome tabella personalizzato.
--runtime.telemetry.azure-log-analytics.auth.dcr-immutable-id ID regola raccolta dati.
--runtime.telemetry.azure-log-analytics.auth.dce-endpoint Endpoint raccolta dati.
--runtime.telemetry.file.enabled Abilitare la telemetria del sink di file.
--runtime.telemetry.file.path Percorso del file di log.
--runtime.telemetry.file.rolling-interval Intervallo di rotazione.
--runtime.telemetry.file.retained-file-count-limit Numero massimo di file conservati.
--runtime.telemetry.file.file-size-limit-bytes Dimensioni massime per file prima del rollback.
--help Visualizza questa schermata della Guida.
--version Visualizzare le informazioni sulla versione.

-c, --config

Percorso del file di configurazione. Per impostazione predefinita, a dab-config.json meno che non dab-config.<DAB_ENVIRONMENT>.json esista, dove DAB_ENVIRONMENT è una variabile di ambiente.

Example

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

--data-source.database-type

Tipo di database.

Valori consentiti:

  • MSSQL
  • PostgreSQL
  • CosmosDB_NoSQL
  • MySQL

Example

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

Configurazione risultante

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

--data-source.connection-string

Stringa di connessione per l'origine dati.

Example

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

--data-source.options.database

Nome del database per Cosmos DB per NoSql.

Example

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

--data-source.options.container

Nome del contenitore per Cosmos DB per NoSql.

Example

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

--data-source.options.schema

Percorso dello schema per Cosmos DB per NoSql.

Example

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

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

Abilitare il contesto della sessione.

Valori consentiti:

  • true (impostazione predefinita)
  • false

Example

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

Configurazione risultante

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

--runtime.graphql.depth-limit

Profondità massima consentita della query nidificata.

Valori consentiti:

  • $(0,2147483647]$ (incluso)
  • -1 per rimuovere il limite

Example

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

Configurazione risultante

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

--runtime.graphql.enabled

Abilitare l'endpoint GraphQL di DAB.

Example

dab configure \
  --runtime.graphql.enabled false

--runtime.graphql.path

Personalizzare il percorso dell'endpoint GraphQL di DAB. Prefisso percorso con /.

Example

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

--runtime.graphql.allow-introspection

Consentire o negare le richieste di introspezione graphQL.

Example

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

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

Abilitare o disabilitare le operazioni di creazione di più mutazioni nello schema GraphQL generato.

Example

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

--runtime.rest.enabled

Abilitare l'endpoint REST di DAB.

Example

dab configure \
  --runtime.rest.enabled false

--runtime.rest.path

Personalizzare il percorso dell'endpoint REST di DAB. Prefisso percorso con /.

Example

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

Configurazione risultante

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

--runtime.rest.request-body-strict

Non consentire campi del corpo della richiesta REST estranei.

Example

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

--runtime.mcp.enabled

Abilitare l'endpoint MCP di DAB.

Annotazioni

Questa opzione è disponibile solo nell'interfaccia della riga di comando non definitiva v1.7 (attualmente RC). Eseguire l'installazione con dotnet tool install microsoft.dataapibuilder --prerelease.

Example

dab configure \
  --runtime.mcp.enabled false

Configurazione risultante

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

--runtime.mcp.path

Personalizzare il percorso dell'endpoint MCP di DAB. Prefisso percorso con /.

Annotazioni

Questa opzione è disponibile solo nell'interfaccia della riga di comando non definitiva v1.7 (attualmente RC). Eseguire l'installazione con dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Configurazione risultante

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

--runtime.mcp.dml-tools.enabled

Abilitare l'endpoint degli strumenti MCP DML di DAB.

Annotazioni

Questa opzione è disponibile solo nell'interfaccia della riga di comando non definitiva v1.7 (attualmente RC). Eseguire l'installazione con dotnet tool install microsoft.dataapibuilder --prerelease.

Per altre informazioni sugli strumenti DML MCP, vedere Strumenti del linguaggio di manipolazione dei dati di SQL MCP Server.

Example

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

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

Abilitare lo strumento MCP di DAB per descrivere le entità.

Annotazioni

Questa opzione è disponibile solo nell'interfaccia della riga di comando non definitiva v1.7 (attualmente RC). Eseguire l'installazione 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

Abilitare lo strumento MCP per la creazione di record di DAB.

Annotazioni

Questa opzione è disponibile solo nell'interfaccia della riga di comando non definitiva v1.7 (attualmente RC). Eseguire l'installazione 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

Abilitare lo strumento di lettura record MCP di DAB.

Annotazioni

Questa opzione è disponibile solo nell'interfaccia della riga di comando non definitiva v1.7 (attualmente RC). Eseguire l'installazione 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

Abilitare lo strumento del record di aggiornamento MCP di DAB.

Annotazioni

Questa opzione è disponibile solo nell'interfaccia della riga di comando non definitiva v1.7 (attualmente RC). Eseguire l'installazione 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

Abilitare lo strumento di eliminazione MCP di DAB.

Annotazioni

Questa opzione è disponibile solo nell'interfaccia della riga di comando non definitiva v1.7 (attualmente RC). Eseguire l'installazione 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

Abilitare lo strumento di esecuzione MCP di DAB.

Annotazioni

Questa opzione è disponibile solo nell'interfaccia della riga di comando non definitiva v1.7 (attualmente RC). Eseguire l'installazione con dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

--runtime.cache.enabled

Abilitare la cache di DAB a livello globale. È anche necessario abilitare la memorizzazione nella cache per ogni entità.

Example

dab configure \
  --runtime.cache.enabled true

Configurazione risultante

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

--runtime.cache.ttl-seconds

Personalizzare il tempo predefinito predefinito globale della cache DAB in secondi.

Example

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

Configurazione risultante

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

--runtime.host.mode

Impostare la modalità di esecuzione host di DAB.

Valori consentiti:

  • Development
  • Production

Example

dab configure \
  --runtime.host.mode Development

Configurazione risultante

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

--runtime.host.cors.origins

Sovrascrivere le origini consentite in CORS. Specificare i valori come elenco delimitato da spazi.

Example

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

Configurazione risultante

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

--runtime.host.cors.allow-credentials

Impostare il valore per l'intestazione Access-Control-Allow-Credentials .

Example

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

--runtime.host.authentication.provider

Configurare il nome del provider di autenticazione.

Example

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

--runtime.host.authentication.jwt.audience

Configurare uno o più destinatari previsti del token JWT.

Example

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

--runtime.host.authentication.jwt.issuer

Configurare l'entità che ha emesso il token JWT.

Example

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

Configurazione risultante

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

--azure-key-vault.endpoint

Configurare l'URL dell'endpoint di Azure Key Vault.

Example

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

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

Configurare la modalità dei criteri di ripetizione dei tentativi.

Valori consentiti:

  • fixed
  • exponential

Example

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

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

Configurare il numero massimo di tentativi.

Example

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

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

Configurare il ritardo iniziale tra tentativi in secondi.

Example

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

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

Configurare il ritardo massimo tra i tentativi in secondi (per la modalità esponenziale).

Example

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

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

Configurare il timeout di rete per le richieste in secondi.

Example

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

Configurazione risultante

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

Abilitare o disabilitare Azure Log Analytics.

Example

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

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

Configurare una stringa di identificatore DAB usata in Azure Log Analytics.

Example

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

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

Configurare l'intervallo di scaricamento in secondi per Azure Log Analytics.

Example

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

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

Configurare il nome di tabella personalizzato per 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

Configurare l'ID non modificabile DCR per 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

Configurare l'endpoint DCE per Azure Log Analytics.

Example

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

Configurazione risultante

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

Abilitare o disabilitare la registrazione del sink di file.

Example

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

--runtime.telemetry.file.path

Configurare il percorso per la registrazione del sink di file.

Example

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

--runtime.telemetry.file.rolling-interval

Configurare l'intervallo di sequenza per la registrazione del sink di file.

Valori consentiti:

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

Example

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

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

Configurare il numero massimo di file conservati.

Example

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

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

Configurare il limite massimo di dimensioni dei file in byte.

Example

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

Configurazione risultante

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

Visualizza questa schermata della Guida.

Example

dab configure \
  --help

--version

Visualizzare le informazioni sulla versione.

Example

dab configure \
  --version
  • Last updated on