Share via

Channel interface

  • Reference
Package:
@azure/arm-eventgrid

Channel info.

Extends
Resource

Properties

channelType

The type of the event channel which represents the direction flow of events.
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.
messageForActivation

Context or helpful message that can be used during the approval process by the subscriber.
partnerDestinationInfo

This property should be populated when channelType is PartnerDestination and represents information about the partner destination resource corresponding to the channel.
partnerTopicInfo

This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.
provisioningState

Provisioning state of the channel.
readinessState

The readiness state of the corresponding partner topic.
systemData

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

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

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

PartnerDestinationInfoUnion

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

PartnerTopicInfo

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

systemData

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

systemData?: SystemData

Property Value

SystemData

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