AzureDataExplorerConnectionProperties Class

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models

Assembly:: Az.DigitalTwins.private.dll

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 a time series database connection to Azure Data Explorer with data being sent via an EventHub.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.AzureDataExplorerConnectionPropertiesTypeConverter))]
public class AzureDataExplorerConnectionProperties : Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IAzureDataExplorerConnectionProperties, Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.AzureDataExplorerConnectionPropertiesTypeConverter))>]
type AzureDataExplorerConnectionProperties = class
    interface IAzureDataExplorerConnectionProperties
    interface IJsonSerializable
    interface ITimeSeriesDatabaseConnectionProperties
    interface IValidates

Public Class AzureDataExplorerConnectionProperties
Implements IAzureDataExplorerConnectionProperties, IValidates

Inheritance: Object
AzureDataExplorerConnectionProperties

Attributes: TypeConverterAttribute

Implements: IAzureDataExplorerConnectionProperties ITimeSeriesDatabaseConnectionProperties IJsonSerializable IValidates

Constructors

Name	Description
AzureDataExplorerConnectionProperties()	Creates an new AzureDataExplorerConnectionProperties instance.

Properties

Name	Description
AdxDatabaseName	The name of the Azure Data Explorer database.
AdxEndpointUri	The URI of the Azure Data Explorer endpoint.
AdxResourceId	The resource ID of the Azure Data Explorer cluster.
AdxTableName	The name of the Azure Data Explorer table. Defaults to AdtPropertyEvents.
ConnectionType	The type of time series connection resource.
EventHubConsumerGroup	The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.
EventHubEndpointUri	The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
EventHubEntityPath	The EventHub name in the EventHub namespace for identity-based authentication.
EventHubNamespaceResourceId	The resource ID of the EventHub namespace.
ProvisioningState	The provisioning state.

Methods

Name	Description
DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of AzureDataExplorerConnectionProperties.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of AzureDataExplorerConnectionProperties.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IAzureDataExplorerConnectionProperties.
FromJsonString(String)	Creates a new instance of AzureDataExplorerConnectionProperties, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of AzureDataExplorerConnectionProperties into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()
Validate(IEventListener)	Validates that this object meets the validation criteria.

Applies to