Runtime

Konfigurationsinställningar som avgör körningsbeteende.

Sidnumreringsinställningar

REST-inställningar

GraphQL-inställningar

Värdinställningar

CORS-inställningar

Autentiseringsinställningar

Cacheinställningar

Komprimeringsinställningar

Inställningar för telemetri

MCP-inställningar

Formatöversikt

{
  "runtime": {
    "pagination": {
      "max-page-size": <integer|null> (default: `100000`),
      "default-page-size": <integer|null> (default: `100`)
    },
    "rest": {
      "path": <string> (default: "/api"),
      "enabled": <true>|<false>,
      "request-body-strict": <true>|<false> (default: `true`)
    },
    "graphql": {
      "path": <string> (default: "/graphql"),
      "enabled": <true>|<false>,
      "allow-introspection": <true>|<false>,
      "depth-limit": <integer|null> (default: `null`),
      "multiple-mutations": {
        "create": {
          "enabled": <true>|<false> (default: `false`)
        }
      }
    },
    "host": {
      "mode": <"production"> (default) | <"development">,
      "max-response-size-mb": <integer|null> (default: `158`),
      "cors": {
        "origins": [ "<string>" ],
        "allow-credentials": <true>|<false> (default: `false`)
      },
      "authentication": {
        "provider": <string> (default: "Unauthenticated"),
        "jwt": {
          "audience": "<string>",
          "issuer": "<string>"
        }
      }
    }
  },
    "compression": {
      "level": <"optimal"> (default) | <"fastest"> | <"none">
    },
    "cache": {
      "enabled": <true>|<false> (default: `false`),
      "ttl-seconds": <integer> (default: `5`),
      "level-2": {
        "enabled": <true>|<false> (default: `false`),
        "provider": <"redis">,
        "connection-string": <string>,
        "partition": <string>
      }
    },
    "telemetry": {
      "application-insights": {
        "connection-string": "<string>",
        "enabled": <true>|<false> (default: `true`)
      },
      "open-telemetry": {
        "endpoint": "<string>",
        "headers": "<string>",
        "service-name": <string> (default: "dab"),
        "exporter-protocol": <"grpc"> (default) | <"httpprotobuf">,
        "enabled": <true>|<false> (default: `true`)
      },
      "azure-log-analytics": {
        "enabled": <true>|<false> (default: `false`),
        "dab-identifier": <string> (default: "DabLogs"),
        "flush-interval-seconds": <integer> (default: `5`),
        "auth": {
          "custom-table-name": <string>,
          "dcr-immutable-id": <string>,
          "dce-endpoint": <string>
        }
      },
      "file": {
        "enabled": <true>|<false> (default: `false`),
        "path": <string> (default: "/logs/dab-log.txt"),
        "rolling-interval": <string> (default: "Day"),
        "retained-file-count-limit": <integer> (default: `1`),
        "file-size-limit-bytes": <integer> (default: `1048576`)
      },
      "log-level": {
        // namespace keys
        "<namespace>": <"trace"|"debug"|"information"|"warning"|"error"|"critical"|"none"|null>
      }
    },
    "health": {
      "enabled": <true>|<false> (default: `true`),
      "roles": [ "<string>" ],
      "cache-ttl-seconds": <integer> (default: `5`),
      "max-query-parallelism": <integer> (default: `4`)
    },
    "mcp": {
      "enabled": <true>|<false> (default: `true`),
      "path": <string> (default: `"/mcp"`),
      "description": <string>,
      "dml-tools": <true>|<false> | {
        "describe-entities": <true>|<false> (default: `true`),
        "create-record": <true>|<false> (default: `true`),
        "read-records": <true>|<false> (default: `true`),
        "update-record": <true>|<false> (default: `true`),
        "delete-record": <true>|<false> (default: `true`),
        "execute-entity": <true>|<false> (default: `true`),
        "aggregate-records": <true>|<false> | {
          "enabled": <true>|<false> (default: `true`),
          "query-timeout": <integer> (default: `30`)
        }
      }
    }
  }
}

