Share via


IotHubDataConnection Class

Definition

Class representing an iot hub data connection.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IotHubDataConnectionTypeConverter))]
public class IotHubDataConnection : Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IIotHubDataConnection, Microsoft.Azure.PowerShell.Cmdlets.Synapse.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IotHubDataConnectionTypeConverter))>]
type IotHubDataConnection = class
    interface IIotHubDataConnection
    interface IJsonSerializable
    interface IDataConnection
    interface IResource
    interface IValidates
Public Class IotHubDataConnection
Implements IIotHubDataConnection, IValidates
Inheritance
IotHubDataConnection
Attributes
Implements

Constructors

IotHubDataConnection()

Creates an new IotHubDataConnection instance.

Properties

ConsumerGroup

The iot hub consumer group.

DataFormat

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

EventSystemProperty

System properties of the iot hub

Id

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

IotHubResourceId

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

Kind

Kind of the endpoint for the data connection

Location

Resource location.

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

ProvisioningState

The provisioned state of the resource.

SharedAccessPolicyName

The name of the share access policy

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

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.

TableName

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

Type

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

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of IotHubDataConnection.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of IotHubDataConnection.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Synapse.Models.Api20210601Preview.IIotHubDataConnection.

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of IotHubDataConnection into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to