workspace_notification

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

Overview

Name	workspace_notification
Type	Resource
Id	azure.api_management.workspace_notification

Fields

The following fields are returned by SELECT queries:

get

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.
description	string	Description of the Notification.
recipients	object	Recipient Parameter values.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	Title of the Notification. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_service

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.
description	string	Description of the Notification.
recipients	object	Recipient Parameter values.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	Title of the Notification. Required.
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
get	select	resource_group_name, service_name, workspace_id, notification_name, subscription_id		Gets the details of the Notification specified by its identifier.
list_by_service	select	resource_group_name, service_name, workspace_id, subscription_id	$top, $skip	Lists a collection of properties defined within a service instance.
create_or_update	insert	resource_group_name, service_name, workspace_id, notification_name, subscription_id		Create or Update API Management publisher notification for the workspace.
create_or_update	replace	resource_group_name, service_name, workspace_id, notification_name, subscription_id		Create or Update API Management publisher notification for the workspace.

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
notification_name	string	Notification Name Identifier. 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.
$skip	integer	Number of records to skip. Default value is None.
$top	integer	Number of records to return. Default value is None.

SELECT examples

get

Gets the details of the Notification specified by its identifier.

SELECT
id,
name,
description,
recipients,
systemData,
title,
type
FROM azure.api_management.workspace_notification
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
;

list_by_service

Lists a collection of properties defined within a service instance.

SELECT
id,
name,
description,
recipients,
systemData,
title,
type
FROM azure.api_management.workspace_notification
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND workspace_id = '{{ workspace_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Create or Update API Management publisher notification for the workspace.

INSERT INTO azure.api_management.workspace_notification (
resource_group_name,
service_name,
workspace_id,
notification_name,
subscription_id
)
SELECT 
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ workspace_id }}',
'{{ notification_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

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

REPLACE examples

create_or_update

Create or Update API Management publisher notification for the workspace.

REPLACE azure.api_management.workspace_notification
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 subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;