Läge (värdkörning)

Utvecklingsbeteende

• Aktiverad Nitro (tidigare Banana Cake Pop) för GraphQL-testning
• Aktiverat Swagger-användargränssnitt för REST-testning
• Aktiverade anonyma hälsokontroller
• Ökad loggningsveroalitet (felsökning)

Format

{
  "runtime": {
    "host": {
      "mode": "production" (default) | "development"
    }
  }
}

Maximal svarsstorlek (värdkörning)

Anger den maximala storleken (i megabyte) för ett givet resultat. Eftersom stora svar kan belasta systemet begränsar max-response-size-mb du den totala storleken (skiljer sig från radantal) för att förhindra överbelastning, vilket är särskilt med stora kolumner som text eller JSON.

Format

{
  "runtime": {
    "host": {
      "max-response-size-mb": <integer; default: 158>
    }
  }
}

GraphQL (körning)

Global GraphQL-konfiguration.

Kapslade egenskaper

Egenskapsanteckningar

• Undersökvägar tillåts inte för egenskapen path .
• Använd depth-limit för att begränsa kapslade frågor.
• Ange allow-introspection till false för att dölja GraphQL-schemat.
• Använd multiple-mutations för att infoga flera entiteter i en enda mutation.

Format

{
  "runtime": {
    "graphql": {
      "enabled": <true> (default) | <false>
      "depth-limit": <integer|null> (default: `null`),
      "path": <string> (default: /graphql),
      "allow-introspection": <true> (default) | <false>,
      "multiple-mutations": {
        "create": {
          "enabled": <true> | <false> (default)
        }
      }
    }
  }
}

Exempel: flera mutationer

Configuration

{
  "runtime": {
    "graphql": {
      "multiple-mutations": {
        "create": {
          "enabled": true
        }
      }
    }
  },
  "entities": {
    "User": {
      "source": "dbo.Users",
      "permissions": [
        {
          "role": "anonymous",
          "actions": ["create"] // entity permissions are required
        }
      ]
    }
  }
}

GraphQL-mutation

mutation {
  createUsers(input: [
    { name: "Alice", age: 30, isAdmin: true },
    { name: "Bob", age: 25, isAdmin: false },
    { name: "Charlie", age: 35, isAdmin: true }
  ]) {
    id
    name
    age
    isAdmin
  }
}

REST (körningstid)

Global REST-konfiguration.

Kapslade egenskaper

Egenskapsanteckningar

• Om global enabled är falsespelar den enskilda entitetsnivån enabled ingen roll.
• Egenskapen path stöder inte undersökvägsvärden som /api/data.
• request-body-strict introducerades för att förenkla .NET POCO-objekt.

Format

{
  "runtime": {
    "rest": {
      "enabled": <true> (default) | <false>,
      "path": <string> (default: /api),
      "request-body-strict": <true> (default) | <false>
    }
  }
}

Exempel: request-body-strict

• Kolumner med ett default() värde ignoreras endast när INSERT deras värde i nyttolasten är null. Därför INSERT kan åtgärder i default() kolumner, när request-body-strict är true, inte resultera i explicita null värden. För att utföra det här beteendet krävs en UPDATE åtgärd.
• Kolumner med en default() ignoreras inte under UPDATE oavsett nyttolastvärde.
• Beräknade kolumner ignoreras alltid.
• Autogenererade kolumner ignoreras alltid.

Exempeltabell

CREATE TABLE Users (
    Id INT PRIMARY KEY IDENTITY, -- auto-generated column
    Name NVARCHAR(50) NOT NULL,
    Age INT DEFAULT 18, -- column with default
    IsAdmin BIT DEFAULT 0, -- column with default
    IsMinor AS IIF(Age <= 18, 1, 0) -- computed column
);

