Skip to content
Developer tools wps

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

CAF abbreviation wps
Length 3 to 63 characters
Allowed characters Alphanumerics (a-z, A-Z, 0-9), hyphens
Scope of uniqueness Global (must be unique across all of Azure)
CAF pattern wps-{workload}-{environment}-{region}-{instance}
Worth knowing: Globally unique name.

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.

Example names

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

Scenario Generated name Length
Payments API, production wps-payments-prod-eus-001 25/63
Web app, development wps-webapp-dev-weu-002 22/63
Analytics with company prefix wps-contoso-analytics-stage-uks-001 35/63

Naming in Terraform and Bicep

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

Terraform
locals {
  web_pubsub_name = "wps-${var.workload}-${var.environment}-${var.region}-001"
}
Bicep
var webPubsubName = 'wps-${workload}-${environment}-${region}-001'

Generate Web PubSub names for your workload

Free, no login. Validation and Terraform, Bicep, or CSV export included.

Open in the generator →

Related Developer tools resources

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