TopicSpace interface

The Topic space resource.

Extends

Properties

description

Description for the Topic Space resource.

provisioningState

Provisioning state of the TopicSpace resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData

The system metadata relating to the TopicSpace resource. NOTE: This property will not be serialized. It can only be populated by the server.

topicTemplates

The topic filters in the topic space. Example: "topicTemplates": [ "devices/foo/bar", "devices/topic1/+", "devices/${principal.name}/${principal.attributes.keyName}" ].

Inherited Properties

id

Fully qualified identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

name

Name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

type

Type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

description

Description for the Topic Space resource.

description?: string

Property Value

string

provisioningState

Provisioning state of the TopicSpace resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

systemData

The system metadata relating to the TopicSpace resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

topicTemplates

The topic filters in the topic space. Example: "topicTemplates": [ "devices/foo/bar", "devices/topic1/+", "devices/${principal.name}/${principal.attributes.keyName}" ].

topicTemplates?: string[]

Property Value

string[]

Inherited Property Details

id

Fully qualified identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

name

Name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

type

Type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type