@azure/arm-iothub package

The JSON-serialized X509 Certificate.

The X509 Certificate.

The JSON-serialized array of Certificate objects.

The description of an X509 CA Certificate.

The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.

The JSON-serialized leaf certificate

The X509 Certificate.

Interface representing a Certificates.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

The IoT hub cloud-to-device messaging properties.

The health data for an endpoint

The JSON-serialized array of EndpointHealthData objects with a next link.

The properties of an enrichment that your IoT hub applies to messages delivered to endpoints.

Error details.

The EventHub consumer group.

The properties of the EventHubConsumerGroupInfo object.

The EventHub consumer group name.

The JSON-serialized array of Event Hub-compatible consumer group names with a next link.

The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.

Use to provide parameters when requesting an export of all devices in the IoT hub.

Use to provide failover region when requesting manual Failover for a hub.

The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.

The properties of the feedback queue for cloud-to-device messages.

The group information for creating a private endpoint on an IotHub

The properties for a group information object

Use to provide parameters when requesting an import of all devices in the hub.

Interface representing a IotHub.

IoT Hub capacity information.

Optional parameters.

The description of the IoT hub.

The JSON-serialized array of IotHubDescription objects with a next link.

Public representation of one of the locations where a resource is provisioned.

Defines headers for IotHub_manualFailover operation.

Optional parameters.

The properties indicating whether a given IoT hub name is available.

The properties of an IoT hub.

Quota metrics properties.

The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.

Interface representing a IotHubResource.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for IotHubResource_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

SKU properties.

The JSON-serialized array of IotHubSkuDescription objects with a next link.

Information about the SKU of the IoT hub.

The IP filter rules for the IoT hub.

The properties of the Job Response object.

The JSON-serialized array of JobResponse objects with a next link.

The properties of the Managed identity.

Routes that matched

The properties of the messaging endpoints used by this IoT hub.

Name of Iot Hub type

IP Rule to be applied as part of Network Rule Set

Network Rule Set Properties of IotHub

IoT Hub REST API operation

The object that represents the operation.

Input values.

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.

Interface representing a Operations.

Optional parameters.

Optional parameters.

The private endpoint property of a private endpoint connection

The private endpoint connection of an IotHub

The properties of a private endpoint connection

Interface representing a PrivateEndpointConnections.

Defines headers for PrivateEndpointConnections_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

The available private link resources for an IotHub

Optional parameters.

Optional parameters.

Interface representing a PrivateLinkResourcesOperations.

The current state of a private endpoint connection

Identity registry statistics.

The common properties of an Azure resource.

Interface representing a ResourceProviderCommon.

Optional parameters.

Compilation error when evaluating route

Position where the route error happened

Range of route errors

The properties of a routing rule that your IoT hub uses to route messages to endpoints.

The properties related to a cosmos DB sql container endpoint.

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.

The properties related to an event hub endpoint.

Routing message

The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

The properties related to service bus queue endpoint types.

The properties related to service bus topic endpoint types.

The properties related to a storage container endpoint.

Twin reference input parameter. This is an optional parameter

The properties of an IoT hub shared access policy.

The list of shared access policies with a next link.

The properties of the Azure Storage endpoint for file upload.

Metadata pertaining to creation and last modification of the resource.

A container holding only the Tags for a resource, allowing the user to update the tags on an IoT Hub instance.

Input for testing all routes

Result of testing all routes

Input for testing route

Result of testing one route

Detailed result of testing a route

User subscription quota response

Json-serialized array of User subscription quota response

Defines values for AccessRights.

Defines values for AuthenticationType.
KnownAuthenticationType can be used interchangeably with AuthenticationType, this enum contains the known values that the service supports.

Known values supported by the service

keyBased
identityBased

Defines values for Capabilities.
KnownCapabilities can be used interchangeably with Capabilities, this enum contains the known values that the service supports.

Known values supported by the service

None
DeviceManagement

Contains response data for the createOrUpdate operation.

Contains response data for the generateVerificationCode operation.

Contains response data for the get operation.

Contains response data for the listByIotHub operation.

Contains response data for the verify operation.

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

Defines values for DefaultAction.
KnownDefaultAction can be used interchangeably with DefaultAction, this enum contains the known values that the service supports.

Known values supported by the service

Deny
Allow

Defines values for EndpointHealthStatus.
KnownEndpointHealthStatus can be used interchangeably with EndpointHealthStatus, this enum contains the known values that the service supports.

Known values supported by the service

unknown
healthy
degraded
unhealthy
dead

Defines values for IotHubNameUnavailabilityReason.

