Microsoft Azure

Azure Notification Hubs

Microsoft Notification Hubs Resource Provider REST API.

Communication#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

Microsoft Notification Hubs Resource Provider REST API.

Endpoints 35

Hubs

  • POSTChecks the availability of the given notificationHub in a namespace./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/checkNotificationHubAvailability
  • GETGets the notification hub./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/notificationHubs/:notificationHubName
  • PUTCreates/Update a NotificationHub in a namespace./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/notificationHubs/:notificationHubName
  • DELETEDeletes a notification hub associated with a namespace./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/notificationHubs/:notificationHubName
  • PATCHPatch a NotificationHub in a namespace./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/notificationHubs/:notificationHubName
  • GETLists the notification hubs associated with a namespace./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/notificationHubs?$skipToken=string&$top=100
  • POSTTest send a push notification./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/notificationHubs/:notificationHubName/debugsend
  • GETGets an authorization rule for a NotificationHub by name./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/notificationHubs/:notificationHubName/authorizationRules/:authorizationRuleName
  • PUTCreates/Updates an authorization rule for a NotificationHub/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/notificationHubs/:notificationHubName/authorizationRules/:authorizationRuleName
  • DELETEDeletes a notificationHub authorization rule/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/notificationHubs/:notificationHubName/authorizationRules/:authorizationRuleName
  • GETGets the authorization rules for a NotificationHub./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/notificationHubs/:notificationHubName/authorizationRules
  • POSTGets the Primary and Secondary ConnectionStrings to the NotificationHub/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/notificationHubs/:notificationHubName/authorizationRules/:authorizationRuleName/listKeys
  • POSTRegenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/notificationHubs/:notificationHubName/authorizationRules/:authorizationRuleName/regenerateKeys
  • POSTLists the PNS Credentials associated with a notification hub./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/notificationHubs/:notificationHubName/pnsCredentials

Namespaces

  • POSTChecks the availability of the given service namespace across all Azure subscriptions. This is useful because the domain name is created based on the service namespace name./subscriptions/:subscriptionId/providers/Microsoft.NotificationHubs/checkNamespaceAvailability
  • GETReturns the given namespace./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName
  • PUTCreates / Updates a Notification Hub namespace. This operation is idempotent./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName
  • DELETEDeletes an existing namespace. This operation also removes all associated notificationHubs under the namespace./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName
  • PATCHPatches the existing namespace./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName
  • GETLists all the available namespaces within the subscription./subscriptions/:subscriptionId/providers/Microsoft.NotificationHubs/namespaces?$skipToken=string&$top=100
  • GETLists the available namespaces within a resource group./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces?$skipToken=string&$top=100
  • GETGets an authorization rule for a namespace by name./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/authorizationRules/:authorizationRuleName
  • PUTCreates an authorization rule for a namespace/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/authorizationRules/:authorizationRuleName
  • DELETEDeletes a namespace authorization rule/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/authorizationRules/:authorizationRuleName
  • GETGets the authorization rules for a namespace./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/authorizationRules
  • POSTGets the Primary and Secondary ConnectionStrings to the namespace./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/authorizationRules/:authorizationRuleName/listKeys
  • POSTRegenerates the Primary/Secondary Keys to the Namespace Authorization Rule/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/authorizationRules/:authorizationRuleName/regenerateKeys
  • POSTLists the PNS credentials associated with a namespace./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/pnsCredentials

Operations

  • GETLists all available Notification Hubs operations./providers/Microsoft.NotificationHubs/operations

PrivateLink

  • GETReturns a Private Endpoint Connection with a given name. This is a public API that can be called directly by Notification Hubs users./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/privateEndpointConnections/:privateEndpointConnectionName
  • PUTApproves or rejects Private Endpoint Connection. This is a public API that can be called directly by Notification Hubs users./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/privateEndpointConnections/:privateEndpointConnectionName
  • DELETEDeletes the Private Endpoint Connection. This is a public API that can be called directly by Notification Hubs users./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/privateEndpointConnections/:privateEndpointConnectionName
  • GETReturns all Private Endpoint Connections that belong to the given Notification Hubs namespace. This is a public API that can be called directly by Notification Hubs users./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/privateEndpointConnections
  • GETReturns Group Id response. This is a public API required by the Networking RP contract. It can be used directly by Notification Hubs users./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/privateLinkResources/:subResourceNameEven though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's…
  • GETReturns all Group Ids supported by the Notification Hubs RP. This is a public API required by the Networking RP contract. It can be used directly by Notification Hubs users./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/privateLinkResourcesEven though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's…

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
35 operations on 23 pathsGET 14POST 9PUT 5DELETE 5PATCH 2
Main resources
Hubs 14Namespaces 14PrivateLink 6Operations 1
Description format
Swagger 2.0, API version 2023-09-01

How to test the Azure Notification Hubs 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 Notification Hubs 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 “Checks the availability of the given notificationHub in a namespace.” (POST /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.NotificationHubs/namespaces/:namespaceName/checkNotificationHubAvailability), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Notification Hubs?

Microsoft Notification Hubs Resource Provider REST API. It is listed under Communication and has 35 endpoints.

Who publishes the Azure Notification Hubs?

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 Notification Hubs?

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

How do I authenticate with the Azure Notification Hubs?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Notification Hubs have?

35 operations on 23 paths (14 GET, 9 POST, 5 PUT, 5 DELETE, 2 PATCH). The largest groups are Hubs, Namespaces, PrivateLink, Operations.

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