@azure/arm-iothub package
Klasy
| IotHubClient |
Interfejsy
| ArmIdentity | |
| ArmUserIdentity | |
| CertificateBodyDescription |
Certyfikat X509 serializowany w formacie JSON. |
| CertificateDescription |
Certyfikat X509. |
| CertificateListDescription |
Tablica serializowana w formacie JSON obiektów Certyfikat. |
| CertificateProperties |
Opis certyfikatu urzędu certyfikacji X509. |
| CertificatePropertiesWithNonce |
Opis certyfikatu urzędu certyfikacji X509, w tym problem nie wystawiony dla przepływu weryfikacjiOf-Possession. |
| CertificateVerificationDescription |
Certyfikat liści 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 obsługi komunikatów w chmurze 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. |
| EventHubConsumerGroupBodyDescription |
Grupa odbiorców usługi EventHub. |
| EventHubConsumerGroupInfo |
Właściwości obiektu EventHubConsumerGroupInfo. |
| EventHubConsumerGroupName |
Nazwa grupy odbiorców usługi EventHub. |
| EventHubConsumerGroupsListResult |
Tablica 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. Usługa IoT Hub używa tych właściwości podczas kierowania komunikatów do rezerwowego punktu końcowego. |
| FeedbackProperties |
Właściwości kolejki opinii dla komunikatów z chmury do urządzenia. |
| GroupIdInformation |
Informacje o grupie dotyczące tworzenia prywatnego punktu końcowego w usłudze IotHub |
| GroupIdInformationProperties |
Właściwości obiektu informacyjnego grupy |
| ImportDevicesRequest |
Użyj polecenia , aby podać parametry podczas żądania importu wszystkich urządzeń w centrum. |
| IotHub |
Interfejs reprezentujący IotHub. |
| IotHubCapacity |
Informacje o pojemności usługi IoT Hub. |
| 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. |
| IotHubManualFailoverHeaders |
Definiuje nagłówki dla operacji IotHub_manualFailover. |
| 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 Hub. |
| 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. |
| IotHubResourceDeleteHeaders |
Definiuje nagłówki dla operacji IotHubResource_delete. |
| 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. |
| ManagedIdentity |
Właściwości tożsamości zarządzanej. |
| 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 |
| NetworkRuleSetIpRule |
Reguła adresu IP, która ma być stosowana w ramach zestawu reguł sieci |
| NetworkRuleSetProperties |
Właściwości zestawu reguł sieciowych usługi IotHub |
| Operation |
Operacja interfejsu API REST usługi IoT Hub |
| OperationDisplay |
Obiekt reprezentujący operację. |
| OperationInputs |
Wartości wejściowe. |
| OperationListResult |
Wynik żądania wyświetlenia listy operacji usługi IoT Hub. Zawiera listę operacji i link adresu URL, aby uzyskać następny zestaw wyników. |
| Operations |
Interfejs reprezentujący operacje. |
| OperationsListNextOptionalParams |
Parametry opcjonalne. |
| OperationsListOptionalParams |
Parametry opcjonalne. |
| PrivateEndpoint |
Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego |
| PrivateEndpointConnection |
Połączenie prywatnego punktu końcowego usługi IotHub |
| PrivateEndpointConnectionProperties |
Właściwości połączenia prywatnego punktu końcowego |
| PrivateEndpointConnections |
Interfejs reprezentujący element PrivateEndpointConnections. |
| PrivateEndpointConnectionsDeleteHeaders |
Definiuje nagłówki dla operacji PrivateEndpointConnections_delete. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Parametry opcjonalne. |
| PrivateEndpointConnectionsGetOptionalParams |
Parametry opcjonalne. |
| PrivateEndpointConnectionsListOptionalParams |
Parametry opcjonalne. |
| PrivateEndpointConnectionsUpdateOptionalParams |
Parametry opcjonalne. |
| PrivateLinkResources |
Dostępne zasoby linków prywatnych dla usługi IotHub |
| PrivateLinkResourcesGetOptionalParams |
Parametry opcjonalne. |
| PrivateLinkResourcesListOptionalParams |
Parametry opcjonalne. |
| PrivateLinkResourcesOperations |
Interfejs reprezentujący element PrivateLinkResourcesOperations. |
| PrivateLinkServiceConnectionState |
Bieżący stan połączenia prywatnego punktu końcowego |
| 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, w którym wystąpił błąd trasy |
| RouteErrorRange |
Zakres błędów tras |
| RouteProperties |
Właściwości reguły routingu używanej przez centrum IoT do kierowania komunikatów do punktów końcowych. |
| RoutingCosmosDBSqlApiProperties |
Właściwości związane z punktem końcowym kontenera sql usługi Cosmos DB. |
| RoutingEndpoints |
Właściwości związane z niestandardowymi punktami końcowymi, do których centrum IoT kieruje komunikaty na podstawie reguł routingu. Dozwolone jest maksymalnie 10 niestandardowych punktów końcowych 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 routingu |
| RoutingProperties |
Właściwości związane z routingiem centrum IoT Hub. 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 bliźniaczej. 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. |
| SystemData |
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu. |
| TagsResource |
Kontener przechowujący tylko tagi dla zasobu, co umożliwia użytkownikowi aktualizowanie tagów w wystąpieniu usługi IoT Hub. |
| TestAllRoutesInput |
Dane wejściowe do testowania wszystkich tras |
| TestAllRoutesResult |
Wynik testowania wszystkich tras |
| TestRouteInput |
Dane wejściowe do testowania trasy |
| TestRouteResult |
Wynik testowania jednej trasy |
| TestRouteResultDetails |
Szczegółowy wynik testowania trasy |
| UserSubscriptionQuota |
Odpowiedź na odpowiedź na limit przydziału subskrypcji użytkownika |
| UserSubscriptionQuotaListResult |
Tablica serializowana w formacie Json odpowiedzi na limit przydziału subskrypcji użytkownika |
Aliasy typu
| AccessRights |
Definiuje wartości dla programu AccessRights. |
| AuthenticationType |
Definiuje wartości AuthenticationType. Znane wartości obsługiwane przez usługę
keyBased |
| Capabilities |
Definiuje wartości funkcji. Znane wartości obsługiwane przez usługę
Brak |
| 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. |
| CreatedByType |
Definiuje wartości createdByType. Znane wartości obsługiwane przez usługę
użytkownika |
| DefaultAction |
Definiuje wartości parametru DefaultAction. Znane wartości obsługiwane przez usługę
odmowa |
| EndpointHealthStatus |
Definiuje wartości parametru EndpointHealthStatus. Znane wartości obsługiwane przez usługę
nieznanych |
| IotHubNameUnavailabilityReason |
Definiuje wartości dla IotHubNameUnavailabilityReason. |
| IotHubReplicaRoleType |
Definiuje wartości IotHubReplicaRoleType. Znane wartości obsługiwane przez usługę
podstawowa |
| 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. Znane wartości obsługiwane przez usługę
F1 |
| IotHubSkuTier |
Definiuje wartości dla IotHubSkuTier. |
| IpFilterActionType |
Definiuje wartości typu IpFilterActionType. |
| JobStatus |
Definiuje wartości parametru JobStatus. |
| JobType |
Definiuje wartości parametru JobType. Znane wartości obsługiwane przez usługę
nieznanych |
| NetworkRuleIPAction |
Definiuje wartości networkRuleIPAction. Znane wartości obsługiwane przez usługęZezwalaj na |
| OperationsListNextResponse |
Zawiera dane odpowiedzi dla operacji listDalej. |
| OperationsListResponse |
Zawiera dane odpowiedzi dla operacji listy. |
| PrivateEndpointConnectionsDeleteResponse |
Zawiera dane odpowiedzi dla operacji usuwania. |
| PrivateEndpointConnectionsGetResponse |
Zawiera dane odpowiedzi dla operacji pobierania. |
| PrivateEndpointConnectionsListResponse |
Zawiera dane odpowiedzi dla operacji listy. |
| PrivateEndpointConnectionsUpdateResponse |
Zawiera dane odpowiedzi dla operacji aktualizacji. |
| PrivateLinkResourcesGetResponse |
Zawiera dane odpowiedzi dla operacji pobierania. |
| PrivateLinkResourcesListResponse |
Zawiera dane odpowiedzi dla operacji listy. |
| PrivateLinkServiceConnectionStatus |
Definiuje wartości parametru PrivateLinkServiceConnectionStatus. Znane wartości obsługiwane przez usługę
oczekujące |
| PublicNetworkAccess |
Definiuje wartości dla funkcji PublicNetworkAccess. Znane wartości obsługiwane przez usługę
włączone |
| ResourceIdentityType |
Definiuje wartości właściwości ResourceIdentityType. |
| ResourceProviderCommonGetSubscriptionQuotaResponse |
Zawiera dane odpowiedzi dla operacji getSubscriptionQuota. |
| RouteErrorSeverity |
Definiuje wartości routeErrorSeverity. Znane wartości obsługiwane przez usługę
błędu |
| RoutingSource |
Definiuje wartości elementu RoutingSource. Znane wartości obsługiwane przez usługęnieprawidłowy |
| RoutingStorageContainerPropertiesEncoding |
Definiuje wartości parametru RoutingStorageContainerPropertiesEncoding. Znane wartości obsługiwane przez usługę
Avro |
| TestResultStatus |
Definiuje wartości parametru TestResultStatus. Znane wartości obsługiwane przez usługę
niezdefiniowane |
Wyliczenia
| KnownAuthenticationType |
Znane wartości AuthenticationType akceptowane przez usługę. |
| KnownCapabilities |
Znane wartości Capabilities akceptowane przez usługę. |
| KnownCreatedByType |
Znane wartości CreatedByType akceptowane przez usługę. |
| KnownDefaultAction |
Znane wartości DefaultAction akceptowane przez usługę. |
| KnownEndpointHealthStatus |
Znane wartości EndpointHealthStatus akceptowane przez usługę. |
| KnownIotHubReplicaRoleType |
Znane wartości IotHubReplicaRoleType, które akceptuje usługa. |
| KnownIotHubSku |
Znane wartości IotHubSku, które akceptuje usługa. |
| KnownJobType |
Znane wartości JobType akceptowane przez usługę. |
| KnownNetworkRuleIPAction |
Znane wartości NetworkRuleIPAction, które akceptuje usługa. |
| KnownPrivateLinkServiceConnectionStatus |
Znane wartości PrivateLinkServiceConnectionStatus, które akceptuje usługa. |
| KnownPublicNetworkAccess |
Znane wartości PublicNetworkAccess akceptowane przez usługę. |
| KnownRouteErrorSeverity |
Znane wartości RouteErrorSeverity, które akceptuje usługa. |
| KnownRoutingSource |
Znane wartości RoutingSource akceptowane przez usługę. |
| KnownRoutingStorageContainerPropertiesEncoding |
Znane wartości RoutingStorageContainerPropertiesEncoding, które akceptuje usługa. |
| KnownTestResultStatus |
Znane wartości TestResultStatus akceptowane przez usługę. |
Funkcje
| get |
Biorąc pod uwagę ostatni |
Szczegóły funkcji
getContinuationToken(unknown)
Biorąc pod uwagę ostatni .value wygenerowany przez iterator byPage, 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 dostępu do value w iteratorzeResult z iteratora byPage.
Zwraca
string | undefined
Token kontynuacji, który można przekazać do elementu byPage() podczas przyszłych wywołań.