- 3 minutes to read

ServiceBusRelayHostSuffixes - System Parameter

New 7.12

ServiceBusRelayHostSuffixes is a json System Parameter that lists extra Service Bus host endings a relayed Monitoring Agent may use. Public Azure, Azure Government, and Azure China are built in; add the ending of any other sovereign cloud here. The Monitoring Service and the Web API read it before they send anything through the relay; how relaying works is on Configure Service Bus Relaying for Monitor Agents.

System Parameter edit page of ServiceBusRelayHostSuffixes with the value servicebus.sovcloud-api.fr in a JSON array, Json model is valid, and Save enabled (7.12)
The ending of the French sovereign cloud Bleu added to the parameter.

At a Glance

Property Value
Key ServiceBusRelayHostSuffixes
Data type json (an array of strings)
Default [] on a new installation; an update keeps a saved value
Read by Monitoring Service, Web API
Takes effect Within about 15 seconds; no restart needed
Status ✅ Active
Since Nodinite 7.12

How It Works

A relayed Monitoring Agent's Authentication Key holds the Hybrid Connection string, and the host in its Endpoint must end in an allowed Service Bus ending. The Monitoring Service and the Web API send the relay SAS token and the agent's API key to that host, so only Service Bus hosts are accepted.

  • Always allowed: servicebus.windows.net (public Azure), servicebus.usgovcloudapi.net (Azure Government), and servicebus.chinacloudapi.cn (Azure China, 21Vianet).
  • Also allowed: each ending in this parameter, for example servicebus.sovcloud-api.fr for Bleu.
  • An ending matches on a whole label, with a namespace in front: contoso.servicebus.sovcloud-api.fr is accepted; servicebus.sovcloud-api.fr alone and contoso.servicebus.sovcloud-api.fr.example.com are not.
  • When the host isn't allowed, nothing is sent. The agent shows as not available, with Connection Error in the Monitoring Service, and the reason Endpoint host '…' is not a Service Bus Relay host. Add its Service Bus host ending to the System Parameter ServiceBusRelayHostSuffixes.

Value Format

A JSON array of strings, one Service Bus host ending per entry.

Rule Detail
Starts with servicebus.
Characters Letters, digits, - and . only: no scheme, path, port, or wildcard
Stored as Trimmed, in lower case, without duplicates
["servicebus.sovcloud-api.fr"]

A value that breaks a rule is refused on Save, and nothing is stored:

The same edit page with evil.example.com in a JSON array: Json invalid, the message that the entry is not a Service Bus host ending, and Save disabled (7.12)
An entry that doesn't start with servicebus. is refused.

Choosing a Value

Leave it [] when your relays are in public Azure, Azure Government, or Azure China. Add an ending only for the sovereign cloud your Azure Relay namespace is in, and take it from the namespace's host name in the Azure portal of that cloud.

Next Steps