init příkaz

Inicializace nového konfiguračního souboru tvůrce rozhraní Data API Výsledný kód JSON zachycuje podrobnosti o zdroji dat, povolené koncové body (REST, GraphQL, MCP), ověřování a chování modulu runtime.

Syntaxe

dab init [options]

Pokud cílový konfigurační soubor již existuje, příkaz ho přepíše. Sloučení neexistuje. Pokud potřebujete zachovat předchozí soubor, použijte správu verzí nebo zálohy.

Rychlý přehled

Možnost Shrnutí
-c, --config Název výstupního konfiguračního souboru (výchozí dab-config.json)

Oddíl ověřování

Možnost Shrnutí
--auth.audience Deklarace cílové skupiny JSON Web Token (JWT)
--auth.issuer Deklarace identity vystavitele webového tokenu JSON (JWT)
--auth.provider Zprostředkovatel identity (výchozí Unauthenticated)

Část Zdroj dat

Možnost Shrnutí
--connection-string Připojovací řetězec databáze (podporuje @env())
--cosmosdb_nosql-container Název kontejneru NoSQL služby Cosmos DB (volitelné)
--cosmosdb_nosql-database Název databáze NoSQL služby Cosmos DB (vyžadovaný pro cosmosdb_nosql)
--database-type Typ databáze: mssql, mysql, postgresqlcosmosdb_postgresql,cosmosdb_nosql
--set-session-context Povolení kontextu relace SQL Serveru (pouze mssql)

Část GraphQL

Možnost Shrnutí
--graphql.disabled Deprecated. Zakáže GraphQL (použití --graphql.enabled false)
--graphql.enabled Povolení GraphQL (výchozí hodnota true)
--graphql.multiple-create.enabled Povolit vícenásobné vytváření mutací (výchozí false)
--graphql.path Předpona koncového bodu GraphQL (výchozí /graphql)
--graphql-schema Cesta ke schématu GraphQL (vyžadovaná pro cosmosdb_nosql)

Oddíl hostitelů a ověřování

Možnost Shrnutí
--host-mode Režim hostitele: Vývoj nebo Produkční (výchozí produkční)
--cors-origin Seznam povolených původů (oddělený čárkami)
--runtime.base-route Globální předpona pro všechny koncové body

Oddíl MCP

Možnost Shrnutí
--mcp.aggregate-records.query-timeout Časový limit nástroje agregace záznamů v sekundách (výchozí 30, rozsah 1–600)
--mcp.disabled Deprecated. Zakáže MCP (použití --mcp.enabled false)
--mcp.enabled Povolení MCP (výchozí hodnota true)
--mcp.path Předpona koncového bodu MCP (výchozí /mcp)

Poznámka:

Funkce MCP je dostupná ve verzi 1.7 a novějších verzích.

Oddíl REST

Možnost Shrnutí
--rest.disabled Deprecated. Zakáže REST (použití --rest.enabled false)
--rest.enabled Povolte REST (výchozí true, preferujte před --rest.disabled)
--rest.path Předpona koncového bodu REST (výchozí /api, ignorováno pro cosmosdb_nosql)
--rest.request-body-strict Vynucení ověření textu striktního požadavku (výchozí false, ignorováno pro cosmosdb_nosql)

Důležité

Ve stejném příkazu nekombinujte nové --*.enabled příznaky a starší --*.disabled příznaky pro stejný subsystém. Preferujte --*.enabled vzor, --rest.disabledupozornění protokolu , --graphql.disableda --mcp.disabled možnosti a budou odebrány v budoucích verzích.

-c, --config

Název výstupního konfiguračního souboru Výchozí hodnota je dab-config.json.

Example

dab init \
  --database-type mssql \
  --config dab-config.local.json

Výsledná konfigurace

{
  "data-source": {
    "database-type": "mssql",
    "connection-string": ""
  }
}

--auth.audience

Deklarace cílové skupiny JSON Web Token (JWT).

Example

dab init \
  --database-type mssql \
  --auth.audience "https://example.com/api"

