Workspace Notification Recipient Email - Create Or Update
Adds the Email address to the list of Recipients for the Notification.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientEmails/{email}?api-version=2024-05-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
email
|
path | True |
string |
Email identifier. |
notification
|
path | True |
Notification Name Identifier. |
|
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
service
|
path | True |
string |
The name of the API Management service. Regex pattern: |
subscription
|
path | True |
string uuid |
The ID of the target subscription. The value must be an UUID. |
workspace
|
path | True |
string |
Workspace identifier. Must be unique in the current API Management service instance. Regex pattern: |
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Recipient Email is already part of the notification list. |
|
201 Created |
Recipient Email was successfully added to the notification list. |
|
Other Status Codes |
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
ApiManagementCreateWorkspaceNotificationRecipientEmail
Sample request
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com?api-version=2024-05-01
Sample response
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com",
"type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails",
"name": "foobar@live.com",
"properties": {
"email": "foobar@live.com"
}
}
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com",
"type": "Microsoft.ApiManagement/service/workspaces/notifications/recipientEmails",
"name": "foobar@live.com",
"properties": {
"email": "foobar@live.com"
}
}
Definitions
Name | Description |
---|---|
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Notification |
Notification Name Identifier. |
Recipient |
Recipient Email 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 |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
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. |
RecipientEmailContract
Recipient Email 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.email |
string |
User Email subscribed to notification. |
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |