messaging/web_pubsub¶

Overview¶

This page documents the Terraform module implementation, key configuration surfaces, and how it integrates with CAF.

Dependency diagram (Mermaid)¶

graph TD azurerm_key_vault_secret.primary_access_key["azurerm_key_vault_secret.primary_access_key"] azurerm_key_vault_secret.primary_connection_string["azurerm_key_vault_secret.primary_connection_string"] azurerm_key_vault_secret.secondary_access_key["azurerm_key_vault_secret.secondary_access_key"] azurerm_key_vault_secret.secondary_connection_string["azurerm_key_vault_secret.secondary_connection_string"] azurerm_web_pubsub.wps["azurerm_web_pubsub.wps"] data.azurecaf_name.wps["data.azurecaf_name.wps"] module.private_endpoint["module.private_endpoint"] remote:keyvaults["remote:keyvaults"] remote:private_dns["remote:private_dns"] remote:resource_groups["remote:resource_groups"] remote:vnets["remote:vnets"] azurerm_key_vault_secret.primary_access_key --> azurerm_web_pubsub.wps azurerm_key_vault_secret.primary_access_key --> remote:keyvaults azurerm_key_vault_secret.primary_connection_string --> azurerm_web_pubsub.wps azurerm_key_vault_secret.primary_connection_string --> remote:keyvaults azurerm_key_vault_secret.secondary_access_key --> azurerm_web_pubsub.wps azurerm_key_vault_secret.secondary_access_key --> remote:keyvaults azurerm_key_vault_secret.secondary_connection_string --> azurerm_web_pubsub.wps azurerm_key_vault_secret.secondary_connection_string --> remote:keyvaults azurerm_web_pubsub.wps --> data.azurecaf_name.wps module.private_endpoint --> azurerm_web_pubsub.wps module.private_endpoint --> remote:private_dns module.private_endpoint --> remote:resource_groups module.private_endpoint --> remote:vnets

Module Reference¶

Category: messaging
Path: modules/messaging/web_pubsub
Azure Resources: azurerm_key_vault_secret, azurerm_web_pubsub

Inputs¶

Name	Description	Type	Required	Default	Validation
`"global_settings"`	"Global settings object (see module README.md)"	`any`	yes	`-`	-
`"client_config"`	"Client configuration object (see module README.md)."	`any`	yes	`-`	-
`"settings"`	"(Required) Used to handle passthrough paramenters."	`any`	yes	`-`	-
`"remote_objects"`	"Remote objects configuration."	`any`	no	`{}`	-
`"vnets"`		`any`	no	`{}`	-
`"private_endpoints"`		`any`	no	`{}`	-
`"location"`	"location of the resource if different from the resource group."	`string`	no	`-`	-
`"resource_group_name"`	"Resource group object to deploy the Azure resource"	`string`	no	`-`	-
`"resource_group"`	"Resource group object to deploy the Azure resource"	`any`	yes	`-`	-
`"base_tags"`	"Base tags for the resource to be inherited from the resource group."	`bool`	yes	`-`	-

Outputs¶

Name	Description	Sensitive	Value
`"id"`	"The ID of the Web PubSub service"	-	`azurerm_web_pubsub.wps.id`
`"hostname"`	"The hostname of the Web PubSub service"	-	`azurerm_web_pubsub.wps.name`
`"public_port"`	"The public_port of the Web PubSub service"	-	`azurerm_web_pubsub.wps.public_port`
`"server_port"`	"The server_port of the Web PubSub service"	-	`azurerm_web_pubsub.wps.server_port`
`"primary_access_key"`	"The primary_access_key of the Web PubSub service"	-	`azurerm_web_pubsub.wps.primary_access_key`
`"primary_connection_string"`	"The primary_connection_string of the Web PubSub service"	-	`azurerm_web_pubsub.wps.primary_connection_string`
`"secondary_access_key"`	"The secondary_access_key of the Web PubSub service"	-	`azurerm_web_pubsub.wps.secondary_access_key`
`"secondary_connection_string"`	"The secondary_connection_string of the Web PubSub service"	-	`azurerm_web_pubsub.wps.secondary_connection_string`
`"location"`	"The location of the Web PubSub service"	-	`local.location`
`"resource_group_name"`	"The resource group name of the Web PubSub service"	-	`azurerm_web_pubsub.wps.resource_group_name`
`"identity"`	" An identity block, which contains the Identity information for this Web PubSub service. Exports principal_id (The P...	-	`try(azurerm_web_pubsub.wps.identity, null)`

Sources¶

modules/messaging/web_pubsub/keyvault_secrets.tf
modules/messaging/web_pubsub/locals.tf
modules/messaging/web_pubsub/main.tf
modules/messaging/web_pubsub/managed_identities.tf
modules/messaging/web_pubsub/outputs.tf
modules/messaging/web_pubsub/private_endpoint.tf
modules/messaging/web_pubsub/variables.tf
modules/messaging/web_pubsub/web_pubsub.tf