Azure Functions Configuration

このページは、まだ日本語ではご利用いただけません。翻訳中です。

古いプラグインバージョンのドキュメントを閲覧しています。

構成

このプラグインはDBレスモードに対応しています。

互換性のあるプロトコル

Azure Functionsプラグインは以下のプロトコルに対応しています：

grpc, grpcs, http, https, tcp, tls, tls_passthrough, udp, ws, wss

パラメータ

このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。

• name or plugin

  string required

  プラグイン名。この場合は azure-functions 。

  • Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドはnameです。
  • Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドはpluginです。

• service.name or service.id

  string

  プラグインが対象とするサービス名または ID。最上位の /plugins エンドポイント. からプラグインをサービスに追加する場合は、これらのパラメータのいずれかを設定してください /services/{serviceName|Id}/plugins を使用する場合は必要ありません。

• route.name or route.id

  string

  プラグインがターゲットとするルート名または ID。最上位の /plugins エンドポイント. を通るルートにプラグインを追加する場合は、これらのパラメータのいずれかを設定してください /routes/{routeName|Id}/plugins を使用する場合は必要ありません。

• consumer.name or consumer.id

  string

  プラグインがターゲットとするコンシューマーの名前または ID。 最上位の /plugins エンドポイント. からコンシューマーにプラグインを追加する場合は、これらのパラメーターのいずれかを設定してください /consumers/{consumerName|Id}/pluginsを使用する場合は必要ありません。

• enabled

  boolean default: true

  このプラグインが適用されるかどうか。

• config

  record required
  • timeout

    number default: 600000

    Timeout in milliseconds before closing a connection to the Azure Functions server.

  • keepalive

    number default: 60000

    Time in milliseconds during which an idle connection to the Azure Functions server lives before being closed.

  • https

    boolean default: true

    Use of HTTPS to connect with the Azure Functions server.

  • https_verify

    boolean default: false

    Set to true to authenticate the Azure Functions server.

  • apikey

    string referenceable encrypted

    The apikey to access the Azure resources. If provided, it is injected as the x-functions-key header.

  • clientid

    string referenceable encrypted

    The clientid to access the Azure resources. If provided, it is injected as the x-functions-clientid header.

  • appname

    string required

    The Azure app name.

  • hostdomain

    string required default: azurewebsites.net

    The domain where the function resides.

  • routeprefix

    string default: api

    Route prefix to use.

  • functionname

    string required

    Name of the Azure function to invoke.