Výsledná konfigurace

{
  "runtime": {
    "host": {
      "authentication": {
        "jwt": {
          "audience": "https://example.com/api"
        }
      }
    }
  }
}

--auth.issuer

Deklarace identity vystavitele webového tokenu JSON (JWT).

Example

dab init \
  --database-type mssql \
  --auth.issuer "https://login.microsoftonline.com/{tenant-id}/v2.0"

Výsledná konfigurace

{
  "runtime": {
    "host": {
      "authentication": {
        "jwt": {
          "issuer": "https://login.microsoftonline.com/{tenant-id}/v2.0"
        }
      }
    }
  }
}

--auth.provider

Zprostředkovatel identity. Výchozí hodnota je Unauthenticated.

Pokud Unauthenticated je jazyk DAB aktivní, nekontroluje ani neověřuje žádné JWT. Všechny požadavky běží jako anonymous. Jiná služba může ověřovat nebo filtrovat požadavky dříve, než se dostanou k DAB, ale DAB stále autorizuje pouze jako anonymous. Pokud chcete použít jiného zprostředkovatele, nastavte ho explicitně.

Pokyny ke konfiguraci najdete v tématu Konfigurace neověřeného zprostředkovatele.

Poznámka:

Funkce tvůrce rozhraní Data API 2.0 popsané v této části jsou aktuálně ve verzi Preview a můžou se změnit před obecnou dostupností. Další informace najdete v tématu Co je nového ve verzi 2.0.

Platné hodnoty: Unauthenticated, StaticWebApps, EntraID, AzureAD, AppService, Simulator, . Custom

Důležité

Poskytovatelé jiné než Unauthenticated, StaticWebAppsa Simulator vyžadují --auth.audience a --auth.issuer.

Example

dab init \
  --database-type mssql \
  --auth.provider AzureAD \
  --auth.audience "https://example.com/api" \
  --auth.issuer "https://login.microsoftonline.com/{tenant-id}/v2.0"

Výsledná konfigurace

{
  "runtime": {
    "host": {
      "authentication": {
        "provider": "AzureAD",
        "jwt": {
          "audience": "https://example.com/api",
          "issuer": "https://login.microsoftonline.com/{tenant-id}/v2.0"
        }
      }
    }
  }
}

--connection-string

Připojovací řetězec databáze. Podporuje @env().

Example

dab init \
  --database-type mssql \
  --connection-string "@env('MSSQL_CONNECTION_STRING')"

Výsledná konfigurace

{
  "data-source": {
    "connection-string": "@env('MSSQL_CONNECTION_STRING')"
  }
}

--cors-origin

Seznam povolených původů oddělený čárkami

Example

dab init \
  --database-type mssql \
  --cors-origin "https://app.example.com,https://admin.example.com"

Výsledná konfigurace

{
  "runtime": {
    "host": {
      "cors": {
        "origins": [ "https://app.example.com", "https://admin.example.com" ]
      }
    }
  }
}

--cosmosdb_nosql-container

Název kontejneru NoSQL služby Cosmos DB

Example

dab init \
  --database-type cosmosdb_nosql \
  --cosmosdb_nosql-container MyContainer

Výsledná konfigurace

{
  "data-source": {
    "database-type": "cosmosdb_nosql",
    "options": {
      "container": "MyContainer"
    }
  }
}

--cosmosdb_nosql-database

Název databáze NoSQL služby Cosmos DB Požadováno pro cosmosdb_nosql.

Example

dab init \
  --database-type cosmosdb_nosql \
  --cosmosdb_nosql-database MyDb

Výsledná konfigurace

{
  "data-source": {
    "database-type": "cosmosdb_nosql",
    "options": {
      "database": "MyDb"
    }
  }
}

--database-type

Určuje cílový databázový stroj. Podporované hodnoty: mssql, mysql, postgresql, cosmosdb_postgresql, cosmosdb_nosql.

Example

dab init \
  --database-type mssql

Výsledná konfigurace

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

--graphql.disabled

