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.
begin_delete(resource_group_name: str, partner_namespace_name: str, channel_name: str, **kwargs: Any) -> LROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the partners subscription. Required. |
|
partner_namespace_name
Required
|
Name of the partner namespace. Required. |
|
channel_name
Required
|
Name of the channel. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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.ChannelParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the partners subscription. Required. |
|
partner_namespace_name
Required
|
Name of the partner namespace. Required. |
|
channel_name
Required
|
Name of the channel. Required. |
|
channel_info
Required
|
Channel information. Is either a Channel type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
Channel or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Get a channel.
Get properties of a channel.
get(resource_group_name: str, partner_namespace_name: str, channel_name: str, **kwargs: Any) -> ChannelParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the partners subscription. Required. |
|
partner_namespace_name
Required
|
Name of the partner namespace. Required. |
|
channel_name
Required
|
Name of the channel. Required. |
Returns
| Type | Description |
|---|---|
|
Channel or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> EventSubscriptionFullUrlParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the partners subscription. Required. |
|
partner_namespace_name
Required
|
Name of the partner namespace. Required. |
|
channel_name
Required
|
Name of the Channel. Required. |
Returns
| Type | Description |
|---|---|
|
EventSubscriptionFullUrl or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> ItemPaged[Channel]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the partners subscription. Required. |
|
partner_namespace_name
Required
|
Name of the partner namespace. Required. |
|
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'. Default value is None. Default value: None
|
|
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. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Channel or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the partners subscription. Required. |
|
partner_namespace_name
Required
|
Name of the partner namespace. Required. |
|
channel_name
Required
|
Name of the channel. Required. |
|
channel_update_parameters
Required
|
Channel update information. Is either a ChannelUpdateParameters type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.eventgrid.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv137\\Lib\\site-packages\\azure\\mgmt\\eventgrid\\models\\__init__.py'>