SystemTopicsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:system_topics> attribute.
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
|
The name of the resource group. The name is case insensitive. Required. |
|
system_topic_name
Required
|
Name of the system topic. Required. |
|
system_topic_info
Required
|
System Topic information. Is one of the following types: SystemTopic, JSON, IO[bytes] Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns SystemTopic. The SystemTopic is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. The name is case insensitive. Required. |
|
system_topic_name
Required
|
Name of the system topic. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns None |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. The name is case insensitive. Required. |
|
system_topic_name
Required
|
Name of the system topic. Required. |
|
system_topic_update_parameters
Required
|
SystemTopic update information. Is one of the following types: SystemTopicUpdateParameters, JSON, IO[bytes] Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns SystemTopic. The SystemTopic is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
get
Get a system topic.
Get properties of a system topic.
async get(resource_group_name: str, system_topic_name: str, **kwargs: Any) -> SystemTopicParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
system_topic_name
Required
|
Name of the system topic. Required. |
Returns
| Type | Description |
|---|---|
|
SystemTopic. The SystemTopic is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
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) -> AsyncItemPaged[SystemTopic]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
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 SystemTopic |
Exceptions
| Type | Description |
|---|---|
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) -> AsyncItemPaged[SystemTopic]Keyword-Only Parameters
| Name | Description |
|---|---|
|
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 SystemTopic |
Exceptions
| Type | Description |
|---|---|
