Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

AzureWebPubSubResource

Handle
📦 Aspire.Hosting.Azure.WebPubSub v17.0.0
type AzureWebPubSubResource interface {
ExpressionValue
Resource
ResourceWithConnectionString
ResourceWithEndpoints
}

Methods

methodAddHubbuilder
Adds an Azure Web Pub Sub hub resource to the application model.
AddHub(
name string,
options ...*AddHubOptions,
) AzureWebPubSubHubResource
namestringThe name of the Azure WebPubSub Hub resource.
options...*AddHubOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*AddHubOptions argument.

HubName*stringThe name of the Azure WebPubSub Hub. If not provided, this defaults to the same value as name.
AzureWebPubSubHubResource

The resource builder.

Returns a handle; failures surface later via Err().

methodRunAsEmulatorbuilder
Configures Azure Web PubSub to run locally using the emulator container.
RunAsEmulator(options ...*RunAsEmulatorOptions) AzureWebPubSubResource
options...*RunAsEmulatorOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*RunAsEmulatorOptions argument.

ConfigureContainerfunc(obj AzureWebPubSubEmulatorResource)callbackAn optional callback to configure the emulator container.
AzureWebPubSubResource

A reference to the IResourceBuilder.

Returns a handle; failures surface later via Err().