Udostępnij przez

configure polecenie

Skonfiguruj właściwości środowiska uruchomieniowego i źródła danych spoza jednostki w istniejącym pliku konfiguracji konstruktora interfejsu API danych. Nieokreślone opcje pozostawiają istniejące wartości bez zmian. Jeśli jakakolwiek podana opcja jest nieprawidłowa, cała aktualizacja zakończy się niepowodzeniem (wszystkie lub nic).

Składnia

dab configure [options]

Uwaga / Notatka

To polecenie nie zmienia entities sekcji. Służy dab update do wprowadzania zmian jednostek.

Szybki rzut oka

Option Podsumowanie
-c, --config Ścieżka do pliku konfiguracji (wartość domyślna dab-config.json).
--data-source.database-type Ustaw typ bazy danych.
--data-source.connection-string Ustaw parametry połączenia bazy danych.
--data-source.options.database Nazwa bazy danych dla usługi Cosmos DB dla NoSql.
--data-source.options.container Nazwa kontenera dla usługi Cosmos DB dla NoSql.
--data-source.options.schema Ścieżka schematu dla usługi Cosmos DB dla NoSql.
--data-source.options.set-session-context Włącz kontekst sesji.
--runtime.graphql.depth-limit Ogranicz maksymalną głębokość zapytania.
--runtime.graphql.enabled Włączanie lub wyłączanie punktu końcowego graphQL.
--runtime.graphql.path Dostosuj ścieżkę punktu końcowego GraphQL.
--runtime.graphql.allow-introspection Zezwalaj na introspekcję graphQL lub odmawiaj jej.
--runtime.graphql.multiple-mutations.create.enabled Włącz mutacje wielokrotnego tworzenia.
--runtime.rest.enabled Włączanie lub wyłączanie punktu końcowego REST.
--runtime.rest.path Dostosuj ścieżkę punktu końcowego REST.
--runtime.rest.request-body-strict Wymuszanie ścisłej weryfikacji treści żądania REST.
--runtime.mcp.enabled Włączanie lub wyłączanie punktu końcowego MCP.
--runtime.mcp.path Dostosuj ścieżkę punktu końcowego MCP.
--runtime.mcp.dml-tools.enabled Włącz lub wyłącz wszystkie narzędzia DML MCP.
--runtime.mcp.dml-tools.describe-entities.enabled Włącz lub wyłącz narzędzie describe-entities.
--runtime.mcp.dml-tools.create-record.enabled Włącz lub wyłącz narzędzie create-record.
--runtime.mcp.dml-tools.read-records.enabled Włącz lub wyłącz narzędzie do odczytu rekordów.
--runtime.mcp.dml-tools.update-record.enabled Włącz lub wyłącz narzędzie update-record.
--runtime.mcp.dml-tools.delete-record.enabled Włącz lub wyłącz narzędzie do usuwania rekordu.
--runtime.mcp.dml-tools.execute-entity.enabled Włącz lub wyłącz narzędzie execute-entity.
--runtime.cache.enabled Włączanie lub wyłączanie globalnej pamięci podręcznej.
--runtime.cache.ttl-seconds Globalny czas wygaśnięcia pamięci podręcznej w sekundach.
--runtime.host.mode Ustaw tryb hosta: Programowanie lub Produkcja.
--runtime.host.cors.origins Dozwolone źródła mechanizmu CORS.
--runtime.host.cors.allow-credentials Ustaw mechanizm CORS allow-credentials.
--runtime.host.authentication.provider Dostawca uwierzytelniania.
--runtime.host.authentication.jwt.audience Twierdzenie odbiorców JWT.
--runtime.host.authentication.jwt.issuer Oświadczenie wystawcy JWT.
--azure-key-vault.endpoint Podstawowy punkt końcowy usługi Azure Key Vault.
--azure-key-vault.retry-policy.mode Ponów próbę trybu zasad.
--azure-key-vault.retry-policy.max-count Maksymalna liczba ponownych prób.
--azure-key-vault.retry-policy.delay-seconds Opóźnienie między ponownych prób.
--azure-key-vault.retry-policy.max-delay-seconds Maksymalne opóźnienie ponawiania prób wykładniczych.
--azure-key-vault.retry-policy.network-timeout-seconds Limit czasu wywołań sieciowych.
--runtime.telemetry.azure-log-analytics.enabled Włącz telemetrię usługi Azure Log Analytics.
--runtime.telemetry.azure-log-analytics.dab-identifier Rozróżnianie źródła dziennika.
--runtime.telemetry.azure-log-analytics.flush-interval-seconds Opróżnianie tempa w sekundach.
--runtime.telemetry.azure-log-analytics.auth.custom-table-name Niestandardowa nazwa tabeli.
--runtime.telemetry.azure-log-analytics.auth.dcr-immutable-id Identyfikator reguły zbierania danych.
--runtime.telemetry.azure-log-analytics.auth.dce-endpoint Punkt końcowy zbierania danych.
--runtime.telemetry.file.enabled Włącz telemetrię ujścia plików.
--runtime.telemetry.file.path Ścieżka do pliku dziennika.
--runtime.telemetry.file.rolling-interval Interwał kroczący.
--runtime.telemetry.file.retained-file-count-limit Maksymalna liczba przechowywanych plików.
--runtime.telemetry.file.file-size-limit-bytes Maksymalny rozmiar pliku przed stopniem stopniowania.
--help Wyświetl ten ekran pomocy.
--version Wyświetl informacje o wersji.

