Interface SystemTopicsClient


  • public interface SystemTopicsClient
    An instance of this class provides access to all the operations defined in SystemTopicsClient.
    • Method Detail

      • getByResourceGroup

        SystemTopicInner getByResourceGroup​(String resourceGroupName,
                                            String systemTopicName)
        Get properties of a system topic.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        systemTopicName - Name of the system topic.
        Returns:
        properties 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.
      • getByResourceGroupWithResponse

        com.azure.core.http.rest.Response<SystemTopicInner> getByResourceGroupWithResponse​(String resourceGroupName,
                                                                                           String systemTopicName,
                                                                                           com.azure.core.util.Context context)
        Get properties of a system topic.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        systemTopicName - Name of the system topic.
        context - The context to associate with this operation.
        Returns:
        properties 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.
      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SystemTopicInner>,​SystemTopicInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                          String systemTopicName,
                                                                                                                                                          SystemTopicInner systemTopicInfo)
        Asynchronously creates a new system topic with the specified parameters.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        systemTopicName - Name of the system topic.
        systemTopicInfo - System Topic information.
        Returns:
        eventGrid System Topic along with Response on successful completion of Mono.
        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.
      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SystemTopicInner>,​SystemTopicInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                          String systemTopicName,
                                                                                                                                                          SystemTopicInner systemTopicInfo,
                                                                                                                                                          com.azure.core.util.Context context)
        Asynchronously creates a new system topic with the specified parameters.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        systemTopicName - Name of the system topic.
        systemTopicInfo - System Topic information.
        context - The context to associate with this operation.
        Returns:
        eventGrid System Topic along with Response on successful completion of Mono.
        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

        SystemTopicInner createOrUpdate​(String resourceGroupName,
                                        String systemTopicName,
                                        SystemTopicInner systemTopicInfo)
        Asynchronously creates a new system topic with the specified parameters.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        systemTopicName - Name of the system topic.
        systemTopicInfo - System Topic information.
        Returns:
        eventGrid 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.
      • createOrUpdate

        SystemTopicInner createOrUpdate​(String resourceGroupName,
                                        String systemTopicName,
                                        SystemTopicInner systemTopicInfo,
                                        com.azure.core.util.Context context)
        Asynchronously creates a new system topic with the specified parameters.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        systemTopicName - Name of the system topic.
        systemTopicInfo - System Topic information.
        context - The context to associate with this operation.
        Returns:
        eventGrid 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.
      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                          String systemTopicName)
        Delete existing system topic.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        systemTopicName - Name of the system topic.
        Returns:
        the Response on successful completion of Mono.
        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.
      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                          String systemTopicName,
                                                                                                                          com.azure.core.util.Context context)
        Delete existing system topic.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        systemTopicName - Name of the system topic.
        context - The context to associate with this operation.
        Returns:
        the Response on successful completion of Mono.
        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)
        Delete existing system topic.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        systemTopicName - Name of the 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.
      • delete

        void delete​(String resourceGroupName,
                    String systemTopicName,
                    com.azure.core.util.Context context)
        Delete existing system topic.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        systemTopicName - Name of the system topic.
        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.
      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SystemTopicInner>,​SystemTopicInner> beginUpdate​(String resourceGroupName,
                                                                                                                                                  String systemTopicName,
                                                                                                                                                  SystemTopicUpdateParameters systemTopicUpdateParameters)
        Asynchronously updates a system topic with the specified parameters.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        systemTopicName - Name of the system topic.
        systemTopicUpdateParameters - SystemTopic update information.
        Returns:
        eventGrid System Topic along with Response on successful completion of Mono.
        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.
      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SystemTopicInner>,​SystemTopicInner> beginUpdate​(String resourceGroupName,
                                                                                                                                                  String systemTopicName,
                                                                                                                                                  SystemTopicUpdateParameters systemTopicUpdateParameters,
                                                                                                                                                  com.azure.core.util.Context context)
        Asynchronously updates a system topic with the specified parameters.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        systemTopicName - Name of the system topic.
        systemTopicUpdateParameters - SystemTopic update information.
        context - The context to associate with this operation.
        Returns:
        eventGrid System Topic along with Response on successful completion of Mono.
        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

        SystemTopicInner update​(String resourceGroupName,
                                String systemTopicName,
                                SystemTopicUpdateParameters systemTopicUpdateParameters)
        Asynchronously updates a system topic with the specified parameters.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        systemTopicName - Name of the system topic.
        systemTopicUpdateParameters - SystemTopic update information.
        Returns:
        eventGrid 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.
      • update

        SystemTopicInner update​(String resourceGroupName,
                                String systemTopicName,
                                SystemTopicUpdateParameters systemTopicUpdateParameters,
                                com.azure.core.util.Context context)
        Asynchronously updates a system topic with the specified parameters.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        systemTopicName - Name of the system topic.
        systemTopicUpdateParameters - SystemTopic update information.
        context - The context to associate with this operation.
        Returns:
        eventGrid 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.
      • list

        com.azure.core.http.rest.PagedIterable<SystemTopicInner> list()
        List all the system topics under an Azure subscription.
        Returns:
        result of the List System topics 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<SystemTopicInner> list​(String filter,
                                                                      Integer top,
                                                                      com.azure.core.util.Context context)
        List all the system topics under an 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 System topics 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<SystemTopicInner> listByResourceGroup​(String resourceGroupName)
        List all the system topics under a resource group.
        Parameters:
        resourceGroupName - The name of the resource group within the user's subscription.
        Returns:
        result of the List System topics 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<SystemTopicInner> listByResourceGroup​(String resourceGroupName,
                                                                                     String filter,
                                                                                     Integer top,
                                                                                     com.azure.core.util.Context context)
        List all the system topics under a 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 System topics 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.