Delen via

configure opdracht

Configureer runtime- en gegevensbroneigenschappen die niet entiteitsspecifiek zijn in een bestaand configuratiebestand van de Data API Builder. Niet-opgegeven opties laten bestaande waarden ongewijzigd. Als een opgegeven optie ongeldig is, mislukt de hele update (alles of niets).

Acroniemen die in deze verwijzing worden gebruikt:

MCP staat voor Model Context Protocol. DML staat voor de taal voor gegevensmanipulatie. TTL staat voor time to live. JWT staat voor JSON Web Token. RC staat voor release kandidaat. DCR staat voor regel voor gegevensverzameling. DCE staat voor eindpunt voor gegevensverzameling.

Syntaxis

dab configure [options]

Opmerking

Met deze opdracht wordt de entities sectie niet gewijzigd. Gebruiken dab update voor entiteitswijzigingen.

Opmerking

OpenTelemetry- en Application Insights-instellingen zijn geconfigureerd met dab add-telemetry, niet dab configure. Zie concept/monitor/open-telemetry.md en concept/monitor/application-insights.md.

Snelle blik

Optie Samenvatting
-c, --config Pad naar het configuratiebestand (standaard dab-config.json).
--data-source.database-type Stel het databasetype in.
--data-source.connection-string Stel de verbindingsreeks voor de database in.
--data-source.options.database Databasenaam voor Cosmos DB for NoSql.
--data-source.options.container Containernaam voor Cosmos DB voor NoSql.
--data-source.options.schema Schemapad voor Cosmos DB voor NoSql.
--data-source.options.set-session-context Schakel sessiecontext in.
--runtime.graphql.depth-limit Beperk de maximale querydiepte.
--runtime.graphql.enabled GraphQL-eindpunt in- of uitschakelen.
--runtime.graphql.path Pas het GraphQL-eindpuntpad aan.
--runtime.graphql.allow-introspection GraphQL-introspectie toestaan of weigeren.
--runtime.graphql.multiple-mutations.create.enabled Meervoudige mutaties mogelijk maken.
--runtime.rest.enabled REST-eindpunt in- of uitschakelen.
--runtime.rest.path Pas het REST-eindpuntpad aan.
--runtime.rest.request-body-strict Dwing strikte REST-aanvraagbodyvalidatie af.
--runtime.mcp.enabled MCP-eindpunt in- of uitschakelen.
--runtime.mcp.path Pas het MCP-eindpuntpad aan.
--runtime.mcp.dml-tools.enabled Schakel alle MCP DML-hulpprogramma's in of uit.
--runtime.mcp.dml-tools.describe-entities.enabled Schakel het hulpprogramma describe-entities in of uit.
--runtime.mcp.dml-tools.create-record.enabled Schakel het hulpprogramma create-record in of uit.
--runtime.mcp.dml-tools.read-records.enabled Schakel het hulpprogramma leesrecords in of uit.
--runtime.mcp.dml-tools.update-record.enabled Schakel het hulpprogramma updaterecord in of uit.
--runtime.mcp.dml-tools.delete-record.enabled Schakel het hulpprogramma delete-record in of uit.
--runtime.mcp.dml-tools.execute-entity.enabled Schakel het hulpprogramma execute-entity in of uit.
--runtime.cache.enabled Globale cache in- of uitschakelen.
--runtime.cache.ttl-seconds TTL voor globale cache in seconden.
--runtime.host.mode Hostmodus instellen: Ontwikkeling of Productie.
--runtime.host.cors.origins Toegestane CORS-oorsprongen.
--runtime.host.cors.allow-credentials Stel CORS-referenties voor toestaan in.
--runtime.host.authentication.provider Verificatieprovider.
--runtime.host.authentication.jwt.audience JWT-doelgroepclaim.
--runtime.host.authentication.jwt.issuer Claim van JWT-verlener.
--azure-key-vault.endpoint Azure Key Vault-basiseindpunt.
--azure-key-vault.retry-policy.mode Beleidsmodus voor opnieuw proberen.
--azure-key-vault.retry-policy.max-count Maximaal aantal nieuwe pogingen.
--azure-key-vault.retry-policy.delay-seconds Vertraging tussen nieuwe pogingen.
--azure-key-vault.retry-policy.max-delay-seconds Maximale vertraging voor exponentiële nieuwe pogingen.
--azure-key-vault.retry-policy.network-timeout-seconds Time-out voor netwerkoproepen.
--runtime.telemetry.azure-log-analytics.enabled Schakel Azure Log Analytics-telemetrie in.
--runtime.telemetry.azure-log-analytics.dab-identifier Oorsprong van logboek onderscheiden.
--runtime.telemetry.azure-log-analytics.flush-interval-seconds Spoelen cadans in seconden.
--runtime.telemetry.azure-log-analytics.auth.custom-table-name Aangepaste tabelnaam.
--runtime.telemetry.azure-log-analytics.auth.dcr-immutable-id Regel-id voor gegevensverzameling.
--runtime.telemetry.azure-log-analytics.auth.dce-endpoint Eindpunt voor gegevensverzameling.
--runtime.telemetry.file.enabled Schakel telemetrie van bestandssink in.
--runtime.telemetry.file.path Pad naar logboekbestand.
--runtime.telemetry.file.rolling-interval Doorlopend interval.
--runtime.telemetry.file.retained-file-count-limit Maximum aantal bestanden dat wordt bewaard.
--runtime.telemetry.file.file-size-limit-bytes Maximale grootte per bestand voordat het wordt gerold.
--help Dit Help-scherm weergeven.
--version Versie-informatie weergeven.

