ChannelProperties Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Properties of the Channel.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.ChannelPropertiesTypeConverter))]
public class ChannelProperties : Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IChannelProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.ChannelPropertiesTypeConverter))>]
type ChannelProperties = class
interface IChannelProperties
interface IJsonSerializable
Public Class ChannelProperties
Implements IChannelProperties
- Inheritance
-
ChannelProperties
- Attributes
- Implements
Constructors
ChannelProperties() |
Creates an new ChannelProperties 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. |
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. |
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. |
Methods
DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of ChannelProperties. |
DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of ChannelProperties. |
FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IChannelProperties. |
FromJsonString(String) |
Creates a new instance of ChannelProperties, deserializing the content from a json string. |
ToJson(JsonObject, SerializationMode) |
Serializes this instance of ChannelProperties into a JsonNode. |
ToJsonString() |
Serializes this instance to a json string. |
ToString() |