diff --git a/lib/services/iothub/LICENSE.txt b/lib/services/iothub/LICENSE.txt index 5431ba98b9..8f3d856145 100644 --- a/lib/services/iothub/LICENSE.txt +++ b/lib/services/iothub/LICENSE.txt @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2018 Microsoft +Copyright (c) 2019 Microsoft Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/lib/services/iothub/lib/iotHubClient.js b/lib/services/iothub/lib/iotHubClient.js index 389702b2f9..14b9d7dac0 100644 --- a/lib/services/iothub/lib/iotHubClient.js +++ b/lib/services/iothub/lib/iotHubClient.js @@ -50,7 +50,7 @@ class IotHubClient extends ServiceClient { super(credentials, options); - this.apiVersion = '2018-04-01'; + this.apiVersion = '2018-12-01-preview'; this.acceptLanguage = 'en-US'; this.longRunningOperationRetryTimeout = 30; this.generateClientRequestId = true; diff --git a/lib/services/iothub/lib/models/certificateBodyDescription.js b/lib/services/iothub/lib/models/certificateBodyDescription.js index 2af0caf367..e733744b44 100644 --- a/lib/services/iothub/lib/models/certificateBodyDescription.js +++ b/lib/services/iothub/lib/models/certificateBodyDescription.js @@ -17,7 +17,7 @@ class CertificateBodyDescription { /** * Create a CertificateBodyDescription. - * @member {string} [certificate] base-64 representation of the X509 leaf + * @property {string} [certificate] base-64 representation of the X509 leaf * certificate .cer file or just .pem file content. */ constructor() { diff --git a/lib/services/iothub/lib/models/certificateDescription.js b/lib/services/iothub/lib/models/certificateDescription.js index d0011b5cb1..5697da34db 100644 --- a/lib/services/iothub/lib/models/certificateDescription.js +++ b/lib/services/iothub/lib/models/certificateDescription.js @@ -20,22 +20,22 @@ const models = require('./index'); class CertificateDescription extends models['BaseResource'] { /** * Create a CertificateDescription. - * @member {object} [properties] - * @member {string} [properties.subject] The certificate's subject name. - * @member {date} [properties.expiry] The certificate's expiration date and + * @property {object} [properties] + * @property {string} [properties.subject] The certificate's subject name. + * @property {date} [properties.expiry] The certificate's expiration date and * time. - * @member {string} [properties.thumbprint] The certificate's thumbprint. - * @member {boolean} [properties.isVerified] Determines whether certificate + * @property {string} [properties.thumbprint] The certificate's thumbprint. + * @property {boolean} [properties.isVerified] Determines whether certificate * has been verified. - * @member {date} [properties.created] The certificate's create date and + * @property {date} [properties.created] The certificate's create date and * time. - * @member {date} [properties.updated] The certificate's last update date and - * time. - * @member {string} [properties.certificate] The certificate content - * @member {string} [id] The resource identifier. - * @member {string} [name] The name of the certificate. - * @member {string} [etag] The entity tag. - * @member {string} [type] The resource type. + * @property {date} [properties.updated] The certificate's last update date + * and time. + * @property {string} [properties.certificate] The certificate content + * @property {string} [id] The resource identifier. + * @property {string} [name] The name of the certificate. + * @property {string} [etag] The entity tag. + * @property {string} [type] The resource type. */ constructor() { super(); diff --git a/lib/services/iothub/lib/models/certificateListDescription.js b/lib/services/iothub/lib/models/certificateListDescription.js index 39f48a7284..32909b9778 100644 --- a/lib/services/iothub/lib/models/certificateListDescription.js +++ b/lib/services/iothub/lib/models/certificateListDescription.js @@ -17,7 +17,7 @@ class CertificateListDescription { /** * Create a CertificateListDescription. - * @member {array} [value] The array of Certificate objects. + * @property {array} [value] The array of Certificate objects. */ constructor() { } diff --git a/lib/services/iothub/lib/models/certificateProperties.js b/lib/services/iothub/lib/models/certificateProperties.js index a34e473c39..b9f3325538 100644 --- a/lib/services/iothub/lib/models/certificateProperties.js +++ b/lib/services/iothub/lib/models/certificateProperties.js @@ -17,14 +17,14 @@ class CertificateProperties { /** * Create a CertificateProperties. - * @member {string} [subject] The certificate's subject name. - * @member {date} [expiry] The certificate's expiration date and time. - * @member {string} [thumbprint] The certificate's thumbprint. - * @member {boolean} [isVerified] Determines whether certificate has been + * @property {string} [subject] The certificate's subject name. + * @property {date} [expiry] The certificate's expiration date and time. + * @property {string} [thumbprint] The certificate's thumbprint. + * @property {boolean} [isVerified] Determines whether certificate has been * verified. - * @member {date} [created] The certificate's create date and time. - * @member {date} [updated] The certificate's last update date and time. - * @member {string} [certificate] The certificate content + * @property {date} [created] The certificate's create date and time. + * @property {date} [updated] The certificate's last update date and time. + * @property {string} [certificate] The certificate content */ constructor() { } diff --git a/lib/services/iothub/lib/models/certificatePropertiesWithNonce.js b/lib/services/iothub/lib/models/certificatePropertiesWithNonce.js index b86241c34b..a9a46ad5bc 100644 --- a/lib/services/iothub/lib/models/certificatePropertiesWithNonce.js +++ b/lib/services/iothub/lib/models/certificatePropertiesWithNonce.js @@ -18,16 +18,16 @@ class CertificatePropertiesWithNonce { /** * Create a CertificatePropertiesWithNonce. - * @member {string} [subject] The certificate's subject name. - * @member {date} [expiry] The certificate's expiration date and time. - * @member {string} [thumbprint] The certificate's thumbprint. - * @member {boolean} [isVerified] Determines whether certificate has been + * @property {string} [subject] The certificate's subject name. + * @property {date} [expiry] The certificate's expiration date and time. + * @property {string} [thumbprint] The certificate's thumbprint. + * @property {boolean} [isVerified] Determines whether certificate has been * verified. - * @member {date} [created] The certificate's create date and time. - * @member {date} [updated] The certificate's last update date and time. - * @member {string} [verificationCode] The certificate's verification code + * @property {date} [created] The certificate's create date and time. + * @property {date} [updated] The certificate's last update date and time. + * @property {string} [verificationCode] The certificate's verification code * that will be used for proof of possession. - * @member {string} [certificate] The certificate content + * @property {string} [certificate] The certificate content */ constructor() { } diff --git a/lib/services/iothub/lib/models/certificateVerificationDescription.js b/lib/services/iothub/lib/models/certificateVerificationDescription.js index 47fb80c8eb..ad2edc765a 100644 --- a/lib/services/iothub/lib/models/certificateVerificationDescription.js +++ b/lib/services/iothub/lib/models/certificateVerificationDescription.js @@ -17,8 +17,8 @@ class CertificateVerificationDescription { /** * Create a CertificateVerificationDescription. - * @member {string} [certificate] base-64 representation of X509 certificate - * .cer file or just .pem file content. + * @property {string} [certificate] base-64 representation of X509 + * certificate .cer file or just .pem file content. */ constructor() { } diff --git a/lib/services/iothub/lib/models/certificateWithNonceDescription.js b/lib/services/iothub/lib/models/certificateWithNonceDescription.js index a3194ec800..2eee4a4441 100644 --- a/lib/services/iothub/lib/models/certificateWithNonceDescription.js +++ b/lib/services/iothub/lib/models/certificateWithNonceDescription.js @@ -20,24 +20,24 @@ const models = require('./index'); class CertificateWithNonceDescription extends models['BaseResource'] { /** * Create a CertificateWithNonceDescription. - * @member {object} [properties] - * @member {string} [properties.subject] The certificate's subject name. - * @member {date} [properties.expiry] The certificate's expiration date and + * @property {object} [properties] + * @property {string} [properties.subject] The certificate's subject name. + * @property {date} [properties.expiry] The certificate's expiration date and * time. - * @member {string} [properties.thumbprint] The certificate's thumbprint. - * @member {boolean} [properties.isVerified] Determines whether certificate + * @property {string} [properties.thumbprint] The certificate's thumbprint. + * @property {boolean} [properties.isVerified] Determines whether certificate * has been verified. - * @member {date} [properties.created] The certificate's create date and + * @property {date} [properties.created] The certificate's create date and * time. - * @member {date} [properties.updated] The certificate's last update date and - * time. - * @member {string} [properties.verificationCode] The certificate's + * @property {date} [properties.updated] The certificate's last update date + * and time. + * @property {string} [properties.verificationCode] The certificate's * verification code that will be used for proof of possession. - * @member {string} [properties.certificate] The certificate content - * @member {string} [id] The resource identifier. - * @member {string} [name] The name of the certificate. - * @member {string} [etag] The entity tag. - * @member {string} [type] The resource type. + * @property {string} [properties.certificate] The certificate content + * @property {string} [id] The resource identifier. + * @property {string} [name] The name of the certificate. + * @property {string} [etag] The entity tag. + * @property {string} [type] The resource type. */ constructor() { super(); diff --git a/lib/services/iothub/lib/models/cloudToDeviceProperties.js b/lib/services/iothub/lib/models/cloudToDeviceProperties.js index 89a527bd0f..ea053b7ab7 100644 --- a/lib/services/iothub/lib/models/cloudToDeviceProperties.js +++ b/lib/services/iothub/lib/models/cloudToDeviceProperties.js @@ -17,21 +17,21 @@ class CloudToDeviceProperties { /** * Create a CloudToDeviceProperties. - * @member {number} [maxDeliveryCount] The max delivery count for + * @property {number} [maxDeliveryCount] 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. - * @member {moment.duration} [defaultTtlAsIso8601] The default time to live + * @property {moment.duration} [defaultTtlAsIso8601] 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. - * @member {object} [feedback] - * @member {moment.duration} [feedback.lockDurationAsIso8601] The lock + * @property {object} [feedback] + * @property {moment.duration} [feedback.lockDurationAsIso8601] The lock * duration for the feedback queue. See: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. - * @member {moment.duration} [feedback.ttlAsIso8601] The period of time for + * @property {moment.duration} [feedback.ttlAsIso8601] 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. - * @member {number} [feedback.maxDeliveryCount] The number of times the IoT + * @property {number} [feedback.maxDeliveryCount] 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. */ diff --git a/lib/services/iothub/lib/models/endpointHealthData.js b/lib/services/iothub/lib/models/endpointHealthData.js index 23fccc7c0b..fa888fbac7 100644 --- a/lib/services/iothub/lib/models/endpointHealthData.js +++ b/lib/services/iothub/lib/models/endpointHealthData.js @@ -17,9 +17,19 @@ class EndpointHealthData { /** * Create a EndpointHealthData. - * @member {string} [endpointId] Id of the endpoint - * @member {string} [healthStatus] Health status. Possible values include: - * 'unknown', 'healthy', 'unhealthy', 'dead' + * @property {string} [endpointId] Id of the endpoint + * @property {string} [healthStatus] 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 endpoint. + * Possible values include: 'unknown', 'healthy', 'unhealthy', 'dead' */ constructor() { } diff --git a/lib/services/iothub/lib/models/endpointHealthDataListResult.js b/lib/services/iothub/lib/models/endpointHealthDataListResult.js index f538a7551d..0d62ad1e77 100644 --- a/lib/services/iothub/lib/models/endpointHealthDataListResult.js +++ b/lib/services/iothub/lib/models/endpointHealthDataListResult.js @@ -16,7 +16,7 @@ class EndpointHealthDataListResult extends Array { /** * Create a EndpointHealthDataListResult. - * @member {string} [nextLink] Link to more results + * @property {string} [nextLink] Link to more results */ constructor() { super(); diff --git a/lib/services/iothub/lib/models/errorDetails.js b/lib/services/iothub/lib/models/errorDetails.js index 4c324936fc..a131aa88f6 100644 --- a/lib/services/iothub/lib/models/errorDetails.js +++ b/lib/services/iothub/lib/models/errorDetails.js @@ -17,10 +17,10 @@ class ErrorDetails { /** * Create a ErrorDetails. - * @member {string} [code] The error code. - * @member {string} [httpStatusCode] The HTTP status code. - * @member {string} [message] The error message. - * @member {string} [details] The error details. + * @property {string} [code] The error code. + * @property {string} [httpStatusCode] The HTTP status code. + * @property {string} [message] The error message. + * @property {string} [details] The error details. */ constructor() { } diff --git a/lib/services/iothub/lib/models/eventHubConsumerGroupInfo.js b/lib/services/iothub/lib/models/eventHubConsumerGroupInfo.js index dadaecd584..0c207d3b0c 100644 --- a/lib/services/iothub/lib/models/eventHubConsumerGroupInfo.js +++ b/lib/services/iothub/lib/models/eventHubConsumerGroupInfo.js @@ -20,11 +20,12 @@ const models = require('./index'); class EventHubConsumerGroupInfo extends models['BaseResource'] { /** * Create a EventHubConsumerGroupInfo. - * @member {object} [properties] The tags. - * @member {string} [id] The Event Hub-compatible consumer group identifier. - * @member {string} [name] The Event Hub-compatible consumer group name. - * @member {string} [type] the resource type. - * @member {string} [etag] The etag. + * @property {object} [properties] The tags. + * @property {string} [id] The Event Hub-compatible consumer group + * identifier. + * @property {string} [name] The Event Hub-compatible consumer group name. + * @property {string} [type] the resource type. + * @property {string} [etag] The etag. */ constructor() { super(); diff --git a/lib/services/iothub/lib/models/eventHubConsumerGroupsListResult.js b/lib/services/iothub/lib/models/eventHubConsumerGroupsListResult.js index d1c3628e22..96ddf69a29 100644 --- a/lib/services/iothub/lib/models/eventHubConsumerGroupsListResult.js +++ b/lib/services/iothub/lib/models/eventHubConsumerGroupsListResult.js @@ -17,7 +17,7 @@ class EventHubConsumerGroupsListResult extends Array { /** * Create a EventHubConsumerGroupsListResult. - * @member {string} [nextLink] The next link. + * @property {string} [nextLink] The next link. */ constructor() { super(); diff --git a/lib/services/iothub/lib/models/eventHubProperties.js b/lib/services/iothub/lib/models/eventHubProperties.js index f26a34e58c..81053fa067 100644 --- a/lib/services/iothub/lib/models/eventHubProperties.js +++ b/lib/services/iothub/lib/models/eventHubProperties.js @@ -18,16 +18,16 @@ class EventHubProperties { /** * Create a EventHubProperties. - * @member {number} [retentionTimeInDays] The retention time for + * @property {number} [retentionTimeInDays] 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-messages - * @member {number} [partitionCount] The number of partitions for receiving + * @property {number} [partitionCount] 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. - * @member {array} [partitionIds] The partition ids in the Event + * @property {array} [partitionIds] The partition ids in the Event * Hub-compatible endpoint. - * @member {string} [path] The Event Hub-compatible name. - * @member {string} [endpoint] The Event Hub-compatible endpoint. + * @property {string} [path] The Event Hub-compatible name. + * @property {string} [endpoint] The Event Hub-compatible endpoint. */ constructor() { } diff --git a/lib/services/iothub/lib/models/exportDevicesRequest.js b/lib/services/iothub/lib/models/exportDevicesRequest.js index 55f27a6c20..ba42376a08 100644 --- a/lib/services/iothub/lib/models/exportDevicesRequest.js +++ b/lib/services/iothub/lib/models/exportDevicesRequest.js @@ -18,9 +18,9 @@ class ExportDevicesRequest { /** * Create a ExportDevicesRequest. - * @member {string} exportBlobContainerUri The export blob container URI. - * @member {boolean} excludeKeys The value indicating whether keys should be - * excluded during export. + * @property {string} exportBlobContainerUri The export blob container URI. + * @property {boolean} excludeKeys The value indicating whether keys should + * be excluded during export. */ constructor() { } diff --git a/lib/services/iothub/lib/models/fallbackRouteProperties.js b/lib/services/iothub/lib/models/fallbackRouteProperties.js index cc03d2477f..039cae89b5 100644 --- a/lib/services/iothub/lib/models/fallbackRouteProperties.js +++ b/lib/services/iothub/lib/models/fallbackRouteProperties.js @@ -18,18 +18,18 @@ class FallbackRouteProperties { /** * Create a FallbackRouteProperties. - * @member {string} [name] The name of the route. The name can only include + * @property {string} [name] 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. - * @member {string} [condition] The condition which is evaluated in order to - * apply the fallback route. If the condition is not provided it will + * @property {string} [condition] 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-language - * @member {array} endpointNames The list of endpoints to which the messages - * that satisfy the condition are routed to. Currently only 1 endpoint is - * allowed. - * @member {boolean} isEnabled Used to specify whether the fallback route is - * enabled. + * @property {array} endpointNames The list of endpoints to which the + * messages that satisfy the condition are routed to. Currently only 1 + * endpoint is allowed. + * @property {boolean} isEnabled Used to specify whether the fallback route + * is enabled. */ constructor() { } diff --git a/lib/services/iothub/lib/models/feedbackProperties.js b/lib/services/iothub/lib/models/feedbackProperties.js index f7380f07dd..292d1469ee 100644 --- a/lib/services/iothub/lib/models/feedbackProperties.js +++ b/lib/services/iothub/lib/models/feedbackProperties.js @@ -17,13 +17,13 @@ class FeedbackProperties { /** * Create a FeedbackProperties. - * @member {moment.duration} [lockDurationAsIso8601] The lock duration for + * @property {moment.duration} [lockDurationAsIso8601] The lock duration for * the feedback queue. See: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. - * @member {moment.duration} [ttlAsIso8601] The period of time for which a + * @property {moment.duration} [ttlAsIso8601] 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. - * @member {number} [maxDeliveryCount] The number of times the IoT hub + * @property {number} [maxDeliveryCount] 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. */ diff --git a/lib/services/iothub/lib/models/importDevicesRequest.js b/lib/services/iothub/lib/models/importDevicesRequest.js index dd5b03159b..0768f84b3f 100644 --- a/lib/services/iothub/lib/models/importDevicesRequest.js +++ b/lib/services/iothub/lib/models/importDevicesRequest.js @@ -18,8 +18,8 @@ class ImportDevicesRequest { /** * Create a ImportDevicesRequest. - * @member {string} inputBlobContainerUri The input blob container URI. - * @member {string} outputBlobContainerUri The output blob container URI. + * @property {string} inputBlobContainerUri The input blob container URI. + * @property {string} outputBlobContainerUri The output blob container URI. */ constructor() { } diff --git a/lib/services/iothub/lib/models/index.d.ts b/lib/services/iothub/lib/models/index.d.ts index f6cc69f384..8ccea458f0 100644 --- a/lib/services/iothub/lib/models/index.d.ts +++ b/lib/services/iothub/lib/models/index.d.ts @@ -1,1469 +1,1292 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ -import { BaseResource } from 'ms-rest-azure'; -import { CloudError } from 'ms-rest-azure'; -import * as moment from 'moment'; +import { BaseResource, CloudError } from "ms-rest-azure"; +import * as moment from "moment"; -export { BaseResource } from 'ms-rest-azure'; -export { CloudError } from 'ms-rest-azure'; +export { + BaseResource, + CloudError +}; /** - * @class - * Initializes a new instance of the CertificateVerificationDescription class. - * @constructor * The JSON-serialized leaf certificate - * - * @member {string} [certificate] base-64 representation of X509 certificate - * .cer file or just .pem file content. */ export interface CertificateVerificationDescription { + /** + * base-64 representation of X509 certificate .cer file or just .pem file content. + */ certificate?: string; } /** - * @class - * Initializes a new instance of the CertificateProperties class. - * @constructor * The description of an X509 CA Certificate. - * - * @member {string} [subject] The certificate's subject name. - * @member {date} [expiry] The certificate's expiration date and time. - * @member {string} [thumbprint] The certificate's thumbprint. - * @member {boolean} [isVerified] Determines whether certificate has been - * verified. - * @member {date} [created] The certificate's create date and time. - * @member {date} [updated] The certificate's last update date and time. - * @member {string} [certificate] The certificate content */ export interface CertificateProperties { + /** + * The certificate's subject name. + */ readonly subject?: string; + /** + * The certificate's expiration date and time. + */ readonly expiry?: Date; + /** + * The certificate's thumbprint. + */ readonly thumbprint?: string; + /** + * Determines whether certificate has been verified. + */ readonly isVerified?: boolean; + /** + * The certificate's create date and time. + */ readonly created?: Date; + /** + * The certificate's last update date and time. + */ readonly updated?: Date; + /** + * The certificate content + */ certificate?: string; } /** - * @class - * Initializes a new instance of the CertificateDescription class. - * @constructor * The X509 Certificate. - * - * @member {object} [properties] - * @member {string} [properties.subject] The certificate's subject name. - * @member {date} [properties.expiry] The certificate's expiration date and - * time. - * @member {string} [properties.thumbprint] The certificate's thumbprint. - * @member {boolean} [properties.isVerified] Determines whether certificate has - * been verified. - * @member {date} [properties.created] The certificate's create date and time. - * @member {date} [properties.updated] The certificate's last update date and - * time. - * @member {string} [properties.certificate] The certificate content - * @member {string} [id] The resource identifier. - * @member {string} [name] The name of the certificate. - * @member {string} [etag] The entity tag. - * @member {string} [type] The resource type. */ export interface CertificateDescription extends BaseResource { properties?: CertificateProperties; + /** + * The resource identifier. + */ readonly id?: string; + /** + * The name of the certificate. + */ readonly name?: string; + /** + * The entity tag. + */ readonly etag?: string; + /** + * The resource type. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the CertificateListDescription class. - * @constructor * The JSON-serialized array of Certificate objects. - * - * @member {array} [value] The array of Certificate objects. - */ +*/ export interface CertificateListDescription { + /** + * The array of Certificate objects. + */ value?: CertificateDescription[]; } /** - * @class - * Initializes a new instance of the CertificateBodyDescription class. - * @constructor * The JSON-serialized X509 Certificate. - * - * @member {string} [certificate] base-64 representation of the X509 leaf - * certificate .cer file or just .pem file content. - */ +*/ export interface CertificateBodyDescription { + /** + * base-64 representation of the X509 leaf certificate .cer file or just .pem file content. + */ certificate?: string; } /** - * @class - * Initializes a new instance of the CertificatePropertiesWithNonce class. - * @constructor - * The description of an X509 CA Certificate including the challenge nonce - * issued for the Proof-Of-Possession flow. - * - * @member {string} [subject] The certificate's subject name. - * @member {date} [expiry] The certificate's expiration date and time. - * @member {string} [thumbprint] The certificate's thumbprint. - * @member {boolean} [isVerified] Determines whether certificate has been - * verified. - * @member {date} [created] The certificate's create date and time. - * @member {date} [updated] The certificate's last update date and time. - * @member {string} [verificationCode] The certificate's verification code that - * will be used for proof of possession. - * @member {string} [certificate] The certificate content - */ + * The description of an X509 CA Certificate including the challenge nonce issued for the + * Proof-Of-Possession flow. +*/ export interface CertificatePropertiesWithNonce { + /** + * The certificate's subject name. + */ readonly subject?: string; + /** + * The certificate's expiration date and time. + */ readonly expiry?: Date; + /** + * The certificate's thumbprint. + */ readonly thumbprint?: string; + /** + * Determines whether certificate has been verified. + */ readonly isVerified?: boolean; + /** + * The certificate's create date and time. + */ readonly created?: Date; + /** + * The certificate's last update date and time. + */ readonly updated?: Date; + /** + * The certificate's verification code that will be used for proof of possession. + */ readonly verificationCode?: string; + /** + * The certificate content + */ readonly certificate?: string; } /** - * @class - * Initializes a new instance of the CertificateWithNonceDescription class. - * @constructor * The X509 Certificate. - * - * @member {object} [properties] - * @member {string} [properties.subject] The certificate's subject name. - * @member {date} [properties.expiry] The certificate's expiration date and - * time. - * @member {string} [properties.thumbprint] The certificate's thumbprint. - * @member {boolean} [properties.isVerified] Determines whether certificate has - * been verified. - * @member {date} [properties.created] The certificate's create date and time. - * @member {date} [properties.updated] The certificate's last update date and - * time. - * @member {string} [properties.verificationCode] The certificate's - * verification code that will be used for proof of possession. - * @member {string} [properties.certificate] The certificate content - * @member {string} [id] The resource identifier. - * @member {string} [name] The name of the certificate. - * @member {string} [etag] The entity tag. - * @member {string} [type] The resource type. - */ +*/ export interface CertificateWithNonceDescription extends BaseResource { properties?: CertificatePropertiesWithNonce; + /** + * The resource identifier. + */ readonly id?: string; + /** + * The name of the certificate. + */ readonly name?: string; + /** + * The entity tag. + */ readonly etag?: string; + /** + * The resource type. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the SharedAccessSignatureAuthorizationRule class. - * @constructor * The properties of an IoT hub shared access policy. - * - * @member {string} keyName The name of the shared access policy. - * @member {string} [primaryKey] The primary key. - * @member {string} [secondaryKey] The secondary key. - * @member {string} rights The permissions assigned to the shared access - * policy. Possible values include: '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' - */ +*/ export interface SharedAccessSignatureAuthorizationRule { + /** + * The name of the shared access policy. + */ keyName: string; + /** + * The primary key. + */ primaryKey?: string; + /** + * The secondary key. + */ secondaryKey?: string; + /** + * The permissions assigned to the shared access policy. Possible values include: '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' + */ rights: string; } /** - * @class - * Initializes a new instance of the IpFilterRule class. - * @constructor * The IP filter rules for the IoT hub. - * - * @member {string} filterName The name of the IP filter rule. - * @member {string} action The desired action for requests captured by this - * rule. Possible values include: 'Accept', 'Reject' - * @member {string} ipMask A string that contains the IP address range in CIDR - * notation for the rule. - */ +*/ export interface IpFilterRule { + /** + * The name of the IP filter rule. + */ filterName: string; + /** + * The desired action for requests captured by this rule. Possible values include: 'Accept', + * 'Reject' + */ action: string; + /** + * A string that contains the IP address range in CIDR notation for the rule. + */ ipMask: string; } /** - * @class - * Initializes a new instance of the EventHubProperties class. - * @constructor - * The properties of the provisioned Event Hub-compatible endpoint used by the - * IoT hub. - * - * @member {number} [retentionTimeInDays] 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-messages - * @member {number} [partitionCount] 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. - * @member {array} [partitionIds] The partition ids in the Event Hub-compatible - * endpoint. - * @member {string} [path] The Event Hub-compatible name. - * @member {string} [endpoint] The Event Hub-compatible endpoint. - */ + * The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub. +*/ export interface EventHubProperties { + /** + * 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-messages + */ retentionTimeInDays?: number; + /** + * 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. + */ partitionCount?: number; + /** + * The partition ids in the Event Hub-compatible endpoint. + */ readonly partitionIds?: string[]; + /** + * The Event Hub-compatible name. + */ readonly path?: string; + /** + * The Event Hub-compatible endpoint. + */ readonly endpoint?: string; } /** - * @class - * Initializes a new instance of the RoutingServiceBusQueueEndpointProperties class. - * @constructor * The properties related to service bus queue endpoint types. - * - * @member {string} connectionString The connection string of the service bus - * queue endpoint. - * @member {string} name 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, operationsMonitoringEvents, fileNotifications, $default. Endpoint - * names must be unique across endpoint types. The name need not be the same as - * the actual queue name. - * @member {string} [subscriptionId] The subscription identifier of the service - * bus queue endpoint. - * @member {string} [resourceGroup] The name of the resource group of the - * service bus queue endpoint. - */ +*/ export interface RoutingServiceBusQueueEndpointProperties { + /** + * The connection string of the service bus queue endpoint. + */ connectionString: 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, operationsMonitoringEvents, fileNotifications, $default. Endpoint names + * must be unique across endpoint types. The name need not be the same as the actual queue name. + */ name: string; + /** + * The subscription identifier of the service bus queue endpoint. + */ subscriptionId?: string; + /** + * The name of the resource group of the service bus queue endpoint. + */ resourceGroup?: string; } /** - * @class - * Initializes a new instance of the RoutingServiceBusTopicEndpointProperties class. - * @constructor * The properties related to service bus topic endpoint types. - * - * @member {string} connectionString The connection string of the service bus - * topic endpoint. - * @member {string} name 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, operationsMonitoringEvents, fileNotifications, $default. Endpoint - * names must be unique across endpoint types. The name need not be the same - * as the actual topic name. - * @member {string} [subscriptionId] The subscription identifier of the service - * bus topic endpoint. - * @member {string} [resourceGroup] The name of the resource group of the - * service bus topic endpoint. - */ +*/ export interface RoutingServiceBusTopicEndpointProperties { + /** + * The connection string of the service bus topic endpoint. + */ connectionString: 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, operationsMonitoringEvents, fileNotifications, $default. Endpoint names + * must be unique across endpoint types. The name need not be the same as the actual topic name. + */ name: string; + /** + * The subscription identifier of the service bus topic endpoint. + */ subscriptionId?: string; + /** + * The name of the resource group of the service bus topic endpoint. + */ resourceGroup?: string; } /** - * @class - * Initializes a new instance of the RoutingEventHubProperties class. - * @constructor * The properties related to an event hub endpoint. - * - * @member {string} connectionString The connection string of the event hub - * endpoint. - * @member {string} name 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, operationsMonitoringEvents, fileNotifications, $default. Endpoint - * names must be unique across endpoint types. - * @member {string} [subscriptionId] The subscription identifier of the event - * hub endpoint. - * @member {string} [resourceGroup] The name of the resource group of the event - * hub endpoint. - */ +*/ export interface RoutingEventHubProperties { + /** + * The connection string of the event hub endpoint. + */ connectionString: 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, operationsMonitoringEvents, fileNotifications, $default. Endpoint names + * must be unique across endpoint types. + */ name: string; + /** + * The subscription identifier of the event hub endpoint. + */ subscriptionId?: string; + /** + * The name of the resource group of the event hub endpoint. + */ resourceGroup?: string; } /** - * @class - * Initializes a new instance of the RoutingStorageContainerProperties class. - * @constructor * The properties related to a storage container endpoint. - * - * @member {string} connectionString The connection string of the storage - * account. - * @member {string} name 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, operationsMonitoringEvents, fileNotifications, $default. Endpoint - * names must be unique across endpoint types. - * @member {string} [subscriptionId] The subscription identifier of the storage - * account. - * @member {string} [resourceGroup] The name of the resource group of the - * storage account. - * @member {string} containerName The name of storage container in the storage - * account. - * @member {string} [fileNameFormat] File name format for the blob. Default - * format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters - * are mandatory but can be reordered. - * @member {number} [batchFrequencyInSeconds] Time interval at which blobs are - * written to storage. Value should be between 60 and 720 seconds. Default - * value is 300 seconds. - * @member {number} [maxChunkSizeInBytes] Maximum number of bytes for each blob - * written to storage. Value should be between 10485760(10MB) and - * 524288000(500MB). Default value is 314572800(300MB). - * @member {string} [encoding] Encoding that is used to serialize messages to - * blobs. Supported values are 'avro' and 'avrodeflate'. Default value is - * 'avro'. - */ +*/ export interface RoutingStorageContainerProperties { + /** + * The connection string of the storage account. + */ connectionString: 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, operationsMonitoringEvents, fileNotifications, $default. Endpoint names + * must be unique across endpoint types. + */ name: string; + /** + * The subscription identifier of the storage account. + */ subscriptionId?: string; + /** + * The name of the resource group of the storage account. + */ resourceGroup?: string; + /** + * The name of storage container in the storage account. + */ containerName: 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. + */ fileNameFormat?: string; + /** + * Time interval at which blobs are written to storage. Value should be between 60 and 720 + * seconds. Default value is 300 seconds. + */ batchFrequencyInSeconds?: number; + /** + * Maximum number of bytes for each blob written to storage. Value should be between + * 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). + */ maxChunkSizeInBytes?: number; + /** + * Encoding that is used to serialize messages to blobs. Supported values are 'avro', + * 'avrodeflate', and 'JSON'. Default value is 'avro'. Possible values include: 'Avro', + * 'AvroDeflate', 'JSON' + */ encoding?: string; } /** - * @class - * Initializes a new instance of the RoutingEndpoints class. - * @constructor - * 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. - * - * @member {array} [serviceBusQueues] The list of Service Bus queue endpoints - * that IoT hub routes the messages to, based on the routing rules. - * @member {array} [serviceBusTopics] The list of Service Bus topic endpoints - * that the IoT hub routes the messages to, based on the routing rules. - * @member {array} [eventHubs] 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. - * @member {array} [storageContainers] The list of storage container endpoints - * that IoT hub routes messages to, based on the routing rules. - */ + * 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. +*/ export interface RoutingEndpoints { + /** + * The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the + * routing rules. + */ serviceBusQueues?: RoutingServiceBusQueueEndpointProperties[]; + /** + * The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the + * routing rules. + */ serviceBusTopics?: RoutingServiceBusTopicEndpointProperties[]; + /** + * 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. + */ eventHubs?: RoutingEventHubProperties[]; + /** + * The list of storage container endpoints that IoT hub routes messages to, based on the routing + * rules. + */ storageContainers?: RoutingStorageContainerProperties[]; } /** - * @class - * Initializes a new instance of the RouteProperties class. - * @constructor - * The properties of a routing rule that your IoT hub uses to route messages to - * endpoints. - * - * @member {string} name 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. - * @member {string} source The source that the routing rule is to be applied - * to, such as DeviceMessages. Possible values include: 'Invalid', - * 'DeviceMessages', 'TwinChangeEvents', 'DeviceLifecycleEvents', - * 'DeviceJobLifecycleEvents' - * @member {string} [condition] 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-language - * @member {array} endpointNames The list of endpoints to which messages that - * satisfy the condition are routed. Currently only one endpoint is allowed. - * @member {boolean} isEnabled Used to specify whether a route is enabled. - */ + * The properties of a routing rule that your IoT hub uses to route messages to endpoints. +*/ export interface RouteProperties { + /** + * 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. + */ name: string; + /** + * The source that the routing rule is to be applied to, such as DeviceMessages. Possible values + * include: 'Invalid', 'DeviceMessages', 'TwinChangeEvents', 'DeviceLifecycleEvents', + * 'DeviceJobLifecycleEvents' + */ source: 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-language + */ condition?: string; + /** + * The list of endpoints to which messages that satisfy the condition are routed. Currently only + * one endpoint is allowed. + */ endpointNames: string[]; + /** + * Used to specify whether a route is enabled. + */ isEnabled: boolean; } /** - * @class - * Initializes a new instance of the FallbackRouteProperties class. - * @constructor - * The properties of the fallback route. IoT Hub uses these properties when it - * routes messages to the fallback endpoint. - * - * @member {string} [name] 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. - * @member {string} [condition] 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-language - * @member {array} endpointNames The list of endpoints to which the messages - * that satisfy the condition are routed to. Currently only 1 endpoint is - * allowed. - * @member {boolean} isEnabled Used to specify whether the fallback route is - * enabled. - */ + * The properties of the fallback route. IoT Hub uses these properties when it routes messages to + * the fallback endpoint. +*/ export interface FallbackRouteProperties { + /** + * 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. + */ name?: 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-language + */ condition?: string; + /** + * The list of endpoints to which the messages that satisfy the condition are routed to. + * Currently only 1 endpoint is allowed. + */ endpointNames: string[]; + /** + * Used to specify whether the fallback route is enabled. + */ isEnabled: boolean; } /** - * @class - * Initializes a new instance of the RoutingProperties class. - * @constructor * The routing related properties of the IoT hub. See: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging - * - * @member {object} [endpoints] - * @member {array} [endpoints.serviceBusQueues] The list of Service Bus queue - * endpoints that IoT hub routes the messages to, based on the routing rules. - * @member {array} [endpoints.serviceBusTopics] The list of Service Bus topic - * endpoints that the IoT hub routes the messages to, based on the routing - * rules. - * @member {array} [endpoints.eventHubs] 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. - * @member {array} [endpoints.storageContainers] The list of storage container - * endpoints that IoT hub routes messages to, based on the routing rules. - * @member {array} [routes] 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. - * @member {object} [fallbackRoute] The properties of the route that is used as - * a fall-back route when none of the conditions specified in the 'routes' - * section are met. This is an optional parameter. When this property is not - * set, the messages which do not meet any of the conditions specified in the - * 'routes' section get routed to the built-in eventhub endpoint. - * @member {string} [fallbackRoute.name] 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. - * @member {string} [fallbackRoute.condition] 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-language - * @member {array} [fallbackRoute.endpointNames] The list of endpoints to which - * the messages that satisfy the condition are routed to. Currently only 1 - * endpoint is allowed. - * @member {boolean} [fallbackRoute.isEnabled] Used to specify whether the - * fallback route is enabled. - */ +*/ export interface RoutingProperties { endpoints?: RoutingEndpoints; + /** + * 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. + */ routes?: RouteProperties[]; + /** + * The properties of the route that is used as a fall-back route when none of the conditions + * specified in the 'routes' section are met. This is an optional parameter. When this property + * is not set, the messages which do not meet any of the conditions specified in the 'routes' + * section get routed to the built-in eventhub endpoint. + */ fallbackRoute?: FallbackRouteProperties; } /** - * @class - * Initializes a new instance of the StorageEndpointProperties class. - * @constructor * The properties of the Azure Storage endpoint for file upload. - * - * @member {moment.duration} [sasTtlAsIso8601] The period of time for which the - * 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. - * @member {string} connectionString The connection string for the Azure - * Storage account to which files are uploaded. - * @member {string} containerName The name of the root container where you - * upload files. The container need not exist but should be creatable using the - * connectionString specified. - */ +*/ export interface StorageEndpointProperties { + /** + * 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. + */ sasTtlAsIso8601?: moment.Duration; + /** + * The connection string for the Azure Storage account to which files are uploaded. + */ connectionString: string; + /** + * The name of the root container where you upload files. The container need not exist but should + * be creatable using the connectionString specified. + */ containerName: string; } /** - * @class - * Initializes a new instance of the MessagingEndpointProperties class. - * @constructor * The properties of the messaging endpoints used by this IoT hub. - * - * @member {moment.duration} [lockDurationAsIso8601] The lock duration. See: - * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. - * @member {moment.duration} [ttlAsIso8601] 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. - * @member {number} [maxDeliveryCount] 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. - */ +*/ export interface MessagingEndpointProperties { + /** + * The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. + */ lockDurationAsIso8601?: moment.Duration; + /** + * 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. + */ ttlAsIso8601?: moment.Duration; + /** + * 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. + */ maxDeliveryCount?: number; } /** - * @class - * Initializes a new instance of the FeedbackProperties class. - * @constructor * The properties of the feedback queue for cloud-to-device messages. - * - * @member {moment.duration} [lockDurationAsIso8601] The lock duration for the - * feedback queue. See: - * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. - * @member {moment.duration} [ttlAsIso8601] 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. - * @member {number} [maxDeliveryCount] 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. - */ +*/ export interface FeedbackProperties { + /** + * The lock duration for the feedback queue. See: + * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. + */ lockDurationAsIso8601?: moment.Duration; + /** + * 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. + */ ttlAsIso8601?: moment.Duration; + /** + * 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. + */ maxDeliveryCount?: number; } /** - * @class - * Initializes a new instance of the CloudToDeviceProperties class. - * @constructor * The IoT hub cloud-to-device messaging properties. - * - * @member {number} [maxDeliveryCount] 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. - * @member {moment.duration} [defaultTtlAsIso8601] 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. - * @member {object} [feedback] - * @member {moment.duration} [feedback.lockDurationAsIso8601] The lock duration - * for the feedback queue. See: - * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. - * @member {moment.duration} [feedback.ttlAsIso8601] 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. - * @member {number} [feedback.maxDeliveryCount] 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. - */ +*/ export interface CloudToDeviceProperties { + /** + * 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. + */ maxDeliveryCount?: number; + /** + * 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. + */ defaultTtlAsIso8601?: moment.Duration; feedback?: FeedbackProperties; } /** - * @class - * Initializes a new instance of the OperationsMonitoringProperties class. - * @constructor - * The operations monitoring properties for the IoT hub. The possible keys to - * the dictionary are Connections, DeviceTelemetry, C2DCommands, - * DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, - * C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods. - * - * @member {object} [events] - */ + * The operations monitoring properties for the IoT hub. The possible keys to the dictionary are + * Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations, + * Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods. +*/ export interface OperationsMonitoringProperties { events?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the IotHubProperties class. - * @constructor + * The device streams properties of iothub. +*/ +export interface IotHubPropertiesDeviceStreams { + /** + * List of Device Streams Endpoints. + */ + streamingEndpoints?: string[]; +} + +/** * The properties of an IoT hub. - * - * @member {array} [authorizationPolicies] The shared access policies you can - * use to secure a connection to the IoT hub. - * @member {array} [ipFilterRules] The IP filter rules. - * @member {string} [provisioningState] The provisioning state. - * @member {string} [state] Thehub state state. - * @member {string} [hostName] The name of the host. - * @member {object} [eventHubEndpoints] The Event Hub-compatible endpoint - * properties. The possible keys to this dictionary are events and - * operationsMonitoringEvents. Both of these keys have to be present in the - * dictionary while making create or update calls for the IoT hub. - * @member {object} [routing] - * @member {object} [routing.endpoints] - * @member {array} [routing.endpoints.serviceBusQueues] The list of Service Bus - * queue endpoints that IoT hub routes the messages to, based on the routing - * rules. - * @member {array} [routing.endpoints.serviceBusTopics] The list of Service Bus - * topic endpoints that the IoT hub routes the messages to, based on the - * routing rules. - * @member {array} [routing.endpoints.eventHubs] 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. - * @member {array} [routing.endpoints.storageContainers] The list of storage - * container endpoints that IoT hub routes messages to, based on the routing - * rules. - * @member {array} [routing.routes] 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. - * @member {object} [routing.fallbackRoute] The properties of the route that is - * used as a fall-back route when none of the conditions specified in the - * 'routes' section are met. This is an optional parameter. When this property - * is not set, the messages which do not meet any of the conditions specified - * in the 'routes' section get routed to the built-in eventhub endpoint. - * @member {string} [routing.fallbackRoute.name] 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. - * @member {string} [routing.fallbackRoute.condition] 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-language - * @member {array} [routing.fallbackRoute.endpointNames] The list of endpoints - * to which the messages that satisfy the condition are routed to. Currently - * only 1 endpoint is allowed. - * @member {boolean} [routing.fallbackRoute.isEnabled] Used to specify whether - * the fallback route is enabled. - * @member {object} [storageEndpoints] 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. - * @member {object} [messagingEndpoints] The messaging endpoint properties for - * the file upload notification queue. - * @member {boolean} [enableFileUploadNotifications] If True, file upload - * notifications are enabled. - * @member {object} [cloudToDevice] - * @member {number} [cloudToDevice.maxDeliveryCount] 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. - * @member {moment.duration} [cloudToDevice.defaultTtlAsIso8601] 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. - * @member {object} [cloudToDevice.feedback] - * @member {moment.duration} [cloudToDevice.feedback.lockDurationAsIso8601] The - * lock duration for the feedback queue. See: - * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. - * @member {moment.duration} [cloudToDevice.feedback.ttlAsIso8601] 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. - * @member {number} [cloudToDevice.feedback.maxDeliveryCount] 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. - * @member {string} [comments] IoT hub comments. - * @member {object} [operationsMonitoringProperties] - * @member {object} [operationsMonitoringProperties.events] - * @member {string} [features] The capabilities and features enabled for the - * IoT hub. Possible values include: 'None', 'DeviceManagement' - */ +*/ export interface IotHubProperties { + /** + * The shared access policies you can use to secure a connection to the IoT hub. + */ authorizationPolicies?: SharedAccessSignatureAuthorizationRule[]; + /** + * The IP filter rules. + */ ipFilterRules?: IpFilterRule[]; + /** + * The provisioning state. + */ readonly provisioningState?: string; + /** + * The hub state. + */ readonly state?: string; + /** + * The name of the host. + */ readonly hostName?: string; + /** + * The Event Hub-compatible endpoint properties. The possible keys to this dictionary are events + * and operationsMonitoringEvents. Both of these keys have to be present in the dictionary while + * making create or update calls for the IoT hub. + */ eventHubEndpoints?: { [propertyName: string]: EventHubProperties }; routing?: RoutingProperties; + /** + * 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. + */ storageEndpoints?: { [propertyName: string]: StorageEndpointProperties }; + /** + * The messaging endpoint properties for the file upload notification queue. + */ messagingEndpoints?: { [propertyName: string]: MessagingEndpointProperties }; + /** + * If True, file upload notifications are enabled. + */ enableFileUploadNotifications?: boolean; cloudToDevice?: CloudToDeviceProperties; + /** + * IoT hub comments. + */ comments?: string; operationsMonitoringProperties?: OperationsMonitoringProperties; + /** + * The device streams properties of iothub. + */ + deviceStreams?: IotHubPropertiesDeviceStreams; + /** + * The capabilities and features enabled for the IoT hub. Possible values include: 'None', + * 'DeviceManagement' + */ features?: string; } /** - * @class - * Initializes a new instance of the IotHubSkuInfo class. - * @constructor * Information about the SKU of the IoT hub. - * - * @member {string} name The name of the SKU. Possible values include: 'F1', - * 'S1', 'S2', 'S3', 'B1', 'B2', 'B3' - * @member {string} [tier] The billing tier for the IoT hub. Possible values - * include: 'Free', 'Standard', 'Basic' - * @member {number} [capacity] The number of provisioned IoT Hub units. See: - * https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. - */ +*/ export interface IotHubSkuInfo { + /** + * The name of the SKU. Possible values include: 'F1', 'S1', 'S2', 'S3', 'B1', 'B2', 'B3' + */ name: string; + /** + * The billing tier for the IoT hub. Possible values include: 'Free', 'Standard', 'Basic' + */ readonly tier?: string; + /** + * The number of provisioned IoT Hub units. See: + * https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. + */ capacity?: number; } /** - * @class - * Initializes a new instance of the Resource class. - * @constructor * The common properties of an Azure resource. - * - * @member {string} [id] The resource identifier. - * @member {string} [name] The resource name. - * @member {string} [type] The resource type. - * @member {string} location The resource location. - * @member {object} [tags] The resource tags. - */ +*/ export interface Resource extends BaseResource { + /** + * The resource identifier. + */ readonly id?: string; + /** + * The resource name. + */ readonly name?: string; + /** + * The resource type. + */ readonly type?: string; + /** + * The resource location. + */ location: string; + /** + * The resource tags. + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the IotHubDescription class. - * @constructor * The description of the IoT hub. - * - * @member {string} [etag] 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. - * @member {object} [properties] IotHub properties - * @member {array} [properties.authorizationPolicies] The shared access - * policies you can use to secure a connection to the IoT hub. - * @member {array} [properties.ipFilterRules] The IP filter rules. - * @member {string} [properties.provisioningState] The provisioning state. - * @member {string} [properties.state] Thehub state state. - * @member {string} [properties.hostName] The name of the host. - * @member {object} [properties.eventHubEndpoints] The Event Hub-compatible - * endpoint properties. The possible keys to this dictionary are events and - * operationsMonitoringEvents. Both of these keys have to be present in the - * dictionary while making create or update calls for the IoT hub. - * @member {object} [properties.routing] - * @member {object} [properties.routing.endpoints] - * @member {array} [properties.routing.endpoints.serviceBusQueues] The list of - * Service Bus queue endpoints that IoT hub routes the messages to, based on - * the routing rules. - * @member {array} [properties.routing.endpoints.serviceBusTopics] The list of - * Service Bus topic endpoints that the IoT hub routes the messages to, based - * on the routing rules. - * @member {array} [properties.routing.endpoints.eventHubs] 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. - * @member {array} [properties.routing.endpoints.storageContainers] The list of - * storage container endpoints that IoT hub routes messages to, based on the - * routing rules. - * @member {array} [properties.routing.routes] 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. - * @member {object} [properties.routing.fallbackRoute] The properties of the - * route that is used as a fall-back route when none of the conditions - * specified in the 'routes' section are met. This is an optional parameter. - * When this property is not set, the messages which do not meet any of the - * conditions specified in the 'routes' section get routed to the built-in - * eventhub endpoint. - * @member {string} [properties.routing.fallbackRoute.name] 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. - * @member {string} [properties.routing.fallbackRoute.condition] 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-language - * @member {array} [properties.routing.fallbackRoute.endpointNames] The list of - * endpoints to which the messages that satisfy the condition are routed to. - * Currently only 1 endpoint is allowed. - * @member {boolean} [properties.routing.fallbackRoute.isEnabled] Used to - * specify whether the fallback route is enabled. - * @member {object} [properties.storageEndpoints] 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. - * @member {object} [properties.messagingEndpoints] The messaging endpoint - * properties for the file upload notification queue. - * @member {boolean} [properties.enableFileUploadNotifications] If True, file - * upload notifications are enabled. - * @member {object} [properties.cloudToDevice] - * @member {number} [properties.cloudToDevice.maxDeliveryCount] 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. - * @member {moment.duration} [properties.cloudToDevice.defaultTtlAsIso8601] 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. - * @member {object} [properties.cloudToDevice.feedback] - * @member {moment.duration} - * [properties.cloudToDevice.feedback.lockDurationAsIso8601] The lock duration - * for the feedback queue. See: - * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. - * @member {moment.duration} [properties.cloudToDevice.feedback.ttlAsIso8601] - * 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. - * @member {number} [properties.cloudToDevice.feedback.maxDeliveryCount] 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. - * @member {string} [properties.comments] IoT hub comments. - * @member {object} [properties.operationsMonitoringProperties] - * @member {object} [properties.operationsMonitoringProperties.events] - * @member {string} [properties.features] The capabilities and features enabled - * for the IoT hub. Possible values include: 'None', 'DeviceManagement' - * @member {object} sku IotHub SKU info - * @member {string} [sku.name] The name of the SKU. Possible values include: - * 'F1', 'S1', 'S2', 'S3', 'B1', 'B2', 'B3' - * @member {string} [sku.tier] The billing tier for the IoT hub. Possible - * values include: 'Free', 'Standard', 'Basic' - * @member {number} [sku.capacity] The number of provisioned IoT Hub units. - * See: - * https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. - */ +*/ export interface IotHubDescription extends Resource { + /** + * 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. + */ etag?: string; + /** + * IotHub properties + */ properties?: IotHubProperties; + /** + * IotHub SKU info + */ sku: IotHubSkuInfo; } /** - * @class - * Initializes a new instance of the OperationDisplay class. - * @constructor * The object that represents the operation. - * - * @member {string} [provider] Service provider: Microsoft Devices - * @member {string} [resource] Resource Type: IotHubs - * @member {string} [operation] Name of the operation - */ +*/ export interface OperationDisplay { + /** + * Service provider: Microsoft Devices + */ readonly provider?: string; + /** + * Resource Type: IotHubs + */ readonly resource?: string; + /** + * Name of the operation + */ readonly operation?: string; + /** + * Description of the operation + */ + readonly description?: string; } /** - * @class - * Initializes a new instance of the Operation class. - * @constructor * IoT Hub REST API operation - * - * @member {string} [name] Operation name: {provider}/{resource}/{read | write - * | action | delete} - * @member {object} [display] The object that represents the operation. - * @member {string} [display.provider] Service provider: Microsoft Devices - * @member {string} [display.resource] Resource Type: IotHubs - * @member {string} [display.operation] Name of the operation - */ +*/ export interface Operation { + /** + * Operation name: {provider}/{resource}/{read | write | action | delete} + */ readonly name?: string; + /** + * The object that represents the operation. + */ display?: OperationDisplay; } /** - * @class - * Initializes a new instance of the ErrorDetails class. - * @constructor * Error details. - * - * @member {string} [code] The error code. - * @member {string} [httpStatusCode] The HTTP status code. - * @member {string} [message] The error message. - * @member {string} [details] The error details. - */ +*/ export interface ErrorDetails { + /** + * The error code. + */ readonly code?: string; + /** + * The HTTP status code. + */ readonly httpStatusCode?: string; + /** + * The error message. + */ readonly message?: string; + /** + * The error details. + */ readonly details?: string; } /** - * @class - * Initializes a new instance of the IotHubQuotaMetricInfo class. - * @constructor * Quota metrics properties. - * - * @member {string} [name] The name of the quota metric. - * @member {number} [currentValue] The current value for the quota metric. - * @member {number} [maxValue] The maximum value of the quota metric. - */ +*/ export interface IotHubQuotaMetricInfo { + /** + * The name of the quota metric. + */ readonly name?: string; + /** + * The current value for the quota metric. + */ readonly currentValue?: number; + /** + * The maximum value of the quota metric. + */ readonly maxValue?: number; } /** - * @class - * Initializes a new instance of the EndpointHealthData class. - * @constructor * The health data for an endpoint - * - * @member {string} [endpointId] Id of the endpoint - * @member {string} [healthStatus] Health status. Possible values include: - * 'unknown', 'healthy', 'unhealthy', 'dead' - */ +*/ export interface EndpointHealthData { + /** + * Id of the endpoint + */ endpointId?: string; + /** + * 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 endpoint. Possible values include: 'unknown', 'healthy', + * 'unhealthy', 'dead' + */ healthStatus?: string; } /** - * @class - * Initializes a new instance of the RegistryStatistics class. - * @constructor * Identity registry statistics. - * - * @member {number} [totalDeviceCount] The total count of devices in the - * identity registry. - * @member {number} [enabledDeviceCount] The count of enabled devices in the - * identity registry. - * @member {number} [disabledDeviceCount] The count of disabled devices in the - * identity registry. - */ +*/ export interface RegistryStatistics { + /** + * The total count of devices in the identity registry. + */ readonly totalDeviceCount?: number; + /** + * The count of enabled devices in the identity registry. + */ readonly enabledDeviceCount?: number; + /** + * The count of disabled devices in the identity registry. + */ readonly disabledDeviceCount?: number; } /** - * @class - * Initializes a new instance of the JobResponse class. - * @constructor * The properties of the Job Response object. - * - * @member {string} [jobId] The job identifier. - * @member {date} [startTimeUtc] The start time of the job. - * @member {date} [endTimeUtc] The time the job stopped processing. - * @member {string} [type] The type of the job. Possible values include: - * 'unknown', 'export', 'import', 'backup', 'readDeviceProperties', - * 'writeDeviceProperties', 'updateDeviceConfiguration', 'rebootDevice', - * 'factoryResetDevice', 'firmwareUpdate' - * @member {string} [status] The status of the job. Possible values include: - * 'unknown', 'enqueued', 'running', 'completed', 'failed', 'cancelled' - * @member {string} [failureReason] If status == failed, this string containing - * the reason for the failure. - * @member {string} [statusMessage] The status message for the job. - * @member {string} [parentJobId] The job identifier of the parent job, if any. - */ +*/ export interface JobResponse { + /** + * The job identifier. + */ readonly jobId?: string; + /** + * The start time of the job. + */ readonly startTimeUtc?: Date; + /** + * The time the job stopped processing. + */ readonly endTimeUtc?: Date; + /** + * The type of the job. Possible values include: 'unknown', 'export', 'import', 'backup', + * 'readDeviceProperties', 'writeDeviceProperties', 'updateDeviceConfiguration', 'rebootDevice', + * 'factoryResetDevice', 'firmwareUpdate' + */ readonly type?: string; + /** + * The status of the job. Possible values include: 'unknown', 'enqueued', 'running', 'completed', + * 'failed', 'cancelled' + */ readonly status?: string; + /** + * If status == failed, this string containing the reason for the failure. + */ readonly failureReason?: string; + /** + * The status message for the job. + */ readonly statusMessage?: string; + /** + * The job identifier of the parent job, if any. + */ readonly parentJobId?: string; } /** - * @class - * Initializes a new instance of the IotHubCapacity class. - * @constructor * IoT Hub capacity information. - * - * @member {number} [minimum] The minimum number of units. - * @member {number} [maximum] The maximum number of units. - * @member {number} [default] The default number of units. - * @member {string} [scaleType] The type of the scaling enabled. Possible - * values include: 'Automatic', 'Manual', 'None' - */ +*/ export interface IotHubCapacity { + /** + * The minimum number of units. + */ readonly minimum?: number; + /** + * The maximum number of units. + */ readonly maximum?: number; + /** + * The default number of units. + */ readonly default?: number; + /** + * The type of the scaling enabled. Possible values include: 'Automatic', 'Manual', 'None' + */ readonly scaleType?: string; } /** - * @class - * Initializes a new instance of the IotHubSkuDescription class. - * @constructor * SKU properties. - * - * @member {string} [resourceType] The type of the resource. - * @member {object} sku The type of the resource. - * @member {string} [sku.name] The name of the SKU. Possible values include: - * 'F1', 'S1', 'S2', 'S3', 'B1', 'B2', 'B3' - * @member {string} [sku.tier] The billing tier for the IoT hub. Possible - * values include: 'Free', 'Standard', 'Basic' - * @member {number} [sku.capacity] The number of provisioned IoT Hub units. - * See: - * https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. - * @member {object} capacity IotHub capacity - * @member {number} [capacity.minimum] The minimum number of units. - * @member {number} [capacity.maximum] The maximum number of units. - * @member {number} [capacity.default] The default number of units. - * @member {string} [capacity.scaleType] The type of the scaling enabled. - * Possible values include: 'Automatic', 'Manual', 'None' - */ +*/ export interface IotHubSkuDescription { + /** + * The type of the resource. + */ readonly resourceType?: string; + /** + * The type of the resource. + */ sku: IotHubSkuInfo; + /** + * IotHub capacity + */ capacity: IotHubCapacity; } /** - * @class - * Initializes a new instance of the TagsResource class. - * @constructor - * A container holding only the Tags for a resource, allowing the user to - * update the tags on an IoT Hub instance. - * - * @member {object} [tags] Resource tags - */ + * A container holding only the Tags for a resource, allowing the user to update the tags on an IoT + * Hub instance. +*/ export interface TagsResource { + /** + * Resource tags + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the EventHubConsumerGroupInfo class. - * @constructor * The properties of the EventHubConsumerGroupInfo object. - * - * @member {object} [properties] The tags. - * @member {string} [id] The Event Hub-compatible consumer group identifier. - * @member {string} [name] The Event Hub-compatible consumer group name. - * @member {string} [type] the resource type. - * @member {string} [etag] The etag. - */ +*/ export interface EventHubConsumerGroupInfo extends BaseResource { + /** + * The tags. + */ properties?: { [propertyName: string]: string }; + /** + * The Event Hub-compatible consumer group identifier. + */ readonly id?: string; + /** + * The Event Hub-compatible consumer group name. + */ readonly name?: string; + /** + * the resource type. + */ readonly type?: string; + /** + * The etag. + */ readonly etag?: string; } /** - * @class - * Initializes a new instance of the OperationInputs class. - * @constructor * Input values. - * - * @member {string} name The name of the IoT hub to check. - */ +*/ export interface OperationInputs { + /** + * The name of the IoT hub to check. + */ name: string; } /** - * @class - * Initializes a new instance of the IotHubNameAvailabilityInfo class. - * @constructor * The properties indicating whether a given IoT hub name is available. - * - * @member {boolean} [nameAvailable] The value which indicates whether the - * provided name is available. - * @member {string} [reason] The reason for unavailability. Possible values - * include: 'Invalid', 'AlreadyExists' - * @member {string} [message] The detailed reason message. - */ +*/ export interface IotHubNameAvailabilityInfo { + /** + * The value which indicates whether the provided name is available. + */ readonly nameAvailable?: boolean; + /** + * The reason for unavailability. Possible values include: 'Invalid', 'AlreadyExists' + */ readonly reason?: string; + /** + * The detailed reason message. + */ message?: string; } /** - * @class - * Initializes a new instance of the Name class. - * @constructor * Name of Iot Hub type - * - * @member {string} [value] IotHub type - * @member {string} [localizedValue] Localized value of name - */ +*/ export interface Name { + /** + * IotHub type + */ value?: string; + /** + * Localized value of name + */ localizedValue?: string; } /** - * @class - * Initializes a new instance of the UserSubscriptionQuota class. - * @constructor * User subscription quota response - * - * @member {string} [id] IotHub type id - * @member {string} [type] Response type - * @member {string} [unit] Unit of IotHub type - * @member {number} [currentValue] Current number of IotHub type - * @member {number} [limit] Numerical limit on IotHub type - * @member {object} [name] IotHub type - * @member {string} [name.value] IotHub type - * @member {string} [name.localizedValue] Localized value of name - */ +*/ export interface UserSubscriptionQuota { + /** + * IotHub type id + */ id?: string; + /** + * Response type + */ type?: string; + /** + * Unit of IotHub type + */ unit?: string; + /** + * Current number of IotHub type + */ currentValue?: number; + /** + * Numerical limit on IotHub type + */ limit?: number; + /** + * IotHub type + */ name?: Name; } /** - * @class - * Initializes a new instance of the UserSubscriptionQuotaListResult class. - * @constructor * Json-serialized array of User subscription quota response - * - * @member {array} [value] - * @member {string} [nextLink] - */ +*/ export interface UserSubscriptionQuotaListResult { value?: UserSubscriptionQuota[]; readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the RoutingMessage class. - * @constructor * Routing message - * - * @member {string} [body] Body of routing message - * @member {object} [appProperties] App properties - * @member {object} [systemProperties] System properties - */ +*/ export interface RoutingMessage { + /** + * Body of routing message + */ body?: string; + /** + * App properties + */ appProperties?: { [propertyName: string]: string }; + /** + * System properties + */ systemProperties?: { [propertyName: string]: string }; } +export interface RoutingTwinProperties { + /** + * Twin desired properties + */ + desired?: any; + /** + * Twin desired properties + */ + reported?: any; +} + +/** + * Twin reference input parameter. This is an optional parameter +*/ +export interface RoutingTwin { + /** + * Twin Tags + */ + tags?: any; + properties?: RoutingTwinProperties; +} + /** - * @class - * Initializes a new instance of the TestAllRoutesInput class. - * @constructor * Input for testing all routes - * - * @member {string} [routingSource] Routing source. Possible values include: - * 'Invalid', 'DeviceMessages', 'TwinChangeEvents', 'DeviceLifecycleEvents', - * 'DeviceJobLifecycleEvents' - * @member {object} [message] Routing message - * @member {string} [message.body] Body of routing message - * @member {object} [message.appProperties] App properties - * @member {object} [message.systemProperties] System properties - */ +*/ export interface TestAllRoutesInput { + /** + * Routing source. Possible values include: 'Invalid', 'DeviceMessages', 'TwinChangeEvents', + * 'DeviceLifecycleEvents', 'DeviceJobLifecycleEvents' + */ routingSource?: string; + /** + * Routing message + */ message?: RoutingMessage; + /** + * Routing Twin Reference + */ + twin?: RoutingTwin; } /** - * @class - * Initializes a new instance of the MatchedRoute class. - * @constructor * Routes that matched - * - * @member {object} [properties] Properties of routes that matched - * @member {string} [properties.name] 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. - * @member {string} [properties.source] The source that the routing rule is to - * be applied to, such as DeviceMessages. Possible values include: 'Invalid', - * 'DeviceMessages', 'TwinChangeEvents', 'DeviceLifecycleEvents', - * 'DeviceJobLifecycleEvents' - * @member {string} [properties.condition] 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-language - * @member {array} [properties.endpointNames] The list of endpoints to which - * messages that satisfy the condition are routed. Currently only one endpoint - * is allowed. - * @member {boolean} [properties.isEnabled] Used to specify whether a route is - * enabled. - */ +*/ export interface MatchedRoute { + /** + * Properties of routes that matched + */ properties?: RouteProperties; } /** - * @class - * Initializes a new instance of the TestAllRoutesResult class. - * @constructor * Result of testing all routes - * - * @member {array} [routes] JSON-serialized array of matched routes - */ +*/ export interface TestAllRoutesResult { + /** + * JSON-serialized array of matched routes + */ routes?: MatchedRoute[]; } /** - * @class - * Initializes a new instance of the TestRouteInput class. - * @constructor * Input for testing route - * - * @member {object} [message] Routing message - * @member {string} [message.body] Body of routing message - * @member {object} [message.appProperties] App properties - * @member {object} [message.systemProperties] System properties - * @member {object} route Route properties - * @member {string} [route.name] 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. - * @member {string} [route.source] The source that the routing rule is to be - * applied to, such as DeviceMessages. Possible values include: 'Invalid', - * 'DeviceMessages', 'TwinChangeEvents', 'DeviceLifecycleEvents', - * 'DeviceJobLifecycleEvents' - * @member {string} [route.condition] 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-language - * @member {array} [route.endpointNames] The list of endpoints to which - * messages that satisfy the condition are routed. Currently only one endpoint - * is allowed. - * @member {boolean} [route.isEnabled] Used to specify whether a route is - * enabled. - */ +*/ export interface TestRouteInput { + /** + * Routing message + */ message?: RoutingMessage; + /** + * Route properties + */ route: RouteProperties; + /** + * Routing Twin Reference + */ + twin?: RoutingTwin; } /** - * @class - * Initializes a new instance of the RouteErrorPosition class. - * @constructor * Position where the route error happened - * - * @member {number} [line] Line where the route error happened - * @member {number} [column] Column where the route error happened - */ +*/ export interface RouteErrorPosition { + /** + * Line where the route error happened + */ line?: number; + /** + * Column where the route error happened + */ column?: number; } /** - * @class - * Initializes a new instance of the RouteErrorRange class. - * @constructor * Range of route errors - * - * @member {object} [start] Start where the route error happened - * @member {number} [start.line] Line where the route error happened - * @member {number} [start.column] Column where the route error happened - * @member {object} [end] End where the route error happened - * @member {number} [end.line] Line where the route error happened - * @member {number} [end.column] Column where the route error happened - */ +*/ export interface RouteErrorRange { + /** + * Start where the route error happened + */ start?: RouteErrorPosition; + /** + * End where the route error happened + */ end?: RouteErrorPosition; } /** - * @class - * Initializes a new instance of the RouteCompilationError class. - * @constructor * Compilation error when evaluating route - * - * @member {string} [message] Route error message - * @member {string} [severity] Severity of the route error. Possible values - * include: 'error', 'warning' - * @member {object} [location] Location where the route error happened - * @member {object} [location.start] Start where the route error happened - * @member {number} [location.start.line] Line where the route error happened - * @member {number} [location.start.column] Column where the route error - * happened - * @member {object} [location.end] End where the route error happened - * @member {number} [location.end.line] Line where the route error happened - * @member {number} [location.end.column] Column where the route error happened - */ +*/ export interface RouteCompilationError { + /** + * Route error message + */ message?: string; + /** + * Severity of the route error. Possible values include: 'error', 'warning' + */ severity?: string; + /** + * Location where the route error happened + */ location?: RouteErrorRange; } /** - * @class - * Initializes a new instance of the TestRouteResultDetails class. - * @constructor * Detailed result of testing a route - * - * @member {array} [compilationErrors] JSON-serialized list of route - * compilation errors - */ +*/ export interface TestRouteResultDetails { + /** + * JSON-serialized list of route compilation errors + */ compilationErrors?: RouteCompilationError[]; } /** - * @class - * Initializes a new instance of the TestRouteResult class. - * @constructor * Result of testing one route - * - * @member {string} [result] Result of testing route. Possible values include: - * 'undefined', 'false', 'true' - * @member {object} [details] Detailed result of testing route - * @member {array} [details.compilationErrors] JSON-serialized list of route - * compilation errors - */ +*/ export interface TestRouteResult { + /** + * Result of testing route. Possible values include: 'undefined', 'false', 'true' + */ result?: string; + /** + * Detailed result of testing route + */ details?: TestRouteResultDetails; } /** - * @class - * Initializes a new instance of the ExportDevicesRequest class. - * @constructor - * Use to provide parameters when requesting an export of all devices in the - * IoT hub. - * - * @member {string} exportBlobContainerUri The export blob container URI. - * @member {boolean} excludeKeys The value indicating whether keys should be - * excluded during export. - */ + * Use to provide parameters when requesting an export of all devices in the IoT hub. +*/ export interface ExportDevicesRequest { + /** + * The export blob container URI. + */ exportBlobContainerUri: string; + /** + * The value indicating whether keys should be excluded during export. + */ excludeKeys: boolean; } /** - * @class - * Initializes a new instance of the ImportDevicesRequest class. - * @constructor - * Use to provide parameters when requesting an import of all devices in the - * hub. - * - * @member {string} inputBlobContainerUri The input blob container URI. - * @member {string} outputBlobContainerUri The output blob container URI. - */ + * Use to provide parameters when requesting an import of all devices in the hub. +*/ export interface ImportDevicesRequest { + /** + * The input blob container URI. + */ inputBlobContainerUri: string; + /** + * The output blob container URI. + */ outputBlobContainerUri: string; } - /** - * @class - * Initializes a new instance of the OperationListResult class. - * @constructor - * 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. - * - * @member {string} [nextLink] URL to get the next set of operation list - * results if there are any. - */ + * 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. +*/ export interface OperationListResult extends Array { + /** + * URL to get the next set of operation list results if there are any. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the IotHubDescriptionListResult class. - * @constructor * The JSON-serialized array of IotHubDescription objects with a next link. - * - * @member {string} [nextLink] The next link. - */ +*/ export interface IotHubDescriptionListResult extends Array { + /** + * The next link. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the IotHubSkuDescriptionListResult class. - * @constructor * The JSON-serialized array of IotHubSkuDescription objects with a next link. - * - * @member {string} [nextLink] The next link. - */ +*/ export interface IotHubSkuDescriptionListResult extends Array { + /** + * The next link. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the EventHubConsumerGroupsListResult class. - * @constructor - * The JSON-serialized array of Event Hub-compatible consumer group names with - * a next link. - * - * @member {string} [nextLink] The next link. - */ + * The JSON-serialized array of Event Hub-compatible consumer group names with a next link. +*/ export interface EventHubConsumerGroupsListResult extends Array { + /** + * The next link. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the JobResponseListResult class. - * @constructor * The JSON-serialized array of JobResponse objects with a next link. - * - * @member {string} [nextLink] The next link. - */ +*/ export interface JobResponseListResult extends Array { + /** + * The next link. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the IotHubQuotaMetricInfoListResult class. - * @constructor * The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link. - * - * @member {string} [nextLink] The next link. - */ +*/ export interface IotHubQuotaMetricInfoListResult extends Array { + /** + * The next link. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the EndpointHealthDataListResult class. - * @constructor * The JSON-serialized array of EndpointHealthData objects with a next link. - * - * @member {string} [nextLink] Link to more results - */ +*/ export interface EndpointHealthDataListResult extends Array { + /** + * Link to more results + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the SharedAccessSignatureAuthorizationRuleListResult class. - * @constructor * The list of shared access policies with a next link. - * - * @member {string} [nextLink] The next link. - */ -export interface SharedAccessSignatureAuthorizationRuleListResult extends Array { +*/ +export interface SharedAccessSignatureAuthorizationRuleListResult extends +Array { + /** + * The next link. + */ readonly nextLink?: string; } diff --git a/lib/services/iothub/lib/models/index.js b/lib/services/iothub/lib/models/index.js index f38cce6532..b2821c5d2a 100644 --- a/lib/services/iothub/lib/models/index.js +++ b/lib/services/iothub/lib/models/index.js @@ -41,6 +41,7 @@ exports.MessagingEndpointProperties = require('./messagingEndpointProperties'); exports.FeedbackProperties = require('./feedbackProperties'); exports.CloudToDeviceProperties = require('./cloudToDeviceProperties'); exports.OperationsMonitoringProperties = require('./operationsMonitoringProperties'); +exports.IotHubPropertiesDeviceStreams = require('./iotHubPropertiesDeviceStreams'); exports.IotHubProperties = require('./iotHubProperties'); exports.IotHubSkuInfo = require('./iotHubSkuInfo'); exports.Resource = require('./resource'); @@ -62,6 +63,8 @@ exports.Name = require('./name'); exports.UserSubscriptionQuota = require('./userSubscriptionQuota'); exports.UserSubscriptionQuotaListResult = require('./userSubscriptionQuotaListResult'); exports.RoutingMessage = require('./routingMessage'); +exports.RoutingTwinProperties = require('./routingTwinProperties'); +exports.RoutingTwin = require('./routingTwin'); exports.TestAllRoutesInput = require('./testAllRoutesInput'); exports.MatchedRoute = require('./matchedRoute'); exports.TestAllRoutesResult = require('./testAllRoutesResult'); diff --git a/lib/services/iothub/lib/models/iotHubCapacity.js b/lib/services/iothub/lib/models/iotHubCapacity.js index bd659edda0..54a3eeef91 100644 --- a/lib/services/iothub/lib/models/iotHubCapacity.js +++ b/lib/services/iothub/lib/models/iotHubCapacity.js @@ -17,10 +17,10 @@ class IotHubCapacity { /** * Create a IotHubCapacity. - * @member {number} [minimum] The minimum number of units. - * @member {number} [maximum] The maximum number of units. - * @member {number} [default] The default number of units. - * @member {string} [scaleType] The type of the scaling enabled. Possible + * @property {number} [minimum] The minimum number of units. + * @property {number} [maximum] The maximum number of units. + * @property {number} [default] The default number of units. + * @property {string} [scaleType] The type of the scaling enabled. Possible * values include: 'Automatic', 'Manual', 'None' */ constructor() { diff --git a/lib/services/iothub/lib/models/iotHubDescription.js b/lib/services/iothub/lib/models/iotHubDescription.js index add57e644a..a71e9e4e44 100644 --- a/lib/services/iothub/lib/models/iotHubDescription.js +++ b/lib/services/iothub/lib/models/iotHubDescription.js @@ -20,101 +20,106 @@ const models = require('./index'); class IotHubDescription extends models['Resource'] { /** * Create a IotHubDescription. - * @member {string} [etag] The Etag field is *not* required. If it is + * @property {string} [etag] 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. - * @member {object} [properties] IotHub properties - * @member {array} [properties.authorizationPolicies] The shared access + * @property {object} [properties] IotHub properties + * @property {array} [properties.authorizationPolicies] The shared access * policies you can use to secure a connection to the IoT hub. - * @member {array} [properties.ipFilterRules] The IP filter rules. - * @member {string} [properties.provisioningState] The provisioning state. - * @member {string} [properties.state] Thehub state state. - * @member {string} [properties.hostName] The name of the host. - * @member {object} [properties.eventHubEndpoints] The Event Hub-compatible + * @property {array} [properties.ipFilterRules] The IP filter rules. + * @property {string} [properties.provisioningState] The provisioning state. + * @property {string} [properties.state] The hub state. + * @property {string} [properties.hostName] The name of the host. + * @property {object} [properties.eventHubEndpoints] The Event Hub-compatible * endpoint properties. The possible keys to this dictionary are events and * operationsMonitoringEvents. Both of these keys have to be present in the * dictionary while making create or update calls for the IoT hub. - * @member {object} [properties.routing] - * @member {object} [properties.routing.endpoints] - * @member {array} [properties.routing.endpoints.serviceBusQueues] The list + * @property {object} [properties.routing] + * @property {object} [properties.routing.endpoints] + * @property {array} [properties.routing.endpoints.serviceBusQueues] The list * of Service Bus queue endpoints that IoT hub routes the messages to, based * on the routing rules. - * @member {array} [properties.routing.endpoints.serviceBusTopics] The list + * @property {array} [properties.routing.endpoints.serviceBusTopics] The list * of Service Bus topic endpoints that the IoT hub routes the messages to, * based on the routing rules. - * @member {array} [properties.routing.endpoints.eventHubs] The list of Event - * Hubs endpoints that IoT hub routes messages to, based on the routing + * @property {array} [properties.routing.endpoints.eventHubs] 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. - * @member {array} [properties.routing.endpoints.storageContainers] The list - * of storage container endpoints that IoT hub routes messages to, based on - * the routing rules. - * @member {array} [properties.routing.routes] The list of user-provided + * @property {array} [properties.routing.endpoints.storageContainers] The + * list of storage container endpoints that IoT hub routes messages to, based + * on the routing rules. + * @property {array} [properties.routing.routes] 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. - * @member {object} [properties.routing.fallbackRoute] The properties of the - * route that is used as a fall-back route when none of the conditions + * @property {object} [properties.routing.fallbackRoute] The properties of + * the route that is used as a fall-back route when none of the conditions * specified in the 'routes' section are met. This is an optional parameter. * When this property is not set, the messages which do not meet any of the * conditions specified in the 'routes' section get routed to the built-in * eventhub endpoint. - * @member {string} [properties.routing.fallbackRoute.name] The name of the + * @property {string} [properties.routing.fallbackRoute.name] 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. - * @member {string} [properties.routing.fallbackRoute.condition] The + * @property {string} [properties.routing.fallbackRoute.condition] 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-language - * @member {array} [properties.routing.fallbackRoute.endpointNames] The list - * of endpoints to which the messages that satisfy the condition are routed - * to. Currently only 1 endpoint is allowed. - * @member {boolean} [properties.routing.fallbackRoute.isEnabled] Used to + * @property {array} [properties.routing.fallbackRoute.endpointNames] The + * list of endpoints to which the messages that satisfy the condition are + * routed to. Currently only 1 endpoint is allowed. + * @property {boolean} [properties.routing.fallbackRoute.isEnabled] Used to * specify whether the fallback route is enabled. - * @member {object} [properties.storageEndpoints] The list of Azure Storage + * @property {object} [properties.storageEndpoints] 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. - * @member {object} [properties.messagingEndpoints] The messaging endpoint + * @property {object} [properties.messagingEndpoints] The messaging endpoint * properties for the file upload notification queue. - * @member {boolean} [properties.enableFileUploadNotifications] If True, file - * upload notifications are enabled. - * @member {object} [properties.cloudToDevice] - * @member {number} [properties.cloudToDevice.maxDeliveryCount] The max + * @property {boolean} [properties.enableFileUploadNotifications] If True, + * file upload notifications are enabled. + * @property {object} [properties.cloudToDevice] + * @property {number} [properties.cloudToDevice.maxDeliveryCount] 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. - * @member {moment.duration} [properties.cloudToDevice.defaultTtlAsIso8601] + * @property {moment.duration} [properties.cloudToDevice.defaultTtlAsIso8601] * 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. - * @member {object} [properties.cloudToDevice.feedback] - * @member {moment.duration} + * @property {object} [properties.cloudToDevice.feedback] + * @property {moment.duration} * [properties.cloudToDevice.feedback.lockDurationAsIso8601] The lock * duration for the feedback queue. See: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. - * @member {moment.duration} [properties.cloudToDevice.feedback.ttlAsIso8601] - * The period of time for which a message is available to consume before it - * is expired by the IoT hub. See: + * @property {moment.duration} + * [properties.cloudToDevice.feedback.ttlAsIso8601] 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. - * @member {number} [properties.cloudToDevice.feedback.maxDeliveryCount] The - * number of times the IoT hub attempts to deliver a message on the feedback - * queue. See: + * @property {number} [properties.cloudToDevice.feedback.maxDeliveryCount] + * 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. - * @member {string} [properties.comments] IoT hub comments. - * @member {object} [properties.operationsMonitoringProperties] - * @member {object} [properties.operationsMonitoringProperties.events] - * @member {string} [properties.features] The capabilities and features + * @property {string} [properties.comments] IoT hub comments. + * @property {object} [properties.operationsMonitoringProperties] + * @property {object} [properties.operationsMonitoringProperties.events] + * @property {object} [properties.deviceStreams] The device streams + * properties of iothub. + * @property {array} [properties.deviceStreams.streamingEndpoints] List of + * Device Streams Endpoints. + * @property {string} [properties.features] The capabilities and features * enabled for the IoT hub. Possible values include: 'None', * 'DeviceManagement' - * @member {object} sku IotHub SKU info - * @member {string} [sku.name] The name of the SKU. Possible values include: - * 'F1', 'S1', 'S2', 'S3', 'B1', 'B2', 'B3' - * @member {string} [sku.tier] The billing tier for the IoT hub. Possible + * @property {object} sku IotHub SKU info + * @property {string} [sku.name] The name of the SKU. Possible values + * include: 'F1', 'S1', 'S2', 'S3', 'B1', 'B2', 'B3' + * @property {string} [sku.tier] The billing tier for the IoT hub. Possible * values include: 'Free', 'Standard', 'Basic' - * @member {number} [sku.capacity] The number of provisioned IoT Hub units. + * @property {number} [sku.capacity] The number of provisioned IoT Hub units. * See: * https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. */ @@ -149,7 +154,7 @@ class IotHubDescription extends models['Resource'] { readOnly: true, serializedName: 'name', constraints: { - Pattern: '^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$' + Pattern: /^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$/ }, type: { name: 'String' diff --git a/lib/services/iothub/lib/models/iotHubDescriptionListResult.js b/lib/services/iothub/lib/models/iotHubDescriptionListResult.js index 74ccdb7dcd..cbad92b24a 100644 --- a/lib/services/iothub/lib/models/iotHubDescriptionListResult.js +++ b/lib/services/iothub/lib/models/iotHubDescriptionListResult.js @@ -16,7 +16,7 @@ class IotHubDescriptionListResult extends Array { /** * Create a IotHubDescriptionListResult. - * @member {string} [nextLink] The next link. + * @property {string} [nextLink] The next link. */ constructor() { super(); diff --git a/lib/services/iothub/lib/models/iotHubNameAvailabilityInfo.js b/lib/services/iothub/lib/models/iotHubNameAvailabilityInfo.js index b5544a6c5c..026b20070e 100644 --- a/lib/services/iothub/lib/models/iotHubNameAvailabilityInfo.js +++ b/lib/services/iothub/lib/models/iotHubNameAvailabilityInfo.js @@ -17,11 +17,11 @@ class IotHubNameAvailabilityInfo { /** * Create a IotHubNameAvailabilityInfo. - * @member {boolean} [nameAvailable] The value which indicates whether the + * @property {boolean} [nameAvailable] The value which indicates whether the * provided name is available. - * @member {string} [reason] The reason for unavailability. Possible values + * @property {string} [reason] The reason for unavailability. Possible values * include: 'Invalid', 'AlreadyExists' - * @member {string} [message] The detailed reason message. + * @property {string} [message] The detailed reason message. */ constructor() { } diff --git a/lib/services/iothub/lib/models/iotHubProperties.js b/lib/services/iothub/lib/models/iotHubProperties.js index 5df368eb85..8fba799547 100644 --- a/lib/services/iothub/lib/models/iotHubProperties.js +++ b/lib/services/iothub/lib/models/iotHubProperties.js @@ -17,86 +17,91 @@ class IotHubProperties { /** * Create a IotHubProperties. - * @member {array} [authorizationPolicies] The shared access policies you can - * use to secure a connection to the IoT hub. - * @member {array} [ipFilterRules] The IP filter rules. - * @member {string} [provisioningState] The provisioning state. - * @member {string} [state] Thehub state state. - * @member {string} [hostName] The name of the host. - * @member {object} [eventHubEndpoints] The Event Hub-compatible endpoint + * @property {array} [authorizationPolicies] The shared access policies you + * can use to secure a connection to the IoT hub. + * @property {array} [ipFilterRules] The IP filter rules. + * @property {string} [provisioningState] The provisioning state. + * @property {string} [state] The hub state. + * @property {string} [hostName] The name of the host. + * @property {object} [eventHubEndpoints] The Event Hub-compatible endpoint * properties. The possible keys to this dictionary are events and * operationsMonitoringEvents. Both of these keys have to be present in the * dictionary while making create or update calls for the IoT hub. - * @member {object} [routing] - * @member {object} [routing.endpoints] - * @member {array} [routing.endpoints.serviceBusQueues] The list of Service + * @property {object} [routing] + * @property {object} [routing.endpoints] + * @property {array} [routing.endpoints.serviceBusQueues] The list of Service * Bus queue endpoints that IoT hub routes the messages to, based on the * routing rules. - * @member {array} [routing.endpoints.serviceBusTopics] The list of Service + * @property {array} [routing.endpoints.serviceBusTopics] The list of Service * Bus topic endpoints that the IoT hub routes the messages to, based on the * routing rules. - * @member {array} [routing.endpoints.eventHubs] The list of Event Hubs + * @property {array} [routing.endpoints.eventHubs] 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. - * @member {array} [routing.endpoints.storageContainers] The list of storage - * container endpoints that IoT hub routes messages to, based on the routing - * rules. - * @member {array} [routing.routes] The list of user-provided routing rules + * @property {array} [routing.endpoints.storageContainers] The list of + * storage container endpoints that IoT hub routes messages to, based on the + * routing rules. + * @property {array} [routing.routes] 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. - * @member {object} [routing.fallbackRoute] The properties of the route that - * is used as a fall-back route when none of the conditions specified in the - * 'routes' section are met. This is an optional parameter. When this + * @property {object} [routing.fallbackRoute] The properties of the route + * that is used as a fall-back route when none of the conditions specified in + * the 'routes' section are met. This is an optional parameter. When this * property is not set, the messages which do not meet any of the conditions * specified in the 'routes' section get routed to the built-in eventhub * endpoint. - * @member {string} [routing.fallbackRoute.name] The name of the route. The + * @property {string} [routing.fallbackRoute.name] 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. - * @member {string} [routing.fallbackRoute.condition] The condition which is - * evaluated in order to apply the fallback route. If the condition is not + * @property {string} [routing.fallbackRoute.condition] 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-language - * @member {array} [routing.fallbackRoute.endpointNames] The list of + * @property {array} [routing.fallbackRoute.endpointNames] The list of * endpoints to which the messages that satisfy the condition are routed to. * Currently only 1 endpoint is allowed. - * @member {boolean} [routing.fallbackRoute.isEnabled] Used to specify + * @property {boolean} [routing.fallbackRoute.isEnabled] Used to specify * whether the fallback route is enabled. - * @member {object} [storageEndpoints] The list of Azure Storage endpoints + * @property {object} [storageEndpoints] 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. - * @member {object} [messagingEndpoints] The messaging endpoint properties + * @property {object} [messagingEndpoints] The messaging endpoint properties * for the file upload notification queue. - * @member {boolean} [enableFileUploadNotifications] If True, file upload + * @property {boolean} [enableFileUploadNotifications] If True, file upload * notifications are enabled. - * @member {object} [cloudToDevice] - * @member {number} [cloudToDevice.maxDeliveryCount] The max delivery count + * @property {object} [cloudToDevice] + * @property {number} [cloudToDevice.maxDeliveryCount] 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. - * @member {moment.duration} [cloudToDevice.defaultTtlAsIso8601] The default - * time to live for cloud-to-device messages in the device queue. See: + * @property {moment.duration} [cloudToDevice.defaultTtlAsIso8601] 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. - * @member {object} [cloudToDevice.feedback] - * @member {moment.duration} [cloudToDevice.feedback.lockDurationAsIso8601] + * @property {object} [cloudToDevice.feedback] + * @property {moment.duration} [cloudToDevice.feedback.lockDurationAsIso8601] * The lock duration for the feedback queue. See: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. - * @member {moment.duration} [cloudToDevice.feedback.ttlAsIso8601] The period - * of time for which a message is available to consume before it is expired - * by the IoT hub. See: + * @property {moment.duration} [cloudToDevice.feedback.ttlAsIso8601] 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. - * @member {number} [cloudToDevice.feedback.maxDeliveryCount] The number of + * @property {number} [cloudToDevice.feedback.maxDeliveryCount] 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. - * @member {string} [comments] IoT hub comments. - * @member {object} [operationsMonitoringProperties] - * @member {object} [operationsMonitoringProperties.events] - * @member {string} [features] The capabilities and features enabled for the - * IoT hub. Possible values include: 'None', 'DeviceManagement' + * @property {string} [comments] IoT hub comments. + * @property {object} [operationsMonitoringProperties] + * @property {object} [operationsMonitoringProperties.events] + * @property {object} [deviceStreams] The device streams properties of + * iothub. + * @property {array} [deviceStreams.streamingEndpoints] List of Device + * Streams Endpoints. + * @property {string} [features] The capabilities and features enabled for + * the IoT hub. Possible values include: 'None', 'DeviceManagement' */ constructor() { } @@ -252,6 +257,14 @@ class IotHubProperties { className: 'OperationsMonitoringProperties' } }, + deviceStreams: { + required: false, + serializedName: 'deviceStreams', + type: { + name: 'Composite', + className: 'IotHubPropertiesDeviceStreams' + } + }, features: { required: false, serializedName: 'features', diff --git a/lib/services/iothub/lib/models/iotHubPropertiesDeviceStreams.js b/lib/services/iothub/lib/models/iotHubPropertiesDeviceStreams.js new file mode 100644 index 0000000000..2ec50de0c5 --- /dev/null +++ b/lib/services/iothub/lib/models/iotHubPropertiesDeviceStreams.js @@ -0,0 +1,59 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * The device streams properties of iothub. + * + */ +class IotHubPropertiesDeviceStreams { + /** + * Create a IotHubPropertiesDeviceStreams. + * @property {array} [streamingEndpoints] List of Device Streams Endpoints. + */ + constructor() { + } + + /** + * Defines the metadata of IotHubPropertiesDeviceStreams + * + * @returns {object} metadata of IotHubPropertiesDeviceStreams + * + */ + mapper() { + return { + required: false, + serializedName: 'IotHubProperties_deviceStreams', + type: { + name: 'Composite', + className: 'IotHubPropertiesDeviceStreams', + modelProperties: { + streamingEndpoints: { + required: false, + serializedName: 'streamingEndpoints', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'StringElementType', + type: { + name: 'String' + } + } + } + } + } + } + }; + } +} + +module.exports = IotHubPropertiesDeviceStreams; diff --git a/lib/services/iothub/lib/models/iotHubQuotaMetricInfo.js b/lib/services/iothub/lib/models/iotHubQuotaMetricInfo.js index b0c035e5fd..417d869860 100644 --- a/lib/services/iothub/lib/models/iotHubQuotaMetricInfo.js +++ b/lib/services/iothub/lib/models/iotHubQuotaMetricInfo.js @@ -17,9 +17,9 @@ class IotHubQuotaMetricInfo { /** * Create a IotHubQuotaMetricInfo. - * @member {string} [name] The name of the quota metric. - * @member {number} [currentValue] The current value for the quota metric. - * @member {number} [maxValue] The maximum value of the quota metric. + * @property {string} [name] The name of the quota metric. + * @property {number} [currentValue] The current value for the quota metric. + * @property {number} [maxValue] The maximum value of the quota metric. */ constructor() { } diff --git a/lib/services/iothub/lib/models/iotHubQuotaMetricInfoListResult.js b/lib/services/iothub/lib/models/iotHubQuotaMetricInfoListResult.js index 57fa92bbbf..968a39292b 100644 --- a/lib/services/iothub/lib/models/iotHubQuotaMetricInfoListResult.js +++ b/lib/services/iothub/lib/models/iotHubQuotaMetricInfoListResult.js @@ -16,7 +16,7 @@ class IotHubQuotaMetricInfoListResult extends Array { /** * Create a IotHubQuotaMetricInfoListResult. - * @member {string} [nextLink] The next link. + * @property {string} [nextLink] The next link. */ constructor() { super(); diff --git a/lib/services/iothub/lib/models/iotHubSkuDescription.js b/lib/services/iothub/lib/models/iotHubSkuDescription.js index 696d9c69b0..60db447ebe 100644 --- a/lib/services/iothub/lib/models/iotHubSkuDescription.js +++ b/lib/services/iothub/lib/models/iotHubSkuDescription.js @@ -17,20 +17,20 @@ class IotHubSkuDescription { /** * Create a IotHubSkuDescription. - * @member {string} [resourceType] The type of the resource. - * @member {object} sku The type of the resource. - * @member {string} [sku.name] The name of the SKU. Possible values include: - * 'F1', 'S1', 'S2', 'S3', 'B1', 'B2', 'B3' - * @member {string} [sku.tier] The billing tier for the IoT hub. Possible + * @property {string} [resourceType] The type of the resource. + * @property {object} sku The type of the resource. + * @property {string} [sku.name] The name of the SKU. Possible values + * include: 'F1', 'S1', 'S2', 'S3', 'B1', 'B2', 'B3' + * @property {string} [sku.tier] The billing tier for the IoT hub. Possible * values include: 'Free', 'Standard', 'Basic' - * @member {number} [sku.capacity] The number of provisioned IoT Hub units. + * @property {number} [sku.capacity] The number of provisioned IoT Hub units. * See: * https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. - * @member {object} capacity IotHub capacity - * @member {number} [capacity.minimum] The minimum number of units. - * @member {number} [capacity.maximum] The maximum number of units. - * @member {number} [capacity.default] The default number of units. - * @member {string} [capacity.scaleType] The type of the scaling enabled. + * @property {object} capacity IotHub capacity + * @property {number} [capacity.minimum] The minimum number of units. + * @property {number} [capacity.maximum] The maximum number of units. + * @property {number} [capacity.default] The default number of units. + * @property {string} [capacity.scaleType] The type of the scaling enabled. * Possible values include: 'Automatic', 'Manual', 'None' */ constructor() { diff --git a/lib/services/iothub/lib/models/iotHubSkuDescriptionListResult.js b/lib/services/iothub/lib/models/iotHubSkuDescriptionListResult.js index 0c749f98d3..7e60712dfe 100644 --- a/lib/services/iothub/lib/models/iotHubSkuDescriptionListResult.js +++ b/lib/services/iothub/lib/models/iotHubSkuDescriptionListResult.js @@ -16,7 +16,7 @@ class IotHubSkuDescriptionListResult extends Array { /** * Create a IotHubSkuDescriptionListResult. - * @member {string} [nextLink] The next link. + * @property {string} [nextLink] The next link. */ constructor() { super(); diff --git a/lib/services/iothub/lib/models/iotHubSkuInfo.js b/lib/services/iothub/lib/models/iotHubSkuInfo.js index 8ee4cdb71d..bd1f953a98 100644 --- a/lib/services/iothub/lib/models/iotHubSkuInfo.js +++ b/lib/services/iothub/lib/models/iotHubSkuInfo.js @@ -17,11 +17,12 @@ class IotHubSkuInfo { /** * Create a IotHubSkuInfo. - * @member {string} name The name of the SKU. Possible values include: 'F1', - * 'S1', 'S2', 'S3', 'B1', 'B2', 'B3' - * @member {string} [tier] The billing tier for the IoT hub. Possible values - * include: 'Free', 'Standard', 'Basic' - * @member {number} [capacity] The number of provisioned IoT Hub units. See: + * @property {string} name The name of the SKU. Possible values include: + * 'F1', 'S1', 'S2', 'S3', 'B1', 'B2', 'B3' + * @property {string} [tier] The billing tier for the IoT hub. Possible + * values include: 'Free', 'Standard', 'Basic' + * @property {number} [capacity] The number of provisioned IoT Hub units. + * See: * https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. */ constructor() { diff --git a/lib/services/iothub/lib/models/ipFilterRule.js b/lib/services/iothub/lib/models/ipFilterRule.js index 955a08bdca..7ea8743a6a 100644 --- a/lib/services/iothub/lib/models/ipFilterRule.js +++ b/lib/services/iothub/lib/models/ipFilterRule.js @@ -17,10 +17,10 @@ class IpFilterRule { /** * Create a IpFilterRule. - * @member {string} filterName The name of the IP filter rule. - * @member {string} action The desired action for requests captured by this + * @property {string} filterName The name of the IP filter rule. + * @property {string} action The desired action for requests captured by this * rule. Possible values include: 'Accept', 'Reject' - * @member {string} ipMask A string that contains the IP address range in + * @property {string} ipMask A string that contains the IP address range in * CIDR notation for the rule. */ constructor() { diff --git a/lib/services/iothub/lib/models/jobResponse.js b/lib/services/iothub/lib/models/jobResponse.js index 4ecd3b2357..d8a7b59629 100644 --- a/lib/services/iothub/lib/models/jobResponse.js +++ b/lib/services/iothub/lib/models/jobResponse.js @@ -17,19 +17,20 @@ class JobResponse { /** * Create a JobResponse. - * @member {string} [jobId] The job identifier. - * @member {date} [startTimeUtc] The start time of the job. - * @member {date} [endTimeUtc] The time the job stopped processing. - * @member {string} [type] The type of the job. Possible values include: + * @property {string} [jobId] The job identifier. + * @property {date} [startTimeUtc] The start time of the job. + * @property {date} [endTimeUtc] The time the job stopped processing. + * @property {string} [type] The type of the job. Possible values include: * 'unknown', 'export', 'import', 'backup', 'readDeviceProperties', * 'writeDeviceProperties', 'updateDeviceConfiguration', 'rebootDevice', * 'factoryResetDevice', 'firmwareUpdate' - * @member {string} [status] The status of the job. Possible values include: - * 'unknown', 'enqueued', 'running', 'completed', 'failed', 'cancelled' - * @member {string} [failureReason] If status == failed, this string + * @property {string} [status] The status of the job. Possible values + * include: 'unknown', 'enqueued', 'running', 'completed', 'failed', + * 'cancelled' + * @property {string} [failureReason] If status == failed, this string * containing the reason for the failure. - * @member {string} [statusMessage] The status message for the job. - * @member {string} [parentJobId] The job identifier of the parent job, if + * @property {string} [statusMessage] The status message for the job. + * @property {string} [parentJobId] The job identifier of the parent job, if * any. */ constructor() { diff --git a/lib/services/iothub/lib/models/jobResponseListResult.js b/lib/services/iothub/lib/models/jobResponseListResult.js index d5124de459..888dfddd9a 100644 --- a/lib/services/iothub/lib/models/jobResponseListResult.js +++ b/lib/services/iothub/lib/models/jobResponseListResult.js @@ -16,7 +16,7 @@ class JobResponseListResult extends Array { /** * Create a JobResponseListResult. - * @member {string} [nextLink] The next link. + * @property {string} [nextLink] The next link. */ constructor() { super(); diff --git a/lib/services/iothub/lib/models/matchedRoute.js b/lib/services/iothub/lib/models/matchedRoute.js index 2876130f08..11f2e8886c 100644 --- a/lib/services/iothub/lib/models/matchedRoute.js +++ b/lib/services/iothub/lib/models/matchedRoute.js @@ -17,22 +17,22 @@ class MatchedRoute { /** * Create a MatchedRoute. - * @member {object} [properties] Properties of routes that matched - * @member {string} [properties.name] The name of the route. The name can + * @property {object} [properties] Properties of routes that matched + * @property {string} [properties.name] 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. - * @member {string} [properties.source] The source that the routing rule is + * @property {string} [properties.source] The source that the routing rule is * to be applied to, such as DeviceMessages. Possible values include: * 'Invalid', 'DeviceMessages', 'TwinChangeEvents', 'DeviceLifecycleEvents', * 'DeviceJobLifecycleEvents' - * @member {string} [properties.condition] The condition that is evaluated to - * apply the routing rule. If no condition is provided, it evaluates to true - * by default. For grammar, see: + * @property {string} [properties.condition] 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-language - * @member {array} [properties.endpointNames] The list of endpoints to which - * messages that satisfy the condition are routed. Currently only one + * @property {array} [properties.endpointNames] The list of endpoints to + * which messages that satisfy the condition are routed. Currently only one * endpoint is allowed. - * @member {boolean} [properties.isEnabled] Used to specify whether a route + * @property {boolean} [properties.isEnabled] Used to specify whether a route * is enabled. */ constructor() { diff --git a/lib/services/iothub/lib/models/messagingEndpointProperties.js b/lib/services/iothub/lib/models/messagingEndpointProperties.js index 66fcf5d3ea..1306d02a0a 100644 --- a/lib/services/iothub/lib/models/messagingEndpointProperties.js +++ b/lib/services/iothub/lib/models/messagingEndpointProperties.js @@ -17,12 +17,13 @@ class MessagingEndpointProperties { /** * Create a MessagingEndpointProperties. - * @member {moment.duration} [lockDurationAsIso8601] The lock duration. See: + * @property {moment.duration} [lockDurationAsIso8601] The lock duration. + * See: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. - * @member {moment.duration} [ttlAsIso8601] The period of time for which a + * @property {moment.duration} [ttlAsIso8601] 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. - * @member {number} [maxDeliveryCount] The number of times the IoT hub + * @property {number} [maxDeliveryCount] 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. */ diff --git a/lib/services/iothub/lib/models/name.js b/lib/services/iothub/lib/models/name.js index 3d0a507ef4..393276c387 100644 --- a/lib/services/iothub/lib/models/name.js +++ b/lib/services/iothub/lib/models/name.js @@ -17,8 +17,8 @@ class Name { /** * Create a Name. - * @member {string} [value] IotHub type - * @member {string} [localizedValue] Localized value of name + * @property {string} [value] IotHub type + * @property {string} [localizedValue] Localized value of name */ constructor() { } diff --git a/lib/services/iothub/lib/models/operation.js b/lib/services/iothub/lib/models/operation.js index cc8c17ff2b..ea2f947553 100644 --- a/lib/services/iothub/lib/models/operation.js +++ b/lib/services/iothub/lib/models/operation.js @@ -17,12 +17,13 @@ class Operation { /** * Create a Operation. - * @member {string} [name] Operation name: {provider}/{resource}/{read | + * @property {string} [name] Operation name: {provider}/{resource}/{read | * write | action | delete} - * @member {object} [display] The object that represents the operation. - * @member {string} [display.provider] Service provider: Microsoft Devices - * @member {string} [display.resource] Resource Type: IotHubs - * @member {string} [display.operation] Name of the operation + * @property {object} [display] The object that represents the operation. + * @property {string} [display.provider] Service provider: Microsoft Devices + * @property {string} [display.resource] Resource Type: IotHubs + * @property {string} [display.operation] Name of the operation + * @property {string} [display.description] Description of the operation */ constructor() { } diff --git a/lib/services/iothub/lib/models/operationDisplay.js b/lib/services/iothub/lib/models/operationDisplay.js index 378fc9907a..04297c47a9 100644 --- a/lib/services/iothub/lib/models/operationDisplay.js +++ b/lib/services/iothub/lib/models/operationDisplay.js @@ -17,9 +17,10 @@ class OperationDisplay { /** * Create a OperationDisplay. - * @member {string} [provider] Service provider: Microsoft Devices - * @member {string} [resource] Resource Type: IotHubs - * @member {string} [operation] Name of the operation + * @property {string} [provider] Service provider: Microsoft Devices + * @property {string} [resource] Resource Type: IotHubs + * @property {string} [operation] Name of the operation + * @property {string} [description] Description of the operation */ constructor() { } @@ -61,6 +62,14 @@ class OperationDisplay { type: { name: 'String' } + }, + description: { + required: false, + readOnly: true, + serializedName: 'description', + type: { + name: 'String' + } } } } diff --git a/lib/services/iothub/lib/models/operationInputs.js b/lib/services/iothub/lib/models/operationInputs.js index ce8f1bd7ac..497ef5174b 100644 --- a/lib/services/iothub/lib/models/operationInputs.js +++ b/lib/services/iothub/lib/models/operationInputs.js @@ -17,7 +17,7 @@ class OperationInputs { /** * Create a OperationInputs. - * @member {string} name The name of the IoT hub to check. + * @property {string} name The name of the IoT hub to check. */ constructor() { } diff --git a/lib/services/iothub/lib/models/operationListResult.js b/lib/services/iothub/lib/models/operationListResult.js index 60830f5405..9e9df059d0 100644 --- a/lib/services/iothub/lib/models/operationListResult.js +++ b/lib/services/iothub/lib/models/operationListResult.js @@ -17,7 +17,7 @@ class OperationListResult extends Array { /** * Create a OperationListResult. - * @member {string} [nextLink] URL to get the next set of operation list + * @property {string} [nextLink] URL to get the next set of operation list * results if there are any. */ constructor() { diff --git a/lib/services/iothub/lib/models/operationsMonitoringProperties.js b/lib/services/iothub/lib/models/operationsMonitoringProperties.js index e90ef26064..f5c9ee61db 100644 --- a/lib/services/iothub/lib/models/operationsMonitoringProperties.js +++ b/lib/services/iothub/lib/models/operationsMonitoringProperties.js @@ -20,7 +20,7 @@ class OperationsMonitoringProperties { /** * Create a OperationsMonitoringProperties. - * @member {object} [events] + * @property {object} [events] */ constructor() { } diff --git a/lib/services/iothub/lib/models/registryStatistics.js b/lib/services/iothub/lib/models/registryStatistics.js index 8f07cf9019..b7a89afa5b 100644 --- a/lib/services/iothub/lib/models/registryStatistics.js +++ b/lib/services/iothub/lib/models/registryStatistics.js @@ -17,11 +17,11 @@ class RegistryStatistics { /** * Create a RegistryStatistics. - * @member {number} [totalDeviceCount] The total count of devices in the + * @property {number} [totalDeviceCount] The total count of devices in the * identity registry. - * @member {number} [enabledDeviceCount] The count of enabled devices in the - * identity registry. - * @member {number} [disabledDeviceCount] The count of disabled devices in + * @property {number} [enabledDeviceCount] The count of enabled devices in + * the identity registry. + * @property {number} [disabledDeviceCount] The count of disabled devices in * the identity registry. */ constructor() { diff --git a/lib/services/iothub/lib/models/resource.js b/lib/services/iothub/lib/models/resource.js index 2dc0aa7ae7..b0dfced82c 100644 --- a/lib/services/iothub/lib/models/resource.js +++ b/lib/services/iothub/lib/models/resource.js @@ -20,11 +20,11 @@ const models = require('./index'); class Resource extends models['BaseResource'] { /** * Create a Resource. - * @member {string} [id] The resource identifier. - * @member {string} [name] The resource name. - * @member {string} [type] The resource type. - * @member {string} location The resource location. - * @member {object} [tags] The resource tags. + * @property {string} [id] The resource identifier. + * @property {string} [name] The resource name. + * @property {string} [type] The resource type. + * @property {string} location The resource location. + * @property {object} [tags] The resource tags. */ constructor() { super(); @@ -57,7 +57,7 @@ class Resource extends models['BaseResource'] { readOnly: true, serializedName: 'name', constraints: { - Pattern: '^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$' + Pattern: /^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$/ }, type: { name: 'String' diff --git a/lib/services/iothub/lib/models/routeCompilationError.js b/lib/services/iothub/lib/models/routeCompilationError.js index 4ef2adb36d..eab0e71b22 100644 --- a/lib/services/iothub/lib/models/routeCompilationError.js +++ b/lib/services/iothub/lib/models/routeCompilationError.js @@ -17,17 +17,18 @@ class RouteCompilationError { /** * Create a RouteCompilationError. - * @member {string} [message] Route error message - * @member {string} [severity] Severity of the route error. Possible values + * @property {string} [message] Route error message + * @property {string} [severity] Severity of the route error. Possible values * include: 'error', 'warning' - * @member {object} [location] Location where the route error happened - * @member {object} [location.start] Start where the route error happened - * @member {number} [location.start.line] Line where the route error happened - * @member {number} [location.start.column] Column where the route error + * @property {object} [location] Location where the route error happened + * @property {object} [location.start] Start where the route error happened + * @property {number} [location.start.line] Line where the route error * happened - * @member {object} [location.end] End where the route error happened - * @member {number} [location.end.line] Line where the route error happened - * @member {number} [location.end.column] Column where the route error + * @property {number} [location.start.column] Column where the route error + * happened + * @property {object} [location.end] End where the route error happened + * @property {number} [location.end.line] Line where the route error happened + * @property {number} [location.end.column] Column where the route error * happened */ constructor() { diff --git a/lib/services/iothub/lib/models/routeErrorPosition.js b/lib/services/iothub/lib/models/routeErrorPosition.js index 72c25b4d02..4fd332e15f 100644 --- a/lib/services/iothub/lib/models/routeErrorPosition.js +++ b/lib/services/iothub/lib/models/routeErrorPosition.js @@ -17,8 +17,8 @@ class RouteErrorPosition { /** * Create a RouteErrorPosition. - * @member {number} [line] Line where the route error happened - * @member {number} [column] Column where the route error happened + * @property {number} [line] Line where the route error happened + * @property {number} [column] Column where the route error happened */ constructor() { } diff --git a/lib/services/iothub/lib/models/routeErrorRange.js b/lib/services/iothub/lib/models/routeErrorRange.js index e883326507..fb101e8c4e 100644 --- a/lib/services/iothub/lib/models/routeErrorRange.js +++ b/lib/services/iothub/lib/models/routeErrorRange.js @@ -17,12 +17,12 @@ class RouteErrorRange { /** * Create a RouteErrorRange. - * @member {object} [start] Start where the route error happened - * @member {number} [start.line] Line where the route error happened - * @member {number} [start.column] Column where the route error happened - * @member {object} [end] End where the route error happened - * @member {number} [end.line] Line where the route error happened - * @member {number} [end.column] Column where the route error happened + * @property {object} [start] Start where the route error happened + * @property {number} [start.line] Line where the route error happened + * @property {number} [start.column] Column where the route error happened + * @property {object} [end] End where the route error happened + * @property {number} [end.line] Line where the route error happened + * @property {number} [end.column] Column where the route error happened */ constructor() { } diff --git a/lib/services/iothub/lib/models/routeProperties.js b/lib/services/iothub/lib/models/routeProperties.js index c5e9373034..0547caa8e8 100644 --- a/lib/services/iothub/lib/models/routeProperties.js +++ b/lib/services/iothub/lib/models/routeProperties.js @@ -18,20 +18,21 @@ class RouteProperties { /** * Create a RouteProperties. - * @member {string} name The name of the route. The name can only include + * @property {string} name 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. - * @member {string} source The source that the routing rule is to be applied - * to, such as DeviceMessages. Possible values include: 'Invalid', + * @property {string} source The source that the routing rule is to be + * applied to, such as DeviceMessages. Possible values include: 'Invalid', * 'DeviceMessages', 'TwinChangeEvents', 'DeviceLifecycleEvents', * 'DeviceJobLifecycleEvents' - * @member {string} [condition] The condition that is evaluated to apply the - * routing rule. If no condition is provided, it evaluates to true by + * @property {string} [condition] 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-language - * @member {array} endpointNames The list of endpoints to which messages that - * satisfy the condition are routed. Currently only one endpoint is allowed. - * @member {boolean} isEnabled Used to specify whether a route is enabled. + * @property {array} endpointNames The list of endpoints to which messages + * that satisfy the condition are routed. Currently only one endpoint is + * allowed. + * @property {boolean} isEnabled Used to specify whether a route is enabled. */ constructor() { } @@ -54,7 +55,7 @@ class RouteProperties { required: true, serializedName: 'name', constraints: { - Pattern: '^[A-Za-z0-9-._]{1,64}$' + Pattern: /^[A-Za-z0-9-._]{1,64}$/ }, type: { name: 'String' diff --git a/lib/services/iothub/lib/models/routingEndpoints.js b/lib/services/iothub/lib/models/routingEndpoints.js index 17026717cc..1b0c1bec53 100644 --- a/lib/services/iothub/lib/models/routingEndpoints.js +++ b/lib/services/iothub/lib/models/routingEndpoints.js @@ -20,14 +20,15 @@ class RoutingEndpoints { /** * Create a RoutingEndpoints. - * @member {array} [serviceBusQueues] The list of Service Bus queue endpoints - * that IoT hub routes the messages to, based on the routing rules. - * @member {array} [serviceBusTopics] The list of Service Bus topic endpoints - * that the IoT hub routes the messages to, based on the routing rules. - * @member {array} [eventHubs] 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. - * @member {array} [storageContainers] The list of storage container + * @property {array} [serviceBusQueues] The list of Service Bus queue + * endpoints that IoT hub routes the messages to, based on the routing rules. + * @property {array} [serviceBusTopics] The list of Service Bus topic + * endpoints that the IoT hub routes the messages to, based on the routing + * rules. + * @property {array} [eventHubs] 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. + * @property {array} [storageContainers] The list of storage container * endpoints that IoT hub routes messages to, based on the routing rules. */ constructor() { diff --git a/lib/services/iothub/lib/models/routingEventHubProperties.js b/lib/services/iothub/lib/models/routingEventHubProperties.js index fa24a651f5..00dc5bb155 100644 --- a/lib/services/iothub/lib/models/routingEventHubProperties.js +++ b/lib/services/iothub/lib/models/routingEventHubProperties.js @@ -17,16 +17,16 @@ class RoutingEventHubProperties { /** * Create a RoutingEventHubProperties. - * @member {string} connectionString The connection string of the event hub + * @property {string} connectionString The connection string of the event hub * endpoint. - * @member {string} name 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, operationsMonitoringEvents, fileNotifications, $default. Endpoint - * names must be unique across endpoint types. - * @member {string} [subscriptionId] The subscription identifier of the event - * hub endpoint. - * @member {string} [resourceGroup] The name of the resource group of the + * @property {string} name 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, operationsMonitoringEvents, fileNotifications, + * $default. Endpoint names must be unique across endpoint types. + * @property {string} [subscriptionId] The subscription identifier of the + * event hub endpoint. + * @property {string} [resourceGroup] The name of the resource group of the * event hub endpoint. */ constructor() { @@ -57,7 +57,7 @@ class RoutingEventHubProperties { required: true, serializedName: 'name', constraints: { - Pattern: '^[A-Za-z0-9-._]{1,64}$' + Pattern: /^[A-Za-z0-9-._]{1,64}$/ }, type: { name: 'String' diff --git a/lib/services/iothub/lib/models/routingMessage.js b/lib/services/iothub/lib/models/routingMessage.js index fe21825053..4ed964de4b 100644 --- a/lib/services/iothub/lib/models/routingMessage.js +++ b/lib/services/iothub/lib/models/routingMessage.js @@ -17,9 +17,9 @@ class RoutingMessage { /** * Create a RoutingMessage. - * @member {string} [body] Body of routing message - * @member {object} [appProperties] App properties - * @member {object} [systemProperties] System properties + * @property {string} [body] Body of routing message + * @property {object} [appProperties] App properties + * @property {object} [systemProperties] System properties */ constructor() { } diff --git a/lib/services/iothub/lib/models/routingProperties.js b/lib/services/iothub/lib/models/routingProperties.js index be0a8d9c55..947efb0eaa 100644 --- a/lib/services/iothub/lib/models/routingProperties.js +++ b/lib/services/iothub/lib/models/routingProperties.js @@ -18,38 +18,40 @@ class RoutingProperties { /** * Create a RoutingProperties. - * @member {object} [endpoints] - * @member {array} [endpoints.serviceBusQueues] The list of Service Bus queue - * endpoints that IoT hub routes the messages to, based on the routing rules. - * @member {array} [endpoints.serviceBusTopics] The list of Service Bus topic - * endpoints that the IoT hub routes the messages to, based on the routing + * @property {object} [endpoints] + * @property {array} [endpoints.serviceBusQueues] The list of Service Bus + * queue endpoints that IoT hub routes the messages to, based on the routing * rules. - * @member {array} [endpoints.eventHubs] The list of Event Hubs endpoints + * @property {array} [endpoints.serviceBusTopics] The list of Service Bus + * topic endpoints that the IoT hub routes the messages to, based on the + * routing rules. + * @property {array} [endpoints.eventHubs] 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. - * @member {array} [endpoints.storageContainers] The list of storage + * @property {array} [endpoints.storageContainers] The list of storage * container endpoints that IoT hub routes messages to, based on the routing * rules. - * @member {array} [routes] 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. - * @member {object} [fallbackRoute] The properties of the route that is used - * as a fall-back route when none of the conditions specified in the 'routes' - * section are met. This is an optional parameter. When this property is not - * set, the messages which do not meet any of the conditions specified in the - * 'routes' section get routed to the built-in eventhub endpoint. - * @member {string} [fallbackRoute.name] 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. - * @member {string} [fallbackRoute.condition] The condition which is + * @property {array} [routes] 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. + * @property {object} [fallbackRoute] The properties of the route that is + * used as a fall-back route when none of the conditions specified in the + * 'routes' section are met. This is an optional parameter. When this + * property is not set, the messages which do not meet any of the conditions + * specified in the 'routes' section get routed to the built-in eventhub + * endpoint. + * @property {string} [fallbackRoute.name] 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. + * @property {string} [fallbackRoute.condition] 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-language - * @member {array} [fallbackRoute.endpointNames] The list of endpoints to + * @property {array} [fallbackRoute.endpointNames] The list of endpoints to * which the messages that satisfy the condition are routed to. Currently * only 1 endpoint is allowed. - * @member {boolean} [fallbackRoute.isEnabled] Used to specify whether the + * @property {boolean} [fallbackRoute.isEnabled] Used to specify whether the * fallback route is enabled. */ constructor() { diff --git a/lib/services/iothub/lib/models/routingServiceBusQueueEndpointProperties.js b/lib/services/iothub/lib/models/routingServiceBusQueueEndpointProperties.js index b51c38c266..b144c4d6d9 100644 --- a/lib/services/iothub/lib/models/routingServiceBusQueueEndpointProperties.js +++ b/lib/services/iothub/lib/models/routingServiceBusQueueEndpointProperties.js @@ -17,17 +17,17 @@ class RoutingServiceBusQueueEndpointProperties { /** * Create a RoutingServiceBusQueueEndpointProperties. - * @member {string} connectionString The connection string of the service bus - * queue endpoint. - * @member {string} name 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, operationsMonitoringEvents, fileNotifications, $default. Endpoint - * names must be unique across endpoint types. The name need not be the same - * as the actual queue name. - * @member {string} [subscriptionId] The subscription identifier of the + * @property {string} connectionString The connection string of the service + * bus queue endpoint. + * @property {string} name 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, operationsMonitoringEvents, fileNotifications, + * $default. Endpoint names must be unique across endpoint types. The name + * need not be the same as the actual queue name. + * @property {string} [subscriptionId] The subscription identifier of the * service bus queue endpoint. - * @member {string} [resourceGroup] The name of the resource group of the + * @property {string} [resourceGroup] The name of the resource group of the * service bus queue endpoint. */ constructor() { @@ -58,7 +58,7 @@ class RoutingServiceBusQueueEndpointProperties { required: true, serializedName: 'name', constraints: { - Pattern: '^[A-Za-z0-9-._]{1,64}$' + Pattern: /^[A-Za-z0-9-._]{1,64}$/ }, type: { name: 'String' diff --git a/lib/services/iothub/lib/models/routingServiceBusTopicEndpointProperties.js b/lib/services/iothub/lib/models/routingServiceBusTopicEndpointProperties.js index 1fb7af6634..535cd0d858 100644 --- a/lib/services/iothub/lib/models/routingServiceBusTopicEndpointProperties.js +++ b/lib/services/iothub/lib/models/routingServiceBusTopicEndpointProperties.js @@ -17,17 +17,17 @@ class RoutingServiceBusTopicEndpointProperties { /** * Create a RoutingServiceBusTopicEndpointProperties. - * @member {string} connectionString The connection string of the service bus - * topic endpoint. - * @member {string} name 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, operationsMonitoringEvents, fileNotifications, $default. Endpoint - * names must be unique across endpoint types. The name need not be the same - * as the actual topic name. - * @member {string} [subscriptionId] The subscription identifier of the + * @property {string} connectionString The connection string of the service + * bus topic endpoint. + * @property {string} name 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, operationsMonitoringEvents, fileNotifications, + * $default. Endpoint names must be unique across endpoint types. The name + * need not be the same as the actual topic name. + * @property {string} [subscriptionId] The subscription identifier of the * service bus topic endpoint. - * @member {string} [resourceGroup] The name of the resource group of the + * @property {string} [resourceGroup] The name of the resource group of the * service bus topic endpoint. */ constructor() { @@ -58,7 +58,7 @@ class RoutingServiceBusTopicEndpointProperties { required: true, serializedName: 'name', constraints: { - Pattern: '^[A-Za-z0-9-._]{1,64}$' + Pattern: /^[A-Za-z0-9-._]{1,64}$/ }, type: { name: 'String' diff --git a/lib/services/iothub/lib/models/routingStorageContainerProperties.js b/lib/services/iothub/lib/models/routingStorageContainerProperties.js index cb12edf6ee..d704ff83c9 100644 --- a/lib/services/iothub/lib/models/routingStorageContainerProperties.js +++ b/lib/services/iothub/lib/models/routingStorageContainerProperties.js @@ -17,31 +17,31 @@ class RoutingStorageContainerProperties { /** * Create a RoutingStorageContainerProperties. - * @member {string} connectionString The connection string of the storage + * @property {string} connectionString The connection string of the storage * account. - * @member {string} name 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, operationsMonitoringEvents, fileNotifications, $default. Endpoint - * names must be unique across endpoint types. - * @member {string} [subscriptionId] The subscription identifier of the + * @property {string} name 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, operationsMonitoringEvents, fileNotifications, + * $default. Endpoint names must be unique across endpoint types. + * @property {string} [subscriptionId] The subscription identifier of the * storage account. - * @member {string} [resourceGroup] The name of the resource group of the + * @property {string} [resourceGroup] The name of the resource group of the * storage account. - * @member {string} containerName The name of storage container in the + * @property {string} containerName The name of storage container in the * storage account. - * @member {string} [fileNameFormat] File name format for the blob. Default + * @property {string} [fileNameFormat] File name format for the blob. Default * format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters * are mandatory but can be reordered. - * @member {number} [batchFrequencyInSeconds] Time interval at which blobs + * @property {number} [batchFrequencyInSeconds] Time interval at which blobs * are written to storage. Value should be between 60 and 720 seconds. * Default value is 300 seconds. - * @member {number} [maxChunkSizeInBytes] Maximum number of bytes for each + * @property {number} [maxChunkSizeInBytes] Maximum number of bytes for each * blob written to storage. Value should be between 10485760(10MB) and * 524288000(500MB). Default value is 314572800(300MB). - * @member {string} [encoding] Encoding that is used to serialize messages to - * blobs. Supported values are 'avro' and 'avrodeflate'. Default value is - * 'avro'. + * @property {string} [encoding] Encoding that is used to serialize messages + * to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default + * value is 'avro'. Possible values include: 'Avro', 'AvroDeflate', 'JSON' */ constructor() { } @@ -71,7 +71,7 @@ class RoutingStorageContainerProperties { required: true, serializedName: 'name', constraints: { - Pattern: '^[A-Za-z0-9-._]{1,64}$' + Pattern: /^[A-Za-z0-9-._]{1,64}$/ }, type: { name: 'String' diff --git a/lib/services/iothub/lib/models/routingTwin.js b/lib/services/iothub/lib/models/routingTwin.js new file mode 100644 index 0000000000..fd54456ec3 --- /dev/null +++ b/lib/services/iothub/lib/models/routingTwin.js @@ -0,0 +1,63 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * Twin reference input parameter. This is an optional parameter + * + */ +class RoutingTwin { + /** + * Create a RoutingTwin. + * @property {object} [tags] Twin Tags + * @property {object} [properties] + * @property {object} [properties.desired] Twin desired properties + * @property {object} [properties.reported] Twin desired properties + */ + constructor() { + } + + /** + * Defines the metadata of RoutingTwin + * + * @returns {object} metadata of RoutingTwin + * + */ + mapper() { + return { + required: false, + serializedName: 'RoutingTwin', + type: { + name: 'Composite', + className: 'RoutingTwin', + modelProperties: { + tags: { + required: false, + serializedName: 'tags', + type: { + name: 'Object' + } + }, + properties: { + required: false, + serializedName: 'properties', + type: { + name: 'Composite', + className: 'RoutingTwinProperties' + } + } + } + } + }; + } +} + +module.exports = RoutingTwin; diff --git a/lib/services/iothub/lib/models/routingTwinProperties.js b/lib/services/iothub/lib/models/routingTwinProperties.js new file mode 100644 index 0000000000..8b9f954d7b --- /dev/null +++ b/lib/services/iothub/lib/models/routingTwinProperties.js @@ -0,0 +1,59 @@ +/* + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the MIT License. See License.txt in the project root for + * license information. + * + * Code generated by Microsoft (R) AutoRest Code Generator. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. + */ + +'use strict'; + +/** + * Class representing a RoutingTwinProperties. + */ +class RoutingTwinProperties { + /** + * Create a RoutingTwinProperties. + * @property {object} [desired] Twin desired properties + * @property {object} [reported] Twin desired properties + */ + constructor() { + } + + /** + * Defines the metadata of RoutingTwinProperties + * + * @returns {object} metadata of RoutingTwinProperties + * + */ + mapper() { + return { + required: false, + serializedName: 'RoutingTwin_properties', + type: { + name: 'Composite', + className: 'RoutingTwinProperties', + modelProperties: { + desired: { + required: false, + serializedName: 'desired', + type: { + name: 'Object' + } + }, + reported: { + required: false, + serializedName: 'reported', + type: { + name: 'Object' + } + } + } + } + }; + } +} + +module.exports = RoutingTwinProperties; diff --git a/lib/services/iothub/lib/models/sharedAccessSignatureAuthorizationRule.js b/lib/services/iothub/lib/models/sharedAccessSignatureAuthorizationRule.js index 0a01c9e44e..10804f51c6 100644 --- a/lib/services/iothub/lib/models/sharedAccessSignatureAuthorizationRule.js +++ b/lib/services/iothub/lib/models/sharedAccessSignatureAuthorizationRule.js @@ -17,10 +17,10 @@ class SharedAccessSignatureAuthorizationRule { /** * Create a SharedAccessSignatureAuthorizationRule. - * @member {string} keyName The name of the shared access policy. - * @member {string} [primaryKey] The primary key. - * @member {string} [secondaryKey] The secondary key. - * @member {string} rights The permissions assigned to the shared access + * @property {string} keyName The name of the shared access policy. + * @property {string} [primaryKey] The primary key. + * @property {string} [secondaryKey] The secondary key. + * @property {string} rights The permissions assigned to the shared access * policy. Possible values include: 'RegistryRead', 'RegistryWrite', * 'ServiceConnect', 'DeviceConnect', 'RegistryRead, RegistryWrite', * 'RegistryRead, ServiceConnect', 'RegistryRead, DeviceConnect', diff --git a/lib/services/iothub/lib/models/sharedAccessSignatureAuthorizationRuleListResult.js b/lib/services/iothub/lib/models/sharedAccessSignatureAuthorizationRuleListResult.js index a2430f7dc8..97bb6b8966 100644 --- a/lib/services/iothub/lib/models/sharedAccessSignatureAuthorizationRuleListResult.js +++ b/lib/services/iothub/lib/models/sharedAccessSignatureAuthorizationRuleListResult.js @@ -16,7 +16,7 @@ class SharedAccessSignatureAuthorizationRuleListResult extends Array { /** * Create a SharedAccessSignatureAuthorizationRuleListResult. - * @member {string} [nextLink] The next link. + * @property {string} [nextLink] The next link. */ constructor() { super(); diff --git a/lib/services/iothub/lib/models/storageEndpointProperties.js b/lib/services/iothub/lib/models/storageEndpointProperties.js index dfdd9b08ec..6317bb994f 100644 --- a/lib/services/iothub/lib/models/storageEndpointProperties.js +++ b/lib/services/iothub/lib/models/storageEndpointProperties.js @@ -17,12 +17,12 @@ class StorageEndpointProperties { /** * Create a StorageEndpointProperties. - * @member {moment.duration} [sasTtlAsIso8601] The period of time for which - * the the SAS URI generated by IoT Hub for file upload is valid. See: + * @property {moment.duration} [sasTtlAsIso8601] 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. - * @member {string} connectionString The connection string for the Azure + * @property {string} connectionString The connection string for the Azure * Storage account to which files are uploaded. - * @member {string} containerName The name of the root container where you + * @property {string} containerName The name of the root container where you * upload files. The container need not exist but should be creatable using * the connectionString specified. */ diff --git a/lib/services/iothub/lib/models/tagsResource.js b/lib/services/iothub/lib/models/tagsResource.js index 856755ab9e..488e15580c 100644 --- a/lib/services/iothub/lib/models/tagsResource.js +++ b/lib/services/iothub/lib/models/tagsResource.js @@ -18,7 +18,7 @@ class TagsResource { /** * Create a TagsResource. - * @member {object} [tags] Resource tags + * @property {object} [tags] Resource tags */ constructor() { } diff --git a/lib/services/iothub/lib/models/testAllRoutesInput.js b/lib/services/iothub/lib/models/testAllRoutesInput.js index fd7786303c..d181ac90c3 100644 --- a/lib/services/iothub/lib/models/testAllRoutesInput.js +++ b/lib/services/iothub/lib/models/testAllRoutesInput.js @@ -17,13 +17,18 @@ class TestAllRoutesInput { /** * Create a TestAllRoutesInput. - * @member {string} [routingSource] Routing source. Possible values include: - * 'Invalid', 'DeviceMessages', 'TwinChangeEvents', 'DeviceLifecycleEvents', - * 'DeviceJobLifecycleEvents' - * @member {object} [message] Routing message - * @member {string} [message.body] Body of routing message - * @member {object} [message.appProperties] App properties - * @member {object} [message.systemProperties] System properties + * @property {string} [routingSource] Routing source. Possible values + * include: 'Invalid', 'DeviceMessages', 'TwinChangeEvents', + * 'DeviceLifecycleEvents', 'DeviceJobLifecycleEvents' + * @property {object} [message] Routing message + * @property {string} [message.body] Body of routing message + * @property {object} [message.appProperties] App properties + * @property {object} [message.systemProperties] System properties + * @property {object} [twin] Routing Twin Reference + * @property {object} [twin.tags] Twin Tags + * @property {object} [twin.properties] + * @property {object} [twin.properties.desired] Twin desired properties + * @property {object} [twin.properties.reported] Twin desired properties */ constructor() { } @@ -56,6 +61,14 @@ class TestAllRoutesInput { name: 'Composite', className: 'RoutingMessage' } + }, + twin: { + required: false, + serializedName: 'twin', + type: { + name: 'Composite', + className: 'RoutingTwin' + } } } } diff --git a/lib/services/iothub/lib/models/testAllRoutesResult.js b/lib/services/iothub/lib/models/testAllRoutesResult.js index b4972f53b4..0ae90045cf 100644 --- a/lib/services/iothub/lib/models/testAllRoutesResult.js +++ b/lib/services/iothub/lib/models/testAllRoutesResult.js @@ -17,7 +17,7 @@ class TestAllRoutesResult { /** * Create a TestAllRoutesResult. - * @member {array} [routes] JSON-serialized array of matched routes + * @property {array} [routes] JSON-serialized array of matched routes */ constructor() { } diff --git a/lib/services/iothub/lib/models/testRouteInput.js b/lib/services/iothub/lib/models/testRouteInput.js index f230d80df0..1dd58d6d42 100644 --- a/lib/services/iothub/lib/models/testRouteInput.js +++ b/lib/services/iothub/lib/models/testRouteInput.js @@ -17,27 +17,32 @@ class TestRouteInput { /** * Create a TestRouteInput. - * @member {object} [message] Routing message - * @member {string} [message.body] Body of routing message - * @member {object} [message.appProperties] App properties - * @member {object} [message.systemProperties] System properties - * @member {object} route Route properties - * @member {string} [route.name] The name of the route. The name can only + * @property {object} [message] Routing message + * @property {string} [message.body] Body of routing message + * @property {object} [message.appProperties] App properties + * @property {object} [message.systemProperties] System properties + * @property {object} route Route properties + * @property {string} [route.name] 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. - * @member {string} [route.source] The source that the routing rule is to be - * applied to, such as DeviceMessages. Possible values include: 'Invalid', + * @property {string} [route.source] The source that the routing rule is to + * be applied to, such as DeviceMessages. Possible values include: 'Invalid', * 'DeviceMessages', 'TwinChangeEvents', 'DeviceLifecycleEvents', * 'DeviceJobLifecycleEvents' - * @member {string} [route.condition] The condition that is evaluated to + * @property {string} [route.condition] 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-language - * @member {array} [route.endpointNames] The list of endpoints to which + * @property {array} [route.endpointNames] The list of endpoints to which * messages that satisfy the condition are routed. Currently only one * endpoint is allowed. - * @member {boolean} [route.isEnabled] Used to specify whether a route is + * @property {boolean} [route.isEnabled] Used to specify whether a route is * enabled. + * @property {object} [twin] Routing Twin Reference + * @property {object} [twin.tags] Twin Tags + * @property {object} [twin.properties] + * @property {object} [twin.properties.desired] Twin desired properties + * @property {object} [twin.properties.reported] Twin desired properties */ constructor() { } @@ -71,6 +76,14 @@ class TestRouteInput { name: 'Composite', className: 'RouteProperties' } + }, + twin: { + required: false, + serializedName: 'twin', + type: { + name: 'Composite', + className: 'RoutingTwin' + } } } } diff --git a/lib/services/iothub/lib/models/testRouteResult.js b/lib/services/iothub/lib/models/testRouteResult.js index b71c637203..0a175b3eec 100644 --- a/lib/services/iothub/lib/models/testRouteResult.js +++ b/lib/services/iothub/lib/models/testRouteResult.js @@ -17,11 +17,11 @@ class TestRouteResult { /** * Create a TestRouteResult. - * @member {string} [result] Result of testing route. Possible values + * @property {string} [result] Result of testing route. Possible values * include: 'undefined', 'false', 'true' - * @member {object} [details] Detailed result of testing route - * @member {array} [details.compilationErrors] JSON-serialized list of route - * compilation errors + * @property {object} [details] Detailed result of testing route + * @property {array} [details.compilationErrors] JSON-serialized list of + * route compilation errors */ constructor() { } diff --git a/lib/services/iothub/lib/models/testRouteResultDetails.js b/lib/services/iothub/lib/models/testRouteResultDetails.js index 29878f695d..76e362978b 100644 --- a/lib/services/iothub/lib/models/testRouteResultDetails.js +++ b/lib/services/iothub/lib/models/testRouteResultDetails.js @@ -17,7 +17,7 @@ class TestRouteResultDetails { /** * Create a TestRouteResultDetails. - * @member {array} [compilationErrors] JSON-serialized list of route + * @property {array} [compilationErrors] JSON-serialized list of route * compilation errors */ constructor() { diff --git a/lib/services/iothub/lib/models/userSubscriptionQuota.js b/lib/services/iothub/lib/models/userSubscriptionQuota.js index f619eff75d..a7f39ab485 100644 --- a/lib/services/iothub/lib/models/userSubscriptionQuota.js +++ b/lib/services/iothub/lib/models/userSubscriptionQuota.js @@ -17,14 +17,14 @@ class UserSubscriptionQuota { /** * Create a UserSubscriptionQuota. - * @member {string} [id] IotHub type id - * @member {string} [type] Response type - * @member {string} [unit] Unit of IotHub type - * @member {number} [currentValue] Current number of IotHub type - * @member {number} [limit] Numerical limit on IotHub type - * @member {object} [name] IotHub type - * @member {string} [name.value] IotHub type - * @member {string} [name.localizedValue] Localized value of name + * @property {string} [id] IotHub type id + * @property {string} [type] Response type + * @property {string} [unit] Unit of IotHub type + * @property {number} [currentValue] Current number of IotHub type + * @property {number} [limit] Numerical limit on IotHub type + * @property {object} [name] IotHub type + * @property {string} [name.value] IotHub type + * @property {string} [name.localizedValue] Localized value of name */ constructor() { } diff --git a/lib/services/iothub/lib/models/userSubscriptionQuotaListResult.js b/lib/services/iothub/lib/models/userSubscriptionQuotaListResult.js index 9ff6b9d3c9..af14bb588b 100644 --- a/lib/services/iothub/lib/models/userSubscriptionQuotaListResult.js +++ b/lib/services/iothub/lib/models/userSubscriptionQuotaListResult.js @@ -17,8 +17,8 @@ class UserSubscriptionQuotaListResult { /** * Create a UserSubscriptionQuotaListResult. - * @member {array} [value] - * @member {string} [nextLink] + * @property {array} [value] + * @property {string} [nextLink] */ constructor() { } diff --git a/lib/services/iothub/lib/operations/index.d.ts b/lib/services/iothub/lib/operations/index.d.ts index 06f2c43e9d..3ad5ac6ff5 100644 --- a/lib/services/iothub/lib/operations/index.d.ts +++ b/lib/services/iothub/lib/operations/index.d.ts @@ -345,6 +345,13 @@ export interface IotHubResource { * @param {object} * [iotHubDescription.properties.operationsMonitoringProperties.events] * + * @param {object} [iotHubDescription.properties.deviceStreams] The device + * streams properties of iothub. + * + * @param {array} + * [iotHubDescription.properties.deviceStreams.streamingEndpoints] List of + * Device Streams Endpoints. + * * @param {string} [iotHubDescription.properties.features] The capabilities and * features enabled for the IoT hub. Possible values include: 'None', * 'DeviceManagement' @@ -520,6 +527,13 @@ export interface IotHubResource { * @param {object} * [iotHubDescription.properties.operationsMonitoringProperties.events] * + * @param {object} [iotHubDescription.properties.deviceStreams] The device + * streams properties of iothub. + * + * @param {array} + * [iotHubDescription.properties.deviceStreams.streamingEndpoints] List of + * Device Streams Endpoints. + * * @param {string} [iotHubDescription.properties.features] The capabilities and * features enabled for the IoT hub. Possible values include: 'None', * 'DeviceManagement' @@ -1619,6 +1633,16 @@ export interface IotHubResource { * * @param {object} [input.message.systemProperties] System properties * + * @param {object} [input.twin] Routing Twin Reference + * + * @param {object} [input.twin.tags] Twin Tags + * + * @param {object} [input.twin.properties] + * + * @param {object} [input.twin.properties.desired] Twin desired properties + * + * @param {object} [input.twin.properties.reported] Twin desired properties + * * @param {string} iotHubName IotHub to be tested * * @param {string} resourceGroupName resource group which Iot Hub belongs to @@ -1655,6 +1679,16 @@ export interface IotHubResource { * * @param {object} [input.message.systemProperties] System properties * + * @param {object} [input.twin] Routing Twin Reference + * + * @param {object} [input.twin.tags] Twin Tags + * + * @param {object} [input.twin.properties] + * + * @param {object} [input.twin.properties.desired] Twin desired properties + * + * @param {object} [input.twin.properties.reported] Twin desired properties + * * @param {string} iotHubName IotHub to be tested * * @param {string} resourceGroupName resource group which Iot Hub belongs to @@ -1729,6 +1763,16 @@ export interface IotHubResource { * @param {boolean} input.route.isEnabled Used to specify whether a route is * enabled. * + * @param {object} [input.twin] Routing Twin Reference + * + * @param {object} [input.twin.tags] Twin Tags + * + * @param {object} [input.twin.properties] + * + * @param {object} [input.twin.properties.desired] Twin desired properties + * + * @param {object} [input.twin.properties.reported] Twin desired properties + * * @param {string} iotHubName IotHub to be tested * * @param {string} resourceGroupName resource group which Iot Hub belongs to @@ -1784,6 +1828,16 @@ export interface IotHubResource { * @param {boolean} input.route.isEnabled Used to specify whether a route is * enabled. * + * @param {object} [input.twin] Routing Twin Reference + * + * @param {object} [input.twin.tags] Twin Tags + * + * @param {object} [input.twin.properties] + * + * @param {object} [input.twin.properties.desired] Twin desired properties + * + * @param {object} [input.twin.properties.reported] Twin desired properties + * * @param {string} iotHubName IotHub to be tested * * @param {string} resourceGroupName resource group which Iot Hub belongs to @@ -2291,6 +2345,13 @@ export interface IotHubResource { * @param {object} * [iotHubDescription.properties.operationsMonitoringProperties.events] * + * @param {object} [iotHubDescription.properties.deviceStreams] The device + * streams properties of iothub. + * + * @param {array} + * [iotHubDescription.properties.deviceStreams.streamingEndpoints] List of + * Device Streams Endpoints. + * * @param {string} [iotHubDescription.properties.features] The capabilities and * features enabled for the IoT hub. Possible values include: 'None', * 'DeviceManagement' @@ -2466,6 +2527,13 @@ export interface IotHubResource { * @param {object} * [iotHubDescription.properties.operationsMonitoringProperties.events] * + * @param {object} [iotHubDescription.properties.deviceStreams] The device + * streams properties of iothub. + * + * @param {array} + * [iotHubDescription.properties.deviceStreams.streamingEndpoints] List of + * Device Streams Endpoints. + * * @param {string} [iotHubDescription.properties.features] The capabilities and * features enabled for the IoT hub. Possible values include: 'None', * 'DeviceManagement' diff --git a/lib/services/iothub/lib/operations/iotHubResource.js b/lib/services/iothub/lib/operations/iotHubResource.js index 7fcdfc131f..bc04de92cc 100644 --- a/lib/services/iothub/lib/operations/iotHubResource.js +++ b/lib/services/iothub/lib/operations/iotHubResource.js @@ -306,6 +306,13 @@ function _get(resourceGroupName, resourceName, options, callback) { * @param {object} * [iotHubDescription.properties.operationsMonitoringProperties.events] * + * @param {object} [iotHubDescription.properties.deviceStreams] The device + * streams properties of iothub. + * + * @param {array} + * [iotHubDescription.properties.deviceStreams.streamingEndpoints] List of + * Device Streams Endpoints. + * * @param {string} [iotHubDescription.properties.features] The capabilities and * features enabled for the IoT hub. Possible values include: 'None', * 'DeviceManagement' @@ -2567,6 +2574,16 @@ function _checkNameAvailability(name, options, callback) { * * @param {object} [input.message.systemProperties] System properties * + * @param {object} [input.twin] Routing Twin Reference + * + * @param {object} [input.twin.tags] Twin Tags + * + * @param {object} [input.twin.properties] + * + * @param {object} [input.twin.properties.desired] Twin desired properties + * + * @param {object} [input.twin.properties.reported] Twin desired properties + * * @param {string} iotHubName IotHub to be tested * * @param {string} resourceGroupName resource group which Iot Hub belongs to @@ -2765,6 +2782,16 @@ function _testAllRoutes(input, iotHubName, resourceGroupName, options, callback) * @param {boolean} input.route.isEnabled Used to specify whether a route is * enabled. * + * @param {object} [input.twin] Routing Twin Reference + * + * @param {object} [input.twin.tags] Twin Tags + * + * @param {object} [input.twin.properties] + * + * @param {object} [input.twin.properties.desired] Twin desired properties + * + * @param {object} [input.twin.properties.reported] Twin desired properties + * * @param {string} iotHubName IotHub to be tested * * @param {string} resourceGroupName resource group which Iot Hub belongs to @@ -3737,6 +3764,13 @@ function _importDevices(resourceGroupName, resourceName, importDevicesParameters * @param {object} * [iotHubDescription.properties.operationsMonitoringProperties.events] * + * @param {object} [iotHubDescription.properties.deviceStreams] The device + * streams properties of iothub. + * + * @param {array} + * [iotHubDescription.properties.deviceStreams.streamingEndpoints] List of + * Device Streams Endpoints. + * * @param {string} [iotHubDescription.properties.features] The capabilities and * features enabled for the IoT hub. Possible values include: 'None', * 'DeviceManagement' @@ -5633,6 +5667,13 @@ class IotHubResource { * @param {object} * [iotHubDescription.properties.operationsMonitoringProperties.events] * + * @param {object} [iotHubDescription.properties.deviceStreams] The device + * streams properties of iothub. + * + * @param {array} + * [iotHubDescription.properties.deviceStreams.streamingEndpoints] List of + * Device Streams Endpoints. + * * @param {string} [iotHubDescription.properties.features] The capabilities and * features enabled for the IoT hub. Possible values include: 'None', * 'DeviceManagement' @@ -5820,6 +5861,13 @@ class IotHubResource { * @param {object} * [iotHubDescription.properties.operationsMonitoringProperties.events] * + * @param {object} [iotHubDescription.properties.deviceStreams] The device + * streams properties of iothub. + * + * @param {array} + * [iotHubDescription.properties.deviceStreams.streamingEndpoints] List of + * Device Streams Endpoints. + * * @param {string} [iotHubDescription.properties.features] The capabilities and * features enabled for the IoT hub. Possible values include: 'None', * 'DeviceManagement' @@ -7339,6 +7387,16 @@ class IotHubResource { * * @param {object} [input.message.systemProperties] System properties * + * @param {object} [input.twin] Routing Twin Reference + * + * @param {object} [input.twin.tags] Twin Tags + * + * @param {object} [input.twin.properties] + * + * @param {object} [input.twin.properties.desired] Twin desired properties + * + * @param {object} [input.twin.properties.reported] Twin desired properties + * * @param {string} iotHubName IotHub to be tested * * @param {string} resourceGroupName resource group which Iot Hub belongs to @@ -7387,6 +7445,16 @@ class IotHubResource { * * @param {object} [input.message.systemProperties] System properties * + * @param {object} [input.twin] Routing Twin Reference + * + * @param {object} [input.twin.tags] Twin Tags + * + * @param {object} [input.twin.properties] + * + * @param {object} [input.twin.properties.desired] Twin desired properties + * + * @param {object} [input.twin.properties.reported] Twin desired properties + * * @param {string} iotHubName IotHub to be tested * * @param {string} resourceGroupName resource group which Iot Hub belongs to @@ -7476,6 +7544,16 @@ class IotHubResource { * @param {boolean} input.route.isEnabled Used to specify whether a route is * enabled. * + * @param {object} [input.twin] Routing Twin Reference + * + * @param {object} [input.twin.tags] Twin Tags + * + * @param {object} [input.twin.properties] + * + * @param {object} [input.twin.properties.desired] Twin desired properties + * + * @param {object} [input.twin.properties.reported] Twin desired properties + * * @param {string} iotHubName IotHub to be tested * * @param {string} resourceGroupName resource group which Iot Hub belongs to @@ -7543,6 +7621,16 @@ class IotHubResource { * @param {boolean} input.route.isEnabled Used to specify whether a route is * enabled. * + * @param {object} [input.twin] Routing Twin Reference + * + * @param {object} [input.twin.tags] Twin Tags + * + * @param {object} [input.twin.properties] + * + * @param {object} [input.twin.properties.desired] Twin desired properties + * + * @param {object} [input.twin.properties.reported] Twin desired properties + * * @param {string} iotHubName IotHub to be tested * * @param {string} resourceGroupName resource group which Iot Hub belongs to @@ -8173,6 +8261,13 @@ class IotHubResource { * @param {object} * [iotHubDescription.properties.operationsMonitoringProperties.events] * + * @param {object} [iotHubDescription.properties.deviceStreams] The device + * streams properties of iothub. + * + * @param {array} + * [iotHubDescription.properties.deviceStreams.streamingEndpoints] List of + * Device Streams Endpoints. + * * @param {string} [iotHubDescription.properties.features] The capabilities and * features enabled for the IoT hub. Possible values include: 'None', * 'DeviceManagement' @@ -8360,6 +8455,13 @@ class IotHubResource { * @param {object} * [iotHubDescription.properties.operationsMonitoringProperties.events] * + * @param {object} [iotHubDescription.properties.deviceStreams] The device + * streams properties of iothub. + * + * @param {array} + * [iotHubDescription.properties.deviceStreams.streamingEndpoints] List of + * Device Streams Endpoints. + * * @param {string} [iotHubDescription.properties.features] The capabilities and * features enabled for the IoT hub. Possible values include: 'None', * 'DeviceManagement' diff --git a/lib/services/iothub/package.json b/lib/services/iothub/package.json index c26a98bf7f..dd3e1468f3 100644 --- a/lib/services/iothub/package.json +++ b/lib/services/iothub/package.json @@ -22,4 +22,4 @@ "bugs": { "url": "https://github.com/azure/azure-sdk-for-node/issues" } -} \ No newline at end of file +}