PartnerTopicsOperations Class

PartnerTopicsOperations 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

PartnerTopicsOperations

Constructor

PartnerTopicsOperations(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

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.
partner_topic_name Required	str Name of the partner topic.

Keyword-Only Parameters

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

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.
partner_topic_name Required	str Name of the partner topic.

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 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: PartnerTopic, **kwargs: Any) -> PartnerTopic

Parameters

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

Keyword-Only Parameters

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

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.
partner_topic_name Required	str Name of the partner topic.

Keyword-Only Parameters

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

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.
partner_topic_name Required	str Name of the partner topic.

Keyword-Only Parameters

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

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[PartnerTopicsListResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription.
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[PartnerTopicsListResult]	An iterator like instance of either PartnerTopicsListResult 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[PartnerTopicsListResult]

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.

Keyword-Only Parameters

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

Returns

Type	Description
AsyncItemPaged[PartnerTopicsListResult]	An iterator like instance of either PartnerTopicsListResult 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: PartnerTopicUpdateParameters, **kwargs: Any) -> PartnerTopic | None

Parameters

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

Keyword-Only Parameters

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

Returns

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