Share via

NamespaceTopicsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventGridManagementClient's

<xref:namespace_topics> attribute.

Inheritance
builtins.object
NamespaceTopicsOperations

Constructor

NamespaceTopicsOperations(*args, **kwargs)

Methods

begin_create_or_update

Create a namespace topic.

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

Delete a namespace topic.

Delete existing namespace topic.
begin_regenerate_key

Regenerate key for a namespace topic.

Regenerate a shared access key for a namespace topic.
begin_update

Update a namespace topic.

Asynchronously updates a namespace topic with the specified parameters.
get

Get a namespace topic.

Get properties of a namespace topic.
list_by_namespace

List namespace topics under a namespace.

List all the namespace topics under a namespace.
list_shared_access_keys

List keys for a namespace topic.

List the two keys used to publish to a namespace topic.

begin_create_or_update

Create a namespace topic.

Asynchronously creates a new namespace topic with the specified parameters.

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

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_name
Required
str

Name of the namespace topic. Required.
namespace_topic_info
Required
NamespaceTopic or IO[bytes]

Namespace topic information. Is either a NamespaceTopic type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[NamespaceTopic]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Delete a namespace topic.

Delete existing namespace topic.

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

Name of the topic. Required.

Returns

Type Description
LROPoller[None]

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

Exceptions

Type Description
HttpResponseError

begin_regenerate_key

Regenerate key for a namespace topic.

Regenerate a shared access key for a namespace topic.

begin_regenerate_key(resource_group_name: str, namespace_name: str, topic_name: str, regenerate_key_request: _models.TopicRegenerateKeyRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.TopicSharedAccessKeys]

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_name
Required
str

Name of the topic. Required.
regenerate_key_request
Required
TopicRegenerateKeyRequest or IO[bytes]

Request body to regenerate key. Is either a TopicRegenerateKeyRequest type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[TopicSharedAccessKeys]

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

Exceptions

Type Description
HttpResponseError

begin_update

Update a namespace topic.

Asynchronously updates a namespace topic with the specified parameters.

begin_update(resource_group_name: str, namespace_name: str, topic_name: str, namespace_topic_update_parameters: _models.NamespaceTopicUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.NamespaceTopic]

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_name
Required
str

Name of the namespace topic. Required.
namespace_topic_update_parameters
Required
NamespaceTopicUpdateParameters or IO[bytes]

Namespace topic update information. Is either a NamespaceTopicUpdateParameters type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[NamespaceTopic]

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

Exceptions

Type Description
HttpResponseError

get

Get a namespace topic.

Get properties of a namespace topic.

get(resource_group_name: str, namespace_name: str, topic_name: str, **kwargs: Any) -> NamespaceTopic

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_name
Required
str

Name of the namespace topic. Required.

Returns

Type Description
NamespaceTopic

NamespaceTopic or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_namespace

List namespace topics under a namespace.

List all the namespace topics under a namespace.

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

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

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

Exceptions

Type Description
HttpResponseError

list_shared_access_keys

List keys for a namespace topic.

List the two keys used to publish to a namespace topic.

list_shared_access_keys(resource_group_name: str, namespace_name: str, topic_name: str, **kwargs: Any) -> TopicSharedAccessKeys

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_name
Required
str

Name of the topic. Required.

Returns

Type Description
TopicSharedAccessKeys

TopicSharedAccessKeys 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'>