Notification Recipient User - Create Or Update

Reference

Service:: API Management

API Version:: 2024-05-01

Adds the API Management User to the list of Recipients for the Notification.

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

URI Parameters

Name	In	Required	Type	Description
notificationName	path	True	NotificationName	Notification Name Identifier.
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.
userId	path	True	string	User identifier. Must be unique in the current API Management service instance.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	RecipientUserContract	Recipient User is already part of the notification list.
201 Created	RecipientUserContract	Recipient User was successfully added to the notification list.
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

ApiManagementCreateNotificationRecipientUser

Sample request

HTTP

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

Sample response

Status code:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642",
  "type": "Microsoft.ApiManagement/service/notifications/recipientUsers",
  "name": "576823d0a40f7e74ec07d642",
  "properties": {
    "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642"
  }
}

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642",
  "type": "Microsoft.ApiManagement/service/notifications/recipientUsers",
  "name": "576823d0a40f7e74ec07d642",
  "properties": {
    "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642"
  }
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
NotificationName	Notification Name Identifier.
RecipientUserContract	Recipient User details.

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.

NotificationName

Notification Name Identifier.

Name	Type	Description
AccountClosedPublisher	string	The following email recipients and users will receive email notifications when developer closes his account.
BCC	string	The following recipients will receive blind carbon copies of all emails sent to developers.
NewApplicationNotificationMessage	string	The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.
NewIssuePublisherNotificationMessage	string	The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.
PurchasePublisherNotificationMessage	string	The following email recipients and users will receive email notifications about new API product subscriptions.
QuotaLimitApproachingPublisherNotificationMessage	string	The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.
RequestPublisherNotificationMessage	string	The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.

RecipientUserContract

Recipient User 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.userId	string	API Management UserId subscribed to notification.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Share via