你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
IotHubProperties 类
IoT 中心的属性。
变量仅由服务器填充,在发送请求时将被忽略。
- 继承
-
azure.mgmt.iothub._serialization.ModelIotHubProperties
构造函数
IotHubProperties(*, authorization_policies: List[_models.SharedAccessSignatureAuthorizationRule] | None = None, disable_local_auth: bool | None = None, disable_device_sas: bool | None = None, disable_module_sas: bool | None = None, restrict_outbound_network_access: bool | None = None, allowed_fqdn_list: List[str] | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, ip_filter_rules: List[_models.IpFilterRule] | None = None, network_rule_sets: _models.NetworkRuleSetProperties | None = None, min_tls_version: str | None = None, private_endpoint_connections: List[_models.PrivateEndpointConnection] | None = None, event_hub_endpoints: Dict[str, _models.EventHubProperties] | None = None, routing: _models.RoutingProperties | None = None, storage_endpoints: Dict[str, _models.StorageEndpointProperties] | None = None, messaging_endpoints: Dict[str, _models.MessagingEndpointProperties] | None = None, enable_file_upload_notifications: bool | None = None, cloud_to_device: _models.CloudToDeviceProperties | None = None, comments: str | None = None, device_streams: _models.IotHubPropertiesDeviceStreams | None = None, features: str | _models.Capabilities | None = None, encryption: _models.EncryptionPropertiesDescription | None = None, enable_data_residency: bool | None = None, root_certificate: _models.RootCertificateProperties | None = None, **kwargs: Any)
仅限关键字的参数
名称 | 说明 |
---|---|
authorization_policies
|
可用于保护与 IoT 中心的连接的共享访问策略。 |
disable_local_auth
|
如果为 true,则无法使用具有 Iot 中心范围的 SAS 密钥的 SAS 令牌进行身份验证。 |
disable_device_sas
|
如果为 true,则所有设备 (包括 Edge 设备,但不包括) 作用域 SAS 密钥的模块,都不能用于身份验证。 |
disable_module_sas
|
如果为 true,则不能使用所有模块范围的 SAS 密钥进行身份验证。 |
restrict_outbound_network_access
|
如果为 true,则来自 IotHub 的出口限制为仅允许通过 allowedFqdnList 配置的 FQDN。 |
allowed_fqdn_list
|
允许的 FQDN 列表 (来自 Iot 中心的出口的完全限定域名) 。 |
public_network_access
|
是否允许来自公用网络的请求。 已知值为:“Enabled”和“Disabled”。 |
ip_filter_rules
|
IP 筛选器规则。 |
network_rule_sets
|
IotHub 的网络规则集属性。 |
min_tls_version
|
指定要对此中心支持的最低 TLS 版本。 可以设置为“1.2”,以拒绝使用低于 1.2 的 TLS 版本的客户端。 |
private_endpoint_connections
|
在此 IotHub 上创建的专用终结点连接。 |
event_hub_endpoints
|
与事件中心兼容的终结点属性。 此字典的唯一可能的键是事件。 在对 IoT 中心进行创建或更新调用时,此密钥必须存在于字典中。 |
routing
|
IoT 中心的路由相关属性。 请参阅 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging。 |
storage_endpoints
|
可在其中上传文件的 Azure 存储终结点列表。 目前只能配置一个 Azure 存储帐户,并且该帐户必须将其密钥作为$default。 指定多个存储帐户会导致引发错误。 当 enableFileUploadNotifications 属性设置为 True 时,不指定此属性的值会导致引发错误。 |
messaging_endpoints
|
文件上传通知队列的消息传送终结点属性。 |
enable_file_upload_notifications
|
如果为 True,则启用文件上传通知。 |
cloud_to_device
|
IoT 中心云到设备的消息传送属性。 |
comments
|
IoT 中心注释。 |
device_streams
|
设备流式传输 iothub 的属性。 |
features
|
为 IoT 中心启用的功能和功能。 已知值为:“None”和“DeviceManagement”。 |
encryption
|
IoT 中心的加密属性。 |
enable_data_residency
|
当设置为 true 时,此属性将启用数据驻留,从而禁用灾难恢复。 |
root_certificate
|
此属性存储根证书相关信息。 |
变量
名称 | 说明 |
---|---|
authorization_policies
|
可用于保护与 IoT 中心的连接的共享访问策略。 |
disable_local_auth
|
如果为 true,则无法使用具有 Iot 中心范围的 SAS 密钥的 SAS 令牌进行身份验证。 |
disable_device_sas
|
如果为 true,则所有设备 (包括 Edge 设备,但不包括) 作用域 SAS 密钥的模块,都不能用于身份验证。 |
disable_module_sas
|
如果为 true,则不能使用所有模块范围的 SAS 密钥进行身份验证。 |
restrict_outbound_network_access
|
如果为 true,则来自 IotHub 的出口限制为仅允许通过 allowedFqdnList 配置的 FQDN。 |
allowed_fqdn_list
|
允许的 FQDN 列表 (来自 Iot 中心的出口的完全限定域名) 。 |
public_network_access
|
是否允许来自公用网络的请求。 已知值为:“Enabled”和“Disabled”。 |
ip_filter_rules
|
IP 筛选器规则。 |
network_rule_sets
|
IotHub 的网络规则集属性。 |
min_tls_version
|
指定要对此中心支持的最低 TLS 版本。 可以设置为“1.2”,以拒绝使用低于 1.2 的 TLS 版本的客户端。 |
private_endpoint_connections
|
在此 IotHub 上创建的专用终结点连接。 |
provisioning_state
|
预配状态。 |
state
|
中心状态。 |
host_name
|
主机的名称。 |
event_hub_endpoints
|
与事件中心兼容的终结点属性。 此字典的唯一可能的键是事件。 在对 IoT 中心进行创建或更新调用时,此密钥必须存在于字典中。 |
routing
|
IoT 中心的路由相关属性。 请参阅 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging。 |
storage_endpoints
|
可在其中上传文件的 Azure 存储终结点列表。 目前只能配置一个 Azure 存储帐户,并且该帐户必须将其密钥作为$default。 指定多个存储帐户会导致引发错误。 当 enableFileUploadNotifications 属性设置为 True 时,不指定此属性的值会导致引发错误。 |
messaging_endpoints
|
文件上传通知队列的消息传送终结点属性。 |
enable_file_upload_notifications
|
如果为 True,则启用文件上传通知。 |
cloud_to_device
|
IoT 中心云到设备的消息传送属性。 |
comments
|
IoT 中心注释。 |
device_streams
|
设备流式传输 iothub 的属性。 |
features
|
为 IoT 中心启用的功能和功能。 已知值为:“None”和“DeviceManagement”。 |
encryption
|
IoT 中心的加密属性。 |
locations
|
iot 中心的主位置和辅助位置。 |
enable_data_residency
|
当设置为 true 时,此属性将启用数据驻留,从而禁用灾难恢复。 |
root_certificate
|
此属性存储根证书相关信息。 |