Share via

Notification interface

  • Reference
Package:
@azure/arm-apimanagement

Interface representing a Notification.

Methods

createOrUpdate(string, string, string, NotificationCreateOrUpdateOptionalParams)

Create or Update API Management publisher notification.
get(string, string, string, NotificationGetOptionalParams)

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

Lists a collection of properties defined within a service instance.

Method Details

createOrUpdate(string, string, string, NotificationCreateOrUpdateOptionalParams)

Create or Update API Management publisher notification.

function createOrUpdate(resourceGroupName: string, serviceName: string, notificationName: string, options?: NotificationCreateOrUpdateOptionalParams): 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.

notificationName

string

Notification Name Identifier.

options
NotificationCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<NotificationContract>

get(string, string, string, NotificationGetOptionalParams)

Gets the details of the Notification specified by its identifier.

function get(resourceGroupName: string, serviceName: string, notificationName: string, options?: NotificationGetOptionalParams): 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.

notificationName

string

Notification Name Identifier.

options
NotificationGetOptionalParams

The options parameters.

Returns

Promise<NotificationContract>

listByService(string, string, NotificationListByServiceOptionalParams)

Lists a collection of properties defined within a service instance.

function listByService(resourceGroupName: string, serviceName: string, options?: NotificationListByServiceOptionalParams): 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.

options
NotificationListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NotificationContract, NotificationContract[], PageSettings>