azure-arm-iothub
Advanced tools
Comparing version 1.0.1-preview to 1.1.0-preview
@@ -11,6 +11,7 @@ /* | ||
import { ServiceClientOptions, RequestOptions, ServiceCallback, HttpOperationResponse, ServiceClientCredentials } from 'ms-rest'; | ||
import { ServiceClientCredentials } from 'ms-rest'; | ||
import { AzureServiceClient, AzureServiceClientOptions } from 'ms-rest-azure'; | ||
import * as operations from "./operations"; | ||
declare class IotHubClient { | ||
declare class IotHubClient extends AzureServiceClient { | ||
/** | ||
@@ -36,4 +37,2 @@ * Initializes a new instance of the IotHubClient class. | ||
* | ||
* @param {string} [options.apiVersion] - The version of the API. | ||
* | ||
* @param {string} [options.acceptLanguage] - Gets or sets the preferred language for the response. | ||
@@ -46,3 +45,3 @@ * | ||
*/ | ||
constructor(credentials: ServiceClientCredentials, subscriptionId: string, baseUri?: string, options?: ServiceClientOptions); | ||
constructor(credentials: ServiceClientCredentials, subscriptionId: string, baseUri?: string, options?: AzureServiceClientOptions); | ||
@@ -62,2 +61,3 @@ credentials: ServiceClientCredentials; | ||
// Operation groups | ||
operations: operations.Operations; | ||
iotHubResource: operations.IotHubResource; | ||
@@ -64,0 +64,0 @@ } |
@@ -25,32 +25,18 @@ /* | ||
/** | ||
* @class | ||
* Initializes a new instance of the IotHubClient class. | ||
* @constructor | ||
* | ||
* @param {credentials} credentials - Credentials needed for the client to connect to Azure. | ||
* | ||
* @param {string} subscriptionId - The subscription identifier. | ||
* | ||
* @param {string} [baseUri] - The base URI of the service. | ||
* | ||
* @param {object} [options] - The parameter options | ||
* | ||
* @param {Array} [options.filters] - Filters to be added to the request pipeline | ||
* | ||
* @param {object} [options.requestOptions] - Options for the underlying request object | ||
* {@link https://github.com/request/request#requestoptions-callback Options doc} | ||
* | ||
* @param {boolean} [options.noRetryPolicy] - If set to true, turn off default retry policy | ||
* | ||
* @param {string} [options.apiVersion] - The version of the API. | ||
* | ||
* @param {string} [options.acceptLanguage] - Gets or sets the preferred language for the response. | ||
* | ||
* @param {number} [options.longRunningOperationRetryTimeout] - Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30. | ||
* | ||
* @param {boolean} [options.generateClientRequestId] - When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. | ||
* | ||
*/ | ||
/** Class representing a IotHubClient. */ | ||
class IotHubClient extends ServiceClient { | ||
/** | ||
* Create a IotHubClient. | ||
* @param {credentials} credentials - Credentials needed for the client to connect to Azure. | ||
* @param {string} subscriptionId - The subscription identifier. | ||
* @param {string} [baseUri] - The base URI of the service. | ||
* @param {object} [options] - The parameter options | ||
* @param {Array} [options.filters] - Filters to be added to the request pipeline | ||
* @param {object} [options.requestOptions] - Options for the underlying request object | ||
* {@link https://github.com/request/request#requestoptions-callback Options doc} | ||
* @param {boolean} [options.noRetryPolicy] - If set to true, turn off default retry policy | ||
* @param {string} [options.acceptLanguage] - Gets or sets the preferred language for the response. | ||
* @param {number} [options.longRunningOperationRetryTimeout] - Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30. | ||
* @param {boolean} [options.generateClientRequestId] - When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. | ||
*/ | ||
constructor(credentials, subscriptionId, baseUri, options) { | ||
@@ -68,3 +54,3 @@ if (credentials === null || credentials === undefined) { | ||
this.apiVersion = '2017-01-19'; | ||
this.apiVersion = '2017-07-01'; | ||
this.acceptLanguage = 'en-US'; | ||
@@ -82,5 +68,2 @@ this.longRunningOperationRetryTimeout = 30; | ||
this.addUserAgentInfo(`${packageInfo.name}/${packageInfo.version}`); | ||
if(options.apiVersion !== null && options.apiVersion !== undefined) { | ||
this.apiVersion = options.apiVersion; | ||
} | ||
if(options.acceptLanguage !== null && options.acceptLanguage !== undefined) { | ||
@@ -95,2 +78,3 @@ this.acceptLanguage = options.acceptLanguage; | ||
} | ||
this.operations = new operations.Operations(this); | ||
this.iotHubResource = new operations.IotHubResource(this); | ||
@@ -97,0 +81,0 @@ this.models = models; |
@@ -16,32 +16,26 @@ /* | ||
/** | ||
* @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. | ||
* | ||
*/ | ||
class CloudToDeviceProperties { | ||
/** | ||
* Create a CloudToDeviceProperties. | ||
* @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. | ||
*/ | ||
constructor() { | ||
@@ -48,0 +42,0 @@ } |
@@ -14,17 +14,13 @@ /* | ||
/** | ||
* @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. | ||
* | ||
*/ | ||
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. | ||
*/ | ||
constructor() { | ||
@@ -31,0 +27,0 @@ } |
@@ -14,15 +14,12 @@ /* | ||
/** | ||
* @class | ||
* Initializes a new instance of the EventHubConsumerGroupInfo class. | ||
* @constructor | ||
* The properties of the EventHubConsumerGroupInfo object. | ||
* | ||
* @member {object} [tags] The tags. | ||
* | ||
* @member {string} [id] The Event Hub-compatible consumer group identifier. | ||
* | ||
* @member {string} [name] The Event Hub-compatible consumer group name. | ||
* | ||
*/ | ||
class EventHubConsumerGroupInfo { | ||
/** | ||
* Create a EventHubConsumerGroupInfo. | ||
* @member {object} [tags] The tags. | ||
* @member {string} [id] The Event Hub-compatible consumer group identifier. | ||
* @member {string} [name] The Event Hub-compatible consumer group name. | ||
*/ | ||
constructor() { | ||
@@ -29,0 +26,0 @@ } |
@@ -14,12 +14,10 @@ /* | ||
/** | ||
* @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. | ||
* | ||
*/ | ||
class EventHubConsumerGroupsListResult extends Array { | ||
/** | ||
* Create a EventHubConsumerGroupsListResult. | ||
* @member {string} [nextLink] The next link. | ||
*/ | ||
constructor() { | ||
@@ -26,0 +24,0 @@ super(); |
@@ -14,25 +14,20 @@ /* | ||
/** | ||
* @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 paritions 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. | ||
* | ||
*/ | ||
class EventHubProperties { | ||
/** | ||
* Create a EventHubProperties. | ||
* @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 paritions 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. | ||
*/ | ||
constructor() { | ||
@@ -39,0 +34,0 @@ } |
@@ -14,15 +14,13 @@ /* | ||
/** | ||
* @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. | ||
* | ||
*/ | ||
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. | ||
*/ | ||
constructor() { | ||
@@ -29,0 +27,0 @@ } |
@@ -14,22 +14,19 @@ /* | ||
/** | ||
* @class | ||
* Initializes a new instance of the FallbackRouteProperties class. | ||
* @constructor | ||
* The properties related to the fallback route based on which the IoT hub | ||
* The properties of the fallback route. IoT Hub uses these properties when it | ||
* routes messages to the fallback endpoint. | ||
* | ||
* @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 or not. | ||
* | ||
*/ | ||
class FallbackRouteProperties { | ||
/** | ||
* Create a FallbackRouteProperties. | ||
* @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. | ||
*/ | ||
constructor() { | ||
@@ -36,0 +33,0 @@ } |
@@ -14,21 +14,18 @@ /* | ||
/** | ||
* @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. | ||
* | ||
*/ | ||
class FeedbackProperties { | ||
/** | ||
* Create a FeedbackProperties. | ||
* @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. | ||
*/ | ||
constructor() { | ||
@@ -35,0 +32,0 @@ } |
@@ -14,14 +14,12 @@ /* | ||
/** | ||
* @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. | ||
* | ||
*/ | ||
class ImportDevicesRequest { | ||
/** | ||
* Create a ImportDevicesRequest. | ||
* @member {string} inputBlobContainerUri The input blob container URI. | ||
* @member {string} outputBlobContainerUri The output blob container URI. | ||
*/ | ||
constructor() { | ||
@@ -28,0 +26,0 @@ } |
@@ -13,2 +13,3 @@ /* | ||
import { CloudError } from 'ms-rest-azure'; | ||
import * as moment from 'moment'; | ||
@@ -26,7 +27,4 @@ export { BaseResource } from 'ms-rest-azure'; | ||
* @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 | ||
@@ -42,3 +40,2 @@ * policy. Possible values include: 'RegistryRead', 'RegistryWrite', | ||
* ServiceConnect, DeviceConnect' | ||
* | ||
*/ | ||
@@ -59,9 +56,6 @@ export interface SharedAccessSignatureAuthorizationRule { | ||
* @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. | ||
* | ||
*/ | ||
@@ -84,14 +78,9 @@ export interface IpFilterRule { | ||
* https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages | ||
* | ||
* @member {number} [partitionCount] The number of paritions 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. | ||
* | ||
*/ | ||
@@ -114,16 +103,12 @@ export interface EventHubProperties { | ||
* queue endpoint. | ||
* | ||
* @member {string} name The name of the service bus queue endpoint. The name | ||
* can only include alphanumeric characters, periods, underscores, hyphens and | ||
* has a maximum length of 64 characters. The following names are reserved; | ||
* @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. | ||
* | ||
*/ | ||
@@ -145,16 +130,12 @@ export interface RoutingServiceBusQueueEndpointProperties { | ||
* topic endpoint. | ||
* | ||
* @member {string} name The name of the service bus topic endpoint. The name | ||
* can only include alphanumeric characters, periods, underscores, hyphens and | ||
* has a maximum length of 64 characters. The following names are reserved; | ||
* @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. | ||
* | ||
*/ | ||
@@ -176,15 +157,11 @@ export interface RoutingServiceBusTopicEndpointProperties { | ||
* endpoint. | ||
* | ||
* @member {string} name The name of the event hub 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} 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. | ||
* | ||
*/ | ||
@@ -200,2 +177,46 @@ export interface RoutingEventHubProperties { | ||
* @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 { | ||
connectionString: string; | ||
name: string; | ||
subscriptionId?: string; | ||
resourceGroup?: string; | ||
containerName: string; | ||
fileNameFormat?: string; | ||
batchFrequencyInSeconds?: number; | ||
maxChunkSizeInBytes?: number; | ||
encoding?: string; | ||
} | ||
/** | ||
* @class | ||
* Initializes a new instance of the RoutingEndpoints class. | ||
@@ -210,10 +231,9 @@ * @constructor | ||
* 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. | ||
*/ | ||
@@ -224,2 +244,3 @@ export interface RoutingEndpoints { | ||
eventHubs?: RoutingEventHubProperties[]; | ||
storageContainers?: RoutingStorageContainerProperties[]; | ||
} | ||
@@ -236,18 +257,13 @@ | ||
* alphanumeric characters, periods, underscores, hyphens, has a maximum length | ||
* of 64 characters, and must be unique. | ||
* | ||
* 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: '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: | ||
* 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. | ||
* | ||
*/ | ||
@@ -266,3 +282,3 @@ export interface RouteProperties { | ||
* @constructor | ||
* The properties related to the fallback route based on which the IoT hub | ||
* The properties of the fallback route. IoT Hub uses these properties when it | ||
* routes messages to the fallback endpoint. | ||
@@ -274,10 +290,7 @@ * | ||
* 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 or not. | ||
* | ||
* enabled. | ||
*/ | ||
@@ -298,14 +311,12 @@ export interface FallbackRouteProperties { | ||
* @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 | ||
@@ -315,3 +326,2 @@ * IoT hub uses to route messages to built-in and custom endpoints. A maximum | ||
* rules are allowed for free hubs. | ||
* | ||
* @member {object} [fallbackRoute] The properties of the route that is used as | ||
@@ -322,3 +332,2 @@ * a fall-back route when none of the conditions specified in the 'routes' | ||
* 'routes' section get routed to the built-in eventhub endpoint. | ||
* | ||
* @member {string} [fallbackRoute.condition] The condition which is evaluated | ||
@@ -328,10 +337,7 @@ * in order to apply the fallback route. If the condition is not provided it | ||
* 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 or not. | ||
* | ||
* fallback route is enabled. | ||
*/ | ||
@@ -353,10 +359,7 @@ export interface RoutingProperties { | ||
* 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. | ||
* | ||
*/ | ||
@@ -377,11 +380,8 @@ export interface StorageEndpointProperties { | ||
* 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. | ||
* | ||
*/ | ||
@@ -403,11 +403,8 @@ export interface MessagingEndpointProperties { | ||
* 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. | ||
* | ||
*/ | ||
@@ -429,13 +426,9 @@ export interface FeedbackProperties { | ||
* 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 | ||
@@ -445,7 +438,5 @@ * which a message is available to consume before it is expired by the IoT hub. | ||
* 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. | ||
* | ||
*/ | ||
@@ -468,3 +459,2 @@ export interface CloudToDeviceProperties { | ||
* @member {object} [events] | ||
* | ||
*/ | ||
@@ -483,9 +473,5 @@ export interface OperationsMonitoringProperties { | ||
* use to secure a connection to the IoT hub. | ||
* | ||
* @member {array} [ipFilterRules] The IP filter rules. | ||
* | ||
* @member {string} [provisioningState] The provisioning state. | ||
* | ||
* @member {string} [hostName] The name of the host. | ||
* | ||
* @member {object} [eventHubEndpoints] The Event Hub-compatible endpoint | ||
@@ -495,19 +481,16 @@ * properties. The possible keys to this dictionary are events and | ||
* 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 | ||
@@ -517,3 +500,2 @@ * that the IoT hub uses to route messages to built-in and custom endpoints. A | ||
* routing rules are allowed for free hubs. | ||
* | ||
* @member {object} [routing.fallbackRoute] The properties of the route that is | ||
@@ -524,3 +506,2 @@ * used as a fall-back route when none of the conditions specified in the | ||
* in the 'routes' section get routed to the built-in eventhub endpoint. | ||
* | ||
* @member {string} [routing.fallbackRoute.condition] The condition which is | ||
@@ -530,10 +511,7 @@ * evaluated in order to apply the fallback route. If the condition is not | ||
* 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 or not. | ||
* | ||
* the fallback route is enabled. | ||
* @member {object} [storageEndpoints] The list of Azure Storage endpoints | ||
@@ -545,25 +523,17 @@ * where you can upload files. Currently you can configure only one Azure | ||
* 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 | ||
@@ -573,16 +543,10 @@ * of time for which a message is available to consume before it is expired by | ||
* 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] Comments. | ||
* | ||
* @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' | ||
* | ||
*/ | ||
@@ -613,9 +577,6 @@ export interface IotHubProperties { | ||
* 'S1', 'S2', 'S3' | ||
* | ||
* @member {string} [tier] The billing tier for the IoT hub. Possible values | ||
* include: 'Free', 'Standard' | ||
* | ||
* @member {number} capacity The number of provisioned IoT Hub units. See: | ||
* https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. | ||
* | ||
*/ | ||
@@ -635,11 +596,6 @@ export interface IotHubSkuInfo { | ||
* @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. | ||
* | ||
*/ | ||
@@ -661,22 +617,14 @@ export interface Resource extends BaseResource { | ||
* @member {string} subscriptionid The subscription identifier. | ||
* | ||
* @member {string} resourcegroup The name of the resource group that contains | ||
* the IoT hub. A resource group name uniquely identifies the resource group | ||
* within the subscription. | ||
* | ||
* @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] | ||
* | ||
* @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.hostName] The name of the host. | ||
* | ||
* @member {object} [properties.eventHubEndpoints] The Event Hub-compatible | ||
@@ -686,19 +634,16 @@ * endpoint properties. The possible keys to this dictionary are events and | ||
* 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 | ||
@@ -708,3 +653,2 @@ * routing rules that the IoT hub uses to route messages to built-in and custom | ||
* maximum of 5 routing rules are allowed for free hubs. | ||
* | ||
* @member {object} [properties.routing.fallbackRoute] The properties of the | ||
@@ -716,3 +660,2 @@ * route that is used as a fall-back route when none of the conditions | ||
* eventhub endpoint. | ||
* | ||
* @member {string} [properties.routing.fallbackRoute.condition] The condition | ||
@@ -722,10 +665,7 @@ * which is evaluated in order to apply the fallback route. If the condition is | ||
* 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 or not. | ||
* | ||
* specify whether the fallback route is enabled. | ||
* @member {object} [properties.storageEndpoints] The list of Azure Storage | ||
@@ -737,21 +677,14 @@ * endpoints where you can upload files. Currently you can configure only one | ||
* 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} | ||
@@ -761,3 +694,2 @@ * [properties.cloudToDevice.feedback.lockDurationAsIso8601] The lock duration | ||
* https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | ||
* | ||
* @member {moment.duration} [properties.cloudToDevice.feedback.ttlAsIso8601] | ||
@@ -767,3 +699,2 @@ * The period of time for which a message is available to consume before it is | ||
* https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | ||
* | ||
* @member {number} [properties.cloudToDevice.feedback.maxDeliveryCount] The | ||
@@ -773,24 +704,15 @@ * number of times the IoT hub attempts to deliver a message on the feedback | ||
* https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. | ||
* | ||
* @member {string} [properties.comments] Comments. | ||
* | ||
* @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 | ||
* | ||
* @member {string} [sku.name] The name of the SKU. Possible values include: | ||
* 'F1', 'S1', 'S2', 'S3' | ||
* | ||
* @member {string} [sku.tier] The billing tier for the IoT hub. Possible | ||
* values include: 'Free', 'Standard' | ||
* | ||
* @member {number} [sku.capacity] The number of provisioned IoT Hub units. | ||
* See: | ||
* https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. | ||
* | ||
*/ | ||
@@ -807,14 +729,32 @@ export interface IotHubDescription extends Resource { | ||
* @class | ||
* Initializes a new instance of the SharedAccessSignatureAuthorizationRuleListResult class. | ||
* Initializes a new instance of the OperationDisplay class. | ||
* @constructor | ||
* The list of shared access policies with a next link. | ||
* The object that represents the operation. | ||
* | ||
* @member {array} [value] The list of shared access policies. | ||
* @member {string} [provider] Service provider: Microsoft Devices | ||
* @member {string} [resource] Resource Type: IotHubs | ||
* @member {string} [operation] Name of the operation | ||
*/ | ||
export interface OperationDisplay { | ||
readonly provider?: string; | ||
readonly resource?: string; | ||
readonly operation?: string; | ||
} | ||
/** | ||
* @class | ||
* Initializes a new instance of the Operation class. | ||
* @constructor | ||
* IoT Hub REST API operation | ||
* | ||
* @member {string} [nextLink] The next link. | ||
* | ||
* @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 SharedAccessSignatureAuthorizationRuleListResult { | ||
value?: SharedAccessSignatureAuthorizationRule[]; | ||
readonly nextLink?: string; | ||
export interface Operation { | ||
readonly name?: string; | ||
display?: OperationDisplay; | ||
} | ||
@@ -829,9 +769,5 @@ | ||
* @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. | ||
* | ||
*/ | ||
@@ -852,7 +788,4 @@ export interface ErrorDetails { | ||
* @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. | ||
* | ||
*/ | ||
@@ -867,18 +800,2 @@ export interface IotHubQuotaMetricInfo { | ||
* @class | ||
* Initializes a new instance of the IotHubQuotaMetricInfoListResult class. | ||
* @constructor | ||
* The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link. | ||
* | ||
* @member {array} [value] The array of quota metrics objects. | ||
* | ||
* @member {string} [nextLink] The next link. | ||
* | ||
*/ | ||
export interface IotHubQuotaMetricInfoListResult { | ||
value?: IotHubQuotaMetricInfo[]; | ||
readonly nextLink?: string; | ||
} | ||
/** | ||
* @class | ||
* Initializes a new instance of the RegistryStatistics class. | ||
@@ -890,9 +807,6 @@ * @constructor | ||
* 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. | ||
* | ||
*/ | ||
@@ -912,7 +826,4 @@ export interface RegistryStatistics { | ||
* @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: | ||
@@ -922,13 +833,8 @@ * 'unknown', 'export', 'import', 'backup', 'readDeviceProperties', | ||
* '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. | ||
* | ||
*/ | ||
@@ -948,18 +854,2 @@ export interface JobResponse { | ||
* @class | ||
* Initializes a new instance of the JobResponseListResult class. | ||
* @constructor | ||
* The JSON-serialized array of JobResponse objects with a next link. | ||
* | ||
* @member {array} [value] The array of JobResponse objects. | ||
* | ||
* @member {string} [nextLink] The next link. | ||
* | ||
*/ | ||
export interface JobResponseListResult { | ||
value?: JobResponse[]; | ||
readonly nextLink?: string; | ||
} | ||
/** | ||
* @class | ||
* Initializes a new instance of the IotHubCapacity class. | ||
@@ -970,10 +860,6 @@ * @constructor | ||
* @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' | ||
* | ||
*/ | ||
@@ -994,26 +880,16 @@ export interface IotHubCapacity { | ||
* @member {string} [resourceType] The type of the resource. | ||
* | ||
* @member {object} sku | ||
* | ||
* @member {string} [sku.name] The name of the SKU. Possible values include: | ||
* 'F1', 'S1', 'S2', 'S3' | ||
* | ||
* @member {string} [sku.tier] The billing tier for the IoT hub. Possible | ||
* values include: 'Free', 'Standard' | ||
* | ||
* @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 | ||
* | ||
* @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' | ||
* | ||
*/ | ||
@@ -1028,20 +904,2 @@ export interface IotHubSkuDescription { | ||
* @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 {array} [value] The array of Event Hub-compatible consumer group | ||
* names. | ||
* | ||
* @member {string} [nextLink] The next link. | ||
* | ||
*/ | ||
export interface EventHubConsumerGroupsListResult { | ||
value?: string[]; | ||
readonly nextLink?: string; | ||
} | ||
/** | ||
* @class | ||
* Initializes a new instance of the EventHubConsumerGroupInfo class. | ||
@@ -1052,7 +910,4 @@ * @constructor | ||
* @member {object} [tags] The tags. | ||
* | ||
* @member {string} [id] The Event Hub-compatible consumer group identifier. | ||
* | ||
* @member {string} [name] The Event Hub-compatible consumer group name. | ||
* | ||
*/ | ||
@@ -1067,34 +922,2 @@ export interface EventHubConsumerGroupInfo { | ||
* @class | ||
* Initializes a new instance of the IotHubSkuDescriptionListResult class. | ||
* @constructor | ||
* The JSON-serialized array of IotHubSkuDescription objects with a next link. | ||
* | ||
* @member {array} [value] The array of IotHubSkuDescription. | ||
* | ||
* @member {string} [nextLink] The next link. | ||
* | ||
*/ | ||
export interface IotHubSkuDescriptionListResult { | ||
value?: IotHubSkuDescription[]; | ||
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 {array} [value] The array of IotHubDescription objects. | ||
* | ||
* @member {string} [nextLink] The next link. | ||
* | ||
*/ | ||
export interface IotHubDescriptionListResult { | ||
value?: IotHubDescription[]; | ||
readonly nextLink?: string; | ||
} | ||
/** | ||
* @class | ||
* Initializes a new instance of the OperationInputs class. | ||
@@ -1105,3 +928,2 @@ * @constructor | ||
* @member {string} name The name of the IoT hub to check. | ||
* | ||
*/ | ||
@@ -1120,8 +942,5 @@ export interface OperationInputs { | ||
* provided name is available. | ||
* | ||
* @member {string} [reason] The reason for unavailability. Possible values | ||
* include: 'Invalid', 'AlreadyExists' | ||
* | ||
* @member {string} [message] The detailed reason message. | ||
* | ||
*/ | ||
@@ -1142,6 +961,4 @@ export interface IotHubNameAvailabilityInfo { | ||
* @member {string} exportBlobContainerUri The export blob container URI. | ||
* | ||
* @member {boolean} excludeKeys The value indicating whether keys should be | ||
* excluded during export. | ||
* | ||
*/ | ||
@@ -1161,5 +978,3 @@ export interface ExportDevicesRequest { | ||
* @member {string} inputBlobContainerUri The input blob container URI. | ||
* | ||
* @member {string} outputBlobContainerUri The output blob container URI. | ||
* | ||
*/ | ||
@@ -1171,31 +986,14 @@ export interface ImportDevicesRequest { | ||
/** | ||
* @class | ||
* Initializes a new instance of the IotHubDescriptionListResult class. | ||
* @constructor | ||
* The JSON-serialized array of IotHubDescription objects with a next link. | ||
* | ||
* @member {array} [value] The array of IotHubDescription objects. | ||
* | ||
* @member {string} [nextLink] The next link. | ||
* | ||
*/ | ||
export interface IotHubDescriptionListResult { | ||
value?: IotHubDescription[]; | ||
readonly nextLink?: string; | ||
} | ||
/** | ||
* @class | ||
* Initializes a new instance of the IotHubSkuDescriptionListResult class. | ||
* Initializes a new instance of the OperationListResult class. | ||
* @constructor | ||
* The JSON-serialized array of IotHubSkuDescription objects with a next link. | ||
* 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 {array} [value] The array of IotHubSkuDescription. | ||
* | ||
* @member {string} [nextLink] The next link. | ||
* | ||
* @member {string} [nextLink] URL to get the next set of operation list | ||
* results if there are any. | ||
*/ | ||
export interface IotHubSkuDescriptionListResult { | ||
value?: IotHubSkuDescription[]; | ||
export interface OperationListResult extends Array<Operation> { | ||
readonly nextLink?: string; | ||
@@ -1206,69 +1004,2 @@ } | ||
* @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 {array} [value] The array of Event Hub-compatible consumer group | ||
* names. | ||
* | ||
* @member {string} [nextLink] The next link. | ||
* | ||
*/ | ||
export interface EventHubConsumerGroupsListResult { | ||
value?: string[]; | ||
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 {array} [value] The array of JobResponse objects. | ||
* | ||
* @member {string} [nextLink] The next link. | ||
* | ||
*/ | ||
export interface JobResponseListResult { | ||
value?: JobResponse[]; | ||
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 {array} [value] The array of quota metrics objects. | ||
* | ||
* @member {string} [nextLink] The next link. | ||
* | ||
*/ | ||
export interface IotHubQuotaMetricInfoListResult { | ||
value?: IotHubQuotaMetricInfo[]; | ||
readonly nextLink?: string; | ||
} | ||
/** | ||
* @class | ||
* Initializes a new instance of the SharedAccessSignatureAuthorizationRuleListResult class. | ||
* @constructor | ||
* The list of shared access policies with a next link. | ||
* | ||
* @member {array} [value] The list of shared access policies. | ||
* | ||
* @member {string} [nextLink] The next link. | ||
* | ||
*/ | ||
export interface SharedAccessSignatureAuthorizationRuleListResult { | ||
value?: SharedAccessSignatureAuthorizationRule[]; | ||
readonly nextLink?: string; | ||
} | ||
/** | ||
* @class | ||
* Initializes a new instance of the IotHubDescriptionListResult class. | ||
@@ -1279,3 +1010,2 @@ * @constructor | ||
* @member {string} [nextLink] The next link. | ||
* | ||
*/ | ||
@@ -1293,3 +1023,2 @@ export interface IotHubDescriptionListResult extends Array<IotHubDescription> { | ||
* @member {string} [nextLink] The next link. | ||
* | ||
*/ | ||
@@ -1308,3 +1037,2 @@ export interface IotHubSkuDescriptionListResult extends Array<IotHubSkuDescription> { | ||
* @member {string} [nextLink] The next link. | ||
* | ||
*/ | ||
@@ -1322,3 +1050,2 @@ export interface EventHubConsumerGroupsListResult extends Array<string> { | ||
* @member {string} [nextLink] The next link. | ||
* | ||
*/ | ||
@@ -1336,3 +1063,2 @@ export interface JobResponseListResult extends Array<JobResponse> { | ||
* @member {string} [nextLink] The next link. | ||
* | ||
*/ | ||
@@ -1350,3 +1076,2 @@ export interface IotHubQuotaMetricInfoListResult extends Array<IotHubQuotaMetricInfo> { | ||
* @member {string} [nextLink] The next link. | ||
* | ||
*/ | ||
@@ -1353,0 +1078,0 @@ export interface SharedAccessSignatureAuthorizationRuleListResult extends Array<SharedAccessSignatureAuthorizationRule> { |
@@ -27,2 +27,3 @@ /* | ||
exports.RoutingEventHubProperties = require('./routingEventHubProperties'); | ||
exports.RoutingStorageContainerProperties = require('./routingStorageContainerProperties'); | ||
exports.RoutingEndpoints = require('./routingEndpoints'); | ||
@@ -41,15 +42,11 @@ exports.RouteProperties = require('./routeProperties'); | ||
exports.IotHubDescription = require('./iotHubDescription'); | ||
exports.SharedAccessSignatureAuthorizationRuleListResult = require('./sharedAccessSignatureAuthorizationRuleListResult'); | ||
exports.OperationDisplay = require('./operationDisplay'); | ||
exports.Operation = require('./operation'); | ||
exports.ErrorDetails = require('./errorDetails'); | ||
exports.IotHubQuotaMetricInfo = require('./iotHubQuotaMetricInfo'); | ||
exports.IotHubQuotaMetricInfoListResult = require('./iotHubQuotaMetricInfoListResult'); | ||
exports.RegistryStatistics = require('./registryStatistics'); | ||
exports.JobResponse = require('./jobResponse'); | ||
exports.JobResponseListResult = require('./jobResponseListResult'); | ||
exports.IotHubCapacity = require('./iotHubCapacity'); | ||
exports.IotHubSkuDescription = require('./iotHubSkuDescription'); | ||
exports.EventHubConsumerGroupsListResult = require('./eventHubConsumerGroupsListResult'); | ||
exports.EventHubConsumerGroupInfo = require('./eventHubConsumerGroupInfo'); | ||
exports.IotHubSkuDescriptionListResult = require('./iotHubSkuDescriptionListResult'); | ||
exports.IotHubDescriptionListResult = require('./iotHubDescriptionListResult'); | ||
exports.OperationInputs = require('./operationInputs'); | ||
@@ -59,2 +56,3 @@ exports.IotHubNameAvailabilityInfo = require('./iotHubNameAvailabilityInfo'); | ||
exports.ImportDevicesRequest = require('./importDevicesRequest'); | ||
exports.OperationListResult = require('./operationListResult'); | ||
exports.IotHubDescriptionListResult = require('./iotHubDescriptionListResult'); | ||
@@ -61,0 +59,0 @@ exports.IotHubSkuDescriptionListResult = require('./iotHubSkuDescriptionListResult'); |
@@ -14,18 +14,14 @@ /* | ||
/** | ||
* @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' | ||
* | ||
*/ | ||
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 | ||
* values include: 'Automatic', 'Manual', 'None' | ||
*/ | ||
constructor() { | ||
@@ -32,0 +28,0 @@ } |
@@ -16,136 +16,106 @@ /* | ||
/** | ||
* @class | ||
* Initializes a new instance of the IotHubDescription class. | ||
* @constructor | ||
* The description of the IoT hub. | ||
* | ||
* @member {string} subscriptionid The subscription identifier. | ||
* | ||
* @member {string} resourcegroup The name of the resource group that contains | ||
* the IoT hub. A resource group name uniquely identifies the resource group | ||
* within the subscription. | ||
* | ||
* @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] | ||
* | ||
* @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.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.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.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 or not. | ||
* | ||
* @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] 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 | ||
* | ||
* @member {string} [sku.name] The name of the SKU. Possible values include: | ||
* 'F1', 'S1', 'S2', 'S3' | ||
* | ||
* @member {string} [sku.tier] The billing tier for the IoT hub. Possible | ||
* values include: 'Free', 'Standard' | ||
* | ||
* @member {number} [sku.capacity] The number of provisioned IoT Hub units. | ||
* See: | ||
* https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. | ||
* | ||
* @extends models['Resource'] | ||
*/ | ||
class IotHubDescription extends models['Resource'] { | ||
/** | ||
* Create a IotHubDescription. | ||
* @member {string} subscriptionid The subscription identifier. | ||
* @member {string} resourcegroup The name of the resource group that | ||
* contains the IoT hub. A resource group name uniquely identifies the | ||
* resource group within the subscription. | ||
* @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] | ||
* @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.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.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 | ||
* @member {string} [sku.name] The name of the SKU. Possible values include: | ||
* 'F1', 'S1', 'S2', 'S3' | ||
* @member {string} [sku.tier] The billing tier for the IoT hub. Possible | ||
* values include: 'Free', 'Standard' | ||
* @member {number} [sku.capacity] The number of provisioned IoT Hub units. | ||
* See: | ||
* https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. | ||
*/ | ||
constructor() { | ||
@@ -152,0 +122,0 @@ super(); |
@@ -14,11 +14,9 @@ /* | ||
/** | ||
* @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. | ||
* | ||
*/ | ||
class IotHubDescriptionListResult extends Array { | ||
/** | ||
* Create a IotHubDescriptionListResult. | ||
* @member {string} [nextLink] The next link. | ||
*/ | ||
constructor() { | ||
@@ -25,0 +23,0 @@ super(); |
@@ -14,17 +14,14 @@ /* | ||
/** | ||
* @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. | ||
* | ||
*/ | ||
class IotHubNameAvailabilityInfo { | ||
/** | ||
* Create a IotHubNameAvailabilityInfo. | ||
* @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. | ||
*/ | ||
constructor() { | ||
@@ -31,0 +28,0 @@ } |
@@ -16,109 +16,85 @@ /* | ||
/** | ||
* @class | ||
* Initializes a new instance of the IotHubProperties class. | ||
* @constructor | ||
* 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} [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.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.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 or not. | ||
* | ||
* @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] 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' | ||
* | ||
*/ | ||
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} [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.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' | ||
*/ | ||
constructor() { | ||
@@ -125,0 +101,0 @@ } |
@@ -14,15 +14,12 @@ /* | ||
/** | ||
* @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. | ||
* | ||
*/ | ||
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. | ||
*/ | ||
constructor() { | ||
@@ -29,0 +26,0 @@ } |
@@ -14,11 +14,9 @@ /* | ||
/** | ||
* @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. | ||
* | ||
*/ | ||
class IotHubQuotaMetricInfoListResult extends Array { | ||
/** | ||
* Create a IotHubQuotaMetricInfoListResult. | ||
* @member {string} [nextLink] The next link. | ||
*/ | ||
constructor() { | ||
@@ -25,0 +23,0 @@ super(); |
@@ -16,34 +16,24 @@ /* | ||
/** | ||
* @class | ||
* Initializes a new instance of the IotHubSkuDescription class. | ||
* @constructor | ||
* SKU properties. | ||
* | ||
* @member {string} [resourceType] The type of the resource. | ||
* | ||
* @member {object} sku | ||
* | ||
* @member {string} [sku.name] The name of the SKU. Possible values include: | ||
* 'F1', 'S1', 'S2', 'S3' | ||
* | ||
* @member {string} [sku.tier] The billing tier for the IoT hub. Possible | ||
* values include: 'Free', 'Standard' | ||
* | ||
* @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 | ||
* | ||
* @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' | ||
* | ||
*/ | ||
class IotHubSkuDescription { | ||
/** | ||
* Create a IotHubSkuDescription. | ||
* @member {string} [resourceType] The type of the resource. | ||
* @member {object} sku | ||
* @member {string} [sku.name] The name of the SKU. Possible values include: | ||
* 'F1', 'S1', 'S2', 'S3' | ||
* @member {string} [sku.tier] The billing tier for the IoT hub. Possible | ||
* values include: 'Free', 'Standard' | ||
* @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 | ||
* @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' | ||
*/ | ||
constructor() { | ||
@@ -50,0 +40,0 @@ } |
@@ -14,11 +14,9 @@ /* | ||
/** | ||
* @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. | ||
* | ||
*/ | ||
class IotHubSkuDescriptionListResult extends Array { | ||
/** | ||
* Create a IotHubSkuDescriptionListResult. | ||
* @member {string} [nextLink] The next link. | ||
*/ | ||
constructor() { | ||
@@ -25,0 +23,0 @@ super(); |
@@ -14,18 +14,15 @@ /* | ||
/** | ||
* @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' | ||
* | ||
* @member {string} [tier] The billing tier for the IoT hub. Possible values | ||
* include: 'Free', 'Standard' | ||
* | ||
* @member {number} capacity The number of provisioned IoT Hub units. See: | ||
* https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. | ||
* | ||
*/ | ||
class IotHubSkuInfo { | ||
/** | ||
* Create a IotHubSkuInfo. | ||
* @member {string} name The name of the SKU. Possible values include: 'F1', | ||
* 'S1', 'S2', 'S3' | ||
* @member {string} [tier] The billing tier for the IoT hub. Possible values | ||
* include: 'Free', 'Standard' | ||
* @member {number} capacity The number of provisioned IoT Hub units. See: | ||
* https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. | ||
*/ | ||
constructor() { | ||
@@ -32,0 +29,0 @@ } |
@@ -14,17 +14,14 @@ /* | ||
/** | ||
* @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. | ||
* | ||
*/ | ||
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 | ||
* rule. Possible values include: 'Accept', 'Reject' | ||
* @member {string} ipMask A string that contains the IP address range in | ||
* CIDR notation for the rule. | ||
*/ | ||
constructor() { | ||
@@ -31,0 +28,0 @@ } |
@@ -14,30 +14,23 @@ /* | ||
/** | ||
* @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. | ||
* | ||
*/ | ||
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: | ||
* '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. | ||
*/ | ||
constructor() { | ||
@@ -44,0 +37,0 @@ } |
@@ -14,11 +14,9 @@ /* | ||
/** | ||
* @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. | ||
* | ||
*/ | ||
class JobResponseListResult extends Array { | ||
/** | ||
* Create a JobResponseListResult. | ||
* @member {string} [nextLink] The next link. | ||
*/ | ||
constructor() { | ||
@@ -25,0 +23,0 @@ super(); |
@@ -14,20 +14,17 @@ /* | ||
/** | ||
* @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. | ||
* | ||
*/ | ||
class MessagingEndpointProperties { | ||
/** | ||
* Create a MessagingEndpointProperties. | ||
* @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. | ||
*/ | ||
constructor() { | ||
@@ -34,0 +31,0 @@ } |
@@ -14,11 +14,10 @@ /* | ||
/** | ||
* @class | ||
* Initializes a new instance of the OperationInputs class. | ||
* @constructor | ||
* Input values. | ||
* | ||
* @member {string} name The name of the IoT hub to check. | ||
* | ||
*/ | ||
class OperationInputs { | ||
/** | ||
* Create a OperationInputs. | ||
* @member {string} name The name of the IoT hub to check. | ||
*/ | ||
constructor() { | ||
@@ -25,0 +24,0 @@ } |
@@ -14,5 +14,2 @@ /* | ||
/** | ||
* @class | ||
* Initializes a new instance of the OperationsMonitoringProperties class. | ||
* @constructor | ||
* The operations monitoring properties for the IoT hub. The possible keys to | ||
@@ -23,6 +20,8 @@ * the dictionary are Connections, DeviceTelemetry, C2DCommands, | ||
* | ||
* @member {object} [events] | ||
* | ||
*/ | ||
class OperationsMonitoringProperties { | ||
/** | ||
* Create a OperationsMonitoringProperties. | ||
* @member {object} [events] | ||
*/ | ||
constructor() { | ||
@@ -29,0 +28,0 @@ } |
@@ -14,18 +14,15 @@ /* | ||
/** | ||
* @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. | ||
* | ||
*/ | ||
class RegistryStatistics { | ||
/** | ||
* Create a RegistryStatistics. | ||
* @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. | ||
*/ | ||
constructor() { | ||
@@ -32,0 +29,0 @@ } |
@@ -16,19 +16,15 @@ /* | ||
/** | ||
* @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. | ||
* | ||
* @extends models['BaseResource'] | ||
*/ | ||
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. | ||
*/ | ||
constructor() { | ||
@@ -35,0 +31,0 @@ super(); |
@@ -14,28 +14,23 @@ /* | ||
/** | ||
* @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: '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. | ||
* | ||
*/ | ||
class RouteProperties { | ||
/** | ||
* Create a RouteProperties. | ||
* @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: '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. | ||
*/ | ||
constructor() { | ||
@@ -42,0 +37,0 @@ } |
@@ -16,5 +16,2 @@ /* | ||
/** | ||
* @class | ||
* Initializes a new instance of the RoutingEndpoints class. | ||
* @constructor | ||
* The properties related to the custom endpoints to which your IoT hub routes | ||
@@ -25,14 +22,16 @@ * messages based on the routing rules. A maximum of 10 custom endpoints are | ||
* | ||
* @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. | ||
* | ||
*/ | ||
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 | ||
* endpoints that IoT hub routes messages to, based on the routing rules. | ||
*/ | ||
constructor() { | ||
@@ -99,2 +98,17 @@ } | ||
} | ||
}, | ||
storageContainers: { | ||
required: false, | ||
serializedName: 'storageContainers', | ||
type: { | ||
name: 'Sequence', | ||
element: { | ||
required: false, | ||
serializedName: 'RoutingStorageContainerPropertiesElementType', | ||
type: { | ||
name: 'Composite', | ||
className: 'RoutingStorageContainerProperties' | ||
} | ||
} | ||
} | ||
} | ||
@@ -101,0 +115,0 @@ } |
@@ -14,24 +14,20 @@ /* | ||
/** | ||
* @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 of the event hub 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. | ||
* | ||
*/ | ||
class RoutingEventHubProperties { | ||
/** | ||
* Create a RoutingEventHubProperties. | ||
* @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. | ||
*/ | ||
constructor() { | ||
@@ -38,0 +34,0 @@ } |
@@ -16,46 +16,40 @@ /* | ||
/** | ||
* @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} [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.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 or not. | ||
* | ||
*/ | ||
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 | ||
* 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.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. | ||
*/ | ||
constructor() { | ||
@@ -62,0 +56,0 @@ } |
@@ -14,25 +14,21 @@ /* | ||
/** | ||
* @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 of the service bus queue 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. | ||
* | ||
*/ | ||
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 | ||
* service bus queue endpoint. | ||
* @member {string} [resourceGroup] The name of the resource group of the | ||
* service bus queue endpoint. | ||
*/ | ||
constructor() { | ||
@@ -39,0 +35,0 @@ } |
@@ -14,25 +14,21 @@ /* | ||
/** | ||
* @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 of the service bus topic 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. | ||
* | ||
*/ | ||
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 | ||
* service bus topic endpoint. | ||
* @member {string} [resourceGroup] The name of the resource group of the | ||
* service bus topic endpoint. | ||
*/ | ||
constructor() { | ||
@@ -39,0 +35,0 @@ } |
@@ -14,26 +14,22 @@ /* | ||
/** | ||
* @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' | ||
* | ||
*/ | ||
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 | ||
* 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' | ||
*/ | ||
constructor() { | ||
@@ -40,0 +36,0 @@ } |
@@ -14,11 +14,9 @@ /* | ||
/** | ||
* @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. | ||
* | ||
*/ | ||
class SharedAccessSignatureAuthorizationRuleListResult extends Array { | ||
/** | ||
* Create a SharedAccessSignatureAuthorizationRuleListResult. | ||
* @member {string} [nextLink] The next link. | ||
*/ | ||
constructor() { | ||
@@ -25,0 +23,0 @@ super(); |
@@ -14,20 +14,17 @@ /* | ||
/** | ||
* @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. | ||
* | ||
*/ | ||
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: | ||
* 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. | ||
*/ | ||
constructor() { | ||
@@ -34,0 +31,0 @@ } |
@@ -17,2 +17,3 @@ /* | ||
exports.Operations = require('./operations'); | ||
exports.IotHubResource = require('./iotHubResource'); |
@@ -0,0 +0,0 @@ The MIT License (MIT) |
@@ -7,3 +7,3 @@ { | ||
], | ||
"version": "1.0.1-preview", | ||
"version": "1.1.0-preview", | ||
"description": "Microsoft Azure IoTHub Resource Provider Management Client Library for Node", | ||
@@ -24,4 +24,4 @@ "tags": [ | ||
"dependencies": { | ||
"ms-rest": "^2.0.0", | ||
"ms-rest-azure": "^2.0.0" | ||
"ms-rest": "^2.2.2", | ||
"ms-rest-azure": "^2.3.3" | ||
}, | ||
@@ -28,0 +28,0 @@ "homepage": "http://github.com/Azure/azure-sdk-for-node", |
@@ -0,0 +0,0 @@ # Microsoft Azure SDK for Node.js - IoT Hub |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
631826
51
15180
Updatedms-rest@^2.2.2
Updatedms-rest-azure@^2.3.3