init parancs

Inicializáljon egy új Data API Builder-konfigurációs fájlt. Az eredményként kapott JSON rögzíti az adatforrás részleteit, az engedélyezett végpontokat (REST, GraphQL, MCP), a hitelesítést és a futtatókörnyezet viselkedését.

Szemantika

dab init [options]

Ha a célkonfigurációs fájl már létezik, a parancs felülírja azt. Nincs egyesítés. Ha meg kell őriznie az előző fájlt, használjon verziókövetést vagy biztonsági másolatot.

Gyors áttekintés

Lehetőség Összefoglalás
-c, --config Kimeneti konfigurációs fájl neve (alapértelmezett dab-config.json)

Hitelesítési szakasz

Lehetőség Összefoglalás
--auth.audience JSON Web Token (JWT) célközönségre vonatkozó jogcím
--auth.issuer JSON Web Token (JWT) kiállítói jogcím
--auth.provider Identitásszolgáltató (alapértelmezett Unauthenticated)

Adatforrás szakasz

Lehetőség Összefoglalás
--connection-string Adatbázis kapcsolati sztringje (támogatja @env())
--cosmosdb_nosql-container Cosmos DB NoSQL-tároló neve (nem kötelező)
--cosmosdb_nosql-database Cosmos DB NoSQL-adatbázis neve (cosmosdb_nosql szükséges)
--database-type Adatbázis típusa: mssql, mysql, postgresql, cosmosdb_postgresqlcosmosdb_nosql
--set-session-context SQL Server-munkamenet-környezet engedélyezése (csak mssql)

GraphQL-szakasz

Lehetőség Összefoglalás
--graphql.disabled Deprecated. Letiltja a GraphQL-t (használat --graphql.enabled false)
--graphql.enabled GraphQL engedélyezése (alapértelmezett igaz)
--graphql.multiple-create.enabled Több létrehozási mutáció engedélyezése (alapértelmezett hamis)
--graphql.path GraphQL-végpont előtagja (alapértelmezett /graphql)
--graphql-schema A GraphQL-séma elérési útja (cosmosdb_nosql szükséges)

Gazdagép és hitelesítés szakasz

Lehetőség Összefoglalás
--host-mode Gazdagép mód: Fejlesztés vagy éles környezet (alapértelmezett éles környezet)
--cors-origin Engedélyezett forráslista (vesszővel tagolt)
--runtime.base-route Globális előtag az összes végponthoz

MCP-szakasz

Lehetőség Összefoglalás
--mcp.aggregate-records.query-timeout Aggregátumrekordok eszköz időtúllépése másodpercben (alapértelmezett 30, tartomány: 1–600)
--mcp.disabled Deprecated. Az MCP letiltása (használat --mcp.enabled false)
--mcp.enabled McP engedélyezése (alapértelmezett igaz)
--mcp.path MCP-végpont előtagja (alapértelmezett /mcp)

Megjegyzés:

Az MCP-képesség verzióban és újabb verziókban 1.7 is elérhető.

REST szakasz

Lehetőség Összefoglalás
--rest.disabled Deprecated. A REST letiltása (használat --rest.enabled false)
--rest.enabled REST engedélyezése (alapértelmezett igaz, előnyben részesítés)--rest.disabled
--rest.path REST-végpont előtagja (alapértelmezett /api, cosmosdb_nosql figyelmen kívül hagyva)
--rest.request-body-strict Szigorú kérelemtörzs-ellenőrzés kényszerítése (alapértelmezett hamis, cosmosdb_nosql figyelmen kívül hagyva)

Fontos

Ne keverje az új --*.enabled és az örökölt --*.disabled jelzőket ugyanabban az alrendszerben ugyanabban a parancsban. Előnyben részesíti a --*.enabled mintát; a --rest.disabled, --graphql.disabledés --mcp.disabled a beállítások napló figyelmeztetéseit, és a jövőbeli verziókban el lesz távolítva.

-c, --config

Kimeneti konfigurációs fájl neve. Az alapértelmezett érték dab-config.json.

Example

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

Eredményként kapott konfiguráció

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

--auth.audience

JSON Web Token (JWT) célközönség jogcíme.

Example

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

Eredményként kapott konfiguráció

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

--auth.issuer

JSON Web Token (JWT) kiállítói jogcím.

Example

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

Eredményként kapott konfiguráció

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

--auth.provider

Identitásszolgáltató. Az alapértelmezett érték Unauthenticated.

Ha Unauthenticated aktív, a DAB nem vizsgálja meg vagy ellenőrzi a JWT-t. Az összes kérés a következőként anonymousfut: . Egy másik szolgáltatás hitelesítheti vagy szűrheti a kéréseket, mielőtt elérnék a DAB-t, de a DAB továbbra is csak a következőképpen engedélyezi a anonymouskéréseket. Ha másik szolgáltatót szeretne használni, állítsa be explicit módon.