Begär nyttolast

{
  "Id": 999,
  "Name": "Alice",
  "Age": null,
  "IsAdmin": null,
  "IsMinor": false,
  "ExtraField": "ignored"
}

Infoga beteende när request-body-strict = false

INSERT INTO Users (Name) VALUES ('Alice');
-- Default values for Age (18) and IsAdmin (0) are applied by the database.
-- IsMinor is ignored because it’s a computed column.
-- ExtraField is ignored.
-- The database generates the Id value.

Svarslast

{
  "Id": 1,          // Auto-generated by the database
  "Name": "Alice",
  "Age": 18,        // Default applied
  "IsAdmin": false, // Default applied
  "IsMinor": true   // Computed
}

Uppdatera beteende när request-body-strict = false

UPDATE Users
SET Name = 'Alice Updated', Age = NULL
WHERE Id = 1;
-- IsMinor and ExtraField are ignored.

Svarslast

{
  "Id": 1,
  "Name": "Alice Updated",
  "Age": null,
  "IsAdmin": false,
  "IsMinor": false // Recomputed by the database (false when age is `null`)
}

CORS (värdkörning)

Global CORS-konfiguration.

Kapslade egenskaper

Format

{
  "runtime": {
    "host": {
      "cors": {
        "allow-credentials": <true> | <false> (default),
        "origins": ["<array-of-strings>"]
      }
    }
  }
}

Provider (Autentiseringsvärdkörning)

Väljer autentiseringsmetod. Varje provider validerar identiteten på olika sätt. Stegvis konfiguration finns i instruktionsguiderna i följande tabell.

Providersammanfattning

Oautentiserad (standard)

När Unauthenticated har angetts (eller ingen provider har angetts) inspekterar eller validerar INTE DAB någon JWT. Alla begäranden körs som anonymous rollen . En klientdelstjänst som Azure API Management eller en programgateway kan fortfarande hantera autentiserings- eller åtkomstprinciper innan begäranden når DAB, men DAB fortsätter endast att auktorisera som anonymous.

{
  "host": {
    "authentication": {
      "provider": "Unauthenticated"
    }
  }
}

AppService

Litar på identitetshuvuden som matas in av Azure App Service EasyAuth.

{
  "host": {
    "authentication": {
      "provider": "AppService"
    }
  }
}

EntraID

Validerar JWT-token som utfärdats av Microsoft Entra-ID.

{
  "host": {
    "authentication": {
      "provider": "EntraId",
      "jwt": {
        "audience": "<application-id>",
        "issuer": "https://login.microsoftonline.com/<tenant-id>/v2.0"
      }
    }
  }
}

Skräddarsydd

Validerar JWT-token från identitetsprovidrar från tredje part.

{
  "host": {
    "authentication": {
      "provider": "Custom",
      "jwt": {
        "audience": "<api-audience>",
        "issuer": "https://<your-idp-domain>/"
      }
    }
  }
}

Simulator

Simulerar autentisering för lokal utveckling och testning.

{
  "host": {
    "authentication": {
      "provider": "Simulator"
    }
  }
}

Val av roll

För alla leverantörer utom Simulator X-MS-API-ROLE väljer rubriken vilken roll som ska användas från den autentiserade användarens anspråk. Om den utelämnas använder begäran systemrollen Authenticated . Mer information om rollutvärdering finns i Översikt över auktorisering.

JWT (autentiseringsvärdkörning)

Global JSON-webbtokenkonfiguration (JWT).

Kapslade egenskaper

* Både audience och issuer krävs när objektet jwt finns. Själva jwt objektet krävs när providern är EntraID, AzureADeller Custom.

Format

{
  "runtime": {
    "host": {
      "authentication": {
        "jwt": {
          "audience": "<client-id>",
          "issuer": "<issuer-url>"
        }
      }
    }
  }
}

Sidnumrering (Runtime)

