[AutoPR] iothub/resource-manager

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

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;

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() {

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();

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() {
   }

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() {
   }

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() {
   }

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() {
   }

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();

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.
    */

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() {
   }

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();

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() {
   }

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();

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();

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() {
   }

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() {
   }

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() {
   }

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.
    */

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() {
   }