SystemTopics Interface

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.3.0-beta.1

public interface SystemTopics

Resource collection API of SystemTopics.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new SystemTopic resource.
abstract void	delete(String resourceGroupName, String systemTopicName, Context context) Delete a system topic.
abstract void	deleteById(String id) Delete a system topic.
abstract void	deleteByIdWithResponse(String id, Context context) Delete a system topic.
abstract void	deleteByResourceGroup(String resourceGroupName, String systemTopicName) Delete a system topic.
abstract SystemTopic	getById(String id) Get a system topic.
abstract Response<SystemTopic>	getByIdWithResponse(String id, Context context) Get a system topic.
abstract SystemTopic	getByResourceGroup(String resourceGroupName, String systemTopicName) Get a system topic.
abstract Response<SystemTopic>	getByResourceGroupWithResponse(String resourceGroupName, String systemTopicName, Context context) Get a system topic.
abstract PagedIterable<SystemTopic>	list() List system topics under an Azure subscription.
abstract PagedIterable<SystemTopic>	list(String filter, Integer top, Context context) List system topics under an Azure subscription.
abstract PagedIterable<SystemTopic>	listByResourceGroup(String resourceGroupName) List system topics under a resource group.
abstract PagedIterable<SystemTopic>	listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context) List system topics under a resource group.

Method Details

define

public abstract SystemTopic.DefinitionStages.Blank define(String name)

Begins definition for a new SystemTopic resource.

Parameters:

name - resource name.

Returns:

the first stage of the new SystemTopic definition.

delete

public abstract void delete(String resourceGroupName, String systemTopicName, Context context)

Delete a system topic. 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.

deleteById

public abstract void deleteById(String id)

Delete a system topic. Delete existing system topic.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Delete a system topic. Delete existing system topic.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String systemTopicName)

Delete a system topic. Delete existing system topic.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

systemTopicName - Name of the system topic.

getById

public abstract SystemTopic getById(String id)

Get a system topic. Get properties of a system topic.

Parameters:

id - the resource ID.

Returns:

properties of a system topic along with Response<T>.

getByIdWithResponse

public abstract Response<SystemTopic> getByIdWithResponse(String id, Context context)

Get a system topic. 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<T>.

getByResourceGroup

public abstract SystemTopic getByResourceGroup(String resourceGroupName, String systemTopicName)

Get a system topic. 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.

getByResourceGroupWithResponse

public abstract Response<SystemTopic> getByResourceGroupWithResponse(String resourceGroupName, String systemTopicName, Context context)

Get a system topic. 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<T>.

list

public abstract PagedIterable<SystemTopic> list()

List system topics under an Azure subscription. List all the system topics under an Azure subscription.

Returns:

result of the List System topics operation as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<SystemTopic> list(String filter, Integer top, Context context)

List system topics under an Azure subscription. 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<T>.

listByResourceGroup

public abstract PagedIterable<SystemTopic> listByResourceGroup(String resourceGroupName)

List system topics under a resource group. 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<T>.

listByResourceGroup

public abstract PagedIterable<SystemTopic> listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context)

List system topics under a resource group. 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<T>.