Skip to content

Data Source: azurermWebPubsub

Use this data source to access information about an existing Azure Web Pubsub service.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
new azurerm.dataAzurermWebPubsub.DataAzurermWebPubsub(this, "example", {
  name: "test-webpubsub",
  resource_group_name: "wps-resource-group",
});

Argument Reference

The following arguments are supported:

  • name - Specifies the name of the Web Pubsub service.

  • resourceGroupName - Specifies the name of the resource group the Web Pubsub service is located in.

Attributes Reference

The following attributes are exported:

  • id - The ID of the Web Pubsub service.

  • hostname - The FQDN of the Web Pubsub service.

  • ipAddress - The publicly accessible IP of the Web Pubsub service.

  • location - The Azure location where the Web Pubsub service exists.

  • publicPort - The publicly accessible port of the Web Pubsub service which is designed for browser/client use.

  • serverPort - The publicly accessible port of the Web Pubsub service which is designed for customer server side use.

  • primaryAccessKey - The primary access key of the Web Pubsub service.

  • primaryConnectionString - The primary connection string of the Web Pubsub service.

  • secondaryAccessKey - The secondary access key of the Web Pubsub service.

  • secondaryConnectionString - The secondary connection string of the Web Pubsub service.

  • identity - An identity block as documented below.

The identity block exports the following:

  • type - The type of identity used for the web pubsub.

  • userAssignedIdentityId - The ID of the User Assigned Identity. This value will be empty when using system assigned identity.

  • principalId - The principal id of the system assigned identity.

  • tenantId - The tenant id of the system assigned identity.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minutes) Used when retrieving the Web Pubsub service.