DomainTopicsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:domain_topics> attribute.
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.
async begin_create_or_update(resource_group_name: str, domain_name: str, domain_topic_name: str, **kwargs: Any) -> AsyncLROPoller[DomainTopic]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. Required. |
|
domain_name
Required
|
Name of the domain. Required. |
|
domain_topic_name
Required
|
Name of the domain topic. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either DomainTopic or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete
Delete a domain topic.
Delete existing domain topic.
async begin_delete(resource_group_name: str, domain_name: str, domain_topic_name: str, **kwargs: Any) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. Required. |
|
domain_name
Required
|
Name of the domain. Required. |
|
domain_topic_name
Required
|
Name of the domain topic. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Get a domain topic.
Get properties of a domain topic.
async get(resource_group_name: str, domain_name: str, domain_topic_name: str, **kwargs: Any) -> DomainTopicParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. Required. |
|
domain_name
Required
|
Name of the domain. Required. |
|
domain_topic_name
Required
|
Name of the topic. Required. |
Returns
| Type | Description |
|---|---|
|
DomainTopic or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> AsyncIterable[DomainTopic]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. Required. |
|
domain_name
Required
|
Domain name. 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 DomainTopic 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\\venv130\\Lib\\site-packages\\azure\\mgmt\\eventgrid\\models\\__init__.py'>