Channel interface

Package:

@azure/arm-eventgrid

Channel info.

Extends

ProxyResource

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.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type