@azure/arm-iothub package

Kelas

IotHubClient

Antarmuka

ArmIdentity
ArmUserIdentity
CertificateBodyDescription	Sertifikat X509 serial JSON.
CertificateDescription	Sertifikat X509.
CertificateListDescription	Array objek Sertifikat yang diserialisasikan JSON.
CertificateProperties	Penjabaran dari Sertifikat CA X509.
CertificatePropertiesWithNonce	Deskripsi Sertifikat CA X509 termasuk tantangan nonce yang dikeluarkan untuk alur Proof-Of-Possession.
CertificateVerificationDescription	Sertifikat daun berseri JSON
CertificateWithNonceDescription	Sertifikat X509.
Certificates	Antarmuka yang mewakili Sertifikat.
CertificatesCreateOrUpdateOptionalParams	Parameter opsional.
CertificatesDeleteOptionalParams	Parameter opsional.
CertificatesGenerateVerificationCodeOptionalParams	Parameter opsional.
CertificatesGetOptionalParams	Parameter opsional.
CertificatesListByIotHubOptionalParams	Parameter opsional.
CertificatesVerifyOptionalParams	Parameter opsional.
CloudToDeviceProperties	Properti olahpesan cloud-ke-perangkat hub IoT.
EndpointHealthData	Data kesehatan untuk titik akhir
EndpointHealthDataListResult	Array objek EndpointHealthData yang diserialisasikan JSON dengan tautan berikutnya.
EnrichmentProperties	Properti pengayaan yang diterapkan hub IoT Anda ke pesan yang dikirimkan ke titik akhir.
ErrorDetails	Detail kesalahan.
EventHubConsumerGroupBodyDescription	Grup konsumen EventHub.
EventHubConsumerGroupInfo	Properti objek EventHubConsumerGroupInfo.
EventHubConsumerGroupName	Nama grup konsumen EventHub.
EventHubConsumerGroupsListResult	Array berseri JSON dari nama grup konsumen yang kompatibel dengan Event Hub dengan tautan berikutnya.
EventHubProperties	Properti titik akhir yang kompatibel dengan Pusat Aktivitas yang disediakan yang digunakan oleh hub IoT.
ExportDevicesRequest	Gunakan untuk menyediakan parameter saat meminta ekspor semua perangkat di hub IoT.
FailoverInput	Gunakan untuk menyediakan wilayah failover saat meminta Failover manual untuk hub.
FallbackRouteProperties	Properti rute fallback. IoT Hub menggunakan properti ini saat merutekan pesan ke titik akhir fallback.
FeedbackProperties	Properti antrean umpan balik untuk pesan cloud-ke-perangkat.
GroupIdInformation	Informasi grup untuk membuat titik akhir privat di IotHub
GroupIdInformationProperties	Properti untuk objek informasi grup
ImportDevicesRequest	Gunakan untuk menyediakan parameter saat meminta impor semua perangkat di hub.
IotHub	Antarmuka yang mewakili IotHub.
IotHubCapacity	IoT Hub informasi kapasitas.
IotHubClientOptionalParams	Parameter opsional.
IotHubDescription	Penjabaran dari hub IoT.
IotHubDescriptionListResult	Array objek IotHubDescription yang diserialisasikan JSON dengan tautan berikutnya.
IotHubLocationDescription	Representasi publik dari salah satu lokasi tempat sumber daya disediakan.
IotHubManualFailoverHeaders	Menentukan header untuk operasi IotHub_manualFailover.
IotHubManualFailoverOptionalParams	Parameter opsional.
IotHubNameAvailabilityInfo	Properti yang menunjukkan apakah nama hub IoT tertentu tersedia.
IotHubProperties	Properti hub IoT.
IotHubQuotaMetricInfo	Properti metrik kuota.
IotHubQuotaMetricInfoListResult	Array berseri JSON dari objek IotHubQuotaMetricInfo dengan tautan berikutnya.
IotHubResource	Antarmuka yang mewakili IotHubResource.
IotHubResourceCheckNameAvailabilityOptionalParams	Parameter opsional.
IotHubResourceCreateEventHubConsumerGroupOptionalParams	Parameter opsional.
IotHubResourceCreateOrUpdateOptionalParams	Parameter opsional.
IotHubResourceDeleteEventHubConsumerGroupOptionalParams	Parameter opsional.
IotHubResourceDeleteHeaders	Menentukan header untuk operasi IotHubResource_delete.
IotHubResourceDeleteOptionalParams	Parameter opsional.
IotHubResourceExportDevicesOptionalParams	Parameter opsional.
IotHubResourceGetEndpointHealthNextOptionalParams	Parameter opsional.
IotHubResourceGetEndpointHealthOptionalParams	Parameter opsional.
IotHubResourceGetEventHubConsumerGroupOptionalParams	Parameter opsional.
IotHubResourceGetJobOptionalParams	Parameter opsional.
IotHubResourceGetKeysForKeyNameOptionalParams	Parameter opsional.
IotHubResourceGetOptionalParams	Parameter opsional.
IotHubResourceGetQuotaMetricsNextOptionalParams	Parameter opsional.
IotHubResourceGetQuotaMetricsOptionalParams	Parameter opsional.
IotHubResourceGetStatsOptionalParams	Parameter opsional.
IotHubResourceGetValidSkusNextOptionalParams	Parameter opsional.
IotHubResourceGetValidSkusOptionalParams	Parameter opsional.
IotHubResourceImportDevicesOptionalParams	Parameter opsional.
IotHubResourceListByResourceGroupNextOptionalParams	Parameter opsional.
IotHubResourceListByResourceGroupOptionalParams	Parameter opsional.
IotHubResourceListBySubscriptionNextOptionalParams	Parameter opsional.
IotHubResourceListBySubscriptionOptionalParams	Parameter opsional.
IotHubResourceListEventHubConsumerGroupsNextOptionalParams	Parameter opsional.
IotHubResourceListEventHubConsumerGroupsOptionalParams	Parameter opsional.
IotHubResourceListJobsNextOptionalParams	Parameter opsional.
IotHubResourceListJobsOptionalParams	Parameter opsional.
IotHubResourceListKeysNextOptionalParams	Parameter opsional.
IotHubResourceListKeysOptionalParams	Parameter opsional.
IotHubResourceTestAllRoutesOptionalParams	Parameter opsional.
IotHubResourceTestRouteOptionalParams	Parameter opsional.
IotHubResourceUpdateOptionalParams	Parameter opsional.
IotHubSkuDescription	Properti SKU.
IotHubSkuDescriptionListResult	Array objek IotHubSkuDescription yang diserialisasikan JSON dengan tautan berikutnya.
IotHubSkuInfo	Informasi tentang SKU hub IoT.
IpFilterRule	Aturan filter IP untuk hub IoT.
JobResponse	Properti objek Respons Pekerjaan.
JobResponseListResult	Array objek JobResponse yang diserialisasikan JSON dengan tautan berikutnya.
ManagedIdentity	Properti identitas Terkelola.
MatchedRoute	Rute yang cocok
MessagingEndpointProperties	Properti titik akhir olahpesan yang digunakan oleh hub IoT ini.
Name	Nama jenis Iot Hub
NetworkRuleSetIpRule	Aturan IP yang akan diterapkan sebagai bagian dari Seperangkat Aturan Jaringan
NetworkRuleSetProperties	Properti Seperangkat Aturan Jaringan IotHub
Operation	IoT Hub operasi REST API
OperationDisplay	Objek yang mewakili operasi.
OperationInputs	Nilai input.
OperationListResult	Hasil permintaan untuk mencantumkan operasi IoT Hub. Ini berisi daftar operasi dan tautan URL untuk mendapatkan serangkaian hasil berikutnya.
Operations	Antarmuka yang mewakili Operasi.
OperationsListNextOptionalParams	Parameter opsional.
OperationsListOptionalParams	Parameter opsional.
PrivateEndpoint	Properti titik akhir privat dari koneksi titik akhir privat
PrivateEndpointConnection	Koneksi titik akhir privat dari IotHub
PrivateEndpointConnectionProperties	Properti koneksi titik akhir privat
PrivateEndpointConnections	Antarmuka yang mewakili PrivateEndpointConnections.
PrivateEndpointConnectionsDeleteHeaders	Menentukan header untuk operasi PrivateEndpointConnections_delete.
PrivateEndpointConnectionsDeleteOptionalParams	Parameter opsional.
PrivateEndpointConnectionsGetOptionalParams	Parameter opsional.
PrivateEndpointConnectionsListOptionalParams	Parameter opsional.
PrivateEndpointConnectionsUpdateOptionalParams	Parameter opsional.
PrivateLinkResources	Sumber daya tautan privat yang tersedia untuk IotHub
PrivateLinkResourcesGetOptionalParams	Parameter opsional.
PrivateLinkResourcesListOptionalParams	Parameter opsional.
PrivateLinkResourcesOperations	Antarmuka yang mewakili PrivateLinkResourcesOperations.
PrivateLinkServiceConnectionState	Status koneksi titik akhir privat saat ini
RegistryStatistics	Statistik registri identitas.
Resource	Properti umum sumber daya Azure.
ResourceProviderCommon	Antarmuka yang mewakili ResourceProviderCommon.
ResourceProviderCommonGetSubscriptionQuotaOptionalParams	Parameter opsional.
RouteCompilationError	Kesalahan kompilasi saat mengevaluasi rute
RouteErrorPosition	Posisi di mana kesalahan rute terjadi
RouteErrorRange	Rentang kesalahan rute
RouteProperties	Properti aturan perutean yang digunakan hub IoT Anda untuk merutekan pesan ke titik akhir.
RoutingCosmosDBSqlApiProperties	Properti yang terkait dengan titik akhir kontainer sql cosmos DB.
RoutingEndpoints	Properti yang terkait dengan titik akhir kustom tempat hub IoT Anda merutekan pesan berdasarkan aturan perutean. Maksimal 10 titik akhir kustom diizinkan di semua jenis titik akhir untuk hub berbayar dan hanya 1 titik akhir kustom yang diizinkan di semua jenis titik akhir untuk hub gratis.
RoutingEventHubProperties	Properti yang terkait dengan titik akhir pusat aktivitas.
RoutingMessage	Pesan perutean
RoutingProperties	Properti terkait perutean hub IoT. Melihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	Properti yang terkait dengan jenis titik akhir antrean bus layanan.
RoutingServiceBusTopicEndpointProperties	Properti yang terkait dengan jenis titik akhir topik bus layanan.
RoutingStorageContainerProperties	Properti yang terkait dengan titik akhir kontainer penyimpanan.
RoutingTwin	Parameter input referensi kembar. Ini adalah parameter opsional
RoutingTwinProperties
SharedAccessSignatureAuthorizationRule	Properti kebijakan akses bersama hub IoT.
SharedAccessSignatureAuthorizationRuleListResult	Daftar kebijakan akses bersama dengan tautan berikutnya.
StorageEndpointProperties	Properti titik akhir Azure Storage untuk pengunggahan file.
SystemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
TagsResource	Kontainer yang hanya menyimpan Tag untuk sumber daya, memungkinkan pengguna memperbarui tag pada instans IoT Hub.
TestAllRoutesInput	Input untuk menguji semua rute
TestAllRoutesResult	Hasil pengujian semua rute
TestRouteInput	Input untuk rute pengujian
TestRouteResult	Hasil pengujian satu rute
TestRouteResultDetails	Hasil terperinci dari pengujian rute
UserSubscriptionQuota	Respons kuota langganan pengguna
UserSubscriptionQuotaListResult	Array respons kuota langganan pengguna yang diserialisasikan Json

