azure-native.synapse.IotHubDataConnection
Explore with Pulumi AI
Class representing an iot hub data connection. Azure REST API version: 2021-06-01-preview.
Example Usage
KustoPoolDataConnectionsCreateOrUpdate.json
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var iotHubDataConnection = new AzureNative.Synapse.IotHubDataConnection("iotHubDataConnection", new()
    {
        DataConnectionName = "DataConnections8",
        DatabaseName = "KustoDatabase8",
        KustoPoolName = "kustoclusterrptest4",
        ResourceGroupName = "kustorptest",
        WorkspaceName = "synapseWorkspaceName",
    });
});
package main
import (
	synapse "github.com/pulumi/pulumi-azure-native-sdk/synapse/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := synapse.NewIotHubDataConnection(ctx, "iotHubDataConnection", &synapse.IotHubDataConnectionArgs{
			DataConnectionName: pulumi.String("DataConnections8"),
			DatabaseName:       pulumi.String("KustoDatabase8"),
			KustoPoolName:      pulumi.String("kustoclusterrptest4"),
			ResourceGroupName:  pulumi.String("kustorptest"),
			WorkspaceName:      pulumi.String("synapseWorkspaceName"),
		})
		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.synapse.IotHubDataConnection;
import com.pulumi.azurenative.synapse.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()
            .dataConnectionName("DataConnections8")
            .databaseName("KustoDatabase8")
            .kustoPoolName("kustoclusterrptest4")
            .resourceGroupName("kustorptest")
            .workspaceName("synapseWorkspaceName")
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const iotHubDataConnection = new azure_native.synapse.IotHubDataConnection("iotHubDataConnection", {
    dataConnectionName: "DataConnections8",
    databaseName: "KustoDatabase8",
    kustoPoolName: "kustoclusterrptest4",
    resourceGroupName: "kustorptest",
    workspaceName: "synapseWorkspaceName",
});
import pulumi
import pulumi_azure_native as azure_native
iot_hub_data_connection = azure_native.synapse.IotHubDataConnection("iotHubDataConnection",
    data_connection_name="DataConnections8",
    database_name="KustoDatabase8",
    kusto_pool_name="kustoclusterrptest4",
    resource_group_name="kustorptest",
    workspace_name="synapseWorkspaceName")
resources:
  iotHubDataConnection:
    type: azure-native:synapse:IotHubDataConnection
    properties:
      dataConnectionName: DataConnections8
      databaseName: KustoDatabase8
      kustoPoolName: kustoclusterrptest4
      resourceGroupName: kustorptest
      workspaceName: synapseWorkspaceName
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,
                         resource_group_name: Optional[str] = None,
                         workspace_name: Optional[str] = None,
                         database_name: Optional[str] = None,
                         kusto_pool_name: Optional[str] = None,
                         iot_hub_resource_id: Optional[str] = None,
                         shared_access_policy_name: Optional[str] = None,
                         consumer_group: Optional[str] = None,
                         event_system_properties: Optional[Sequence[str]] = None,
                         mapping_rule_name: Optional[str] = None,
                         location: Optional[str] = None,
                         data_connection_name: Optional[str] = None,
                         table_name: Optional[str] = None,
                         data_format: Optional[Union[str, IotHubDataFormat]] = 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:synapse: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 azure_nativeIotHubDataConnectionResource = new AzureNative.Synapse.IotHubDataConnection("azure-nativeIotHubDataConnectionResource", new()
{
    Kind = "string",
    ResourceGroupName = "string",
    WorkspaceName = "string",
    DatabaseName = "string",
    KustoPoolName = "string",
    IotHubResourceId = "string",
    SharedAccessPolicyName = "string",
    ConsumerGroup = "string",
    EventSystemProperties = new[]
    {
        "string",
    },
    MappingRuleName = "string",
    Location = "string",
    DataConnectionName = "string",
    TableName = "string",
    DataFormat = "string",
});
example, err := synapse.NewIotHubDataConnection(ctx, "azure-nativeIotHubDataConnectionResource", &synapse.IotHubDataConnectionArgs{
	Kind:                   pulumi.String("string"),
	ResourceGroupName:      pulumi.String("string"),
	WorkspaceName:          pulumi.String("string"),
	DatabaseName:           pulumi.String("string"),
	KustoPoolName:          pulumi.String("string"),
	IotHubResourceId:       pulumi.String("string"),
	SharedAccessPolicyName: pulumi.String("string"),
	ConsumerGroup:          pulumi.String("string"),
	EventSystemProperties: pulumi.StringArray{
		pulumi.String("string"),
	},
	MappingRuleName:    pulumi.String("string"),
	Location:           pulumi.String("string"),
	DataConnectionName: pulumi.String("string"),
	TableName:          pulumi.String("string"),
	DataFormat:         pulumi.String("string"),
})
var azure_nativeIotHubDataConnectionResource = new IotHubDataConnection("azure-nativeIotHubDataConnectionResource", IotHubDataConnectionArgs.builder()
    .kind("string")
    .resourceGroupName("string")
    .workspaceName("string")
    .databaseName("string")
    .kustoPoolName("string")
    .iotHubResourceId("string")
    .sharedAccessPolicyName("string")
    .consumerGroup("string")
    .eventSystemProperties("string")
    .mappingRuleName("string")
    .location("string")
    .dataConnectionName("string")
    .tableName("string")
    .dataFormat("string")
    .build());
