/* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. * Changes may cause incorrect behavior and will be lost if the code is * regenerated. */ import { ServiceClientOptions, RequestOptions, ServiceCallback, HttpOperationResponse } from 'ms-rest'; import * as models from '../models'; /** * @class * Operations * __NOTE__: An instance of this class is automatically created for an * instance of the IotHubClient. */ export interface Operations { /** * Lists all of the available IoT Hub REST API operations. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ listWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * Lists all of the available IoT Hub REST API operations. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {OperationListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {OperationListResult} [result] - The deserialized result object if an error did not occur. * See {@link OperationListResult} for more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ list(options?: { customHeaders? : { [headerName: string]: string; } }): Promise; list(callback: ServiceCallback): void; list(options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * Lists all of the available IoT Hub REST API operations. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ listNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * Lists all of the available IoT Hub REST API operations. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {OperationListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {OperationListResult} [result] - The deserialized result object if an error did not occur. * See {@link OperationListResult} for more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ listNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; listNext(nextPageLink: string, callback: ServiceCallback): void; listNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; } /** * @class * IotHubResource * __NOTE__: An instance of this class is automatically created for an * instance of the IotHubClient. */ export interface IotHubResource { /** * @summary Get the non-security related metadata of an IoT hub * * Get the non-security related metadata of an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ getWithHttpOperationResponse(resourceGroupName: string, resourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get the non-security related metadata of an IoT hub * * Get the non-security related metadata of an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {IotHubDescription} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {IotHubDescription} [result] - The deserialized result object if an error did not occur. * See {@link IotHubDescription} for more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ get(resourceGroupName: string, resourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; get(resourceGroupName: string, resourceName: string, callback: ServiceCallback): void; get(resourceGroupName: string, resourceName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Create or update the metadata of an IoT hub. * * Create or update the metadata of an Iot hub. The usual pattern to modify a * property is to retrieve the IoT hub metadata and security metadata, and then * combine them with the modified values in a new body to update the IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} iotHubDescription The IoT hub metadata and security * metadata. * * @param {string} [iotHubDescription.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. * * @param {object} [iotHubDescription.properties] IotHub properties * * @param {array} [iotHubDescription.properties.authorizationPolicies] The * shared access policies you can use to secure a connection to the IoT hub. * * @param {array} [iotHubDescription.properties.ipFilterRules] The IP filter * rules. * * @param {object} [iotHubDescription.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. * * @param {object} [iotHubDescription.properties.routing] * * @param {object} [iotHubDescription.properties.routing.endpoints] * * @param {array} * [iotHubDescription.properties.routing.endpoints.serviceBusQueues] The list * of Service Bus queue endpoints that IoT hub routes the messages to, based on * the routing rules. * * @param {array} * [iotHubDescription.properties.routing.endpoints.serviceBusTopics] The list * of Service Bus topic endpoints that the IoT hub routes the messages to, * based on the routing rules. * * @param {array} [iotHubDescription.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. * * @param {array} * [iotHubDescription.properties.routing.endpoints.storageContainers] The list * of storage container endpoints that IoT hub routes messages to, based on the * routing rules. * * @param {array} [iotHubDescription.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. * * @param {object} [iotHubDescription.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. * * @param {string} [iotHubDescription.properties.routing.fallbackRoute.name] * The name of the route. The name can only include alphanumeric characters, * periods, underscores, hyphens, has a maximum length of 64 characters, and * must be unique. * * @param {string} * [iotHubDescription.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 * * @param {array} * iotHubDescription.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. * * @param {boolean} * iotHubDescription.properties.routing.fallbackRoute.isEnabled Used to specify * whether the fallback route is enabled. * * @param {object} [iotHubDescription.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. * * @param {object} [iotHubDescription.properties.messagingEndpoints] The * messaging endpoint properties for the file upload notification queue. * * @param {boolean} * [iotHubDescription.properties.enableFileUploadNotifications] If True, file * upload notifications are enabled. * * @param {object} [iotHubDescription.properties.cloudToDevice] * * @param {number} * [iotHubDescription.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. * * @param {moment.duration} * [iotHubDescription.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. * * @param {object} [iotHubDescription.properties.cloudToDevice.feedback] * * @param {moment.duration} * [iotHubDescription.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. * * @param {moment.duration} * [iotHubDescription.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. * * @param {number} * [iotHubDescription.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. * * @param {string} [iotHubDescription.properties.comments] IoT hub comments. * * @param {object} * [iotHubDescription.properties.operationsMonitoringProperties] * * @param {object} * [iotHubDescription.properties.operationsMonitoringProperties.events] * * @param {string} [iotHubDescription.properties.features] The capabilities and * features enabled for the IoT hub. Possible values include: 'None', * 'DeviceManagement' * * @param {object} iotHubDescription.sku IotHub SKU info * * @param {string} iotHubDescription.sku.name The name of the SKU. Possible * values include: 'F1', 'S1', 'S2', 'S3', 'B1', 'B2', 'B3' * * @param {number} [iotHubDescription.sku.capacity] The number of provisioned * IoT Hub units. See: * https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. * * @param {string} iotHubDescription.location The resource location. * * @param {object} [iotHubDescription.tags] The resource tags. * * @param {object} [options] Optional Parameters. * * @param {string} [options.ifMatch] ETag of the IoT Hub. Do not specify for * creating a brand new IoT Hub. Required to update an existing IoT Hub. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ createOrUpdateWithHttpOperationResponse(resourceGroupName: string, resourceName: string, iotHubDescription: models.IotHubDescription, options?: { ifMatch? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Create or update the metadata of an IoT hub. * * Create or update the metadata of an Iot hub. The usual pattern to modify a * property is to retrieve the IoT hub metadata and security metadata, and then * combine them with the modified values in a new body to update the IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} iotHubDescription The IoT hub metadata and security * metadata. * * @param {string} [iotHubDescription.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. * * @param {object} [iotHubDescription.properties] IotHub properties * * @param {array} [iotHubDescription.properties.authorizationPolicies] The * shared access policies you can use to secure a connection to the IoT hub. * * @param {array} [iotHubDescription.properties.ipFilterRules] The IP filter * rules. * * @param {object} [iotHubDescription.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. * * @param {object} [iotHubDescription.properties.routing] * * @param {object} [iotHubDescription.properties.routing.endpoints] * * @param {array} * [iotHubDescription.properties.routing.endpoints.serviceBusQueues] The list * of Service Bus queue endpoints that IoT hub routes the messages to, based on * the routing rules. * * @param {array} * [iotHubDescription.properties.routing.endpoints.serviceBusTopics] The list * of Service Bus topic endpoints that the IoT hub routes the messages to, * based on the routing rules. * * @param {array} [iotHubDescription.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. * * @param {array} * [iotHubDescription.properties.routing.endpoints.storageContainers] The list * of storage container endpoints that IoT hub routes messages to, based on the * routing rules. * * @param {array} [iotHubDescription.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. * * @param {object} [iotHubDescription.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. * * @param {string} [iotHubDescription.properties.routing.fallbackRoute.name] * The name of the route. The name can only include alphanumeric characters, * periods, underscores, hyphens, has a maximum length of 64 characters, and * must be unique. * * @param {string} * [iotHubDescription.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 * * @param {array} * iotHubDescription.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. * * @param {boolean} * iotHubDescription.properties.routing.fallbackRoute.isEnabled Used to specify * whether the fallback route is enabled. * * @param {object} [iotHubDescription.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. * * @param {object} [iotHubDescription.properties.messagingEndpoints] The * messaging endpoint properties for the file upload notification queue. * * @param {boolean} * [iotHubDescription.properties.enableFileUploadNotifications] If True, file * upload notifications are enabled. * * @param {object} [iotHubDescription.properties.cloudToDevice] * * @param {number} * [iotHubDescription.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. * * @param {moment.duration} * [iotHubDescription.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. * * @param {object} [iotHubDescription.properties.cloudToDevice.feedback] * * @param {moment.duration} * [iotHubDescription.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. * * @param {moment.duration} * [iotHubDescription.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. * * @param {number} * [iotHubDescription.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. * * @param {string} [iotHubDescription.properties.comments] IoT hub comments. * * @param {object} * [iotHubDescription.properties.operationsMonitoringProperties] * * @param {object} * [iotHubDescription.properties.operationsMonitoringProperties.events] * * @param {string} [iotHubDescription.properties.features] The capabilities and * features enabled for the IoT hub. Possible values include: 'None', * 'DeviceManagement' * * @param {object} iotHubDescription.sku IotHub SKU info * * @param {string} iotHubDescription.sku.name The name of the SKU. Possible * values include: 'F1', 'S1', 'S2', 'S3', 'B1', 'B2', 'B3' * * @param {number} [iotHubDescription.sku.capacity] The number of provisioned * IoT Hub units. See: * https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. * * @param {string} iotHubDescription.location The resource location. * * @param {object} [iotHubDescription.tags] The resource tags. * * @param {object} [options] Optional Parameters. * * @param {string} [options.ifMatch] ETag of the IoT Hub. Do not specify for * creating a brand new IoT Hub. Required to update an existing IoT Hub. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {IotHubDescription} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {IotHubDescription} [result] - The deserialized result object if an error did not occur. * See {@link IotHubDescription} for more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ createOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: models.IotHubDescription, options?: { ifMatch? : string, customHeaders? : { [headerName: string]: string; } }): Promise; createOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: models.IotHubDescription, callback: ServiceCallback): void; createOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: models.IotHubDescription, options: { ifMatch? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Update an existing IoT Hubs tags. * * Update an existing IoT Hub tags. to update other fields use the * CreateOrUpdate method * * @param {string} resourceGroupName Resource group identifier. * * @param {string} resourceName Name of iot hub to update. * * @param {object} [options] Optional Parameters. * * @param {object} [options.tags] Resource tags * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ updateWithHttpOperationResponse(resourceGroupName: string, resourceName: string, options?: { tags? : { [propertyName: string]: string }, customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Update an existing IoT Hubs tags. * * Update an existing IoT Hub tags. to update other fields use the * CreateOrUpdate method * * @param {string} resourceGroupName Resource group identifier. * * @param {string} resourceName Name of iot hub to update. * * @param {object} [options] Optional Parameters. * * @param {object} [options.tags] Resource tags * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {IotHubDescription} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {IotHubDescription} [result] - The deserialized result object if an error did not occur. * See {@link IotHubDescription} for more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ update(resourceGroupName: string, resourceName: string, options?: { tags? : { [propertyName: string]: string }, customHeaders? : { [headerName: string]: string; } }): Promise; update(resourceGroupName: string, resourceName: string, callback: ServiceCallback): void; update(resourceGroupName: string, resourceName: string, options: { tags? : { [propertyName: string]: string }, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Delete an IoT hub * * Delete an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ deleteMethodWithHttpOperationResponse(resourceGroupName: string, resourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Delete an IoT hub * * Delete an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {Object} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {Object} [result] - The deserialized result object if an error did not occur. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ deleteMethod(resourceGroupName: string, resourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; deleteMethod(resourceGroupName: string, resourceName: string, callback: ServiceCallback): void; deleteMethod(resourceGroupName: string, resourceName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get all the IoT hubs in a subscription * * Get all the IoT hubs in a subscription. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ listBySubscriptionWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get all the IoT hubs in a subscription * * Get all the IoT hubs in a subscription. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {IotHubDescriptionListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {IotHubDescriptionListResult} [result] - The deserialized result object if an error did not occur. * See {@link IotHubDescriptionListResult} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ listBySubscription(options?: { customHeaders? : { [headerName: string]: string; } }): Promise; listBySubscription(callback: ServiceCallback): void; listBySubscription(options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get all the IoT hubs in a resource group * * Get all the IoT hubs in a resource group. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ listByResourceGroupWithHttpOperationResponse(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get all the IoT hubs in a resource group * * Get all the IoT hubs in a resource group. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {IotHubDescriptionListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {IotHubDescriptionListResult} [result] - The deserialized result object if an error did not occur. * See {@link IotHubDescriptionListResult} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ listByResourceGroup(resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; listByResourceGroup(resourceGroupName: string, callback: ServiceCallback): void; listByResourceGroup(resourceGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get the statistics from an IoT hub * * Get the statistics from an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ getStatsWithHttpOperationResponse(resourceGroupName: string, resourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get the statistics from an IoT hub * * Get the statistics from an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {RegistryStatistics} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {RegistryStatistics} [result] - The deserialized result object if an error did not occur. * See {@link RegistryStatistics} for more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ getStats(resourceGroupName: string, resourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; getStats(resourceGroupName: string, resourceName: string, callback: ServiceCallback): void; getStats(resourceGroupName: string, resourceName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get the list of valid SKUs for an IoT hub * * Get the list of valid SKUs for an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ getValidSkusWithHttpOperationResponse(resourceGroupName: string, resourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get the list of valid SKUs for an IoT hub * * Get the list of valid SKUs for an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {IotHubSkuDescriptionListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {IotHubSkuDescriptionListResult} [result] - The deserialized result object if an error did not occur. * See {@link IotHubSkuDescriptionListResult} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ getValidSkus(resourceGroupName: string, resourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; getValidSkus(resourceGroupName: string, resourceName: string, callback: ServiceCallback): void; getValidSkus(resourceGroupName: string, resourceName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get a list of the consumer groups in the Event Hub-compatible * device-to-cloud endpoint in an IoT hub * * Get a list of the consumer groups in the Event Hub-compatible * device-to-cloud endpoint in an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} eventHubEndpointName The name of the Event Hub-compatible * endpoint. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ listEventHubConsumerGroupsWithHttpOperationResponse(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get a list of the consumer groups in the Event Hub-compatible * device-to-cloud endpoint in an IoT hub * * Get a list of the consumer groups in the Event Hub-compatible * device-to-cloud endpoint in an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} eventHubEndpointName The name of the Event Hub-compatible * endpoint. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {EventHubConsumerGroupsListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {EventHubConsumerGroupsListResult} [result] - The deserialized result object if an error did not occur. * See {@link EventHubConsumerGroupsListResult} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, callback: ServiceCallback): void; listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get a consumer group from the Event Hub-compatible device-to-cloud * endpoint for an IoT hub * * Get a consumer group from the Event Hub-compatible device-to-cloud endpoint * for an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} eventHubEndpointName The name of the Event Hub-compatible * endpoint in the IoT hub. * * @param {string} name The name of the consumer group to retrieve. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ getEventHubConsumerGroupWithHttpOperationResponse(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get a consumer group from the Event Hub-compatible device-to-cloud * endpoint for an IoT hub * * Get a consumer group from the Event Hub-compatible device-to-cloud endpoint * for an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} eventHubEndpointName The name of the Event Hub-compatible * endpoint in the IoT hub. * * @param {string} name The name of the consumer group to retrieve. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {EventHubConsumerGroupInfo} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {EventHubConsumerGroupInfo} [result] - The deserialized result object if an error did not occur. * See {@link EventHubConsumerGroupInfo} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, callback: ServiceCallback): void; getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Add a consumer group to an Event Hub-compatible endpoint in an IoT * hub * * Add a consumer group to an Event Hub-compatible endpoint in an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} eventHubEndpointName The name of the Event Hub-compatible * endpoint in the IoT hub. * * @param {string} name The name of the consumer group to add. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ createEventHubConsumerGroupWithHttpOperationResponse(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Add a consumer group to an Event Hub-compatible endpoint in an IoT * hub * * Add a consumer group to an Event Hub-compatible endpoint in an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} eventHubEndpointName The name of the Event Hub-compatible * endpoint in the IoT hub. * * @param {string} name The name of the consumer group to add. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {EventHubConsumerGroupInfo} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {EventHubConsumerGroupInfo} [result] - The deserialized result object if an error did not occur. * See {@link EventHubConsumerGroupInfo} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, callback: ServiceCallback): void; createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Delete a consumer group from an Event Hub-compatible endpoint in an * IoT hub * * Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} eventHubEndpointName The name of the Event Hub-compatible * endpoint in the IoT hub. * * @param {string} name The name of the consumer group to delete. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ deleteEventHubConsumerGroupWithHttpOperationResponse(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Delete a consumer group from an Event Hub-compatible endpoint in an * IoT hub * * Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} eventHubEndpointName The name of the Event Hub-compatible * endpoint in the IoT hub. * * @param {string} name The name of the consumer group to delete. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {null} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {null} [result] - The deserialized result object if an error did not occur. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, callback: ServiceCallback): void; deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get a list of all the jobs in an IoT hub. For more information, * see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry * * Get a list of all the jobs in an IoT hub. For more information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ listJobsWithHttpOperationResponse(resourceGroupName: string, resourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get a list of all the jobs in an IoT hub. For more information, * see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry * * Get a list of all the jobs in an IoT hub. For more information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {JobResponseListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {JobResponseListResult} [result] - The deserialized result object if an error did not occur. * See {@link JobResponseListResult} for more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ listJobs(resourceGroupName: string, resourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; listJobs(resourceGroupName: string, resourceName: string, callback: ServiceCallback): void; listJobs(resourceGroupName: string, resourceName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get the details of a job from an IoT hub. For more information, * see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry * * Get the details of a job from an IoT hub. For more information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} jobId The job identifier. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ getJobWithHttpOperationResponse(resourceGroupName: string, resourceName: string, jobId: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get the details of a job from an IoT hub. For more information, * see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry * * Get the details of a job from an IoT hub. For more information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} jobId The job identifier. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {JobResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {JobResponse} [result] - The deserialized result object if an error did not occur. * See {@link JobResponse} for more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ getJob(resourceGroupName: string, resourceName: string, jobId: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; getJob(resourceGroupName: string, resourceName: string, jobId: string, callback: ServiceCallback): void; getJob(resourceGroupName: string, resourceName: string, jobId: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get the quota metrics for an IoT hub * * Get the quota metrics for an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ getQuotaMetricsWithHttpOperationResponse(resourceGroupName: string, resourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get the quota metrics for an IoT hub * * Get the quota metrics for an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {IotHubQuotaMetricInfoListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {IotHubQuotaMetricInfoListResult} [result] - The deserialized result object if an error did not occur. * See {@link IotHubQuotaMetricInfoListResult} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ getQuotaMetrics(resourceGroupName: string, resourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; getQuotaMetrics(resourceGroupName: string, resourceName: string, callback: ServiceCallback): void; getQuotaMetrics(resourceGroupName: string, resourceName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get the health for routing endpoints * * Get the health for routing endpoints. * * @param {string} resourceGroupName * * @param {string} iotHubName * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ getEndpointHealthWithHttpOperationResponse(resourceGroupName: string, iotHubName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get the health for routing endpoints * * Get the health for routing endpoints. * * @param {string} resourceGroupName * * @param {string} iotHubName * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {EndpointHealthDataListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {EndpointHealthDataListResult} [result] - The deserialized result object if an error did not occur. * See {@link EndpointHealthDataListResult} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ getEndpointHealth(resourceGroupName: string, iotHubName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; getEndpointHealth(resourceGroupName: string, iotHubName: string, callback: ServiceCallback): void; getEndpointHealth(resourceGroupName: string, iotHubName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Check if an IoT hub name is available * * Check if an IoT hub name is available. * * @param {string} name The name of the IoT hub to check. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ checkNameAvailabilityWithHttpOperationResponse(name: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Check if an IoT hub name is available * * Check if an IoT hub name is available. * * @param {string} name The name of the IoT hub to check. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {IotHubNameAvailabilityInfo} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {IotHubNameAvailabilityInfo} [result] - The deserialized result object if an error did not occur. * See {@link IotHubNameAvailabilityInfo} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ checkNameAvailability(name: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; checkNameAvailability(name: string, callback: ServiceCallback): void; checkNameAvailability(name: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Test all routes * * Test all routes configured in this Iot Hub * * @param {object} input Input for testing all routes * * @param {string} [input.routingSource] Routing source. Possible values * include: 'Invalid', 'DeviceMessages', 'TwinChangeEvents', * 'DeviceLifecycleEvents', 'DeviceJobLifecycleEvents' * * @param {object} [input.message] Routing message * * @param {string} [input.message.body] Body of routing message * * @param {object} [input.message.appProperties] App properties * * @param {object} [input.message.systemProperties] System properties * * @param {string} iotHubName IotHub to be tested * * @param {string} resourceGroupName resource group which Iot Hub belongs to * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ testAllRoutesWithHttpOperationResponse(input: models.TestAllRoutesInput, iotHubName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Test all routes * * Test all routes configured in this Iot Hub * * @param {object} input Input for testing all routes * * @param {string} [input.routingSource] Routing source. Possible values * include: 'Invalid', 'DeviceMessages', 'TwinChangeEvents', * 'DeviceLifecycleEvents', 'DeviceJobLifecycleEvents' * * @param {object} [input.message] Routing message * * @param {string} [input.message.body] Body of routing message * * @param {object} [input.message.appProperties] App properties * * @param {object} [input.message.systemProperties] System properties * * @param {string} iotHubName IotHub to be tested * * @param {string} resourceGroupName resource group which Iot Hub belongs to * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {TestAllRoutesResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {TestAllRoutesResult} [result] - The deserialized result object if an error did not occur. * See {@link TestAllRoutesResult} for more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ testAllRoutes(input: models.TestAllRoutesInput, iotHubName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; testAllRoutes(input: models.TestAllRoutesInput, iotHubName: string, resourceGroupName: string, callback: ServiceCallback): void; testAllRoutes(input: models.TestAllRoutesInput, iotHubName: string, resourceGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Test the new route * * Test the new route for this Iot Hub * * @param {object} input Route that needs to be tested * * @param {object} [input.message] Routing message * * @param {string} [input.message.body] Body of routing message * * @param {object} [input.message.appProperties] App properties * * @param {object} [input.message.systemProperties] System properties * * @param {object} input.route Route properties * * @param {string} input.route.name The name of the route. The name can only * include alphanumeric characters, periods, underscores, hyphens, has a * maximum length of 64 characters, and must be unique. * * @param {string} input.route.source The source that the routing rule is to be * applied to, such as DeviceMessages. Possible values include: 'Invalid', * 'DeviceMessages', 'TwinChangeEvents', 'DeviceLifecycleEvents', * 'DeviceJobLifecycleEvents' * * @param {string} [input.route.condition] The condition that is evaluated to * apply the routing rule. If no condition is provided, it evaluates to true by * default. For grammar, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language * * @param {array} input.route.endpointNames The list of endpoints to which * messages that satisfy the condition are routed. Currently only one endpoint * is allowed. * * @param {boolean} input.route.isEnabled Used to specify whether a route is * enabled. * * @param {string} iotHubName IotHub to be tested * * @param {string} resourceGroupName resource group which Iot Hub belongs to * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ testRouteWithHttpOperationResponse(input: models.TestRouteInput, iotHubName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Test the new route * * Test the new route for this Iot Hub * * @param {object} input Route that needs to be tested * * @param {object} [input.message] Routing message * * @param {string} [input.message.body] Body of routing message * * @param {object} [input.message.appProperties] App properties * * @param {object} [input.message.systemProperties] System properties * * @param {object} input.route Route properties * * @param {string} input.route.name The name of the route. The name can only * include alphanumeric characters, periods, underscores, hyphens, has a * maximum length of 64 characters, and must be unique. * * @param {string} input.route.source The source that the routing rule is to be * applied to, such as DeviceMessages. Possible values include: 'Invalid', * 'DeviceMessages', 'TwinChangeEvents', 'DeviceLifecycleEvents', * 'DeviceJobLifecycleEvents' * * @param {string} [input.route.condition] The condition that is evaluated to * apply the routing rule. If no condition is provided, it evaluates to true by * default. For grammar, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language * * @param {array} input.route.endpointNames The list of endpoints to which * messages that satisfy the condition are routed. Currently only one endpoint * is allowed. * * @param {boolean} input.route.isEnabled Used to specify whether a route is * enabled. * * @param {string} iotHubName IotHub to be tested * * @param {string} resourceGroupName resource group which Iot Hub belongs to * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {TestRouteResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {TestRouteResult} [result] - The deserialized result object if an error did not occur. * See {@link TestRouteResult} for more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ testRoute(input: models.TestRouteInput, iotHubName: string, resourceGroupName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; testRoute(input: models.TestRouteInput, iotHubName: string, resourceGroupName: string, callback: ServiceCallback): void; testRoute(input: models.TestRouteInput, iotHubName: string, resourceGroupName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get the security metadata for an IoT hub. For more information, * see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security * * Get the security metadata for an IoT hub. For more information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ listKeysWithHttpOperationResponse(resourceGroupName: string, resourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get the security metadata for an IoT hub. For more information, * see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security * * Get the security metadata for an IoT hub. For more information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {SharedAccessSignatureAuthorizationRuleListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {SharedAccessSignatureAuthorizationRuleListResult} [result] - The deserialized result object if an error did not occur. * See {@link * SharedAccessSignatureAuthorizationRuleListResult} for * more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ listKeys(resourceGroupName: string, resourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; listKeys(resourceGroupName: string, resourceName: string, callback: ServiceCallback): void; listKeys(resourceGroupName: string, resourceName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get a shared access policy by name from an IoT hub. For more * information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security * * Get a shared access policy by name from an IoT hub. For more information, * see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} keyName The name of the shared access policy. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ getKeysForKeyNameWithHttpOperationResponse(resourceGroupName: string, resourceName: string, keyName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get a shared access policy by name from an IoT hub. For more * information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security * * Get a shared access policy by name from an IoT hub. For more information, * see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} keyName The name of the shared access policy. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {SharedAccessSignatureAuthorizationRule} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {SharedAccessSignatureAuthorizationRule} [result] - The deserialized result object if an error did not occur. * See {@link SharedAccessSignatureAuthorizationRule} for * more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, callback: ServiceCallback): void; getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Exports all the device identities in the IoT hub identity registry * to an Azure Storage blob container. For more information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities * * Exports all the device identities in the IoT hub identity registry to an * Azure Storage blob container. For more information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} exportDevicesParameters The parameters that specify the * export devices operation. * * @param {string} exportDevicesParameters.exportBlobContainerUri The export * blob container URI. * * @param {boolean} exportDevicesParameters.excludeKeys The value indicating * whether keys should be excluded during export. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ exportDevicesWithHttpOperationResponse(resourceGroupName: string, resourceName: string, exportDevicesParameters: models.ExportDevicesRequest, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Exports all the device identities in the IoT hub identity registry * to an Azure Storage blob container. For more information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities * * Exports all the device identities in the IoT hub identity registry to an * Azure Storage blob container. For more information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} exportDevicesParameters The parameters that specify the * export devices operation. * * @param {string} exportDevicesParameters.exportBlobContainerUri The export * blob container URI. * * @param {boolean} exportDevicesParameters.excludeKeys The value indicating * whether keys should be excluded during export. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {JobResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {JobResponse} [result] - The deserialized result object if an error did not occur. * See {@link JobResponse} for more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ exportDevices(resourceGroupName: string, resourceName: string, exportDevicesParameters: models.ExportDevicesRequest, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; exportDevices(resourceGroupName: string, resourceName: string, exportDevicesParameters: models.ExportDevicesRequest, callback: ServiceCallback): void; exportDevices(resourceGroupName: string, resourceName: string, exportDevicesParameters: models.ExportDevicesRequest, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Import, update, or delete device identities in the IoT hub identity * registry from a blob. For more information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities * * Import, update, or delete device identities in the IoT hub identity registry * from a blob. For more information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} importDevicesParameters The parameters that specify the * import devices operation. * * @param {string} importDevicesParameters.inputBlobContainerUri The input blob * container URI. * * @param {string} importDevicesParameters.outputBlobContainerUri The output * blob container URI. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ importDevicesWithHttpOperationResponse(resourceGroupName: string, resourceName: string, importDevicesParameters: models.ImportDevicesRequest, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Import, update, or delete device identities in the IoT hub identity * registry from a blob. For more information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities * * Import, update, or delete device identities in the IoT hub identity registry * from a blob. For more information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} importDevicesParameters The parameters that specify the * import devices operation. * * @param {string} importDevicesParameters.inputBlobContainerUri The input blob * container URI. * * @param {string} importDevicesParameters.outputBlobContainerUri The output * blob container URI. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {JobResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {JobResponse} [result] - The deserialized result object if an error did not occur. * See {@link JobResponse} for more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ importDevices(resourceGroupName: string, resourceName: string, importDevicesParameters: models.ImportDevicesRequest, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; importDevices(resourceGroupName: string, resourceName: string, importDevicesParameters: models.ImportDevicesRequest, callback: ServiceCallback): void; importDevices(resourceGroupName: string, resourceName: string, importDevicesParameters: models.ImportDevicesRequest, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Create or update the metadata of an IoT hub. * * Create or update the metadata of an Iot hub. The usual pattern to modify a * property is to retrieve the IoT hub metadata and security metadata, and then * combine them with the modified values in a new body to update the IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} iotHubDescription The IoT hub metadata and security * metadata. * * @param {string} [iotHubDescription.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. * * @param {object} [iotHubDescription.properties] IotHub properties * * @param {array} [iotHubDescription.properties.authorizationPolicies] The * shared access policies you can use to secure a connection to the IoT hub. * * @param {array} [iotHubDescription.properties.ipFilterRules] The IP filter * rules. * * @param {object} [iotHubDescription.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. * * @param {object} [iotHubDescription.properties.routing] * * @param {object} [iotHubDescription.properties.routing.endpoints] * * @param {array} * [iotHubDescription.properties.routing.endpoints.serviceBusQueues] The list * of Service Bus queue endpoints that IoT hub routes the messages to, based on * the routing rules. * * @param {array} * [iotHubDescription.properties.routing.endpoints.serviceBusTopics] The list * of Service Bus topic endpoints that the IoT hub routes the messages to, * based on the routing rules. * * @param {array} [iotHubDescription.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. * * @param {array} * [iotHubDescription.properties.routing.endpoints.storageContainers] The list * of storage container endpoints that IoT hub routes messages to, based on the * routing rules. * * @param {array} [iotHubDescription.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. * * @param {object} [iotHubDescription.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. * * @param {string} [iotHubDescription.properties.routing.fallbackRoute.name] * The name of the route. The name can only include alphanumeric characters, * periods, underscores, hyphens, has a maximum length of 64 characters, and * must be unique. * * @param {string} * [iotHubDescription.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 * * @param {array} * iotHubDescription.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. * * @param {boolean} * iotHubDescription.properties.routing.fallbackRoute.isEnabled Used to specify * whether the fallback route is enabled. * * @param {object} [iotHubDescription.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. * * @param {object} [iotHubDescription.properties.messagingEndpoints] The * messaging endpoint properties for the file upload notification queue. * * @param {boolean} * [iotHubDescription.properties.enableFileUploadNotifications] If True, file * upload notifications are enabled. * * @param {object} [iotHubDescription.properties.cloudToDevice] * * @param {number} * [iotHubDescription.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. * * @param {moment.duration} * [iotHubDescription.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. * * @param {object} [iotHubDescription.properties.cloudToDevice.feedback] * * @param {moment.duration} * [iotHubDescription.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. * * @param {moment.duration} * [iotHubDescription.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. * * @param {number} * [iotHubDescription.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. * * @param {string} [iotHubDescription.properties.comments] IoT hub comments. * * @param {object} * [iotHubDescription.properties.operationsMonitoringProperties] * * @param {object} * [iotHubDescription.properties.operationsMonitoringProperties.events] * * @param {string} [iotHubDescription.properties.features] The capabilities and * features enabled for the IoT hub. Possible values include: 'None', * 'DeviceManagement' * * @param {object} iotHubDescription.sku IotHub SKU info * * @param {string} iotHubDescription.sku.name The name of the SKU. Possible * values include: 'F1', 'S1', 'S2', 'S3', 'B1', 'B2', 'B3' * * @param {number} [iotHubDescription.sku.capacity] The number of provisioned * IoT Hub units. See: * https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. * * @param {string} iotHubDescription.location The resource location. * * @param {object} [iotHubDescription.tags] The resource tags. * * @param {object} [options] Optional Parameters. * * @param {string} [options.ifMatch] ETag of the IoT Hub. Do not specify for * creating a brand new IoT Hub. Required to update an existing IoT Hub. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName: string, resourceName: string, iotHubDescription: models.IotHubDescription, options?: { ifMatch? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Create or update the metadata of an IoT hub. * * Create or update the metadata of an Iot hub. The usual pattern to modify a * property is to retrieve the IoT hub metadata and security metadata, and then * combine them with the modified values in a new body to update the IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} iotHubDescription The IoT hub metadata and security * metadata. * * @param {string} [iotHubDescription.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. * * @param {object} [iotHubDescription.properties] IotHub properties * * @param {array} [iotHubDescription.properties.authorizationPolicies] The * shared access policies you can use to secure a connection to the IoT hub. * * @param {array} [iotHubDescription.properties.ipFilterRules] The IP filter * rules. * * @param {object} [iotHubDescription.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. * * @param {object} [iotHubDescription.properties.routing] * * @param {object} [iotHubDescription.properties.routing.endpoints] * * @param {array} * [iotHubDescription.properties.routing.endpoints.serviceBusQueues] The list * of Service Bus queue endpoints that IoT hub routes the messages to, based on * the routing rules. * * @param {array} * [iotHubDescription.properties.routing.endpoints.serviceBusTopics] The list * of Service Bus topic endpoints that the IoT hub routes the messages to, * based on the routing rules. * * @param {array} [iotHubDescription.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. * * @param {array} * [iotHubDescription.properties.routing.endpoints.storageContainers] The list * of storage container endpoints that IoT hub routes messages to, based on the * routing rules. * * @param {array} [iotHubDescription.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. * * @param {object} [iotHubDescription.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. * * @param {string} [iotHubDescription.properties.routing.fallbackRoute.name] * The name of the route. The name can only include alphanumeric characters, * periods, underscores, hyphens, has a maximum length of 64 characters, and * must be unique. * * @param {string} * [iotHubDescription.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 * * @param {array} * iotHubDescription.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. * * @param {boolean} * iotHubDescription.properties.routing.fallbackRoute.isEnabled Used to specify * whether the fallback route is enabled. * * @param {object} [iotHubDescription.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. * * @param {object} [iotHubDescription.properties.messagingEndpoints] The * messaging endpoint properties for the file upload notification queue. * * @param {boolean} * [iotHubDescription.properties.enableFileUploadNotifications] If True, file * upload notifications are enabled. * * @param {object} [iotHubDescription.properties.cloudToDevice] * * @param {number} * [iotHubDescription.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. * * @param {moment.duration} * [iotHubDescription.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. * * @param {object} [iotHubDescription.properties.cloudToDevice.feedback] * * @param {moment.duration} * [iotHubDescription.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. * * @param {moment.duration} * [iotHubDescription.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. * * @param {number} * [iotHubDescription.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. * * @param {string} [iotHubDescription.properties.comments] IoT hub comments. * * @param {object} * [iotHubDescription.properties.operationsMonitoringProperties] * * @param {object} * [iotHubDescription.properties.operationsMonitoringProperties.events] * * @param {string} [iotHubDescription.properties.features] The capabilities and * features enabled for the IoT hub. Possible values include: 'None', * 'DeviceManagement' * * @param {object} iotHubDescription.sku IotHub SKU info * * @param {string} iotHubDescription.sku.name The name of the SKU. Possible * values include: 'F1', 'S1', 'S2', 'S3', 'B1', 'B2', 'B3' * * @param {number} [iotHubDescription.sku.capacity] The number of provisioned * IoT Hub units. See: * https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. * * @param {string} iotHubDescription.location The resource location. * * @param {object} [iotHubDescription.tags] The resource tags. * * @param {object} [options] Optional Parameters. * * @param {string} [options.ifMatch] ETag of the IoT Hub. Do not specify for * creating a brand new IoT Hub. Required to update an existing IoT Hub. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {IotHubDescription} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {IotHubDescription} [result] - The deserialized result object if an error did not occur. * See {@link IotHubDescription} for more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: models.IotHubDescription, options?: { ifMatch? : string, customHeaders? : { [headerName: string]: string; } }): Promise; beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: models.IotHubDescription, callback: ServiceCallback): void; beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: models.IotHubDescription, options: { ifMatch? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Update an existing IoT Hubs tags. * * Update an existing IoT Hub tags. to update other fields use the * CreateOrUpdate method * * @param {string} resourceGroupName Resource group identifier. * * @param {string} resourceName Name of iot hub to update. * * @param {object} [options] Optional Parameters. * * @param {object} [options.tags] Resource tags * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ beginUpdateWithHttpOperationResponse(resourceGroupName: string, resourceName: string, options?: { tags? : { [propertyName: string]: string }, customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Update an existing IoT Hubs tags. * * Update an existing IoT Hub tags. to update other fields use the * CreateOrUpdate method * * @param {string} resourceGroupName Resource group identifier. * * @param {string} resourceName Name of iot hub to update. * * @param {object} [options] Optional Parameters. * * @param {object} [options.tags] Resource tags * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {IotHubDescription} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {IotHubDescription} [result] - The deserialized result object if an error did not occur. * See {@link IotHubDescription} for more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ beginUpdate(resourceGroupName: string, resourceName: string, options?: { tags? : { [propertyName: string]: string }, customHeaders? : { [headerName: string]: string; } }): Promise; beginUpdate(resourceGroupName: string, resourceName: string, callback: ServiceCallback): void; beginUpdate(resourceGroupName: string, resourceName: string, options: { tags? : { [propertyName: string]: string }, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Delete an IoT hub * * Delete an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ beginDeleteMethodWithHttpOperationResponse(resourceGroupName: string, resourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Delete an IoT hub * * Delete an IoT hub. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {Object} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {Object} [result] - The deserialized result object if an error did not occur. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ beginDeleteMethod(resourceGroupName: string, resourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; beginDeleteMethod(resourceGroupName: string, resourceName: string, callback: ServiceCallback): void; beginDeleteMethod(resourceGroupName: string, resourceName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get all the IoT hubs in a subscription * * Get all the IoT hubs in a subscription. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ listBySubscriptionNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get all the IoT hubs in a subscription * * Get all the IoT hubs in a subscription. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {IotHubDescriptionListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {IotHubDescriptionListResult} [result] - The deserialized result object if an error did not occur. * See {@link IotHubDescriptionListResult} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ listBySubscriptionNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; listBySubscriptionNext(nextPageLink: string, callback: ServiceCallback): void; listBySubscriptionNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get all the IoT hubs in a resource group * * Get all the IoT hubs in a resource group. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ listByResourceGroupNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get all the IoT hubs in a resource group * * Get all the IoT hubs in a resource group. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {IotHubDescriptionListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {IotHubDescriptionListResult} [result] - The deserialized result object if an error did not occur. * See {@link IotHubDescriptionListResult} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ listByResourceGroupNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; listByResourceGroupNext(nextPageLink: string, callback: ServiceCallback): void; listByResourceGroupNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get the list of valid SKUs for an IoT hub * * Get the list of valid SKUs for an IoT hub. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ getValidSkusNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get the list of valid SKUs for an IoT hub * * Get the list of valid SKUs for an IoT hub. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {IotHubSkuDescriptionListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {IotHubSkuDescriptionListResult} [result] - The deserialized result object if an error did not occur. * See {@link IotHubSkuDescriptionListResult} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ getValidSkusNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; getValidSkusNext(nextPageLink: string, callback: ServiceCallback): void; getValidSkusNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get a list of the consumer groups in the Event Hub-compatible * device-to-cloud endpoint in an IoT hub * * Get a list of the consumer groups in the Event Hub-compatible * device-to-cloud endpoint in an IoT hub. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ listEventHubConsumerGroupsNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get a list of the consumer groups in the Event Hub-compatible * device-to-cloud endpoint in an IoT hub * * Get a list of the consumer groups in the Event Hub-compatible * device-to-cloud endpoint in an IoT hub. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {EventHubConsumerGroupsListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {EventHubConsumerGroupsListResult} [result] - The deserialized result object if an error did not occur. * See {@link EventHubConsumerGroupsListResult} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ listEventHubConsumerGroupsNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; listEventHubConsumerGroupsNext(nextPageLink: string, callback: ServiceCallback): void; listEventHubConsumerGroupsNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get a list of all the jobs in an IoT hub. For more information, * see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry * * Get a list of all the jobs in an IoT hub. For more information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ listJobsNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get a list of all the jobs in an IoT hub. For more information, * see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry * * Get a list of all the jobs in an IoT hub. For more information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {JobResponseListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {JobResponseListResult} [result] - The deserialized result object if an error did not occur. * See {@link JobResponseListResult} for more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ listJobsNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; listJobsNext(nextPageLink: string, callback: ServiceCallback): void; listJobsNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get the quota metrics for an IoT hub * * Get the quota metrics for an IoT hub. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ getQuotaMetricsNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get the quota metrics for an IoT hub * * Get the quota metrics for an IoT hub. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {IotHubQuotaMetricInfoListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {IotHubQuotaMetricInfoListResult} [result] - The deserialized result object if an error did not occur. * See {@link IotHubQuotaMetricInfoListResult} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ getQuotaMetricsNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; getQuotaMetricsNext(nextPageLink: string, callback: ServiceCallback): void; getQuotaMetricsNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get the health for routing endpoints * * Get the health for routing endpoints. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ getEndpointHealthNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get the health for routing endpoints * * Get the health for routing endpoints. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {EndpointHealthDataListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {EndpointHealthDataListResult} [result] - The deserialized result object if an error did not occur. * See {@link EndpointHealthDataListResult} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ getEndpointHealthNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; getEndpointHealthNext(nextPageLink: string, callback: ServiceCallback): void; getEndpointHealthNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get the security metadata for an IoT hub. For more information, * see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security * * Get the security metadata for an IoT hub. For more information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ listKeysNextWithHttpOperationResponse(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get the security metadata for an IoT hub. For more information, * see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security * * Get the security metadata for an IoT hub. For more information, see: * https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. * * @param {string} nextPageLink The NextLink from the previous successful call * to List operation. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {SharedAccessSignatureAuthorizationRuleListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {SharedAccessSignatureAuthorizationRuleListResult} [result] - The deserialized result object if an error did not occur. * See {@link * SharedAccessSignatureAuthorizationRuleListResult} for * more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ listKeysNext(nextPageLink: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; listKeysNext(nextPageLink: string, callback: ServiceCallback): void; listKeysNext(nextPageLink: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; } /** * @class * ResourceProviderCommon * __NOTE__: An instance of this class is automatically created for an * instance of the IotHubClient. */ export interface ResourceProviderCommon { /** * @summary Get the number of iot hubs in the subscription * * Get the number of free and paid iot hubs in the subscription * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ getSubscriptionQuotaWithHttpOperationResponse(options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get the number of iot hubs in the subscription * * Get the number of free and paid iot hubs in the subscription * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {UserSubscriptionQuotaListResult} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {UserSubscriptionQuotaListResult} [result] - The deserialized result object if an error did not occur. * See {@link UserSubscriptionQuotaListResult} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ getSubscriptionQuota(options?: { customHeaders? : { [headerName: string]: string; } }): Promise; getSubscriptionQuota(callback: ServiceCallback): void; getSubscriptionQuota(options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; } /** * @class * Certificates * __NOTE__: An instance of this class is automatically created for an * instance of the IotHubClient. */ export interface Certificates { /** * @summary Get the certificate list. * * Returns the list of certificates. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ listByIotHubWithHttpOperationResponse(resourceGroupName: string, resourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get the certificate list. * * Returns the list of certificates. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {CertificateListDescription} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {CertificateListDescription} [result] - The deserialized result object if an error did not occur. * See {@link CertificateListDescription} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ listByIotHub(resourceGroupName: string, resourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; listByIotHub(resourceGroupName: string, resourceName: string, callback: ServiceCallback): void; listByIotHub(resourceGroupName: string, resourceName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Get the certificate. * * Returns the certificate. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} certificateName The name of the certificate * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ getWithHttpOperationResponse(resourceGroupName: string, resourceName: string, certificateName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Get the certificate. * * Returns the certificate. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} certificateName The name of the certificate * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {CertificateDescription} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {CertificateDescription} [result] - The deserialized result object if an error did not occur. * See {@link CertificateDescription} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ get(resourceGroupName: string, resourceName: string, certificateName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; get(resourceGroupName: string, resourceName: string, certificateName: string, callback: ServiceCallback): void; get(resourceGroupName: string, resourceName: string, certificateName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Upload the certificate to the IoT hub. * * Adds new or replaces existing certificate. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} certificateName The name of the certificate * * @param {object} [options] Optional Parameters. * * @param {string} [options.ifMatch] ETag of the Certificate. Do not specify * for creating a brand new certificate. Required to update an existing * certificate. * * @param {string} [options.certificate] base-64 representation of the X509 * leaf certificate .cer file or just .pem file content. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ createOrUpdateWithHttpOperationResponse(resourceGroupName: string, resourceName: string, certificateName: string, options?: { ifMatch? : string, certificate? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Upload the certificate to the IoT hub. * * Adds new or replaces existing certificate. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} certificateName The name of the certificate * * @param {object} [options] Optional Parameters. * * @param {string} [options.ifMatch] ETag of the Certificate. Do not specify * for creating a brand new certificate. Required to update an existing * certificate. * * @param {string} [options.certificate] base-64 representation of the X509 * leaf certificate .cer file or just .pem file content. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {CertificateDescription} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {CertificateDescription} [result] - The deserialized result object if an error did not occur. * See {@link CertificateDescription} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ createOrUpdate(resourceGroupName: string, resourceName: string, certificateName: string, options?: { ifMatch? : string, certificate? : string, customHeaders? : { [headerName: string]: string; } }): Promise; createOrUpdate(resourceGroupName: string, resourceName: string, certificateName: string, callback: ServiceCallback): void; createOrUpdate(resourceGroupName: string, resourceName: string, certificateName: string, options: { ifMatch? : string, certificate? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Delete an X509 certificate. * * Deletes an existing X509 certificate or does nothing if it does not exist. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} certificateName The name of the certificate * * @param {string} ifMatch ETag of the Certificate. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ deleteMethodWithHttpOperationResponse(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Delete an X509 certificate. * * Deletes an existing X509 certificate or does nothing if it does not exist. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} certificateName The name of the certificate * * @param {string} ifMatch ETag of the Certificate. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {null} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {null} [result] - The deserialized result object if an error did not occur. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ deleteMethod(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; deleteMethod(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, callback: ServiceCallback): void; deleteMethod(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Generate verification code for proof of possession flow. * * Generates verification code for proof of possession flow. The verification * code will be used to generate a leaf certificate. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} certificateName The name of the certificate * * @param {string} ifMatch ETag of the Certificate. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ generateVerificationCodeWithHttpOperationResponse(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Generate verification code for proof of possession flow. * * Generates verification code for proof of possession flow. The verification * code will be used to generate a leaf certificate. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} certificateName The name of the certificate * * @param {string} ifMatch ETag of the Certificate. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {CertificateWithNonceDescription} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {CertificateWithNonceDescription} [result] - The deserialized result object if an error did not occur. * See {@link CertificateWithNonceDescription} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ generateVerificationCode(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise; generateVerificationCode(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, callback: ServiceCallback): void; generateVerificationCode(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; /** * @summary Verify certificate's private key possession. * * Verifies the certificate's private key possession by providing the leaf cert * issued by the verifying pre uploaded certificate. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} certificateName The name of the certificate * * @param {string} ifMatch ETag of the Certificate. * * @param {object} [options] Optional Parameters. * * @param {string} [options.certificate] base-64 representation of X509 * certificate .cer file or just .pem file content. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ verifyWithHttpOperationResponse(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options?: { certificate? : string, customHeaders? : { [headerName: string]: string; } }): Promise>; /** * @summary Verify certificate's private key possession. * * Verifies the certificate's private key possession by providing the leaf cert * issued by the verifying pre uploaded certificate. * * @param {string} resourceGroupName The name of the resource group that * contains the IoT hub. * * @param {string} resourceName The name of the IoT hub. * * @param {string} certificateName The name of the certificate * * @param {string} ifMatch ETag of the Certificate. * * @param {object} [options] Optional Parameters. * * @param {string} [options.certificate] base-64 representation of X509 * certificate .cer file or just .pem file content. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {CertificateDescription} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {CertificateDescription} [result] - The deserialized result object if an error did not occur. * See {@link CertificateDescription} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ verify(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options?: { certificate? : string, customHeaders? : { [headerName: string]: string; } }): Promise; verify(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, callback: ServiceCallback): void; verify(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options: { certificate? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback): void; }