Aracılığıyla paylaş

configure komut

Var olan bir Data API builder yapılandırma dosyasında varlığa özgü olmayan çalışma zamanı ve veri kaynağı özelliklerini yapılandırın. Belirtilmeyen seçenekler var olan değerleri değiştirmeden bırakır. Sağlanan seçeneklerden biri geçersizse güncelleştirmenin tamamı başarısız olur (tümü veya hiçbiri).

Bu başvuruda kullanılan kısaltmalar:

MCP, Model Bağlam Protokolü anlamına gelir. DML, veri işleme dilinin kısaltmasıdır. TTL, yaşam süresi anlamına gelir. JWT, JSON Web Belirteci anlamına gelir. RC, sürüm adayı anlamına gelir. DCR, veri toplama kuralı anlamına gelir. DCE, veri toplama uç noktasının kısaltmasıdır.

Sözdizimi

dab configure [options]

Uyarı

Bu komut bölümü değiştirmez entities . Varlık değişiklikleri için kullanın dab update .

Uyarı

OpenTelemetry ve Application Insights ayarları ile dab add-telemetrydeğil ile dab configureyapılandırılır. Bkz. concept/monitor/open-telemetry.md ve concept/monitor/application-insights.md.

Hızlı bakış

Seçenek Özet
-c, --config Yapılandırma dosyasının yolu (varsayılan dab-config.json).
--data-source.database-type Veritabanı türünü ayarlayın.
--data-source.connection-string Veritabanı bağlantı dizesini ayarlayın.
--data-source.options.database NoSql için Cosmos DB veritabanı adı.
--data-source.options.container NoSql için Cosmos DB kapsayıcı adı.
--data-source.options.schema NoSql için Cosmos DB şema yolu.
--data-source.options.set-session-context Oturum bağlamı'nı etkinleştirin.
--runtime.graphql.depth-limit Maksimum sorgu derinliğini sınırlayın.
--runtime.graphql.enabled GraphQL uç noktasını etkinleştirin veya devre dışı bırakın.
--runtime.graphql.path GraphQL uç nokta yolunu özelleştirin.
--runtime.graphql.allow-introspection GraphQL introspection'a izin verme veya reddetme.
--runtime.graphql.multiple-mutations.create.enabled Çoklu değişimleri etkinleştir.
--runtime.rest.enabled REST uç noktasını etkinleştirin veya devre dışı bırakın.
--runtime.rest.path REST uç nokta yolunu özelleştirin.
--runtime.rest.request-body-strict Katı REST isteği gövdesi doğrulamayı zorunlu kılma.
--runtime.mcp.enabled MCP uç noktasını etkinleştirin veya devre dışı bırakın.
--runtime.mcp.path MCP uç noktası yolunu özelleştirin.
--runtime.mcp.dml-tools.enabled Tüm MCP DML araçlarını etkinleştirin veya devre dışı bırakın.
--runtime.mcp.dml-tools.describe-entities.enabled Describe-entities aracını etkinleştirin veya devre dışı bırakın.
--runtime.mcp.dml-tools.create-record.enabled Kayıt oluşturma aracını etkinleştirin veya devre dışı bırakın.
--runtime.mcp.dml-tools.read-records.enabled Okuma kayıtları aracını etkinleştirin veya devre dışı bırakın.
--runtime.mcp.dml-tools.update-record.enabled Güncelleştirme kaydı aracını etkinleştirin veya devre dışı bırakın.
--runtime.mcp.dml-tools.delete-record.enabled Kayıt silme aracını etkinleştirin veya devre dışı bırakın.
--runtime.mcp.dml-tools.execute-entity.enabled Execute-entity aracını etkinleştirin veya devre dışı bırakın.
--runtime.cache.enabled Genel önbelleği etkinleştirin veya devre dışı bırakın.
--runtime.cache.ttl-seconds Saniyeler içinde genel önbellek TTL'si.
--runtime.host.mode Konak modunu ayarlama: Geliştirme veya Üretim.
--runtime.host.cors.origins İzin verilen CORS kaynakları.
--runtime.host.cors.allow-credentials CORS allow-credentials'i ayarlayın.
--runtime.host.authentication.provider Kimlik doğrulama sağlayıcısı.
--runtime.host.authentication.jwt.audience JWT hedef kitle talebi.
--runtime.host.authentication.jwt.issuer JWT veren talebi.
--azure-key-vault.endpoint Azure Key Vault temel uç noktası.
--azure-key-vault.retry-policy.mode İlke modunu yeniden deneyin.
--azure-key-vault.retry-policy.max-count En fazla yeniden deneme denemesi.
--azure-key-vault.retry-policy.delay-seconds Yeniden denemeler arasındaki gecikme.
--azure-key-vault.retry-policy.max-delay-seconds Üstel yeniden denemeler için maksimum gecikme.
--azure-key-vault.retry-policy.network-timeout-seconds Ağ çağrıları için zaman aşımı.
--runtime.telemetry.azure-log-analytics.enabled Azure Log Analytics telemetrisini etkinleştirin.
--runtime.telemetry.azure-log-analytics.dab-identifier Günlük kaynağını ayırt edin.
--runtime.telemetry.azure-log-analytics.flush-interval-seconds Tempoyu saniyeler içinde boşalt.
--runtime.telemetry.azure-log-analytics.auth.custom-table-name Özel tablo adı.
--runtime.telemetry.azure-log-analytics.auth.dcr-immutable-id Veri Toplama Kuralı Kimliği.
--runtime.telemetry.azure-log-analytics.auth.dce-endpoint Veri Toplama Uç Noktası.
--runtime.telemetry.file.enabled Dosya havuzu telemetrisini etkinleştirin.
--runtime.telemetry.file.path Günlük dosyasının yolu.
--runtime.telemetry.file.rolling-interval Sıralı aralık.
--runtime.telemetry.file.retained-file-count-limit Tutulan en fazla dosya sayısı.
--runtime.telemetry.file.file-size-limit-bytes Döndürmeden önce dosya başına en büyük boyut.
--help Bu yardım ekranını görüntüleyin.
--version Sürüm bilgilerini görüntüleme.

