Package com.azure.resourcemanager.apimanagement.models

Interface Notifications

public interface Notifications

Resource collection API of Notifications.

Method Summary

Modifier and Type	Method	Description
NotificationContract	createOrUpdate(String resourceGroupName, String serviceName, NotificationName notificationName)	Create or Update API Management publisher notification.
com.azure.core.http.rest.Response<NotificationContract>	createOrUpdateWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, String ifMatch, com.azure.core.util.Context context)	Create or Update API Management publisher notification.
NotificationContract	get(String resourceGroupName, String serviceName, NotificationName notificationName)	Gets the details of the Notification specified by its identifier.
com.azure.core.http.rest.Response<NotificationContract>	getWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, com.azure.core.util.Context context)	Gets the details of the Notification specified by its identifier.
com.azure.core.http.rest.PagedIterable<NotificationContract>	listByService(String resourceGroupName, String serviceName)	Lists a collection of properties defined within a service instance.
com.azure.core.http.rest.PagedIterable<NotificationContract>	listByService(String resourceGroupName, String serviceName, Integer top, Integer skip, com.azure.core.util.Context context)	Lists a collection of properties defined within a service instance.

Method Detail

listByService

com.azure.core.http.rest.PagedIterable<NotificationContract> listByService(String resourceGroupName,
                                                                           String serviceName)

Lists a collection of properties defined within a service instance.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

paged Notification list representation as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByService

com.azure.core.http.rest.PagedIterable<NotificationContract> listByService(String resourceGroupName,
                                                                           String serviceName,
                                                                           Integer top,
                                                                           Integer skip,
                                                                           com.azure.core.util.Context context)

Lists a collection of properties defined within a service instance.

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

get

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.

serviceName - The name of the API Management service.

notificationName - Notification Name Identifier.

Returns:

the details of the Notification specified by its identifier.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponse

com.azure.core.http.rest.Response<NotificationContract> getWithResponse(String resourceGroupName,
                                                                        String serviceName,
                                                                        NotificationName notificationName,
                                                                        com.azure.core.util.Context context)

Gets the details of the Notification specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

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

Create or Update API Management publisher notification.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

notificationName - Notification Name Identifier.

Returns:

notification details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateWithResponse

com.azure.core.http.rest.Response<NotificationContract> createOrUpdateWithResponse(String resourceGroupName,
                                                                                   String serviceName,
                                                                                   NotificationName notificationName,
                                                                                   String ifMatch,
                                                                                   com.azure.core.util.Context context)

Create or Update API Management publisher notification.

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.