Share via


IotHubConnectionProperties Class

Definition

Class representing the Kusto Iot hub connection properties.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.IotHubConnectionPropertiesTypeConverter))]
public class IotHubConnectionProperties : Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.IIotHubConnectionProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.IotHubConnectionPropertiesTypeConverter))>]
type IotHubConnectionProperties = class
    interface IIotHubConnectionProperties
    interface IJsonSerializable
Public Class IotHubConnectionProperties
Implements IIotHubConnectionProperties
Inheritance
IotHubConnectionProperties
Attributes
Implements

Constructors

IotHubConnectionProperties()

Creates an new IotHubConnectionProperties instance.

Properties

ConsumerGroup

The iot hub consumer group.

DatabaseRouting

Indication for database routing information from the data connection, by default only database routing information is allowed

DataFormat

The data format of the message. Optionally the data format can be added to each message.

EventSystemProperty

System properties of the iot hub

IotHubResourceId

The resource ID of the Iot hub to be used to create a data connection.

MappingRuleName

The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.

ProvisioningState

The provisioned state of the resource.

RetrievalStartDate

When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. It can only retrieve events retained by the Event hub, based on its retention period.

SharedAccessPolicyName

The name of the share access policy

TableName

The table where the data should be ingested. Optionally the table information can be added to each message.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of IotHubConnectionProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of IotHubConnectionProperties.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20230815.IIotHubConnectionProperties.

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of IotHubConnectionProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Applies to