@azure/arm-iothub-profile-2020-09-01-hybrid package
Classes
IotHubClient |
Interfaces
CertificateBodyDescription |
The JSON-serialized X509 Certificate. |
CertificateDescription |
The X509 Certificate. |
CertificateListDescription |
The JSON-serialized array of Certificate objects. |
CertificateProperties |
The description of an X509 CA Certificate. |
CertificatePropertiesWithNonce |
The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow. |
CertificateVerificationDescription |
The JSON-serialized leaf certificate |
CertificateWithNonceDescription |
The X509 Certificate. |
Certificates |
Interface representing a Certificates. |
CertificatesCreateOrUpdateOptionalParams |
Optional parameters. |
CertificatesDeleteOptionalParams |
Optional parameters. |
CertificatesGenerateVerificationCodeOptionalParams |
Optional parameters. |
CertificatesGetOptionalParams |
Optional parameters. |
CertificatesListByIotHubOptionalParams |
Optional parameters. |
CertificatesVerifyOptionalParams |
Optional parameters. |
CloudToDeviceProperties |
The IoT hub cloud-to-device messaging properties. |
EndpointHealthData |
The health data for an endpoint |
EndpointHealthDataListResult |
The JSON-serialized array of EndpointHealthData objects with a next link. |
EnrichmentProperties |
The properties of an enrichment that your IoT hub applies to messages delivered to endpoints. |
ErrorDetails |
Error details. |
EventHubConsumerGroupInfo |
The properties of the EventHubConsumerGroupInfo object. |
EventHubConsumerGroupsListResult |
The JSON-serialized array of Event Hub-compatible consumer group names with a next link. |
EventHubProperties |
The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub. |
ExportDevicesRequest |
Use to provide parameters when requesting an export of all devices in the IoT hub. |
FailoverInput |
Use to provide failover region when requesting manual Failover for a hub. |
FallbackRouteProperties |
The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. |
FeedbackProperties |
The properties of the feedback queue for cloud-to-device messages. |
ImportDevicesRequest |
Use to provide parameters when requesting an import of all devices in the hub. |
IotHub |
Interface representing a IotHub. |
IotHubCapacity |
IoT Hub capacity information. |
IotHubClientOptionalParams |
Optional parameters. |
IotHubDescription |
The description of the IoT hub. |
IotHubDescriptionListResult |
The JSON-serialized array of IotHubDescription objects with a next link. |
IotHubLocationDescription |
Public representation of one of the locations where a resource is provisioned. |
IotHubManualFailoverOptionalParams |
Optional parameters. |
IotHubNameAvailabilityInfo |
The properties indicating whether a given IoT hub name is available. |
IotHubProperties |
The properties of an IoT hub. |
IotHubPropertiesDeviceStreams |
The device streams properties of iothub. |
IotHubQuotaMetricInfo |
Quota metrics properties. |
IotHubQuotaMetricInfoListResult |
The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link. |
IotHubResource |
Interface representing a IotHubResource. |
IotHubResourceCheckNameAvailabilityOptionalParams |
Optional parameters. |
IotHubResourceCreateEventHubConsumerGroupOptionalParams |
Optional parameters. |
IotHubResourceCreateOrUpdateOptionalParams |
Optional parameters. |
IotHubResourceDeleteEventHubConsumerGroupOptionalParams |
Optional parameters. |
IotHubResourceDeleteOptionalParams |
Optional parameters. |
IotHubResourceExportDevicesOptionalParams |
Optional parameters. |
IotHubResourceGetEndpointHealthNextOptionalParams |
Optional parameters. |
IotHubResourceGetEndpointHealthOptionalParams |
Optional parameters. |
IotHubResourceGetEventHubConsumerGroupOptionalParams |
Optional parameters. |
IotHubResourceGetJobOptionalParams |
Optional parameters. |
IotHubResourceGetKeysForKeyNameOptionalParams |
Optional parameters. |
IotHubResourceGetOptionalParams |
Optional parameters. |
IotHubResourceGetQuotaMetricsNextOptionalParams |
Optional parameters. |
IotHubResourceGetQuotaMetricsOptionalParams |
Optional parameters. |
IotHubResourceGetStatsOptionalParams |
Optional parameters. |
IotHubResourceGetValidSkusNextOptionalParams |
Optional parameters. |
IotHubResourceGetValidSkusOptionalParams |
Optional parameters. |
IotHubResourceImportDevicesOptionalParams |
Optional parameters. |
IotHubResourceListByResourceGroupNextOptionalParams |
Optional parameters. |
IotHubResourceListByResourceGroupOptionalParams |
Optional parameters. |
IotHubResourceListBySubscriptionNextOptionalParams |
Optional parameters. |
IotHubResourceListBySubscriptionOptionalParams |
Optional parameters. |
IotHubResourceListEventHubConsumerGroupsNextOptionalParams |
Optional parameters. |
IotHubResourceListEventHubConsumerGroupsOptionalParams |
Optional parameters. |
IotHubResourceListJobsNextOptionalParams |
Optional parameters. |
IotHubResourceListJobsOptionalParams |
Optional parameters. |
IotHubResourceListKeysNextOptionalParams |
Optional parameters. |
IotHubResourceListKeysOptionalParams |
Optional parameters. |
IotHubResourceTestAllRoutesOptionalParams |
Optional parameters. |
IotHubResourceTestRouteOptionalParams |
Optional parameters. |
IotHubResourceUpdateOptionalParams |
Optional parameters. |
IotHubSkuDescription |
SKU properties. |
IotHubSkuDescriptionListResult |
The JSON-serialized array of IotHubSkuDescription objects with a next link. |
IotHubSkuInfo |
Information about the SKU of the IoT hub. |
IpFilterRule |
The IP filter rules for the IoT hub. |
JobResponse |
The properties of the Job Response object. |
JobResponseListResult |
The JSON-serialized array of JobResponse objects with a next link. |
MatchedRoute |
Routes that matched |
MessagingEndpointProperties |
The properties of the messaging endpoints used by this IoT hub. |
Name |
Name of Iot Hub type |
Operation |
IoT Hub REST API operation |
OperationDisplay |
The object that represents the operation. |
OperationInputs |
Input values. |
OperationListResult |
Result of the request to list IoT Hub operations. It contains a list of operations and a URL link to get the next set of results. |
Operations |
Interface representing a Operations. |
OperationsListNextOptionalParams |
Optional parameters. |
OperationsListOptionalParams |
Optional parameters. |
RegistryStatistics |
Identity registry statistics. |
Resource |
The common properties of an Azure resource. |
ResourceProviderCommon |
Interface representing a ResourceProviderCommon. |
ResourceProviderCommonGetSubscriptionQuotaOptionalParams |
Optional parameters. |
RouteCompilationError |
Compilation error when evaluating route |
RouteErrorPosition |
Position where the route error happened |
RouteErrorRange |
Range of route errors |
RouteProperties |
The properties of a routing rule that your IoT hub uses to route messages to endpoints. |
RoutingEndpoints |
The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. |
RoutingEventHubProperties |
The properties related to an event hub endpoint. |
RoutingMessage |
Routing message |
RoutingProperties |
The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
RoutingServiceBusQueueEndpointProperties |
The properties related to service bus queue endpoint types. |
RoutingServiceBusTopicEndpointProperties |
The properties related to service bus topic endpoint types. |
RoutingStorageContainerProperties |
The properties related to a storage container endpoint. |
RoutingTwin |
Twin reference input parameter. This is an optional parameter |
RoutingTwinProperties | |
SharedAccessSignatureAuthorizationRule |
The properties of an IoT hub shared access policy. |
SharedAccessSignatureAuthorizationRuleListResult |
The list of shared access policies with a next link. |
StorageEndpointProperties |
The properties of the Azure Storage endpoint for file upload. |
TagsResource |
A container holding only the Tags for a resource, allowing the user to update the tags on an IoT Hub instance. |
TestAllRoutesInput |
Input for testing all routes |
TestAllRoutesResult |
Result of testing all routes |
TestRouteInput |
Input for testing route |
TestRouteResult |
Result of testing one route |
TestRouteResultDetails |
Detailed result of testing a route |
UserSubscriptionQuota |
User subscription quota response |
UserSubscriptionQuotaListResult |
Json-serialized array of User subscription quota response |
Type Aliases
AccessRights |
Defines values for AccessRights. |
Capabilities |
Defines values for Capabilities. Known values supported by the serviceNone |
CertificatesCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
CertificatesGenerateVerificationCodeResponse |
Contains response data for the generateVerificationCode operation. |
CertificatesGetResponse |
Contains response data for the get operation. |
CertificatesListByIotHubResponse |
Contains response data for the listByIotHub operation. |
CertificatesVerifyResponse |
Contains response data for the verify operation. |
EndpointHealthStatus |
Defines values for EndpointHealthStatus. Known values supported by the serviceunknown |
IotHubNameUnavailabilityReason |
Defines values for IotHubNameUnavailabilityReason. |
IotHubReplicaRoleType |
Defines values for IotHubReplicaRoleType. Known values supported by the serviceprimary |
IotHubResourceCheckNameAvailabilityResponse |
Contains response data for the checkNameAvailability operation. |
IotHubResourceCreateEventHubConsumerGroupResponse |
Contains response data for the createEventHubConsumerGroup operation. |
IotHubResourceCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
IotHubResourceDeleteResponse |
Contains response data for the delete operation. |
IotHubResourceExportDevicesResponse |
Contains response data for the exportDevices operation. |
IotHubResourceGetEndpointHealthNextResponse |
Contains response data for the getEndpointHealthNext operation. |
IotHubResourceGetEndpointHealthResponse |
Contains response data for the getEndpointHealth operation. |
IotHubResourceGetEventHubConsumerGroupResponse |
Contains response data for the getEventHubConsumerGroup operation. |
IotHubResourceGetJobResponse |
Contains response data for the getJob operation. |
IotHubResourceGetKeysForKeyNameResponse |
Contains response data for the getKeysForKeyName operation. |
IotHubResourceGetQuotaMetricsNextResponse |
Contains response data for the getQuotaMetricsNext operation. |
IotHubResourceGetQuotaMetricsResponse |
Contains response data for the getQuotaMetrics operation. |
IotHubResourceGetResponse |
Contains response data for the get operation. |
IotHubResourceGetStatsResponse |
Contains response data for the getStats operation. |
IotHubResourceGetValidSkusNextResponse |
Contains response data for the getValidSkusNext operation. |
IotHubResourceGetValidSkusResponse |
Contains response data for the getValidSkus operation. |
IotHubResourceImportDevicesResponse |
Contains response data for the importDevices operation. |
IotHubResourceListByResourceGroupNextResponse |
Contains response data for the listByResourceGroupNext operation. |
IotHubResourceListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
IotHubResourceListBySubscriptionNextResponse |
Contains response data for the listBySubscriptionNext operation. |
IotHubResourceListBySubscriptionResponse |
Contains response data for the listBySubscription operation. |
IotHubResourceListEventHubConsumerGroupsNextResponse |
Contains response data for the listEventHubConsumerGroupsNext operation. |
IotHubResourceListEventHubConsumerGroupsResponse |
Contains response data for the listEventHubConsumerGroups operation. |
IotHubResourceListJobsNextResponse |
Contains response data for the listJobsNext operation. |
IotHubResourceListJobsResponse |
Contains response data for the listJobs operation. |
IotHubResourceListKeysNextResponse |
Contains response data for the listKeysNext operation. |
IotHubResourceListKeysResponse |
Contains response data for the listKeys operation. |
IotHubResourceTestAllRoutesResponse |
Contains response data for the testAllRoutes operation. |
IotHubResourceTestRouteResponse |
Contains response data for the testRoute operation. |
IotHubResourceUpdateResponse |
Contains response data for the update operation. |
IotHubScaleType |
Defines values for IotHubScaleType. |
IotHubSku |
Defines values for IotHubSku. Known values supported by the serviceF1 |
IotHubSkuTier |
Defines values for IotHubSkuTier. |
IpFilterActionType |
Defines values for IpFilterActionType. |
JobStatus |
Defines values for JobStatus. |
JobType |
Defines values for JobType. Known values supported by the serviceunknown |
OperationsListNextResponse |
Contains response data for the listNext operation. |
OperationsListResponse |
Contains response data for the list operation. |
ResourceProviderCommonGetSubscriptionQuotaResponse |
Contains response data for the getSubscriptionQuota operation. |
RouteErrorSeverity |
Defines values for RouteErrorSeverity. Known values supported by the serviceerror |
RoutingSource |
Defines values for RoutingSource. Known values supported by the serviceInvalid |
RoutingStorageContainerPropertiesEncoding |
Defines values for RoutingStorageContainerPropertiesEncoding. Known values supported by the serviceAvro |
TestResultStatus |
Defines values for TestResultStatus. Known values supported by the serviceundefined |
Enums
KnownCapabilities |
Known values of Capabilities that the service accepts. |
KnownEndpointHealthStatus |
Known values of EndpointHealthStatus that the service accepts. |
KnownIotHubReplicaRoleType |
Known values of IotHubReplicaRoleType that the service accepts. |
KnownIotHubSku |
Known values of IotHubSku that the service accepts. |
KnownJobType |
Known values of JobType that the service accepts. |
KnownRouteErrorSeverity |
Known values of RouteErrorSeverity that the service accepts. |
KnownRoutingSource |
Known values of RoutingSource that the service accepts. |
KnownRoutingStorageContainerPropertiesEncoding |
Known values of RoutingStorageContainerPropertiesEncoding that the service accepts. |
KnownTestResultStatus |
Known values of TestResultStatus that the service accepts. |
Functions
get |
Given the last |
Function Details
getContinuationToken(unknown)
Given the last .value
produced by the byPage
iterator,
returns a continuation token that can be used to begin paging from
that point later.
function getContinuationToken(page: unknown): string | undefined
Parameters
- page
-
unknown
An object from accessing value
on the IteratorResult from a byPage
iterator.
Returns
string | undefined
The continuation token that can be passed into byPage() during future calls.