PartnerTopicsOperations Class

Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:partner_topics> attribute.

Inheritance: builtins.object

PartnerTopicsOperations

Constructor

PartnerTopicsOperations(*args, **kwargs)

Methods

activate	Activate a partner topic. Activate a newly created partner topic.
begin_delete	Delete a partner topic. Delete existing partner topic.
create_or_update	Create a partner topic. Asynchronously creates a new partner topic with the specified parameters.
deactivate	Deactivate a partner topic. Deactivate specific partner topic.
get	Get a partner topic. Get properties of a partner topic.
list_by_resource_group	List partner topics under a resource group. List all the partner topics under a resource group.
list_by_subscription	List partner topics under an Azure subscription. List all the partner topics under an Azure subscription.
update	Update a partner topic. Asynchronously updates a partner topic with the specified parameters.

activate

Activate a partner topic.

Activate a newly created partner topic.

async activate(resource_group_name: str, partner_topic_name: str, **kwargs: Any) -> PartnerTopic

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.
partner_topic_name Required	str Name of the partner topic. Required.

Returns

Type	Description
PartnerTopic	PartnerTopic or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Delete a partner topic.

Delete existing partner topic.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.
partner_topic_name Required	str Name of the partner topic. Required.

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 a partner topic.

Asynchronously creates a new partner topic with the specified parameters.

async create_or_update(resource_group_name: str, partner_topic_name: str, partner_topic_info: _models.PartnerTopic, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PartnerTopic

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.
partner_topic_name Required	str Name of the partner topic. Required.
partner_topic_info Required	PartnerTopic or IO[bytes] Partner Topic information. Is either a PartnerTopic type or a IO[bytes] type. Required.

Returns

Type	Description
PartnerTopic	PartnerTopic or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

deactivate

Deactivate a partner topic.

Deactivate specific partner topic.

async deactivate(resource_group_name: str, partner_topic_name: str, **kwargs: Any) -> PartnerTopic

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.
partner_topic_name Required	str Name of the partner topic. Required.

Returns

Type	Description
PartnerTopic	PartnerTopic or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Get a partner topic.

Get properties of a partner topic.

async get(resource_group_name: str, partner_topic_name: str, **kwargs: Any) -> PartnerTopic

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.
partner_topic_name Required	str Name of the partner topic. Required.

Returns

Type	Description
PartnerTopic	PartnerTopic or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

List partner topics under a resource group.

List all the partner topics under a resource group.

list_by_resource_group(resource_group_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[PartnerTopic]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. 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
AsyncItemPaged[PartnerTopic]	An iterator like instance of either PartnerTopic or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_subscription

List partner topics under an Azure subscription.

List all the partner topics under an Azure subscription.

list_by_subscription(filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[PartnerTopic]

Parameters

Name	Description
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.

Name

Description

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
AsyncItemPaged[PartnerTopic]	An iterator like instance of either PartnerTopic or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Update a partner topic.

Asynchronously updates a partner topic with the specified parameters.

async update(resource_group_name: str, partner_topic_name: str, partner_topic_update_parameters: _models.PartnerTopicUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PartnerTopic | None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.
partner_topic_name Required	str Name of the partner topic. Required.
partner_topic_update_parameters Required	PartnerTopicUpdateParameters or IO[bytes] PartnerTopic update information. Is either a PartnerTopicUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
PartnerTopic, None	PartnerTopic or 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'>

Share via

PartnerTopicsOperations Class

Constructor

Methods

activate

Parameters

Returns

Exceptions

begin_delete

Parameters

Returns

Exceptions

create_or_update

Parameters

Returns

Exceptions

deactivate

Parameters

Returns

Exceptions

get

Parameters

Returns

Exceptions

list_by_resource_group

Parameters

Returns

Exceptions

list_by_subscription

Parameters

Returns

Exceptions

update

Parameters

Returns

Exceptions

Attributes

models

Additional resources