IotHubProperties interface

Paket:

@azure/arm-iothub

Die Eigenschaften eines IoT Hubs.

Eigenschaften

allowedFqdnList	Liste der zulässigen FQDNs (vollqualifizierter Domänenname) für ausgehenden Datenverkehr von Iot Hub.
authorizationPolicies	Die Shared Access-Richtlinien, die Sie verwenden können, um eine Verbindung mit dem IoT Hub zu schützen.
cloudToDevice	Die IoT Hub-Cloud-zu-Gerät-Messagingeigenschaften.
comments	IoT Hub-Kommentare.
disableDeviceSAS	Wenn true, können nicht alle sas-Bereichsschlüssel für Geräte (einschließlich Edgegeräte, aber mit Ausnahme von Modulen) für die Authentifizierung verwendet werden.
disableLocalAuth	Wenn true, können SAS-Token mit iot hub-bereichsbezogenen SAS-Schlüsseln nicht für die Authentifizierung verwendet werden.
disableModuleSAS	Wenn true, können nicht alle modulbezogenen SAS-Schlüssel für die Authentifizierung verwendet werden.
enableDataResidency	Wenn diese Eigenschaft auf TRUE festgelegt ist, wird die Datenresidenz aktiviert, wodurch die Notfallwiederherstellung deaktiviert wird.
enableFileUploadNotifications	True gibt an, dass Benachrichtigungen zum Hochladen von Dateien aktiviert sind.
eventHubEndpoints	Die Event Hub-kompatiblen Endpunkteigenschaften. Der einzige mögliche Schlüssel für dieses Wörterbuch sind Ereignisse. Dieser Schlüssel muss im Wörterbuch vorhanden sein, während Erstellungs- oder Aktualisierungsaufrufe für den IoT Hub ausgeführt werden.
features	Die Funktionen und Features, die für den IoT Hub aktiviert sind.
hostName	Der Name des Hosts. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
ipFilterRules	Die IP-Filterregeln.
locations	Primärer und sekundärer Standort für iot Hub HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
messagingEndpoints	Die Messagingendpunkteigenschaften für die Dateiuploadbenachrichtigungswarteschlange.
minTlsVersion	Gibt die TLS-Mindestversion an, die für diesen Hub unterstützt werden soll. Kann auf "1.2" festgelegt werden, damit Clients, die eine TLS-Version unter 1.2 verwenden, abgelehnt werden.
networkRuleSets	Netzwerkregelsatzeigenschaften von IotHub
privateEndpointConnections	Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden
provisioningState	Der Bereitstellungsstatus. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
publicNetworkAccess	Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind
restrictOutboundNetworkAccess	Wenn true, ist der Ausgehende von IotHub nur auf die zulässigen FQDNs beschränkt, die über allowedFqdnList konfiguriert werden.
routing	Die Routingeigenschaften des IoT Hubs. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
state	Der Hubstatus. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
storageEndpoints	Die Liste der Azure Storage-Endpunkte, an denen Sie Dateien hochladen können. Derzeit können Sie nur ein Azure Storage-Konto konfigurieren, dessen Schlüssel als $default muss. Wenn Sie mehrere Speicherkonten angeben, wird ein Fehler ausgelöst. Wenn sie keinen Wert für diese Eigenschaft angeben, wenn die enableFileUploadNotifications-Eigenschaft auf True festgelegt ist, wird ein Fehler ausgelöst.

Details zur Eigenschaft

allowedFqdnList

Liste der zulässigen FQDNs (vollqualifizierter Domänenname) für ausgehenden Datenverkehr von Iot Hub.

allowedFqdnList?: string[]

Eigenschaftswert

string[]

authorizationPolicies

Die Shared Access-Richtlinien, die Sie verwenden können, um eine Verbindung mit dem IoT Hub zu schützen.

authorizationPolicies?: SharedAccessSignatureAuthorizationRule[]

Eigenschaftswert

SharedAccessSignatureAuthorizationRule[]

cloudToDevice

Die IoT Hub-Cloud-zu-Gerät-Messagingeigenschaften.

cloudToDevice?: CloudToDeviceProperties

Eigenschaftswert

CloudToDeviceProperties

comments

IoT Hub-Kommentare.

comments?: string

Eigenschaftswert

string

disableDeviceSAS

Wenn true, können nicht alle sas-Bereichsschlüssel für Geräte (einschließlich Edgegeräte, aber mit Ausnahme von Modulen) für die Authentifizierung verwendet werden.

