Notification - List By Service

Reference

Service:: API Management

API Version:: 2024-05-01

Lists a collection of properties defined within a service instance.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications?api-version=2024-05-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications?$top={$top}&$skip={$skip}&api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
serviceName	path	True	string	The name of the API Management service. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.
$skip	query		integer int32	Number of records to skip.
$top	query		integer int32	Number of records to return.

Responses

Name	Type	Description
200 OK	NotificationCollection	A Collection of the Notification for the specified API Management service instance.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ApiManagementListNotifications

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications?api-version=2024-05-01

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage",
      "type": "Microsoft.ApiManagement/service/notifications",
      "name": "RequestPublisherNotificationMessage",
      "properties": {
        "title": "Subscription requests (requiring approval)",
        "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.",
        "recipients": {
          "emails": [
            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com",
            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live",
            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com"
          ],
          "users": [
            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642"
          ]
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/PurchasePublisherNotificationMessage",
      "type": "Microsoft.ApiManagement/service/notifications",
      "name": "PurchasePublisherNotificationMessage",
      "properties": {
        "title": "New subscriptions",
        "description": "The following email recipients and users will receive email notifications about new API product subscriptions.",
        "recipients": {
          "emails": [
            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com"
          ],
          "users": [
            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"
          ]
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/NewApplicationNotificationMessage",
      "type": "Microsoft.ApiManagement/service/notifications",
      "name": "NewApplicationNotificationMessage",
      "properties": {
        "title": "Application gallery requests",
        "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.",
        "recipients": {
          "emails": [
            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com"
          ],
          "users": []
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/BCC",
      "type": "Microsoft.ApiManagement/service/notifications",
      "name": "BCC",
      "properties": {
        "title": "BCC",
        "description": "The following recipients will receive blind carbon copies of all emails sent to developers.",
        "recipients": {
          "emails": [],
          "users": []
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/NewIssuePublisherNotificationMessage",
      "type": "Microsoft.ApiManagement/service/notifications",
      "name": "NewIssuePublisherNotificationMessage",
      "properties": {
        "title": "New issue or comment",
        "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.",
        "recipients": {
          "emails": [],
          "users": [
            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"
          ]
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/AccountClosedPublisher",
      "type": "Microsoft.ApiManagement/service/notifications",
      "name": "AccountClosedPublisher",
      "properties": {
        "title": "Close account message",
        "description": "The following email recipients and users will receive email notifications when developer closes his account",
        "recipients": {
          "emails": [
            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com"
          ],
          "users": []
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/QuotaLimitApproachingPublisherNotificationMessage",
      "type": "Microsoft.ApiManagement/service/notifications",
      "name": "QuotaLimitApproachingPublisherNotificationMessage",
      "properties": {
        "title": "Approaching subscription quota limit",
        "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.",
        "recipients": {
          "emails": [],
          "users": [
            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"
          ]
        }
      }
    }
  ],
  "count": 7,
  "nextLink": ""
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
NotificationCollection	Paged Notification list representation.
NotificationContract	Notification details.
RecipientsContractProperties	Notification Parameter contract.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

NotificationCollection

Paged Notification list representation.

Name	Type	Description
count	integer	Total record count number across all pages.
nextLink	string	Next page link if any.
value	NotificationContract[]	Page values.

NotificationContract

Notification details.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.description	string	Description of the Notification.
properties.recipients	RecipientsContractProperties	Recipient Parameter values.
properties.title	string	Title of the Notification.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

RecipientsContractProperties

Notification Parameter contract.

Name	Type	Description
emails	string[]	List of Emails subscribed for the notification.
users	string[]	List of Users subscribed for the notification.

Share via