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

Klasy

IotHubClient

Interfejsy

CertificateBodyDescription	Certyfikat X509 serializowany w formacie JSON.
CertificateDescription	Certyfikat X509.
CertificateListDescription	Tablica z serializacji JSON obiektów certyfikatu.
CertificateProperties	Opis certyfikatu urzędu certyfikacji X509.
CertificatePropertiesWithNonce	Opis certyfikatu urzędu certyfikacji X509, w tym niezwiązany z wyzwaniem wystawionym dla przepływu dowodu posiadania.
CertificateVerificationDescription	Certyfikat liścia serializowanego w formacie JSON
CertificateWithNonceDescription	Certyfikat X509.
Certificates	Interfejs reprezentujący certyfikaty.
CertificatesCreateOrUpdateOptionalParams	Parametry opcjonalne.
CertificatesDeleteOptionalParams	Parametry opcjonalne.
CertificatesGenerateVerificationCodeOptionalParams	Parametry opcjonalne.
CertificatesGetOptionalParams	Parametry opcjonalne.
CertificatesListByIotHubOptionalParams	Parametry opcjonalne.
CertificatesVerifyOptionalParams	Parametry opcjonalne.
CloudToDeviceProperties	Właściwości komunikatów z chmury do urządzenia w usłudze IoT Hub.
EndpointHealthData	Dane kondycji punktu końcowego
EndpointHealthDataListResult	Tablica serializowana w formacie JSON obiektów EndpointHealthData z następnym linkiem.
EnrichmentProperties	Właściwości wzbogacania, które centrum IoT ma zastosowanie do komunikatów dostarczanych do punktów końcowych.
ErrorDetails	Szczegóły błędu.
EventHubConsumerGroupInfo	Właściwości obiektu EventHubConsumerGroupInfo.
EventHubConsumerGroupsListResult	Tablica z serializacji JSON nazw grup odbiorców zgodnych z centrum zdarzeń z następnym linkiem.
EventHubProperties	Właściwości aprowizowanego punktu końcowego zgodnego z centrum zdarzeń używanego przez centrum IoT.
ExportDevicesRequest	Użyj polecenia , aby podać parametry podczas żądania eksportu wszystkich urządzeń w centrum IoT.
FailoverInput	Użyj polecenia , aby zapewnić region trybu failover podczas żądania ręcznego przejścia w tryb failover dla centrum.
FallbackRouteProperties	Właściwości trasy rezerwowej. IoT Hub używa tych właściwości, gdy kieruje komunikaty do rezerwowego punktu końcowego.
FeedbackProperties	Właściwości kolejki opinii dla komunikatów z chmury do urządzenia.
ImportDevicesRequest	Użyj polecenia , aby podać parametry podczas żądania zaimportowania wszystkich urządzeń w centrum.
IotHub	Interfejs reprezentujący IotHub.
IotHubCapacity	IoT Hub informacje o pojemności.
IotHubClientOptionalParams	Parametry opcjonalne.
IotHubDescription	Opis centrum IoT.
IotHubDescriptionListResult	Tablica serializowana w formacie JSON obiektów IotHubDescription z następnym linkiem.
IotHubLocationDescription	Publiczna reprezentacja jednej z lokalizacji, w których aprowizowany jest zasób.
IotHubManualFailoverOptionalParams	Parametry opcjonalne.
IotHubNameAvailabilityInfo	Właściwości wskazujące, czy dana nazwa centrum IoT jest dostępna.
IotHubProperties	Właściwości centrum IoT.
IotHubPropertiesDeviceStreams	Urządzenie przesyła strumieniowo właściwości iothub.
IotHubQuotaMetricInfo	Właściwości metryk przydziału.
IotHubQuotaMetricInfoListResult	Tablica serializowana w formacie JSON obiektów IotHubQuotaMetricInfo z następnym linkiem.
IotHubResource	Interfejs reprezentujący IotHubResource.
IotHubResourceCheckNameAvailabilityOptionalParams	Parametry opcjonalne.
IotHubResourceCreateEventHubConsumerGroupOptionalParams	Parametry opcjonalne.
IotHubResourceCreateOrUpdateOptionalParams	Parametry opcjonalne.
IotHubResourceDeleteEventHubConsumerGroupOptionalParams	Parametry opcjonalne.
IotHubResourceDeleteOptionalParams	Parametry opcjonalne.
IotHubResourceExportDevicesOptionalParams	Parametry opcjonalne.
IotHubResourceGetEndpointHealthNextOptionalParams	Parametry opcjonalne.
IotHubResourceGetEndpointHealthOptionalParams	Parametry opcjonalne.
IotHubResourceGetEventHubConsumerGroupOptionalParams	Parametry opcjonalne.
IotHubResourceGetJobOptionalParams	Parametry opcjonalne.
IotHubResourceGetKeysForKeyNameOptionalParams	Parametry opcjonalne.
IotHubResourceGetOptionalParams	Parametry opcjonalne.
IotHubResourceGetQuotaMetricsNextOptionalParams	Parametry opcjonalne.
IotHubResourceGetQuotaMetricsOptionalParams	Parametry opcjonalne.
IotHubResourceGetStatsOptionalParams	Parametry opcjonalne.
IotHubResourceGetValidSkusNextOptionalParams	Parametry opcjonalne.
IotHubResourceGetValidSkusOptionalParams	Parametry opcjonalne.
IotHubResourceImportDevicesOptionalParams	Parametry opcjonalne.
IotHubResourceListByResourceGroupNextOptionalParams	Parametry opcjonalne.
IotHubResourceListByResourceGroupOptionalParams	Parametry opcjonalne.
IotHubResourceListBySubscriptionNextOptionalParams	Parametry opcjonalne.
IotHubResourceListBySubscriptionOptionalParams	Parametry opcjonalne.
IotHubResourceListEventHubConsumerGroupsNextOptionalParams	Parametry opcjonalne.
IotHubResourceListEventHubConsumerGroupsOptionalParams	Parametry opcjonalne.
IotHubResourceListJobsNextOptionalParams	Parametry opcjonalne.
IotHubResourceListJobsOptionalParams	Parametry opcjonalne.
IotHubResourceListKeysNextOptionalParams	Parametry opcjonalne.
IotHubResourceListKeysOptionalParams	Parametry opcjonalne.
IotHubResourceTestAllRoutesOptionalParams	Parametry opcjonalne.
IotHubResourceTestRouteOptionalParams	Parametry opcjonalne.
IotHubResourceUpdateOptionalParams	Parametry opcjonalne.
IotHubSkuDescription	Właściwości jednostki SKU.
IotHubSkuDescriptionListResult	Tablica serializowana w formacie JSON obiektów IotHubSkuDescription z następnym linkiem.
IotHubSkuInfo	Informacje o jednostce SKU centrum IoT.
IpFilterRule	Reguły filtrowania adresów IP dla centrum IoT.
JobResponse	Właściwości obiektu Odpowiedź zadania.
JobResponseListResult	Tablica serializacji JSON obiektów JobResponse z następnym linkiem.
MatchedRoute	Trasy pasujące
MessagingEndpointProperties	Właściwości punktów końcowych obsługi komunikatów używanych przez to centrum IoT.
Name	Nazwa typu centrum IoT
Operation	operacja interfejsu API REST IoT Hub
OperationDisplay	Obiekt reprezentujący operację.
OperationInputs	Wartości wejściowe.
OperationListResult	Wynik żądania wyświetlenia listy operacji IoT Hub. Zawiera listę operacji i link adresu URL umożliwiający uzyskanie następnego zestawu wyników.
Operations	Interfejs reprezentujący operacje.
OperationsListNextOptionalParams	Parametry opcjonalne.
OperationsListOptionalParams	Parametry opcjonalne.
RegistryStatistics	Statystyki rejestru tożsamości.
Resource	Typowe właściwości zasobu platformy Azure.
ResourceProviderCommon	Interfejs reprezentujący element ResourceProviderCommon.
ResourceProviderCommonGetSubscriptionQuotaOptionalParams	Parametry opcjonalne.
RouteCompilationError	Błąd kompilacji podczas oceniania trasy
RouteErrorPosition	Położenie miejsca, w którym wystąpił błąd trasy
RouteErrorRange	Zakres błędów trasy
RouteProperties	Właściwości reguły routingu używanej przez centrum IoT do kierowania komunikatów do punktów końcowych.
RoutingEndpoints	Właściwości związane z niestandardowymi punktami końcowymi, do których centrum IoT kieruje komunikaty na podstawie reguł routingu. Maksymalnie 10 niestandardowych punktów końcowych jest dozwolonych we wszystkich typach punktów końcowych dla płatnych centrów, a tylko 1 niestandardowy punkt końcowy jest dozwolony we wszystkich typach punktów końcowych dla bezpłatnych centrów.
RoutingEventHubProperties	Właściwości związane z punktem końcowym centrum zdarzeń.
RoutingMessage	Komunikat rozsyłania
RoutingProperties	Właściwości powiązane z routingiem centrum IoT. Zobacz: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	Właściwości związane z typami punktów końcowych kolejki usługi Service Bus.
RoutingServiceBusTopicEndpointProperties	Właściwości związane z typami punktów końcowych tematu usługi Service Bus.
RoutingStorageContainerProperties	Właściwości związane z punktem końcowym kontenera magazynu.
RoutingTwin	Parametr wejściowy odwołania bliźniaczej reprezentacji. Jest to opcjonalny parametr
RoutingTwinProperties
SharedAccessSignatureAuthorizationRule	Właściwości zasad dostępu współdzielonego centrum IoT Hub.
SharedAccessSignatureAuthorizationRuleListResult	Lista zasad dostępu współdzielonego z następnym linkiem.
StorageEndpointProperties	Właściwości punktu końcowego usługi Azure Storage na potrzeby przekazywania plików.
TagsResource	Kontener przechowujący tylko tagi zasobu, umożliwiając użytkownikowi aktualizowanie tagów w wystąpieniu IoT Hub.
TestAllRoutesInput	Dane wejściowe do testowania wszystkich tras
TestAllRoutesResult	Wynik testowania wszystkich tras
TestRouteInput	Dane wejściowe na potrzeby testowania trasy
TestRouteResult	Wynik testowania jednej trasy
TestRouteResultDetails	Szczegółowy wynik testowania trasy
UserSubscriptionQuota	Odpowiedź na limit przydziału subskrypcji użytkownika
UserSubscriptionQuotaListResult	Tablica serializacji Json odpowiedzi limitu przydziału subskrypcji użytkownika

