azure-messaging-webpubsubservice-py

from azure.messaging.webpubsubservice import WebPubSubServiceClient
from azure.identity import DefaultAzureCredential, ManagedIdentityCredential
 
# Local dev: DefaultAzureCredential. Production: set AZURE_TOKEN_CREDENTIALS=prod or AZURE_TOKEN_CREDENTIALS=<specific_credential>
credential = DefaultAzureCredential(require_envvar=True)
# Or use a specific credential directly in production:
# See https://learn.microsoft.com/python/api/overview/azure/identity-readme?view=azure-python#credential-classes
# credential = ManagedIdentityCredential()
 
with WebPubSubServiceClient(
    endpoint="https://<name>.webpubsub.azure.com",
    hub="my-hub",
    credential=credential
) as client:
    # Use `client` for all subsequent operations (see examples below)
    ...

# Token for anonymous user
token = client.get_client_access_token()
print(f"URL: {token['url']}")
 
# Token with user ID
token = client.get_client_access_token(
    user_id="user123",
    roles=["webpubsub.sendToGroup", "webpubsub.joinLeaveGroup"]
)
 
# Token with groups
token = client.get_client_access_token(
    user_id="user123",
    groups=["group1", "group2"]
)

# Send text
client.send_to_all(message="Hello everyone!", content_type="text/plain")
 
# Send JSON
client.send_to_all(
    message={"type": "notification", "data": "Hello"},
    content_type="application/json"
)

client.send_to_user(
    user_id="user123",
    message="Hello user!",
    content_type="text/plain"
)

client.send_to_group(
    group="my-group",
    message="Hello group!",
    content_type="text/plain"
)

client.send_to_connection(
    connection_id="abc123",
    message="Hello connection!",
    content_type="text/plain"
)

# Add user to group
client.add_user_to_group(group="my-group", user_id="user123")
 
# Remove user from group
client.remove_user_from_group(group="my-group", user_id="user123")
 
# Add connection to group
client.add_connection_to_group(group="my-group", connection_id="abc123")
 
# Remove connection from group
client.remove_connection_from_group(group="my-group", connection_id="abc123")

# Check if connection exists
exists = client.connection_exists(connection_id="abc123")
 
# Check if user has connections
exists = client.user_exists(user_id="user123")
 
# Check if group has connections
exists = client.group_exists(group="my-group")
 
# Close connection
client.close_connection(connection_id="abc123", reason="Session ended")
 
# Close all connections for user
client.close_all_connections(user_id="user123")

from azure.messaging.webpubsubservice import WebPubSubServiceClient
 
# Grant permission
client.grant_permission(
    permission="joinLeaveGroup",
    connection_id="abc123",
    target_name="my-group"
)
 
# Revoke permission
client.revoke_permission(
    permission="joinLeaveGroup",
    connection_id="abc123",
    target_name="my-group"
)
 
# Check permission
has_permission = client.check_permission(
    permission="joinLeaveGroup",
    connection_id="abc123",
    target_name="my-group"
)

from azure.messaging.webpubsubclient import WebPubSubClient
 
with WebPubSubClient(credential=token["url"]) as client:
    @client.on("connected")
    def on_connected(e):
        print(f"Connected: {e.connection_id}")
 
    @client.on("server-message")
    def on_message(e):
        print(f"Message: {e.data}")
 
    @client.on("group-message")
    def on_group_message(e):
        print(f"Group {e.group}: {e.data}")
 
    client.send_to_group("my-group", "Hello from Python!")

from azure.messaging.webpubsubservice.aio import WebPubSubServiceClient
from azure.identity.aio import DefaultAzureCredential
 
async def broadcast():
    async with DefaultAzureCredential() as credential:
        async with WebPubSubServiceClient(
            endpoint="https://<name>.webpubsub.azure.com",
            hub="my-hub",
            credential=credential
        ) as client:
            await client.send_to_all("Hello async!", content_type="text/plain")