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: Model Context Protocol (MCP), data manipulatie language (DML), time to live (TTL), JSON Web Token (JWT), release kandidaat (RC), data collection rule (DCR) en eindpunt voor gegevensverzameling (DCE).

Opmerking

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

Syntaxis

dab configure [options]

Belangrijk

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

Sectie Gegevensbron

Optie Samenvatting
--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 Sessiecontext in- of uitschakelen. Standaard: false.
--data-source.health.enabled Schakel de statuscontrole van de gegevensbron in of uit.
--data-source.health.name Id voor gegevensbron in statuscontrolerapport.
--data-source.health.threshold-ms Drempelwaarde voor statuscontrolequery's in milliseconden.
--data-source.user-delegated-auth.enabled Schakel door de gebruiker gedelegeerde OBO-verificatie in.
--data-source.user-delegated-auth.provider Stel de id-provider van de OBO in.
--data-source.user-delegated-auth.database-audience Doelgroep voor het downstream SQL-token.
--data-source-files Raadpleeg aanvullende configuratiebestanden voor gegevensbronnen.

GraphQL-sectie

Optie Samenvatting
--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.

REST-sectie

Optie Samenvatting
--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.

Sectie Paginering

Optie Samenvatting
--runtime.pagination.max-page-size Maximale paginagrootte voor gepagineerde resultaten.
--runtime.pagination.default-page-size Standaardpaginaformaat voor gepagineerde resultaten.
--runtime.pagination.next-link-relative Gebruik relatieve URL's in REST-paginering volgende koppelingen.

MCP-sectie

Optie Samenvatting
--runtime.mcp.enabled MCP-eindpunt in- of uitschakelen.
--runtime.mcp.path Pas het MCP-eindpuntpad aan.
--runtime.mcp.description Stel de beschrijving van de MCP-server in.
--runtime.mcp.dml-tools Schakel alle MCP DML-hulpprogramma's in of uit.
--runtime.mcp.dml-tools.describe-entities Schakel het hulpprogramma describe-entities in of uit.
--runtime.mcp.dml-tools.create-record Schakel het hulpprogramma create-record in of uit.
--runtime.mcp.dml-tools.read-records Schakel het hulpprogramma leesrecords in of uit.
--runtime.mcp.dml-tools.update-record Schakel het hulpprogramma updaterecord in of uit.
--runtime.mcp.dml-tools.delete-record Schakel het hulpprogramma delete-record in of uit.
--runtime.mcp.dml-tools.execute-entity Schakel het hulpprogramma execute-entity in of uit.
--runtime.mcp.dml-tools.aggregate-records Schakel het hulpprogramma aggregate-records in of uit.
--runtime.mcp.dml-tools.aggregate-records.query-timeout Time-out voor uitvoering in seconden voor aggregate-records.

Cachesectie

Optie Samenvatting
--runtime.cache.enabled Globale cache in- of uitschakelen.
--runtime.cache.ttl-seconds TTL voor globale cache in seconden.
--runtime.compression.level Stel het HTTP-antwoordcompressieniveau in.

Hostsectie

Optie Samenvatting
--runtime.host.mode Hostmodus instellen: Ontwikkeling of Productie.
--runtime.host.max-response-size-mb Maximale antwoordgrootte in megabytes.
--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.

Sectie Status

Optie Samenvatting
--runtime.health.enabled Schakel het globale statuseindpunt in of uit.
--runtime.health.cache-ttl-seconds Cache TTL voor statuscontrolerapporten.
--runtime.health.max-query-parallelism Maximaal aantal query's voor gelijktijdige statuscontrole.
--runtime.health.roles Rollen die zijn toegestaan om uitgebreide statusresultaten weer te geven.

Effectieve machtigingen

Optie Samenvatting
--show-effective-permissions Opgeloste machtigingen voor alle entiteiten weergeven.

Key Vault-sectie

Optie Samenvatting
--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.

Sectie Telemetrie

Optie Samenvatting
--runtime.telemetry.log-level Configureer de uitgebreidheid van logboekregistratie per naamruimte.
--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.

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

Resulterende configuratie

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

--data-source-files

Raadpleeg aanvullende configuratiebestanden voor gegevensbronnen uit het hoofdconfiguratiebestand.

Example

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

Resulterende configuratie

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

--data-source.options.database

Databasenaam voor Cosmos DB for NoSql.

Example

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

Resulterende configuratie

{
  "data-source": {
    "options": {
      "database": "MyCosmosDatabase"
    }
  }
}

--data-source.options.container

Containernaam voor Cosmos DB voor NoSql.

Example

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

Resulterende configuratie

