IotHubProperties Constructors
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
IotHubProperties()
Initializes a new instance of the IotHubProperties class.
public IotHubProperties ();Public Sub New ()Applies to
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.
public IotHubProperties (System.Collections.Generic.IList<Microsoft.Azure.Management.IotHub.Models.SharedAccessSignatureAuthorizationRule> authorizationPolicies = default, bool? disableLocalAuth = default, bool? disableDeviceSAS = default, bool? disableModuleSAS = default, bool? restrictOutboundNetworkAccess = default, System.Collections.Generic.IList<string> allowedFqdnList = default, string publicNetworkAccess = default, System.Collections.Generic.IList<Microsoft.Azure.Management.IotHub.Models.IpFilterRule> ipFilterRules = default, Microsoft.Azure.Management.IotHub.Models.NetworkRuleSetProperties networkRuleSets = default, string minTlsVersion = default, System.Collections.Generic.IList<Microsoft.Azure.Management.IotHub.Models.PrivateEndpointConnection> privateEndpointConnections = default, string provisioningState = default, string state = default, string hostName = default, System.Collections.Generic.IDictionary<string,Microsoft.Azure.Management.IotHub.Models.EventHubProperties> eventHubEndpoints = default, Microsoft.Azure.Management.IotHub.Models.RoutingProperties routing = default, System.Collections.Generic.IDictionary<string,Microsoft.Azure.Management.IotHub.Models.StorageEndpointProperties> storageEndpoints = default, System.Collections.Generic.IDictionary<string,Microsoft.Azure.Management.IotHub.Models.MessagingEndpointProperties> messagingEndpoints = default, bool? enableFileUploadNotifications = default, Microsoft.Azure.Management.IotHub.Models.CloudToDeviceProperties cloudToDevice = default, string comments = default, string features = default, System.Collections.Generic.IList<Microsoft.Azure.Management.IotHub.Models.IotHubLocationDescription> locations = default, bool? enableDataResidency = default);new Microsoft.Azure.Management.IotHub.Models.IotHubProperties : System.Collections.Generic.IList<Microsoft.Azure.Management.IotHub.Models.SharedAccessSignatureAuthorizationRule> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * System.Collections.Generic.IList<string> * string * System.Collections.Generic.IList<Microsoft.Azure.Management.IotHub.Models.IpFilterRule> * Microsoft.Azure.Management.IotHub.Models.NetworkRuleSetProperties * string * System.Collections.Generic.IList<Microsoft.Azure.Management.IotHub.Models.PrivateEndpointConnection> * string * string * string * System.Collections.Generic.IDictionary<string, Microsoft.Azure.Management.IotHub.Models.EventHubProperties> * Microsoft.Azure.Management.IotHub.Models.RoutingProperties * System.Collections.Generic.IDictionary<string, Microsoft.Azure.Management.IotHub.Models.StorageEndpointProperties> * System.Collections.Generic.IDictionary<string, Microsoft.Azure.Management.IotHub.Models.MessagingEndpointProperties> * Nullable<bool> * Microsoft.Azure.Management.IotHub.Models.CloudToDeviceProperties * string * string * System.Collections.Generic.IList<Microsoft.Azure.Management.IotHub.Models.IotHubLocationDescription> * Nullable<bool> -> Microsoft.Azure.Management.IotHub.Models.IotHubPropertiesPublic Sub New (Optional authorizationPolicies As IList(Of SharedAccessSignatureAuthorizationRule) = Nothing, Optional disableLocalAuth As Nullable(Of Boolean) = Nothing, Optional disableDeviceSAS As Nullable(Of Boolean) = Nothing, Optional disableModuleSAS As Nullable(Of Boolean) = Nothing, Optional restrictOutboundNetworkAccess As Nullable(Of Boolean) = Nothing, Optional allowedFqdnList As IList(Of String) = Nothing, Optional publicNetworkAccess As String = Nothing, Optional ipFilterRules As IList(Of IpFilterRule) = Nothing, Optional networkRuleSets As NetworkRuleSetProperties = Nothing, Optional minTlsVersion As String = Nothing, Optional privateEndpointConnections As IList(Of PrivateEndpointConnection) = Nothing, Optional provisioningState As String = Nothing, Optional state As String = Nothing, Optional hostName As String = Nothing, Optional eventHubEndpoints As IDictionary(Of String, EventHubProperties) = Nothing, Optional routing As RoutingProperties = Nothing, Optional storageEndpoints As IDictionary(Of String, StorageEndpointProperties) = Nothing, Optional messagingEndpoints As IDictionary(Of String, MessagingEndpointProperties) = Nothing, Optional enableFileUploadNotifications As Nullable(Of Boolean) = Nothing, Optional cloudToDevice As CloudToDeviceProperties = Nothing, Optional comments As String = Nothing, Optional features As String = Nothing, Optional locations As IList(Of IotHubLocationDescription) = Nothing, Optional enableDataResidency As Nullable(Of Boolean) = Nothing)Parameters
- authorizationPolicies
- IList<SharedAccessSignatureAuthorizationRule>
The shared access policies you can use to secure a connection to the IoT hub.
If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.
If true, all module scoped SAS keys cannot be used for authentication.
If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.
List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
- publicNetworkAccess
- String
Whether requests from Public Network are allowed. Possible values include: 'Enabled', 'Disabled'
- ipFilterRules
- IList<IpFilterRule>
The IP filter rules.
- networkRuleSets
- NetworkRuleSetProperties
- minTlsVersion
- String
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.
- privateEndpointConnections
- IList<PrivateEndpointConnection>
Private endpoint connections created on this IotHub
- provisioningState
- String
The provisioning state.
- state
- String
The hub state.
- hostName
- String
The name of the host.
- eventHubEndpoints
- IDictionary<String,EventHubProperties>
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.
- routing
- RoutingProperties
- storageEndpoints
- IDictionary<String,StorageEndpointProperties>
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.
- messagingEndpoints
- IDictionary<String,MessagingEndpointProperties>
The messaging endpoint properties for the file upload notification queue.
- cloudToDevice
- CloudToDeviceProperties
- comments
- String
IoT hub comments.
- features
- String
The capabilities and features enabled for the IoT hub. Possible values include: 'None', 'DeviceManagement'
- locations
- IList<IotHubLocationDescription>
Primary and secondary location for iot hub
This property when set to true, will enable data residency, thus, disabling disaster recovery.
Applies to
Azure SDK for .NET