Команда configure

Настройте свойства среды выполнения и источника данных, которые не относятся к сущностям в существующем файле конфигурации построителя данных. Неопределенные параметры оставляют существующие значения неизменными. Если любой указанный параметр недопустим, все обновление завершается ошибкой (все или ничего).

Акронимы, используемые в этой ссылке: протокол контекста модели (MCP), язык обработки данных (DML), время жизни (TTL), веб-токен JSON (JWT), кандидат выпуска (RC), правило сбора данных (DCR) и конечная точка сбора данных (DCE).

Замечание

Эта команда не изменяет entities раздел. Используется dab update для изменений сущностей.

Синтаксис

dab configure [options]

Это важно

Параметры OpenTelemetry и Application Insights настраиваются с dab add-telemetryпомощью , а не dab configure. См. основные сведения о концепции, мониторе/ open-telemetry.md и концепции/monitor/application-insights.md.

Краткий обзор

Вариант Сводка
-c, --config Путь к файлу конфигурации (по умолчанию dab-config.json).

Раздел источника данных

Вариант Сводка
--data-source.database-type Задайте тип базы данных.
--data-source.connection-string Задайте строку подключения к базе данных.
--data-source.options.database Имя базы данных для Cosmos DB для NoSql.
--data-source.options.container Имя контейнера для Cosmos DB для NoSql.
--data-source.options.schema Путь схемы для Cosmos DB для NoSql.
--data-source.options.set-session-context Включение или отключение контекста сеанса. По умолчанию: false.
--data-source.health.enabled Включите или отключите проверку работоспособности источника данных.
--data-source.health.name Идентификатор источника данных в отчете проверки работоспособности.
--data-source.health.threshold-ms Пороговое значение запроса проверки работоспособности в миллисекундах.
--data-source.user-delegated-auth.enabled Включите делегированную пользователем проверку подлинности OBO.
--data-source.user-delegated-auth.provider Задайте поставщик удостоверений OBO.
--data-source.user-delegated-auth.database-audience Целевая аудитория для нижестоящего токена SQL.
--data-source-files Ссылка на дополнительные файлы конфигурации источника данных.

Раздел GraphQL

Вариант Сводка
--runtime.graphql.depth-limit Ограничение максимальной глубины запроса.
--runtime.graphql.enabled Включите или отключите конечную точку GraphQL.
--runtime.graphql.path Настройте путь конечной точки GraphQL.
--runtime.graphql.allow-introspection Разрешить или запретить introspection GraphQL.
--runtime.graphql.multiple-mutations.create.enabled Включение нескольких изменений.

Раздел REST

Вариант Сводка
--runtime.rest.enabled Включите или отключите конечную точку REST.
--runtime.rest.path Настройте путь конечной точки REST.
--runtime.rest.request-body-strict Применение строгой проверки текста запроса REST.

Раздел разбиения на страницы

Вариант Сводка
--runtime.pagination.max-page-size Максимальный размер страницы для результатов с разбивкой на страницы.
--runtime.pagination.default-page-size Размер страницы по умолчанию для результатов с разбивкой на страницы.
--runtime.pagination.next-link-relative Используйте относительные URL-адреса в следующих ссылках на страницы REST.

Раздел MCP

Вариант Сводка
--runtime.mcp.enabled Включите или отключите конечную точку MCP.
--runtime.mcp.path Настройте путь конечной точки MCP.
--runtime.mcp.description Задайте описание сервера MCP.
--runtime.mcp.dml-tools Включите или отключите все средства MCP DML.
--runtime.mcp.dml-tools.describe-entities Включите или отключите средство описания сущностей.
--runtime.mcp.dml-tools.create-record Включите или отключите средство создания записи.
--runtime.mcp.dml-tools.read-records Включите или отключите средство чтения записей.
--runtime.mcp.dml-tools.update-record Включите или отключите средство записи обновлений.
--runtime.mcp.dml-tools.delete-record Включите или отключите средство удаления записи.
--runtime.mcp.dml-tools.execute-entity Включите или отключите средство execute-entity.
--runtime.mcp.dml-tools.aggregate-records Включите или отключите средство агрегирования записей.
--runtime.mcp.dml-tools.aggregate-records.query-timeout Время ожидания выполнения в секундах для агрегатных записей.

