IotHubProperties interface

  • Reference
Package:
@azure/arm-iothub

The properties of an IoT hub.

Properties

allowedFqdnList

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

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

The IoT hub cloud-to-device messaging properties.
comments

IoT hub comments.
disableDeviceSAS

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

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

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

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

If True, file upload notifications are enabled.
eventHubEndpoints

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.
features

The capabilities and features enabled for the IoT hub.
hostName

The name of the host. NOTE: This property will not be serialized. It can only be populated by the server.
ipFilterRules

The IP filter rules.
locations

Primary and secondary location for iot hub NOTE: This property will not be serialized. It can only be populated by the server.
messagingEndpoints

The messaging endpoint properties for the file upload notification queue.
minTlsVersion

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

Network Rule Set Properties of IotHub
privateEndpointConnections

Private endpoint connections created on this IotHub
provisioningState

The provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccess

Whether requests from Public Network are allowed
restrictOutboundNetworkAccess

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

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

The hub state. NOTE: This property will not be serialized. It can only be populated by the server.
storageEndpoints

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.

Property Details

allowedFqdnList

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

allowedFqdnList?: string[]

Property Value

string[]

authorizationPolicies

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

authorizationPolicies?: SharedAccessSignatureAuthorizationRule[]

Property Value

SharedAccessSignatureAuthorizationRule[]

cloudToDevice

The IoT hub cloud-to-device messaging properties.

cloudToDevice?: CloudToDeviceProperties

Property Value

CloudToDeviceProperties

comments

IoT hub comments.

comments?: string

Property Value

string

disableDeviceSAS

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

disableDeviceSAS?: boolean

Property Value

boolean

disableLocalAuth

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

disableLocalAuth?: boolean

Property Value

boolean

disableModuleSAS

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

disableModuleSAS?: boolean

Property Value

boolean

enableDataResidency

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

enableDataResidency?: boolean

Property Value

boolean

enableFileUploadNotifications

If True, file upload notifications are enabled.

enableFileUploadNotifications?: boolean

Property Value

boolean

eventHubEndpoints

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.

eventHubEndpoints?: {[propertyName: string]: EventHubProperties}

Property Value

{[propertyName: string]: EventHubProperties}

features

The capabilities and features enabled for the IoT hub.

features?: string

Property Value

string

hostName

The name of the host. NOTE: This property will not be serialized. It can only be populated by the server.

hostName?: string

Property Value

string

ipFilterRules

The IP filter rules.

ipFilterRules?: IpFilterRule[]

Property Value

IpFilterRule[]

locations

Primary and secondary location for iot hub NOTE: This property will not be serialized. It can only be populated by the server.

locations?: IotHubLocationDescription[]

Property Value

IotHubLocationDescription[]

messagingEndpoints

The messaging endpoint properties for the file upload notification queue.

messagingEndpoints?: {[propertyName: string]: MessagingEndpointProperties}

Property Value

{[propertyName: string]: MessagingEndpointProperties}

minTlsVersion

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.

minTlsVersion?: string

Property Value

string

networkRuleSets

Network Rule Set Properties of IotHub

networkRuleSets?: NetworkRuleSetProperties

Property Value

NetworkRuleSetProperties

privateEndpointConnections

Private endpoint connections created on this IotHub

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

The provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publicNetworkAccess

Whether requests from Public Network are allowed

publicNetworkAccess?: string

Property Value

string

restrictOutboundNetworkAccess

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

restrictOutboundNetworkAccess?: boolean

Property Value

boolean

routing

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

routing?: RoutingProperties

Property Value

RoutingProperties

state

The hub state. NOTE: This property will not be serialized. It can only be populated by the server.

state?: string

Property Value

string

storageEndpoints

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.

storageEndpoints?: {[propertyName: string]: StorageEndpointProperties}

Property Value

{[propertyName: string]: StorageEndpointProperties}