@azure/arm-iothub package
Klasy
IotHubClient |
Interfejsy
ArmIdentity | |
ArmUserIdentity | |
CertificateBodyDescription |
Certyfikat X509 serializowany w formacie JSON. |
CertificateDescription |
Certyfikat X509. |
CertificateListDescription |
Tablica zserializowana w formacie JSON obiektów Certyfikat. |
CertificateProperties |
Opis certyfikatu urzędu certyfikacji X509. |
CertificatePropertiesWithNonce |
Opis certyfikatu urzędu certyfikacji X509, w tym wyzwanie, które nie zostało wystawione dla przepływu dowodu posiadania. |
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 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 stosowane przez centrum IoT 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 Hub. |
ExportDevicesRequest |
Służy do podawania parametrów 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 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 informacji o grupie |
ImportDevicesRequest |
Służy do podawania parametrów podczas żądania importu wszystkich urządzeń w centrum. |
IotHub |
Interfejs reprezentujący usługę IotHub. |
IotHubCapacity |
IoT Hub informacji 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. |
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. |
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 usługę 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, które są zgodne |
MessagingEndpointProperties |
Właściwości punktów końcowych obsługi komunikatów używanych przez to centrum IoT. |
Name |
Nazwa typu centrum Iot Hub |
NetworkRuleSetIpRule |
Reguła adresu IP, która ma być stosowana w ramach zestawu reguł sieciowych |
NetworkRuleSetProperties |
Właściwości zestawu reguł sieciowych usługi IotHub |
Operation |
operacja interfejsu API REST IoT Hub |
OperationDisplay |
Obiekt reprezentujący operację. |
OperationInputs |
Wartości wejściowe. |
OperationListResult |
Wynik żądania wyświetlania listy IoT Hub operacji. 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 linku prywatnego 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 miejsca, 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. 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. |
SystemData |
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu. |
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 accessRights. |
AuthenticationType |
Definiuje wartości authenticationType. Znane wartości obsługiwane przez usługękeyBased |
Capabilities |
Definiuje wartości dla opcji Capabilities (Możliwości). 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żytkownik |
DefaultAction |
Definiuje wartości parametru DefaultAction. Znane wartości obsługiwane przez usługęDeny |
EndpointHealthStatus |
Definiuje wartości parametru EndpointHealthStatus. Znane wartości obsługiwane przez usługęNieznany |
IotHubNameUnavailabilityReason |
Definiuje wartości dla IotHubNameUnavailabilityReason. |
IotHubReplicaRoleType |
Definiuje wartości dla IotHubReplicaRoleType. Znane wartości obsługiwane przez usługęPodstawowy |
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 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 ipFilterActionType. |
JobStatus |
Definiuje wartości parametru JobStatus. |
JobType |
Definiuje wartości JobType. Znane wartości obsługiwane przez usługęNieznany |
NetworkRuleIPAction |
Definiuje wartości dla parametru NetworkRuleIPAction. Znane wartości obsługiwane przez usługęZezwalaj |
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łączono |
ResourceIdentityType |
Definiuje wartości resourceIdentityType. |
ResourceProviderCommonGetSubscriptionQuotaResponse |
Zawiera dane odpowiedzi dla operacji getSubscriptionQuota. |
RouteErrorSeverity |
Definiuje wartości routeErrorSeverity. Znane wartości obsługiwane przez usługęBłąd |
RoutingSource |
Definiuje wartości dla elementu RoutingSource. Znane wartości obsługiwane przez usługęNieprawidłowy |
RoutingStorageContainerPropertiesEncoding |
Definiuje wartości routinguStorageContainerPropertiesEncoding. Znane wartości obsługiwane przez usługęAvro |
TestResultStatus |
Definiuje wartości dla 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 funkcji akceptowanych przez usługę. |
KnownCreatedByType |
Znane wartości CreatedByType , które akceptuje usługa. |
KnownDefaultAction |
Znane wartości DefaultAction , które akceptuje usługa. |
KnownEndpointHealthStatus |
Znane wartości EndpointHealthStatus , które akceptuje usługa. |
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 funkcji PublicNetworkAccess , które akceptuje usługa. |
KnownRouteErrorSeverity |
Znane wartości RouteErrorSeverity akceptowane przez usługę. |
KnownRoutingSource |
Znane wartości usługi RoutingSource , które akceptuje usługa. |
KnownRoutingStorageContainerPropertiesEncoding |
Znane wartości RoutingStorageContainerPropertiesEncoding , które akceptuje usługa. |
KnownTestResultStatus |
Znane wartości TestResultStatus , które akceptuje usługa. |
Funkcje
get |
Biorąc pod uwagę ostatni |
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ń.