Share via

IotHubProperties interface

  • Reference
Package:
@azure/arm-iothub-profile-2020-09-01-hybrid

The properties of an IoT hub.

Properties

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

The device streams properties of iothub.
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.
provisioningState

The provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
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

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

deviceStreams

The device streams properties of iothub.

deviceStreams?: IotHubPropertiesDeviceStreams

Property Value

IotHubPropertiesDeviceStreams

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}

provisioningState

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

provisioningState?: string

Property Value

string

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}