Share via

TopicSpacesOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventGridManagementClient's

<xref:topic_spaces> attribute.

Inheritance
builtins.object
TopicSpacesOperations

Constructor

TopicSpacesOperations(*args, **kwargs)

Methods

begin_create_or_update

Create or update a topic space.

Create or update a topic space with the specified parameters.
begin_delete

Delete a topic space.

Delete an existing topic space.
get

Get a topic space.

Get properties of a topic space.
list_by_namespace

List all topic spaces under a namespace.

Get all the topic spaces under a namespace.

begin_create_or_update

Create or update a topic space.

Create or update a topic space with the specified parameters.

begin_create_or_update(resource_group_name: str, namespace_name: str, topic_space_name: str, topic_space_info: _models.TopicSpace, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.TopicSpace]

Parameters

Name Description
resource_group_name
Required
str

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

Name of the namespace. Required.
topic_space_name
Required
str

The topic space name. Required.
topic_space_info
Required
TopicSpace or IO[bytes]

Topic space information. Is either a TopicSpace type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[TopicSpace]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Delete a topic space.

Delete an existing topic space.

begin_delete(resource_group_name: str, namespace_name: str, topic_space_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.
namespace_name
Required
str

Name of the namespace. Required.
topic_space_name
Required
str

Name of the Topic space. 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 topic space.

Get properties of a topic space.

get(resource_group_name: str, namespace_name: str, topic_space_name: str, **kwargs: Any) -> TopicSpace

Parameters

Name Description
resource_group_name
Required
str

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

Name of the namespace. Required.
topic_space_name
Required
str

Name of the Topic space. Required.

Returns

Type Description
TopicSpace

TopicSpace or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_namespace

List all topic spaces under a namespace.

Get all the topic spaces under a namespace.

list_by_namespace(resource_group_name: str, namespace_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[TopicSpace]

Parameters

Name Description
resource_group_name
Required
str

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

Name of the namespace. 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[TopicSpace]

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