ChannelsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:channels> attribute.

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.

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. The name is case insensitive. Required.
partner_namespace_name Required	str Name of the partner namespace. Required.
channel_name Required	str Name of the channel. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns None

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: _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. The name is case insensitive. 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 <xref:JSON> or IO[bytes] Channel information. Is one of the following types: Channel, JSON, IO[bytes] Required.

Returns

Type	Description
Channel	Channel. The Channel is compatible with MutableMapping

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. The name is case insensitive. 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. The Channel is compatible with MutableMapping

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. The name is case insensitive. 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. The EventSubscriptionFullUrl is compatible with MutableMapping

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) -> AsyncItemPaged[Channel]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
partner_namespace_name Required	str Name of the partner namespace. Required.

Keyword-Only Parameters

Name	Description
filter	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. Default value: None
top	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. Default value: None

Name

Description

filter

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.

Default value: None

top

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.

Default value: None

Returns

Type	Description
AsyncItemPaged[Channel]	An iterator like instance of Channel

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: _models.ChannelUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. 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 <xref:JSON> or IO[bytes] Channel update information. Is one of the following types: ChannelUpdateParameters, JSON, IO[bytes] Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

Comentários

Esta página foi útil?