pulumi-azure-kotlin/com.pulumi.azure.iot.kotlin.outputs/IoTHubEndpoint

IoTHubEndpoint

data class IoTHubEndpoint(val authenticationType: String? = null, val batchFrequencyInSeconds: Int? = null, val connectionString: String? = null, val containerName: String? = null, val encoding: String? = null, val endpointUri: String? = null, val entityPath: String? = null, val fileNameFormat: String? = null, val identityId: String? = null, val maxChunkSizeInBytes: Int? = null, val name: String, val resourceGroupName: String? = null, val type: String)

Constructors

IoTHubEndpoint

fun IoTHubEndpoint(authenticationType: String? = null, batchFrequencyInSeconds: Int? = null, connectionString: String? = null, containerName: String? = null, encoding: String? = null, endpointUri: String? = null, entityPath: String? = null, fileNameFormat: String? = null, identityId: String? = null, maxChunkSizeInBytes: Int? = null, name: String, resourceGroupName: String? = null, type: String)

Types

Companion

object Companion

Properties

authenticationType

val authenticationType: String? = null

The type used to authenticate against the endpoint. Possible values are keyBased and identityBased. Defaults to keyBased.

batchFrequencyInSeconds

val batchFrequencyInSeconds: Int? = null

Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. This attribute is applicable for endpoint type AzureIotHub.StorageContainer.

connectionString

val connectionString: String? = null

The connection string for the endpoint. This attribute is mandatory and can only be specified when authentication_type is keyBased.

containerName

val containerName: String? = null

The name of storage container in the storage account. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.

encoding

val encoding: String? = null

Encoding that is used to serialize messages to blobs. Supported values are Avro, AvroDeflate and JSON. Default value is Avro. This attribute is applicable for endpoint type AzureIotHub.StorageContainer. Changing this forces a new resource to be created.

endpointUri

val endpointUri: String? = null

URI of the Service Bus or Event Hubs Namespace endpoint. This attribute can only be specified and is mandatory when authentication_type is identityBased for endpoint type AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.

entityPath

val entityPath: String? = null

Name of the Service Bus Queue/Topic or Event Hub. This attribute can only be specified and is mandatory when authentication_type is identityBased for endpoint type AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.

fileNameFormat

val fileNameFormat: String? = null

File name format for the blob. Default format is `{iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}`. All parameters are mandatory but can be reordered. This attribute is applicable for endpoint type AzureIotHub.StorageContainer.

identityId

val identityId: String? = null

The ID of the User Managed Identity used to authenticate against the endpoint.

maxChunkSizeInBytes

val maxChunkSizeInBytes: Int? = null

Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). This attribute is applicable for endpoint type AzureIotHub.StorageContainer.

name

val name: String

The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

resourceGroupName

val resourceGroupName: String? = null

The resource group in which the endpoint will be created.

type

val type: String

The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.