Azure Native

Pulumi Official
Package maintained by Pulumi
v1.67.0 published on Tuesday, Jul 12, 2022 by Pulumi

getIotHubDataConnection

Class representing an iot hub data connection. API Version: 2021-04-01-preview.

Using getIotHubDataConnection

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getIotHubDataConnection(args: GetIotHubDataConnectionArgs, opts?: InvokeOptions): Promise<GetIotHubDataConnectionResult>
function getIotHubDataConnectionOutput(args: GetIotHubDataConnectionOutputArgs, opts?: InvokeOptions): Output<GetIotHubDataConnectionResult>
def get_iot_hub_data_connection(data_connection_name: Optional[str] = None,
                                database_name: Optional[str] = None,
                                kusto_pool_name: Optional[str] = None,
                                resource_group_name: Optional[str] = None,
                                workspace_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetIotHubDataConnectionResult
def get_iot_hub_data_connection_output(data_connection_name: Optional[pulumi.Input[str]] = None,
                                database_name: Optional[pulumi.Input[str]] = None,
                                kusto_pool_name: Optional[pulumi.Input[str]] = None,
                                resource_group_name: Optional[pulumi.Input[str]] = None,
                                workspace_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetIotHubDataConnectionResult]
func LookupIotHubDataConnection(ctx *Context, args *LookupIotHubDataConnectionArgs, opts ...InvokeOption) (*LookupIotHubDataConnectionResult, error)
func LookupIotHubDataConnectionOutput(ctx *Context, args *LookupIotHubDataConnectionOutputArgs, opts ...InvokeOption) LookupIotHubDataConnectionResultOutput

> Note: This function is named LookupIotHubDataConnection in the Go SDK.

public static class GetIotHubDataConnection 
{
    public static Task<GetIotHubDataConnectionResult> InvokeAsync(GetIotHubDataConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetIotHubDataConnectionResult> Invoke(GetIotHubDataConnectionInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetIotHubDataConnectionResult> getIotHubDataConnection(GetIotHubDataConnectionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:synapse:getIotHubDataConnection
  Arguments:
    # Arguments dictionary

The following arguments are supported:

DataConnectionName string

The name of the data connection.

DatabaseName string

The name of the database in the Kusto pool.

KustoPoolName string

The name of the Kusto pool.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

WorkspaceName string

The name of the workspace

DataConnectionName string

The name of the data connection.

DatabaseName string

The name of the database in the Kusto pool.

KustoPoolName string

The name of the Kusto pool.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

WorkspaceName string

The name of the workspace

dataConnectionName String

The name of the data connection.

databaseName String

The name of the database in the Kusto pool.

kustoPoolName String

The name of the Kusto pool.

resourceGroupName String

The name of the resource group. The name is case insensitive.

workspaceName String

The name of the workspace

dataConnectionName string

The name of the data connection.

databaseName string

The name of the database in the Kusto pool.

kustoPoolName string

The name of the Kusto pool.

resourceGroupName string

The name of the resource group. The name is case insensitive.

workspaceName string

The name of the workspace

data_connection_name str

The name of the data connection.

database_name str

The name of the database in the Kusto pool.

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.

workspace_name str

The name of the workspace

dataConnectionName String

The name of the data connection.

databaseName String

The name of the database in the Kusto pool.

kustoPoolName String

The name of the Kusto pool.

resourceGroupName String

The name of the resource group. The name is case insensitive.

workspaceName String

The name of the workspace

getIotHubDataConnection Result

The following output properties are available:

ConsumerGroup string

The iot hub consumer group.

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

IotHubResourceId string

The resource ID of the Iot hub to be used to create a data connection.

Name string

The name of the resource

ProvisioningState string

The provisioned state of the resource.

SharedAccessPolicyName string

The name of the share access policy

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"

DataFormat string

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.

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

IotHubResourceId string

The resource ID of the Iot hub to be used to create a data connection.

Name string

The name of the resource

ProvisioningState string

The provisioned state of the resource.

SharedAccessPolicyName string

The name of the share access policy

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"

DataFormat string

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.

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

iotHubResourceId String

The resource ID of the Iot hub to be used to create a data connection.

name String

The name of the resource

provisioningState String

The provisioned state of the resource.

sharedAccessPolicyName String

The name of the share access policy

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"

dataFormat String

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.

id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

iotHubResourceId string

The resource ID of the Iot hub to be used to create a data connection.

name string

The name of the resource

provisioningState string

The provisioned state of the resource.

sharedAccessPolicyName string

The name of the share access policy

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"

dataFormat string

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.

id str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

iot_hub_resource_id str

The resource ID of the Iot hub to be used to create a data connection.

name str

The name of the resource

provisioning_state str

The provisioned state of the resource.

shared_access_policy_name str

The name of the share access policy

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"

data_format str

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.

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

iotHubResourceId String

The resource ID of the Iot hub to be used to create a data connection.

name String

The name of the resource

provisioningState String

The provisioned state of the resource.

sharedAccessPolicyName String

The name of the share access policy

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"

dataFormat String

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.

Supporting Types

SystemDataResponse

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.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0