Globala sidnumreringsgränser för REST- och GraphQL-slutpunkter.

Kapslade egenskaper

Värden med maximal sidstorlek som stöds

Standardvärden för sidstorlek som stöds

Beteende för next-link-relative

När next-link-relative är trueanvänder sidnumreringsvärden nextLink relativa URL:er i stället för absoluta URL:er.

Format

{
  "runtime": {
    "pagination": {
      "max-page-size": <integer; default: 100000>,
      "default-page-size": <integer; default: 100>,
      "next-link-relative": <boolean; default: false>
    }
  }
}

Exempel: Växling i REST

Request

GET https://localhost:5001/api/users

Svarslast

{
  "value": [
    {
      "Id": 1,
      "Name": "Alice",
      "Age": 30,
      "IsAdmin": true,
      "IsMinor": false
    },
    {
      "Id": 2,
      "Name": "Bob",
      "Age": 17,
      "IsAdmin": false,
      "IsMinor": true
    }
  ],
  "nextLink": "https://localhost:5001/api/users?$after=W3siRW50aXR5TmFtZSI6InVzZXJzIiwiRmllbGROYW1lI=="
}

Begär nästa sida

GET https://localhost:5001/api/users?$after=W3siRW50aXR5TmFtZSI6InVzZXJzIiwiRmllbGROYW1lI==

Exempel: Växling i GraphQL

Begär nyttolast (fråga)

query {
  users {
    items {
      Id
      Name
      Age
      IsAdmin
      IsMinor
    }
    hasNextPage
    endCursor
  }
}

Svarslast

{
  "data": {
    "users": {
      "items": [
        {
          "Id": 1,
          "Name": "Alice",
          "Age": 30,
          "IsAdmin": true,
          "IsMinor": false
        },
        {
          "Id": 2,
          "Name": "Bob",
          "Age": 17,
          "IsAdmin": false,
          "IsMinor": true
        }
      ],
      "hasNextPage": true,
      "endCursor": "W3siRW50aXR5TmFtZSI6InVzZXJzIiwiRmllbGROYW1lI=="
    }
  }
}

Begär nästa sida

query {
  users(after: "W3siRW50aXR5TmFtZSI6InVzZXJzIiwiRmllbGROYW1lI==") {
    items {
      Id
      Name
      Age
      IsAdmin
      IsMinor
    }
    hasNextPage
    endCursor
  }
}

Exempel: Åtkomst i max-page-size begäranden

max-page-size Använd värdet genom att ange $limit (REST) eller first (GraphQL) till -1.

REST

GET https://localhost:5001/api/users?$limit=-1

GraphQL

query {
  users(first: -1) {
    items {
      ...
    }
  }
}

Komprimering (körning)

Http-svarskomprimeringskonfiguration. När det är aktiverat komprimerar DAB svarskroppar för att minska nyttolaststorlekarna och förbättra överföringshastigheterna.

Kapslade egenskaper

Värden som stöds för level

HTTP-klienthuvuden

Komprimering anropas av klientens Accept-Encoding huvud. Algoritmer som stöds är Gzip och Brotli. Inställningen level konfigurerar komprimeringsstrategin när både klienten och servern stöder flera algoritmer.

Rubriker som stöds

Format

{
  "runtime": {
    "compression": {
      "level": <"optimal"> (default) | <"fastest"> | <"none">
    }
  }
}

Example

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

Cache (körning)

Global cachekonfiguration.

Kapslade egenskaper

Format

{
  "runtime": {
    "cache":  {
      "enabled": <boolean>,
      "ttl-seconds": <integer>,
      "level-2": {
        "enabled": <boolean>,
        "provider": "redis",
        "connection-string": <string>,
        "partition": <string>
      }
    }
  }
}

När level-2.enabled är trueanvänder DAB den konfigurerade distribuerade cacheprovidern utöver det lokala minnesinterna cacheminnet. En entitet som konfigurerats med cachenivå L1L2 kontrollerar först den lokala cachen och sedan distribuerad cache innan den går till databasen.

