Interface SystemTopics
public interface SystemTopics
Resource collection API of SystemTopics.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new SystemTopic resource.void
Delete existing system topic.void
deleteById
(String id) Delete existing system topic.void
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Delete existing system topic.void
deleteByResourceGroup
(String resourceGroupName, String systemTopicName) Delete existing system topic.Get properties of a system topic.com.azure.core.http.rest.Response<SystemTopic>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Get properties of a system topic.getByResourceGroup
(String resourceGroupName, String systemTopicName) Get properties of a system topic.com.azure.core.http.rest.Response<SystemTopic>
getByResourceGroupWithResponse
(String resourceGroupName, String systemTopicName, com.azure.core.util.Context context) Get properties of a system topic.com.azure.core.http.rest.PagedIterable<SystemTopic>
list()
List all the system topics under an Azure subscription.com.azure.core.http.rest.PagedIterable<SystemTopic>
List all the system topics under an Azure subscription.com.azure.core.http.rest.PagedIterable<SystemTopic>
listByResourceGroup
(String resourceGroupName) List all the system topics under a resource group.com.azure.core.http.rest.PagedIterable<SystemTopic>
listByResourceGroup
(String resourceGroupName, String filter, Integer top, com.azure.core.util.Context context) List all the system topics under a resource group.
-
Method Details
-
getByResourceGroup
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<SystemTopic> 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.
-
deleteByResourceGroup
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
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.
-
list
com.azure.core.http.rest.PagedIterable<SystemTopic> list()List all the system topics under an Azure subscription.- Returns:
- result of the List System topics operation as paginated response with
PagedIterable
. - 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<SystemTopic> 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 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.
-
listByResourceGroup
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 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.
-
listByResourceGroup
com.azure.core.http.rest.PagedIterable<SystemTopic> 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 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.
-
getById
Get properties of a system topic.- Parameters:
id
- the resource ID.- 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.
-
getByIdWithResponse
com.azure.core.http.rest.Response<SystemTopic> getByIdWithResponse(String id, com.azure.core.util.Context context) Get properties of a system topic.- Parameters:
id
- the resource ID.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.
-
deleteById
Delete existing system topic.- 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
Delete existing system topic.- 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
Begins definition for a new SystemTopic resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new SystemTopic definition.
-