Topics Interface

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.1.0

public interface Topics

Resource collection API of Topics.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new Topic resource.
abstract void	delete(String resourceGroupName, String topicName, Context context) Delete existing topic.
abstract void	deleteById(String id) Delete existing topic.
abstract void	deleteByIdWithResponse(String id, Context context) Delete existing topic.
abstract void	deleteByResourceGroup(String resourceGroupName, String topicName) Delete existing topic.
abstract Topic	getById(String id) Get properties of a topic.
abstract Response<Topic>	getByIdWithResponse(String id, Context context) Get properties of a topic.
abstract Topic	getByResourceGroup(String resourceGroupName, String topicName) Get properties of a topic.
abstract Response<Topic>	getByResourceGroupWithResponse(String resourceGroupName, String topicName, Context context) Get properties of a topic.
abstract PagedIterable<Topic>	list() List all the topics under an Azure subscription.
abstract PagedIterable<Topic>	list(String filter, Integer top, Context context) List all the topics under an Azure subscription.
abstract PagedIterable<Topic>	listByResourceGroup(String resourceGroupName) List all the topics under a resource group.
abstract PagedIterable<Topic>	listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context) List all the topics under a resource group.
abstract PagedIterable<EventType>	listEventTypes(String resourceGroupName, String providerNamespace, String resourceTypeName, String resourceName) List event types for a topic.
abstract PagedIterable<EventType>	listEventTypes(String resourceGroupName, String providerNamespace, String resourceTypeName, String resourceName, Context context) List event types for a topic.
abstract TopicSharedAccessKeys	listSharedAccessKeys(String resourceGroupName, String topicName) List the two keys used to publish to a topic.
abstract Response<TopicSharedAccessKeys>	listSharedAccessKeysWithResponse(String resourceGroupName, String topicName, Context context) List the two keys used to publish to a topic.
abstract TopicSharedAccessKeys	regenerateKey(String resourceGroupName, String topicName, TopicRegenerateKeyRequest regenerateKeyRequest) Regenerate a shared access key for a topic.
abstract TopicSharedAccessKeys	regenerateKey(String resourceGroupName, String topicName, TopicRegenerateKeyRequest regenerateKeyRequest, Context context) Regenerate a shared access key for a topic.

Method Details

define

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

Begins definition for a new Topic resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Topic definition.

delete

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

Delete existing topic.

Parameters:

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

topicName - Name of the topic.

context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Delete existing topic.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Delete existing topic.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String topicName)

Delete existing topic.

Parameters:

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

topicName - Name of the topic.

getById

public abstract Topic getById(String id)

Get properties of a topic.

Parameters:

id - the resource ID.

Returns:

properties of a topic along with Response<T>.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Get properties of a topic.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

properties of a topic along with Response<T>.

getByResourceGroup

public abstract Topic getByResourceGroup(String resourceGroupName, String topicName)

Get properties of a topic.

Parameters:

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

topicName - Name of the topic.

Returns:

properties of a topic.

getByResourceGroupWithResponse

public abstract Response getByResourceGroupWithResponse(String resourceGroupName, String topicName, Context context)

Get properties of a topic.

Parameters:

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

topicName - Name of the topic.

context - The context to associate with this operation.

Returns:

properties of a topic along with Response<T>.

list

public abstract PagedIterable list()

List all the topics under an Azure subscription.

Returns:

result of the List Topics operation.

list

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

List all the 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 Topics operation.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName)

List all the topics under a resource group.

Parameters:

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

Returns:

result of the List Topics operation.

listByResourceGroup

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

List all the 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 Topics operation.

listEventTypes

public abstract PagedIterable listEventTypes(String resourceGroupName, String providerNamespace, String resourceTypeName, String resourceName)

List event types for a 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 topic type.

resourceName - Name of the topic.

Returns:

result of the List Event Types operation.

listEventTypes

public abstract PagedIterable listEventTypes(String resourceGroupName, String providerNamespace, String resourceTypeName, String resourceName, Context context)

List event types for a 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 topic type.

resourceName - Name of the topic.

context - The context to associate with this operation.

Returns:

result of the List Event Types operation.

listSharedAccessKeys

public abstract TopicSharedAccessKeys listSharedAccessKeys(String resourceGroupName, String topicName)

List the two keys used to publish to a topic.

Parameters:

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

topicName - Name of the topic.

Returns:

shared access keys of the Topic.

listSharedAccessKeysWithResponse

public abstract Response listSharedAccessKeysWithResponse(String resourceGroupName, String topicName, Context context)

List the two keys used to publish to a topic.

Parameters:

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

topicName - Name of the topic.

context - The context to associate with this operation.

Returns:

shared access keys of the Topic along with Response<T>.

regenerateKey

public abstract TopicSharedAccessKeys regenerateKey(String resourceGroupName, String topicName, TopicRegenerateKeyRequest regenerateKeyRequest)

Regenerate a shared access key for a topic.

Parameters:

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

topicName - Name of the topic.

regenerateKeyRequest - Request body to regenerate key.

Returns:

shared access keys of the Topic.

regenerateKey

public abstract TopicSharedAccessKeys regenerateKey(String resourceGroupName, String topicName, TopicRegenerateKeyRequest regenerateKeyRequest, Context context)

Regenerate a shared access key for a topic.

Parameters:

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

topicName - Name of the topic.

regenerateKeyRequest - Request body to regenerate key.

context - The context to associate with this operation.

Returns:

shared access keys of the Topic.

Azure SDK for Java

Latest