Telemetri (körning)

Global telemetrikonfiguration.

Kapslade egenskaper

Konfigurerar loggning av verbositet per namnområde. Den här konfigurationen följer standardkonventionerna för .NET-loggning och tillåter detaljerad kontroll, även om den förutsätter viss förtrogenhet med interna data-API-byggare. Data-API-byggare är öppen källkod: https://aka.ms/dab

Format

{
  "runtime": {
    "telemetry": {
      "log-level": {
        "namespace": "log-level",
        "namespace": "log-level"
      }
    }
  }
}

Example

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

Application Insights (telemetri)

Konfigurerar loggning till Application Insights.

Kapslade egenskaper

Format

{
  "runtime": {
    "telemetry": {
      "application-insights": {
        "enabled": <true; default: true> | <false>
        "connection-string": <string>
      }
    }
  }
}

OpenTelemetry (telemetri)

Konfigurerar loggning till Öppna telemetri.

Kapslade egenskaper

Flera rubriker är , avgränsade (kommatecken).

Format

{
  "runtime": {
    "telemetry": {
      "open-telemetry": {
        "enabled": <true> (default) | <false>,
        "endpoint": <string>,
        "headers": <string>,
        "service-name": <string> (default: "dab"),
        "exporter-protocol": <"grpc" (default) | "httpprotobuf">
      }
    }
  }
}

Example

{
  "runtime": {
    "telemetry": {
      "open-telemetry": {
        "enabled": true,
        // a gRPC endpoint example
        "endpoint": "http://localhost:4317",
        // an HTTP/protobuf endpoint example
        "endpoint": "http://localhost:4318/v1/metrics",
        "headers": "api-key=key,other-config-value=value",
        "service-name": "dab",
      }
    }
  }
}

Läs mer om OTEL_EXPORTER_OTLP_HEADERS.

Azure Log Analytics (telemetri)

Konfigurerar loggning till Azure Log Analytics via en datainsamlingsslutpunkt. När det är aktiverat skickar DAB telemetridata i batchar med ett konfigurerbart intervall.

Kapslade egenskaper

* auth krävs när enabled är true.

* Krävs när enabled är true.

• dab-identifier– en etikett som skickas till Log Analytics för att skilja vilka loggar som kommer från Data API Builder.
• flush-interval-seconds– tidsintervallet (i sekunder) mellan att skicka batchar med telemetridata.
• custom-table-name– namnet på den anpassade tabellen i Azure Log Analytics där data lagras.
• dcr-immutable-id– det oföränderliga ID:t för datainsamlingsregeln som definierar hur data samlas in.
• dce-endpoint– den datainsamlingsslutpunkts-URL som används för att skicka telemetridata.

Format

{
  "runtime": {
    "telemetry": {
      "azure-log-analytics": {
        "enabled": <true> | <false> (default),
        "dab-identifier": <string> (default: "DabLogs"),
        "flush-interval-seconds": <integer> (default: 5),
        "auth": {
          "custom-table-name": "<string>",
          "dcr-immutable-id": "<string>",
          "dce-endpoint": "<string>"
        }
      }
    }
  }
}

Example

{
  "runtime": {
    "telemetry": {
      "azure-log-analytics": {
        "enabled": true,
        "dab-identifier": "MyDabInstance",
        "flush-interval-seconds": 10,
        "auth": {
          "custom-table-name": "DabTelemetry_CL",
          "dcr-immutable-id": "dcr-abc123def456",
          "dce-endpoint": "https://my-dce.eastus-1.ingest.monitor.azure.com"
        }
      }
    }
  }
}

Fil (telemetri)

Konfigurerar skrivning av telemetriloggar till en lokal fil. När det är aktiverat skriver DAB strukturerade loggutdata till den angivna filsökvägen med konfigurerbara rullande intervall och storleksgränser.

