Microsoft Azure

Azure Webpubsub (2024-03-01)

REST API for Azure WebPubSub Service

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

REST API for Azure WebPubSub Service

Endpoints 44

WebPubSub

  • GETOperations_List/providers/Microsoft.SignalRService/operationsLists all of the available REST API operations of the Microsoft.SignalRService provider.
  • POSTWebPubSub_CheckNameAvailability/subscriptions/:subscriptionId/providers/Microsoft.SignalRService/locations/:location/checkNameAvailabilityChecks that the resource name is valid and is not already in use.
  • GETUsages_List/subscriptions/:subscriptionId/providers/Microsoft.SignalRService/locations/:location/usagesList resource usage quotas by location.
  • GETWebPubSub_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.SignalRService/webPubSubHandles requests to list all resources in a subscription.
  • GETWebPubSub_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSubHandles requests to list all resources in a resource group.
  • GETWebPubSub_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceNameGet the resource and its properties.
  • PUTWebPubSub_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceNameCreate or update a resource.
  • DELETEWebPubSub_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceNameOperation to delete a resource.
  • PATCHWebPubSub_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceNameOperation to update an exiting resource.
  • GETWebPubSubCustomCertificates_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/customCertificatesList all custom certificates.
  • GETWebPubSubCustomCertificates_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/customCertificates/:certificateNameGet a custom certificate.
  • PUTWebPubSubCustomCertificates_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/customCertificates/:certificateNameCreate or update a custom certificate.
  • DELETEWebPubSubCustomCertificates_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/customCertificates/:certificateNameDelete a custom certificate.
  • GETWebPubSubCustomDomains_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/customDomainsList all custom domains.
  • GETWebPubSubCustomDomains_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/customDomains/:nameGet a custom domain.
  • PUTWebPubSubCustomDomains_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/customDomains/:nameCreate or update a custom domain.
  • DELETEWebPubSubCustomDomains_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/customDomains/:nameDelete a custom domain.
  • GETWebPubSubHubs_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/hubsList hub settings.
  • GETWebPubSubHubs_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/hubs/:hubNameGet a hub setting.
  • PUTWebPubSubHubs_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/hubs/:hubNameCreate or update a hub setting.
  • DELETEWebPubSubHubs_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/hubs/:hubNameDelete a hub setting.
  • POSTWebPubSub_ListKeys/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/listKeysGet the access keys of the resource.
  • GETWebPubSubPrivateEndpointConnections_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/privateEndpointConnectionsList private endpoint connections
  • GETWebPubSubPrivateEndpointConnections_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/privateEndpointConnections/:privateEndpointConnectionNameGet the specified private endpoint connection
  • PUTWebPubSubPrivateEndpointConnections_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/privateEndpointConnections/:privateEndpointConnectionNameUpdate the state of specified private endpoint connection
  • DELETEWebPubSubPrivateEndpointConnections_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/privateEndpointConnections/:privateEndpointConnectionNameDelete the specified private endpoint connection
  • GETWebPubSubPrivateLinkResources_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/privateLinkResourcesGet the private link resources that need to be created for a resource.
  • POSTWebPubSub_RegenerateKey/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/regenerateKeyRegenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
  • GETWebPubSubReplicas_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/replicasList all replicas belong to this resource
  • GETWebPubSubReplicas_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/replicas/:replicaNameGet the replica and its properties.
  • PUTWebPubSubReplicas_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/replicas/:replicaNameCreate or update a replica.
  • DELETEWebPubSubReplicas_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/replicas/:replicaNameOperation to delete a replica.
  • PATCHWebPubSubReplicas_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/replicas/:replicaNameOperation to update an exiting replica.
  • POSTWebPubSubReplicas_Restart/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/replicas/:replicaName/restartOperation to restart a replica.
  • GETWebPubSubReplicaSharedPrivateLinkResources_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/replicas/:replicaName/sharedPrivateLinkResourcesList shared private link resources
  • GETWebPubSubReplicaSharedPrivateLinkResources_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/replicas/:replicaName/sharedPrivateLinkResources/:sharedPrivateLinkResourceNameGet the specified shared private link resource
  • PUTWebPubSubReplicaSharedPrivateLinkResources_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/replicas/:replicaName/sharedPrivateLinkResources/:sharedPrivateLinkResourceNameCreate or update a shared private link resource
  • GETWebPubSub_ListReplicaSkus/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/replicas/:replicaName/skusList all available skus of the replica resource.
  • POSTWebPubSub_Restart/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/restartOperation to restart a resource.
  • GETWebPubSubSharedPrivateLinkResources_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/sharedPrivateLinkResourcesList shared private link resources
  • GETWebPubSubSharedPrivateLinkResources_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/sharedPrivateLinkResources/:sharedPrivateLinkResourceNameGet the specified shared private link resource
  • PUTWebPubSubSharedPrivateLinkResources_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/sharedPrivateLinkResources/:sharedPrivateLinkResourceNameCreate or update a shared private link resource
  • DELETEWebPubSubSharedPrivateLinkResources_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/sharedPrivateLinkResources/:sharedPrivateLinkResourceNameDelete the specified shared private link resource
  • GETWebPubSub_ListSkus/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/webPubSub/:resourceName/skusList all available skus of the resource.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
44 operations on 27 pathsGET 22PUT 8DELETE 7POST 5PATCH 2
Main resources
WebPubSub 44
Response formats
application/json
Description format
Swagger 2.0, API version 2024-03-01

How to test the Azure Webpubsub (2024-03-01) in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Webpubsub (2024-03-01) collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Operations_List” (GET /providers/Microsoft.SignalRService/operations), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Webpubsub (2024-03-01)?

REST API for Azure WebPubSub Service It is listed under Developer tools and has 44 endpoints.

Who publishes the Azure Webpubsub (2024-03-01)?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Webpubsub (2024-03-01)?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Webpubsub (2024-03-01)?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Webpubsub (2024-03-01) have?

44 operations on 27 paths (22 GET, 8 PUT, 7 DELETE, 5 POST, 2 PATCH). The largest groups are WebPubSub.

Is forking the Azure Webpubsub (2024-03-01) free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.