Web PubSub naming convention

The CAF abbreviation for Web PubSub is wps. Names can be 3 to 63 characters long and allow alphanumerics and hyphens. The name must be globally unique across all of Azure.

Naming rules

Rules follow Microsoft's resource naming rules and CAF abbreviations. Some resource types have extra start/end character restrictions, so verify against the official docs before locking in a convention.

Naming Developer tools resources

App Configuration stores, Maps accounts, SignalR, and Web PubSub each become their own DNS endpoint and are typically shared across several apps or services rather than owned by one, similar in spirit to a shared API Management instance. Name them for the platform or shared boundary they serve, not for whichever app happened to need them first.

The common mistake is naming a shared App Configuration store after its first consumer, then having to work around that name once a second, unrelated app depends on the same store. Naming for the boundary from day one avoids that rename.

Example names

Generated by the same engine as the name generator, so length and character rules are already applied.

Naming in Terraform and Bicep

Build the name from variables so one module produces the right name in every environment.

locals {
  web_pubsub_name = "wps-${var.workload}-${var.environment}-${var.region}-001"
}

var webPubsubName = 'wps-${workload}-${environment}-${region}-001'

Related Developer tools resources

See the full list of Azure resource naming rules or read the complete CAF naming guide.