@azure/arm-iothub package

類別

IotHubClient

介面

ArmIdentity
ArmUserIdentity
CertificateBodyDescription	JSON 串行化的 X509 憑證。
CertificateDescription	X509 憑證。
CertificateListDescription	Certificate 物件的 JSON 串行化陣列。
CertificateProperties	X509 CA 憑證的描述。
CertificatePropertiesWithNonce	X509 CA 憑證的描述，包括針對 Proof-Of-Possession 流程發出的挑戰 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	定義 Capabilities 的值。 KnownCapabilities 可以與 Capabilities 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 無 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 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 未知的 匯出 匯入 備份 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 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 錯誤 警告
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（） 的接續令牌。