Channels Interface

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

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

public interface Channels

Resource collection API of Channels.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new Channel resource.
abstract void	delete(String resourceGroupName, String partnerNamespaceName, String channelName) Delete a channel.
abstract void	delete(String resourceGroupName, String partnerNamespaceName, String channelName, Context context) Delete a channel.
abstract void	deleteById(String id) Delete a channel.
abstract void	deleteByIdWithResponse(String id, Context context) Delete a channel.
abstract Channel	get(String resourceGroupName, String partnerNamespaceName, String channelName) Get a channel.
abstract Channel	getById(String id) Get a channel.
abstract Response<Channel>	getByIdWithResponse(String id, Context context) Get a channel.
abstract EventSubscriptionFullUrl	getFullUrl(String resourceGroupName, String partnerNamespaceName, String channelName) Get full URL of partner destination channel.
abstract Response<EventSubscriptionFullUrl>	getFullUrlWithResponse(String resourceGroupName, String partnerNamespaceName, String channelName, Context context) Get full URL of partner destination channel.
abstract Response<Channel>	getWithResponse(String resourceGroupName, String partnerNamespaceName, String channelName, Context context) Get a channel.
abstract PagedIterable<Channel>	listByPartnerNamespace(String resourceGroupName, String partnerNamespaceName) List channels.
abstract PagedIterable<Channel>	listByPartnerNamespace(String resourceGroupName, String partnerNamespaceName, String filter, Integer top, Context context) List channels.
abstract void	update(String resourceGroupName, String partnerNamespaceName, String channelName, ChannelUpdateParameters channelUpdateParameters) Update a Channel.
abstract Response<Void>	updateWithResponse(String resourceGroupName, String partnerNamespaceName, String channelName, ChannelUpdateParameters channelUpdateParameters, Context context) Update a Channel.

Method Details

define

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

Begins definition for a new Channel resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Channel definition.

delete

public abstract void delete(String resourceGroupName, String partnerNamespaceName, String channelName)

Delete a channel. Delete an existing channel.

Parameters:

resourceGroupName - The name of the resource group within the partners subscription.

partnerNamespaceName - Name of the partner namespace.

channelName - Name of the channel.

delete

public abstract void delete(String resourceGroupName, String partnerNamespaceName, String channelName, Context context)

Delete a channel. Delete an existing channel.

Parameters:

resourceGroupName - The name of the resource group within the partners subscription.

partnerNamespaceName - Name of the partner namespace.

channelName - Name of the channel.

context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Delete a channel. Delete an existing channel.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Delete a channel. Delete an existing channel.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

get

public abstract Channel get(String resourceGroupName, String partnerNamespaceName, String channelName)

Get a channel. Get properties of a channel.

Parameters:

resourceGroupName - The name of the resource group within the partners subscription.

partnerNamespaceName - Name of the partner namespace.

channelName - Name of the channel.

Returns:

properties of a channel.

getById

public abstract Channel getById(String id)

Get a channel. Get properties of a channel.

Parameters:

id - the resource ID.

Returns:

properties of a channel along with Response<T>.

getByIdWithResponse

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

Get a channel. Get properties of a channel.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

properties of a channel along with Response<T>.

getFullUrl

public abstract EventSubscriptionFullUrl getFullUrl(String resourceGroupName, String partnerNamespaceName, String channelName)

Get full URL of partner destination channel. Get the full endpoint URL of a partner destination channel.

Parameters:

resourceGroupName - The name of the resource group within the partners subscription.

partnerNamespaceName - Name of the partner namespace.

channelName - Name of the Channel.

Returns:

the full endpoint URL of a partner destination channel.

getFullUrlWithResponse

public abstract Response<EventSubscriptionFullUrl> getFullUrlWithResponse(String resourceGroupName, String partnerNamespaceName, String channelName, Context context)

Get full URL of partner destination channel. Get the full endpoint URL of a partner destination channel.

Parameters:

resourceGroupName - The name of the resource group within the partners subscription.

partnerNamespaceName - Name of the partner namespace.

channelName - Name of the Channel.

context - The context to associate with this operation.

Returns:

the full endpoint URL of a partner destination channel along with Response<T>.

getWithResponse

public abstract Response<Channel> getWithResponse(String resourceGroupName, String partnerNamespaceName, String channelName, Context context)

Get a channel. Get properties of a channel.

Parameters:

resourceGroupName - The name of the resource group within the partners subscription.

partnerNamespaceName - Name of the partner namespace.

channelName - Name of the channel.

context - The context to associate with this operation.

Returns:

properties of a channel along with Response<T>.

listByPartnerNamespace

public abstract PagedIterable<Channel> listByPartnerNamespace(String resourceGroupName, String partnerNamespaceName)

List channels. List all the channels in a partner namespace.

Parameters:

resourceGroupName - The name of the resource group within the partners subscription.

partnerNamespaceName - Name of the partner namespace.

Returns:

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

listByPartnerNamespace

public abstract PagedIterable<Channel> listByPartnerNamespace(String resourceGroupName, String partnerNamespaceName, String filter, Integer top, Context context)

List channels. List all the channels in a partner namespace.

Parameters:

resourceGroupName - The name of the resource group within the partners subscription.

partnerNamespaceName - Name of the partner namespace.

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 Channels operation as paginated response with PagedIterable<T>.

update

public abstract void update(String resourceGroupName, String partnerNamespaceName, String channelName, ChannelUpdateParameters channelUpdateParameters)

Update a Channel. Synchronously updates a channel with the specified parameters.

Parameters:

resourceGroupName - The name of the resource group within the partners subscription.

partnerNamespaceName - Name of the partner namespace.

channelName - Name of the channel.

channelUpdateParameters - Channel update information.

updateWithResponse

public abstract Response<Void> updateWithResponse(String resourceGroupName, String partnerNamespaceName, String channelName, ChannelUpdateParameters channelUpdateParameters, Context context)

Update a Channel. Synchronously updates a channel with the specified parameters.

Parameters:

resourceGroupName - The name of the resource group within the partners subscription.

partnerNamespaceName - Name of the partner namespace.

channelName - Name of the channel.

channelUpdateParameters - Channel update information.

context - The context to associate with this operation.

Returns:

the Response<T>.