{
  "data-source": {
    "options": {
      "container": "MyCosmosContainer"
    }
  }
}

--data-source.options.schema

Schemapad voor Cosmos DB voor NoSql.

Example

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

Resulterende configuratie

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

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

Schakel sessiecontext in.

Toegestane waarden:

  • true
  • false (standaard)

Example

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

Resulterende configuratie

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

--data-source.health.enabled

Schakel de statuscontrole voor de gegevensbron in of uit. De standaardwaarde is true.

Example

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

Resulterende configuratie

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

--data-source.health.name

Id voor gegevensbron in statuscontrolerapport.

Example

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

Resulterende configuratie

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

--data-source.health.threshold-ms

Maximale duur in milliseconden voor de query voor de statuscontrole van de gegevensbron. De standaardwaarde is 1000.

Example

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

Resulterende configuratie

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

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

Door de gebruiker gedelegeerde verificatie in-Behalf-Of (OBO) in- of uitschakelen. Alleen ondersteund voor mssql gegevensbronnen.

Opmerking

De data-API builder 2.0-functionaliteit die in deze sectie wordt beschreven, is momenteel in preview en kan veranderen vóór algemene beschikbaarheid. Zie Wat is er nieuw in versie 2.0 voor meer informatie.

Example

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

Resulterende configuratie

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

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

Stel de id-provider in voor on-Behalf-Of (OBO) door de gebruiker gedelegeerde verificatie. Op dit moment wordt alleen EntraId ondersteund.

Opmerking

De data-API builder 2.0-functionaliteit die in deze sectie wordt beschreven, is momenteel in preview en kan veranderen vóór algemene beschikbaarheid. Zie Wat is er nieuw in versie 2.0 voor meer informatie.

Example

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

Resulterende configuratie

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

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

Stel de doelgroep in voor het downstream SQL-token wanneer OBO is ingeschakeld.

Example

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

Resulterende configuratie

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

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

Resulterende configuratie

{
  "runtime": {
    "graphql": {
      "enabled": false
    }
  }
}

--runtime.graphql.path

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

Example

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

Resulterende configuratie

{
  "runtime": {
    "graphql": {
      "path": "/graphql"
    }
  }
}

--runtime.graphql.allow-introspection

GraphQL-introspectieaanvragen toestaan of weigeren.

Example

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

Resulterende configuratie

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

Resulterende configuratie

{
  "runtime": {
    "graphql": {
      "multiple-mutations": {
        "create": {
          "enabled": true
        }
      }
    }
  }
}

--runtime.rest.enabled

Schakel het REST-eindpunt van DAB in.

Example

dab configure \
  --runtime.rest.enabled false

Resulterende configuratie

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

Resulterende configuratie

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

--runtime.pagination.max-page-size

Maximale paginagrootte voor gepagineerde resultaten. De standaardwaarde is 100000. Minimum is 1.

Example

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

Resulterende configuratie

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

--runtime.pagination.default-page-size

Standaardpaginaformaat voor gepagineerde resultaten. De standaardwaarde is 100. Minimum is 1.

Example

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

Resulterende configuratie

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

--runtime.pagination.next-link-relative

Gebruik relatieve URL's in plaats van absolute URL's in REST-pagineringswaarden nextLink . De standaardwaarde is false.

Example

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

Resulterende configuratie

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

--runtime.mcp.enabled

Schakel het MCP-eindpunt van DAB in.

Opmerking

Deze optie is beschikbaar in de Data API Builder 2.0 preview CLI. Installeer de nieuwste prerelease 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 beschikbaar in de Data API Builder 2.0 preview CLI. Installeer de nieuwste prerelease met dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Resulterende configuratie

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

--runtime.mcp.description

Stel de beschrijving van de MCP-server in voor weergave in het geïnitialiseerde antwoord.

Opmerking

Deze optie is beschikbaar in de Data API Builder 2.0 preview CLI. Installeer de nieuwste prerelease met dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Resulterende configuratie

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

--runtime.mcp.dml-tools

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

Opmerking

Deze optie is beschikbaar in de Data API Builder 2.0 preview CLI. Installeer de nieuwste prerelease 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 false

Resulterende configuratie

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

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

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

Opmerking

Deze optie is beschikbaar in de Data API Builder 2.0 preview CLI. Installeer de nieuwste prerelease met dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Resulterende configuratie

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

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

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

Opmerking

Deze optie is beschikbaar in de Data API Builder 2.0 preview CLI. Installeer de nieuwste prerelease met dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Resulterende configuratie

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

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

Schakel het MCP-hulpprogramma voor leesrecords van DAB in.

Opmerking

Deze optie is beschikbaar in de Data API Builder 2.0 preview CLI. Installeer de nieuwste prerelease met dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Resulterende configuratie

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

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