Раздел кэша

Вариант Сводка
--runtime.cache.enabled Включение или отключение глобального кэша.
--runtime.cache.ttl-seconds Срок жизни глобального кэша в секундах.
--runtime.compression.level Задайте уровень сжатия http-ответа.

Раздел узла

Вариант Сводка
--runtime.host.mode Задайте режим узла: разработка или рабочая среда.
--runtime.host.max-response-size-mb Максимальный размер отклика в мегабайтах.
--runtime.host.cors.origins Разрешенные источники CORS.
--runtime.host.cors.allow-credentials Задайте учетные данные allow-credentials CORS.
--runtime.host.authentication.provider Поставщик проверки подлинности.
--runtime.host.authentication.jwt.audience Утверждение аудитории JWT.
--runtime.host.authentication.jwt.issuer Утверждение издателя JWT.

Раздел работоспособности

Вариант Сводка
--runtime.health.enabled Включите или отключите глобальную конечную точку работоспособности.
--runtime.health.cache-ttl-seconds Кэшируйте TTL для отчетов проверки работоспособности.
--runtime.health.max-query-parallelism Максимальное число одновременных запросов проверки работоспособности.
--runtime.health.roles Роли, разрешенные для просмотра комплексных результатов работоспособности.

Действующие разрешения

Вариант Сводка
--show-effective-permissions Отображение разрешенных разрешений для всех сущностей.

Раздел Key Vault

Вариант Сводка
--azure-key-vault.endpoint Базовая конечная точка Azure Key Vault.
--azure-key-vault.retry-policy.mode Режим политики повтора.
--azure-key-vault.retry-policy.max-count Максимальное число повторных попыток.
--azure-key-vault.retry-policy.delay-seconds Задержка между повторными попытками.
--azure-key-vault.retry-policy.max-delay-seconds Максимальная задержка для экспоненциальных повторных попыток.
--azure-key-vault.retry-policy.network-timeout-seconds Время ожидания для сетевых вызовов.

Раздел телеметрии

Вариант Сводка
--runtime.telemetry.log-level Настройте детализацию ведения журнала по пространству имен.
--runtime.telemetry.azure-log-analytics.enabled Включите данные телеметрии Azure Log Analytics.
--runtime.telemetry.azure-log-analytics.dab-identifier Различает источник журнала.
--runtime.telemetry.azure-log-analytics.flush-interval-seconds Очистка каденции в секундах.
--runtime.telemetry.azure-log-analytics.auth.custom-table-name Имя настраиваемой таблицы.
--runtime.telemetry.azure-log-analytics.auth.dcr-immutable-id Идентификатор правила сбора данных.
--runtime.telemetry.azure-log-analytics.auth.dce-endpoint Конечная точка сбора данных.
--runtime.telemetry.file.enabled Включите данные телеметрии приемника файлов.
--runtime.telemetry.file.path Путь к файлу журнала.
--runtime.telemetry.file.rolling-interval Скользящий интервал.
--runtime.telemetry.file.retained-file-count-limit Максимальное количество сохраненных файлов.
--runtime.telemetry.file.file-size-limit-bytes Максимальный размер для каждого файла перед перекатом.

-c, --config

Путь к файлу конфигурации. dab-config.json По умолчанию, если dab-config.<DAB_ENVIRONMENT>.json не существует, где DAB_ENVIRONMENT находится переменная среды.

Example

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

--data-source.database-type

Тип базы данных.

Допустимые значения:

  • MSSQL
  • DWSQL
  • PostgreSQL
  • CosmosDB_PostgreSQL
  • CosmosDB_NoSQL
  • MySQL

Example

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

Результирующая конфигурация

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

--data-source.connection-string

Строка подключения для источника данных.

Example

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

Результирующая конфигурация

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