azure_native_iot_hub_data_connection_resource = azure_native.synapse.IotHubDataConnection("azure-nativeIotHubDataConnectionResource",
    kind="string",
    resource_group_name="string",
    workspace_name="string",
    database_name="string",
    kusto_pool_name="string",
    iot_hub_resource_id="string",
    shared_access_policy_name="string",
    consumer_group="string",
    event_system_properties=["string"],
    mapping_rule_name="string",
    location="string",
    data_connection_name="string",
    table_name="string",
    data_format="string")
const azure_nativeIotHubDataConnectionResource = new azure_native.synapse.IotHubDataConnection("azure-nativeIotHubDataConnectionResource", {
    kind: "string",
    resourceGroupName: "string",
    workspaceName: "string",
    databaseName: "string",
    kustoPoolName: "string",
    iotHubResourceId: "string",
    sharedAccessPolicyName: "string",
    consumerGroup: "string",
    eventSystemProperties: ["string"],
    mappingRuleName: "string",
    location: "string",
    dataConnectionName: "string",
    tableName: "string",
    dataFormat: "string",
});
type: azure-native:synapse:IotHubDataConnection
properties:
    consumerGroup: string
    dataConnectionName: string
    dataFormat: string
    databaseName: string
    eventSystemProperties:
        - string
    iotHubResourceId: string
    kind: string
    kustoPoolName: string
    location: string
    mappingRuleName: string
    resourceGroupName: string
    sharedAccessPolicyName: string
    tableName: string
    workspaceName: 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:
