Share via

SystemTopicsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventGridManagementClient's

<xref:system_topics> attribute.

Inheritance
builtins.object
SystemTopicsOperations

Constructor

SystemTopicsOperations(*args, **kwargs)

Methods

begin_create_or_update

Create a system topic.

Asynchronously creates a new system topic with the specified parameters.
begin_delete

Delete a system topic.

Delete existing system topic.
begin_update

Update a system topic.

Asynchronously updates a system topic with the specified parameters.
get

Get a system topic.

Get properties of a system topic.
list_by_resource_group

List system topics under a resource group.

List all the system topics under a resource group.
list_by_subscription

List system topics under an Azure subscription.

List all the system topics under an Azure subscription.

begin_create_or_update

Create a system topic.

Asynchronously creates a new system topic with the specified parameters.

async begin_create_or_update(resource_group_name: str, system_topic_name: str, system_topic_info: _models.SystemTopic, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.SystemTopic]

Parameters

Name Description
resource_group_name
Required
str

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

Name of the system topic. Required.
system_topic_info
Required
SystemTopic or IO[bytes]

System Topic information. Is either a SystemTopic type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[SystemTopic]

An instance of AsyncLROPoller that returns either SystemTopic or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Delete a system topic.

Delete existing system topic.

async begin_delete(resource_group_name: str, system_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.
system_topic_name
Required
str

Name of the system 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

begin_update

Update a system topic.

Asynchronously updates a system topic with the specified parameters.

async begin_update(resource_group_name: str, system_topic_name: str, system_topic_update_parameters: _models.SystemTopicUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.SystemTopic]

Parameters

Name Description
resource_group_name
Required
str

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

Name of the system topic. Required.
system_topic_update_parameters
Required
SystemTopicUpdateParameters or IO[bytes]

SystemTopic update information. Is either a SystemTopicUpdateParameters type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[SystemTopic]

An instance of AsyncLROPoller that returns either SystemTopic or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get a system topic.

Get properties of a system topic.

async get(resource_group_name: str, system_topic_name: str, **kwargs: Any) -> SystemTopic

Parameters

Name Description
resource_group_name
Required
str

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

Name of the system topic. Required.

Returns

Type Description
SystemTopic

SystemTopic or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_resource_group

List system topics under a resource group.

List all the system topics under a resource group.

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

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

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

Exceptions

Type Description
HttpResponseError

list_by_subscription

List system topics under an Azure subscription.

List all the system topics under an Azure subscription.

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

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.

Returns

Type Description
AsyncItemPaged[SystemTopic]

An iterator like instance of either SystemTopic 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'>