/
/Azure Web PubSub Service REST API
ChangesDocsSign in
Sign in
  • APIs
  • Generators
  • Stacks
  • Projects
  • Docs
  • History
  • Schema
Checked 1h ago · Updated 2mo ago
general1
webpubsub16
  • postBroadcast content inside request body to all the connected client connections.
  • deleteClose the client connection.
  • headCheck if the connection with the given connectionId exists.
  • postSend content inside request body to the specific connection.
  • headCheck if there are any client connections inside the given group
  • postSend content inside request body to a group of connections.
  • putAdd a connection to the target group.
  • deleteRemove a connection from the target group.
  • headCheck if there are any client connections connected for the given user.
  • postSend content inside request body to the specific user.
  • putAdd a user to the target group.
  • deleteRemove a user from the target group.
  • deleteRemove a user from all groups.
  • putGrant permission to the connection.
  • deleteRevoke permission for the connection.
  • headCheck if a connection has permission to the specified action.
    webpubsub

    Broadcast content inside request body to all the connected client connections.

    post/api/hubs/{hub}/:send

    Path parameters

    hubstring required

    Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.

    Query parameters

    excludedstring[]

    Excluded connection Ids.

    api-versionstring

    The version of the REST APIs.

    Request body

    string binary required

    Response

    The message is accepted. The service follows fire-and-forget pattern when sending messages.

    Changes