Kapslade egenskaper

* path krävs när enabled är true.

Rullande intervallvärden

Format

{
  "runtime": {
    "telemetry": {
      "file": {
        "enabled": <true> | <false> (default),
        "path": <string> (default: "/logs/dab-log.txt"),
        "rolling-interval": <"Day"> (default) | <"Minute"> | <"Hour"> | <"Month"> | <"Year"> | <"Infinite">,
        "retained-file-count-limit": <integer> (default: 1),
        "file-size-limit-bytes": <integer> (default: 1048576)
      }
    }
  }
}

Example

{
  "runtime": {
    "telemetry": {
      "file": {
        "enabled": true,
        "path": "/var/log/dab/dab-telemetry.txt",
        "rolling-interval": "Hour",
        "retained-file-count-limit": 24,
        "file-size-limit-bytes": 5242880
      }
    }
  }
}

MCP (runtime)

Konfigurerar MCP-servern (SQL Model Context Protocol), som exponerar databasentiteter som MCP-verktyg för AI-agenter.

Kapslade egenskaper

Egenskapen dml-tools accepterar ett booleskt värde för att aktivera eller inaktivera alla verktyg eller ett objekt för att styra enskilda verktyg:

Verktyget aggregate-records accepterar ett booleskt objekt eller ett objekt med fler inställningar:

Format

{
  "runtime": {
    "mcp": {
      "enabled": <true> (default) | <false>,
      "path": <string> (default: "/mcp"),
      "description": <string>,
      "dml-tools": {
        "describe-entities": <true> | <false>,
        "create-record": <true> | <false>,
        "read-records": <true> | <false>,
        "update-record": <true> | <false>,
        "delete-record": <true> | <false>,
        "execute-entity": <true> | <false>,
        "aggregate-records": {
          "enabled": <true> | <false>,
          "query-timeout": <integer; default: 30>
        }
      }
    }
  }
}

Example

{
  "runtime": {
    "mcp": {
      "enabled": true,
      "dml-tools": {
        "describe-entities": true,
        "create-record": true,
        "read-records": true,
        "update-record": true,
        "delete-record": true,
        "execute-entity": true,
        "aggregate-records": {
          "enabled": true,
          "query-timeout": 30
        }
      }
    }
  }
}

Om du vill aktivera eller inaktivera alla DML-verktyg samtidigt anger du "dml-tools" till true eller false.

När du inaktiverar ett verktyg på körningsnivå visas verktyget aldrig i MCP-svaret tools/list och kan inte anropas, oavsett behörigheter på entitetsnivå. Mer information om enskilda DML-verktyg finns i Verktyg för datamanipuleringsspråk (DML).

Använda CLI

dab configure --runtime.mcp.enabled true
dab configure --runtime.mcp.path "/mcp"
dab configure --runtime.mcp.dml-tools.describe-entities true
dab configure --runtime.mcp.dml-tools.create-record true
dab configure --runtime.mcp.dml-tools.read-records true
dab configure --runtime.mcp.dml-tools.update-record true
dab configure --runtime.mcp.dml-tools.delete-record true
dab configure --runtime.mcp.dml-tools.execute-entity true
dab configure --runtime.mcp.dml-tools.aggregate-records.enabled true

Hälsa (körning)

Konfiguration av slutpunkt för global hälsokontroll (/health).

Kapslade egenskaper

Beteende i utveckling jämfört med produktion

Format

{
  "health": {
    "enabled": <true> (default) | <false>,
    "roles": [ <string> ], // required in production
    "cache-ttl-seconds": <integer; default: 5>,
    "max-query-parallelism": <integer; default: 4>
  }
}

Example

{
  "health": {
    "enabled": true,
    "roles": ["admin", "support"],
    "cache-ttl-seconds": 10,
    "max-query-parallelism": 6
  }
}