workspace_notification_recipient_users

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

Overview

Name	workspace_notification_recipient_users
Type	Resource
Id	azure.api_management.workspace_notification_recipient_users

Fields

The following fields are returned by SELECT queries:

list_by_notification

The response body contains the Recipient User collection for the notification.

Name	Datatype	Description
properties	object	Recipient User entity 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 User subscribed to the notification.
create_or_update	insert	resourceGroupName, serviceName, workspaceId, notificationName, userId, subscriptionId		Adds the API Management User to the list of Recipients for the Notification.
delete	delete	resourceGroupName, serviceName, workspaceId, notificationName, userId, subscriptionId		Removes the API Management user 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
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.
userId	string	User identifier. Must be unique in the current API Management service instance.
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 User subscribed to the notification.

SELECT
properties
FROM azure.api_management.workspace_notification_recipient_users
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 API Management User to the list of Recipients for the Notification.

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

Manifest

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

DELETE examples

delete

Removes the API Management user from the list of Notification.

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