-c, --config

Ścieżka do pliku konfiguracji. Wartość domyślna to dab-config.json , chyba że dab-config.<DAB_ENVIRONMENT>.json istnieje, gdzie DAB_ENVIRONMENT jest zmienną środowiskową.

Example

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

--data-source.database-type

Typ bazy danych.

Dozwolone wartości:

  • MSSQL
  • PostgreSQL
  • CosmosDB_NoSQL
  • MySQL

Example

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

Wynikowa konfiguracja

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

--data-source.connection-string

Parametry połączenia dla źródła danych.

Example

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

--data-source.options.database

Nazwa bazy danych dla usługi Cosmos DB dla NoSql.

Example

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

--data-source.options.container

Nazwa kontenera dla usługi Cosmos DB dla NoSql.

Example

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

--data-source.options.schema

Ścieżka schematu dla usługi Cosmos DB dla NoSql.

Example

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

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

Włącz kontekst sesji.

Dozwolone wartości:

  • true (ustawienie domyślne)
  • false

Example

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

Wynikowa konfiguracja

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

--runtime.graphql.depth-limit

Maksymalna dozwolona głębokość zagnieżdżonego zapytania.

Dozwolone wartości:

  • $(0,2147483647]$ (włącznie)
  • -1 aby usunąć limit

Example

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

Wynikowa konfiguracja

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

--runtime.graphql.enabled

Włącz punkt końcowy graphQL języka DAB.

Example

dab configure \
  --runtime.graphql.enabled false

--runtime.graphql.path

Dostosuj ścieżkę punktu końcowego graphQL języka DAB. Ścieżka prefiksu z /.

Example

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

--runtime.graphql.allow-introspection

Zezwalanie na żądania introspekcji graphQL lub odmawianie ich.

Example

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

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

Włącz lub wyłącz operacje tworzenia wielu mutacji w wygenerowanym schemacie GraphQL.

Example

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

--runtime.rest.enabled

Włącz punkt końcowy REST usługi DAB.

Example

dab configure \
  --runtime.rest.enabled false

--runtime.rest.path

Dostosuj ścieżkę punktu końcowego REST języka DAB. Ścieżka prefiksu z /.

Example

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

Wynikowa konfiguracja

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

--runtime.rest.request-body-strict

Zakazać nadmiarowych pól treści żądania REST.

Example

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

--runtime.mcp.enabled

Włącz punkt końcowy MCP w usłudze DAB.

Uwaga / Notatka

Ta opcja jest dostępna tylko w interfejsie wiersza polecenia wersji 1.7 (obecnie RC). Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --prerelease.

Example

dab configure \
  --runtime.mcp.enabled false

Wynikowa konfiguracja

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

--runtime.mcp.path

Dostosuj ścieżkę punktu końcowego MCP w usłudze DAB. Ścieżka prefiksu z /.

Uwaga / Notatka

Ta opcja jest dostępna tylko w interfejsie wiersza polecenia wersji 1.7 (obecnie RC). Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Wynikowa konfiguracja

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

--runtime.mcp.dml-tools.enabled

Włącz punkt końcowy narzędzi DML mcP programu DAB.

Uwaga / Notatka

Ta opcja jest dostępna tylko w interfejsie wiersza polecenia wersji 1.7 (obecnie RC). Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Włącz narzędzie do opisywania jednostek w usłudze DAB w usłudze DAB.

Uwaga / Notatka

Ta opcja jest dostępna tylko w interfejsie wiersza polecenia wersji 1.7 (obecnie RC). Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Włącz narzędzie do tworzenia rekordu MCP w usłudze DAB.

