IotHubProperties Class

Definition

The properties of an IoT hub.

public class IotHubProperties
public class IotHubProperties : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.IotHub.Models.IotHubProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.IotHub.Models.IotHubProperties>
type IotHubProperties = class
type IotHubProperties = class
    interface IJsonModel<IotHubProperties>
    interface IPersistableModel<IotHubProperties>
Public Class IotHubProperties
Public Class IotHubProperties
Implements IJsonModel(Of IotHubProperties), IPersistableModel(Of IotHubProperties)
Inheritance
IotHubProperties
Implements

Constructors

IotHubProperties()

Initializes a new instance of IotHubProperties.

Properties

AllowedFqdns

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.

IPFilterRules

The IP filter rules.

Locations

Primary and secondary location for iot hub.

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.

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.

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.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<IotHubProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<IotHubProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<IotHubProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<IotHubProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<IotHubProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to