Share via

TopicSpacesConfiguration Class

  • Reference

Properties of the Topic Spaces Configuration.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.eventgrid._serialization.Model
TopicSpacesConfiguration

Constructor

TopicSpacesConfiguration(*, state: str | _models.TopicSpacesConfigurationState | None = None, route_topic_resource_id: str | None = None, routing_enrichments: _models.RoutingEnrichments | None = None, client_authentication: _models.ClientAuthenticationSettings | None = None, maximum_session_expiry_in_hours: int | None = None, maximum_client_sessions_per_authentication_name: int | None = None, routing_identity_info: _models.RoutingIdentityInfo | None = None, custom_domains: List[_models.CustomDomainConfiguration] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
state
str or TopicSpacesConfigurationState

Indicate if Topic Spaces Configuration is enabled for the namespace. Default is Disabled. Known values are: "Disabled" and "Enabled".
route_topic_resource_id
str

Fully qualified Azure Resource Id for the Event Grid Topic to which events will be routed to from TopicSpaces under a namespace. This property should be in the following format '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft.EventGrid/topics/{topicName}'. This topic should reside in the same region where namespace is located.
routing_enrichments
RoutingEnrichments

Routing enrichments for topic spaces configuration.
client_authentication
ClientAuthenticationSettings

Client authentication settings for topic spaces configuration.
maximum_session_expiry_in_hours
int

The maximum session expiry in hours. The property default value is 1 hour. Min allowed value is 1 hour and max allowed value is 8 hours.
maximum_client_sessions_per_authentication_name
int

The maximum number of sessions per authentication name. The property default value is 1. Min allowed value is 1 and max allowed value is 100.
routing_identity_info
RoutingIdentityInfo

Routing identity info for topic spaces configuration.
custom_domains
list[CustomDomainConfiguration]

List of custom domain configurations for the namespace.

Variables

Name Description
state
str or TopicSpacesConfigurationState

Indicate if Topic Spaces Configuration is enabled for the namespace. Default is Disabled. Known values are: "Disabled" and "Enabled".
route_topic_resource_id
str

Fully qualified Azure Resource Id for the Event Grid Topic to which events will be routed to from TopicSpaces under a namespace. This property should be in the following format '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft.EventGrid/topics/{topicName}'. This topic should reside in the same region where namespace is located.
hostname
str

The endpoint for the topic spaces configuration. This is a read-only property.
routing_enrichments
RoutingEnrichments

Routing enrichments for topic spaces configuration.
client_authentication
ClientAuthenticationSettings

Client authentication settings for topic spaces configuration.
maximum_session_expiry_in_hours
int

The maximum session expiry in hours. The property default value is 1 hour. Min allowed value is 1 hour and max allowed value is 8 hours.
maximum_client_sessions_per_authentication_name
int

The maximum number of sessions per authentication name. The property default value is 1. Min allowed value is 1 and max allowed value is 100.
routing_identity_info
RoutingIdentityInfo

Routing identity info for topic spaces configuration.
custom_domains
list[CustomDomainConfiguration]

List of custom domain configurations for the namespace.