Web Pub Sub Hubs - Create Or Update

Service:

Azure Web PubSub Service

API Version:

2023-02-01

Create or update a hub setting.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}?api-version=2023-02-01

URI Parameters

Name	In	Required	Type	Description
hubName	path	True	string	The hub name.
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
resourceName	path	True	string	The name of the resource.
subscriptionId	path	True	string	Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.

Request Body

Name	Required	Type	Description
properties	True	WebPubSubHubProperties	Properties of a hub.

Responses

Name	Type	Description
200 OK	WebPubSubHub	OK.The request makes no change. The response describes the existing hub setting.
201 Created	WebPubSubHub	Created. The response describes the hub setting and contains a Location header to query the operation result.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

WebPubSubHubs_CreateOrUpdate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SignalRService/webPubSub/myWebPubSubService/hubs/exampleHub?api-version=2023-02-01

{
  "properties": {
    "eventHandlers": [
      {
        "urlTemplate": "http://host.com",
        "userEventPattern": "*",
        "systemEvents": [
          "connect",
          "connected"
        ],
        "auth": {
          "type": "ManagedIdentity",
          "managedIdentity": {
            "resource": "abc"
          }
        }
      }
    ],
    "eventListeners": [
      {
        "filter": {
          "type": "EventName",
          "systemEvents": [
            "connected",
            "disconnected"
          ],
          "userEventPattern": "*"
        },
        "endpoint": {
          "type": "EventHub",
          "fullyQualifiedNamespace": "example.servicebus.windows.net",
          "eventHubName": "eventHubName1"
        }
      }
    ],
    "anonymousConnectPolicy": "allow"
  }
}

Java

import com.azure.resourcemanager.webpubsub.models.EventHandler;
import com.azure.resourcemanager.webpubsub.models.EventHubEndpoint;
import com.azure.resourcemanager.webpubsub.models.EventListener;
import com.azure.resourcemanager.webpubsub.models.EventNameFilter;
import com.azure.resourcemanager.webpubsub.models.ManagedIdentitySettings;
import com.azure.resourcemanager.webpubsub.models.UpstreamAuthSettings;
import com.azure.resourcemanager.webpubsub.models.UpstreamAuthType;
import com.azure.resourcemanager.webpubsub.models.WebPubSubHubProperties;
import java.util.Arrays;

