TopicSpacesConfiguration interface

Properties of the Topic Spaces Configuration.

Properties

clientAuthentication

Client authentication settings for topic spaces configuration.

customDomains

List of custom domain configurations for the namespace.

hostname

The endpoint for the topic spaces configuration. This is a read-only property. NOTE: This property will not be serialized. It can only be populated by the server.

maximumClientSessionsPerAuthenticationName

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.

maximumSessionExpiryInHours

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.

routeTopicResourceId

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.

routingEnrichments

Routing enrichments for topic spaces configuration

routingIdentityInfo

Routing identity info for topic spaces configuration.

state

Indicate if Topic Spaces Configuration is enabled for the namespace. Default is Disabled.

Property Details

clientAuthentication

Client authentication settings for topic spaces configuration.

clientAuthentication?: ClientAuthenticationSettings

Property Value

customDomains

List of custom domain configurations for the namespace.

customDomains?: CustomDomainConfiguration[]

Property Value

hostname

The endpoint for the topic spaces configuration. This is a read-only property. NOTE: This property will not be serialized. It can only be populated by the server.

hostname?: string

Property Value

string

maximumClientSessionsPerAuthenticationName

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.

maximumClientSessionsPerAuthenticationName?: number

Property Value

number

maximumSessionExpiryInHours

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.

maximumSessionExpiryInHours?: number

Property Value

number

routeTopicResourceId

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.

routeTopicResourceId?: string

Property Value

string

routingEnrichments

Routing enrichments for topic spaces configuration

routingEnrichments?: RoutingEnrichments

Property Value

routingIdentityInfo

Routing identity info for topic spaces configuration.

routingIdentityInfo?: RoutingIdentityInfo

Property Value

state

Indicate if Topic Spaces Configuration is enabled for the namespace. Default is Disabled.

state?: string

Property Value

string