pulumi-azure-native-kotlin/com.pulumi.azurenative.devices.kotlin.outputs/IotHubPropertiesResponse

IotHubPropertiesResponse

data class IotHubPropertiesResponse(val allowedFqdnList: List<String>? = null, val authorizationPolicies: List<SharedAccessSignatureAuthorizationRuleResponse>? = null, val cloudToDevice: CloudToDevicePropertiesResponse? = null, val comments: String? = null, val deviceStreams: IotHubPropertiesResponseDeviceStreams? = null, val disableDeviceSAS: Boolean? = null, val disableLocalAuth: Boolean? = null, val disableModuleSAS: Boolean? = null, val enableDataResidency: Boolean? = null, val enableFileUploadNotifications: Boolean? = null, val encryption: EncryptionPropertiesDescriptionResponse? = null, val eventHubEndpoints: Map<String, EventHubPropertiesResponse>? = null, val features: String? = null, val hostName: String, val ipFilterRules: List<IpFilterRuleResponse>? = null, val locations: List<IotHubLocationDescriptionResponse>, val messagingEndpoints: Map<String, MessagingEndpointPropertiesResponse>? = null, val minTlsVersion: String? = null, val networkRuleSets: NetworkRuleSetPropertiesResponse? = null, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>? = null, val provisioningState: String, val publicNetworkAccess: String? = null, val restrictOutboundNetworkAccess: Boolean? = null, val rootCertificate: RootCertificatePropertiesResponse? = null, val routing: RoutingPropertiesResponse? = null, val state: String, val storageEndpoints: Map<String, StorageEndpointPropertiesResponse>? = null)

The properties of an IoT hub.

Constructors

IotHubPropertiesResponse

constructor(allowedFqdnList: List<String>? = null, authorizationPolicies: List<SharedAccessSignatureAuthorizationRuleResponse>? = null, cloudToDevice: CloudToDevicePropertiesResponse? = null, comments: String? = null, deviceStreams: IotHubPropertiesResponseDeviceStreams? = null, disableDeviceSAS: Boolean? = null, disableLocalAuth: Boolean? = null, disableModuleSAS: Boolean? = null, enableDataResidency: Boolean? = null, enableFileUploadNotifications: Boolean? = null, encryption: EncryptionPropertiesDescriptionResponse? = null, eventHubEndpoints: Map<String, EventHubPropertiesResponse>? = null, features: String? = null, hostName: String, ipFilterRules: List<IpFilterRuleResponse>? = null, locations: List<IotHubLocationDescriptionResponse>, messagingEndpoints: Map<String, MessagingEndpointPropertiesResponse>? = null, minTlsVersion: String? = null, networkRuleSets: NetworkRuleSetPropertiesResponse? = null, privateEndpointConnections: List<PrivateEndpointConnectionResponse>? = null, provisioningState: String, publicNetworkAccess: String? = null, restrictOutboundNetworkAccess: Boolean? = null, rootCertificate: RootCertificatePropertiesResponse? = null, routing: RoutingPropertiesResponse? = null, state: String, storageEndpoints: Map<String, StorageEndpointPropertiesResponse>? = null)

Types

object Companion

Properties

allowedFqdnList

val allowedFqdnList: List<String>? = null

List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.

authorizationPolicies

val authorizationPolicies: List<SharedAccessSignatureAuthorizationRuleResponse>? = null

The shared access policies you can use to secure a connection to the IoT hub.

val cloudToDevice: CloudToDevicePropertiesResponse? = null

The IoT hub cloud-to-device messaging properties.

val comments: String? = null

IoT hub comments.

val deviceStreams: IotHubPropertiesResponseDeviceStreams? = null

The device streams properties of iothub.

disableDeviceSAS

val disableDeviceSAS: Boolean? = null

If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.

disableLocalAuth

val disableLocalAuth: Boolean? = null

If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.

disableModuleSAS

val disableModuleSAS: Boolean? = null

If true, all module scoped SAS keys cannot be used for authentication.

enableDataResidency

val enableDataResidency: Boolean? = null

This property when set to true, will enable data residency, thus, disabling disaster recovery.

enableFileUploadNotifications

val enableFileUploadNotifications: Boolean? = null

If True, file upload notifications are enabled.

val encryption: EncryptionPropertiesDescriptionResponse? = null

The encryption properties for the IoT hub.

eventHubEndpoints

val eventHubEndpoints: Map<String, EventHubPropertiesResponse>? = null

The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub.

val features: String? = null

The capabilities and features enabled for the IoT hub.

val hostName: String

The name of the host.

val ipFilterRules: List<IpFilterRuleResponse>? = null

The IP filter rules.

val locations: List<IotHubLocationDescriptionResponse>

Primary and secondary location for iot hub

messagingEndpoints

val messagingEndpoints: Map<String, MessagingEndpointPropertiesResponse>? = null

The messaging endpoint properties for the file upload notification queue.

val minTlsVersion: String? = null

Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected.

networkRuleSets

val networkRuleSets: NetworkRuleSetPropertiesResponse? = null

Network Rule Set Properties of IotHub

privateEndpointConnections

val privateEndpointConnections: List<PrivateEndpointConnectionResponse>? = null

Private endpoint connections created on this IotHub

provisioningState

val provisioningState: String

The provisioning state.

publicNetworkAccess

val publicNetworkAccess: String? = null

Whether requests from Public Network are allowed

restrictOutboundNetworkAccess

val restrictOutboundNetworkAccess: Boolean? = null

If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.

rootCertificate

val rootCertificate: RootCertificatePropertiesResponse? = null

This property store root certificate related information

val routing: RoutingPropertiesResponse? = null

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

val state: String

The hub state.

storageEndpoints

val storageEndpoints: Map<String, StorageEndpointPropertiesResponse>? = null

The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.