workspace_notification_recipient_email

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

Overview

Name	workspace_notification_recipient_email
Type	Resource
Id	azure.api_management.workspace_notification_recipient_email

Fields

The following fields are returned by SELECT queries:

list_by_notification

Name	Datatype	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.
email	string	User Email subscribed to notification.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_notification	select	resource_group_name, service_name, workspace_id, notification_name, subscription_id		Gets the list of the Notification Recipient Emails subscribed to a notification.
create_or_update	insert	resource_group_name, service_name, workspace_id, notification_name, email, subscription_id		Adds the Email address to the list of Recipients for the Notification.
create_or_update	replace	resource_group_name, service_name, workspace_id, notification_name, email, subscription_id		Adds the Email address to the list of Recipients for the Notification.
delete	delete	resource_group_name, service_name, workspace_id, notification_name, email, subscription_id		Removes the email from the list of Notification.
check_entity_exists	exec	resource_group_name, service_name, workspace_id, notification_name, email, subscription_id		Determine if Notification Recipient Email subscribed to the 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. Required.
notification_name	string	Workspace identifier. Must be unique in the current API Management service instance. Known values are: "RequestPublisherNotificationMessage", "PurchasePublisherNotificationMessage", "NewApplicationNotificationMessage", "BCC", "NewIssuePublisherNotificationMessage", "AccountClosedPublisher", and "QuotaLimitApproachingPublisherNotificationMessage". Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
workspace_id	string	Workspace identifier. Must be unique in the current API Management service instance. Required.

SELECT examples

list_by_notification

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

SELECT
id,
name,
email,
systemData,
type
FROM azure.api_management.workspace_notification_recipient_email
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND workspace_id = '{{ workspace_id }}' -- required
AND notification_name = '{{ notification_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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_email (
resource_group_name,
service_name,
workspace_id,
notification_name,
email,
subscription_id
)
SELECT 
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ workspace_id }}',
'{{ notification_name }}',
'{{ email }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: workspace_notification_recipient_email
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspace_notification_recipient_email resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the workspace_notification_recipient_email resource.
  - name: workspace_id
    value: "{{ workspace_id }}"
    description: Required parameter for the workspace_notification_recipient_email resource.
  - name: notification_name
    value: "{{ notification_name }}"
    description: Required parameter for the workspace_notification_recipient_email resource.
  - name: email
    value: "{{ email }}"
    description: Required parameter for the workspace_notification_recipient_email resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspace_notification_recipient_email resource.

REPLACE examples

create_or_update

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

REPLACE azure.api_management.workspace_notification_recipient_email
SET 
-- No updatable properties
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND workspace_id = '{{ workspace_id }}' --required
AND notification_name = '{{ notification_name }}' --required
AND email = '{{ email }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Removes the email from the list of Notification.

DELETE FROM azure.api_management.workspace_notification_recipient_email
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND workspace_id = '{{ workspace_id }}' --required
AND notification_name = '{{ notification_name }}' --required
AND email = '{{ email }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

check_entity_exists

Determine if Notification Recipient Email subscribed to the notification.

EXEC azure.api_management.workspace_notification_recipient_email.check_entity_exists 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@workspace_id='{{ workspace_id }}' --required, 
@notification_name='{{ notification_name }}' --required, 
@email='{{ email }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;