Azure Native v2.20.0, Nov 29 23

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.20.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.synapse.IotHubDataConnection

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.20.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-azure-native

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 (
	"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 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")

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",
});

resources:
  iotHubDataConnection:
    type: azure-native:synapse:IotHubDataConnection
    properties:
      dataConnectionName: DataConnections8
      databaseName: KustoDatabase8
      kustoPoolName: kustoclusterrptest4
      resourceGroupName: kustorptest
      workspaceName: synapseWorkspaceName

Create IotHubDataConnection Resource

new IotHubDataConnection(name: string, args: IotHubDataConnectionArgs, opts?: CustomResourceOptions);

@overload
def IotHubDataConnection(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         consumer_group: Optional[str] = None,
                         data_connection_name: Optional[str] = None,
                         data_format: Optional[Union[str, IotHubDataFormat]] = None,
                         database_name: Optional[str] = None,
                         event_system_properties: Optional[Sequence[str]] = None,
                         iot_hub_resource_id: Optional[str] = None,
                         kusto_pool_name: Optional[str] = None,
                         location: Optional[str] = None,
                         mapping_rule_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         shared_access_policy_name: Optional[str] = None,
                         table_name: Optional[str] = None,
                         workspace_name: Optional[str] = None)
@overload
def IotHubDataConnection(resource_name: str,
                         args: IotHubDataConnectionArgs,
                         opts: Optional[ResourceOptions] = 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.

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.

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

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.
IotHubResourceId string: The resource ID of the Iot hub to be used to create a data connection.
KustoPoolName string: The name of the Kusto pool.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
SharedAccessPolicyName string: The name of the share access policy
WorkspaceName string: The name of the workspace.
DataConnectionName string: The name of the data connection.
DataFormat string | Pulumi.AzureNative.Synapse.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.

ConsumerGroup string: The iot hub consumer group.
DatabaseName string: The name of the database in the Kusto pool.
IotHubResourceId string: The resource ID of the Iot hub to be used to create a data connection.
KustoPoolName string: The name of the Kusto pool.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
SharedAccessPolicyName string: The name of the share access policy
WorkspaceName string: The name of the workspace.
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.

consumerGroup String: The iot hub consumer group.
databaseName String: The name of the database in the Kusto pool.
iotHubResourceId String: The resource ID of the Iot hub to be used to create a data connection.
kustoPoolName String: The name of the Kusto pool.
resourceGroupName String: The name of the resource group. The name is case insensitive.
sharedAccessPolicyName String: The name of the share access policy
workspaceName String: The name of the workspace.
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.

consumerGroup string: The iot hub consumer group.
databaseName string: The name of the database in the Kusto pool.
iotHubResourceId string: The resource ID of the Iot hub to be used to create a data connection.
kustoPoolName string: The name of the Kusto pool.
resourceGroupName string: The name of the resource group. The name is case insensitive.
sharedAccessPolicyName string: The name of the share access policy
workspaceName string: The name of the workspace.
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.

consumer_group str: The iot hub consumer group.
database_name str: The name of the database in the Kusto pool.
iot_hub_resource_id str: The resource ID of the Iot hub to be used to create a data connection.
kusto_pool_name str: The name of the Kusto pool.
resource_group_name str: The name of the resource group. The name is case insensitive.
shared_access_policy_name str: The name of the share access policy
workspace_name str: The name of the workspace.
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.

consumerGroup String: The iot hub consumer group.
databaseName String: The name of the database in the Kusto pool.
iotHubResourceId String: The resource ID of the Iot hub to be used to create a data connection.
kustoPoolName String: The name of the Kusto pool.
resourceGroupName String: The name of the resource group. The name is case insensitive.
sharedAccessPolicyName String: The name of the share access policy
workspaceName String: The name of the workspace.
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.
SystemData Pulumi.AzureNative.Synapse.Outputs.SystemDataResponse: 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 SystemDataResponse: 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 SystemDataResponse: 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 SystemDataResponse: 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 SystemDataResponse: 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

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

SystemDataResponse, SystemDataResponseArgs

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: 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.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: 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.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: 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.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: 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_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: 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.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: 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}

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.20.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.synapse.IotHubDataConnection

On this page

On this page

Example Usage

KustoPoolDataConnectionsCreateOrUpdate.json

Create IotHubDataConnection Resource

IotHubDataConnection Resource Properties

Inputs

Outputs

Supporting Types

IotHubDataFormat, IotHubDataFormatArgs

SystemDataResponse, SystemDataResponseArgs

Import

Package Details

On this page

On this page