Uwaga / Notatka

Ta opcja jest dostępna tylko w interfejsie wiersza polecenia wersji 1.7 (obecnie RC). Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Włącz narzędzie do odczytu MCP w usłudze DAB.

Uwaga / Notatka

Ta opcja jest dostępna tylko w interfejsie wiersza polecenia wersji 1.7 (obecnie RC). Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Włącz narzędzie do rejestrowania aktualizacji MCP w usłudze DAB.

Uwaga / Notatka

Ta opcja jest dostępna tylko w interfejsie wiersza polecenia wersji 1.7 (obecnie RC). Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Włącz narzędzie do usuwania rekordu MCP w usłudze DAB.

Uwaga / Notatka

Ta opcja jest dostępna tylko w interfejsie wiersza polecenia wersji 1.7 (obecnie RC). Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

Włącz narzędzie jednostki wykonywania mcp w usłudze DAB.

Uwaga / Notatka

Ta opcja jest dostępna tylko w interfejsie wiersza polecenia wersji 1.7 (obecnie RC). Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

--runtime.cache.enabled

Włącz globalnie pamięć podręczną języka DAB. Należy również włączyć buforowanie dla każdej jednostki.

Example

dab configure \
  --runtime.cache.enabled true

Wynikowa konfiguracja

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

--runtime.cache.ttl-seconds

Dostosuj globalny czas wygaśnięcia pamięci podręcznej DAB w sekundach.

Example

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

Wynikowa konfiguracja

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

--runtime.host.mode

Ustaw tryb działania hosta w języku DAB.

Dozwolone wartości:

  • Development
  • Production

Example

dab configure \
  --runtime.host.mode Development

Wynikowa konfiguracja

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

--runtime.host.cors.origins

Zastępowanie dozwolonych źródeł w mechanizmie CORS. Podaj wartości jako listę rozdzielaną spacjami.

Example

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

Wynikowa konfiguracja

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

--runtime.host.cors.allow-credentials

Ustaw wartość nagłówka Access-Control-Allow-Credentials .

Example

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

--runtime.host.authentication.provider

Skonfiguruj nazwę dostawcy uwierzytelniania.

Example

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

--runtime.host.authentication.jwt.audience

Skonfiguruj zamierzonych adresatów tokenu JWT.

Example

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

--runtime.host.authentication.jwt.issuer

Skonfiguruj jednostkę, która wystawiła token JWT.

Example

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

Wynikowa konfiguracja

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

--azure-key-vault.endpoint

Skonfiguruj adres URL punktu końcowego usługi Azure Key Vault.

Example

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

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

Skonfiguruj tryb zasad ponawiania prób.

Dozwolone wartości:

  • fixed
  • exponential

Example

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

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

Skonfiguruj maksymalną liczbę ponownych prób.

Example

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

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

Skonfiguruj początkowe opóźnienie między ponowną próbą w sekundach.

Example

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

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

Skonfiguruj maksymalne opóźnienie między ponawiania próbami w sekundach (dla trybu wykładniczego).

Example

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

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

Skonfiguruj limit czasu sieci dla żądań w sekundach.

Example

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

Wynikowa konfiguracja

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

Włączanie lub wyłączanie usługi Azure Log Analytics.

Example

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

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

Skonfiguruj ciąg identyfikatora języka DAB używany w usłudze Azure Log Analytics.

Example

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

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

Skonfiguruj interwał opróżniania w sekundach dla usługi Azure Log Analytics.

Example

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

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

Skonfiguruj niestandardową nazwę tabeli dla usługi 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

Skonfiguruj niezmienny identyfikator DCR dla usługi 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

Konfigurowanie punktu końcowego DCE dla usługi Azure Log Analytics.

Example

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

Wynikowa konfiguracja

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

Włączanie lub wyłączanie rejestrowania ujścia plików.

Example

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

--runtime.telemetry.file.path

Skonfiguruj ścieżkę do rejestrowania ujścia plików.

Example

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

--runtime.telemetry.file.rolling-interval

Skonfiguruj interwał kroczący na potrzeby rejestrowania ujścia plików.

Dozwolone wartości:

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

Example

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

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

Skonfiguruj maksymalną liczbę zachowanych plików.

Example

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

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

Skonfiguruj maksymalny limit rozmiaru pliku w bajtach.

Example

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

Wynikowa konfiguracja

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

Wyświetl ten ekran pomocy.

Example

dab configure \
  --help

--version

Wyświetl informacje o wersji.

Example

dab configure \
  --version
  • Last updated on