DomainTopicsOperations Class

DomainTopicsOperations 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

DomainTopicsOperations

Constructor

DomainTopicsOperations(client, config, serializer, deserializer)

Parameters

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

models

Alias to model classes used in this operation group.

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) -> azure.core.polling._poller.LROPoller[azure.mgmt.eventgrid.models._models_py3.DomainTopic]

Parameters

resource_group_name

str

Required

The name of the resource group within the user's subscription.

domain_name

str

Required

Name of the domain.

domain_topic_name

str

Required

Name of the domain topic.

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 PollingMethod

By default, your polling method will be ARMPolling. 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

An instance of LROPoller that returns either DomainTopic or the result of cls(response)

Return type

LROPoller[DomainTopic]

Exceptions

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) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group within the user's subscription.

domain_name

str

Required

Name of the domain.

domain_topic_name

str

Required

Name of the domain topic.

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 PollingMethod

By default, your polling method will be ARMPolling. 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

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

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) -> azure.mgmt.eventgrid.models._models_py3.DomainTopic

Parameters

resource_group_name

str

Required

The name of the resource group within the user's subscription.

domain_name

str

Required

Name of the domain.

domain_topic_name

str

Required

Name of the topic.

cls

callable

A custom type or function that will be passed the direct response

Returns

DomainTopic, or the result of cls(response)

Return type

DomainTopic

Exceptions

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: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) -> Iterable[azure.mgmt.eventgrid.models._models_py3.DomainTopicsListResult]

Parameters

resource_group_name

str

Required

The name of the resource group within the user's subscription.

domain_name

str

Required

Domain name.

filter

str

Required

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

int

Required

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.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DomainTopicsListResult or the result of cls(response)

Return type

ItemPaged[DomainTopicsListResult]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.eventgrid.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\eventgrid\\models\\__init__.py'>