Package com.azure.resourcemanager.eventgrid.models

Interface PartnerTopicEventSubscriptions

public interface PartnerTopicEventSubscriptions
Resource collection API of PartnerTopicEventSubscriptions.

  • Method Details

    • get

      EventSubscription get(String resourceGroupName, String partnerTopicName, String eventSubscriptionName)
      Get properties of an event subscription of a partner topic.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      partnerTopicName - Name of the partner topic.
      eventSubscriptionName - Name of the event subscription to be found. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
      Returns:
      properties of an event subscription of a partner 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.

    • getWithResponse

      com.azure.core.http.rest.Response<EventSubscription> getWithResponse(String resourceGroupName, String partnerTopicName, String eventSubscriptionName, com.azure.core.util.Context context)
      Get properties of an event subscription of a partner topic.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      partnerTopicName - Name of the partner topic.
      eventSubscriptionName - Name of the event subscription to be found. 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:
      properties of an event subscription of a partner 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.

    • createOrUpdate

      EventSubscription createOrUpdate(String resourceGroupName, String partnerTopicName, String eventSubscriptionName, EventSubscriptionInner eventSubscriptionInfo)
      Asynchronously creates or updates an event subscription of a partner topic 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.
      partnerTopicName - Name of the partner 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 partnerTopicName, String eventSubscriptionName, EventSubscriptionInner eventSubscriptionInfo, com.azure.core.util.Context context)
      Asynchronously creates or updates an event subscription of a partner topic 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.
      partnerTopicName - Name of the partner 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 partnerTopicName, String eventSubscriptionName)
      Delete an existing event subscription of a partner topic.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      partnerTopicName - Name of the partner 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 partnerTopicName, String eventSubscriptionName, com.azure.core.util.Context context)
      Delete an existing event subscription of a partner topic.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      partnerTopicName - Name of the partner 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 partnerTopicName, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters)
      Update an existing event subscription of a partner topic.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      partnerTopicName - Name of the partner 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 partnerTopicName, String eventSubscriptionName, EventSubscriptionUpdateParameters eventSubscriptionUpdateParameters, com.azure.core.util.Context context)
      Update an existing event subscription of a partner topic.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      partnerTopicName - Name of the partner 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 partnerTopicName, String eventSubscriptionName)
      Get the full endpoint URL for an event subscription of a partner topic.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      partnerTopicName - Name of the partner 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 partner 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 partnerTopicName, String eventSubscriptionName, com.azure.core.util.Context context)
      Get the full endpoint URL for an event subscription of a partner topic.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      partnerTopicName - Name of the partner 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 partner 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.

    • listByPartnerTopic

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

    • listByPartnerTopic

      com.azure.core.http.rest.PagedIterable<EventSubscription> listByPartnerTopic(String resourceGroupName, String partnerTopicName, String filter, Integer top, com.azure.core.util.Context context)
      List event subscriptions that belong to a specific partner topic.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      partnerTopicName - Name of the partner 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 partnerTopicName, String eventSubscriptionName)
      Get all delivery attributes for an event subscription of a partner topic.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      partnerTopicName - Name of the partner 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 of a partner 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.

    • getDeliveryAttributesWithResponse

      com.azure.core.http.rest.Response<DeliveryAttributeListResult> getDeliveryAttributesWithResponse(String resourceGroupName, String partnerTopicName, String eventSubscriptionName, com.azure.core.util.Context context)
      Get all delivery attributes for an event subscription of a partner topic.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription.
      partnerTopicName - Name of the partner 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 of a partner 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.