Share via


Channel Class

Definition

Channel info.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.ChannelTypeConverter))]
public class Channel : Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IChannel, Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.ChannelTypeConverter))>]
type Channel = class
    interface IChannel
    interface IJsonSerializable
    interface IResource
    interface IValidates
Public Class Channel
Implements IChannel, IValidates
Inheritance
Channel
Attributes
Implements

Constructors

Channel()

Creates an new Channel instance.

Properties

ChannelType

The type of the event channel which represents the direction flow of events.

EventTypeInfoInlineEventType

A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. An example of a valid inline event name is "Contoso.OrderCreated". The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.

EventTypeInfoKind

The kind of event type used.

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.

Id

Fully qualified identifier of the resource.

MessageForActivation

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

Name

Name of the resource.

PartnerDestinationInfo

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

PartnerDestinationInfoAzureSubscriptionId

Azure subscription ID of the subscriber. The partner destination associated with the channel will be created under this Azure subscription.

PartnerDestinationInfoEndpointServiceContext

Additional context of the partner destination endpoint.

PartnerDestinationInfoEndpointType

Type of the endpoint for the partner destination

PartnerDestinationInfoName

Name of the partner destination associated with the channel.

PartnerDestinationInfoResourceGroupName

Azure Resource Group of the subscriber. The partner destination associated with the channel will be created under this resource group.

PartnerDestinationInfoResourceMoveChangeHistory

Change history of the resource move.

PartnerTopicInfoAzureSubscriptionId

Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription.

PartnerTopicInfoName

Name of the partner topic associated with the channel.

PartnerTopicInfoResourceGroupName

Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group.

PartnerTopicInfoSource

The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic.

ProvisioningState

Provisioning state of the channel.

ReadinessState

The readiness state of the corresponding partner topic.

ResourceGroupName

Gets the resource group name

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Type

Type of the resource.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of Channel.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of Channel.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IChannel.

FromJsonString(String)

Creates a new instance of Channel, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of Channel into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to