@azure/arm-iothub package

類別

IotHubClient

介面

ArmIdentity
ArmUserIdentity
CertificateBodyDescription	JSON 序列化的 X509 憑證。
CertificateDescription	X509 憑證。
CertificateListDescription	Certificate 物件的 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	Job Response 物件的屬性。
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 可以與 Capabilities 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 無 DeviceManagement
CertificatesCreateOrUpdateResponse	包含 createOrUpdate 作業的回應資料。
CertificatesGenerateVerificationCodeResponse	包含 generateVerificationCode 作業的回應資料。
CertificatesGetResponse	包含取得作業的回應資料。
CertificatesListByIotHubResponse	包含 listByIotHub 作業的回應資料。
CertificatesVerifyResponse	包含驗證作業的回應資料。
CreatedByType	定義 CreatedByType 的值。 KnownCreatedByType 可以與 CreatedByType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 使用者 應用程式 ManagedIdentity 金鑰
DefaultAction	定義 DefaultAction 的值。 KnownDefaultAction 可以與 DefaultAction 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 Deny 允許
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 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 未知 出口 import 備份 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 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 已啟用 Disabled
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 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 未定義 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)

.value假設反覆運算器最後一個產生 byPage ，會傳回接續權杖，以便稍後開始從該點分頁。

函式詳細資料

getContinuationToken(unknown)

.value假設反覆運算器最後一個產生 byPage ，會傳回接續權杖，以便稍後開始從該點分頁。

function getContinuationToken(page: unknown): string | undefined

參數

page

unknown

從反覆運算器存取 value IteratorResult byPage 的物件。

傳回

string | undefined

後續呼叫期間可傳入 byPage () 的接續權杖。