Share via


KustoIotHubDataConnection Class

Definition

Class representing an iot hub data connection.

public class KustoIotHubDataConnection : Azure.ResourceManager.Kusto.KustoDataConnectionData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Kusto.Models.KustoIotHubDataConnection>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Kusto.Models.KustoIotHubDataConnection>
type KustoIotHubDataConnection = class
    inherit KustoDataConnectionData
    interface IJsonModel<KustoIotHubDataConnection>
    interface IPersistableModel<KustoIotHubDataConnection>
Public Class KustoIotHubDataConnection
Inherits KustoDataConnectionData
Implements IJsonModel(Of KustoIotHubDataConnection), IPersistableModel(Of KustoIotHubDataConnection)
Inheritance
KustoIotHubDataConnection
Implements

Constructors

KustoIotHubDataConnection()

Initializes a new instance of KustoIotHubDataConnection.

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.

EventSystemProperties

System properties of the iot hub.

Id

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

(Inherited from ResourceData)
IotHubResourceId

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

Location

Resource location.

(Inherited from KustoDataConnectionData)
MappingRuleName

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

Name

The name of the resource.

(Inherited from ResourceData)
ProvisioningState

The provisioned state of the resource.

ResourceType

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

(Inherited from ResourceData)
RetrievalStartOn

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.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
TableName

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

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<KustoDataConnectionData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from KustoDataConnectionData)
IJsonModel<KustoDataConnectionData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from KustoDataConnectionData)
IJsonModel<KustoIotHubDataConnection>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<KustoIotHubDataConnection>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<KustoDataConnectionData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from KustoDataConnectionData)
IPersistableModel<KustoDataConnectionData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from KustoDataConnectionData)
IPersistableModel<KustoDataConnectionData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from KustoDataConnectionData)
IPersistableModel<KustoIotHubDataConnection>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<KustoIotHubDataConnection>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<KustoIotHubDataConnection>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to