- ConsumerGroup string
- The iot hub consumer group.
- DatabaseName string
- The name of the database in the Kusto pool.
- IotHub stringResource Id 
- The resource ID of the Iot hub to be used to create a data connection.
- KustoPool stringName 
- The name of the Kusto pool.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- string
- The name of the share access policy
- WorkspaceName string
- The name of the workspace.
- DataConnection stringName 
- The name of the data connection.
- DataFormat string | Pulumi.Azure Native. Synapse. Iot Hub Data Format 
- The data format of the message. Optionally the data format can be added to each message.
- EventSystem List<string>Properties 
- System properties of the iot hub
- Location string
- Resource location.
- MappingRule stringName 
- 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.
- ConsumerGroup string
- The iot hub consumer group.
- DatabaseName string
- The name of the database in the Kusto pool.
- IotHub stringResource Id 
- The resource ID of the Iot hub to be used to create a data connection.
- KustoPool stringName 
- The name of the Kusto pool.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- string
- The name of the share access policy
- WorkspaceName string
- The name of the workspace.
- DataConnection stringName 
- The name of the data connection.
- DataFormat string | IotHub Data Format 
- The data format of the message. Optionally the data format can be added to each message.
- EventSystem []stringProperties 
- System properties of the iot hub
- Location string
- Resource location.
- MappingRule stringName 
- 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.
- consumerGroup String
- The iot hub consumer group.
- databaseName String
- The name of the database in the Kusto pool.
- iotHub StringResource Id 
- The resource ID of the Iot hub to be used to create a data connection.
- kustoPool StringName 
- The name of the Kusto pool.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- String
- The name of the share access policy
- workspaceName String
- The name of the workspace.
- dataConnection StringName 
- The name of the data connection.
- dataFormat String | IotHub Data Format 
- The data format of the message. Optionally the data format can be added to each message.
- eventSystem List<String>Properties 
- System properties of the iot hub
- location String
- Resource location.
- mappingRule StringName 
- 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.
- consumerGroup string
- The iot hub consumer group.
- databaseName string
- The name of the database in the Kusto pool.
- iotHub stringResource Id 
- The resource ID of the Iot hub to be used to create a data connection.
- kustoPool stringName 
- The name of the Kusto pool.
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- string
- The name of the share access policy
- workspaceName string
- The name of the workspace.
- dataConnection stringName 
- The name of the data connection.
- dataFormat string | IotHub Data Format 
- The data format of the message. Optionally the data format can be added to each message.
- eventSystem string[]Properties 
- System properties of the iot hub
- location string
- Resource location.
- mappingRule stringName 
- 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.
- consumer_group str
- The iot hub consumer group.
- database_name str
- The name of the database in the Kusto pool.
- iot_hub_ strresource_ id 
- The resource ID of the Iot hub to be used to create a data connection.
- kusto_pool_ strname 
- The name of the Kusto pool.
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- str
- The name of the share access policy
- workspace_name str
- The name of the workspace.
- data_connection_ strname 
- The name of the data connection.
- data_format str | IotHub Data Format 
- The data format of the message. Optionally the data format can be added to each message.
- event_system_ Sequence[str]properties 
- System properties of the iot hub
- location str
- Resource location.
- mapping_rule_ strname 
- 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.
- consumerGroup String
- The iot hub consumer group.
- databaseName String
- The name of the database in the Kusto pool.
- iotHub StringResource Id 
- The resource ID of the Iot hub to be used to create a data connection.
- kustoPool StringName 
- The name of the Kusto pool.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- String
- The name of the share access policy
- workspaceName String
- The name of the workspace.
- dataConnection StringName 
- 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.
- eventSystem List<String>Properties 
- System properties of the iot hub
- location String
- Resource location.
- mappingRule StringName 
- 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.
- SystemData Pulumi.Azure Native. Synapse. Outputs. System Data Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- 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.
- SystemData SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- 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.
- systemData SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- 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.
- systemData SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- 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.
- system_data SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- 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.
- systemData Property Map
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- 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
- IotHub Data Format MULTIJSON 
- MULTIJSON
- IotHub Data Format JSON 
- JSON
- IotHub Data Format CSV 
- CSV
- IotHub Data Format TSV 
- TSV
- IotHub Data Format SCSV 
- SCSV
- IotHub Data Format SOHSV 
- SOHSV
- IotHub Data Format PSV 
- PSV
- IotHub Data Format TXT 
- TXT
- IotHub Data Format RAW 
- RAW
- IotHub Data Format SINGLEJSON 
- SINGLEJSON
- IotHub Data Format AVRO 
- AVRO
- IotHub Data Format TSVE 
- TSVE
- IotHub Data Format PARQUET 
- PARQUET
- IotHub Data Format ORC 
- ORC
- IotHub Data Format APACHEAVRO 
- APACHEAVRO
- IotHub Data Format 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
- 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
SystemDataResponse, SystemDataResponseArgs      
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
- createdAt string
- The timestamp of resource creation (UTC).
- createdBy string
- The identity that created the resource.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- The type of identity that last modified the resource.
- created_at str
- The timestamp of resource creation (UTC).
- created_by str
- The identity that created the resource.
- created_by_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- The type of identity that last modified the resource.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:synapse:IotHubDataConnection KustoClusterRPTest4/KustoDatabase8/DataConnections8 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/databases/{databaseName}/dataConnections/{dataConnectionName} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0