Configuration

This page is the complete configuration surface for the KubeMQ.Aspire.Client package: the configuration sections each registration method binds, the full KubeMQClientSettings table, the connection-string parsing rules, and the supported runtime and dependency versions. For the registration methods themselves see the Client API; for a task-oriented walkthrough see the Client Configuration and TLS guide.

Configuration sections

Client settings are bound from configuration before the configureSettings delegate runs. The configuration section depends on which registration method you call.

The top-level Aspire:KubeMQ:Client section configures the default client. Named subsections under it — Aspire:KubeMQ:Client:{name} — configure each keyed client, where {name} matches the service key.

{
  "Aspire": {
    "KubeMQ": {
      "Client": {
        "DisableHealthChecks": false,
        "DisableTracing": false,
        "DisableMetrics": false,
        "HealthCheckTimeout": "00:00:05",
        "AuthToken": null,
        "ClientId": null
      }
    }
  }
}

{
  "Aspire": {
    "KubeMQ": {
      "Client": {
        "orders": {
          "ClientId": "orders-service",
          "GrpcChannelCount": 8
        },
        "notifications": {
          "DisableTracing": true
        }
      }
    }
  }
}

Settings can also be set in code via the configureSettings delegate, which is applied after binding and overrides configured values:

builder.AddKubeMQClient("messaging", settings =>
{
    settings.DisableHealthChecks = true;
    settings.AuthToken = "my-token";
});

KubeMQClientSettings

Every property on KubeMQClientSettings. Properties whose default is "SDK default" are nullable — leaving them null passes through to the underlying KubeMQ.SDK.CSharp default shown in parentheses.

GrpcChannelCount is constrained to the range 1–16 by the configuration schema. The Tls* properties take effect only when UseTls is true; otherwise they are ignored. For a guided tour of TLS, gRPC tuning, keepalive, and reconnect, see Client Configuration and TLS.

Connection string format

The integration parses the connection string into a host and port before constructing the client. The parser enforces strict rules — violations throw a KubeMQConfigurationException.

localhost:50000
messaging:50000
[::1]:50000

grpc://localhost:50000   # scheme prefix
::1:50000                # IPv6 without brackets
localhost:70000          # port out of range

Requirements

The packages build on these dependency versions:

The KubeMQ .NET Aspire integration is licensed under Apache 2.0.

Related