Microsoft Azure

Azure SignalR

REST API for Azure SignalR Service

Developer tools#openapi#cloud

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 SignalR Service

Endpoints 40

SignalR

  • GETOperations_List/providers/Microsoft.SignalRService/operationsLists all of the available REST API operations of the Microsoft.SignalRService provider.
  • POSTSignalR_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.
  • GETSignalR_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.SignalRService/signalRHandles requests to list all resources in a subscription.
  • GETSignalR_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalRHandles requests to list all resources in a resource group.
  • GETSignalR_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceNameGet the resource and its properties.
  • PUTSignalR_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceNameCreate or update a resource.
  • DELETESignalR_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceNameOperation to delete a resource.
  • PATCHSignalR_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceNameOperation to update an exiting resource.
  • GETSignalRCustomCertificates_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/customCertificatesList all custom certificates.
  • GETSignalRCustomCertificates_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/customCertificates/:certificateNameGet a custom certificate.
  • PUTSignalRCustomCertificates_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/customCertificates/:certificateNameCreate or update a custom certificate.
  • DELETESignalRCustomCertificates_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/customCertificates/:certificateNameDelete a custom certificate.
  • GETSignalRCustomDomains_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/customDomainsList all custom domains.
  • GETSignalRCustomDomains_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/customDomains/:nameGet a custom domain.
  • PUTSignalRCustomDomains_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/customDomains/:nameCreate or update a custom domain.
  • DELETESignalRCustomDomains_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/customDomains/:nameDelete a custom domain.
  • POSTSignalR_ListKeys/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/listKeysGet the access keys of the resource.
  • GETSignalRPrivateEndpointConnections_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/privateEndpointConnectionsList private endpoint connections
  • GETSignalRPrivateEndpointConnections_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/privateEndpointConnections/:privateEndpointConnectionNameGet the specified private endpoint connection
  • PUTSignalRPrivateEndpointConnections_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/privateEndpointConnections/:privateEndpointConnectionNameUpdate the state of specified private endpoint connection
  • DELETESignalRPrivateEndpointConnections_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/privateEndpointConnections/:privateEndpointConnectionNameDelete the specified private endpoint connection
  • GETSignalRPrivateLinkResources_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/privateLinkResourcesGet the private link resources that need to be created for a resource.
  • POSTSignalR_RegenerateKey/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/regenerateKeyRegenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
  • GETSignalRReplicas_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/replicasList all replicas belong to this resource
  • GETSignalRReplicas_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/replicas/:replicaNameGet the replica and its properties.
  • PUTSignalRReplicas_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/replicas/:replicaNameCreate or update a replica.
  • DELETESignalRReplicas_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/replicas/:replicaNameOperation to delete a replica.
  • PATCHSignalRReplicas_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/replicas/:replicaNameOperation to update an exiting replica.
  • POSTSignalRReplicas_Restart/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/replicas/:replicaName/restartOperation to restart a replica.
  • GETSignalRReplicaSharedPrivateLinkResources_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/replicas/:replicaName/sharedPrivateLinkResourcesList shared private link resources
  • GETSignalRReplicaSharedPrivateLinkResources_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/replicas/:replicaName/sharedPrivateLinkResources/:sharedPrivateLinkResourceNameGet the specified shared private link resource
  • PUTSignalRReplicaSharedPrivateLinkResources_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/replicas/:replicaName/sharedPrivateLinkResources/:sharedPrivateLinkResourceNameCreate or update a shared private link resource
  • GETSignalR_ListReplicaSkus/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/replicas/:replicaName/skusList all available skus of the replica resource.
  • POSTSignalR_Restart/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/restartOperation to restart a resource.
  • GETSignalRSharedPrivateLinkResources_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/sharedPrivateLinkResourcesList shared private link resources
  • GETSignalRSharedPrivateLinkResources_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/sharedPrivateLinkResources/:sharedPrivateLinkResourceNameGet the specified shared private link resource
  • PUTSignalRSharedPrivateLinkResources_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/sharedPrivateLinkResources/:sharedPrivateLinkResourceNameCreate or update a shared private link resource
  • DELETESignalRSharedPrivateLinkResources_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/:resourceName/sharedPrivateLinkResources/:sharedPrivateLinkResourceNameDelete the specified shared private link resource
  • GETSignalR_ListSkus/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.SignalRService/signalR/: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
40 operations on 25 pathsGET 20PUT 7DELETE 6POST 5PATCH 2
Main resources
SignalR 40
Response formats
application/json
Description format
Swagger 2.0, API version 2024-03-01

How to test the Azure SignalR 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 SignalR 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 SignalR?

REST API for Azure SignalR Service It is listed under Developer tools and has 40 endpoints.

Who publishes the Azure SignalR?

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 SignalR?

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

How do I authenticate with the Azure SignalR?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure SignalR have?

40 operations on 25 paths (20 GET, 7 PUT, 6 DELETE, 5 POST, 2 PATCH). The largest groups are SignalR.

Is forking the Azure SignalR 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.