-c, --config

Yapılandırma dosyasının yolu. Varsayılan olarakdab-config.json, ortam değişkeni olduğu dab-config.<DAB_ENVIRONMENT>.json sürece DAB_ENVIRONMENT olarak ayarlanır.

Example

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

--data-source.database-type

Veritabanı türü.

İzin verilen değerler:

  • MSSQL
  • PostgreSQL
  • CosmosDB_NoSQL
  • MySQL

Example

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

Sonuçta elde edilen yapılandırma

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

--data-source.connection-string

Veri kaynağı için bağlantı dizesi.

Example

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

--data-source.options.database

NoSql için Cosmos DB veritabanı adı.

Example

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

--data-source.options.container

NoSql için Cosmos DB kapsayıcı adı.

Example

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

--data-source.options.schema

NoSql için Cosmos DB şema yolu.

Example

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

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

Oturum bağlamı'nı etkinleştirin.

İzin verilen değerler:

  • true (varsayılan)
  • false

Example

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

Sonuçta elde edilen yapılandırma

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

--runtime.graphql.depth-limit

İç içe sorgunun izin verilen maksimum derinliği.

İzin verilen değerler:

  • $(0,2147483647]$ (dahil)
  • -1 sınırı kaldırmak için

Example

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

Sonuçta elde edilen yapılandırma

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

--runtime.graphql.enabled

DAB'nin GraphQL uç noktasını etkinleştirin.

Example

dab configure \
  --runtime.graphql.enabled false

--runtime.graphql.path

DAB'nin GraphQL uç nokta yolunu özelleştirin. ile /ön ek yolu.

Example

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

--runtime.graphql.allow-introspection

GraphQL introspection isteklerine izin verin veya reddedin.

Example

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

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

Oluşturulan GraphQL şemasında çoklu mutasyon oluşturma işlemlerini etkinleştirin veya devre dışı bırakın.

Example

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

--runtime.rest.enabled

DAB'nin REST uç noktasını etkinleştirin.

Example

dab configure \
  --runtime.rest.enabled false

--runtime.rest.path

DAB'ın REST uç nokta yolunu özelleştirin. ile /ön ek yolu.

Example

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

Sonuçta elde edilen yapılandırma

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

--runtime.rest.request-body-strict

Gereksiz REST isteği gövde alanlarını yasakla.

Example

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

--runtime.mcp.enabled

DAB'nin MCP uç noktasını etkinleştirin.

Uyarı

Bu seçenek yalnızca v1.7 öncesi CLI'de (şu anda RC) kullanılabilir. ile yükleyin dotnet tool install microsoft.dataapibuilder --prerelease.

Example

dab configure \
  --runtime.mcp.enabled false

Sonuçta elde edilen yapılandırma

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

--runtime.mcp.path

DAB'ın MCP uç nokta yolunu özelleştirin. ile /ön ek yolu.

Uyarı

Bu seçenek yalnızca v1.7 öncesi CLI'de (şu anda RC) kullanılabilir. ile yükleyin dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

Sonuçta elde edilen yapılandırma

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

--runtime.mcp.dml-tools.enabled

DAB'nin MCP DML araçları uç noktasını etkinleştirin.

Uyarı

Bu seçenek yalnızca v1.7 öncesi CLI'de (şu anda RC) kullanılabilir. ile yükleyin dotnet tool install microsoft.dataapibuilder --prerelease.

MCP DML araçları hakkında daha fazla bilgi için bkz. SQL MCP Server veri işleme dili araçları.

Example

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

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

DAB'nin MCP açık varlık aracını etkinleştirin.

Uyarı

Bu seçenek yalnızca v1.7 öncesi CLI'de (şu anda RC) kullanılabilir. ile yükleyin dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

