Notifications Interface

public interface Notifications

Resource collection API of Notifications.

Method Summary

Modifier and Type Method and Description
abstract NotificationContract createOrUpdate(String resourceGroupName, String serviceName, NotificationName notificationName)

Create or Update API Management publisher notification.

abstract Response<NotificationContract> createOrUpdateWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, String ifMatch, Context context)

Create or Update API Management publisher notification.

abstract NotificationContract get(String resourceGroupName, String serviceName, NotificationName notificationName)

Gets the details of the Notification specified by its identifier.

abstract Response<NotificationContract> getWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, Context context)

Gets the details of the Notification specified by its identifier.

abstract PagedIterable<NotificationContract> listByService(String resourceGroupName, String serviceName)

Lists a collection of properties defined within a service instance.

abstract PagedIterable<NotificationContract> listByService(String resourceGroupName, String serviceName, Integer top, Integer skip, Context context)

Lists a collection of properties defined within a service instance.

Method Details

createOrUpdate

public abstract NotificationContract createOrUpdate(String resourceGroupName, String serviceName, NotificationName notificationName)

Create or Update API Management publisher notification.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
notificationName - Notification Name Identifier.

Returns:

notification details.

createOrUpdateWithResponse

public abstract Response createOrUpdateWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, String ifMatch, Context context)

Create or Update API Management publisher notification.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
notificationName - Notification Name Identifier.
ifMatch - ETag of the Entity. Not required when creating an entity, but required when updating an entity.
context - The context to associate with this operation.

Returns:

notification details along with Response<T>.

get

public abstract NotificationContract get(String resourceGroupName, String serviceName, NotificationName notificationName)

Gets the details of the Notification specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
notificationName - Notification Name Identifier.

Returns:

the details of the Notification specified by its identifier.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, Context context)

Gets the details of the Notification specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
notificationName - Notification Name Identifier.
context - The context to associate with this operation.

Returns:

the details of the Notification specified by its identifier along with Response<T>.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName)

Lists a collection of properties defined within a service instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.

Returns:

paged Notification list representation as paginated response with PagedIterable<T>.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName, Integer top, Integer skip, Context context)

Lists a collection of properties defined within a service instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
top - Number of records to return.
skip - Number of records to skip.
context - The context to associate with this operation.

Returns:

paged Notification list representation as paginated response with PagedIterable<T>.

Applies to