Defines values for IotHubReplicaRoleType.
KnownIotHubReplicaRoleType can be used interchangeably with IotHubReplicaRoleType, this enum contains the known values that the service supports.

Known values supported by the service

primary
secondary

Contains response data for the checkNameAvailability operation.

Contains response data for the createEventHubConsumerGroup operation.

Contains response data for the createOrUpdate operation.

Contains response data for the delete operation.

Contains response data for the exportDevices operation.

Contains response data for the getEndpointHealthNext operation.

Contains response data for the getEndpointHealth operation.

Contains response data for the getEventHubConsumerGroup operation.

Contains response data for the getJob operation.

Contains response data for the getKeysForKeyName operation.

Contains response data for the getQuotaMetricsNext operation.

Contains response data for the getQuotaMetrics operation.

Contains response data for the get operation.

Contains response data for the getStats operation.

Contains response data for the getValidSkusNext operation.

Contains response data for the getValidSkus operation.

Contains response data for the importDevices operation.

Contains response data for the listByResourceGroupNext operation.

Contains response data for the listByResourceGroup operation.

Contains response data for the listBySubscriptionNext operation.

Contains response data for the listBySubscription operation.

Contains response data for the listEventHubConsumerGroupsNext operation.

Contains response data for the listEventHubConsumerGroups operation.

Contains response data for the listJobsNext operation.

Contains response data for the listJobs operation.

Contains response data for the listKeysNext operation.

Contains response data for the listKeys operation.

Contains response data for the testAllRoutes operation.

Contains response data for the testRoute operation.

Contains response data for the update operation.

Defines values for IotHubScaleType.

Defines values for IotHubSku.
KnownIotHubSku can be used interchangeably with IotHubSku, this enum contains the known values that the service supports.

Known values supported by the service

F1
S1
S2
S3
B1
B2
B3

Defines values for IotHubSkuTier.

Defines values for IpFilterActionType.

Defines values for JobStatus.

Defines values for JobType.
KnownJobType can be used interchangeably with JobType, this enum contains the known values that the service supports.

Known values supported by the service

unknown
export
import
backup
readDeviceProperties
writeDeviceProperties
updateDeviceConfiguration
rebootDevice
factoryResetDevice
firmwareUpdate

Defines values for NetworkRuleIPAction.
KnownNetworkRuleIPAction can be used interchangeably with NetworkRuleIPAction, this enum contains the known values that the service supports.

Known values supported by the service

Allow

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the delete operation.

Contains response data for the get operation.

Contains response data for the list operation.

Contains response data for the update operation.

Contains response data for the get operation.

Contains response data for the list operation.

Defines values for PrivateLinkServiceConnectionStatus.
KnownPrivateLinkServiceConnectionStatus can be used interchangeably with PrivateLinkServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected
Disconnected

Defines values for PublicNetworkAccess.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

Defines values for ResourceIdentityType.

Contains response data for the getSubscriptionQuota operation.

Defines values for RouteErrorSeverity.
KnownRouteErrorSeverity can be used interchangeably with RouteErrorSeverity, this enum contains the known values that the service supports.

Known values supported by the service

error
warning

Defines values for RoutingSource.
KnownRoutingSource can be used interchangeably with RoutingSource, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
DeviceMessages
TwinChangeEvents
DeviceLifecycleEvents
DeviceJobLifecycleEvents
DeviceConnectionStateEvents

Defines values for RoutingStorageContainerPropertiesEncoding.
KnownRoutingStorageContainerPropertiesEncoding can be used interchangeably with RoutingStorageContainerPropertiesEncoding, this enum contains the known values that the service supports.

Known values supported by the service

Avro
AvroDeflate
JSON

Defines values for TestResultStatus.
KnownTestResultStatus can be used interchangeably with TestResultStatus, this enum contains the known values that the service supports.

Known values supported by the service

undefined
false
true

Known values of AuthenticationType that the service accepts.

Known values of Capabilities that the service accepts.

Known values of CreatedByType that the service accepts.

Known values of DefaultAction that the service accepts.

Known values of EndpointHealthStatus that the service accepts.

Known values of IotHubReplicaRoleType that the service accepts.

Known values of IotHubSku that the service accepts.

Known values of JobType that the service accepts.

Known values of NetworkRuleIPAction that the service accepts.

Known values of PrivateLinkServiceConnectionStatus that the service accepts.

Known values of PublicNetworkAccess that the service accepts.

Known values of RouteErrorSeverity that the service accepts.

Known values of RoutingSource that the service accepts.

Known values of RoutingStorageContainerPropertiesEncoding that the service accepts.

Known values of TestResultStatus that the service accepts.

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.