--data-source-files

Ссылка на дополнительные файлы конфигурации источника данных из корневого файла конфигурации.

Example

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

Результирующая конфигурация

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

--data-source.options.database

Имя базы данных для Cosmos DB для NoSql.

Example

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

Результирующая конфигурация

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

--data-source.options.container

Имя контейнера для Cosmos DB для NoSql.

Example

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

Результирующая конфигурация

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

--data-source.options.schema

Путь схемы для Cosmos DB для NoSql.

Example

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

Результирующая конфигурация

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

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

Включите контекст сеанса.

Допустимые значения:

  • true
  • false (по умолчанию)

Example

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

Результирующая конфигурация

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

--data-source.health.enabled

Включите или отключите проверку работоспособности источника данных. По умолчанию — true.

Example

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

Результирующая конфигурация

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

--data-source.health.name

Идентификатор источника данных в отчете проверки работоспособности.

Example

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

Результирующая конфигурация

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

--data-source.health.threshold-ms

Максимальная длительность в миллисекундах для запроса проверки работоспособности источника данных. По умолчанию — 1000.

Example

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

Результирующая конфигурация

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

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

Включите или отключите проверку подлинности, делегированную пользователемBehalf-Of (OBO). Поддерживается только для mssql источников данных.

Замечание

Функции построителя данных 2.0, описанные в этом разделе, находятся в предварительной версии и могут измениться до общедоступной доступности. Дополнительные сведения см. в статье "Новые возможности" версии 2.0.

Example

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

Результирующая конфигурация

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

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

Задайте поставщик удостоверений для проверки подлинности, делегированной пользователем вBehalf-Of (OBO). В настоящее время поддерживается только EntraId .

Замечание

Функции построителя данных 2.0, описанные в этом разделе, находятся в предварительной версии и могут измениться до общедоступной доступности. Дополнительные сведения см. в статье "Новые возможности" версии 2.0.

Example

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

Результирующая конфигурация

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

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

Задайте целевую аудиторию для нижестоящего маркера SQL при включении OBO.

Example

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

Результирующая конфигурация

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

--runtime.graphql.depth-limit

Максимальная допустимая глубина вложенного запроса.

Допустимые значения:

  • $(0,2147483647]$ (включительно)
  • -1 удаление ограничения

Example

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

Результирующая конфигурация

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

--runtime.graphql.enabled

Включите конечную точку GraphQL DAB.

Example

dab configure \
  --runtime.graphql.enabled false

Результирующая конфигурация

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

--runtime.graphql.path

Настройка пути конечной точки GraphQL в DAB. Путь префикса с /.

Example

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

Результирующая конфигурация

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

--runtime.graphql.allow-introspection

Разрешить или запретить запросы introspection GraphQL.

Example

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

Результирующая конфигурация

{
  "runtime": {
    "graphql": {
      "allow-introspection": false
    }
  }
}

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

Включите или отключите операции создания нескольких мутаций в созданной схеме GraphQL.

Example

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

Результирующая конфигурация

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

--runtime.rest.enabled

Включите конечную точку REST DAB.

Example

dab configure \
  --runtime.rest.enabled false

Результирующая конфигурация

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

--runtime.rest.path

Настройте путь конечной точки REST DAB. Путь префикса с /.

Example

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

Результирующая конфигурация

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

--runtime.rest.request-body-strict

Запретить ненужные поля текста запроса REST.

Example

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

Результирующая конфигурация

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

--runtime.pagination.max-page-size

Максимальный размер страницы для результатов с разбивкой на страницы. По умолчанию — 100000. Минимальное значение — 1.

Example

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

Результирующая конфигурация

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

--runtime.pagination.default-page-size

Размер страницы по умолчанию для результатов с разбивкой на страницы. По умолчанию — 100. Минимальное значение — 1.

Example

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

Результирующая конфигурация

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

--runtime.pagination.next-link-relative

Используйте относительные URL-адреса вместо абсолютных URL-адресов в значениях разбиения nextLink на страницы REST. По умолчанию — false.

