Package com.azure.resourcemanager.eventgrid.models

Interface EventSubscriptions

  • public interface EventSubscriptions
    Resource collection API of EventSubscriptions.

    • Method Detail

      • get

        EventSubscription get​(String scope,
                      String eventSubscriptionName)
        Get properties of an event subscription.
        Parameters:
        scope - The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
        eventSubscriptionName - Name of the event subscription.
        Returns:
        properties of 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 scope,
                                                                     String eventSubscriptionName,
                                                                     com.azure.core.util.Context context)
        Get properties of an event subscription.
        Parameters:
        scope - The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
        eventSubscriptionName - Name of the event subscription.
        context - The context to associate with this operation.
        Returns:
        properties of 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.

      • deleteByResourceGroup

        void deleteByResourceGroup​(String scope,
                           String eventSubscriptionName)
        Delete an existing event subscription.
        Parameters:
        scope - The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
        eventSubscriptionName - Name of the 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 scope,
            String eventSubscriptionName,
            com.azure.core.util.Context context)
        Delete an existing event subscription.
        Parameters:
        scope - The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
        eventSubscriptionName - Name of the event subscription.
        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.

      • getFullUrl

        EventSubscriptionFullUrl getFullUrl​(String scope,
                                    String eventSubscriptionName)
        Get the full endpoint URL for an event subscription.
        Parameters:
        scope - The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
        eventSubscriptionName - Name of the event subscription.
        Returns:
        the full endpoint URL 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.

      • getFullUrlWithResponse

        com.azure.core.http.rest.Response<EventSubscriptionFullUrl> getFullUrlWithResponse​(String scope,
                                                                                   String eventSubscriptionName,
                                                                                   com.azure.core.util.Context context)
        Get the full endpoint URL for an event subscription.
        Parameters:
        scope - The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
        eventSubscriptionName - Name of the event subscription.
        context - The context to associate with this operation.
        Returns:
        the full endpoint URL 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.

      • list

        com.azure.core.http.rest.PagedIterable<EventSubscription> list()
        List all aggregated global event subscriptions under a specific Azure subscription.
        Returns:
        result of the List EventSubscriptions operation.
        Throws:
        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.

      • list

        com.azure.core.http.rest.PagedIterable<EventSubscription> list​(String filter,
                                                               Integer top,
                                                               com.azure.core.util.Context context)
        List all aggregated global event subscriptions under a specific Azure subscription.
        Parameters:
        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.
        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.

      • listGlobalBySubscriptionForTopicType

        com.azure.core.http.rest.PagedIterable<EventSubscription> listGlobalBySubscriptionForTopicType​(String topicTypeName)
        List all global event subscriptions under an Azure subscription for a topic type.
        Parameters:
        topicTypeName - Name of the topic type.
        Returns:
        result of the List EventSubscriptions 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.

      • listGlobalBySubscriptionForTopicType

        com.azure.core.http.rest.PagedIterable<EventSubscription> listGlobalBySubscriptionForTopicType​(String topicTypeName,
                                                                                               String filter,
                                                                                               Integer top,
                                                                                               com.azure.core.util.Context context)
        List all global event subscriptions under an Azure subscription for a topic type.
        Parameters:
        topicTypeName - Name of the topic type.
        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.
        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.

      • listByResourceGroup

        com.azure.core.http.rest.PagedIterable<EventSubscription> listByResourceGroup​(String resourceGroupName)
        List all global event subscriptions under a specific Azure subscription and resource group.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        Returns:
        result of the List EventSubscriptions 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.

      • listByResourceGroup

        com.azure.core.http.rest.PagedIterable<EventSubscription> listByResourceGroup​(String resourceGroupName,
                                                                              String filter,
                                                                              Integer top,
                                                                              com.azure.core.util.Context context)
        List all global event subscriptions under a specific Azure subscription and resource group.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        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.
        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.

      • listGlobalByResourceGroupForTopicType

        com.azure.core.http.rest.PagedIterable<EventSubscription> listGlobalByResourceGroupForTopicType​(String resourceGroupName,
                                                                                                String topicTypeName)
        List all global event subscriptions under a resource group for a specific topic type.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        topicTypeName - Name of the topic type.
        Returns:
        result of the List EventSubscriptions 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.

      • listGlobalByResourceGroupForTopicType

        com.azure.core.http.rest.PagedIterable<EventSubscription> listGlobalByResourceGroupForTopicType​(String resourceGroupName,
                                                                                                String topicTypeName,
                                                                                                String filter,
                                                                                                Integer top,
                                                                                                com.azure.core.util.Context context)
        List all global event subscriptions under a resource group for a specific topic type.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        topicTypeName - Name of the topic type.
        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.
        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.

      • listRegionalBySubscription

        com.azure.core.http.rest.PagedIterable<EventSubscription> listRegionalBySubscription​(String location)
        List all event subscriptions from the given location under a specific Azure subscription.
        Parameters:
        location - Name of the location.
        Returns:
        result of the List EventSubscriptions 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.

      • listRegionalBySubscription

        com.azure.core.http.rest.PagedIterable<EventSubscription> listRegionalBySubscription​(String location,
                                                                                     String filter,
                                                                                     Integer top,
                                                                                     com.azure.core.util.Context context)
        List all event subscriptions from the given location under a specific Azure subscription.
        Parameters:
        location - Name of the location.
        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.
        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.

      • listRegionalByResourceGroup

        com.azure.core.http.rest.PagedIterable<EventSubscription> listRegionalByResourceGroup​(String resourceGroupName,
                                                                                      String location)
        List all event subscriptions from the given location under a specific Azure subscription and resource group.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        location - Name of the location.
        Returns:
        result of the List EventSubscriptions 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.

      • listRegionalByResourceGroup

        com.azure.core.http.rest.PagedIterable<EventSubscription> listRegionalByResourceGroup​(String resourceGroupName,
                                                                                      String location,
                                                                                      String filter,
                                                                                      Integer top,
                                                                                      com.azure.core.util.Context context)
        List all event subscriptions from the given location under a specific Azure subscription and resource group.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        location - Name of the location.
        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.
        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.

      • listRegionalBySubscriptionForTopicType

        com.azure.core.http.rest.PagedIterable<EventSubscription> listRegionalBySubscriptionForTopicType​(String location,
                                                                                                 String topicTypeName)
        List all event subscriptions from the given location under a specific Azure subscription and topic type.
        Parameters:
        location - Name of the location.
        topicTypeName - Name of the topic type.
        Returns:
        result of the List EventSubscriptions 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.

      • listRegionalBySubscriptionForTopicType

        com.azure.core.http.rest.PagedIterable<EventSubscription> listRegionalBySubscriptionForTopicType​(String location,
                                                                                                 String topicTypeName,
                                                                                                 String filter,
                                                                                                 Integer top,
                                                                                                 com.azure.core.util.Context context)
        List all event subscriptions from the given location under a specific Azure subscription and topic type.
        Parameters:
        location - Name of the location.
        topicTypeName - Name of the topic type.
        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.
        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.

      • listRegionalByResourceGroupForTopicType

        com.azure.core.http.rest.PagedIterable<EventSubscription> listRegionalByResourceGroupForTopicType​(String resourceGroupName,
                                                                                                  String location,
                                                                                                  String topicTypeName)
        List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        location - Name of the location.
        topicTypeName - Name of the topic type.
        Returns:
        result of the List EventSubscriptions 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.

      • listRegionalByResourceGroupForTopicType

        com.azure.core.http.rest.PagedIterable<EventSubscription> listRegionalByResourceGroupForTopicType​(String resourceGroupName,
                                                                                                  String location,
                                                                                                  String topicTypeName,
                                                                                                  String filter,
                                                                                                  Integer top,
                                                                                                  com.azure.core.util.Context context)
        List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        location - Name of the location.
        topicTypeName - Name of the topic type.
        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.
        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.

      • listByResource

        com.azure.core.http.rest.PagedIterable<EventSubscription> listByResource​(String resourceGroupName,
                                                                         String providerNamespace,
                                                                         String resourceTypeName,
                                                                         String resourceName)
        List all event subscriptions that have been created for a specific topic.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        providerNamespace - Namespace of the provider of the topic.
        resourceTypeName - Name of the resource type.
        resourceName - Name of the resource.
        Returns:
        result of the List EventSubscriptions 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.

      • listByResource

        com.azure.core.http.rest.PagedIterable<EventSubscription> listByResource​(String resourceGroupName,
                                                                         String providerNamespace,
                                                                         String resourceTypeName,
                                                                         String resourceName,
                                                                         String filter,
                                                                         Integer top,
                                                                         com.azure.core.util.Context context)
        List all event subscriptions that have been created for a specific topic.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        providerNamespace - Namespace of the provider of the topic.
        resourceTypeName - Name of the resource type.
        resourceName - Name of the resource.
        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.
        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.

      • listByDomainTopic

        com.azure.core.http.rest.PagedIterable<EventSubscription> listByDomainTopic​(String resourceGroupName,
                                                                            String domainName,
                                                                            String topicName)
        List all event subscriptions that have been created for a specific domain topic.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        domainName - Name of the top level domain.
        topicName - Name of the domain topic.
        Returns:
        result of the List EventSubscriptions 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.

      • listByDomainTopic

        com.azure.core.http.rest.PagedIterable<EventSubscription> listByDomainTopic​(String resourceGroupName,
                                                                            String domainName,
                                                                            String topicName,
                                                                            String filter,
                                                                            Integer top,
                                                                            com.azure.core.util.Context context)
        List all event subscriptions that have been created for a specific domain topic.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        domainName - Name of the top level domain.
        topicName - Name of the domain 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.
        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 scope,
                                                  String eventSubscriptionName)
        Get all delivery attributes for an event subscription.
        Parameters:
        scope - The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
        eventSubscriptionName - Name of the event subscription.
        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 scope,
                                                                                                 String eventSubscriptionName,
                                                                                                 com.azure.core.util.Context context)
        Get all delivery attributes for an event subscription.
        Parameters:
        scope - The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.
        eventSubscriptionName - Name of the event subscription.
        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.

      • getById

        EventSubscription getById​(String id)
        Get properties of an event subscription.
        Parameters:
        id - the resource ID.
        Returns:
        properties of 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.

      • getByIdWithResponse

        com.azure.core.http.rest.Response<EventSubscription> getByIdWithResponse​(String id,
                                                                         com.azure.core.util.Context context)
        Get properties of an event subscription.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        properties of 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.

      • deleteById

        void deleteById​(String id)
        Delete an existing event subscription.
        Parameters:
        id - the resource ID.
        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.

      • deleteByIdWithResponse

        void deleteByIdWithResponse​(String id,
                            com.azure.core.util.Context context)
        Delete an existing event subscription.
        Parameters:
        id - the resource ID.
        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.

      • define

        EventSubscription.DefinitionStages.Blank define​(String name)
        Begins definition for a new EventSubscription resource.
        Parameters:
        name - resource name.
        Returns:
        the first stage of the new EventSubscription definition.