A konfigurációs útmutatásért lásd : Hitelesítés nélküli szolgáltató konfigurálása.

Megjegyzés:

Az ebben a szakaszban ismertetett Data API Builder 2.0 funkció jelenleg előzetes verzióban érhető el, és az általános rendelkezésre állás előtt változhat. További információ: A 2.0-s verzió újdonságai.

Érvényes értékek: Unauthenticated, StaticWebApps, EntraID, AzureAD, AppService, Simulator. Custom

Fontos

UnauthenticatedA nem , StaticWebAppsés a szükséges és Simulator--auth.issuera .--auth.audience

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"

Eredményként kapott konfiguráció

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

--connection-string

Adatbázis-kapcsolati sztring. Támogatja @env()a .

Example

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

Eredményként kapott konfiguráció

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

--cors-origin

Az engedélyezett források vesszővel tagolt listája.

Example

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

Eredményként kapott konfiguráció

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

--cosmosdb_nosql-container

Cosmos DB NoSQL-tároló neve.

Example

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

Eredményként kapott konfiguráció

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

--cosmosdb_nosql-database

Cosmos DB NoSQL-adatbázis neve. A következőhöz cosmosdb_nosqlszükséges: .

Example

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

Eredményként kapott konfiguráció

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

--database-type

Megadja a céladatbázis-motort. Támogatott értékek: mssql, mysql, postgresql, cosmosdb_postgresql, cosmosdb_nosql.

Example

dab init \
  --database-type mssql

Eredményként kapott konfiguráció

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

--graphql.disabled

Deprecated. Letiltja a GraphQL-t. Előnyben részesítve --graphql.enabled false.

--graphql.enabled

Engedélyezze a GraphQL-végpontot. Az alapértelmezett érték true.

Example

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

Eredményként kapott konfiguráció

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

--graphql.multiple-create.enabled

Lehetővé teszi több sor létrehozását egyetlen mutációban. Az alapértelmezett érték false.

Example

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

Eredményként kapott konfiguráció

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

--graphql.path

GraphQL-végpont előtagja. Az alapértelmezett érték /graphql.

Example

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

Eredményként kapott konfiguráció

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

--graphql-schema

GraphQL-sémafájl elérési útja. A következőhöz cosmosdb_nosqlszükséges: .

Example

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

Eredményként kapott konfiguráció

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

--host-mode

Gazdagép mód. Az alapértelmezett érték Production.

Érvényes értékek: Development, Production.

Example

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

Eredményként kapott konfiguráció

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

--mcp.aggregate-records.query-timeout

Végrehajtási időtúllépés másodpercben az összesítő rekordokat tartalmazó MCP-eszközhöz. Az alapértelmezett érték 30. Tartomány: 1600.

Example

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

Eredményként kapott konfiguráció

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

--mcp.disabled

Deprecated. Letiltja az MCP-t. Előnyben részesítve --mcp.enabled false.

--mcp.enabled

Engedélyezze az MCP-végpontot. Az alapértelmezett érték true.

Example

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

Eredményként kapott konfiguráció

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

--mcp.path

MCP-végpont előtagja. Az alapértelmezett érték /mcp.

Example

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

Eredményként kapott konfiguráció

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

--rest.disabled

Deprecated. Letiltja a REST funkciót. Előnyben részesítve --rest.enabled false.

--rest.enabled

REST-végpont engedélyezése. Az alapértelmezett érték true.

Example

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

Eredményként kapott konfiguráció

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

--rest.path

REST-végpont előtagja. Az alapértelmezett érték /api.

Megjegyzés:

Figyelmen kívül hagyva a következőhöz cosmosdb_nosql: .

Example

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

Eredményként kapott konfiguráció

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

--rest.request-body-strict

A kérelemtörzsekben lévő további mezők kezelését szabályozza. Az alapértelmezett érték false.

  • true: Elveti a felesleges mezőket (HTTP 400).
  • false: Figyelmen kívül hagyja a további mezőket.

Megjegyzés:

Figyelmen kívül hagyva a következőhöz cosmosdb_nosql: .

Example

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

Eredményként kapott konfiguráció

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

--runtime.base-route

Az összes végpontra előre fel van állítva globális előtag. A kezdőbetűnek a kezdőbetűvel kell kezdődnie /.

Fontos

Ehhez a beállításhoz a hitelesítésszolgáltatónak kell lennie StaticWebApps. A beállítás mellett --runtime.base-route.--auth.provider StaticWebApps

Example

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

Eredményként kapott konfiguráció

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

--set-session-context

Engedélyezze az adatok SQL Serverre való küldését munkamenet-környezet használatával. Csak a következőre mssqlérvényes: . Az alapértelmezett érték false.

Example

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

Eredményként kapott konfiguráció

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