import * as pulumi from "@pulumi/pulumi"; /** * Manages a Kusto (also known as Azure Data Explorer) IotHub Data Connection * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const example = new azure.core.ResourceGroup("example", { * name: "example-resources", * location: "West Europe", * }); * const exampleCluster = new azure.kusto.Cluster("example", { * name: "examplekustocluster", * location: example.location, * resourceGroupName: example.name, * sku: { * name: "Standard_D13_v2", * capacity: 2, * }, * }); * const exampleDatabase = new azure.kusto.Database("example", { * name: "example-kusto-database", * resourceGroupName: example.name, * location: example.location, * clusterName: exampleCluster.name, * hotCachePeriod: "P7D", * softDeletePeriod: "P31D", * }); * const exampleIoTHub = new azure.iot.IoTHub("example", { * name: "exampleIoTHub", * resourceGroupName: example.name, * location: example.location, * sku: { * name: "B1", * capacity: 1, * }, * }); * const exampleSharedAccessPolicy = new azure.iot.SharedAccessPolicy("example", { * name: "example-shared-access-policy", * resourceGroupName: example.name, * iothubName: exampleIoTHub.name, * registryRead: true, * }); * const exampleConsumerGroup = new azure.iot.ConsumerGroup("example", { * name: "example-consumer-group", * resourceGroupName: example.name, * iothubName: exampleIoTHub.name, * eventhubEndpointName: "events", * }); * const exampleIotHubDataConnection = new azure.kusto.IotHubDataConnection("example", { * name: "my-kusto-iothub-data-connection", * resourceGroupName: example.name, * location: example.location, * clusterName: exampleCluster.name, * databaseName: exampleDatabase.name, * iothubId: exampleIoTHub.id, * consumerGroup: exampleConsumerGroup.name, * sharedAccessPolicyName: exampleSharedAccessPolicy.name, * eventSystemProperties: [ * "message-id", * "sequence-number", * "to", * ], * tableName: "my-table", * mappingRuleName: "my-table-mapping", * dataFormat: "JSON", * retrievalStartDate: "2023-06-26T12:00:00Z", * }); * ``` * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Microsoft.Kusto` - 2024-04-13 * * ## Import * * Kusto IotHub Data Connections can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:kusto/iotHubDataConnection:IotHubDataConnection example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Kusto/clusters/cluster1/databases/database1/dataConnections/dataConnection1 * ``` */ export declare class IotHubDataConnection extends pulumi.CustomResource { /** * Get an existing IotHubDataConnection resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: IotHubDataConnectionState, opts?: pulumi.CustomResourceOptions): IotHubDataConnection; /** * Returns true if the given object is an instance of IotHubDataConnection. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is IotHubDataConnection; /** * Specifies the name of the Kusto Cluster this data connection will be added to. Changing this forces a new resource to be created. */ readonly clusterName: pulumi.Output; /** * Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created. */ readonly consumerGroup: pulumi.Output; /** * Specifies the data format of the IoTHub messages. Allowed values: `APACHEAVRO`, `AVRO`, `CSV`, `JSON`, `MULTIJSON`, `ORC`, `PARQUET`, `PSV`, `RAW`, `SCSV`, `SINGLEJSON`, `SOHSV`, `TSV`, `TSVE`, `TXT` and `W3CLOGFILE`. Changing this forces a new resource to be created. */ readonly dataFormat: pulumi.Output; /** * Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created. */ readonly databaseName: pulumi.Output; /** * Indication for database routing information from the data connection, by default only database routing information is allowed. Allowed values: `Single`, `Multi`. Changing this forces a new resource to be created. Defaults to `Single`. */ readonly databaseRoutingType: pulumi.Output; /** * Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created. */ readonly eventSystemProperties: pulumi.Output; /** * Specifies the resource id of the IotHub this data connection will use for ingestion. Changing this forces a new resource to be created. */ readonly iothubId: pulumi.Output; /** * The location where the Kusto Database should be created. Changing this forces a new resource to be created. */ readonly location: pulumi.Output; /** * Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created. Changing this forces a new resource to be created. */ readonly mappingRuleName: pulumi.Output; /** * The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created. */ readonly name: pulumi.Output; /** * Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created. */ readonly resourceGroupName: pulumi.Output; /** * Specifies the date after which data should be retrieved from IoT Hub. When defined, the data connection retrieves existing events created since the specified retrieval start date. It can only retrieve events retained by the IoT Hub, based on its retention period. The value should be in RFC3339 format (e.g., `2023-06-26T12:00:00Z`). */ readonly retrievalStartDate: pulumi.Output; /** * Specifies the IotHub Shared Access Policy this data connection will use for ingestion, which must have read permission. Changing this forces a new resource to be created. */ readonly sharedAccessPolicyName: pulumi.Output; /** * Specifies the target table name used for the message ingestion. Table must exist before resource is created. Changing this forces a new resource to be created. */ readonly tableName: pulumi.Output; /** * Create a IotHubDataConnection resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: IotHubDataConnectionArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering IotHubDataConnection resources. */ export interface IotHubDataConnectionState { /** * Specifies the name of the Kusto Cluster this data connection will be added to. Changing this forces a new resource to be created. */ clusterName?: pulumi.Input; /** * Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created. */ consumerGroup?: pulumi.Input; /** * Specifies the data format of the IoTHub messages. Allowed values: `APACHEAVRO`, `AVRO`, `CSV`, `JSON`, `MULTIJSON`, `ORC`, `PARQUET`, `PSV`, `RAW`, `SCSV`, `SINGLEJSON`, `SOHSV`, `TSV`, `TSVE`, `TXT` and `W3CLOGFILE`. Changing this forces a new resource to be created. */ dataFormat?: pulumi.Input; /** * Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created. */ databaseName?: pulumi.Input; /** * Indication for database routing information from the data connection, by default only database routing information is allowed. Allowed values: `Single`, `Multi`. Changing this forces a new resource to be created. Defaults to `Single`. */ databaseRoutingType?: pulumi.Input; /** * Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created. */ eventSystemProperties?: pulumi.Input[]>; /** * Specifies the resource id of the IotHub this data connection will use for ingestion. Changing this forces a new resource to be created. */ iothubId?: pulumi.Input; /** * The location where the Kusto Database should be created. Changing this forces a new resource to be created. */ location?: pulumi.Input; /** * Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created. Changing this forces a new resource to be created. */ mappingRuleName?: pulumi.Input; /** * The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created. */ resourceGroupName?: pulumi.Input; /** * Specifies the date after which data should be retrieved from IoT Hub. When defined, the data connection retrieves existing events created since the specified retrieval start date. It can only retrieve events retained by the IoT Hub, based on its retention period. The value should be in RFC3339 format (e.g., `2023-06-26T12:00:00Z`). */ retrievalStartDate?: pulumi.Input; /** * Specifies the IotHub Shared Access Policy this data connection will use for ingestion, which must have read permission. Changing this forces a new resource to be created. */ sharedAccessPolicyName?: pulumi.Input; /** * Specifies the target table name used for the message ingestion. Table must exist before resource is created. Changing this forces a new resource to be created. */ tableName?: pulumi.Input; } /** * The set of arguments for constructing a IotHubDataConnection resource. */ export interface IotHubDataConnectionArgs { /** * Specifies the name of the Kusto Cluster this data connection will be added to. Changing this forces a new resource to be created. */ clusterName: pulumi.Input; /** * Specifies the IotHub consumer group this data connection will use for ingestion. Changing this forces a new resource to be created. */ consumerGroup: pulumi.Input; /** * Specifies the data format of the IoTHub messages. Allowed values: `APACHEAVRO`, `AVRO`, `CSV`, `JSON`, `MULTIJSON`, `ORC`, `PARQUET`, `PSV`, `RAW`, `SCSV`, `SINGLEJSON`, `SOHSV`, `TSV`, `TSVE`, `TXT` and `W3CLOGFILE`. Changing this forces a new resource to be created. */ dataFormat?: pulumi.Input; /** * Specifies the name of the Kusto Database this data connection will be added to. Changing this forces a new resource to be created. */ databaseName: pulumi.Input; /** * Indication for database routing information from the data connection, by default only database routing information is allowed. Allowed values: `Single`, `Multi`. Changing this forces a new resource to be created. Defaults to `Single`. */ databaseRoutingType?: pulumi.Input; /** * Specifies the System Properties that each IoT Hub message should contain. Changing this forces a new resource to be created. */ eventSystemProperties?: pulumi.Input[]>; /** * Specifies the resource id of the IotHub this data connection will use for ingestion. Changing this forces a new resource to be created. */ iothubId: pulumi.Input; /** * The location where the Kusto Database should be created. Changing this forces a new resource to be created. */ location?: pulumi.Input; /** * Specifies the mapping rule used for the message ingestion. Mapping rule must exist before resource is created. Changing this forces a new resource to be created. */ mappingRuleName?: pulumi.Input; /** * The name of the Kusto IotHub Data Connection to create. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * Specifies the Resource Group where the Kusto Database should exist. Changing this forces a new resource to be created. */ resourceGroupName: pulumi.Input; /** * Specifies the date after which data should be retrieved from IoT Hub. When defined, the data connection retrieves existing events created since the specified retrieval start date. It can only retrieve events retained by the IoT Hub, based on its retention period. The value should be in RFC3339 format (e.g., `2023-06-26T12:00:00Z`). */ retrievalStartDate?: pulumi.Input; /** * Specifies the IotHub Shared Access Policy this data connection will use for ingestion, which must have read permission. Changing this forces a new resource to be created. */ sharedAccessPolicyName: pulumi.Input; /** * Specifies the target table name used for the message ingestion. Table must exist before resource is created. Changing this forces a new resource to be created. */ tableName?: pulumi.Input; }