你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

IotHubProperties interface

包:

@azure/arm-iothub

IoT 中心的属性。

属性

allowedFqdnList	允许的 FQDN 列表 (来自 Iot 中心的出口的完全限定域名) 。
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

允许的 FQDN 列表 (来自 Iot 中心的出口的完全限定域名) 。

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}