Schakel het MCP-updaterecordprogramma van DAB in.

Opmerking

Deze optie is beschikbaar in de Data API Builder 2.0 preview CLI. Installeer de nieuwste prerelease met dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Resulterende configuratie

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

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

Schakel het MCP-hulpprogramma voor verwijderen van DAB in.

Opmerking

Deze optie is beschikbaar in de Data API Builder 2.0 preview CLI. Installeer de nieuwste prerelease met dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Resulterende configuratie

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

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

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

Opmerking

Deze optie is beschikbaar in de Data API Builder 2.0 preview CLI. Installeer de nieuwste prerelease met dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Resulterende configuratie

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

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

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

Opmerking

Deze optie is beschikbaar in de Data API Builder 2.0 preview CLI. Installeer de nieuwste prerelease met dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Resulterende configuratie

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

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

Stel de time-out voor de uitvoering in seconden in voor het MCP-hulpprogramma voor statistische records.

Standaard: 30. Bereik: 1-600.

Opmerking

Deze optie is beschikbaar in de Data API Builder 2.0 preview CLI. Installeer de nieuwste prerelease met dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Resulterende configuratie

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

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

Opmerking

De data-API builder 2.0-functionaliteit die in deze sectie wordt beschreven, is momenteel in preview en kan veranderen vóór algemene beschikbaarheid. Zie Wat is er nieuw in versie 2.0 voor meer informatie.

Stel het HTTP-antwoordcompressieniveau in.

Toegestane waarden:

  • optimal— balansen compressieverhouding en snelheid (standaard)
  • fastest— prioriteit geeft aan de compressiesnelheid boven verhouding
  • none— schakelt compressie uit

Example

dab configure \
  --runtime.compression.level optimal

Resulterende configuratie

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

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

Maximale grootte in megabytes voor een databaseantwoord in één resultaat. De standaardwaarde is 158.

Example

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

Resulterende configuratie

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

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

Resulterende configuratie

{
  "runtime": {
    "host": {
      "cors": {
        "allow-credentials": true
      }
    }
  }
}

--runtime.host.authentication.provider

Configureer de naam van de verificatieprovider.

Example

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

Resulterende configuratie

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

Resulterende configuratie

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

--runtime.health.enabled

Schakel het globale statuseindpunt in of uit. De standaardwaarde is true.

Example

dab configure \
  --runtime.health.enabled true

Resulterende configuratie

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

--runtime.health.cache-ttl-seconds

Time to live in seconden voor statuscontrolerapporten in de cache. De standaardwaarde is 5. Minimum is 0.

Example

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

Resulterende configuratie

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

--runtime.health.max-query-parallelism

Maximaal aantal query's voor gelijktijdige statuscontrole. De standaardwaarde is 4. De waarden worden vastgemaakt aan het ondersteunde bereik van 1 door 8.

Example

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

Resulterende configuratie

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

--runtime.health.roles

Rollen die zijn toegestaan om uitgebreide statusresultaten weer te geven. Configureer ten minste één rol in de productiemodus.

Example

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

Resulterende configuratie

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

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

Resulterende configuratie

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

Resulterende configuratie

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

Resulterende configuratie

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

Resulterende configuratie

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

Resulterende configuratie

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

Configureer de uitgebreidheid van logboekregistratie per naamruimte. Gebruik default dit voor het globale terugvalniveau of geef een naamruimte of klassenaam achter --runtime.telemetry.log-level.op.

Toegestane waarden: Trace, Debug, Information, Warning, , Error, Critical. None

Example

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

Resulterende configuratie

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

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

Azure Log Analytics in- of uitschakelen.

Example

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

Resulterende configuratie

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

Resulterende configuratie

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

Resulterende configuratie

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

Resulterende configuratie

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

Resulterende configuratie

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

Resulterende configuratie

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

Resulterende configuratie

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

Resulterende configuratie

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

Resulterende configuratie

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

--show-effective-permissions

Geef de opgeloste machtigingen weer voor elke entiteit nadat de overname van rollen is toegepast. Gebruik deze optie om te zien wat elke rol daadwerkelijk kan doen zonder handmatig door de configuratie te redeneren.

Opmerking

De data-API builder 2.0-functionaliteit die in deze sectie wordt beschreven, is momenteel in preview en kan veranderen vóór algemene beschikbaarheid. Zie Wat is er nieuw in versie 2.0 voor meer informatie.

Example

dab configure \
  --show-effective-permissions

dab configure \
  --show-effective-permissions --config my-config.json

dab configure ^
  --show-effective-permissions --config my-config.json

Voorbeelduitvoer

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