ChannelProperties interface
Properties of the Channel.
Properties
| channel |
The type of the event channel which represents the direction flow of events. |
| expiration |
Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, the channel and corresponding partner topic are deleted. |
| message |
Context or helpful message that can be used during the approval process by the subscriber. |
| partner |
This property should be populated when channelType is PartnerDestination and represents information about the partner destination resource corresponding to the channel. |
| partner |
This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel. |
| provisioning |
Provisioning state of the channel. |
| readiness |
The readiness state of the corresponding partner topic. |
Property Details
channelType
The type of the event channel which represents the direction flow of events.
channelType?: string
Property Value
string
expirationTimeIfNotActivatedUtc
Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, the channel and corresponding partner topic are deleted.
expirationTimeIfNotActivatedUtc?: Date
Property Value
Date
messageForActivation
Context or helpful message that can be used during the approval process by the subscriber.
messageForActivation?: string
Property Value
string
partnerDestinationInfo
This property should be populated when channelType is PartnerDestination and represents information about the partner destination resource corresponding to the channel.
partnerDestinationInfo?: PartnerDestinationInfoUnion
Property Value
partnerTopicInfo
This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.
partnerTopicInfo?: PartnerTopicInfo
Property Value
provisioningState
Provisioning state of the channel.
provisioningState?: string
Property Value
string
readinessState
The readiness state of the corresponding partner topic.
readinessState?: string
Property Value
string