ArmIotHubModelFactory.IotHubProperties Method

Reference

Definition

Namespace:: Azure.ResourceManager.IotHub.Models

Assembly:: Azure.ResourceManager.IotHub.dll

Package:: Azure.ResourceManager.IotHub v1.1.1

Package:: Azure.ResourceManager.IotHub v1.2.0-beta.1

Source:: ArmIotHubModelFactory.cs

Source:: ArmIotHubModelFactory.cs

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.

Initializes a new instance of IotHubProperties.

public static Azure.ResourceManager.IotHub.Models.IotHubProperties IotHubProperties (System.Collections.Generic.IEnumerable<Azure.ResourceManager.IotHub.Models.SharedAccessSignatureAuthorizationRule> authorizationPolicies = default, bool? disableLocalAuth = default, bool? disableDeviceSas = default, bool? disableModuleSas = default, bool? restrictOutboundNetworkAccess = default, System.Collections.Generic.IEnumerable<string> allowedFqdns = default, Azure.ResourceManager.IotHub.Models.IotHubPublicNetworkAccess? publicNetworkAccess = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.IotHub.Models.IotHubIPFilterRule> ipFilterRules = default, Azure.ResourceManager.IotHub.Models.IotHubNetworkRuleSetProperties networkRuleSets = default, string minTlsVersion = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.IotHub.IotHubPrivateEndpointConnectionData> privateEndpointConnections = default, string provisioningState = default, string state = default, string hostName = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.IotHub.Models.EventHubCompatibleEndpointProperties> eventHubEndpoints = default, Azure.ResourceManager.IotHub.Models.IotHubRoutingProperties routing = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.IotHub.Models.IotHubStorageEndpointProperties> storageEndpoints = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.IotHub.Models.MessagingEndpointProperties> messagingEndpoints = default, bool? enableFileUploadNotifications = default, Azure.ResourceManager.IotHub.Models.CloudToDeviceProperties cloudToDevice = default, string comments = default, Azure.ResourceManager.IotHub.Models.IotHubCapability? features = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.IotHub.Models.IotHubLocationDescription> locations = default, bool? enableDataResidency = default);

static member IotHubProperties : seq<Azure.ResourceManager.IotHub.Models.SharedAccessSignatureAuthorizationRule> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * seq<string> * Nullable<Azure.ResourceManager.IotHub.Models.IotHubPublicNetworkAccess> * seq<Azure.ResourceManager.IotHub.Models.IotHubIPFilterRule> * Azure.ResourceManager.IotHub.Models.IotHubNetworkRuleSetProperties * string * seq<Azure.ResourceManager.IotHub.IotHubPrivateEndpointConnectionData> * string * string * string * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.IotHub.Models.EventHubCompatibleEndpointProperties> * Azure.ResourceManager.IotHub.Models.IotHubRoutingProperties * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.IotHub.Models.IotHubStorageEndpointProperties> * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.IotHub.Models.MessagingEndpointProperties> * Nullable<bool> * Azure.ResourceManager.IotHub.Models.CloudToDeviceProperties * string * Nullable<Azure.ResourceManager.IotHub.Models.IotHubCapability> * seq<Azure.ResourceManager.IotHub.Models.IotHubLocationDescription> * Nullable<bool> -> Azure.ResourceManager.IotHub.Models.IotHubProperties

Public Shared Function IotHubProperties (Optional authorizationPolicies As IEnumerable(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 allowedFqdns As IEnumerable(Of String) = Nothing, Optional publicNetworkAccess As Nullable(Of IotHubPublicNetworkAccess) = Nothing, Optional ipFilterRules As IEnumerable(Of IotHubIPFilterRule) = Nothing, Optional networkRuleSets As IotHubNetworkRuleSetProperties = Nothing, Optional minTlsVersion As String = Nothing, Optional privateEndpointConnections As IEnumerable(Of IotHubPrivateEndpointConnectionData) = Nothing, Optional provisioningState As String = Nothing, Optional state As String = Nothing, Optional hostName As String = Nothing, Optional eventHubEndpoints As IDictionary(Of String, EventHubCompatibleEndpointProperties) = Nothing, Optional routing As IotHubRoutingProperties = Nothing, Optional storageEndpoints As IDictionary(Of String, IotHubStorageEndpointProperties) = 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 Nullable(Of IotHubCapability) = Nothing, Optional locations As IEnumerable(Of IotHubLocationDescription) = Nothing, Optional enableDataResidency As Nullable(Of Boolean) = Nothing) As IotHubProperties

Parameters

authorizationPolicies: IEnumerable<SharedAccessSignatureAuthorizationRule>

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

disableLocalAuth: Nullable<Boolean>

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

disableDeviceSas: Nullable<Boolean>

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

disableModuleSas: Nullable<Boolean>

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

restrictOutboundNetworkAccess: Nullable<Boolean>

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

allowedFqdns: IEnumerable<String>

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

publicNetworkAccess: Nullable<IotHubPublicNetworkAccess>

Whether requests from Public Network are allowed.

ipFilterRules: IEnumerable<IotHubIPFilterRule>

The IP filter rules.

networkRuleSets: IotHubNetworkRuleSetProperties

Network Rule Set Properties of IotHub.

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: IEnumerable<IotHubPrivateEndpointConnectionData>

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,EventHubCompatibleEndpointProperties>

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: IotHubRoutingProperties

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

storageEndpoints: IDictionary<String,IotHubStorageEndpointProperties>

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.