DomainTopicsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventGridManagementClient's

<xref:domain_topics> attribute.

Inheritance

builtins.object

DomainTopicsOperations

Constructor

DomainTopicsOperations(*args, **kwargs)

Methods

begin_create_or_update	Create or update a domain topic. Asynchronously creates or updates a new domain topic with the specified parameters.
begin_delete	Delete a domain topic. Delete existing domain topic.
get	Get a domain topic. Get properties of a domain topic.
list_by_domain	List domain topics. List all the topics in a domain.

begin_create_or_update

Create or update a domain topic.

Asynchronously creates or updates a new domain topic with the specified parameters.

begin_create_or_update(resource_group_name: str, domain_name: str, domain_topic_name: str, **kwargs: Any) -> LROPoller[DomainTopic]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.
domain_name Required	str Name of the domain. Required.
domain_topic_name Required	str Name of the domain topic. Required.

Returns

Type	Description
LROPoller[DomainTopic]	An instance of LROPoller that returns either DomainTopic or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Delete a domain topic.

Delete existing domain topic.

begin_delete(resource_group_name: str, domain_name: str, domain_topic_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.
domain_name Required	str Name of the domain. Required.
domain_topic_name Required	str Name of the domain topic. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Get a domain topic.

Get properties of a domain topic.

get(resource_group_name: str, domain_name: str, domain_topic_name: str, **kwargs: Any) -> DomainTopic

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.
domain_name Required	str Name of the domain. Required.
domain_topic_name Required	str Name of the topic. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_domain

List domain topics.

List all the topics in a domain.

list_by_domain(resource_group_name: str, domain_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[DomainTopic]

Parameters

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