@azure/arm-iothub-profile-2020-09-01-hybrid package

Třídy

IotHubClient

Rozhraní

CertificateBodyDescription	Certifikát X509 serializovaný ve formátu JSON.
CertificateDescription	Certifikát X509.
CertificateListDescription	Serializované pole JSON objektů certificate.
CertificateProperties	Popis certifikátu certifikační autority X509.
CertificatePropertiesWithNonce	Popis certifikátu certifikační autority X509 včetně výzvy vydané pro tok ověření vlastnictví.
CertificateVerificationDescription	Listový certifikát serializovaný ve formátu 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 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 rozšíření, které vaše centrum IoT použije na zprávy doručované do koncových bodů.
ErrorDetails	Podrobnosti o chybě.
EventHubConsumerGroupInfo	Vlastnosti EventHubConsumerGroupInfo objektu.
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 se službou Event Hub, který používá centrum IoT.
ExportDevicesRequest	Slouží k zadání parametrů při žádosti o export všech zařízení ve službě IoT Hub.
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í centra.
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í
ImportDevicesRequest	Slouží k zadání parametrů při žádosti o import všech zařízení v centru.
IotHub	Rozhraní představující IotHub.
IotHubCapacity	IoT Hub informace o kapacitě.
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ý.
IotHubManualFailoverOptionalParams	Volitelné parametry.
IotHubNameAvailabilityInfo	Vlastnosti označující, jestli je daný název centra IoT k dispozici.
IotHubProperties	Vlastnosti centra IoT.
IotHubPropertiesDeviceStreams	Zařízení streamuje vlastnosti iothubu.
IotHubQuotaMetricInfo	Vlastnosti metrik kvót.
IotHubQuotaMetricInfoListResult	Json-serializované pole IotHubQuotaMetricInfo objektů s dalším odkazem.
IotHubResource	Rozhraní představující IotHubResource.
IotHubResourceCheckNameAvailabilityOptionalParams	Volitelné parametry.
IotHubResourceCreateEventHubConsumerGroupOptionalParams	Volitelné parametry.
IotHubResourceCreateOrUpdateOptionalParams	Volitelné parametry.
IotHubResourceDeleteEventHubConsumerGroupOptionalParams	Volitelné parametry.
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é poři sadě IoT Hub.
IpFilterRule	Pravidla filtru IP adres pro centrum IoT.
JobResponse	Vlastnosti objektu Job Response.
JobResponseListResult	Serializované pole JSON objektů JobResponse s dalším odkazem.
MatchedRoute	Trasy, které odpovídají
MessagingEndpointProperties	Vlastnosti koncových bodů zasílání zpráv používaných tímto centrem IoT.
Name	Název typu Iot Hub
Operation	IoT Hub operace rozhraní REST API
OperationDisplay	Objekt, který představuje operaci.
OperationInputs	Vstupní hodnoty.
OperationListResult	Výsledek požadavku na výpis IoT Hub operací. Obsahuje seznam operací a odkaz url pro získání další sady výsledků.
Operations	Rozhraní představující operaci.
OperationsListNextOptionalParams	Volitelné parametry.
OperationsListOptionalParams	Volitelné parametry.
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	Umístění, 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ů.
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á centra je povolených maximálně 10 vlastních koncových bodů napříč všemi typy 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	Zpráva směrování
RoutingProperties	Vlastnosti ioT Hubu související se směrováním 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	Referenční vstupní parametr 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.
TagsResource	Kontejner, který obsahuje pouze značky prostředku, což uživateli umožňuje aktualizovat značky v instanci IoT Hub.
TestAllRoutesInput	Vstup pro testování všech tras
TestAllRoutesResult	Výsledek testování všech tras
TestRouteInput	Vstup pro testování trasy
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 JSON odpovědi na kvótu předplatného uživatele

Aliasy typu

