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

@azure/arm-iothub package

类

IotHubClient

接口

ArmIdentity
ArmUserIdentity
CertificateBodyDescription	JSON 序列化的 X509 证书。
CertificateDescription	X509 证书。
CertificateListDescription	证书对象的 JSON 序列化数组。
CertificateProperties	X509 CA 证书的说明。
CertificatePropertiesWithNonce	X509 CA 证书的说明，包括为所有权证明流颁发的质询 nonce。
CertificateVerificationDescription	JSON 序列化叶证书
CertificateWithNonceDescription	X509 证书。
Certificates	表示证书的接口。
CertificatesCreateOrUpdateOptionalParams	可选参数。
CertificatesDeleteOptionalParams	可选参数。
CertificatesGenerateVerificationCodeOptionalParams	可选参数。
CertificatesGetOptionalParams	可选参数。
CertificatesListByIotHubOptionalParams	可选参数。
CertificatesVerifyOptionalParams	可选参数。
CloudToDeviceProperties	IoT 中心云到设备的消息传送属性。
EndpointHealthData	终结点的运行状况数据
EndpointHealthDataListResult	包含下一个链接的 EndpointHealthData 对象的 JSON 序列化数组。
EnrichmentProperties	IoT 中心应用于传递到终结点的消息的扩充的属性。
ErrorDetails	错误详细信息。
EventHubConsumerGroupBodyDescription	EventHub 使用者组。
EventHubConsumerGroupInfo	EventHubConsumerGroupInfo 对象的属性。
EventHubConsumerGroupName	EventHub 使用者组名称。
EventHubConsumerGroupsListResult	包含下一个链接的事件中心兼容使用者组名称的 JSON 序列化数组。
EventHubProperties	IoT 中心使用的预配事件中心兼容终结点的属性。
ExportDevicesRequest	使用 在请求导出 IoT 中心中的所有设备时提供参数。
FailoverInput	使用 在请求手动故障转移中心时提供故障转移区域。
FallbackRouteProperties	回退路由的属性。 IoT 中心在将消息路由到回退终结点时使用这些属性。
FeedbackProperties	云到设备消息的反馈队列的属性。
GroupIdInformation	用于在 IotHub 上创建专用终结点的组信息
GroupIdInformationProperties	组信息对象的属性
ImportDevicesRequest	使用 在请求导入中心中的所有设备时提供参数。
IotHub	表示 IotHub 的接口。
IotHubCapacity	IoT 中心容量信息。
IotHubClientOptionalParams	可选参数。
IotHubDescription	IoT 中心的说明。
IotHubDescriptionListResult	包含下一个链接的 IotHubDescription 对象的 JSON 序列化数组。
IotHubLocationDescription	资源预配位置之一的公共表示形式。
IotHubManualFailoverHeaders	定义IotHub_manualFailover操作的标头。
IotHubManualFailoverOptionalParams	可选参数。
IotHubNameAvailabilityInfo	指示给定 IoT 中心名称是否可用的属性。
IotHubProperties	IoT 中心的属性。
IotHubQuotaMetricInfo	配额指标属性。
IotHubQuotaMetricInfoListResult	包含下一个链接的 IotHubQuotaMetricInfo 对象的 JSON 序列化数组。
IotHubResource	表示 IotHubResource 的接口。
IotHubResourceCheckNameAvailabilityOptionalParams	可选参数。
IotHubResourceCreateEventHubConsumerGroupOptionalParams	可选参数。
IotHubResourceCreateOrUpdateOptionalParams	可选参数。
IotHubResourceDeleteEventHubConsumerGroupOptionalParams	可选参数。
IotHubResourceDeleteHeaders	定义IotHubResource_delete操作的标头。
IotHubResourceDeleteOptionalParams	可选参数。
IotHubResourceExportDevicesOptionalParams	可选参数。
IotHubResourceGetEndpointHealthNextOptionalParams	可选参数。
IotHubResourceGetEndpointHealthOptionalParams	可选参数。
IotHubResourceGetEventHubConsumerGroupOptionalParams	可选参数。
IotHubResourceGetJobOptionalParams	可选参数。
IotHubResourceGetKeysForKeyNameOptionalParams	可选参数。
IotHubResourceGetOptionalParams	可选参数。
IotHubResourceGetQuotaMetricsNextOptionalParams	可选参数。
IotHubResourceGetQuotaMetricsOptionalParams	可选参数。
IotHubResourceGetStatsOptionalParams	可选参数。
IotHubResourceGetValidSkusNextOptionalParams	可选参数。
IotHubResourceGetValidSkusOptionalParams	可选参数。
IotHubResourceImportDevicesOptionalParams	可选参数。
IotHubResourceListByResourceGroupNextOptionalParams	可选参数。
IotHubResourceListByResourceGroupOptionalParams	可选参数。
IotHubResourceListBySubscriptionNextOptionalParams	可选参数。
IotHubResourceListBySubscriptionOptionalParams	可选参数。
IotHubResourceListEventHubConsumerGroupsNextOptionalParams	可选参数。
IotHubResourceListEventHubConsumerGroupsOptionalParams	可选参数。
IotHubResourceListJobsNextOptionalParams	可选参数。
IotHubResourceListJobsOptionalParams	可选参数。
IotHubResourceListKeysNextOptionalParams	可选参数。
IotHubResourceListKeysOptionalParams	可选参数。
IotHubResourceTestAllRoutesOptionalParams	可选参数。
IotHubResourceTestRouteOptionalParams	可选参数。
IotHubResourceUpdateOptionalParams	可选参数。
IotHubSkuDescription	SKU 属性。
IotHubSkuDescriptionListResult	包含下一个链接的 IotHubSkuDescription 对象的 JSON 序列化数组。
IotHubSkuInfo	有关 IoT 中心的 SKU 的信息。
IpFilterRule	IoT 中心的 IP 筛选器规则。
JobResponse	作业响应对象的属性。
JobResponseListResult	包含下一个链接的 JobResponse 对象的 JSON 序列化数组。
ManagedIdentity	托管标识的属性。
MatchedRoute	匹配的路由
MessagingEndpointProperties	此 IoT 中心使用的消息传送终结点的属性。
Name	IoT 中心类型的名称
NetworkRuleSetIpRule	要作为网络规则集的一部分应用的 IP 规则
NetworkRuleSetProperties	IotHub 的网络规则集属性
Operation	IoT 中心 REST API 操作
OperationDisplay	表示操作的 对象。
OperationInputs	输入值。
OperationListResult	列出IoT 中心操作的请求的结果。 它包含操作列表和用于获取下一组结果的 URL 链接。
Operations	表示操作的接口。
OperationsListNextOptionalParams	可选参数。
OperationsListOptionalParams	可选参数。
PrivateEndpoint	专用终结点连接的专用终结点属性
PrivateEndpointConnection	IotHub 的专用终结点连接
PrivateEndpointConnectionProperties	专用终结点连接的属性
PrivateEndpointConnections	表示 PrivateEndpointConnections 的接口。
PrivateEndpointConnectionsDeleteHeaders	定义PrivateEndpointConnections_delete操作的标头。
PrivateEndpointConnectionsDeleteOptionalParams	可选参数。
PrivateEndpointConnectionsGetOptionalParams	可选参数。
PrivateEndpointConnectionsListOptionalParams	可选参数。
PrivateEndpointConnectionsUpdateOptionalParams	可选参数。
PrivateLinkResources	IotHub 的可用专用链接资源
PrivateLinkResourcesGetOptionalParams	可选参数。
PrivateLinkResourcesListOptionalParams	可选参数。
PrivateLinkResourcesOperations	表示 PrivateLinkResourcesOperations 的接口。
PrivateLinkServiceConnectionState	专用终结点连接的当前状态
RegistryStatistics	标识注册表统计信息。
Resource	Azure 资源的常用属性。
ResourceProviderCommon	表示 ResourceProviderCommon 的接口。
ResourceProviderCommonGetSubscriptionQuotaOptionalParams	可选参数。
RouteCompilationError	评估路由时出现编译错误
RouteErrorPosition	发生路由错误的位置
RouteErrorRange	路由错误的范围
RouteProperties	IoT 中心用于将消息路由到终结点的路由规则的属性。
RoutingCosmosDBSqlApiProperties	与 cosmos DB sql 容器终结点相关的属性。
RoutingEndpoints	与 IoT 中心根据路由规则将消息路由到的自定义终结点相关的属性。 对于付费中心，所有终结点类型最多允许 10 个自定义终结点，免费中心的所有终结点类型中只允许 1 个自定义终结点。
RoutingEventHubProperties	与事件中心终结点相关的属性。
RoutingMessage	路由消息
RoutingProperties	IoT 中心的路由相关属性。 请参阅：https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	与服务总线队列终结点类型相关的属性。
RoutingServiceBusTopicEndpointProperties	与服务总线主题终结点类型相关的属性。
RoutingStorageContainerProperties	与存储容器终结点相关的属性。
RoutingTwin	孪生引用输入参数。 这是一个可选参数
RoutingTwinProperties
SharedAccessSignatureAuthorizationRule	IoT 中心共享访问策略的属性。
SharedAccessSignatureAuthorizationRuleListResult	包含下一个链接的共享访问策略列表。
StorageEndpointProperties	用于文件上传的 Azure 存储终结点的属性。
SystemData	与资源的创建和上次修改相关的元数据。
TagsResource	仅包含资源的标记的容器，允许用户更新 IoT 中心 实例上的标记。
TestAllRoutesInput	用于测试所有路由的输入
TestAllRoutesResult	测试所有路由的结果
TestRouteInput	测试路由的输入
TestRouteResult	测试一个路由的结果
TestRouteResultDetails	测试路由的详细结果
UserSubscriptionQuota	用户订阅配额响应
UserSubscriptionQuotaListResult	用户订阅配额响应的 Json 序列化数组

