Package com.azure.resourcemanager.eventgrid.models

Interface SystemTopicEventSubscriptions

public interface SystemTopicEventSubscriptions
Resource collection API of SystemTopicEventSubscriptions.

  • Method Details

    • get

      EventSubscription get(String resourceGroupName, String systemTopicName, String eventSubscriptionName)
      Get an event subscription.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      systemTopicName - Name of the system topic.
      eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
      Returns:
      an event subscription.
      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<EventSubscription> getWithResponse(String resourceGroupName, String systemTopicName, String eventSubscriptionName, com.azure.core.util.Context context)
      Get an event subscription.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      systemTopicName - Name of the system topic.
      eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
      context - The context to associate with this operation.
      Returns:
      an event subscription 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

      EventSubscription createOrUpdate(String resourceGroupName, String systemTopicName, String eventSubscriptionName, EventSubscriptionInner eventSubscriptionInfo)
      Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      systemTopicName - Name of the system topic.
      eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
      eventSubscriptionInfo - Event subscription properties containing the destination and filter information.
      Returns:
      event Subscription.
      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

      EventSubscription createOrUpdate(String resourceGroupName, String systemTopicName, String eventSubscriptionName, EventSubscriptionInner eventSubscriptionInfo, com.azure.core.util.Context context)
      Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      systemTopicName - Name of the system topic.
      eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
      eventSubscriptionInfo - Event subscription properties containing the destination and filter information.
      context - The context to associate with this operation.
      Returns:
      event Subscription.
      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.

    • delete

      void delete(String resourceGroupName, String systemTopicName, String eventSubscriptionName)
      Delete an existing event subscription of a system topic.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      systemTopicName - Name of the system topic.
      eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
      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.

    • delete

      void delete(String resourceGroupName, String systemTopicName, String eventSubscriptionName, com.azure.core.util.Context context)
      Delete an existing event subscription of a system topic.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      systemTopicName - Name of the system topic.
      eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
      context - The context to associate with this operation.
      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.

    • update

      EventSubscription update(String resourceGroupName, String systemTopicName, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters)
      Update an existing event subscription of a system topic.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      systemTopicName - Name of the system topic.
      eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
      eventSubscriptionUpdateParameters - Updated event subscription information.
      Returns:
      event Subscription.
      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.

    • update

      EventSubscription update(String resourceGroupName, String systemTopicName, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters, com.azure.core.util.Context context)
      Update an existing event subscription of a system topic.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      systemTopicName - Name of the system topic.
      eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
      eventSubscriptionUpdateParameters - Updated event subscription information.
      context - The context to associate with this operation.
      Returns:
      event Subscription.
      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.

    • getFullUrl

      EventSubscriptionFullUrl getFullUrl(String resourceGroupName, String systemTopicName, String eventSubscriptionName)
      Get the full endpoint URL for an event subscription of a system topic.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      systemTopicName - Name of the system topic.
      eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
      Returns:
      the full endpoint URL for an event subscription of a system topic.
      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.

    • getFullUrlWithResponse

      com.azure.core.http.rest.Response<EventSubscriptionFullUrl> getFullUrlWithResponse(String resourceGroupName, String systemTopicName, String eventSubscriptionName, com.azure.core.util.Context context)
      Get the full endpoint URL for an event subscription of a system topic.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      systemTopicName - Name of the system topic.
      eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
      context - The context to associate with this operation.
      Returns:
      the full endpoint URL for an event subscription of a system topic 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.

    • listBySystemTopic

      com.azure.core.http.rest.PagedIterable<EventSubscription> listBySystemTopic(String resourceGroupName, String systemTopicName)
      List event subscriptions that belong to a specific system topic.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      systemTopicName - Name of the system topic.
      Returns:
      result of the List EventSubscriptions operation 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.

    • listBySystemTopic

      com.azure.core.http.rest.PagedIterable<EventSubscription> listBySystemTopic(String resourceGroupName, String systemTopicName, String filter, Integer top, com.azure.core.util.Context context)
      List event subscriptions that belong to a specific system topic.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      systemTopicName - Name of the system topic.
      filter - The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.
      top - The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.
      context - The context to associate with this operation.
      Returns:
      result of the List EventSubscriptions operation 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.

    • getDeliveryAttributes

      DeliveryAttributeListResult getDeliveryAttributes(String resourceGroupName, String systemTopicName, String eventSubscriptionName)
      Get all delivery attributes for an event subscription.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      systemTopicName - Name of the system topic.
      eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
      Returns:
      all delivery attributes for an event subscription.
      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.

    • getDeliveryAttributesWithResponse

      com.azure.core.http.rest.Response<DeliveryAttributeListResult> getDeliveryAttributesWithResponse(String resourceGroupName, String systemTopicName, String eventSubscriptionName, com.azure.core.util.Context context)
      Get all delivery attributes for an event subscription.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      systemTopicName - Name of the system topic.
      eventSubscriptionName - Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
      context - The context to associate with this operation.
      Returns:
      all delivery attributes for an event subscription 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.