@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 3.74 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Returns a data connection.
*
* Uses Azure REST API version 2021-06-01-preview.
*/
export declare function getIotHubDataConnection(args: GetIotHubDataConnectionArgs, opts?: pulumi.InvokeOptions): Promise<GetIotHubDataConnectionResult>;
export interface GetIotHubDataConnectionArgs {
/**
* The name of the data connection.
*/
dataConnectionName: string;
/**
* The name of the database in the Kusto pool.
*/
databaseName: string;
/**
* The name of the Kusto pool.
*/
kustoPoolName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
/**
* The name of the workspace.
*/
workspaceName: string;
}
/**
* Class representing an iot hub data connection.
*/
export interface GetIotHubDataConnectionResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The iot hub consumer group.
*/
readonly consumerGroup: string;
/**
* The data format of the message. Optionally the data format can be added to each message.
*/
readonly dataFormat?: string;
/**
* System properties of the iot hub
*/
readonly eventSystemProperties?: string[];
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* The resource ID of the Iot hub to be used to create a data connection.
*/
readonly iotHubResourceId: string;
/**
* Kind of the endpoint for the data connection
* Expected value is 'IotHub'.
*/
readonly kind: "IotHub";
/**
* Resource location.
*/
readonly location?: string;
/**
* The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
*/
readonly mappingRuleName?: string;
/**
* The name of the resource
*/
readonly name: string;
/**
* The provisioned state of the resource.
*/
readonly provisioningState: string;
/**
* The name of the share access policy
*/
readonly sharedAccessPolicyName: string;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.synapse.SystemDataResponse;
/**
* The table where the data should be ingested. Optionally the table information can be added to each message.
*/
readonly tableName?: string;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
}
/**
* Returns a data connection.
*
* Uses Azure REST API version 2021-06-01-preview.
*/
export declare function getIotHubDataConnectionOutput(args: GetIotHubDataConnectionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetIotHubDataConnectionResult>;
export interface GetIotHubDataConnectionOutputArgs {
/**
* The name of the data connection.
*/
dataConnectionName: pulumi.Input<string>;
/**
* The name of the database in the Kusto pool.
*/
databaseName: pulumi.Input<string>;
/**
* The name of the Kusto pool.
*/
kustoPoolName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the workspace.
*/
workspaceName: pulumi.Input<string>;
}