/** Samples for WebPubSubHubs CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/WebPubSubHubs_CreateOrUpdate.json
     */
    /**
     * Sample code: WebPubSubHubs_CreateOrUpdate.
     *
     * @param manager Entry point to WebPubSubManager.
     */
    public static void webPubSubHubsCreateOrUpdate(com.azure.resourcemanager.webpubsub.WebPubSubManager manager) {
        manager
            .webPubSubHubs()
            .define("exampleHub")
            .withExistingWebPubSub("myResourceGroup", "myWebPubSubService")
            .withProperties(
                new WebPubSubHubProperties()
                    .withEventHandlers(
                        Arrays
                            .asList(
                                new EventHandler()
                                    .withUrlTemplate("http://host.com")
                                    .withUserEventPattern("*")
                                    .withSystemEvents(Arrays.asList("connect", "connected"))
                                    .withAuth(
                                        new UpstreamAuthSettings()
                                            .withType(UpstreamAuthType.MANAGED_IDENTITY)
                                            .withManagedIdentity(new ManagedIdentitySettings().withResource("abc")))))
                    .withEventListeners(
                        Arrays
                            .asList(
                                new EventListener()
                                    .withFilter(
                                        new EventNameFilter()
                                            .withSystemEvents(Arrays.asList("connected", "disconnected"))
                                            .withUserEventPattern("*"))
                                    .withEndpoint(
                                        new EventHubEndpoint()
                                            .withFullyQualifiedNamespace("example.servicebus.windows.net")
                                            .withEventHubName("eventHubName1"))))
                    .withAnonymousConnectPolicy("allow"))
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.webpubsub import WebPubSubManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-webpubsub
# USAGE
    python web_pub_sub_hubs_create_or_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebPubSubManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.web_pub_sub_hubs.begin_create_or_update(
        hub_name="exampleHub",
        resource_group_name="myResourceGroup",
        resource_name="myWebPubSubService",
        parameters={
            "properties": {
                "anonymousConnectPolicy": "allow",
                "eventHandlers": [
                    {
                        "auth": {"managedIdentity": {"resource": "abc"}, "type": "ManagedIdentity"},
                        "systemEvents": ["connect", "connected"],
                        "urlTemplate": "http://host.com",
                        "userEventPattern": "*",
                    }
                ],
                "eventListeners": [
                    {
                        "endpoint": {
                            "eventHubName": "eventHubName1",
                            "fullyQualifiedNamespace": "example.servicebus.windows.net",
                            "type": "EventHub",
                        },
                        "filter": {
                            "systemEvents": ["connected", "disconnected"],
                            "type": "EventName",
                            "userEventPattern": "*",
                        },
                    }
                ],
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/WebPubSubHubs_CreateOrUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armwebpubsub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/webpubsub/armwebpubsub"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/WebPubSubHubs_CreateOrUpdate.json
func ExampleHubsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armwebpubsub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewHubsClient().BeginCreateOrUpdate(ctx, "exampleHub", "myResourceGroup", "myWebPubSubService", armwebpubsub.Hub{
		Properties: &armwebpubsub.HubProperties{
			AnonymousConnectPolicy: to.Ptr("allow"),
			EventHandlers: []*armwebpubsub.EventHandler{
				{
					Auth: &armwebpubsub.UpstreamAuthSettings{
						Type: to.Ptr(armwebpubsub.UpstreamAuthTypeManagedIdentity),
						ManagedIdentity: &armwebpubsub.ManagedIdentitySettings{
							Resource: to.Ptr("abc"),
						},
					},
					SystemEvents: []*string{
						to.Ptr("connect"),
						to.Ptr("connected")},
					URLTemplate:      to.Ptr("http://host.com"),
					UserEventPattern: to.Ptr("*"),
				}},
			EventListeners: []*armwebpubsub.EventListener{
				{
					Endpoint: &armwebpubsub.EventHubEndpoint{
						Type:                    to.Ptr(armwebpubsub.EventListenerEndpointDiscriminatorEventHub),
						EventHubName:            to.Ptr("eventHubName1"),
						FullyQualifiedNamespace: to.Ptr("example.servicebus.windows.net"),
					},
					Filter: &armwebpubsub.EventNameFilter{
						Type: to.Ptr(armwebpubsub.EventListenerFilterDiscriminatorEventName),
						SystemEvents: []*string{
							to.Ptr("connected"),
							to.Ptr("disconnected")},
						UserEventPattern: to.Ptr("*"),
					},
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Hub = armwebpubsub.Hub{
	// 	Name: to.Ptr("exampleHub"),
	// 	Type: to.Ptr("Microsoft.SignalRService/WebPubSub/hubs"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub"),
	// 	Properties: &armwebpubsub.HubProperties{
	// 		AnonymousConnectPolicy: to.Ptr("allow"),
	// 		EventHandlers: []*armwebpubsub.EventHandler{
	// 			{
	// 				Auth: &armwebpubsub.UpstreamAuthSettings{
	// 					Type: to.Ptr(armwebpubsub.UpstreamAuthTypeManagedIdentity),
	// 					ManagedIdentity: &armwebpubsub.ManagedIdentitySettings{
	// 						Resource: to.Ptr("abc"),
	// 					},
	// 				},
	// 				SystemEvents: []*string{
	// 					to.Ptr("connect"),
	// 					to.Ptr("connected")},
	// 					URLTemplate: to.Ptr("http://host.com"),
	// 					UserEventPattern: to.Ptr("*"),
	// 			}},
	// 			EventListeners: []*armwebpubsub.EventListener{
	// 				{
	// 					Endpoint: &armwebpubsub.EventHubEndpoint{
	// 						Type: to.Ptr(armwebpubsub.EventListenerEndpointDiscriminatorEventHub),
	// 						EventHubName: to.Ptr("eventHubName1"),
	// 						FullyQualifiedNamespace: to.Ptr("example.servicebus.windows.net"),
	// 					},
	// 					Filter: &armwebpubsub.EventNameFilter{
	// 						Type: to.Ptr(armwebpubsub.EventListenerFilterDiscriminatorEventName),
	// 						SystemEvents: []*string{
	// 							to.Ptr("connected"),
	// 							to.Ptr("disconnected")},
	// 							UserEventPattern: to.Ptr("*"),
	// 						},
	// 				}},
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { WebPubSubManagementClient } = require("@azure/arm-webpubsub");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create or update a hub setting.
 *
 * @summary Create or update a hub setting.
 * x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/WebPubSubHubs_CreateOrUpdate.json
 */
async function webPubSubHubsCreateOrUpdate() {
  const subscriptionId =
    process.env["WEB-PUBSUB_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const hubName = "exampleHub";
  const resourceGroupName = process.env["WEB-PUBSUB_RESOURCE_GROUP"] || "myResourceGroup";
  const resourceName = "myWebPubSubService";
  const parameters = {
    properties: {
      anonymousConnectPolicy: "allow",
      eventHandlers: [
        {
          auth: {
            type: "ManagedIdentity",
            managedIdentity: { resource: "abc" },
          },
          systemEvents: ["connect", "connected"],
          urlTemplate: "http://host.com",
          userEventPattern: "*",
        },
      ],
      eventListeners: [
        {
          endpoint: {
            type: "EventHub",
            eventHubName: "eventHubName1",
            fullyQualifiedNamespace: "example.servicebus.windows.net",
          },
          filter: {
            type: "EventName",
            systemEvents: ["connected", "disconnected"],
            userEventPattern: "*",
          },
        },
      ],
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new WebPubSubManagementClient(credential, subscriptionId);
  const result = await client.webPubSubHubs.beginCreateOrUpdateAndWait(
    hubName,
    resourceGroupName,
    resourceName,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "properties": {
    "eventHandlers": [
      {
        "urlTemplate": "http://host.com",
        "userEventPattern": "*",
        "systemEvents": [
          "connect",
          "connected"
        ],
        "auth": {
          "type": "ManagedIdentity",
          "managedIdentity": {
            "resource": "abc"
          }
        }
      }
    ],
    "eventListeners": [
      {
        "filter": {
          "type": "EventName",
          "systemEvents": [
            "connected",
            "disconnected"
          ],
          "userEventPattern": "*"
        },
        "endpoint": {
          "type": "EventHub",
          "fullyQualifiedNamespace": "example.servicebus.windows.net",
          "eventHubName": "eventHubName1"
        }
      }
    ],
    "anonymousConnectPolicy": "allow"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub",
  "name": "exampleHub",
  "type": "Microsoft.SignalRService/WebPubSub/hubs"
}

Status code:

201

Location: https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus...

Response Body

{
  "properties": {
    "eventHandlers": [
      {
        "urlTemplate": "http://host.com",
        "userEventPattern": "*",
        "systemEvents": [
          "connect",
          "connected"
        ],
        "auth": {
          "type": "ManagedIdentity",
          "managedIdentity": {
            "resource": "abc"
          }
        }
      }
    ],
    "eventListeners": [
      {
        "filter": {
          "type": "EventName",
          "systemEvents": [
            "connected",
            "disconnected"
          ],
          "userEventPattern": "*"
        },
        "endpoint": {
          "type": "EventHub",
          "fullyQualifiedNamespace": "example.servicebus.windows.net",
          "eventHubName": "eventHubName1"
        }
      }
    ],
    "anonymousConnectPolicy": "allow"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub",
  "name": "exampleHub",
  "type": "Microsoft.SignalRService/WebPubSub/hubs"
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
EventHandler	Properties of event handler.
EventHubEndpoint	An Event Hub endpoint. The managed identity of Web PubSub service must be enabled, and the identity should have the "Azure Event Hubs Data sender" role to access Event Hub.
EventListener	A setting defines which kinds of events should be sent to which endpoint.
EventNameFilter	Filter events by their name.
ManagedIdentitySettings	Managed identity settings for upstream.
systemData	Metadata pertaining to creation and last modification of the resource.
UpstreamAuthSettings	Upstream auth settings. If not set, no auth is used for upstream messages.
UpstreamAuthType	Upstream auth type enum.
WebPubSubHub	A hub setting
WebPubSubHubProperties	Properties of a hub.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

EventHandler

Properties of event handler.

Name	Type	Description
auth	UpstreamAuthSettings	Upstream auth settings. If not set, no auth is used for upstream messages.
systemEvents	string[]	Gets or sets the list of system events.
urlTemplate	string	Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in. For example, UrlTemplate can be http://example.com/api/{hub}/{event}. The host part can't contains parameters.
userEventPattern	string	Gets or sets the matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1"

EventHubEndpoint

An Event Hub endpoint. The managed identity of Web PubSub service must be enabled, and the identity should have the "Azure Event Hubs Data sender" role to access Event Hub.

Name	Type	Description
eventHubName	string	The name of the Event Hub.
fullyQualifiedNamespace	string	The fully qualified namespace name of the Event Hub resource. For example, "example.servicebus.windows.net".
type	string: EventHub

EventListener

A setting defines which kinds of events should be sent to which endpoint.

Name	Type	Description
endpoint	EventListenerEndpoint: EventHubEndpoint	An endpoint specifying where Web PubSub should send events to.
filter	EventListenerFilter: EventNameFilter	A base class for event filter which determines whether an event should be sent to an event listener.

EventNameFilter

Filter events by their name.

Name	Type	Description
systemEvents	string[]	Gets or sets a list of system events. Supported events: "connected" and "disconnected". Blocking event "connect" is not supported because it requires a response.
type	string: EventName
userEventPattern	string	Gets or sets a matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches events "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1"

ManagedIdentitySettings

Managed identity settings for upstream.

Name	Type	Description
resource	string	The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UpstreamAuthSettings

Upstream auth settings. If not set, no auth is used for upstream messages.

Name	Type	Description
managedIdentity	ManagedIdentitySettings	Managed identity settings for upstream.
type	UpstreamAuthType	Upstream auth type enum.

UpstreamAuthType

Upstream auth type enum.

Name	Type	Description
ManagedIdentity	string
None	string

WebPubSubHub

A hub setting

Name	Type	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
properties	WebPubSubHubProperties	Properties of a hub.
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource - e.g. "Microsoft.SignalRService/SignalR"

WebPubSubHubProperties

Properties of a hub.

Name	Type	Default Value	Description
anonymousConnectPolicy	string	deny	The settings for configuring if anonymous connections are allowed for this hub: "allow" or "deny". Default to "deny".
eventHandlers	EventHandler[]		Event handler of a hub.
eventListeners	EventListener[]		Event listener settings for forwarding your client events to listeners. Event listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients. One event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn't matter. Maximum count of event listeners among all hubs is 10.