disableDeviceSAS?: boolean

Eigenschaftswert

boolean

disableLocalAuth

Wenn true, können SAS-Token mit iot hub-bereichsbezogenen SAS-Schlüsseln nicht für die Authentifizierung verwendet werden.

disableLocalAuth?: boolean

Eigenschaftswert

boolean

disableModuleSAS

Wenn true, können nicht alle modulbezogenen SAS-Schlüssel für die Authentifizierung verwendet werden.

disableModuleSAS?: boolean

Eigenschaftswert

boolean

enableDataResidency

Wenn diese Eigenschaft auf TRUE festgelegt ist, wird die Datenresidenz aktiviert, wodurch die Notfallwiederherstellung deaktiviert wird.

enableDataResidency?: boolean

Eigenschaftswert

boolean

enableFileUploadNotifications

True gibt an, dass Benachrichtigungen zum Hochladen von Dateien aktiviert sind.

enableFileUploadNotifications?: boolean

Eigenschaftswert

boolean

eventHubEndpoints

Die Event Hub-kompatiblen Endpunkteigenschaften. Der einzige mögliche Schlüssel für dieses Wörterbuch sind Ereignisse. Dieser Schlüssel muss im Wörterbuch vorhanden sein, während Erstellungs- oder Aktualisierungsaufrufe für den IoT Hub ausgeführt werden.

eventHubEndpoints?: {[propertyName: string]: EventHubProperties}

Eigenschaftswert

{[propertyName: string]: EventHubProperties}

features

Die Funktionen und Features, die für den IoT Hub aktiviert sind.

features?: string

Eigenschaftswert

string

hostName

Der Name des Hosts. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

hostName?: string

Eigenschaftswert

string

ipFilterRules

Die IP-Filterregeln.

ipFilterRules?: IpFilterRule[]

Eigenschaftswert

IpFilterRule[]

locations

Primärer und sekundärer Standort für iot Hub HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

locations?: IotHubLocationDescription[]

Eigenschaftswert

IotHubLocationDescription[]

messagingEndpoints

Die Messagingendpunkteigenschaften für die Dateiuploadbenachrichtigungswarteschlange.

messagingEndpoints?: {[propertyName: string]: MessagingEndpointProperties}

Eigenschaftswert

{[propertyName: string]: MessagingEndpointProperties}

minTlsVersion

Gibt die TLS-Mindestversion an, die für diesen Hub unterstützt werden soll. Kann auf "1.2" festgelegt werden, damit Clients, die eine TLS-Version unter 1.2 verwenden, abgelehnt werden.

minTlsVersion?: string

Eigenschaftswert

string

networkRuleSets

Netzwerkregelsatzeigenschaften von IotHub

networkRuleSets?: NetworkRuleSetProperties

Eigenschaftswert

NetworkRuleSetProperties

privateEndpointConnections

Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden

privateEndpointConnections?: PrivateEndpointConnection[]

Eigenschaftswert

PrivateEndpointConnection[]

provisioningState

Der Bereitstellungsstatus. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

provisioningState?: string

Eigenschaftswert

string

publicNetworkAccess

Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind

publicNetworkAccess?: string

Eigenschaftswert

string

restrictOutboundNetworkAccess

Wenn true, ist der Ausgehende von IotHub nur auf die zulässigen FQDNs beschränkt, die über allowedFqdnList konfiguriert werden.

restrictOutboundNetworkAccess?: boolean

Eigenschaftswert

boolean

routing

Die Routingeigenschaften des IoT Hubs. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

routing?: RoutingProperties

Eigenschaftswert

RoutingProperties

state

Der Hubstatus. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

state?: string

Eigenschaftswert

string

storageEndpoints

Die Liste der Azure Storage-Endpunkte, an denen Sie Dateien hochladen können. Derzeit können Sie nur ein Azure Storage-Konto konfigurieren, dessen Schlüssel als $default muss. Wenn Sie mehrere Speicherkonten angeben, wird ein Fehler ausgelöst. Wenn sie keinen Wert für diese Eigenschaft angeben, wenn die enableFileUploadNotifications-Eigenschaft auf True festgelegt ist, wird ein Fehler ausgelöst.

storageEndpoints?: {[propertyName: string]: StorageEndpointProperties}

Eigenschaftswert

{[propertyName: string]: StorageEndpointProperties}