IotHubProperties Class

Definition

The properties of an IoT hub.

public class IotHubProperties
type IotHubProperties = class
Public Class IotHubProperties
Inheritance
IotHubProperties

Constructors

IotHubProperties()

Initializes a new instance of the IotHubProperties class.

IotHubProperties(IList<SharedAccessSignatureAuthorizationRule>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, IList<String>, String, IList<IpFilterRule>, NetworkRuleSetProperties, String, IList<PrivateEndpointConnection>, String, String, String, IDictionary<String,EventHubProperties>, RoutingProperties, IDictionary<String, StorageEndpointProperties>, IDictionary<String,MessagingEndpointProperties>, Nullable<Boolean>, CloudToDeviceProperties, String, String, IList<IotHubLocationDescription>, Nullable<Boolean>)

Initializes a new instance of the IotHubProperties class.

Properties

AllowedFqdnList

Gets or sets list of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.

AuthorizationPolicies

Gets or sets the shared access policies you can use to secure a connection to the IoT hub.

CloudToDevice
Comments

Gets or sets ioT hub comments.

DisableDeviceSAS

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

DisableLocalAuth

Gets or sets if true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.

DisableModuleSAS

Gets or sets if true, all module scoped SAS keys cannot be used for authentication.

EnableDataResidency

Gets or sets this property when set to true, will enable data residency, thus, disabling disaster recovery.

EnableFileUploadNotifications

Gets or sets if True, file upload notifications are enabled.

EventHubEndpoints

Gets or sets 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

Gets or sets the capabilities and features enabled for the IoT hub. Possible values include: 'None', 'DeviceManagement'

HostName

Gets the name of the host.

IpFilterRules

Gets or sets the IP filter rules.

Locations

Gets primary and secondary location for iot hub

MessagingEndpoints

Gets or sets the messaging endpoint properties for the file upload notification queue.

MinTlsVersion

Gets or sets 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
PrivateEndpointConnections

Gets or sets private endpoint connections created on this IotHub

ProvisioningState

Gets the provisioning state.

PublicNetworkAccess

Gets or sets whether requests from Public Network are allowed. Possible values include: 'Enabled', 'Disabled'

RestrictOutboundNetworkAccess

Gets or sets if true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.

Routing
State

Gets the hub state.

StorageEndpoints

Gets or sets 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.

Methods

Validate()

Validate the object.

Applies to