@azure/arm-iothub package

Třídy

IotHubClient

Rozhraní

ArmIdentity
ArmUserIdentity
CertificateBodyDescription	Serializovaný certifikát X509 JSON.
CertificateDescription	Certifikát X509.
CertificateListDescription	Serializované pole JSON objektů certifikátů.
CertificateProperties	Popis certifikátu certifikační autority X509.
CertificatePropertiesWithNonce	Popis certifikátu certifikační autority X509, včetně výzvy, která není vydána pro tok ověřeníOf-Possession.
CertificateVerificationDescription	Serializovaný listový certifikát JSON
CertificateWithNonceDescription	Certifikát X509.
Certificates	Rozhraní představující certifikáty
CertificatesCreateOrUpdateOptionalParams	Volitelné parametry.
CertificatesDeleteOptionalParams	Volitelné parametry.
CertificatesGenerateVerificationCodeOptionalParams	Volitelné parametry.
CertificatesGetOptionalParams	Volitelné parametry.
CertificatesListByIotHubOptionalParams	Volitelné parametry.
CertificatesVerifyOptionalParams	Volitelné parametry.
CloudToDeviceProperties	Vlastnosti zasílání zpráv typu cloud-zařízení ve službě IoT Hub
EndpointHealthData	Data o stavu koncového bodu
EndpointHealthDataListResult	Serializované pole JSON objektů EndpointHealthData s dalším odkazem.
EnrichmentProperties	Vlastnosti obohacení, které vaše centrum IoT používá pro zprávy doručované do koncových bodů.
ErrorDetails	Podrobnosti o chybě
EventHubConsumerGroupBodyDescription	Skupina příjemců EventHubu.
EventHubConsumerGroupInfo	Vlastnosti EventHubConsumerGroupInfo objektu.
EventHubConsumerGroupName	Název skupiny příjemců EventHubu.
EventHubConsumerGroupsListResult	Serializované pole json názvů skupin příjemců kompatibilních s centrem událostí s dalším odkazem.
EventHubProperties	Vlastnosti zřízeného koncového bodu kompatibilního s centrem událostí, který používá centrum IoT.
ExportDevicesRequest	Slouží k zadání parametrů při vyžádání exportu všech zařízení v centru IoT.
FailoverInput	Slouží k poskytnutí oblasti převzetí služeb při selhání při vyžádání ručního převzetí služeb při selhání pro centrum.
FallbackRouteProperties	Vlastnosti náhradní trasy. IoT Hub tyto vlastnosti používá při směrování zpráv do záložního koncového bodu.
FeedbackProperties	Vlastnosti fronty zpětné vazby pro zprávy typu cloud-zařízení
GroupIdInformation	Informace o skupině pro vytvoření privátního koncového bodu na IotHubu
GroupIdInformationProperties	Vlastnosti informačního objektu skupiny
ImportDevicesRequest	Slouží k zadání parametrů při vyžádání importu všech zařízení v centru.
IotHub	Rozhraní představující IotHub
IotHubCapacity	Informace o kapacitě služby IoT Hub
IotHubClientOptionalParams	Volitelné parametry.
IotHubDescription	Popis centra IoT.
IotHubDescriptionListResult	Serializované pole JSON objektů IotHubDescription s dalším odkazem.
IotHubLocationDescription	Veřejná reprezentace jednoho z umístění, kde je prostředek zřízený.
IotHubManualFailoverHeaders	Definuje hlavičky pro operaci IotHub_manualFailover.
IotHubManualFailoverOptionalParams	Volitelné parametry.
IotHubNameAvailabilityInfo	Vlastnosti označující, jestli je daný název centra IoT k dispozici.
IotHubProperties	Vlastnosti ioT Hubu.
IotHubQuotaMetricInfo	Vlastnosti metrik kvót.
IotHubQuotaMetricInfoListResult	Serializované pole JSON objektů IotHubQuotaMetricInfo s dalším odkazem.
IotHubResource	Rozhraní představující IotHubResource
IotHubResourceCheckNameAvailabilityOptionalParams	Volitelné parametry.
IotHubResourceCreateEventHubConsumerGroupOptionalParams	Volitelné parametry.
IotHubResourceCreateOrUpdateOptionalParams	Volitelné parametry.
IotHubResourceDeleteEventHubConsumerGroupOptionalParams	Volitelné parametry.
IotHubResourceDeleteHeaders	Definuje hlavičky pro operaci IotHubResource_delete.
IotHubResourceDeleteOptionalParams	Volitelné parametry.
IotHubResourceExportDevicesOptionalParams	Volitelné parametry.
IotHubResourceGetEndpointHealthNextOptionalParams	Volitelné parametry.
IotHubResourceGetEndpointHealthOptionalParams	Volitelné parametry.
IotHubResourceGetEventHubConsumerGroupOptionalParams	Volitelné parametry.
IotHubResourceGetJobOptionalParams	Volitelné parametry.
IotHubResourceGetKeysForKeyNameOptionalParams	Volitelné parametry.
IotHubResourceGetOptionalParams	Volitelné parametry.
IotHubResourceGetQuotaMetricsNextOptionalParams	Volitelné parametry.
IotHubResourceGetQuotaMetricsOptionalParams	Volitelné parametry.
IotHubResourceGetStatsOptionalParams	Volitelné parametry.
IotHubResourceGetValidSkusNextOptionalParams	Volitelné parametry.
IotHubResourceGetValidSkusOptionalParams	Volitelné parametry.
IotHubResourceImportDevicesOptionalParams	Volitelné parametry.
IotHubResourceListByResourceGroupNextOptionalParams	Volitelné parametry.
IotHubResourceListByResourceGroupOptionalParams	Volitelné parametry.
IotHubResourceListBySubscriptionNextOptionalParams	Volitelné parametry.
IotHubResourceListBySubscriptionOptionalParams	Volitelné parametry.
IotHubResourceListEventHubConsumerGroupsNextOptionalParams	Volitelné parametry.
IotHubResourceListEventHubConsumerGroupsOptionalParams	Volitelné parametry.
IotHubResourceListJobsNextOptionalParams	Volitelné parametry.
IotHubResourceListJobsOptionalParams	Volitelné parametry.
IotHubResourceListKeysNextOptionalParams	Volitelné parametry.
IotHubResourceListKeysOptionalParams	Volitelné parametry.
IotHubResourceTestAllRoutesOptionalParams	Volitelné parametry.
IotHubResourceTestRouteOptionalParams	Volitelné parametry.
IotHubResourceUpdateOptionalParams	Volitelné parametry.
IotHubSkuDescription	Vlastnosti skladové položky.
IotHubSkuDescriptionListResult	Serializované pole JSON objektů IotHubSkuDescription s dalším odkazem.
IotHubSkuInfo	Informace o skladové posílce ioT Hubu.
IpFilterRule	Pravidla filtru IP adres pro centrum IoT.
JobResponse	Vlastnosti objektu Job Response.
JobResponseListResult	Serializované pole JSON objektů JobResponse s dalším odkazem.
ManagedIdentity	Vlastnosti spravované identity.
MatchedRoute	Trasy, které odpovídají
MessagingEndpointProperties	Vlastnosti koncových bodů zasílání zpráv, které používá toto centrum IoT.
Name	Název typu iot Hubu
NetworkRuleSetIpRule	Pravidlo PROTOKOLU IP, které se má použít jako součást sady pravidel sítě
NetworkRuleSetProperties	Vlastnosti sady pravidel sítě iotHubu
Operation	Operace rozhraní REST API služby IoT Hub
OperationDisplay	Objekt, který představuje operaci.
OperationInputs	Vstupní hodnoty.
OperationListResult	Výsledek požadavku na výpis operací IoT Hubu Obsahuje seznam operací a odkaz na adresu URL pro získání další sady výsledků.
Operations	Rozhraní představující operace
OperationsListNextOptionalParams	Volitelné parametry.
OperationsListOptionalParams	Volitelné parametry.
PrivateEndpoint	Vlastnost privátního koncového bodu připojení privátního koncového bodu
PrivateEndpointConnection	Připojení privátního koncového bodu IotHubu
PrivateEndpointConnectionProperties	Vlastnosti připojení privátního koncového bodu
PrivateEndpointConnections	Rozhraní představující PrivateEndpointConnections
PrivateEndpointConnectionsDeleteHeaders	Definuje hlavičky pro operaci PrivateEndpointConnections_delete.
PrivateEndpointConnectionsDeleteOptionalParams	Volitelné parametry.
PrivateEndpointConnectionsGetOptionalParams	Volitelné parametry.
PrivateEndpointConnectionsListOptionalParams	Volitelné parametry.
PrivateEndpointConnectionsUpdateOptionalParams	Volitelné parametry.
PrivateLinkResources	Dostupné prostředky privátního propojení pro IotHub
PrivateLinkResourcesGetOptionalParams	Volitelné parametry.
PrivateLinkResourcesListOptionalParams	Volitelné parametry.
PrivateLinkResourcesOperations	Rozhraní představující PrivateLinkResourcesOperations.
PrivateLinkServiceConnectionState	Aktuální stav připojení privátního koncového bodu
RegistryStatistics	Statistiky registru identit
Resource	Společné vlastnosti prostředku Azure.
ResourceProviderCommon	Rozhraní představující ResourceProviderCommon.
ResourceProviderCommonGetSubscriptionQuotaOptionalParams	Volitelné parametry.
RouteCompilationError	Chyba kompilace při vyhodnocování trasy
RouteErrorPosition	Pozice, kde došlo k chybě trasy
RouteErrorRange	Rozsah chyb tras
RouteProperties	Vlastnosti pravidla směrování, které vaše centrum IoT používá ke směrování zpráv do koncových bodů.
RoutingCosmosDBSqlApiProperties	Vlastnosti související s koncovým bodem kontejneru SQL služby Cosmos DB.
RoutingEndpoints	Vlastnosti související s vlastními koncovými body, do kterých vaše centrum IoT směruje zprávy na základě pravidel směrování. Pro placené rozbočovače je povolených maximálně 10 vlastních koncových bodů a pro bezplatná centra je povolený pouze 1 vlastní koncový bod.
RoutingEventHubProperties	Vlastnosti související s koncovým bodem centra událostí.
RoutingMessage	Směrovací zpráva
RoutingProperties	Vlastnosti související se směrováním centra IoT. Viz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	Vlastnosti související s typy koncových bodů fronty služby Service Bus.
RoutingServiceBusTopicEndpointProperties	Vlastnosti související s typy koncových bodů tématu služby Service Bus.
RoutingStorageContainerProperties	Vlastnosti související s koncovým bodem kontejneru úložiště.
RoutingTwin	Vstupní parametr odkazu dvojčete. Toto je volitelný parametr.
RoutingTwinProperties
SharedAccessSignatureAuthorizationRule	Vlastnosti zásad sdíleného přístupu služby IoT Hub.
SharedAccessSignatureAuthorizationRuleListResult	Seznam zásad sdíleného přístupu s dalším odkazem
StorageEndpointProperties	Vlastnosti koncového bodu služby Azure Storage pro nahrání souboru.
SystemData	Metadata týkající se vytvoření a poslední změny prostředku.
TagsResource	Kontejner, který obsahuje pouze značky pro prostředek, což uživateli umožňuje aktualizovat značky v instanci ioT Hubu.
TestAllRoutesInput	Vstup pro testování všech tras
TestAllRoutesResult	Výsledek testování všech tras
TestRouteInput	Vstup pro testovací trasu
TestRouteResult	Výsledek testování jedné trasy
TestRouteResultDetails	Podrobný výsledek testování trasy
UserSubscriptionQuota	Odpověď na kvótu předplatného uživatele
UserSubscriptionQuotaListResult	Serializované pole odpovědi na kvótu předplatného uživatele ve formátu Json