Aliasy typu

AccessRights	Definiuje wartości dla programu AccessRights.
Capabilities	Definiuje wartości dla opcji Możliwości. Znanecapabilities mogą być używane zamiennie z możliwościami. Ta wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Brak DeviceManagement
CertificatesCreateOrUpdateResponse	Zawiera dane odpowiedzi dla operacji createOrUpdate.
CertificatesGenerateVerificationCodeResponse	Zawiera dane odpowiedzi dla operacji generateVerificationCode.
CertificatesGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
CertificatesListByIotHubResponse	Zawiera dane odpowiedzi dla operacji listByIotHub.
CertificatesVerifyResponse	Zawiera dane odpowiedzi dla operacji weryfikacji.
EndpointHealthStatus	Definiuje wartości dla endpointHealthStatus. ZnanyendpointHealthStatus może być używany zamiennie z EndpointHealthStatus, to wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Nieznany Zdrowe Niezdrowe Martwe
IotHubNameUnavailabilityReason	Definiuje wartości IotHubNameUnavailabilityReason.
IotHubReplicaRoleType	Definiuje wartości IotHubReplicaRoleType. ZnaneIotHubReplicaRoleType można używać zamiennie z IotHubReplicaRoleType. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Podstawowy Pomocniczy
IotHubResourceCheckNameAvailabilityResponse	Zawiera dane odpowiedzi dla operacji checkNameAvailability.
IotHubResourceCreateEventHubConsumerGroupResponse	Zawiera dane odpowiedzi dla operacji createEventHubConsumerGroup.
IotHubResourceCreateOrUpdateResponse	Zawiera dane odpowiedzi dla operacji createOrUpdate.
IotHubResourceDeleteResponse	Zawiera dane odpowiedzi dla operacji usuwania.
IotHubResourceExportDevicesResponse	Zawiera dane odpowiedzi dla operacji exportDevices.
IotHubResourceGetEndpointHealthNextResponse	Zawiera dane odpowiedzi dla operacji getEndpointHealthNext.
IotHubResourceGetEndpointHealthResponse	Zawiera dane odpowiedzi dla operacji getEndpointHealth.
IotHubResourceGetEventHubConsumerGroupResponse	Zawiera dane odpowiedzi dla operacji getEventHubConsumerGroup.
IotHubResourceGetJobResponse	Zawiera dane odpowiedzi dla operacji getJob.
IotHubResourceGetKeysForKeyNameResponse	Zawiera dane odpowiedzi dla operacji getKeysForKeyName.
IotHubResourceGetQuotaMetricsNextResponse	Zawiera dane odpowiedzi dla operacji getQuotaMetricsNext.
IotHubResourceGetQuotaMetricsResponse	Zawiera dane odpowiedzi dla operacji getQuotaMetrics.
IotHubResourceGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
IotHubResourceGetStatsResponse	Zawiera dane odpowiedzi dla operacji getStats.
IotHubResourceGetValidSkusNextResponse	Zawiera dane odpowiedzi dla operacji getValidSkusNext.
IotHubResourceGetValidSkusResponse	Zawiera dane odpowiedzi dla operacji getValidSkus.
IotHubResourceImportDevicesResponse	Zawiera dane odpowiedzi dla operacji importDevices.
IotHubResourceListByResourceGroupNextResponse	Zawiera dane odpowiedzi dla operacji listByResourceGroupNext.
IotHubResourceListByResourceGroupResponse	Zawiera dane odpowiedzi dla operacji listByResourceGroup.
IotHubResourceListBySubscriptionNextResponse	Zawiera dane odpowiedzi dla operacji listBySubscriptionNext.
IotHubResourceListBySubscriptionResponse	Zawiera dane odpowiedzi dla operacji listBySubscription.
IotHubResourceListEventHubConsumerGroupsNextResponse	Zawiera dane odpowiedzi dla operacji listEventHubConsumerGroupsNext.
IotHubResourceListEventHubConsumerGroupsResponse	Zawiera dane odpowiedzi dla operacji listEventHubConsumerGroups.
IotHubResourceListJobsNextResponse	Zawiera dane odpowiedzi dla operacji listJobsNext.
IotHubResourceListJobsResponse	Zawiera dane odpowiedzi dla operacji listJobs.
IotHubResourceListKeysNextResponse	Zawiera dane odpowiedzi dla operacji listKeysNext.
IotHubResourceListKeysResponse	Zawiera dane odpowiedzi dla operacji listKeys.
IotHubResourceTestAllRoutesResponse	Zawiera dane odpowiedzi dla operacji testAllRoutes.
IotHubResourceTestRouteResponse	Zawiera dane odpowiedzi dla operacji testRoute.
IotHubResourceUpdateResponse	Zawiera dane odpowiedzi dla operacji aktualizacji.
IotHubScaleType	Definiuje wartości dla elementu IotHubScaleType.
IotHubSku	Definiuje wartości dla IotHubSku. ZnaneIotHubSku można używać zamiennie z IotHubSku. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę F1 S1 S2 S3 B1 B2 B3
IotHubSkuTier	Definiuje wartości dla IotHubSkuTier.
IpFilterActionType	Definiuje wartości typu IpFilterActionType.
JobStatus	Definiuje wartości parametru JobStatus.
JobType	Definiuje wartości parametru JobType. Typ KnownJobType może być używany zamiennie z wartością JobType. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Nieznany Eksportu Importu Kopia zapasowa readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice firmwareUpdate
OperationsListNextResponse	Zawiera dane odpowiedzi dla operacji listNext.
OperationsListResponse	Zawiera dane odpowiedzi dla operacji listy.
ResourceProviderCommonGetSubscriptionQuotaResponse	Zawiera dane odpowiedzi dla operacji getSubscriptionQuota.
RouteErrorSeverity	Definiuje wartości elementu RouteErrorSeverity. KnownRouteErrorSeverity można używać zamiennie z RouteErrorSeverity. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Błąd Ostrzeżenie
RoutingSource	Definiuje wartości dla elementu RoutingSource. Usługa KnownRoutingSource może być używana zamiennie z usługą RoutingSource. Ta wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Nieprawidłowy DeviceMessages TwinChangeEvents DeviceLifecycleEvents DeviceJobLifecycleEvents DigitalTwinChangeEvents
RoutingStorageContainerPropertiesEncoding	Definiuje wartości routinguStorageContainerPropertiesEncoding. ZnaneRoutingStorageContainerPropertiesEncoding można używać zamiennie z routingiemStorageContainerPropertiesEncoding , to wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Avro AvroDeflate JSON
TestResultStatus	Definiuje wartości dla parametru TestResultStatus. ZnanytestResultStatus może być używany zamiennie z testresultStatus, to wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Niezdefiniowane False True