Deprecated. Zakáže GraphQL. Raději --graphql.enabled false.

--graphql.enabled

Povolte koncový bod GraphQL. Výchozí hodnota je true.

Example

dab init \
  --database-type mssql \
  --graphql.enabled false

Výsledná konfigurace

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

--graphql.multiple-create.enabled

Umožňuje vytvářet více řádků v jedné mutaci. Výchozí hodnota je false.

Example

dab init \
  --database-type mssql \
  --graphql.multiple-create.enabled true

Výsledná konfigurace

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

--graphql.path

Předpona koncového bodu GraphQL Výchozí hodnota je /graphql.

Example

dab init \
  --database-type mssql \
  --graphql.path /gql

Výsledná konfigurace

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

--graphql-schema

Cesta k souboru schématu GraphQL Požadováno pro cosmosdb_nosql.

Example

dab init \
  --database-type cosmosdb_nosql \
  --graphql-schema ./schema.gql

Výsledná konfigurace

{
  "data-source": {
    "database-type": "cosmosdb_nosql",
    "options": {
      "schema": "./schema.gql"
    }
  }
}

--host-mode

Režim hostitele. Výchozí hodnota je Production.

Platné hodnoty: Development, Production.

Example

dab init \
  --database-type mssql \
  --host-mode development

Výsledná konfigurace

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

--mcp.aggregate-records.query-timeout

Časový limit provádění v sekundách pro nástroj MCP agregovaných záznamů Výchozí hodnota je 30. Rozsah: 1–600.

Example

dab init \
  --database-type mssql \
  --mcp.aggregate-records.query-timeout 60

Výsledná konfigurace

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

--mcp.disabled

Deprecated. Zakáže MCP. Raději --mcp.enabled false.

--mcp.enabled

Povolte koncový bod MCP. Výchozí hodnota je true.

Example

dab init \
  --database-type mssql \
  --mcp.enabled false

Výsledná konfigurace

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

--mcp.path

Předpona koncového bodu MCP. Výchozí hodnota je /mcp.

Example

dab init \
  --database-type mssql \
  --mcp.path /model

Výsledná konfigurace

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

--rest.disabled

Deprecated. Zakáže REST. Raději --rest.enabled false.

--rest.enabled

Povolte koncový bod REST. Výchozí hodnota je true.

Example

dab init \
  --database-type mssql \
  --rest.enabled false

Výsledná konfigurace

{
  "runtime": {
    "rest": {
      "enabled": false
    }
  }
}

--rest.path

Předpona koncového bodu REST Výchozí hodnota je /api.

Poznámka:

Ignorováno pro cosmosdb_nosql.

Example

dab init \
  --database-type mssql \
  --rest.path /rest

Výsledná konfigurace

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

--rest.request-body-strict

Řídí zpracování dalších polí v subjektech žádostí. Výchozí hodnota je false.

  • true: Odmítne nadbytečná pole (HTTP 400).
  • false: Ignoruje nadbytečná pole.

Poznámka:

Ignorováno pro cosmosdb_nosql.

Example

dab init \
  --database-type mssql \
  --rest.request-body-strict false

Výsledná konfigurace

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

--runtime.base-route

Globální předpona předpona pro všechny koncové body. Musí začínat na /.

Důležité

Tato možnost vyžaduje, aby StaticWebAppsbyl zprostředkovatel ověřování . Nastavit --auth.provider StaticWebApps vedle --runtime.base-routesebe .

Example

dab init \
  --database-type mssql \
  --auth.provider StaticWebApps \
  --runtime.base-route /v1

Výsledná konfigurace

{
  "runtime": {
    "base-route": "/v1"
  }
}

--set-session-context

Povolte odesílání dat do SQL Serveru pomocí kontextu relace. Platí pouze pro mssql. Výchozí hodnota je false.

Example

dab init \
  --database-type mssql \
  --set-session-context true

Výsledná konfigurace

{
  "data-source": {
    "database-type": "mssql",
    "options": {
      "set-session-context": true
    }
  }
}
  • Last updated on