Alias Jenis

AccessRights	Menentukan nilai untuk AccessRights.
AuthenticationType	Menentukan nilai untuk AuthenticationType. KnownAuthenticationType dapat digunakan secara bergantian dengan AuthenticationType, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan keyBased identityBased
Capabilities	Menentukan nilai untuk Kapabilitas. KnownCapabilities dapat digunakan secara bergantian dengan Kemampuan, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Tidak ada DeviceManagement
CertificatesCreateOrUpdateResponse	Berisi data respons untuk operasi createOrUpdate.
CertificatesGenerateVerificationCodeResponse	Berisi data respons untuk operasi generateVerificationCode.
CertificatesGetResponse	Berisi data respons untuk operasi get.
CertificatesListByIotHubResponse	Berisi data respons untuk operasi listByIotHub.
CertificatesVerifyResponse	Berisi data respons untuk operasi verifikasi.
CreatedByType	Menentukan nilai untuk CreatedByType. KnownCreatedByType dapat digunakan secara bergantian dengan CreatedByType, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Pengguna Aplikasi ManagedIdentity Kunci
DefaultAction	Menentukan nilai untuk DefaultAction. KnownDefaultAction dapat digunakan secara bergantian dengan DefaultAction, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Tolak Izinkan
EndpointHealthStatus	Menentukan nilai untuk EndpointHealthStatus. KnownEndpointHealthStatus dapat digunakan secara bergantian dengan EndpointHealthStatus, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Diketahui Sehat Rusak tidak sehat mati
IotHubNameUnavailabilityReason	Menentukan nilai untuk IotHubNameUnavailabilityReason.
IotHubReplicaRoleType	Menentukan nilai untuk IotHubReplicaRoleType. KnownIotHubReplicaRoleType dapat digunakan secara bergantian dengan IotHubReplicaRoleType, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Utama Sekunder
IotHubResourceCheckNameAvailabilityResponse	Berisi data respons untuk operasi checkNameAvailability.
IotHubResourceCreateEventHubConsumerGroupResponse	Berisi data respons untuk operasi createEventHubConsumerGroup.
IotHubResourceCreateOrUpdateResponse	Berisi data respons untuk operasi createOrUpdate.
IotHubResourceDeleteResponse	Berisi data respons untuk operasi penghapusan.
IotHubResourceExportDevicesResponse	Berisi data respons untuk operasi exportDevices.
IotHubResourceGetEndpointHealthNextResponse	Berisi data respons untuk operasi getEndpointHealthNext.
IotHubResourceGetEndpointHealthResponse	Berisi data respons untuk operasi getEndpointHealth.
IotHubResourceGetEventHubConsumerGroupResponse	Berisi data respons untuk operasi getEventHubConsumerGroup.
IotHubResourceGetJobResponse	Berisi data respons untuk operasi getJob.
IotHubResourceGetKeysForKeyNameResponse	Berisi data respons untuk operasi getKeysForKeyName.
IotHubResourceGetQuotaMetricsNextResponse	Berisi data respons untuk operasi getQuotaMetricsNext.
IotHubResourceGetQuotaMetricsResponse	Berisi data respons untuk operasi getQuotaMetrics.
IotHubResourceGetResponse	Berisi data respons untuk operasi get.
IotHubResourceGetStatsResponse	Berisi data respons untuk operasi getStats.
IotHubResourceGetValidSkusNextResponse	Berisi data respons untuk operasi getValidSkusNext.
IotHubResourceGetValidSkusResponse	Berisi data respons untuk operasi getValidSkus.
IotHubResourceImportDevicesResponse	Berisi data respons untuk operasi importDevices.
IotHubResourceListByResourceGroupNextResponse	Berisi data respons untuk operasi listByResourceGroupNext.
IotHubResourceListByResourceGroupResponse	Berisi data respons untuk operasi listByResourceGroup.
IotHubResourceListBySubscriptionNextResponse	Berisi data respons untuk operasi listBySubscriptionNext.
IotHubResourceListBySubscriptionResponse	Berisi data respons untuk operasi listBySubscription.
IotHubResourceListEventHubConsumerGroupsNextResponse	Berisi data respons untuk operasi listEventHubConsumerGroupsNext.
IotHubResourceListEventHubConsumerGroupsResponse	Berisi data respons untuk operasi listEventHubConsumerGroups.
IotHubResourceListJobsNextResponse	Berisi data respons untuk operasi listJobsNext.
IotHubResourceListJobsResponse	Berisi data respons untuk operasi listJobs.
IotHubResourceListKeysNextResponse	Berisi data respons untuk operasi listKeysNext.
IotHubResourceListKeysResponse	Berisi data respons untuk operasi listKeys.
IotHubResourceTestAllRoutesResponse	Berisi data respons untuk operasi testAllRoutes.
IotHubResourceTestRouteResponse	Berisi data respons untuk operasi testRoute.
IotHubResourceUpdateResponse	Berisi data respons untuk operasi pembaruan.
IotHubScaleType	Menentukan nilai untuk IotHubScaleType.
IotHubSku	Menentukan nilai untuk IotHubSku. KnownIotHubSku dapat digunakan secara bergantian dengan IotHubSku, enum ini berisi nilai-nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan F1 S1 S2 S3 B1 B2 B3
IotHubSkuTier	Menentukan nilai untuk IotHubSkuTier.
IpFilterActionType	Menentukan nilai untuk IpFilterActionType.
JobStatus	Menentukan nilai untuk JobStatus.
JobType	Menentukan nilai untuk JobType. KnownJobType dapat digunakan secara bergantian dengan JobType, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Diketahui ekspor impor Cadangan readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice firmwareUpdate
NetworkRuleIPAction	Menentukan nilai untuk NetworkRuleIPAction. KnownNetworkRuleIPAction dapat digunakan secara bergantian dengan NetworkRuleIPAction, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Izinkan
OperationsListNextResponse	Berisi data respons untuk operasi listNext.
OperationsListResponse	Berisi data respons untuk operasi daftar.
PrivateEndpointConnectionsDeleteResponse	Berisi data respons untuk operasi penghapusan.
PrivateEndpointConnectionsGetResponse	Berisi data respons untuk operasi get.
PrivateEndpointConnectionsListResponse	Berisi data respons untuk operasi daftar.
PrivateEndpointConnectionsUpdateResponse	Berisi data respons untuk operasi pembaruan.
PrivateLinkResourcesGetResponse	Berisi data respons untuk operasi get.
PrivateLinkResourcesListResponse	Berisi data respons untuk operasi daftar.
PrivateLinkServiceConnectionStatus	Menentukan nilai untuk PrivateLinkServiceConnectionStatus. KnownPrivateLinkServiceConnectionStatus dapat digunakan secara bergantian dengan PrivateLinkServiceConnectionStatus, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Tertunda Disetujui Ditolak Terputus
PublicNetworkAccess	Menentukan nilai untuk PublicNetworkAccess. KnownPublicNetworkAccess dapat digunakan secara bergantian dengan PublicNetworkAccess, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Aktif Nonaktif
ResourceIdentityType	Menentukan nilai untuk ResourceIdentityType.
ResourceProviderCommonGetSubscriptionQuotaResponse	Berisi data respons untuk operasi getSubscriptionQuota.
RouteErrorSeverity	Menentukan nilai untuk RouteErrorSeverity. KnownRouteErrorSeverity dapat digunakan secara bergantian dengan RouteErrorSeverity, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan kesalahan warning
RoutingSource	Menentukan nilai untuk RoutingSource. KnownRoutingSource dapat digunakan secara bergantian dengan RoutingSource, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan tidak valid DeviceMessages TwinChangeEvents DeviceLifecycleEvents DeviceJobLifecycleEvents DeviceConnectionStateEvents
RoutingStorageContainerPropertiesEncoding	Menentukan nilai untuk RoutingStorageContainerPropertiesEncoding. KnownRoutingStorageContainerPropertiesEncoding dapat digunakan secara bergantian dengan RoutingStorageContainerPropertiesEncoding, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Avro AvroDeflate JSON
TestResultStatus	Menentukan nilai untuk TestResultStatus. KnownTestResultStatus dapat digunakan secara bergantian dengan TestResultStatus, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan tidak ditentukan salah true