类型别名

AccessRights	定义 AccessRights 的值。
AuthenticationType	定义 AuthenticationType 的值。 KnownAuthenticationType 可与 AuthenticationType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 keyBased identityBased
Capabilities	定义“功能”的值。 KnownCapabilities 可以与功能互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 无 DeviceManagement
CertificatesCreateOrUpdateResponse	包含 createOrUpdate 操作的响应数据。
CertificatesGenerateVerificationCodeResponse	包含 generateVerificationCode 操作的响应数据。
CertificatesGetResponse	包含获取操作的响应数据。
CertificatesListByIotHubResponse	包含 listByIotHub 操作的响应数据。
CertificatesVerifyResponse	包含验证操作的响应数据。
CreatedByType	定义 CreatedByType 的值。 KnownCreatedByType 可与 CreatedByType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 用户 应用程序 ManagedIdentity 键
DefaultAction	定义 DefaultAction 的值。 KnownDefaultAction 可与 DefaultAction 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 拒绝 允许
EndpointHealthStatus	定义 EndpointHealthStatus 的值。 KnownEndpointHealthStatus 可与 EndpointHealthStatus 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 未知 健康 退化 不良 不活动
IotHubNameUnavailabilityReason	定义 IotHubNameUnavailabilityReason 的值。
IotHubReplicaRoleType	定义 IotHubReplicaRoleType 的值。 KnownIotHubReplicaRoleType 可与 IotHubReplicaRoleType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 主要 二 次
IotHubResourceCheckNameAvailabilityResponse	包含 checkNameAvailability 操作的响应数据。
IotHubResourceCreateEventHubConsumerGroupResponse	包含 createEventHubConsumerGroup 操作的响应数据。
IotHubResourceCreateOrUpdateResponse	包含 createOrUpdate 操作的响应数据。
IotHubResourceDeleteResponse	包含删除操作的响应数据。
IotHubResourceExportDevicesResponse	包含 exportDevices 操作的响应数据。
IotHubResourceGetEndpointHealthNextResponse	包含 getEndpointHealthNext 操作的响应数据。
IotHubResourceGetEndpointHealthResponse	包含 getEndpointHealth 操作的响应数据。
IotHubResourceGetEventHubConsumerGroupResponse	包含 getEventHubConsumerGroup 操作的响应数据。
IotHubResourceGetJobResponse	包含 getJob 操作的响应数据。
IotHubResourceGetKeysForKeyNameResponse	包含 getKeysForKeyName 操作的响应数据。
IotHubResourceGetQuotaMetricsNextResponse	包含 getQuotaMetricsNext 操作的响应数据。
IotHubResourceGetQuotaMetricsResponse	包含 getQuotaMetrics 操作的响应数据。
IotHubResourceGetResponse	包含获取操作的响应数据。
IotHubResourceGetStatsResponse	包含 getStats 操作的响应数据。
IotHubResourceGetValidSkusNextResponse	包含 getValidSkusNext 操作的响应数据。
IotHubResourceGetValidSkusResponse	包含 getValidSkus 操作的响应数据。
IotHubResourceImportDevicesResponse	包含 importDevices 操作的响应数据。
IotHubResourceListByResourceGroupNextResponse	包含 listByResourceGroupNext 操作的响应数据。
IotHubResourceListByResourceGroupResponse	包含 listByResourceGroup 操作的响应数据。
IotHubResourceListBySubscriptionNextResponse	包含 listBySubscriptionNext 操作的响应数据。
IotHubResourceListBySubscriptionResponse	包含 listBySubscription 操作的响应数据。
IotHubResourceListEventHubConsumerGroupsNextResponse	包含 listEventHubConsumerGroupsNext 操作的响应数据。
IotHubResourceListEventHubConsumerGroupsResponse	包含 listEventHubConsumerGroups 操作的响应数据。
IotHubResourceListJobsNextResponse	包含 listJobsNext 操作的响应数据。
IotHubResourceListJobsResponse	包含 listJobs 操作的响应数据。
IotHubResourceListKeysNextResponse	包含 listKeysNext 操作的响应数据。
IotHubResourceListKeysResponse	包含 listKeys 操作的响应数据。
IotHubResourceTestAllRoutesResponse	包含 testAllRoutes 操作的响应数据。
IotHubResourceTestRouteResponse	包含 testRoute 操作的响应数据。
IotHubResourceUpdateResponse	包含更新操作的响应数据。
IotHubScaleType	定义 IotHubScaleType 的值。
IotHubSku	定义 IotHubSku 的值。 KnownIotHubSku 可与 IotHubSku 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 F1 S1 S2 S3 B1 B2 B3
IotHubSkuTier	定义 IotHubSkuTier 的值。
IpFilterActionType	定义 IpFilterActionType 的值。
JobStatus	定义 JobStatus 的值。
JobType	定义 JobType 的值。 KnownJobType 可与 JobType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 未知 export import backup readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice firmwareUpdate
NetworkRuleIPAction	定义 NetworkRuleIPAction 的值。 KnownNetworkRuleIPAction 可与 NetworkRuleIPAction 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 允许
OperationsListNextResponse	包含 listNext 操作的响应数据。
OperationsListResponse	包含列表操作的响应数据。
PrivateEndpointConnectionsDeleteResponse	包含删除操作的响应数据。
PrivateEndpointConnectionsGetResponse	包含获取操作的响应数据。
PrivateEndpointConnectionsListResponse	包含列表操作的响应数据。
PrivateEndpointConnectionsUpdateResponse	包含更新操作的响应数据。
PrivateLinkResourcesGetResponse	包含获取操作的响应数据。
PrivateLinkResourcesListResponse	包含列表操作的响应数据。
PrivateLinkServiceConnectionStatus	定义 PrivateLinkServiceConnectionStatus 的值。 KnownPrivateLinkServiceConnectionStatus 可与 PrivateLinkServiceConnectionStatus 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 挂起 已批准 已拒绝 已断开连接
PublicNetworkAccess	定义 PublicNetworkAccess 的值。 KnownPublicNetworkAccess 可与 PublicNetworkAccess 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 已启用 已禁用
ResourceIdentityType	定义 ResourceIdentityType 的值。
ResourceProviderCommonGetSubscriptionQuotaResponse	包含 getSubscriptionQuota 操作的响应数据。
RouteErrorSeverity	定义 RouteErrorSeverity 的值。 KnownRouteErrorSeverity 可与 RouteErrorSeverity 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 error warning
RoutingSource	定义 RoutingSource 的值。 KnownRoutingSource 可与 RoutingSource 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 无效 DeviceMessages TwinChangeEvents DeviceLifecycleEvents DeviceJobLifecycleEvents DeviceConnectionStateEvents
RoutingStorageContainerPropertiesEncoding	定义 RoutingStorageContainerPropertiesEncoding 的值。 KnownRoutingStorageContainerPropertiesEncoding 可与 RoutingStorageContainerPropertiesEncoding 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 Avro AvroDeflate JSON
TestResultStatus	定义 TestResultStatus 的值。 KnownTestResultStatus 可与 TestResultStatus 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 undefined false true