Wyliczenia

KnownCapabilities	Znane wartości możliwości akceptowanych przez usługę.
KnownEndpointHealthStatus	Znane wartości EndpointHealthStatus akceptowane przez usługę.
KnownIotHubReplicaRoleType	Znane wartości IotHubReplicaRoleType akceptowane przez usługę.
KnownIotHubSku	Znane wartości IotHubSku akceptowane przez usługę.
KnownJobType	Znane wartości JobType akceptowane przez usługę.
KnownRouteErrorSeverity	Znane wartości RouteErrorSeverity akceptowane przez usługę.
KnownRoutingSource	Znane wartości elementu RoutingSource akceptowane przez usługę.
KnownRoutingStorageContainerPropertiesEncoding	Znane wartości RoutingStorageContainerPropertiesEncoding akceptowane przez usługę.
KnownTestResultStatus	Znane wartości parametru TestResultStatus akceptowane przez usługę.

Funkcje

getContinuationToken(unknown)

Biorąc pod uwagę ostatni .value wygenerowany przez byPage iterator, zwraca token kontynuacji, którego można użyć do rozpoczęcia stronicowania z tego punktu później.

Szczegóły funkcji

getContinuationToken(unknown)

Biorąc pod uwagę ostatni .value wygenerowany przez byPage iterator, zwraca token kontynuacji, którego można użyć do rozpoczęcia stronicowania z tego punktu później.

function getContinuationToken(page: unknown): string | undefined

Parametry

page

unknown

Obiekt z uzyskiwania value dostępu do iteratoraresult z iteratora byPage .

Zwraca

string | undefined

Token kontynuacji, który można przekazać do elementu byPage() podczas przyszłych wywołań.