Example

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

Результирующая конфигурация

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

--runtime.mcp.enabled

Включите конечную точку MCP DAB.

Замечание

Этот параметр доступен в предварительной версии CLI построителя данных 2.0. Установите последнюю предварительную версию с dotnet tool install microsoft.dataapibuilder --prereleaseпомощью .

Example

dab configure \
  --runtime.mcp.enabled false

Результирующая конфигурация

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

--runtime.mcp.path

Настройте путь конечной точки MCB DAB. Путь префикса с /.

Замечание

Этот параметр доступен в предварительной версии CLI построителя данных 2.0. Установите последнюю предварительную версию с dotnet tool install microsoft.dataapibuilder --prereleaseпомощью .

Example

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

Результирующая конфигурация

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

--runtime.mcp.description

Задайте для инициализированного ответа описание сервера MCP.

Замечание

Этот параметр доступен в предварительной версии CLI построителя данных 2.0. Установите последнюю предварительную версию с dotnet tool install microsoft.dataapibuilder --prereleaseпомощью .

Example

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

Результирующая конфигурация

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

--runtime.mcp.dml-tools

Включите конечную точку средств MCP DML DAB.

Замечание

Этот параметр доступен в предварительной версии CLI построителя данных 2.0. Установите последнюю предварительную версию с dotnet tool install microsoft.dataapibuilder --prereleaseпомощью .

Дополнительные сведения о средствах DML MCP см. в статье SQL MCP Server для языка языка обработки данных.

Example

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

Результирующая конфигурация

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

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

Включите средство MCP DAB для описания сущностей.

Замечание

Этот параметр доступен в предварительной версии CLI построителя данных 2.0. Установите последнюю предварительную версию с dotnet tool install microsoft.dataapibuilder --prereleaseпомощью .

Example

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

Результирующая конфигурация

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

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

Включите средство создания записей DAB в DAB.

Замечание

Этот параметр доступен в предварительной версии CLI построителя данных 2.0. Установите последнюю предварительную версию с dotnet tool install microsoft.dataapibuilder --prereleaseпомощью .

Example

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

Результирующая конфигурация

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

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

Включите средство чтения записей MCB DAB.

Замечание

Этот параметр доступен в предварительной версии CLI построителя данных 2.0. Установите последнюю предварительную версию с dotnet tool install microsoft.dataapibuilder --prereleaseпомощью .

Example

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

Результирующая конфигурация

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

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

Включите средство записи обновления MCP DAB.

Замечание

Этот параметр доступен в предварительной версии CLI построителя данных 2.0. Установите последнюю предварительную версию с dotnet tool install microsoft.dataapibuilder --prereleaseпомощью .

Example

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

Результирующая конфигурация

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

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

Включите средство удаления записи MCP в DAB.

Замечание

Этот параметр доступен в предварительной версии CLI построителя данных 2.0. Установите последнюю предварительную версию с dotnet tool install microsoft.dataapibuilder --prereleaseпомощью .

Example

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

Результирующая конфигурация

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

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

Включите средство выполнения сущности MCB в DAB.

Замечание

Этот параметр доступен в предварительной версии CLI построителя данных 2.0. Установите последнюю предварительную версию с dotnet tool install microsoft.dataapibuilder --prereleaseпомощью .

Example

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

Результирующая конфигурация

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

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

Включите средство агрегирования записей MCB DAB.

Замечание

Этот параметр доступен в предварительной версии CLI построителя данных 2.0. Установите последнюю предварительную версию с dotnet tool install microsoft.dataapibuilder --prereleaseпомощью .

Example

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

Результирующая конфигурация

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

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

Задайте время ожидания выполнения в секундах для средства MCP агрегатных записей.

По умолчанию: 30. Диапазон: 1–600.

Замечание

Этот параметр доступен в предварительной версии CLI построителя данных 2.0. Установите последнюю предварительную версию с dotnet tool install microsoft.dataapibuilder --prereleaseпомощью .

Example

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

Результирующая конфигурация

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

--runtime.cache.enabled