Aliasy typu

AccessRights	Definuje hodnoty pro AccessRights.
AuthenticationType	Definuje hodnoty pro AuthenticationType. PoleAuthenticationType lze použít zaměnitelně s AuthenticationType, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou keyBased identityBased
Capabilities	Definuje hodnoty pro možnosti. pole KnownCapabilities lze použít zaměnitelně s možnostmi, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Žádné DeviceManagement
CertificatesCreateOrUpdateResponse	Obsahuje data odpovědí pro operaci createOrUpdate.
CertificatesGenerateVerificationCodeResponse	Obsahuje data odpovědi pro operaci generateVerificationCode.
CertificatesGetResponse	Obsahuje data odpovědí pro operaci get.
CertificatesListByIotHubResponse	Obsahuje data odpovědi pro operaci listByIotHub.
CertificatesVerifyResponse	Obsahuje data odpovědí pro operaci ověření.
CreatedByType	Definuje hodnoty pro CreatedByType. PoleCreatedByType lze použít zaměnitelně s CreatedByType, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou uživatele aplikace ManagedIdentity klíč
DefaultAction	Definuje hodnoty pro DefaultAction. PoleDefaultAction lze použít zaměnitelně s DefaultAction, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Odepřít Povolit
EndpointHealthStatus	Definuje hodnoty pro EndpointHealthStatus. PoleEndpointHealthStatus lze použít zaměnitelně s EndpointHealthStatus, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou neznámých v pořádku snížený výkon není v pořádku mrtvá
IotHubNameUnavailabilityReason	Definuje hodnoty pro IotHubNameUnavailabilityReason.
IotHubReplicaRoleType	Definuje hodnoty pro IotHubReplicaRoleType. PoleIotHubReplicaRoleType lze použít zaměnitelně s IotHubReplicaRoleType, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou primární sekundární
IotHubResourceCheckNameAvailabilityResponse	Obsahuje data odpovědí pro operaci checkNameAvailability.
IotHubResourceCreateEventHubConsumerGroupResponse	Obsahuje data odpovědí pro operaci createEventHubConsumerGroup.
IotHubResourceCreateOrUpdateResponse	Obsahuje data odpovědí pro operaci createOrUpdate.
IotHubResourceDeleteResponse	Obsahuje data odpovědí pro operaci odstranění.
IotHubResourceExportDevicesResponse	Obsahuje data odpovědí pro operaci exportDevices.
IotHubResourceGetEndpointHealthNextResponse	Obsahuje data odpovědi pro operaci getEndpointHealthNext.
IotHubResourceGetEndpointHealthResponse	Obsahuje data odpovědí pro operaci getEndpointHealth.
IotHubResourceGetEventHubConsumerGroupResponse	Obsahuje data odpovědí pro operaci getEventHubConsumerGroup.
IotHubResourceGetJobResponse	Obsahuje data odpovědi pro operaci getJob.
IotHubResourceGetKeysForKeyNameResponse	Obsahuje data odpovědi pro operaci getKeysForKeyName.
IotHubResourceGetQuotaMetricsNextResponse	Obsahuje data odpovědi pro operaci getQuotaMetricsNext.
IotHubResourceGetQuotaMetricsResponse	Obsahuje data odpovědí pro operaci getQuotaMetrics.
IotHubResourceGetResponse	Obsahuje data odpovědí pro operaci get.
IotHubResourceGetStatsResponse	Obsahuje data odpovědi pro operaci getStats.
IotHubResourceGetValidSkusNextResponse	Obsahuje data odpovědi pro operaci getValidSkusNext.
IotHubResourceGetValidSkusResponse	Obsahuje data odpovědí pro operaci getValidSkus.
IotHubResourceImportDevicesResponse	Obsahuje data odpovědí pro operaci importDevices.
IotHubResourceListByResourceGroupNextResponse	Obsahuje data odpovědi pro operaci listByResourceGroupNext.
IotHubResourceListByResourceGroupResponse	Obsahuje data odpovědi pro operaci listByResourceGroup.
IotHubResourceListBySubscriptionNextResponse	Obsahuje data odpovědi pro operaci listBySubscriptionNext.
IotHubResourceListBySubscriptionResponse	Obsahuje data odpovědi pro operaci listBySubscription.
IotHubResourceListEventHubConsumerGroupsNextResponse	Obsahuje data odpovědi pro operaci listEventHubConsumerGroupsNext.
IotHubResourceListEventHubConsumerGroupsResponse	Obsahuje data odpovědí pro operaci listEventHubConsumerGroups.
IotHubResourceListJobsNextResponse	Obsahuje data odpovědi pro operaci listJobsNext.
IotHubResourceListJobsResponse	Obsahuje data odpovědí pro operaci listJobs.
IotHubResourceListKeysNextResponse	Obsahuje data odpovědi pro operaci listKeysNext.
IotHubResourceListKeysResponse	Obsahuje data odpovědí pro operaci listKeys.
IotHubResourceTestAllRoutesResponse	Obsahuje data odpovědí pro operaci testAllRoutes.
IotHubResourceTestRouteResponse	Obsahuje data odpovědí pro operaci testRoute.
IotHubResourceUpdateResponse	Obsahuje data odpovědí pro operaci aktualizace.
IotHubScaleType	Definuje hodnoty pro IotHubScaleType.
IotHubSku	Definuje hodnoty pro IotHubSku. PoleIotHubSku lze použít zaměnitelně s IotHubSku, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou F1 S1 S2 S3 B1 B2 B3
IotHubSkuTier	Definuje hodnoty pro IotHubSkuTier.
IpFilterActionType	Definuje hodnoty pro IpFilterActionType.
JobStatus	Definuje hodnoty pro JobStatus.
JobType	Definuje hodnoty pro JobType. PoleJobType lze použít zaměnitelně s JobType, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou neznámých exportu importu zálohování readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice firmwareUpdate
NetworkRuleIPAction	Definuje hodnoty pro NetworkRuleIPAction. PoleNetworkRuleIPAction lze použít zaměnitelně s NetworkRuleIPAction, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Povolit
OperationsListNextResponse	Obsahuje data odpovědi pro operaci listNext.
OperationsListResponse	Obsahuje data odpovědí pro operaci seznamu.
PrivateEndpointConnectionsDeleteResponse	Obsahuje data odpovědí pro operaci odstranění.
PrivateEndpointConnectionsGetResponse	Obsahuje data odpovědí pro operaci get.
PrivateEndpointConnectionsListResponse	Obsahuje data odpovědí pro operaci seznamu.
PrivateEndpointConnectionsUpdateResponse	Obsahuje data odpovědí pro operaci aktualizace.
PrivateLinkResourcesGetResponse	Obsahuje data odpovědí pro operaci get.
PrivateLinkResourcesListResponse	Obsahuje data odpovědí pro operaci seznamu.
PrivateLinkServiceConnectionStatus	Definuje hodnoty pro PrivateLinkServiceConnectionStatus. KnownPrivateLinkServiceConnectionStatus lze použít zaměnitelně s PrivateLinkServiceConnectionStatus, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou čekající schválené odmítnuté odpojené
PublicNetworkAccess	Definuje hodnoty pro PublicNetworkAccess. KnownPublicNetworkAccess lze použít zaměnitelně s PublicNetworkAccess, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Povoleno Zakázáno
ResourceIdentityType	Definuje hodnoty pro ResourceIdentityType.
ResourceProviderCommonGetSubscriptionQuotaResponse	Obsahuje data odpovědi pro operaci getSubscriptionQuota.
RouteErrorSeverity	Definuje hodnoty pro RouteErrorSeverity. PoleRouteErrorSeverity lze použít zaměnitelně s RouteErrorSeverity, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou chyba upozornění
RoutingSource	Definuje hodnoty pro RoutingSource. PoleRoutingSource lze použít zaměnitelně s RoutingSource, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Neplatný DeviceMessages TwinChangeEvents DeviceLifecycleEvents DeviceJobLifecycleEvents DeviceConnectionStateEvents
RoutingStorageContainerPropertiesEncoding	Definuje hodnoty pro RoutingStorageContainerPropertiesEncoding. KnownRoutingStorageContainerPropertiesEncoding lze použít zaměnitelně se RoutingStorageContainerPropertiesEncoding, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Avro AvroDeflate JSON
TestResultStatus	Definuje hodnoty pro TestResultStatus. PoleTestResultStatus lze použít zaměnitelně s TestResultStatus, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou nedefinované false true

