Package com.azure.resourcemanager.eventgrid.models

Interface Channels

public interface Channels
Resource collection API of Channels.

  • Method Details

    • get

      Channel get(String resourceGroupName, String partnerNamespaceName, String channelName)
      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.
      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.

    • getWithResponse

      com.azure.core.http.rest.Response<Channel> getWithResponse(String resourceGroupName, String partnerNamespaceName, String channelName, com.azure.core.util.Context context)
      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.
      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

      void delete(String resourceGroupName, String partnerNamespaceName, String channelName)
      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.
      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

      void delete(String resourceGroupName, String partnerNamespaceName, String channelName, com.azure.core.util.Context context)
      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.
      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.

    • update

      void update(String resourceGroupName, String partnerNamespaceName, String channelName, ChannelUpdateParameters channelUpdateParameters)
      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.
      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.

    • updateWithResponse

      com.azure.core.http.rest.Response<Void> updateWithResponse(String resourceGroupName, String partnerNamespaceName, String channelName, ChannelUpdateParameters channelUpdateParameters, com.azure.core.util.Context context)
      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.
      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.

    • listByPartnerNamespace

      com.azure.core.http.rest.PagedIterable<Channel> listByPartnerNamespace(String resourceGroupName, String partnerNamespaceName)
      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.
      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.

    • listByPartnerNamespace

      com.azure.core.http.rest.PagedIterable<Channel> listByPartnerNamespace(String resourceGroupName, String partnerNamespaceName, String filter, Integer top, com.azure.core.util.Context context)
      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.
      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.

    • getFullUrl

      EventSubscriptionFullUrl getFullUrl(String resourceGroupName, String partnerNamespaceName, String channelName)
      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.
      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.

    • getFullUrlWithResponse

      com.azure.core.http.rest.Response<EventSubscriptionFullUrl> getFullUrlWithResponse(String resourceGroupName, String partnerNamespaceName, String channelName, com.azure.core.util.Context context)
      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.
      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

      Channel getById(String id)
      Get properties of a channel.
      Parameters:
      id - the resource ID.
      Returns:
      properties of a channel 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<Channel> getByIdWithResponse(String id, com.azure.core.util.Context context)
      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.
      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

      void deleteById(String id)
      Delete an existing channel.
      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

      void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Delete an existing channel.
      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

      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.