AzureWebPubSubExtensions Methods
Class Methods 6 members
Provides extension methods for adding the Azure Web PubSub resources to the application model.
AddAzureWebPubSub(IDistributedApplicationBuilder, string) Section titled AddAzureWebPubSub(IDistributedApplicationBuilder, string) extension IResourceBuilder<AzureWebPubSubResource> Adds an Azure Web PubSub resource to the application model. Change sku: WithParameter("sku", "Standard_S1") Change capacity: WithParameter("capacity", 2)
public static class AzureWebPubSubExtensions{ public static IResourceBuilder<AzureWebPubSubResource> AddAzureWebPubSub( this IDistributedApplicationBuilder builder, string name) { // ... }}Parameters
builder IDistributedApplicationBuilder The Hosting.IDistributedApplicationBuilder. name string The name of the resource. This name will be used as the connection string name when referenced in a dependency. Returns
IResourceBuilder<AzureWebPubSubResource> A reference to the ApplicationModel.IResourceBuilder`1. Remarks
By default references to the Azure Web PubSub resource will be assigned the following roles: -
WebPubSubBuiltInRole.WebPubSubServiceOwner These can be replaced by calling AzureWebPubSubExtensions.WithRoleAssignments. AddEventHandler(IResourceBuilder<AzureWebPubSubHubResource>, ExpressionInterpolatedStringHandler, string, string[]?, UpstreamAuthSettings?) Section titled AddEventHandler(IResourceBuilder<AzureWebPubSubHubResource>, ExpressionInterpolatedStringHandler, string, string[]?, UpstreamAuthSettings?) extension IResourceBuilder<AzureWebPubSubHubResource> Add event handler setting with expression
public static class AzureWebPubSubExtensions{ public static IResourceBuilder<AzureWebPubSubHubResource> AddEventHandler( this IResourceBuilder<AzureWebPubSubHubResource> builder, ExpressionInterpolatedStringHandler urlTemplateExpression, string userEventPattern = "*", string[]? systemEvents = null, UpstreamAuthSettings? authSettings = null) { // ... }}Parameters
builder IResourceBuilder<AzureWebPubSubHubResource> The builder for a Web PubSub hub. urlTemplateExpression ExpressionInterpolatedStringHandler The expression to evaluate the URL template configured for the event handler. userEventPattern string optional The user event pattern for the event handler. systemEvents string[]? optional The system events for the event handler. authSettings UpstreamAuthSettings? optional The auth settings configured for the event handler. AddEventHandler(IResourceBuilder<AzureWebPubSubHubResource>, ReferenceExpression, string, string[]?, UpstreamAuthSettings?) Section titled AddEventHandler(IResourceBuilder<AzureWebPubSubHubResource>, ReferenceExpression, string, string[]?, UpstreamAuthSettings?) extension IResourceBuilder<AzureWebPubSubHubResource> Add event handler setting with expression
public static class AzureWebPubSubExtensions{ public static IResourceBuilder<AzureWebPubSubHubResource> AddEventHandler( this IResourceBuilder<AzureWebPubSubHubResource> builder, ReferenceExpression urlExpression, string userEventPattern = "*", string[]? systemEvents = null, UpstreamAuthSettings? authSettings = null) { // ... }}Parameters
builder IResourceBuilder<AzureWebPubSubHubResource> The builder for a Web PubSub hub. urlExpression ReferenceExpression The expression to evaluate the URL template configured for the event handler. userEventPattern string optional The user event pattern for the event handler. systemEvents string[]? optional The system events for the event handler. authSettings UpstreamAuthSettings? optional The auth settings configured for the event handler. AddHub(IResourceBuilder<AzureWebPubSubResource>, string) Section titled AddHub(IResourceBuilder<AzureWebPubSubResource>, string) extension IResourceBuilder<AzureWebPubSubHubResource> Add hub settings
public static class AzureWebPubSubExtensions{ public static IResourceBuilder<AzureWebPubSubHubResource> AddHub( this IResourceBuilder<AzureWebPubSubResource> builder, string hubName) { // ... }}Parameters
builder IResourceBuilder<AzureWebPubSubResource> The builder for the distributed application. hubName string The hub name. Hub name is case-insensitive. AddHub(IResourceBuilder<AzureWebPubSubResource>, string, string?) Section titled AddHub(IResourceBuilder<AzureWebPubSubResource>, string, string?) extension IResourceBuilder<AzureWebPubSubHubResource> Adds an Azure Web Pub Sub hub resource to the application model.
public static class AzureWebPubSubExtensions{ public static IResourceBuilder<AzureWebPubSubHubResource> AddHub( this IResourceBuilder<AzureWebPubSubResource> builder, string name, string? hubName = null) { // ... }}Parameters
builder IResourceBuilder<AzureWebPubSubResource> The Azure WebPubSub resource builder. name string The name of the Azure WebPubSub Hub resource. hubName string? optional The name of the Azure WebPubSub Hub. If not provided, this defaults to the same value as name. Returns
IResourceBuilder<AzureWebPubSubHubResource> A reference to the ApplicationModel.IResourceBuilder`1. WithRoleAssignments(IResourceBuilder<T>, IResourceBuilder<AzureWebPubSubResource>, WebPubSubBuiltInRole[]) Section titled WithRoleAssignments(IResourceBuilder<T>, IResourceBuilder<AzureWebPubSubResource>, WebPubSubBuiltInRole[]) extension IResourceBuilder<T> Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure Web PubSub resource. This replaces the default role assignments for the resource.
public static class AzureWebPubSubExtensions{ public static IResourceBuilder<T> WithRoleAssignments<T>( this IResourceBuilder<T> builder, IResourceBuilder<AzureWebPubSubResource> target, params WebPubSubBuiltInRole[] roles) { // ... }}Parameters
builder IResourceBuilder<T> The resource to which the specified roles will be assigned. target IResourceBuilder<AzureWebPubSubResource> The target Azure Web PubSub resource. roles WebPubSubBuiltInRole[] The built-in Web PubSub roles to be assigned. Returns
IResourceBuilder<T> The updated ApplicationModel.IResourceBuilder`1 with the applied role assignments. Remarks
Assigns the WebPubSubServiceReader role to the 'Projects.Api' project.
var builder = DistributedApplication.CreateBuilder(args);
var webPubSub = builder.AddAzureWebPubSub("webPubSub");
var api = builder.AddProject<Projects.Api>("api") .WithRoleAssignments(webPubSub, WebPubSubBuiltInRole.WebPubSubServiceReader) .WithReference(webPubSub);