Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. kusto
  5. getIotHubDataConnection
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.kusto.getIotHubDataConnection

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Returns a data connection. Azure REST API version: 2022-12-29.

Using getIotHubDataConnection

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getIotHubDataConnection(args: GetIotHubDataConnectionArgs, opts?: InvokeOptions): Promise<GetIotHubDataConnectionResult>
function getIotHubDataConnectionOutput(args: GetIotHubDataConnectionOutputArgs, opts?: InvokeOptions): Output<GetIotHubDataConnectionResult>
Copy
def get_iot_hub_data_connection(cluster_name: Optional[str] = None,
                                data_connection_name: Optional[str] = None,
                                database_name: Optional[str] = None,
                                resource_group_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetIotHubDataConnectionResult
def get_iot_hub_data_connection_output(cluster_name: Optional[pulumi.Input[str]] = None,
                                data_connection_name: Optional[pulumi.Input[str]] = None,
                                database_name: Optional[pulumi.Input[str]] = None,
                                resource_group_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetIotHubDataConnectionResult]
Copy
func LookupIotHubDataConnection(ctx *Context, args *LookupIotHubDataConnectionArgs, opts ...InvokeOption) (*LookupIotHubDataConnectionResult, error)
func LookupIotHubDataConnectionOutput(ctx *Context, args *LookupIotHubDataConnectionOutputArgs, opts ...InvokeOption) LookupIotHubDataConnectionResultOutput
Copy

> Note: This function is named LookupIotHubDataConnection in the Go SDK.

public static class GetIotHubDataConnection 
{
    public static Task<GetIotHubDataConnectionResult> InvokeAsync(GetIotHubDataConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetIotHubDataConnectionResult> Invoke(GetIotHubDataConnectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIotHubDataConnectionResult> getIotHubDataConnection(GetIotHubDataConnectionArgs args, InvokeOptions options)
public static Output<GetIotHubDataConnectionResult> getIotHubDataConnection(GetIotHubDataConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:kusto:getIotHubDataConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
DataConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the data connection.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group containing the Kusto cluster.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
DataConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the data connection.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group containing the Kusto cluster.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto cluster.
dataConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the data connection.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database in the Kusto cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group containing the Kusto cluster.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto cluster.
dataConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the data connection.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group containing the Kusto cluster.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Kusto cluster.
data_connection_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the data connection.
database_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the database in the Kusto cluster.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group containing the Kusto cluster.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto cluster.
dataConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the data connection.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database in the Kusto cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group containing the Kusto cluster.

getIotHubDataConnection Result

The following output properties are available:

ConsumerGroup string
The iot hub consumer group.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
IotHubResourceId string
The resource ID of the Iot hub to be used to create a data connection.
Name string
The name of the resource
ProvisioningState string
The provisioned state of the resource.
SharedAccessPolicyName string
The name of the share access policy
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
DataFormat string
The data format of the message. Optionally the data format can be added to each message.
DatabaseRouting string
Indication for database routing information from the data connection, by default only database routing information is allowed
EventSystemProperties List<string>
System properties of the iot hub
Location string
Resource location.
MappingRuleName string
The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
RetrievalStartDate string
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.
TableName string
The table where the data should be ingested. Optionally the table information can be added to each message.
ConsumerGroup string
The iot hub consumer group.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
IotHubResourceId string
The resource ID of the Iot hub to be used to create a data connection.
Name string
The name of the resource
ProvisioningState string
The provisioned state of the resource.
SharedAccessPolicyName string
The name of the share access policy
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
DataFormat string
The data format of the message. Optionally the data format can be added to each message.
DatabaseRouting string
Indication for database routing information from the data connection, by default only database routing information is allowed
EventSystemProperties []string
System properties of the iot hub
Location string
Resource location.
MappingRuleName string
The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
RetrievalStartDate string
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.
TableName string
The table where the data should be ingested. Optionally the table information can be added to each message.
consumerGroup String
The iot hub consumer group.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
iotHubResourceId String
The resource ID of the Iot hub to be used to create a data connection.
name String
The name of the resource
provisioningState String
The provisioned state of the resource.
sharedAccessPolicyName String
The name of the share access policy
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
dataFormat String
The data format of the message. Optionally the data format can be added to each message.
databaseRouting String
Indication for database routing information from the data connection, by default only database routing information is allowed
eventSystemProperties List<String>
System properties of the iot hub
location String
Resource location.
mappingRuleName String
The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
retrievalStartDate String
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.
tableName String
The table where the data should be ingested. Optionally the table information can be added to each message.
consumerGroup string
The iot hub consumer group.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
iotHubResourceId string
The resource ID of the Iot hub to be used to create a data connection.
name string
The name of the resource
provisioningState string
The provisioned state of the resource.
sharedAccessPolicyName string
The name of the share access policy
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
dataFormat string
The data format of the message. Optionally the data format can be added to each message.
databaseRouting string
Indication for database routing information from the data connection, by default only database routing information is allowed
eventSystemProperties string[]
System properties of the iot hub
location string
Resource location.
mappingRuleName string
The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
retrievalStartDate string
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.
tableName string
The table where the data should be ingested. Optionally the table information can be added to each message.
consumer_group str
The iot hub consumer group.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
iot_hub_resource_id str
The resource ID of the Iot hub to be used to create a data connection.
name str
The name of the resource
provisioning_state str
The provisioned state of the resource.
shared_access_policy_name str
The name of the share access policy
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
data_format str
The data format of the message. Optionally the data format can be added to each message.
database_routing str
Indication for database routing information from the data connection, by default only database routing information is allowed
event_system_properties Sequence[str]
System properties of the iot hub
location str
Resource location.
mapping_rule_name str
The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
retrieval_start_date str
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.
table_name str
The table where the data should be ingested. Optionally the table information can be added to each message.
consumerGroup String
The iot hub consumer group.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
iotHubResourceId String
The resource ID of the Iot hub to be used to create a data connection.
name String
The name of the resource
provisioningState String
The provisioned state of the resource.
sharedAccessPolicyName String
The name of the share access policy
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
dataFormat String
The data format of the message. Optionally the data format can be added to each message.
databaseRouting String
Indication for database routing information from the data connection, by default only database routing information is allowed
eventSystemProperties List<String>
System properties of the iot hub
location String
Resource location.
mappingRuleName String
The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
retrievalStartDate String
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.
tableName String
The table where the data should be ingested. Optionally the table information can be added to each message.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native