枚举

KnownAuthenticationType	服务接受的 AuthenticationType 的已知值。
KnownCapabilities	服务 接受的功能的 已知值。
KnownCreatedByType	服务接受的 CreatedByType 的已知值。
KnownDefaultAction	服务接受的 DefaultAction 的已知值。
KnownEndpointHealthStatus	服务接受的 EndpointHealthStatus 的已知值。
KnownIotHubReplicaRoleType	服务接受的 IotHubReplicaRoleType 的已知值。
KnownIotHubSku	服务接受的 IotHubSku 的已知值。
KnownJobType	服务接受的 JobType 的已知值。
KnownNetworkRuleIPAction	服务接受的 NetworkRuleIPAction 的已知值。
KnownPrivateLinkServiceConnectionStatus	服务接受的 PrivateLinkServiceConnectionStatus 的已知值。
KnownPublicNetworkAccess	服务接受的 PublicNetworkAccess 的已知值。
KnownRouteErrorSeverity	服务接受的 RouteErrorSeverity 的已知值。
KnownRoutingSource	服务接受的 RoutingSource 的已知值。
KnownRoutingStorageContainerPropertiesEncoding	服务接受的 RoutingStorageContainerPropertiesEncoding 的已知值。
KnownTestResultStatus	服务接受的 TestResultStatus 的已知值。

函数

getContinuationToken(unknown)

给定迭代器生成的byPage最后.value一个，将返回一个可用于稍后从该点开始分页的延续标记。

函数详细信息

getContinuationToken(unknown)

给定迭代器生成的byPage最后.value一个，将返回一个可用于稍后从该点开始分页的延续标记。

function getContinuationToken(page: unknown): string | undefined

参数

page

unknown

从迭代器访问 value IteratorResult byPage 的对象。

返回

string | undefined

在将来调用期间可以传递到 byPage () 的延续标记。