AccessRights	Definuje hodnoty pro AccessRights.
Capabilities	Definuje hodnoty pro Schopnosti. Pole KnownCapabilities lze používat zaměnitelně s funkcemi Capabilities. Tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Žádný DeviceManagement
CertificatesCreateOrUpdateResponse	Obsahuje data odpovědi pro operaci createOrUpdate.
CertificatesGenerateVerificationCodeResponse	Obsahuje data odpovědi pro operaci generateVerificationCode.
CertificatesGetResponse	Obsahuje data odpovědi pro operaci get.
CertificatesListByIotHubResponse	Obsahuje data odpovědi pro operaci listByIotHub.
CertificatesVerifyResponse	Obsahuje data odpovědi pro operaci ověření.
EndpointHealthStatus	Definuje hodnoty pro EndpointHealthStatus. KnownEndpointHealthStatus je možné používat zaměnitelně s EndpointHealthStatus, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Neznámý Zdravé Nezdravé Mrtvý
IotHubNameUnavailabilityReason	Definuje hodnoty pro IotHubNameUnavailabilityReason.
IotHubReplicaRoleType	Definuje hodnoty pro IotHubReplicaRoleType. Pole KnownIotHubReplicaRoleType se dá zaměnit 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ědi pro operaci checkNameAvailability.
IotHubResourceCreateEventHubConsumerGroupResponse	Obsahuje data odpovědi pro operaci createEventHubConsumerGroup.
IotHubResourceCreateOrUpdateResponse	Obsahuje data odpovědi pro operaci createOrUpdate.
IotHubResourceDeleteResponse	Obsahuje data odpovědi na operaci odstranění.
IotHubResourceExportDevicesResponse	Obsahuje data odpovědi pro operaci exportDevices.
IotHubResourceGetEndpointHealthNextResponse	Obsahuje data odpovědi pro operaci getEndpointHealthNext.
IotHubResourceGetEndpointHealthResponse	Obsahuje data odpovědi pro operaci getEndpointHealth.
IotHubResourceGetEventHubConsumerGroupResponse	Obsahuje data odpovědi 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ědi pro operaci getQuotaMetrics.
IotHubResourceGetResponse	Obsahuje data odpovědi pro operaci get.
IotHubResourceGetStatsResponse	Obsahuje data odpovědi pro operaci getStats.
IotHubResourceGetValidSkusNextResponse	Obsahuje data odpovědi pro operaci getValidSkusNext.
IotHubResourceGetValidSkusResponse	Obsahuje data odpovědi pro operaci getValidSkus.
IotHubResourceImportDevicesResponse	Obsahuje data odpovědi 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ědi pro operaci listEventHubConsumerGroups.
IotHubResourceListJobsNextResponse	Obsahuje data odpovědi pro operaci listJobsNext.
IotHubResourceListJobsResponse	Obsahuje data odpovědi pro operaci listJobs.
IotHubResourceListKeysNextResponse	Obsahuje data odpovědi pro operaci listKeysNext.
IotHubResourceListKeysResponse	Obsahuje data odpovědi pro operaci listKeys.
IotHubResourceTestAllRoutesResponse	Obsahuje data odpovědi pro operaci testAllRoutes.
IotHubResourceTestRouteResponse	Obsahuje data odpovědí pro operaci testRoute.
IotHubResourceUpdateResponse	Obsahuje data odpovědi pro operaci aktualizace.
IotHubScaleType	Definuje hodnoty pro IotHubScaleType.
IotHubSku	Definuje hodnoty pro IotHubSku. KnownIotHubSku je možné používat 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. Pole KnownJobType 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ý Vývozní Import Zálohování readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice firmwareUpdate
OperationsListNextResponse	Obsahuje data odpovědi pro operaci listNext.
OperationsListResponse	Obsahuje data odpovědi pro operaci seznamu.
ResourceProviderCommonGetSubscriptionQuotaResponse	Obsahuje data odpovědi pro operaci getSubscriptionQuota.
RouteErrorSeverity	Definuje hodnoty pro RouteErrorSeverity. Pole KnownRouteErrorSeverity 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. Pole KnownRoutingSource je možné používat zaměnitelně se službou RoutingSource. Tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Neplatný DeviceMessages TwinChangeEvents DeviceLifecycleEvents DeviceJobLifecycleEvents DigitalTwinChangeEvents
RoutingStorageContainerPropertiesEncoding	Definuje hodnoty pro RoutingStorageContainerPropertiesEncoding. KnownRoutingStorageContainerPropertiesEncoding lze použít zaměnitelně s 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. KnownTestResultStatus 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 Pravda

Výčty

KnownCapabilities	Známé hodnoty schopností , 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á.
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)

Na základě posledního .value vygenerovaného byPage iterátorem vrátí token pokračování, který lze použít k zahájení stránkování od tohoto okamžiku později.

Podrobnosti funkce

getContinuationToken(unknown)

Na základě posledního .value vygenerovaného byPage iterátorem vrátí token pokračování, který lze použít k zahájení stránkování od tohoto okamžiku později.

function getContinuationToken(page: unknown): string | undefined

Parametry

page

unknown

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

Návraty

string | undefined

Token pokračování, který může být předán do byPage() během budoucích volání.