Share via

ChannelsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventGridManagementClient's

<xref:channels> attribute.

Inheritance
builtins.object
ChannelsOperations

Constructor

ChannelsOperations(*args, **kwargs)

Methods

begin_delete

Delete a channel.

Delete an existing channel.
create_or_update

Create or update a channel.

Synchronously creates or updates a new channel with the specified parameters.
get

Get a channel.

Get properties of a channel.
get_full_url

Get full URL of partner destination channel.

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

List channels.

List all the channels in a partner namespace.
update

Update a Channel.

Synchronously updates a channel with the specified parameters.

begin_delete

Delete a channel.

Delete an existing channel.

begin_delete(resource_group_name: str, partner_namespace_name: str, channel_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the partners subscription. Required.
partner_namespace_name
Required
str

Name of the partner namespace. Required.
channel_name
Required
str

Name of the channel. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

create_or_update

Create or update a channel.

Synchronously creates or updates a new channel with the specified parameters.

create_or_update(resource_group_name: str, partner_namespace_name: str, channel_name: str, channel_info: _models.Channel, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Channel

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the partners subscription. Required.
partner_namespace_name
Required
str

Name of the partner namespace. Required.
channel_name
Required
str

Name of the channel. Required.
channel_info
Required
Channel or IO[bytes]

Channel information. Is either a Channel type or a IO[bytes] type. Required.

Returns

Type Description
Channel

Channel or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get a channel.

Get properties of a channel.

get(resource_group_name: str, partner_namespace_name: str, channel_name: str, **kwargs: Any) -> Channel

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the partners subscription. Required.
partner_namespace_name
Required
str

Name of the partner namespace. Required.
channel_name
Required
str

Name of the channel. Required.

Returns

Type Description
Channel

Channel or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_full_url

Get full URL of partner destination channel.

Get the full endpoint URL of a partner destination channel.

get_full_url(resource_group_name: str, partner_namespace_name: str, channel_name: str, **kwargs: Any) -> EventSubscriptionFullUrl

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the partners subscription. Required.
partner_namespace_name
Required
str

Name of the partner namespace. Required.
channel_name
Required
str

Name of the Channel. Required.

Returns

Type Description
EventSubscriptionFullUrl

EventSubscriptionFullUrl or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_partner_namespace

List channels.

List all the channels in a partner namespace.

list_by_partner_namespace(resource_group_name: str, partner_namespace_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[Channel]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the partners subscription. Required.
partner_namespace_name
Required
str

Name of the partner namespace. Required.
filter
Required
str

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'. Default value is None.
top
Required
int

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. Default value is None.

Returns

Type Description
ItemPaged[Channel]

An iterator like instance of either Channel or the result of cls(response)

Exceptions

Type Description
HttpResponseError

update

Update a Channel.

Synchronously updates a channel with the specified parameters.

update(resource_group_name: str, partner_namespace_name: str, channel_name: str, channel_update_parameters: _models.ChannelUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the partners subscription. Required.
partner_namespace_name
Required
str

Name of the partner namespace. Required.
channel_name
Required
str

Name of the channel. Required.
channel_update_parameters
Required
ChannelUpdateParameters or IO[bytes]

Channel update information. Is either a ChannelUpdateParameters type or a IO[bytes] type. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.eventgrid.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\eventgrid\\models\\__init__.py'>