npm install @datafire/azure_iothub
The npm package @datafire/azure_iothub receives a total of 4 downloads a week. As such, we scored @datafire/azure_iothub popularity level to be Limited.
Based on project statistics from the GitHub repository for the npm package @datafire/azure_iothub, we found that it has been starred 110 times, and that 0 other projects in the ecosystem are dependent on it.
Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.
We found a way for you to contribute to the project! Looks like @datafire/azure_iothub is missing a security policy.
You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.
We found a way for you to contribute to the project! Looks like @datafire/azure_iothub is missing a security policy.
# Install the Snyk CLI and test your project
npm i snyk && snyk test @datafire/azure_iothub
Further analysis of the maintenance status of @datafire/azure_iothub based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.
We found that @datafire/azure_iothub demonstrates a positive version release cadence with at least one new version released in the past 3 months.
As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.
This project has seen only 10 or less contributors.
We found a way for you to contribute to the project! Looks like @datafire/azure_iothub is missing a Code of Conduct.
@datafire/azure_iothub has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.
Client library for iotHubClient
npm install --save @datafire/azure_iothub
let azure_iothub = require('@datafire/azure_iothub').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Use this API to manage the IoT hubs in your Azure subscription.
Lists all of the available IoT Hub REST API operations.
azure_iothub.Operations_List({
"api-version": ""
}, context)
object
string
: The version of the API.Get all the IoT hubs in a subscription.
azure_iothub.IotHubResource_ListBySubscription({
"api-version": "",
"subscriptionId": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.Check if an IoT hub name is available.
azure_iothub.IotHubResource_CheckNameAvailability({
"api-version": "",
"subscriptionId": "",
"operationInputs": {
"name": ""
}
}, context)
object
string
: The version of the API.string
: The subscription identifier.Get the number of free and paid iot hubs in the subscription
azure_iothub.ResourceProviderCommon_GetSubscriptionQuota({
"subscriptionId": "",
"api-version": ""
}, context)
object
string
: The subscription identifier.string
: The version of the API.Get all the IoT hubs in a resource group.
azure_iothub.IotHubResource_ListByResourceGroup({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.Perform manual fail over of given hub
azure_iothub.IotHub_ManualFailover({
"iotHubName": "",
"failoverInput": {
"failoverRegion": ""
},
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
object
string
: IotHub to fail overstring
: The subscription identifier.string
: resource group which Iot Hub belongs tostring
: The version of the API.Output schema unknown
Test all routes configured in this Iot Hub
azure_iothub.IotHubResource_TestAllRoutes({
"input": {},
"iotHubName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
object
string
: IotHub to be testedstring
: The subscription identifier.string
: resource group which Iot Hub belongs tostring
: The version of the API.Test the new route for this Iot Hub
azure_iothub.IotHubResource_TestRoute({
"input": {
"route": {
"name": "",
"endpointNames": [],
"source": "",
"isEnabled": true
}
},
"iotHubName": "",
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
object
string
: IotHub to be testedstring
: The subscription identifier.string
: resource group which Iot Hub belongs tostring
: The version of the API.Get the health for routing endpoints.
azure_iothub.IotHubResource_GetEndpointHealth({
"subscriptionId": "",
"resourceGroupName": "",
"iotHubName": "",
"api-version": ""
}, context)
object
string
: The subscription identifier.string
string
string
: The version of the API.Delete an IoT hub.
azure_iothub.IotHubResource_Delete({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.Get the non-security related metadata of an IoT hub.
azure_iothub.IotHubResource_Get({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method
azure_iothub.IotHubResource_Update({
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"IotHubTags": null,
"api-version": ""
}, context)
object
string
: The subscription identifier.string
: Resource group identifier.string
: Name of iot hub to update.string
: The version of the API.Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub.
azure_iothub.IotHubResource_CreateOrUpdate({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"iotHubDescription": {
"sku": {
"name": ""
}
}
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.string
: ETag of the IoT Hub. Do not specify for creating a brand new IoT Hub. Required to update an existing IoT Hub.Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
azure_iothub.IotHubResource_GetKeysForKeyName({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"keyName": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.string
: The name of the shared access policy.Get the statistics from an IoT hub.
azure_iothub.IotHubResource_GetStats({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.Returns the list of certificates.
azure_iothub.Certificates_ListByIotHub({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.Deletes an existing X509 certificate or does nothing if it does not exist.
azure_iothub.Certificates_Delete({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"certificateName": "",
"If-Match": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.string
: The name of the certificatestring
: ETag of the Certificate.Output schema unknown
Returns the certificate.
azure_iothub.Certificates_Get({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"certificateName": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.string
: The name of the certificateAdds new or replaces existing certificate.
azure_iothub.Certificates_CreateOrUpdate({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"certificateName": "",
"certificateDescription": {}
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.string
: The name of the certificatestring
: ETag of the Certificate. Do not specify for creating a brand new certificate. Required to update an existing certificate.Generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate.
azure_iothub.Certificates_GenerateVerificationCode({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"certificateName": "",
"If-Match": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.string
: The name of the certificatestring
: ETag of the Certificate.Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.
azure_iothub.Certificates_Verify({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"certificateName": "",
"certificateVerificationBody": {},
"If-Match": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.string
: The name of the certificatestring
: ETag of the Certificate.Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.
azure_iothub.IotHubResource_ListEventHubConsumerGroups({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"eventHubEndpointName": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.string
: The name of the Event Hub-compatible endpoint.Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.
azure_iothub.IotHubResource_DeleteEventHubConsumerGroup({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"eventHubEndpointName": "",
"name": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.string
: The name of the Event Hub-compatible endpoint in the IoT hub.string
: The name of the consumer group to delete.Output schema unknown
Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.
azure_iothub.IotHubResource_GetEventHubConsumerGroup({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"eventHubEndpointName": "",
"name": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.string
: The name of the Event Hub-compatible endpoint in the IoT hub.string
: The name of the consumer group to retrieve.Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.
azure_iothub.IotHubResource_CreateEventHubConsumerGroup({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"eventHubEndpointName": "",
"name": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.string
: The name of the Event Hub-compatible endpoint in the IoT hub.string
: The name of the consumer group to add.Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
azure_iothub.IotHubResource_ExportDevices({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"exportDevicesParameters": {
"exportBlobContainerUri": "",
"excludeKeys": true
}
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
azure_iothub.IotHubResource_ImportDevices({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"importDevicesParameters": {
"inputBlobContainerUri": "",
"outputBlobContainerUri": ""
}
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
azure_iothub.IotHubResource_ListJobs({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
azure_iothub.IotHubResource_GetJob({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"jobId": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.string
: The job identifier.Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
azure_iothub.IotHubResource_ListKeys({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.Get the quota metrics for an IoT hub.
azure_iothub.IotHubResource_GetQuotaMetrics({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.Get the list of valid SKUs for an IoT hub.
azure_iothub.IotHubResource_GetValidSkus({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": ""
}, context)
object
string
: The version of the API.string
: The subscription identifier.string
: The name of the resource group that contains the IoT hub.string
: The name of the IoT hub.object
: The JSON-serialized X509 Certificate.
string
: base-64 representation of the X509 leaf certificate .cer file or just .pem file content.object
: The X509 Certificate.
string
: The entity tag.string
: The resource identifier.string
: The name of the certificate.string
: The resource type.object
: The JSON-serialized array of Certificate objects.
array
: The array of Certificate objects.
object
: The description of an X509 CA Certificate.
string
: The certificate contentstring
: The certificate's create date and time.string
: The certificate's expiration date and time.boolean
: Determines whether certificate has been verified.string
: The certificate's subject name.string
: The certificate's thumbprint.string
: The certificate's last update date and time.object
: The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.
string
: The certificate contentstring
: The certificate's create date and time.string
: The certificate's expiration date and time.boolean
: Determines whether certificate has been verified.string
: The certificate's subject name.string
: The certificate's thumbprint.string
: The certificate's last update date and time.string
: The certificate's verification code that will be used for proof of possession.object
: The JSON-serialized leaf certificate
string
: base-64 representation of X509 certificate .cer file or just .pem file content.object
: The X509 Certificate.
string
: The entity tag.string
: The resource identifier.string
: The name of the certificate.string
: The resource type.object
: The IoT hub cloud-to-device messaging properties.
string
: The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.integer
: The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.object
: The health data for an endpoint
string
: Id of the endpointstring
(values: unknown, healthy, unhealthy, dead): Health statuses have following meanings. The 'healthy' status shows that the endpoint is accepting messages as expected. The 'unhealthy' status shows that the endpoint is not accepting messages as expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub has established an eventually consistent state of health. The 'dead' status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues with endpoints. The 'unknown' status shows that the IoT Hub has not established a connection with the endpoint. No messages have been delivered to or rejected from this endpointobject
: The JSON-serialized array of EndpointHealthData objects with a next link.
string
: Link to more resultsarray
: JSON-serialized array of Endpoint health data
object
: The properties of an enrichment that your IoT hub applies to messages delivered to endpoints.
array
: The list of endpoints for which the enrichment is applied to the message.
string
string
: The key or name for the enrichment property.string
: The value for the enrichment property.object
: Error details.
string
: The error code.string
: The error details.string
: The HTTP status code.string
: The error message.object
: The properties of the EventHubConsumerGroupInfo object.
string
: The etag.string
: The Event Hub-compatible consumer group identifier.string
: The Event Hub-compatible consumer group name.object
: The tags.string
: the resource type.object
: The JSON-serialized array of Event Hub-compatible consumer group names with a next link.
string
: The next link.array
: List of consumer groups objects
object
: The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.
string
: The Event Hub-compatible endpoint.integer
: The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.array
: The partition ids in the Event Hub-compatible endpoint.
string
string
: The Event Hub-compatible name.integer
: The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messagesobject
: Use to provide parameters when requesting an export of all devices in the IoT hub.
boolean
: The value indicating whether keys should be excluded during export.string
: The export blob container URI.object
: Use to provide failover region when requesting manual Failover for a hub.
string
: Region the hub will be failed over toobject
: The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.
string
: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-languagearray
: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
string
boolean
: Used to specify whether the fallback route is enabled.string
: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.string
(values: DeviceMessages): The source to which the routing rule is to be applied to. For example, DeviceMessagesobject
: The properties of the feedback queue for cloud-to-device messages.
string
: The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.integer
: The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.string
: The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.object
: Use to provide parameters when requesting an import of all devices in the hub.
string
: The input blob container URI.string
: The output blob container URI.object
: IoT Hub capacity information.
integer
: The default number of units.integer
: The maximum number of units.integer
: The minimum number of units.string
(values: Automatic, Manual, None): The type of the scaling enabled.object
: The description of the IoT hub.
string
: The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.string
: The resource identifier.string
: The resource location.string
: The resource name.object
: The resource tags.string
: The resource type.object
: The JSON-serialized array of IotHubDescription objects with a next link.
string
: The next link.array
: The array of IotHubDescription objects.
object
: Public representation of one of the locations where a resource is provisioned.
string
: Azure Geo Regionsstring
(values: primary, secondary): Specific Role assigned to this locationobject
: The properties indicating whether a given IoT hub name is available.
string
: The detailed reason message.boolean
: The value which indicates whether the provided name is available.string
(values: Invalid, AlreadyExists): The reason for unavailability.object
: The properties of an IoT hub.
array
: The shared access policies you can use to secure a connection to the IoT hub.
string
: IoT hub comments.object
: The device streams properties of iothub.
array
: List of Device Streams Endpoints.
string
boolean
: If True, file upload notifications are enabled.object
: The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub.string
(values: None, DeviceManagement): The capabilities and features enabled for the IoT hub.string
: The name of the host.array
: The IP filter rules.
array
: Primary and secondary location for iot hub
object
: The messaging endpoint properties for the file upload notification queue.string
: The provisioning state.string
: The hub state.object
: The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.object
: Quota metrics properties.
integer
: The current value for the quota metric.integer
: The maximum value of the quota metric.string
: The name of the quota metric.object
: The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.
string
: The next link.array
: The array of quota metrics objects.
object
: SKU properties.
string
: The type of the resource.object
: The JSON-serialized array of IotHubSkuDescription objects with a next link.
string
: The next link.array
: The array of IotHubSkuDescription.
object
: Information about the SKU of the IoT hub.
integer
: The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.string
(values: F1, S1, S2, S3, B1, B2, B3): The name of the SKU.string
(values: Free, Standard, Basic): The billing tier for the IoT hub.object
: The IP filter rules for the IoT hub.
string
(values: Accept, Reject): The desired action for requests captured by this rule.string
: The name of the IP filter rule.string
: A string that contains the IP address range in CIDR notation for the rule.object
: The properties of the Job Response object.
string
: The time the job stopped processing.string
: If status == failed, this string containing the reason for the failure.string
: The job identifier.string
: The job identifier of the parent job, if any.string
: The start time of the job.string
(values: unknown, enqueued, running, completed, failed, cancelled): The status of the job.string
: The status message for the job.string
(values: unknown, export, import, backup, readDeviceProperties, writeDeviceProperties, updateDeviceConfiguration, rebootDevice, factoryResetDevice, firmwareUpdate): The type of the job.object
: The JSON-serialized array of JobResponse objects with a next link.
string
: The next link.array
: The array of JobResponse objects.
object
: Routes that matched
object
: The properties of the messaging endpoints used by this IoT hub.
string
: The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.integer
: The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.string
: The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.object
: Name of Iot Hub type
string
: Localized value of namestring
: IotHub typeobject
: IoT Hub REST API operation
object
: The object that represents the operation.
string
: Description of the operationstring
: Name of the operationstring
: Service provider: Microsoft Devicesstring
: Resource Type: IotHubsstring
: Operation name: {provider}/{resource}/{read | write | action | delete}object
: Input values.
string
: The name of the IoT hub to check.object
: 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.
string
: URL to get the next set of operation list results if there are any.array
: List of IoT Hub operations supported by the Microsoft.Devices resource provider.
object
: Identity registry statistics.
integer
: The count of disabled devices in the identity registry.integer
: The count of enabled devices in the identity registry.integer
: The total count of devices in the identity registry.object
: The common properties of an Azure resource.
string
: The resource identifier.string
: The resource location.string
: The resource name.object
: The resource tags.string
: The resource type.object
: Compilation error when evaluating route
string
: Route error messagestring
(values: error, warning): Severity of the route errorobject
: Position where the route error happened
integer
: Column where the route error happenedinteger
: Line where the route error happenedobject
: Range of route errors
object
: The properties of a routing rule that your IoT hub uses to route messages to endpoints.
string
: The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-languagearray
: The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
string
boolean
: Used to specify whether a route is enabled.string
: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.string
(values: Invalid, DeviceMessages, TwinChangeEvents, DeviceLifecycleEvents, DeviceJobLifecycleEvents, DigitalTwinChangeEvents): The source that the routing rule is to be applied to, such as DeviceMessages.object
: 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.
array
: The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.
array
: The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.
array
: The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.
array
: The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.
object
: The properties related to an event hub endpoint.
string
: The connection string of the event hub endpoint.string
: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.string
: The name of the resource group of the event hub endpoint.string
: The subscription identifier of the event hub endpoint.object
: Routing message
object
: App propertiesstring
: Body of routing messageobject
: System propertiesobject
: The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
array
: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/iotmsgenrich
array
: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.
object
: The properties related to service bus queue endpoint types.
string
: The connection string of the service bus queue endpoint.string
: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.string
: The name of the resource group of the service bus queue endpoint.string
: The subscription identifier of the service bus queue endpoint.object
: The properties related to service bus topic endpoint types.
string
: The connection string of the service bus topic endpoint.string
: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.string
: The name of the resource group of the service bus topic endpoint.string
: The subscription identifier of the service bus topic endpoint.object
: The properties related to a storage container endpoint.
integer
: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.string
: The connection string of the storage account.string
: The name of storage container in the storage account.string
(values: Avro, AvroDeflate, JSON): Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'.string
: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.integer
: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).string
: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.string
: The name of the resource group of the storage account.string
: The subscription identifier of the storage account.object
: Twin reference input parameter. This is an optional parameter
object
object
: Twin desired propertiesobject
: Twin desired propertiesobject
: Twin Tagsobject
: The properties of an IoT hub shared access policy.
string
: The name of the shared access policy.string
: The primary key.string
(values: RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect, RegistryRead, RegistryWrite, RegistryRead, ServiceConnect, RegistryRead, DeviceConnect, RegistryWrite, ServiceConnect, RegistryWrite, DeviceConnect, ServiceConnect, DeviceConnect, RegistryRead, RegistryWrite, ServiceConnect, RegistryRead, RegistryWrite, DeviceConnect, RegistryRead, ServiceConnect, DeviceConnect, RegistryWrite, ServiceConnect, DeviceConnect, RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect): The permissions assigned to the shared access policy.string
: The secondary key.object
: The list of shared access policies with a next link.
string
: The next link.array
: The list of shared access policies.
object
: The properties of the Azure Storage endpoint for file upload.
string
: The connection string for the Azure Storage account to which files are uploaded.string
: The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.string
: The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.object
: A container holding only the Tags for a resource, allowing the user to update the tags on an IoT Hub instance.object
: Input for testing all routes
string
(values: Invalid, DeviceMessages, TwinChangeEvents, DeviceLifecycleEvents, DeviceJobLifecycleEvents, DigitalTwinChangeEvents): Routing sourceobject
: Result of testing all routes
array
: JSON-serialized array of matched routes
object
: Input for testing route
object
: Result of testing one route
string
(values: undefined, false, true): Result of testing routeobject
: Detailed result of testing a route
array
: JSON-serialized list of route compilation errors
object
: User subscription quota response
integer
: Current number of IotHub typestring
: IotHub type idinteger
: Numerical limit on IotHub typestring
: Response typestring
: Unit of IotHub typeobject
: Json-serialized array of User subscription quota response
string
array
Version | Published | Tag | Node.js Compatability | Licenses | Dependencies | Direct Vulnerabilities | Publisher |
---|---|---|---|---|---|---|---|
5.0.0 | 21 December 2020 | latest | * | MIT | 1 |
| datafire |
4.0.0 | 12 June 2018 | * | MIT | 1 |
| datafire | |
3.0.0 | 16 February 2018 | * | MIT | 1 |
| datafire | |
All Versions |