Microsoft Azure

Azure API Management: Apimnotifications

Use these REST APIs for performing operations on who is going to receive notifications associated with your Azure API Management deployment.

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

Use these REST APIs for performing operations on who is going to receive notifications associated with your Azure API Management deployment.

Endpoints 11

Notification

  • GETNotification_ListByService/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/notificationsLists a collection of properties defined within a service instance.
  • GETNotification_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/notifications/:notificationNameGets the details of the Notification specified by its identifier.
  • PUTNotification_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/notifications/:notificationNameCreate or Update API Management publisher notification.

NotificationRecipientUser

  • GETNotificationRecipientUser_ListByNotification/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/notifications/:notificationName/recipientUsersGets the list of the Notification Recipient User subscribed to the notification.
  • PUTNotificationRecipientUser_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/notifications/:notificationName/recipientUsers/:userIdAdds the API Management User to the list of Recipients for the Notification.
  • DELETENotificationRecipientUser_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/notifications/:notificationName/recipientUsers/:userIdRemoves the API Management user from the list of Notification.
  • HEADNotificationRecipientUser_CheckEntityExists/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/notifications/:notificationName/recipientUsers/:userIdDetermine if the Notification Recipient User is subscribed to the notification.

NotificationRecipientEmail

  • GETNotificationRecipientEmail_ListByNotification/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/notifications/:notificationName/recipientEmailsGets the list of the Notification Recipient Emails subscribed to a notification.
  • PUTNotificationRecipientEmail_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/notifications/:notificationName/recipientEmails/:emailAdds the Email address to the list of Recipients for the Notification.
  • DELETENotificationRecipientEmail_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/notifications/:notificationName/recipientEmails/:emailRemoves the email from the list of Notification.
  • HEADNotificationRecipientEmail_CheckEntityExists/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/notifications/:notificationName/recipientEmails/:emailDetermine if Notification Recipient Email subscribed to the notification.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
11 operations on 6 pathsGET 4PUT 3HEAD 2DELETE 2
Main resources
NotificationRecipientEmail 4NotificationRecipientUser 4Notification 3
Response formats
application/json
Description format
Swagger 2.0, API version 2024-05-01

How to test the Azure API Management: Apimnotifications 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 API Management: Apimnotifications 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 “Notification_ListByService” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/notifications), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure API Management: Apimnotifications?

Use these REST APIs for performing operations on who is going to receive notifications associated with your Azure API Management deployment. It is listed under Developer tools and has 11 endpoints.

Who publishes the Azure API Management: Apimnotifications?

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 API Management: Apimnotifications?

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

How do I authenticate with the Azure API Management: Apimnotifications?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure API Management: Apimnotifications have?

11 operations on 6 paths (4 GET, 3 PUT, 2 HEAD, 2 DELETE). The largest groups are NotificationRecipientEmail, NotificationRecipientUser, Notification.

Is forking the Azure API Management: Apimnotifications 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.