@azure/arm-iothub package

クラス

IotHubClient

インターフェイス

ArmIdentity
ArmUserIdentity
CertificateBodyDescription	JSON でシリアル化された X509 証明書。
CertificateDescription	X509 証明書。
CertificateListDescription	Certificate オブジェクトの JSON でシリアル化された配列。
CertificateProperties	X509 CA 証明書の説明。
CertificatePropertiesWithNonce	所有証明フローに対して発行されたチャレンジ nonce を含む X509 CA 証明書の説明。
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	次のリンクを含む Event Hub と互換性のあるコンシューマー グループ名の JSON でシリアル化された配列。
EventHubProperties	IoT ハブによって使用される、プロビジョニングされた Event Hub 互換エンドポイントのプロパティ。
ExportDevicesRequest	IoT ハブ内のすべてのデバイスのエクスポートを要求するときにパラメーターを指定するには、 を使用します。
FailoverInput	ハブの手動フェールオーバーを要求するときにフェールオーバー リージョンを指定するには、 を使用します。
FallbackRouteProperties	フォールバック ルートのプロパティ。 IoT Hubは、フォールバック エンドポイントにメッセージをルーティングするときに、これらのプロパティを使用します。
FeedbackProperties	cloud-to-device メッセージのフィードバック キューのプロパティ。
GroupIdInformation	IotHub でプライベート エンドポイントを作成するためのグループ情報
GroupIdInformationProperties	グループ情報オブジェクトのプロパティ
ImportDevicesRequest	ハブ内のすべてのデバイスのインポートを要求するときにパラメーターを指定するには、 を使用します。
IotHub	IotHub を表すインターフェイス。
IotHubCapacity	容量情報をIoT Hubします。
IotHubClientOptionalParams	省略可能なパラメーター。
IotHubDescription	IoT ハブの説明。
IotHubDescriptionListResult	次のリンクを含む IotHubDescription オブジェクトの JSON でシリアル化された配列。
IotHubLocationDescription	リソースがプロビジョニングされている場所の 1 つをパブリックに表現します。
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	マネージド ID のプロパティ。
MatchedRoute	一致したルート
MessagingEndpointProperties	この IoT ハブで使用されるメッセージング エンドポイントのプロパティ。
Name	IoT ハブの種類の名前
NetworkRuleSetIpRule	ネットワーク 規則セットの一部として適用される IP 規則
NetworkRuleSetProperties	IotHub のネットワーク ルール セットプロパティ
Operation	REST API 操作のIoT Hub
OperationDisplay	操作を表す オブジェクト。
OperationInputs	入力値。
OperationListResult	IoT Hub操作を一覧表示する要求の結果。 操作の一覧と、次の結果セットを取得するための 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	ID レジストリの統計情報。
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	Service Bus キュー エンドポイントの種類に関連するプロパティ。
RoutingServiceBusTopicEndpointProperties	Service Bus トピック エンドポイントの種類に関連するプロパティ。
RoutingStorageContainerProperties	ストレージ コンテナー エンドポイントに関連するプロパティ。
RoutingTwin	ツイン参照入力パラメーター。 これは省略可能なパラメーターです
RoutingTwinProperties
SharedAccessSignatureAuthorizationRule	IoT ハブ共有アクセス ポリシーのプロパティ。
SharedAccessSignatureAuthorizationRuleListResult	次のリンクを含む共有アクセス ポリシーの一覧。
StorageEndpointProperties	ファイルアップロード用の Azure Storage エンドポイントのプロパティ。
SystemData	リソースの作成と最後の変更に関連するメタデータ。
TagsResource	リソースのタグのみを保持するコンテナー。ユーザーは、IoT Hub インスタンスのタグを更新できます。
TestAllRoutesInput	すべてのルートをテストするための入力
TestAllRoutesResult	すべてのルートをテストした結果
TestRouteInput	テスト ルートの入力
TestRouteResult	1 つのルートをテストした結果
TestRouteResultDetails	ルートをテストした詳細な結果
UserSubscriptionQuota	ユーザー サブスクリプション クォータの応答
UserSubscriptionQuotaListResult	ユーザー サブスクリプション クォータ応答の Json シリアル化配列

型エイリアス

AccessRights	AccessRights の値を定義します。
AuthenticationType	AuthenticationType の値を定義します。 KnownAuthenticationType は AuthenticationType と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 keyBased identityBased
Capabilities	機能の値を定義します。 KnownCapabilities は Capabilities と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 なし DeviceManagement
CertificatesCreateOrUpdateResponse	createOrUpdate 操作の応答データが含まれます。
CertificatesGenerateVerificationCodeResponse	generateVerificationCode 操作の応答データが含まれます。
CertificatesGetResponse	get 操作の応答データが含まれます。
CertificatesListByIotHubResponse	listByIotHub 操作の応答データが含まれます。
CertificatesVerifyResponse	検証操作の応答データが含まれます。
CreatedByType	CreatedByType の値を定義します。 KnownCreatedByType は CreatedByType と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 User Application ManagedIdentity キー
DefaultAction	DefaultAction の値を定義します。 KnownDefaultAction は DefaultAction と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 Deny 許可
EndpointHealthStatus	EndpointHealthStatus の値を定義します。 KnownEndpointHealthStatus は EndpointHealthStatus と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 未知 健康 劣化 不健康 dead
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	get 操作の応答データが含まれます。
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	get 操作の応答データが含まれます。
PrivateEndpointConnectionsListResponse	リスト操作の応答データが含まれます。
PrivateEndpointConnectionsUpdateResponse	更新操作の応答データが含まれます。
PrivateLinkResourcesGetResponse	get 操作の応答データが含まれます。
PrivateLinkResourcesListResponse	リスト操作の応答データが含まれます。
PrivateLinkServiceConnectionStatus	PrivateLinkServiceConnectionStatus の値を定義します。 KnownPrivateLinkServiceConnectionStatus は PrivateLinkServiceConnectionStatus と同じ意味で使用できます。この列挙型には、サービスでサポートされている既知の値が含まれています。 サービスでサポートされている既知の値 保留中 Approved 拒否 切断
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 と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 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

反復子から IteratorResult にアクセス value する byPage オブジェクト。

戻り値

string | undefined

今後の呼び出し中に byPage() に渡すことができる継続トークン。