Включение кэша DAB глобально. Кроме того, необходимо включить кэширование для каждой сущности.

Example

dab configure \
  --runtime.cache.enabled true

Результирующая конфигурация

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

--runtime.cache.ttl-seconds

Настройте глобальное время по умолчанию кэша DAB для жизни в секундах.

Example

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

Результирующая конфигурация

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

--runtime.compression.level

Замечание

Функции построителя данных 2.0, описанные в этом разделе, находятся в предварительной версии и могут измениться до общедоступной доступности. Дополнительные сведения см. в статье "Новые возможности" версии 2.0.

Задайте уровень сжатия http-ответа.

Допустимые значения:

  • optimal— балансирует коэффициент сжатия и скорость (по умолчанию)
  • fastest— приоритеты скорости сжатия по сравнению с соотношением
  • none— отключает сжатие

Example

dab configure \
  --runtime.compression.level optimal

Результирующая конфигурация

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

--runtime.host.mode

Задайте для узла режим выполнения DAB.

Допустимые значения:

  • Development
  • Production

Example

dab configure \
  --runtime.host.mode Development

Результирующая конфигурация

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

--runtime.host.max-response-size-mb

Максимальный размер в мегабайтах для ответа базы данных в одном результате. По умолчанию — 158.

Example

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

Результирующая конфигурация

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

--runtime.host.cors.origins

Перезапись разрешенных источников в CORS. Укажите значения в виде разделенного пробелом списка.

Example

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

Результирующая конфигурация

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

--runtime.host.cors.allow-credentials

Задайте значение заголовка Access-Control-Allow-Credentials .

Example

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

Результирующая конфигурация

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

--runtime.host.authentication.provider

Настройте имя поставщика проверки подлинности.

Example

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

Результирующая конфигурация

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

--runtime.host.authentication.jwt.audience

Настройте одного или нескольких предполагаемых получателей токена JWT.

Example

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

Результирующая конфигурация

{
  "runtime": {
    "host": {
      "authentication": {
        "jwt": {
          "audience": "api://my-app"
        }
      }
    }
  }
}

--runtime.host.authentication.jwt.issuer

Настройте сущность, выдавающую токен JWT.

Example

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

Результирующая конфигурация

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

--runtime.health.enabled

Включите или отключите глобальную конечную точку работоспособности. По умолчанию — true.

Example

dab configure \
  --runtime.health.enabled true

Результирующая конфигурация

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

--runtime.health.cache-ttl-seconds

Время жизни в секундах для кэшированных отчетов проверки работоспособности. По умолчанию — 5. Минимальное значение — 0.

Example

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

Результирующая конфигурация

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

--runtime.health.max-query-parallelism

Максимальное число одновременных запросов проверки работоспособности. По умолчанию — 4. Значения зажаты в поддерживаемом диапазоне 18.

Example

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

Результирующая конфигурация

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

--runtime.health.roles

Роли, разрешенные для просмотра комплексных результатов работоспособности. В рабочем режиме настройте по крайней мере одну роль.

Example

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

Результирующая конфигурация

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

--azure-key-vault.endpoint

Настройте URL-адрес конечной точки Azure Key Vault.

Example

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

Результирующая конфигурация

{
  "azure-key-vault": {
    "endpoint": "https://my-vault.vault.azure.net"
  }
}

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

Настройте режим политики повторных попыток.

Допустимые значения:

  • fixed
  • exponential

Example

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

Результирующая конфигурация

{
  "azure-key-vault": {
    "retry-policy": {
      "mode": "fixed"
    }
  }
}

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

Настройте максимальное количество попыток повторных попыток.

Example

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

Результирующая конфигурация

{
  "azure-key-vault": {
    "retry-policy": {
      "max-count": 5
    }
  }
}

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

Настройте начальную задержку между повторными попытками в секундах.

Example

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

Результирующая конфигурация

{
  "azure-key-vault": {
    "retry-policy": {
      "delay-seconds": 2
    }
  }
}

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