Výčty

KnownAuthenticationType	Známé hodnoty typu AuthenticationType, které služba přijímá.
KnownCapabilities	Známé hodnoty funkcí , které služba přijímá.
KnownCreatedByType	Známé hodnoty CreatedByType, které služba přijímá.
KnownDefaultAction	Známé hodnoty DefaultAction, které služba přijímá.
KnownEndpointHealthStatus	Známé hodnoty EndpointHealthStatus, které služba přijímá.
KnownIotHubReplicaRoleType	Známé hodnoty IotHubReplicaRoleType, které služba přijímá.
KnownIotHubSku	Známé hodnoty IotHubSku, které služba přijímá.
KnownJobType	Známé hodnoty JobType, které služba přijímá.
KnownNetworkRuleIPAction	Známé hodnoty NetworkRuleIPAction, které služba přijímá.
KnownPrivateLinkServiceConnectionStatus	Známé hodnoty PrivateLinkServiceConnectionStatus, které služba přijímá.
KnownPublicNetworkAccess	Známé hodnoty PublicNetworkAccess, které služba přijímá.
KnownRouteErrorSeverity	Známé hodnoty RouteErrorSeverity, které služba přijímá.
KnownRoutingSource	Známé hodnoty RoutingSource, které služba přijímá.
KnownRoutingStorageContainerPropertiesEncoding	Známé hodnoty RoutingStorageContainerPropertiesEncoding, které služba přijímá.
KnownTestResultStatus	Známé hodnoty TestResultStatus, které služba přijímá.

Funkce

getContinuationToken(unknown)

Vzhledem k poslednímu .value vytvořenému iterátorem byPage vrátí token pokračování, který lze použít k pozdějšímu zahájení stránkování.

Podrobnosti funkce

getContinuationToken(unknown)

Vzhledem k poslednímu .value vytvořenému iterátorem byPage vrátí token pokračování, který lze použít k pozdějšímu zahájení stránkování.

function getContinuationToken(page: unknown): string | undefined

Parametry

page

unknown

Objekt z přístupu k value na IteratorResult z byPage iterátoru.

Návraty

string | undefined

Token pokračování, který lze předat do byPage() během budoucích volání.