IotHubProperties interface

套件:

@azure/arm-iothub

IoT 中樞的屬性。

屬性

allowedFqdnList	允許從 Iot 中樞輸出的 FQDN（完整功能變數名稱）清單。
authorizationPolicies	您可以用來保護IoT中樞連線的共用存取原則。
cloudToDevice	IoT 中樞雲端到裝置傳訊屬性。
comments	IoT 中樞批注。
disableDeviceSAS	如果為 true，則所有裝置（包括 Edge 裝置，但不包括模組）限定範圍的 SAS 金鑰都無法用於驗證。
disableLocalAuth	如果為 true，則無法將具有 Iot 中樞範圍的 SAS 金鑰 SAS 令牌用於驗證。
disableModuleSAS	如果為 true，則所有模組範圍的 SAS 金鑰都無法用於驗證。
enableDataResidency	當設定為 true 時，這個屬性會啟用數據落地，因此會停用災害復原。
enableFileUploadNotifications	如果為 True，則會啟用檔案上傳通知。
eventHubEndpoints	事件中樞相容的端點屬性。 這個字典的唯一可能索引鍵是事件。 在建立或更新IoT中樞的呼叫時，此金鑰必須存在於字典中。
features	針對IoT中樞啟用的功能和功能。
hostName	主機的名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。
ipFilterRules	IP 篩選規則。
locations	iot 中樞的主要和次要位置注意：此屬性將不會串行化。 它只能由伺服器填入。
messagingEndpoints	檔案上傳通知佇列的傳訊端點屬性。
minTlsVersion	指定要支援此中樞的最低 TLS 版本。 可以設定為 「1.2」 ，讓使用 1.2 以下 TLS 版本的用戶端遭到拒絕。
networkRuleSets	IotHub 的網路規則集屬性
privateEndpointConnections	在此IotHub上建立的私人端點連線
provisioningState	布建狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。
publicNetworkAccess	是否允許來自公用網路的要求
restrictOutboundNetworkAccess	如果為 true，則來自 IotHub 的輸出將僅限於透過 allowedFqdnList 設定的允許 FQDN。
routing	IoT 中樞的路由相關屬性。 請參閱：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
state	中樞狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。
storageEndpoints	您可以在其中上傳檔案的 Azure 記憶體端點清單。 目前您只能設定一個 Azure 記憶體帳戶，且必須將其密鑰設定為$default。 指定多個記憶體帳戶會導致擲回錯誤。 當 enableFileUploadNotifications 屬性設定為 True 時，未指定此屬性的值，會導致擲回錯誤。

屬性詳細資料

allowedFqdnList

允許從 Iot 中樞輸出的 FQDN（完整功能變數名稱）清單。

allowedFqdnList?: string[]

屬性值

string[]

authorizationPolicies

您可以用來保護IoT中樞連線的共用存取原則。

authorizationPolicies?: SharedAccessSignatureAuthorizationRule[]

屬性值

SharedAccessSignatureAuthorizationRule[]

cloudToDevice

IoT 中樞雲端到裝置傳訊屬性。

cloudToDevice?: CloudToDeviceProperties

屬性值

CloudToDeviceProperties

comments

IoT 中樞批注。

comments?: string

屬性值

string

disableDeviceSAS

如果為 true，則所有裝置（包括 Edge 裝置，但不包括模組）限定範圍的 SAS 金鑰都無法用於驗證。

disableDeviceSAS?: boolean

屬性值

boolean

disableLocalAuth

如果為 true，則無法將具有 Iot 中樞範圍的 SAS 金鑰 SAS 令牌用於驗證。

disableLocalAuth?: boolean

屬性值

boolean

disableModuleSAS

如果為 true，則所有模組範圍的 SAS 金鑰都無法用於驗證。

disableModuleSAS?: boolean

屬性值

boolean

enableDataResidency

當設定為 true 時，這個屬性會啟用數據落地，因此會停用災害復原。

enableDataResidency?: boolean

屬性值

boolean

enableFileUploadNotifications

如果為 True，則會啟用檔案上傳通知。

enableFileUploadNotifications?: boolean

屬性值

boolean

eventHubEndpoints

事件中樞相容的端點屬性。 這個字典的唯一可能索引鍵是事件。 在建立或更新IoT中樞的呼叫時，此金鑰必須存在於字典中。

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

屬性值

{[propertyName: string]: EventHubProperties}

features

針對IoT中樞啟用的功能和功能。

features?: string

屬性值

string

hostName

主機的名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。

hostName?: string

屬性值

string

ipFilterRules

IP 篩選規則。

ipFilterRules?: IpFilterRule[]

屬性值

IpFilterRule[]

locations

iot 中樞的主要和次要位置注意：此屬性將不會串行化。 它只能由伺服器填入。

locations?: IotHubLocationDescription[]

屬性值

IotHubLocationDescription[]

messagingEndpoints

檔案上傳通知佇列的傳訊端點屬性。

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

屬性值

{[propertyName: string]: MessagingEndpointProperties}

minTlsVersion

指定要支援此中樞的最低 TLS 版本。 可以設定為 「1.2」 ，讓使用 1.2 以下 TLS 版本的用戶端遭到拒絕。

minTlsVersion?: string

屬性值

string

networkRuleSets

IotHub 的網路規則集屬性

networkRuleSets?: NetworkRuleSetProperties

屬性值

NetworkRuleSetProperties

privateEndpointConnections

在此IotHub上建立的私人端點連線

privateEndpointConnections?: PrivateEndpointConnection[]

屬性值

PrivateEndpointConnection[]

provisioningState

布建狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。

provisioningState?: string

屬性值

string

publicNetworkAccess

是否允許來自公用網路的要求

publicNetworkAccess?: string

屬性值

string

restrictOutboundNetworkAccess

如果為 true，則來自 IotHub 的輸出將僅限於透過 allowedFqdnList 設定的允許 FQDN。

restrictOutboundNetworkAccess?: boolean

屬性值

boolean

routing

IoT 中樞的路由相關屬性。 請參閱：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

routing?: RoutingProperties

屬性值

RoutingProperties

state

中樞狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。

state?: string

屬性值

string

storageEndpoints

您可以在其中上傳檔案的 Azure 記憶體端點清單。 目前您只能設定一個 Azure 記憶體帳戶，且必須將其密鑰設定為$default。 指定多個記憶體帳戶會導致擲回錯誤。 當 enableFileUploadNotifications 屬性設定為 True 時，未指定此屬性的值，會導致擲回錯誤。

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

屬性值

{[propertyName: string]: StorageEndpointProperties}