你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
models 包
类
ArmIdentity |
ArmIdentity。 变量仅由服务器填充,发送请求时将被忽略。 |
ArmUserIdentity |
ArmUserIdentity。 变量仅由服务器填充,发送请求时将被忽略。 |
CertificateBodyDescription |
JSON 序列化的 X509 证书。 |
CertificateDescription |
X509 证书。 变量仅由服务器填充,发送请求时将被忽略。 |
CertificateListDescription |
证书对象的 JSON 序列化数组。 |
CertificateProperties |
X509 CA 证书的说明。 变量仅由服务器填充,发送请求时将被忽略。 |
CertificatePropertiesWithNonce |
X509 CA 证书的说明,包括为所有权证明流颁发的质询 nonce。 变量仅由服务器填充,发送请求时将被忽略。 |
CertificateVerificationDescription |
JSON 序列化的叶证书。 |
CertificateWithNonceDescription |
X509 证书。 变量仅由服务器填充,发送请求时将被忽略。 |
CloudToDeviceProperties |
IoT 中心云到设备的消息传送属性。 |
EncryptionPropertiesDescription |
IoT 中心的加密属性。 |
EndpointHealthData |
终结点的运行状况数据。 |
EndpointHealthDataListResult |
包含下一个链接的 EndpointHealthData 对象的 JSON 序列化数组。 变量仅由服务器填充,发送请求时将被忽略。 |
EnrichmentProperties |
IoT 中心应用于传递到终结点的消息的扩充属性。 必须填充所有必需的参数才能发送到 Azure。 |
ErrorDetails |
错误详细信息。 变量仅由服务器填充,发送请求时将被忽略。 |
EventHubConsumerGroupBodyDescription |
EventHub 使用者组。 必须填充所有必需的参数才能发送到 Azure。 |
EventHubConsumerGroupInfo |
EventHubConsumerGroupInfo 对象的属性。 变量仅由服务器填充,发送请求时将被忽略。 |
EventHubConsumerGroupName |
EventHub 使用者组名称。 必须填充所有必需的参数才能发送到 Azure。 |
EventHubConsumerGroupsListResult |
带有下一个链接的事件中心兼容使用者组名称的 JSON 序列化数组。 变量仅由服务器填充,发送请求时将被忽略。 |
EventHubProperties |
IoT 中心使用的与预配的事件中心兼容的终结点的属性。 变量仅由服务器填充,发送请求时将被忽略。 |
ExportDevicesRequest |
在请求导出 IoT 中心中的所有设备时,使用 提供参数。 必须填充所有必需的参数才能发送到 Azure。 |
FailoverInput |
在为中心请求手动故障转移时,使用 提供故障转移区域。 必须填充所有必需的参数才能发送到 Azure。 |
FallbackRouteProperties |
回退路由的属性。 IoT 中心在将消息路由到回退终结点时使用这些属性。 必须填充所有必需的参数才能发送到 Azure。 |
FeedbackProperties |
云到设备消息的反馈队列的属性。 |
GroupIdInformation |
用于在 IotHub 上创建专用终结点的组信息。 变量仅由服务器填充,发送请求时将被忽略。 必须填充所有必需的参数才能发送到 Azure。 |
GroupIdInformationProperties |
组信息对象的属性。 |
ImportDevicesRequest |
在请求导入中心中的所有设备时,使用 提供参数。 必须填充所有必需的参数才能发送到 Azure。 |
IotHubCapacity |
IoT 中心容量信息。 变量仅由服务器填充,发送请求时将被忽略。 |
IotHubDescription |
IoT 中心的说明。 变量仅由服务器填充,发送请求时将被忽略。 必须填充所有必需的参数才能发送到 Azure。 |
IotHubDescriptionListResult |
包含下一个链接的 IotHubDescription 对象的 JSON 序列化数组。 变量仅由服务器填充,发送请求时将被忽略。 |
IotHubLocationDescription |
预配资源的位置之一的公共表示形式。 |
IotHubNameAvailabilityInfo |
指示给定 IoT 中心名称是否可用的属性。 变量仅由服务器填充,发送请求时将被忽略。 |
IotHubProperties |
IoT 中心的属性。 变量仅由服务器填充,发送请求时将被忽略。 |
IotHubPropertiesDeviceStreams |
设备流式传输 iothub 的属性。 |
IotHubQuotaMetricInfo |
配额指标属性。 变量仅由服务器填充,发送请求时将被忽略。 |
IotHubQuotaMetricInfoListResult |
包含下一个链接的 IotHubQuotaMetricInfo 对象的 JSON 序列化数组。 变量仅由服务器填充,发送请求时将被忽略。 |
IotHubSkuDescription |
SKU 属性。 变量仅由服务器填充,发送请求时将被忽略。 必须填充所有必需的参数才能发送到 Azure。 |
IotHubSkuDescriptionListResult |
包含下一个链接的 IotHubSkuDescription 对象的 JSON 序列化数组。 变量仅由服务器填充,发送请求时将被忽略。 |
IotHubSkuInfo |
有关 IoT 中心的 SKU 的信息。 变量仅由服务器填充,发送请求时将被忽略。 必须填充所有必需的参数才能发送到 Azure。 |
IpFilterRule |
IoT 中心的 IP 筛选器规则。 必须填充所有必需的参数才能发送到 Azure。 |
JobResponse |
作业响应对象的属性。 变量仅由服务器填充,发送请求时将被忽略。 |
JobResponseListResult |
包含下一个链接的 JobResponse 对象的 JSON 序列化数组。 变量仅由服务器填充,发送请求时将被忽略。 |
KeyVaultKeyProperties |
KeyVault 密钥的属性。 |
ManagedIdentity |
托管标识的属性。 |
MatchedRoute |
匹配的路由。 |
MessagingEndpointProperties |
此 IoT 中心使用的消息传送终结点的属性。 |
Name |
IoT 中心类型的名称。 |
NetworkRuleSetIpRule |
要作为网络规则集的一部分应用的 IP 规则。 必须填充所有必需的参数才能发送到 Azure。 |
NetworkRuleSetProperties |
IotHub 的网络规则集属性。 必须填充所有必需的参数才能发送到 Azure。 |
Operation |
IoT 中心 REST API 操作。 变量仅由服务器填充,发送请求时将被忽略。 |
OperationDisplay |
表示操作的 对象。 变量仅由服务器填充,发送请求时将被忽略。 |
OperationInputs |
输入值。 必须填充所有必需的参数才能发送到 Azure。 |
OperationListResult |
列出IoT 中心操作的请求的结果。 它包含操作列表和用于获取下一组结果的 URL 链接。 变量仅由服务器填充,发送请求时将被忽略。 |
PrivateEndpoint |
专用终结点连接的专用终结点属性。 变量仅由服务器填充,发送请求时将被忽略。 |
PrivateEndpointConnection |
IotHub 的专用终结点连接。 变量仅由服务器填充,发送请求时将被忽略。 必须填充所有必需的参数才能发送到 Azure。 |
PrivateEndpointConnectionProperties |
专用终结点连接的属性。 必须填充所有必需的参数才能发送到 Azure。 |
PrivateLinkResources |
IotHub 的可用专用链接资源。 |
PrivateLinkServiceConnectionState |
专用终结点连接的当前状态。 必须填充所有必需的参数才能发送到 Azure。 |
RegistryStatistics |
标识注册表统计信息。 变量仅由服务器填充,发送请求时将被忽略。 |
Resource |
Azure 资源的通用属性。 变量仅由服务器填充,发送请求时将被忽略。 必须填充所有必需的参数才能发送到 Azure。 |
RootCertificateProperties |
此属性存储根证书相关信息。 变量仅由服务器填充,发送请求时将被忽略。 |
RouteCompilationError |
评估路由时出现编译错误。 |
RouteErrorPosition |
发生路由错误的位置。 |
RouteErrorRange |
路由错误的范围。 |
RouteProperties |
IoT 中心用于将消息路由到终结点的路由规则的属性。 必须填充所有必需的参数才能发送到 Azure。 |
RoutingCosmosDBSqlApiProperties |
与 cosmos DB sql 集合终结点相关的属性。 必须填充所有必需的参数才能发送到 Azure。 |
RoutingEndpoints |
与 IoT 中心基于路由规则将消息路由到的自定义终结点相关的属性。 付费中心的所有终结点类型中最多允许 10 个自定义终结点,免费中心的所有终结点类型中只允许 1 个自定义终结点。 |
RoutingEventHubProperties |
与事件中心终结点相关的属性。 必须填充所有必需的参数才能发送到 Azure。 |
RoutingMessage |
路由消息。 |
RoutingProperties |
IoT 中心的路由相关属性。 请参阅 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging。 |
RoutingServiceBusQueueEndpointProperties |
与服务总线队列终结点类型相关的属性。 必须填充所有必需的参数才能发送到 Azure。 |
RoutingServiceBusTopicEndpointProperties |
与服务总线主题终结点类型相关的属性。 必须填充所有必需的参数才能发送到 Azure。 |
RoutingStorageContainerProperties |
与存储容器终结点相关的属性。 必须填充所有必需的参数才能发送到 Azure。 |
RoutingTwin |
孪生引用输入参数。 这是一个可选参数。 |
RoutingTwinProperties |
RoutingTwinProperties。 |
SharedAccessSignatureAuthorizationRule |
IoT 中心共享访问策略的属性。 必须填充所有必需的参数才能发送到 Azure。 |
SharedAccessSignatureAuthorizationRuleListResult |
包含下一个链接的共享访问策略列表。 变量仅由服务器填充,发送请求时将被忽略。 |
StorageEndpointProperties |
用于文件上传的 Azure 存储终结点的属性。 必须填充所有必需的参数才能发送到 Azure。 |
SystemData |
与资源的创建和上次修改相关的元数据。 |
TagsResource |
仅保存资源的标记的容器,允许用户更新IoT 中心实例上的标记。 |
TestAllRoutesInput |
用于测试所有路由的输入。 |
TestAllRoutesResult |
测试所有路由的结果。 |
TestRouteInput |
测试路由的输入。 必须填充所有必需的参数才能发送到 Azure。 |
TestRouteResult |
测试一个路由的结果。 |
TestRouteResultDetails |
测试路线的详细结果。 |
UserSubscriptionQuota |
用户订阅配额响应。 |
UserSubscriptionQuotaListResult |
用户订阅配额响应的 Json 序列化数组。 变量仅由服务器填充,发送请求时将被忽略。 |
枚举
AccessRights |
分配给共享访问策略的权限。 |
AuthenticationType |
指定用于连接到存储帐户的身份验证类型。 |
Capabilities |
为 IoT 中心启用的功能和特性。 |
CreatedByType |
创建资源的标识类型。 |
DefaultAction |
网络规则集的默认操作。 |
EndpointHealthStatus |
运行状况具有以下含义。 “正常”状态显示终结点正在按预期接受消息。 “不正常”状态显示终结点未按预期接受消息,并且IoT 中心正在重试将数据发送到此终结点。 当 IoT 中心建立了最终一致的运行状况状态以后,系统会将不正常终结点的状态更新为正常。 “死”状态显示,在重试期间IoT 中心重试发送消息后,终结点不接受消息。 请参阅IoT 中心指标来识别错误并监视终结点的问题。 “未知”状态显示IoT 中心尚未与终结点建立连接。 尚未向该终结点传送任何消息,也未拒绝该终结点发送的任何消息。 |
IotHubNameUnavailabilityReason |
不可用的原因。 |
IotHubReplicaRoleType |
区域的角色可以是主要角色,也可以是辅助角色。 主要区域是 IoT 中心当前预配的区域。 次要区域是 Azure 灾难恢复 (DR) 配对区域,也是 IoT 中心可以故障转移到的区域。 |
IotHubScaleType |
已启用缩放的类型。 |
IotHubSku |
SKU 的名称。 |
IotHubSkuTier |
IoT 中心的计费层。 |
IpFilterActionType |
此规则捕获的请求的所需操作。 |
JobStatus |
作业的状态。 |
JobType |
作业的类型。 |
NetworkRuleIPAction |
IP 筛选器操作。 |
PrivateLinkServiceConnectionStatus |
专用终结点连接的状态。 |
PublicNetworkAccess |
是否允许来自公用网络的请求。 |
ResourceIdentityType |
用于资源的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。 |
RouteErrorSeverity |
路由错误的严重性。 |
RoutingSource |
要应用路由规则的源,例如 DeviceMessages。 |
RoutingStorageContainerPropertiesEncoding |
用于将消息序列化为 Blob 的编码。 支持的值为“avro”、“avrodeflate”和“JSON”。 默认值为“avro”。 |
TestResultStatus |
测试路由的结果。 |