EventHubEventSourceCreateOrUpdateParameters 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.
Parameters supplied to the Create or Update Event Source operation for an EventHub event source.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20200515.EventHubEventSourceCreateOrUpdateParametersTypeConverter))]
public class EventHubEventSourceCreateOrUpdateParameters : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20200515.IEventHubEventSourceCreateOrUpdateParameters, Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20200515.EventHubEventSourceCreateOrUpdateParametersTypeConverter))>]
type EventHubEventSourceCreateOrUpdateParameters = class
interface IEventHubEventSourceCreateOrUpdateParameters
interface IJsonSerializable
interface IEventSourceCreateOrUpdateParameters
interface ICreateOrUpdateTrackedResourceProperties
interface IValidates
Public Class EventHubEventSourceCreateOrUpdateParameters
Implements IEventHubEventSourceCreateOrUpdateParameters, IValidates
- Inheritance
-
EventHubEventSourceCreateOrUpdateParameters
- Attributes
- Implements
Constructors
EventHubEventSourceCreateOrUpdateParameters() |
Creates an new EventHubEventSourceCreateOrUpdateParameters instance. |
Properties
ConsumerGroupName |
The name of the event hub's consumer group that holds the partitions from which events will be read. |
CreationTime |
The time the resource was created. |
EventHubName |
The name of the event hub. |
EventSourceResourceId |
The resource id of the event source in Azure Resource Manager. |
KeyName |
The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub. |
Kind |
The kind of the event source. |
LocalTimestamp |
An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events. |
LocalTimestampFormat |
An enum that represents the format of the local timestamp property that needs to be set. |
LocalTimestampTimeZoneOffset |
An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded. |
Location |
The location of the resource. |
Property |
Properties of the EventHub event source that are required on create or update requests. |
ProvisioningState |
Provisioning state of the resource. |
ServiceBusNamespace |
The name of the service bus that contains the event hub. |
SharedAccessKey |
The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses. |
Tag |
Key-value pairs of additional properties for the resource. |
TimestampPropertyName |
The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used. |
TimeZoneOffsetPropertyName |
The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of property which contains values representing the offset (eg: P1D or 1.00:00:00) |
Methods
DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of EventHubEventSourceCreateOrUpdateParameters. |
DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of EventHubEventSourceCreateOrUpdateParameters. |
FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20200515.IEventHubEventSourceCreateOrUpdateParameters. |
FromJsonString(String) |
Creates a new instance of EventHubEventSourceCreateOrUpdateParameters, deserializing the content from a json string. |
ToJson(JsonObject, SerializationMode) |
Serializes this instance of EventHubEventSourceCreateOrUpdateParameters into a JsonNode. |
ToJsonString() |
Serializes this instance to a json string. |
Validate(IEventListener) |
Validates that this object meets the validation criteria. |