PartnerTopics Interface

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.2.0

public interface PartnerTopics

Resource collection API of PartnerTopics.

Method Summary

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

Method Details

activate

public abstract PartnerTopic activate(String resourceGroupName, String partnerTopicName)

Activate a partner topic. Activate a newly created partner topic.

Parameters:

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

partnerTopicName - Name of the partner topic.

Returns:

event Grid Partner Topic.

activateWithResponse

public abstract Response<PartnerTopic> activateWithResponse(String resourceGroupName, String partnerTopicName, Context context)

Activate a partner topic. Activate a newly created partner topic.

Parameters:

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

partnerTopicName - Name of the partner topic.

context - The context to associate with this operation.

Returns:

event Grid Partner Topic along with Response<T>.

deactivate

public abstract PartnerTopic deactivate(String resourceGroupName, String partnerTopicName)

Deactivate a partner topic. Deactivate specific partner topic.

Parameters:

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

partnerTopicName - Name of the partner topic.

Returns:

event Grid Partner Topic.

deactivateWithResponse

public abstract Response<PartnerTopic> deactivateWithResponse(String resourceGroupName, String partnerTopicName, Context context)

Deactivate a partner topic. Deactivate specific partner topic.

Parameters:

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

partnerTopicName - Name of the partner topic.

context - The context to associate with this operation.

Returns:

event Grid Partner Topic along with Response<T>.

define

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

Begins definition for a new PartnerTopic resource.

Parameters:

name - resource name.

Returns:

the first stage of the new PartnerTopic definition.

delete

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

Delete a partner topic. Delete existing partner topic.

Parameters:

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

partnerTopicName - Name of the partner topic.

context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Delete a partner topic. Delete existing partner topic.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Delete a partner topic. Delete existing partner topic.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String partnerTopicName)

Delete a partner topic. Delete existing partner topic.

Parameters:

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

partnerTopicName - Name of the partner topic.

getById

public abstract PartnerTopic getById(String id)

Get a partner topic. Get properties of a partner topic.

Parameters:

id - the resource ID.

Returns:

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

getByIdWithResponse

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

Get a partner topic. Get properties of a partner topic.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

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

getByResourceGroup

public abstract PartnerTopic getByResourceGroup(String resourceGroupName, String partnerTopicName)

Get a partner topic. Get properties of a partner topic.

Parameters:

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

partnerTopicName - Name of the partner topic.

Returns:

properties of a partner topic.

getByResourceGroupWithResponse

public abstract Response<PartnerTopic> getByResourceGroupWithResponse(String resourceGroupName, String partnerTopicName, Context context)

Get a partner topic. Get properties of a partner topic.

Parameters:

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

partnerTopicName - Name of the partner topic.

context - The context to associate with this operation.

Returns:

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

list

public abstract PagedIterable<PartnerTopic> list()

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

Returns:

result of the List Partner Topics operation as paginated response with PagedIterable<T>.

list

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

List partner topics under an Azure subscription. List all the partner 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 Partner Topics operation as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<PartnerTopic> listByResourceGroup(String resourceGroupName)

List partner topics under a resource group. List all the partner topics under a resource group.

Parameters:

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

Returns:

result of the List Partner Topics operation as paginated response with PagedIterable<T>.

listByResourceGroup

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

List partner topics under a resource group. List all the partner 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 Partner Topics operation as paginated response with PagedIterable<T>.