Настройте максимальную задержку между повторными попытками в секундах (для экспоненциального режима).

Example

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

Результирующая конфигурация

{
  "azure-key-vault": {
    "retry-policy": {
      "max-delay-seconds": 30
    }
  }
}

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

Настройте время ожидания сети для запросов в секундах.

Example

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

Результирующая конфигурация

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

Настройте детализацию ведения журнала по пространству имен. Используйте default для глобального резервного уровня или укажите пространство имен или имя класса после --runtime.telemetry.log-level..

Допустимые значения: Trace, Debug, InformationWarning, Error, Critical; None

Example

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

Результирующая конфигурация

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

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

Включите или отключите Azure Log Analytics.

Example

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

Результирующая конфигурация

{
  "runtime": {
    "telemetry": {
      "azure-log-analytics": {
        "enabled": true
      }
    }
  }
}

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

Настройте строку идентификатора DAB, используемую в Azure Log Analytics.

Example

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

Результирующая конфигурация

{
  "runtime": {
    "telemetry": {
      "azure-log-analytics": {
        "dab-identifier": "MyDab"
      }
    }
  }
}

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

Настройте интервал очистки в секундах для Azure Log Analytics.

Example

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

Результирующая конфигурация

{
  "runtime": {
    "telemetry": {
      "azure-log-analytics": {
        "flush-interval-seconds": 10
      }
    }
  }
}

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

Настройте настраиваемое имя таблицы для Azure Log Analytics.

Example

dab configure \
  --runtime.telemetry.azure-log-analytics.auth.custom-table-name MyDabLogs

Результирующая конфигурация

{
  "runtime": {
    "telemetry": {
      "azure-log-analytics": {
        "auth": {
          "custom-table-name": "MyDabLogs"
        }
      }
    }
  }
}

--runtime.telemetry.azure-log-analytics.auth.dcr-immutable-id

Настройте неизменяемый идентификатор DCR для Azure Log Analytics.

Example

dab configure \
  --runtime.telemetry.azure-log-analytics.auth.dcr-immutable-id dcr-123

Результирующая конфигурация

{
  "runtime": {
    "telemetry": {
      "azure-log-analytics": {
        "auth": {
          "dcr-immutable-id": "dcr-123"
        }
      }
    }
  }
}

--runtime.telemetry.azure-log-analytics.auth.dce-endpoint

Настройте конечную точку DCE для Azure Log Analytics.

Example

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

Результирующая конфигурация

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

Включение или отключение ведения журнала приемника файлов.

Example

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

Результирующая конфигурация

{
  "runtime": {
    "telemetry": {
      "file": {
        "enabled": true
      }
    }
  }
}

--runtime.telemetry.file.path

Настройте путь для ведения журнала приемника файлов.

Example

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

Результирующая конфигурация

{
  "runtime": {
    "telemetry": {
      "file": {
        "path": "C:\\logs\\dab-log.txt"
      }
    }
  }
}

--runtime.telemetry.file.rolling-interval

Настройте последовательный интервал для ведения журнала приемника файлов.

Допустимые значения:

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

Example

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

Результирующая конфигурация

{
  "runtime": {
    "telemetry": {
      "file": {
        "rolling-interval": "Month"
      }
    }
  }
}

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

Настройте максимальное количество сохраненных файлов.

Example

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

Результирующая конфигурация

{
  "runtime": {
    "telemetry": {
      "file": {
        "retained-file-count-limit": 5
      }
    }
  }
}

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

Настройте максимальный размер файла в байтах.

Example

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

Результирующая конфигурация

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

Отображение разрешенных разрешений для каждой сущности после применения наследования ролей. Используйте этот параметр, чтобы узнать, что каждая роль может на самом деле сделать без причины с помощью конфигурации вручную.

Замечание

Функции построителя данных 2.0, описанные в этом разделе, находятся в предварительной версии и могут измениться до общедоступной доступности. Дополнительные сведения см. в статье "Новые возможности" версии 2.0.

Example

dab configure \
  --show-effective-permissions

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

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

Пример результата

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