Enum

KnownAuthenticationType	Nilai AuthenticationType yang diketahui yang diterima layanan.
KnownCapabilities	Nilai Kemampuan yang diketahui yang diterima layanan.
KnownCreatedByType	Nilai yang diketahui dari CreatedByType yang diterima layanan.
KnownDefaultAction	Nilai DefaultAction yang diketahui yang diterima layanan.
KnownEndpointHealthStatus	Nilai yang diketahui dari EndpointHealthStatus yang diterima layanan.
KnownIotHubReplicaRoleType	Nilai yang diketahui dari IotHubReplicaRoleType yang diterima layanan.
KnownIotHubSku	Nilai IotHubSku yang diketahui yang diterima layanan.
KnownJobType	Nilai JobType yang diketahui yang diterima layanan.
KnownNetworkRuleIPAction	Nilai networkRuleIPAction yang diketahui yang diterima layanan.
KnownPrivateLinkServiceConnectionStatus	Nilai yang diketahui dari PrivateLinkServiceConnectionStatus yang diterima layanan.
KnownPublicNetworkAccess	Nilai publicNetworkAccess yang diketahui yang diterima layanan.
KnownRouteErrorSeverity	Nilai yang diketahui dari RouteErrorSeverity yang diterima layanan.
KnownRoutingSource	Nilai RoutingSource yang diketahui yang diterima layanan.
KnownRoutingStorageContainerPropertiesEncoding	Nilai yang diketahui dari RoutingStorageContainerPropertiesEncoding yang diterima layanan.
KnownTestResultStatus	Nilai yang diketahui dari TestResultStatus yang diterima layanan.

Fungsi

getContinuationToken(unknown)

Mengingat yang terakhir .value diproduksi oleh iterator byPage , mengembalikan token kelanjutan yang dapat digunakan untuk memulai paging dari titik itu nanti.

Detail Fungsi

getContinuationToken(unknown)

Mengingat yang terakhir .value diproduksi oleh iterator byPage , mengembalikan token kelanjutan yang dapat digunakan untuk memulai paging dari titik itu nanti.

function getContinuationToken(page: unknown): string | undefined

Parameter

page

unknown

Objek dari mengakses value di IteratorResult dari iterator byPage .

Mengembalikan

string | undefined

Token kelanjutan yang dapat diteruskan ke byPage() selama panggilan di masa mendatang.