workspace_notification_recipient_emails

Creates, updates, deletes, gets or lists a workspace_notification_recipient_emails resource.

Overview

Name	workspace_notification_recipient_emails
Type	Resource
Id	azure.api_management.workspace_notification_recipient_emails

Fields

The following fields are returned by SELECT queries:

list_by_notification

The response body contains the Recipient Email collection subscribed to the notification.

Name	Datatype	Description
properties	object	Recipient Email contract properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_notification	select	resourceGroupName, serviceName, workspaceId, notificationName, subscriptionId		Gets the list of the Notification Recipient Emails subscribed to a notification.
create_or_update	insert	resourceGroupName, serviceName, workspaceId, notificationName, email, subscriptionId		Adds the Email address to the list of Recipients for the Notification.
delete	delete	resourceGroupName, serviceName, workspaceId, notificationName, email, subscriptionId		Removes the email from the list of Notification.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
email	string	Email identifier.
notificationName	string	Notification Name Identifier.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.
workspaceId	string	Workspace identifier. Must be unique in the current API Management service instance.

SELECT examples

list_by_notification

Gets the list of the Notification Recipient Emails subscribed to a notification.

SELECT
properties
FROM azure.api_management.workspace_notification_recipient_emails
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND workspaceId = '{{ workspaceId }}' -- required
AND notificationName = '{{ notificationName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Adds the Email address to the list of Recipients for the Notification.

INSERT INTO azure.api_management.workspace_notification_recipient_emails (
resourceGroupName,
serviceName,
workspaceId,
notificationName,
email,
subscriptionId
)
SELECT 
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ workspaceId }}',
'{{ notificationName }}',
'{{ email }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: workspace_notification_recipient_emails
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspace_notification_recipient_emails resource.
    - name: serviceName
      value: string
      description: Required parameter for the workspace_notification_recipient_emails resource.
    - name: workspaceId
      value: string
      description: Required parameter for the workspace_notification_recipient_emails resource.
    - name: notificationName
      value: string
      description: Required parameter for the workspace_notification_recipient_emails resource.
    - name: email
      value: string
      description: Required parameter for the workspace_notification_recipient_emails resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the workspace_notification_recipient_emails resource.

DELETE examples

delete

Removes the email from the list of Notification.

DELETE FROM azure.api_management.workspace_notification_recipient_emails
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND workspaceId = '{{ workspaceId }}' --required
AND notificationName = '{{ notificationName }}' --required
AND email = '{{ email }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;