-c, --config

Pad naar het configuratiebestand. Standaard ingesteld op dab-config.json tenzij aanwezig, waarbij dab-config.<DAB_ENVIRONMENT>.json een omgevingsvariabele DAB_ENVIRONMENT is.

Example

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

--data-source.database-type

Databasetype.

Toegestane waarden:

  • MSSQL
  • PostgreSQL
  • CosmosDB_NoSQL
  • MySQL

Example

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

Resulterende configuratie

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

--data-source.connection-string

Verbindingsreeks voor de gegevensbron.

Example

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

--data-source.options.database

Databasenaam voor Cosmos DB for NoSql.

Example

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

--data-source.options.container

Containernaam voor Cosmos DB voor NoSql.

Example

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

--data-source.options.schema

Schemapad voor Cosmos DB voor NoSql.

Example

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

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

Schakel sessiecontext in.

Toegestane waarden:

  • true (standaard)
  • false

Example

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

Resulterende configuratie

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

--runtime.graphql.depth-limit

Maximale toegestane diepte van de geneste query.

Toegestane waarden:

  • $(0,2147483647]$ (inclusief)
  • -1 om limiet te verwijderen

Example

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

Resulterende configuratie

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

--runtime.graphql.enabled

Schakel het GraphQL-eindpunt van DAB in.

Example

dab configure \
  --runtime.graphql.enabled false

--runtime.graphql.path

Pas het GraphQL-eindpuntpad van DAB aan. Voorvoegselpad met /.

Example

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

--runtime.graphql.allow-introspection

GraphQL-introspectieaanvragen toestaan of weigeren.

Example

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

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

Maakbewerkingen met meerdere mutaties in- of uitschakelen in het gegenereerde GraphQL-schema.

Example

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

--runtime.rest.enabled

Schakel het REST-eindpunt van DAB in.

Example

dab configure \
  --runtime.rest.enabled false

--runtime.rest.path

Pas het REST-eindpuntpad van DAB aan. Voorvoegselpad met /.

Example

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

Resulterende configuratie

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

--runtime.rest.request-body-strict

Verbied overbodige REST-aanvraagtekstvelden.

Example

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

--runtime.mcp.enabled

Schakel het MCP-eindpunt van DAB in.

Opmerking

Deze optie is alleen beschikbaar in de v1.7 prerelease CLI (momenteel RC). Installeren met dotnet tool install microsoft.dataapibuilder --prerelease.

Example

dab configure \
  --runtime.mcp.enabled false

Resulterende configuratie

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

--runtime.mcp.path

Het MCP-eindpuntpad van DAB aanpassen. Voorvoegselpad met /.

Opmerking

Deze optie is alleen beschikbaar in de v1.7 prerelease CLI (momenteel RC). Installeren met dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Resulterende configuratie

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

--runtime.mcp.dml-tools.enabled

Schakel het MCP DML-hulpprogramma-eindpunt van DAB in.

Opmerking

Deze optie is alleen beschikbaar in de v1.7 prerelease CLI (momenteel RC). Installeren met dotnet tool install microsoft.dataapibuilder --prerelease.

Zie SQL MCP Server-hulpprogramma's voor het bewerken van gegevens voor meer informatie over MCP DML-hulpprogramma's.

Example

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

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

Schakel het MCP-hulpprogramma voor het beschrijven van entiteiten van DAB in.

Opmerking

Deze optie is alleen beschikbaar in de v1.7 prerelease CLI (momenteel RC). Installeren met dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Schakel het MCP-hulpprogramma voor het maken van records van DAB in.

Opmerking

Deze optie is alleen beschikbaar in de v1.7 prerelease CLI (momenteel RC). Installeren met dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Schakel het MCP-hulpprogramma voor leesrecords van DAB in.

Opmerking

Deze optie is alleen beschikbaar in de v1.7 prerelease CLI (momenteel RC). Installeren met dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Schakel het MCP-updaterecordprogramma van DAB in.

Opmerking

Deze optie is alleen beschikbaar in de v1.7 prerelease CLI (momenteel RC). Installeren met dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Schakel het MCP-hulpprogramma voor verwijderen van DAB in.

Opmerking

Deze optie is alleen beschikbaar in de v1.7 prerelease CLI (momenteel RC). Installeren met dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Schakel het MCP-hulpprogramma voor het uitvoeren van entiteiten van DAB in.

Opmerking

Deze optie is alleen beschikbaar in de v1.7 prerelease CLI (momenteel RC). Installeren met dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

--runtime.cache.enabled

Schakel de cache van DAB wereldwijd in. U moet ook caching inschakelen voor elke entiteit.

Example

dab configure \
  --runtime.cache.enabled true

Resulterende configuratie

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

--runtime.cache.ttl-seconds

Pas de globale standaardtijd van de DAB-cache aan in seconden.

Example

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

Resulterende configuratie

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

--runtime.host.mode

Stel de actieve hostmodus van DAB in.

Toegestane waarden:

  • Development
  • Production

Example

dab configure \
  --runtime.host.mode Development

Resulterende configuratie

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

--runtime.host.cors.origins

Toegestane oorsprongen overschrijven in CORS. Geef waarden op als een door spaties gescheiden lijst.

Example

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

Resulterende configuratie

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

--runtime.host.cors.allow-credentials

Stel de waarde voor de Access-Control-Allow-Credentials koptekst in.

Example

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

--runtime.host.authentication.provider

Configureer de naam van de verificatieprovider.

Example

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

--runtime.host.authentication.jwt.audience

Configureer een of meer beoogde geadresseerden van het JWT-token.

Example

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

--runtime.host.authentication.jwt.issuer

Configureer de entiteit die het JWT-token heeft uitgegeven.

Example

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

Resulterende configuratie

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

--azure-key-vault.endpoint

Configureer de Eindpunt-URL van Azure Key Vault.

Example

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

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

Configureer de beleidsmodus voor opnieuw proberen.

Toegestane waarden:

  • fixed
  • exponential

Example

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

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

Configureer het maximum aantal nieuwe pogingen.

Example

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

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

Configureer de initiële vertraging tussen nieuwe pogingen in seconden.

Example

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

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

Configureer de maximale vertraging tussen nieuwe pogingen in seconden (voor exponentiële modus).

Example

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

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

Configureer de netwerktime-out voor aanvragen in seconden.

Example

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

Resulterende configuratie

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

Azure Log Analytics in- of uitschakelen.

Example

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

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

Configureer een DAB-id-tekenreeks die wordt gebruikt in Azure Log Analytics.

Example

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

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

Configureer het leeggemaakte interval in seconden voor Azure Log Analytics.

Example

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

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

Configureer de aangepaste tabelnaam voor 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

Configureer onveranderbare DCR-id voor 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

DCE-eindpunt configureren voor Azure Log Analytics.

Example

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

Resulterende configuratie

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

Logboekregistratie van bestandssink in- of uitschakelen.

Example

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

--runtime.telemetry.file.path

Configureer het pad voor logboekregistratie van bestandssinken.

Example

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

--runtime.telemetry.file.rolling-interval

Configureer het rolling interval voor logboekregistratie van bestandssink.

Toegestane waarden:

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

Example

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

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

Configureer het maximum aantal bewaarde bestanden.

Example

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

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

Configureer de maximale bestandsgrootte in bytes.

Example

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

Resulterende configuratie

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

Dit Help-scherm weergeven.

Example

dab configure \
  --help

--version

Versie-informatie weergeven.

Example

dab configure \
  --version
  • Last updated on