ChannelProperties Class
Properties of the Channel.
Constructor
ChannelProperties(*args: Any, **kwargs: Any)
Variables
| Name | Description |
|---|---|
|
channel_type
|
str or
ChannelType
The type of the event channel which represents the direction flow of events. Known values are: "PartnerTopic" and "PartnerDestination". |
|
partner_topic_info
|
This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel. |
|
partner_destination_info
|
This property should be populated when channelType is PartnerDestination and represents information about the partner destination resource corresponding to the channel. |
|
message_for_activation
|
Context or helpful message that can be used during the approval process by the subscriber. |
|
provisioning_state
|
Provisioning state of the channel. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", "IdleDueToMirroredPartnerTopicDeletion", and "IdleDueToMirroredPartnerDestinationDeletion". |
|
readiness_state
|
The readiness state of the corresponding partner topic. Known values are: "NeverActivated" and "Activated". |
|
expiration_time_if_not_activated_utc
|
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. |
Attributes
channel_type
The type of the event channel which represents the direction flow of events. Known values are: "PartnerTopic" and "PartnerDestination".
channel_type: str | _models.ChannelType | None
expiration_time_if_not_activated_utc
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.
expiration_time_if_not_activated_utc: datetime | None
message_for_activation
Context or helpful message that can be used during the approval process by the subscriber.
message_for_activation: str | None
partner_destination_info
This property should be populated when channelType is PartnerDestination and represents information about the partner destination resource corresponding to the channel.
partner_destination_info: _models.PartnerDestinationInfo | None
partner_topic_info
This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.
partner_topic_info: _models.PartnerTopicInfo | None
provisioning_state
"Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", "IdleDueToMirroredPartnerTopicDeletion", and "IdleDueToMirroredPartnerDestinationDeletion".
provisioning_state: str | _models.ChannelProvisioningState | None
readiness_state
"NeverActivated" and "Activated".
readiness_state: str | _models.ReadinessState | None