Share via

WorkspaceNotification interface

Package:
@azure/arm-apimanagement

Interface representing a WorkspaceNotification.

Methods

createOrUpdate(string, string, string, string, WorkspaceNotificationCreateOrUpdateOptionalParams)

Create or Update API Management publisher notification for the workspace.
get(string, string, string, string, WorkspaceNotificationGetOptionalParams)

Gets the details of the Notification specified by its identifier.
listByService(string, string, string, WorkspaceNotificationListByServiceOptionalParams)

Lists a collection of properties defined within a service instance.

Method Details

createOrUpdate(string, string, string, string, WorkspaceNotificationCreateOrUpdateOptionalParams)

Create or Update API Management publisher notification for the workspace.

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, notificationName: string, options?: WorkspaceNotificationCreateOrUpdateOptionalParams): Promise<NotificationContract>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

workspaceId

string

Workspace identifier. Must be unique in the current API Management service instance.

notificationName

string

Notification Name Identifier.

options
WorkspaceNotificationCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<NotificationContract>

get(string, string, string, string, WorkspaceNotificationGetOptionalParams)

Gets the details of the Notification specified by its identifier.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, notificationName: string, options?: WorkspaceNotificationGetOptionalParams): Promise<NotificationContract>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

workspaceId

string

Workspace identifier. Must be unique in the current API Management service instance.

notificationName

string

Notification Name Identifier.

options
WorkspaceNotificationGetOptionalParams

The options parameters.

Returns

Promise<NotificationContract>

listByService(string, string, string, WorkspaceNotificationListByServiceOptionalParams)

Lists a collection of properties defined within a service instance.

function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceNotificationListByServiceOptionalParams): PagedAsyncIterableIterator<NotificationContract, NotificationContract[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

workspaceId

string

Workspace identifier. Must be unique in the current API Management service instance.

options
WorkspaceNotificationListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NotificationContract, NotificationContract[], PageSettings>