ChannelsOperations Class

ChannelsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

ChannelsOperations

Constructor

ChannelsOperations(client, config, serializer, deserializer)

Parameters

Name	Description
client Required	Client for service requests.
config Required	Configuration of service client.
serializer Required	An object model serializer.
deserializer Required	An object model deserializer.

Variables

Name	Description
models	Alias to model classes used in this operation group.

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.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the partners subscription.
partner_namespace_name Required	str Name of the partner namespace.
channel_name Required	str Name of the channel.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller 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.

async create_or_update(resource_group_name: str, partner_namespace_name: str, channel_name: str, channel_info: Channel, **kwargs: Any) -> Channel

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the partners subscription.
partner_namespace_name Required	str Name of the partner namespace.
channel_name Required	str Name of the channel.
channel_info Required	Channel Channel information.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Channel	Channel, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Get a channel.

Get properties of a channel.

async 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.
partner_namespace_name Required	str Name of the partner namespace.
channel_name Required	str Name of the channel.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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.

async 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.
partner_namespace_name Required	str Name of the partner namespace.
channel_name Required	str Name of the Channel.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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) -> AsyncIterable[ChannelsListResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the partners subscription.
partner_namespace_name Required	str Name of the partner namespace.
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.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[ChannelsListResult]	An iterator like instance of either ChannelsListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Update a Channel.

Synchronously updates a channel with the specified parameters.

async update(resource_group_name: str, partner_namespace_name: str, channel_name: str, channel_update_parameters: ChannelUpdateParameters, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the partners subscription.
partner_namespace_name Required	str Name of the partner namespace.
channel_name Required	str Name of the channel.
channel_update_parameters Required	ChannelUpdateParameters Channel update information.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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'>