workspace_notifications

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

Overview

Name	workspace_notifications
Type	Resource
Id	azure.api_management.workspace_notifications

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified Notification.

Name	Datatype	Description
properties	object	Notification entity contract properties.

list_by_service

A Collection of the Notification for the specified workspace in a API Management service instance.

Name	Datatype	Description
properties	object	Notification entity contract properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, workspaceId, notificationName, subscriptionId		Gets the details of the Notification specified by its identifier.
list_by_service	select	resourceGroupName, serviceName, workspaceId, subscriptionId	$top, $skip	Lists a collection of properties defined within a service instance.
create_or_update	insert	resourceGroupName, serviceName, workspaceId, notificationName, subscriptionId	If-Match	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
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.
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

SELECT examples

get

Gets the details of the Notification specified by its identifier.

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

list_by_service

Lists a collection of properties defined within a service instance.

SELECT
properties
FROM azure.api_management.workspace_notifications
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND workspaceId = '{{ workspaceId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- 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_notifications (
resourceGroupName,
serviceName,
workspaceId,
notificationName,
subscriptionId,
If-Match
)
SELECT 
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ workspaceId }}',
'{{ notificationName }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: workspace_notifications
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspace_notifications resource.
    - name: serviceName
      value: string
      description: Required parameter for the workspace_notifications resource.
    - name: workspaceId
      value: string
      description: Required parameter for the workspace_notifications resource.
    - name: notificationName
      value: string
      description: Required parameter for the workspace_notifications resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the workspace_notifications resource.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.