@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 5.92 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Class representing an event hub data connection.
*
* Uses Azure REST API version 2021-06-01-preview. In version 2.x of the Azure Native provider, it used API version 2021-06-01-preview.
*/
export declare class EventHubDataConnection extends pulumi.CustomResource {
/**
* Get an existing EventHubDataConnection 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): EventHubDataConnection;
/**
* Returns true if the given object is an instance of EventHubDataConnection. 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 EventHubDataConnection;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The event hub messages compression type
*/
readonly compression: pulumi.Output<string | undefined>;
/**
* The event hub consumer group.
*/
readonly consumerGroup: pulumi.Output<string>;
/**
* The data format of the message. Optionally the data format can be added to each message.
*/
readonly dataFormat: pulumi.Output<string | undefined>;
/**
* The resource ID of the event hub to be used to create a data connection.
*/
readonly eventHubResourceId: pulumi.Output<string>;
/**
* System properties of the event hub
*/
readonly eventSystemProperties: pulumi.Output<string[] | undefined>;
/**
* Kind of the endpoint for the data connection
* Expected value is 'EventHub'.
*/
readonly kind: pulumi.Output<"EventHub">;
/**
* Resource location.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub.
*/
readonly managedIdentityResourceId: pulumi.Output<string | undefined>;
/**
* The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
*/
readonly mappingRuleName: pulumi.Output<string | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* The provisioned state of the resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.synapse.SystemDataResponse>;
/**
* The table where the data should be ingested. Optionally the table information can be added to each message.
*/
readonly tableName: pulumi.Output<string | undefined>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Create a EventHubDataConnection 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: EventHubDataConnectionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a EventHubDataConnection resource.
*/
export interface EventHubDataConnectionArgs {
/**
* The event hub messages compression type
*/
compression?: pulumi.Input<string | enums.synapse.Compression>;
/**
* The event hub consumer group.
*/
consumerGroup: pulumi.Input<string>;
/**
* The name of the data connection.
*/
dataConnectionName?: pulumi.Input<string>;
/**
* The data format of the message. Optionally the data format can be added to each message.
*/
dataFormat?: pulumi.Input<string | enums.synapse.EventHubDataFormat>;
/**
* The name of the database in the Kusto pool.
*/
databaseName: pulumi.Input<string>;
/**
* The resource ID of the event hub to be used to create a data connection.
*/
eventHubResourceId: pulumi.Input<string>;
/**
* System properties of the event hub
*/
eventSystemProperties?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Kind of the endpoint for the data connection
* Expected value is 'EventHub'.
*/
kind: pulumi.Input<"EventHub">;
/**
* The name of the Kusto pool.
*/
kustoPoolName: pulumi.Input<string>;
/**
* Resource location.
*/
location?: pulumi.Input<string>;
/**
* The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub.
*/
managedIdentityResourceId?: pulumi.Input<string>;
/**
* The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
*/
mappingRuleName?: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The table where the data should be ingested. Optionally the table information can be added to each message.
*/
tableName?: pulumi.Input<string>;
/**
* The name of the workspace.
*/
workspaceName: pulumi.Input<string>;
}