How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Microsoft Azure

Microsoft Azure Webpubsub API

The Webpubsub API from Microsoft Azure — 39 operation(s) for webpubsub.

Documentation Provider Profile APIs.io OpenAPI GitHub

Microsoft Azure Webpubsub API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Web PubSub. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 61 operations across 39 paths, and defines 78 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

61 operations 39 paths 78 schemas 12 DELETE22 GET4 HEAD2 PATCH10 POST11 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 61

Across 39 paths, the API surfaces 61 operations — 12 DELETE, 22 GET, 4 HEAD, 2 PATCH, 10 POST, 11 PUT. Each is listed below with its method, path, parameters, and response codes.

Webpubsub 61
POST
/api/hubs/{hub}/:generateToken
Microsoft Azure Generate Token For The Client To Connect Azure Web Pubsub Service
microsoftAzureWebpubsubGenerateclienttoken 5 params → 200default
POST
/api/hubs/{hub}/:send
Microsoft Azure Broadcast Content Inside Request Body To All The Connected Client Connections
microsoftAzureWebpubsubSendtoall 3 params body → 202default
HEAD
/api/hubs/{hub}/connections/{connectionId}
Microsoft Azure Check If The Connection With The Given Connectionid Exists
microsoftAzureWebpubsubConnectionexists 3 params → 200404default
DELETE
/api/hubs/{hub}/connections/{connectionId}
Microsoft Azure Close The Client Connection
microsoftAzureWebpubsubCloseconnection 4 params → 200default
POST
/api/hubs/{hub}/connections/{connectionId}/:send
Microsoft Azure Send Content Inside Request Body To The Specific Connection
microsoftAzureWebpubsubSendtoconnection 3 params body → 202default
HEAD
/api/hubs/{hub}/groups/{group}
Microsoft Azure Check If There Are Any Client Connections Inside The Given Group
microsoftAzureWebpubsubGroupexists 3 params → 200404default
POST
/api/hubs/{hub}/groups/{group}/:send
Microsoft Azure Send Content Inside Request Body To A Group Of Connections
microsoftAzureWebpubsubSendtogroup 4 params body → 202default
PUT
/api/hubs/{hub}/groups/{group}/connections/{connectionId}
Microsoft Azure Add A Connection To The Target Group
microsoftAzureWebpubsubAddconnectiontogroup 4 params → 200404default
DELETE
/api/hubs/{hub}/groups/{group}/connections/{connectionId}
Microsoft Azure Remove A Connection From The Target Group
microsoftAzureWebpubsubRemoveconnectionfromgroup 4 params → 200default
HEAD
/api/hubs/{hub}/users/{userId}
Microsoft Azure Check If There Are Any Client Connections Connected For The Given User
microsoftAzureWebpubsubUserexists 3 params → 200404default
POST
/api/hubs/{hub}/users/{userId}/:send
Microsoft Azure Send Content Inside Request Body To The Specific User
microsoftAzureWebpubsubSendtouser 3 params body → 202default
PUT
/api/hubs/{hub}/users/{userId}/groups/{group}
Microsoft Azure Add A User To The Target Group
microsoftAzureWebpubsubAddusertogroup 4 params → 200404default
DELETE
/api/hubs/{hub}/users/{userId}/groups/{group}
Microsoft Azure Remove A User From The Target Group
microsoftAzureWebpubsubRemoveuserfromgroup 4 params → 200default
DELETE
/api/hubs/{hub}/users/{userId}/groups
Microsoft Azure Remove A User From All Groups
microsoftAzureWebpubsubRemoveuserfromallgroups 3 params → 200default
PUT
/api/hubs/{hub}/permissions/{permission}/connections/{connectionId}
Microsoft Azure Grant Permission To The Connection
microsoftAzureWebpubsubGrantpermission 5 params → 200default
DELETE
/api/hubs/{hub}/permissions/{permission}/connections/{connectionId}
Microsoft Azure Revoke Permission For The Connection
microsoftAzureWebpubsubRevokepermission 5 params → 200default
HEAD
/api/hubs/{hub}/permissions/{permission}/connections/{connectionId}
Microsoft Azure Check If A Connection Has Permission To The Specified Action
microsoftAzureWebpubsubCheckpermission 5 params → 200404default
GET
/providers/Microsoft.SignalRService/operations
Microsoft Azure Get Providers Microsoft Signalrservice Operations
microsoftAzureOperationsList 1 param → 200default
POST
/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability
Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Signalrservice Locations Location Checknameavailability
microsoftAzureWebpubsubChecknameavailability 3 params body → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Signalrservice Locations Location Usages
microsoftAzureUsagesList 3 params → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/webPubSub
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Signalrservice Webpubsub
microsoftAzureWebpubsubListbysubscription 2 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub
microsoftAzureWebpubsubListbyresourcegroup 3 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename
microsoftAzureWebpubsubGet 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename
microsoftAzureWebpubsubCreateorupdate 4 params body → 200201202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename
microsoftAzureWebpubsubDelete 4 params → 200202204default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename
microsoftAzureWebpubsubUpdate 4 params body → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Customcertificates
microsoftAzureWebpubsubcustomcertificatesList 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates/{certificateName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Customcertificates Certificatename
microsoftAzureWebpubsubcustomcertificatesGet 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates/{certificateName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Customcertificates Certificatename
microsoftAzureWebpubsubcustomcertificatesCreateorupdate 5 params body → 200201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates/{certificateName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Customcertificates Certificatename
microsoftAzureWebpubsubcustomcertificatesDelete 5 params → 200204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Customdomains
microsoftAzureWebpubsubcustomdomainsList 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Customdomains Name
microsoftAzureWebpubsubcustomdomainsGet 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Customdomains Name
microsoftAzureWebpubsubcustomdomainsCreateorupdate 5 params body → 201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Customdomains Name
microsoftAzureWebpubsubcustomdomainsDelete 5 params → 200202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Hubs
microsoftAzureWebpubsubhubsList 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Hubs Hubname
microsoftAzureWebpubsubhubsGet 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Hubs Hubname
microsoftAzureWebpubsubhubsCreateorupdate 5 params body → 200201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Hubs Hubname
microsoftAzureWebpubsubhubsDelete 5 params → 200202204default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/listKeys
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Listkeys
microsoftAzureWebpubsubListkeys 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Privateendpointconnections
microsoftAzureWebpubsubprivateendpointconnectionsList 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Privateendpointconnections Privateendpointconnectionname
microsoftAzureWebpubsubprivateendpointconnectionsGet 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Privateendpointconnections Privateendpointconnectionname
microsoftAzureWebpubsubprivateendpointconnectionsUpdate 5 params body → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Privateendpointconnections Privateendpointconnectionname
microsoftAzureWebpubsubprivateendpointconnectionsDelete 5 params → 200202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateLinkResources
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Privatelinkresources
microsoftAzureWebpubsubprivatelinkresourcesList 4 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/regenerateKey
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Regeneratekey
microsoftAzureWebpubsubRegeneratekey 4 params body → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas
microsoftAzureWebpubsubreplicasList 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas Replicaname
microsoftAzureWebpubsubreplicasGet 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas Replicaname
microsoftAzureWebpubsubreplicasCreateorupdate 5 params body → 200201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas Replicaname
microsoftAzureWebpubsubreplicasDelete 5 params → 200204default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas Replicaname
microsoftAzureWebpubsubreplicasUpdate 5 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/restart
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas Replicaname Restart
microsoftAzureWebpubsubreplicasRestart 5 params → 202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas Replicaname Sharedprivatelinkresources
microsoftAzureWebpubsubreplicasharedprivatelinkresourcesList 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas Replicaname Sharedprivatelinkresources Sharedpriva…
microsoftAzureWebpubsubreplicasharedprivatelinkresourcesGet 6 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas Replicaname Sharedprivatelinkresources Sharedpriva…
microsoftAzureWebpubsubreplicasharedprivatelinkresourcesCreateorupdate 6 params body → 200201default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/skus
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Replicas Replicaname Skus
microsoftAzureWebpubsubListreplicaskus 5 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/restart
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Restart
microsoftAzureWebpubsubRestart 4 params → 202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Sharedprivatelinkresources
microsoftAzureWebpubsubsharedprivatelinkresourcesList 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Sharedprivatelinkresources Sharedprivatelinkresourcename
microsoftAzureWebpubsubsharedprivatelinkresourcesGet 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Sharedprivatelinkresources Sharedprivatelinkresourcename
microsoftAzureWebpubsubsharedprivatelinkresourcesCreateorupdate 5 params body → 200201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Sharedprivatelinkresources Sharedprivatelinkresourcename
microsoftAzureWebpubsubsharedprivatelinkresourcesDelete 5 params → 200202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/skus
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Signalrservice Webpubsub Resourcename Skus
microsoftAzureWebpubsubListskus 4 params → 200default

Schemas 78

The contract defines 78 schemas that model the data the API accepts and returns. The most detailed are WebPubSubProperties (19 properties), MetricSpecification (8 properties), SharedPrivateLinkResourceProperties (5 properties), Operation (5 properties). Each schema is shown below with its type and property counts.

PrivateLinkResourceProperties
object
Private link resource properties
4 properties
OperationList
object
Result of the request to list REST API operations. It contains a list of operations.
2 properties
ManagedIdentitySettings
object
Managed identity settings for upstream.
1 property
LogSpecification
object
Specifications of the Logs for Azure Monitoring.
2 properties
SkuList
object
The list skus operation response
2 properties
SkuCapacity
object
Describes scaling information of a sku.
5 properties
CustomCertificateList
object
Custom certificates list.
2 properties
PrivateEndpointACL
object
ACL for a private endpoint
1 property 1 required
ResourceLogConfiguration
object
Resource log configuration of a Microsoft.SignalRService resource.
1 property
PrivateLinkServiceConnectionState
object
Connection state of the private endpoint connection
3 properties
ShareablePrivateLinkResourceType
object
Describes a resource type that has been onboarded to private link service
2 properties
WebPubSubHub
object
A hub setting
1 property 1 required
SignalRServiceUsage
object
Object that describes a specific usage of the resources.
5 properties
WebPubSubResourceList
object
Object that includes an array of resources and a possible link for next set.
2 properties
OperationDisplay
object
The object that describes a operation.
4 properties
ServiceSpecification
object
An object that describes a specification.
2 properties
SignalRServiceUsageList
object
Object that includes an array of the resource usages and a possible link for next set.
2 properties
WebPubSubSocketIOSettings
object
SocketIO settings for the resource
1 property
WebPubSubProperties
object
A class that describes the properties of the resource
19 properties
ShareablePrivateLinkResourceProperties
object
Describes the properties of a resource type that has been onboarded to private link service
3 properties
OperationProperties
object
Extra Operation properties.
1 property
PrivateLinkResourceList
object
Contains a list of PrivateLinkResource and a possible link to query more results
2 properties
PrivateEndpointConnectionProperties
object
Private endpoint connection properties
4 properties
CustomDomainProperties
object
Properties of a custom domain.
3 properties 2 required
ReplicaProperties
object
3 properties
RegenerateKeyParameters
object
Parameters describes the request to regenerate access keys
1 property
ManagedIdentityType
string
Represents the identity type: systemAssigned, userAssigned, None
EventListenerEndpoint
object
An endpoint specifying where Web PubSub should send events to.
1 property 1 required
EventListenerFilter
object
A base class for event filter which determines whether an event should be sent to an event listener.
1 property 1 required
LiveTraceConfiguration
object
Live trace configuration of a Microsoft.SignalRService resource.
2 properties
WebPubSubRequestType
string
The incoming request type to the service
PrivateLinkServiceConnectionStatus
string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
NameAvailability
object
Result of the request to check name availability. It contains a flag and possible reason of failure.
3 properties
UserAssignedIdentityProperty
object
Properties of user assigned identity.
2 properties
CustomCertificate
object
A custom certificate.
1 property 1 required
ReplicaList
object
2 properties
EventHandler
object
Properties of event handler.
4 properties 1 required
NetworkACL
object
Network ACL
2 properties
ACLAction
string
Azure Networking ACL Action.
NameAvailabilityParameters
object
Data POST-ed to the nameAvailability action
2 properties 2 required
WebPubSubHubList
object
Hub setting list
2 properties
WebPubSubTlsSettings
object
TLS settings for the resource
1 property
WebPubSubHubProperties
object
Properties of a hub.
4 properties
PrivateEndpoint
object
Private endpoint
1 property
ScaleType
string
The scale type applicable to the sku.
Operation
object
REST API operation supported by resource provider.
5 properties
ManagedIdentity
object
A class represent managed identities used for request and response
4 properties
MetricSpecification
object
Specifications of the Metrics for Azure Monitoring.
8 properties
UpstreamAuthSettings
object
Upstream auth settings. If not set, no auth is used for upstream messages.
2 properties
ResourceLogCategory
object
Resource log category configuration of a Microsoft.SignalRService resource.
2 properties
SharedPrivateLinkResourceStatus
string
Status of the shared private link resource
ResourceReference
object
Reference to a resource.
1 property
LiveTraceCategory
object
Live trace category configuration of a Microsoft.SignalRService resource.
2 properties
PrivateEndpointConnection
object
A private endpoint connection to an azure resource
1 property
SharedPrivateLinkResourceProperties
object
Describes the properties of an existing Shared Private Link Resource
5 properties 2 required
Dimension
object
Specifications of the Dimension of metrics.
4 properties
ClientTokenResponse
object
1 property
ProvisioningState
string
Provisioning state of the resource.
ServiceKind
string
The kind of the service
SharedPrivateLinkResourceList
object
A list of shared private link resources
2 properties
WebPubSubKeys
object
A class represents the access keys of the resource.
4 properties
Replica
object
A class represent a replica resource.
2 properties
PrivateLinkResource
object
Private link resource
1 property
CustomCertificateProperties
object
Custom certificate properties.
4 properties 2 required
SharedPrivateLinkResource
object
Describes a Shared Private Link Resource
1 property
KeyType
string
The type of access key.
IPRule
object
An IP rule
2 properties
SignalRServiceUsageName
object
Localizable String object containing the name and a localized value.
2 properties
EventListener
object
A setting defines which kinds of events should be sent to which endpoint.
2 properties 2 required
WebPubSubSkuTier
string
Optional tier of this particular SKU. 'Standard' or 'Free'. Basic is deprecated, use Standard instead.
Sku
object
Describes an available sku."
3 properties
WebPubSubResource
object
A class represent a resource.
4 properties
CustomDomainList
object
Custom domains list
2 properties
CustomDomain
object
A custom domain
1 property 1 required
PrivateEndpointConnectionList
object
A list of private endpoint connections
2 properties
UpstreamAuthType
string
Upstream auth type enum.
WebPubSubNetworkACLs
object
Network ACLs for the resource
4 properties
ResourceSku
object
The billing information of the resource.
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-webpubsub-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
AE Profile APIs.io
Microsoft Azure Communication Services API
AE Profile APIs.io
Microsoft Azure Event Grid API
AE Profile APIs.io
Microsoft Azure Functions API
AE Profile APIs.io
Microsoft Azure DevOps REST API
AE Profile APIs.io
Microsoft Azure AI Foundry API
AE Profile APIs.io
Microsoft Azure Resource JSON Schema
AE Profile APIs.io
Microsoft Azure JSON-LD Context
AE Profile APIs.io
Microsoft Azure AccessConnector API
AE Profile APIs.io
Microsoft Azure AccessControlRecords API
AE Profile APIs.io
Microsoft Azure AccessPolicies API
AE Profile APIs.io
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
AE Profile APIs.io
#Web PubSub
← Back to M APIs
API Details
ID
microsoft-azure:microsoft-azure-webpubsub-api
Docs
https://learn.microsoft.com/en-us/rest/api/azure/
Provider
Microsoft Azure
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=microsoft-azure-webpubsub-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/microsoft-azure-webpubsub-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Microsoft Azure Webpubsub API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.