Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. kusto
  5. IotHubDataConnection
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.kusto.IotHubDataConnection

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Class representing an iot hub data connection. API Version: 2021-01-01.

    Example Usage

    KustoDataConnectionsCreateOrUpdate

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var iotHubDataConnection = new AzureNative.Kusto.IotHubDataConnection("iotHubDataConnection", new()
    {
        ClusterName = "kustoclusterrptest4",
        DataConnectionName = "DataConnections8",
        DatabaseName = "KustoDatabase8",
        ResourceGroupName = "kustorptest",
    });

});

    package main

import (
	kusto "github.com/pulumi/pulumi-azure-native-sdk/kusto"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kusto.NewIotHubDataConnection(ctx, "iotHubDataConnection", &kusto.IotHubDataConnectionArgs{
			ClusterName:        pulumi.String("kustoclusterrptest4"),
			DataConnectionName: pulumi.String("DataConnections8"),
			DatabaseName:       pulumi.String("KustoDatabase8"),
			ResourceGroupName:  pulumi.String("kustorptest"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.kusto.IotHubDataConnection;
import com.pulumi.azurenative.kusto.IotHubDataConnectionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var iotHubDataConnection = new IotHubDataConnection("iotHubDataConnection", IotHubDataConnectionArgs.builder()        
            .clusterName("kustoclusterrptest4")
            .dataConnectionName("DataConnections8")
            .databaseName("KustoDatabase8")
            .resourceGroupName("kustorptest")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

iot_hub_data_connection = azure_native.kusto.IotHubDataConnection("iotHubDataConnection",
    cluster_name="kustoclusterrptest4",
    data_connection_name="DataConnections8",
    database_name="KustoDatabase8",
    resource_group_name="kustorptest")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const iotHubDataConnection = new azure_native.kusto.IotHubDataConnection("iotHubDataConnection", {
    clusterName: "kustoclusterrptest4",
    dataConnectionName: "DataConnections8",
    databaseName: "KustoDatabase8",
    resourceGroupName: "kustorptest",
});

    resources:
  iotHubDataConnection:
    type: azure-native:kusto:IotHubDataConnection
    properties:
      clusterName: kustoclusterrptest4
      dataConnectionName: DataConnections8
      databaseName: KustoDatabase8
      resourceGroupName: kustorptest

    Create IotHubDataConnection Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IotHubDataConnection(name: string, args: IotHubDataConnectionArgs, opts?: CustomResourceOptions);
    @overload
def IotHubDataConnection(resource_name: str,
                         args: IotHubDataConnectionArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def IotHubDataConnection(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         consumer_group: Optional[str] = None,
                         shared_access_policy_name: Optional[str] = None,
                         cluster_name: Optional[str] = None,
                         database_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         iot_hub_resource_id: Optional[str] = None,
                         data_format: Optional[Union[str, IotHubDataFormat]] = None,
                         location: Optional[str] = None,
                         mapping_rule_name: Optional[str] = None,
                         event_system_properties: Optional[Sequence[str]] = None,
                         data_connection_name: Optional[str] = None,
                         table_name: Optional[str] = None)
    func NewIotHubDataConnection(ctx *Context, name string, args IotHubDataConnectionArgs, opts ...ResourceOption) (*IotHubDataConnection, error)
    public IotHubDataConnection(string name, IotHubDataConnectionArgs args, CustomResourceOptions? opts = null)
    public IotHubDataConnection(String name, IotHubDataConnectionArgs args)
public IotHubDataConnection(String name, IotHubDataConnectionArgs args, CustomResourceOptions options)

    type: azure-native:kusto:IotHubDataConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args IotHubDataConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IotHubDataConnectionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IotHubDataConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IotHubDataConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IotHubDataConnectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var iotHubDataConnectionResource = new AzureNative.Kusto.IotHubDataConnection("iotHubDataConnectionResource", new()
{
    Kind = "string",
    ConsumerGroup = "string",
    SharedAccessPolicyName = "string",
    ClusterName = "string",
    DatabaseName = "string",
    ResourceGroupName = "string",
    IotHubResourceId = "string",
    DataFormat = "string",
    Location = "string",
    MappingRuleName = "string",
    EventSystemProperties = new[]
    {
        "string",
    },
    DataConnectionName = "string",
    TableName = "string",
});

    example, err := kusto.NewIotHubDataConnection(ctx, "iotHubDataConnectionResource", &kusto.IotHubDataConnectionArgs{
	Kind:                   "string",
	ConsumerGroup:          "string",
	SharedAccessPolicyName: "string",
	ClusterName:            "string",
	DatabaseName:           "string",
	ResourceGroupName:      "string",
	IotHubResourceId:       "string",
	DataFormat:             "string",
	Location:               "string",
	MappingRuleName:        "string",
	EventSystemProperties: []string{
		"string",
	},
	DataConnectionName: "string",
	TableName:          "string",
})

    var iotHubDataConnectionResource = new IotHubDataConnection("iotHubDataConnectionResource", IotHubDataConnectionArgs.builder()
    .kind("string")
    .consumerGroup("string")
    .sharedAccessPolicyName("string")
    .clusterName("string")
    .databaseName("string")
    .resourceGroupName("string")
    .iotHubResourceId("string")
    .dataFormat("string")
    .location("string")
    .mappingRuleName("string")
    .eventSystemProperties("string")
    .dataConnectionName("string")
    .tableName("string")
    .build());

    iot_hub_data_connection_resource = azure_native.kusto.IotHubDataConnection("iotHubDataConnectionResource",
    kind=string,
    consumer_group=string,
    shared_access_policy_name=string,
    cluster_name=string,
    database_name=string,
    resource_group_name=string,
    iot_hub_resource_id=string,
    data_format=string,
    location=string,
    mapping_rule_name=string,
    event_system_properties=[string],
    data_connection_name=string,
    table_name=string)

    const iotHubDataConnectionResource = new azure_native.kusto.IotHubDataConnection("iotHubDataConnectionResource", {
    kind: "string",
    consumerGroup: "string",
    sharedAccessPolicyName: "string",
    clusterName: "string",
    databaseName: "string",
    resourceGroupName: "string",
    iotHubResourceId: "string",
    dataFormat: "string",
    location: "string",
    mappingRuleName: "string",
    eventSystemProperties: ["string"],
    dataConnectionName: "string",
    tableName: "string",
});

    type: azure-native:kusto:IotHubDataConnection
properties:
    clusterName: string
    consumerGroup: string
    dataConnectionName: string
    dataFormat: string
    databaseName: string
    eventSystemProperties:
        - string
    iotHubResourceId: string
    kind: string
    location: string
    mappingRuleName: string
    resourceGroupName: string
    sharedAccessPolicyName: string
    tableName: string

    IotHubDataConnection Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The IotHubDataConnection resource accepts the following input properties:

    ClusterName string
    The name of the Kusto cluster.
    ConsumerGroup string
    The iot hub consumer group.
    DatabaseName string
    The name of the database in the Kusto cluster.
    IotHubResourceId string
    The resource ID of the Iot hub to be used to create a data connection.
    ResourceGroupName string
    The name of the resource group containing the Kusto cluster.
    SharedAccessPolicyName string
    The name of the share access policy
    DataConnectionName string
    The name of the data connection.
    DataFormat string | Pulumi.AzureNative.Kusto.IotHubDataFormat
    The data format of the message. Optionally the data format can be added to each message.
    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.
    TableName string
    The table where the data should be ingested. Optionally the table information can be added to each message.
    ClusterName string
    The name of the Kusto cluster.
    ConsumerGroup string
    The iot hub consumer group.
    DatabaseName string
    The name of the database in the Kusto cluster.
    IotHubResourceId string
    The resource ID of the Iot hub to be used to create a data connection.
    ResourceGroupName string
    The name of the resource group containing the Kusto cluster.
    SharedAccessPolicyName string
    The name of the share access policy
    DataConnectionName string
    The name of the data connection.
    DataFormat string | IotHubDataFormat
    The data format of the message. Optionally the data format can be added to each message.
    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.
    TableName string
    The table where the data should be ingested. Optionally the table information can be added to each message.
    clusterName String
    The name of the Kusto cluster.
    consumerGroup String
    The iot hub consumer group.
    databaseName String
    The name of the database in the Kusto cluster.
    iotHubResourceId String
    The resource ID of the Iot hub to be used to create a data connection.
    resourceGroupName String
    The name of the resource group containing the Kusto cluster.
    sharedAccessPolicyName String
    The name of the share access policy
    dataConnectionName String
    The name of the data connection.
    dataFormat String | IotHubDataFormat
    The data format of the message. Optionally the data format can be added to each message.
    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.
    tableName String
    The table where the data should be ingested. Optionally the table information can be added to each message.
    clusterName string
    The name of the Kusto cluster.
    consumerGroup string
    The iot hub consumer group.
    databaseName string
    The name of the database in the Kusto cluster.
    iotHubResourceId string
    The resource ID of the Iot hub to be used to create a data connection.
    resourceGroupName string
    The name of the resource group containing the Kusto cluster.
    sharedAccessPolicyName string
    The name of the share access policy
    dataConnectionName string
    The name of the data connection.
    dataFormat string | IotHubDataFormat
    The data format of the message. Optionally the data format can be added to each message.
    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.
    tableName string
    The table where the data should be ingested. Optionally the table information can be added to each message.
    cluster_name str
    The name of the Kusto cluster.
    consumer_group str
    The iot hub consumer group.
    database_name str
    The name of the database in the Kusto cluster.
    iot_hub_resource_id str
    The resource ID of the Iot hub to be used to create a data connection.
    resource_group_name str
    The name of the resource group containing the Kusto cluster.
    shared_access_policy_name str
    The name of the share access policy
    data_connection_name str
    The name of the data connection.
    data_format str | IotHubDataFormat
    The data format of the message. Optionally the data format can be added to each message.
    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.
    table_name str
    The table where the data should be ingested. Optionally the table information can be added to each message.
    clusterName String
    The name of the Kusto cluster.
    consumerGroup String
    The iot hub consumer group.
    databaseName String
    The name of the database in the Kusto cluster.
    iotHubResourceId String
    The resource ID of the Iot hub to be used to create a data connection.
    resourceGroupName String
    The name of the resource group containing the Kusto cluster.
    sharedAccessPolicyName String
    The name of the share access policy
    dataConnectionName String
    The name of the data connection.
    dataFormat String | "MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE" | "PARQUET" | "ORC" | "APACHEAVRO" | "W3CLOGFILE"
    The data format of the message. Optionally the data format can be added to each message.
    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.
    tableName String
    The table where the data should be ingested. Optionally the table information can be added to each message.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IotHubDataConnection resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioned state of the resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioned state of the resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The provisioned state of the resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    provisioningState string
    The provisioned state of the resource.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    provisioning_state str
    The provisioned state of the resource.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The provisioned state of the resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    IotHubDataFormat, IotHubDataFormatArgs

    MULTIJSON
    MULTIJSON
    JSON
    JSON
    CSV
    CSV
    TSV
    TSV
    SCSV
    SCSV
    SOHSV
    SOHSV
    PSV
    PSV
    TXT
    TXT
    RAW
    RAW
    SINGLEJSON
    SINGLEJSON
    AVRO
    AVRO
    TSVE
    TSVE
    PARQUET
    PARQUET
    ORC
    ORC
    APACHEAVRO
    APACHEAVRO
    W3CLOGFILE
    W3CLOGFILE
    IotHubDataFormatMULTIJSON
    MULTIJSON
    IotHubDataFormatJSON
    JSON
    IotHubDataFormatCSV
    CSV
    IotHubDataFormatTSV
    TSV
    IotHubDataFormatSCSV
    SCSV
    IotHubDataFormatSOHSV
    SOHSV
    IotHubDataFormatPSV
    PSV
    IotHubDataFormatTXT
    TXT
    IotHubDataFormatRAW
    RAW
    IotHubDataFormatSINGLEJSON
    SINGLEJSON
    IotHubDataFormatAVRO
    AVRO
    IotHubDataFormatTSVE
    TSVE
    IotHubDataFormatPARQUET
    PARQUET
    IotHubDataFormatORC
    ORC
    IotHubDataFormatAPACHEAVRO
    APACHEAVRO
    IotHubDataFormatW3CLOGFILE
    W3CLOGFILE
    MULTIJSON
    MULTIJSON
    JSON
    JSON
    CSV
    CSV
    TSV
    TSV
    SCSV
    SCSV
    SOHSV
    SOHSV
    PSV
    PSV
    TXT
    TXT
    RAW
    RAW
    SINGLEJSON
    SINGLEJSON
    AVRO
    AVRO
    TSVE
    TSVE
    PARQUET
    PARQUET
    ORC
    ORC
    APACHEAVRO
    APACHEAVRO
    W3CLOGFILE
    W3CLOGFILE
    MULTIJSON
    MULTIJSON
    JSON
    JSON
    CSV
    CSV
    TSV
    TSV
    SCSV
    SCSV
    SOHSV
    SOHSV
    PSV
    PSV
    TXT
    TXT
    RAW
    RAW
    SINGLEJSON
    SINGLEJSON
    AVRO
    AVRO
    TSVE
    TSVE
    PARQUET
    PARQUET
    ORC
    ORC
    APACHEAVRO
    APACHEAVRO
    W3CLOGFILE
    W3CLOGFILE
    MULTIJSON
    MULTIJSON
    JSON
    JSON
    CSV
    CSV
    TSV
    TSV
    SCSV
    SCSV
    SOHSV
    SOHSV
    PSV
    PSV
    TXT
    TXT
    RAW
    RAW
    SINGLEJSON
    SINGLEJSON
    AVRO
    AVRO
    TSVE
    TSVE
    PARQUET
    PARQUET
    ORC
    ORC
    APACHEAVRO
    APACHEAVRO
    W3_CLOGFILE
    W3CLOGFILE
    "MULTIJSON"
    MULTIJSON
    "JSON"
    JSON
    "CSV"
    CSV
    "TSV"
    TSV
    "SCSV"
    SCSV
    "SOHSV"
    SOHSV
    "PSV"
    PSV
    "TXT"
    TXT
    "RAW"
    RAW
    "SINGLEJSON"
    SINGLEJSON
    "AVRO"
    AVRO
    "TSVE"
    TSVE
    "PARQUET"
    PARQUET
    "ORC"
    ORC
    "APACHEAVRO"
    APACHEAVRO
    "W3CLOGFILE"
    W3CLOGFILE

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:kusto:IotHubDataConnection KustoClusterRPTest4/KustoDatabase8/DataConnections8 /subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native