ArmDigitalTwinsModelFactory.DataExplorerConnectionProperties Method

Definition

Namespace:

Azure.ResourceManager.DigitalTwins.Models

Assembly:

Azure.ResourceManager.DigitalTwins.dll

Package:

Azure.ResourceManager.DigitalTwins v1.3.0

Source:

ArmDigitalTwinsModelFactory.cs

Initializes a new instance of DataExplorerConnectionProperties.

public static Azure.ResourceManager.DigitalTwins.Models.DataExplorerConnectionProperties DataExplorerConnectionProperties (Azure.ResourceManager.DigitalTwins.Models.TimeSeriesDatabaseConnectionState? provisioningState = default, Azure.ResourceManager.DigitalTwins.Models.DigitalTwinsManagedIdentityReference identity = default, Azure.Core.ResourceIdentifier adxResourceId = default, Uri adxEndpointUri = default, string adxDatabaseName = default, string adxTableName = default, string adxTwinLifecycleEventsTableName = default, string adxRelationshipLifecycleEventsTableName = default, Uri eventHubEndpointUri = default, string eventHubEntityPath = default, Azure.Core.ResourceIdentifier eventHubNamespaceResourceId = default, string eventHubConsumerGroup = default, Azure.ResourceManager.DigitalTwins.Models.RecordPropertyAndItemRemoval? recordPropertyAndItemRemovals = default);

static member DataExplorerConnectionProperties : Nullable<Azure.ResourceManager.DigitalTwins.Models.TimeSeriesDatabaseConnectionState> * Azure.ResourceManager.DigitalTwins.Models.DigitalTwinsManagedIdentityReference * Azure.Core.ResourceIdentifier * Uri * string * string * string * string * Uri * string * Azure.Core.ResourceIdentifier * string * Nullable<Azure.ResourceManager.DigitalTwins.Models.RecordPropertyAndItemRemoval> -> Azure.ResourceManager.DigitalTwins.Models.DataExplorerConnectionProperties

Public Shared Function DataExplorerConnectionProperties (Optional provisioningState As Nullable(Of TimeSeriesDatabaseConnectionState) = Nothing, Optional identity As DigitalTwinsManagedIdentityReference = Nothing, Optional adxResourceId As ResourceIdentifier = Nothing, Optional adxEndpointUri As Uri = Nothing, Optional adxDatabaseName As String = Nothing, Optional adxTableName As String = Nothing, Optional adxTwinLifecycleEventsTableName As String = Nothing, Optional adxRelationshipLifecycleEventsTableName As String = Nothing, Optional eventHubEndpointUri As Uri = Nothing, Optional eventHubEntityPath As String = Nothing, Optional eventHubNamespaceResourceId As ResourceIdentifier = Nothing, Optional eventHubConsumerGroup As String = Nothing, Optional recordPropertyAndItemRemovals As Nullable(Of RecordPropertyAndItemRemoval) = Nothing) As DataExplorerConnectionProperties

Parameters

provisioningState

Nullable<TimeSeriesDatabaseConnectionState>

The provisioning state.

identity

DigitalTwinsManagedIdentityReference

Managed identity properties for the time series database connection resource.

adxResourceId

ResourceIdentifier

The resource ID of the Azure Data Explorer cluster.

adxEndpointUri

Uri

The URI of the Azure Data Explorer endpoint.

adxDatabaseName

String

The name of the Azure Data Explorer database.

adxTableName

String

The name of the Azure Data Explorer table used for storing updates to properties of twins and relationships. Defaults to AdtPropertyEvents.

adxTwinLifecycleEventsTableName

String

The name of the Azure Data Explorer table used for recording twin lifecycle events. The table will not be created if this property is left unspecified.

adxRelationshipLifecycleEventsTableName

String

The name of the Azure Data Explorer table used for recording relationship lifecycle events. The table will not be created if this property is left unspecified.

eventHubEndpointUri

Uri

The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://.

eventHubEntityPath

String

The EventHub name in the EventHub namespace for identity-based authentication.

eventHubNamespaceResourceId

ResourceIdentifier

The resource ID of the EventHub namespace.

eventHubConsumerGroup

String

The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.

recordPropertyAndItemRemovals

Nullable<RecordPropertyAndItemRemoval>

Specifies whether or not to record twin / relationship property and item removals, including removals of indexed or keyed values (such as map entries, array elements, etc.). This feature is de-activated unless explicitly set to 'true'. Setting this property to 'true' will generate an additional column in the property events table in ADX.

Returns

DataExplorerConnectionProperties

A new DataExplorerConnectionProperties instance for mocking.