DAB'nin MCP kayıt oluşturma aracını etkinleştirin.

Uyarı

Bu seçenek yalnızca v1.7 öncesi CLI'de (şu anda RC) kullanılabilir. ile yükleyin dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

DAB'nin MCP okuma kayıt aracını etkinleştirin.

Uyarı

Bu seçenek yalnızca v1.7 öncesi CLI'de (şu anda RC) kullanılabilir. ile yükleyin dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

DAB'nin MCP güncelleştirme kayıt aracını etkinleştirin.

Uyarı

Bu seçenek yalnızca v1.7 öncesi CLI'de (şu anda RC) kullanılabilir. ile yükleyin dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

DAB'nin MCP kayıt silme aracını etkinleştirin.

Uyarı

Bu seçenek yalnızca v1.7 öncesi CLI'de (şu anda RC) kullanılabilir. ile yükleyin dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

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

DAB'nin MCP yürütme varlık aracını etkinleştirin.

Uyarı

Bu seçenek yalnızca v1.7 öncesi CLI'de (şu anda RC) kullanılabilir. ile yükleyin dotnet tool install microsoft.dataapibuilder --prerelease.

Example

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

--runtime.cache.enabled

DAB önbelleğini genel olarak etkinleştirin. Ayrıca her varlık için önbelleğe almayı etkinleştirmeniz gerekir.

Example

dab configure \
  --runtime.cache.enabled true

Sonuçta elde edilen yapılandırma

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

--runtime.cache.ttl-seconds

DAB önbelleğinin genel varsayılan süresini saniyeler içinde yaşayacak şekilde özelleştirin.

Example

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

Sonuçta elde edilen yapılandırma

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

--runtime.host.mode

DAB'nin ana bilgisayar çalışma modunu ayarlayın.

İzin verilen değerler:

  • Development
  • Production

Example

dab configure \
  --runtime.host.mode Development

Sonuçta elde edilen yapılandırma

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

--runtime.host.cors.origins

CORS'de izin verilen çıkış noktalarının üzerine yazma. Değerleri boşlukla ayrılmış liste olarak sağlayın.

Example

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

Sonuçta elde edilen yapılandırma

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

--runtime.host.cors.allow-credentials

Üst bilgi için Access-Control-Allow-Credentials değeri ayarlayın.

Example

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

--runtime.host.authentication.provider

Kimlik doğrulama sağlayıcısının adını yapılandırın.

Example

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

--runtime.host.authentication.jwt.audience

JWT belirtecinin hedeflenen bir veya daha fazla alıcısını yapılandırın.

Example

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

--runtime.host.authentication.jwt.issuer

JWT belirtecini veren varlığı yapılandırın.

Example

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

Sonuçta elde edilen yapılandırma

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

--azure-key-vault.endpoint

Azure Key Vault uç nokta URL'sini yapılandırın.

Example

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

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

Yeniden deneme ilkesi modunu yapılandırın.

İzin verilen değerler:

  • fixed
  • exponential

Example

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

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

Yeniden deneme denemesi sayısı üst sınırını yapılandırın.

Example

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

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

Yeniden denemeler arasındaki ilk gecikmeyi saniye cinsinden yapılandırın.

Example

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

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

Yeniden denemeler arasındaki en uzun gecikmeyi saniye cinsinden yapılandırın (üstel mod için).

Example

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

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

İstekler için ağ zaman aşımını saniyeler içinde yapılandırın.

Example

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

Sonuçta elde edilen yapılandırma

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

Azure Log Analytics'i etkinleştirin veya devre dışı bırakın.

Example

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

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

Azure Log Analytics'te kullanılan bir DAB tanımlayıcı dizesini yapılandırın.

Example

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

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

Azure Log Analytics için boşaltma aralığını saniye cinsinden yapılandırın.

Example

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

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

Azure Log Analytics için özel tablo adını yapılandırın.

Example

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

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

Azure Log Analytics için DCR sabit kimliğini yapılandırın.

Example

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

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

Azure Log Analytics için DCE uç noktasını yapılandırın.

Example

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

Sonuçta elde edilen yapılandırma

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

Dosya havuzu günlüğünü etkinleştirin veya devre dışı bırakın.

Example

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

--runtime.telemetry.file.path

Dosya havuzu günlüğü için yolu yapılandırın.

Example

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

--runtime.telemetry.file.rolling-interval

Dosya havuzu günlüğü için sıralı aralığı yapılandırın.

İzin verilen değerler:

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

Example

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

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

En fazla korunan dosya sayısını yapılandırın.

Example

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

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

Bayt cinsinden dosya boyutu üst sınırını yapılandırın.

Example

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

Sonuçta elde edilen yapılandırma

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

Bu yardım ekranını görüntüleyin.

Example

dab configure \
  --help

--version

Sürüm bilgilerini görüntüleme.

Example

dab configure \
  --version
  • Last updated on