Channel Class
Channel info.
Variables are only populated by the server, and will be ignored when sending a request.
- Inheritance
-
azure.mgmt.eventgrid.models._models_py3.ResourceChannel
Constructor
Channel(*, channel_type: str | _models.ChannelType | None = None, partner_topic_info: _models.PartnerTopicInfo | None = None, partner_destination_info: _models.PartnerDestinationInfo | None = None, message_for_activation: str | None = None, provisioning_state: str | _models.ChannelProvisioningState | None = None, readiness_state: str | _models.ReadinessState | None = None, expiration_time_if_not_activated_utc: datetime | None = None, **kwargs: Any)
Keyword-Only Parameters
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. |
Variables
Name | Description |
---|---|
id
|
Fully qualified identifier of the resource. |
name
|
Name of the resource. |
type
|
Type of the resource. |
system_data
|
The system metadata relating to Channel resource. |
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. |
Azure SDK for Python