diff --git a/lib/services/deviceprovisioningservicesManagement/LICENSE.txt b/lib/services/deviceprovisioningservicesManagement/LICENSE.txt index a70e8cf660..5431ba98b9 100644 --- a/lib/services/deviceprovisioningservicesManagement/LICENSE.txt +++ b/lib/services/deviceprovisioningservicesManagement/LICENSE.txt @@ -1,21 +1,21 @@ -The MIT License (MIT) - -Copyright (c) 2018 Microsoft - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +The MIT License (MIT) + +Copyright (c) 2018 Microsoft + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/lib/services/deviceprovisioningservicesManagement/README.md b/lib/services/deviceprovisioningservicesManagement/README.md index 4a693abd4b..c85ee1d46c 100644 --- a/lib/services/deviceprovisioningservicesManagement/README.md +++ b/lib/services/deviceprovisioningservicesManagement/README.md @@ -1,40 +1,41 @@ ---- -uid: azure-arm-deviceprovisioningservices -summary: *content - ---- -# Microsoft Azure SDK for Node.js - IotDpsClient -This project provides a Node.js package for accessing Azure. Right now it supports: -- **Node.js version 6.x.x or higher** - -## Features - - -## How to Install - -```bash -npm install azure-arm-deviceprovisioningservices -``` - -## How to use - -### Authentication, client creation and list operations as an example. - -```javascript -const msRestAzure = require("ms-rest-azure"); -const IotDpsClient = require("azure-arm-deviceprovisioningservices"); -msRestAzure.interactiveLogin().then((creds) => { - const subscriptionId = ""; - const client = new IotDpsClient(creds, subscriptionId); - return client.operations.list().then((result) => { - console.log("The result is:"); - console.log(result); - }); -}).catch((err) => { - console.log('An error ocurred:'); - console.dir(err, {depth: null, colors: true}); -}); - -## Related projects - -- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node) +--- +uid: azure-arm-deviceprovisioningservices +summary: *content + +--- +**This SDK will be deprecated next year and will be replaced by a new TypeScript-based isomorphic SDK (found at https://github.com/Azure/azure-sdk-for-js) which works on Node.js and browsers.** +## Microsoft Azure SDK for Node.js - IotDpsClient +This project provides a Node.js package for accessing Azure. Right now it supports: +- **Node.js version 6.x.x or higher** + +### Features + + +### How to Install + +```bash +npm install azure-arm-deviceprovisioningservices +``` + +### How to use + +#### Authentication, client creation and list operations as an example. + +```javascript +const msRestAzure = require("ms-rest-azure"); +const IotDpsClient = require("azure-arm-deviceprovisioningservices"); +msRestAzure.interactiveLogin().then((creds) => { + const subscriptionId = ""; + const client = new IotDpsClient(creds, subscriptionId); + return client.operations.list().then((result) => { + console.log("The result is:"); + console.log(result); + }); +}).catch((err) => { + console.log('An error occurred:'); + console.dir(err, {depth: null, colors: true}); +}); + +### Related projects + +- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node) diff --git a/lib/services/deviceprovisioningservicesManagement/lib/iotDpsClient.d.ts b/lib/services/deviceprovisioningservicesManagement/lib/iotDpsClient.d.ts index 1076532a1a..d647c488f3 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/iotDpsClient.d.ts +++ b/lib/services/deviceprovisioningservicesManagement/lib/iotDpsClient.d.ts @@ -34,11 +34,11 @@ export default class IotDpsClient extends AzureServiceClient { * * @param {boolean} [options.noRetryPolicy] - If set to true, turn off default retry policy * - * @param {string} [options.acceptLanguage] - Gets or sets the preferred language for the response. + * @param {string} [options.acceptLanguage] - The preferred language for the response. * - * @param {number} [options.longRunningOperationRetryTimeout] - Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30. + * @param {number} [options.longRunningOperationRetryTimeout] - The retry timeout in seconds for Long Running Operations. Default value is 30. * - * @param {boolean} [options.generateClientRequestId] - When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. + * @param {boolean} [options.generateClientRequestId] - Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. * */ constructor(credentials: ServiceClientCredentials, subscriptionId: string, baseUri?: string, options?: AzureServiceClientOptions); diff --git a/lib/services/deviceprovisioningservicesManagement/lib/iotDpsClient.js b/lib/services/deviceprovisioningservicesManagement/lib/iotDpsClient.js index 50964667d4..c9deba3db3 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/iotDpsClient.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/iotDpsClient.js @@ -34,9 +34,9 @@ class IotDpsClient extends ServiceClient { * @param {object} [options.requestOptions] - Options for the underlying request object * {@link https://github.com/request/request#requestoptions-callback Options doc} * @param {boolean} [options.noRetryPolicy] - If set to true, turn off default retry policy - * @param {string} [options.acceptLanguage] - Gets or sets the preferred language for the response. - * @param {number} [options.longRunningOperationRetryTimeout] - Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30. - * @param {boolean} [options.generateClientRequestId] - When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. + * @param {string} [options.acceptLanguage] - The preferred language for the response. + * @param {number} [options.longRunningOperationRetryTimeout] - The retry timeout in seconds for Long Running Operations. Default value is 30. + * @param {boolean} [options.generateClientRequestId] - Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. */ constructor(credentials, subscriptionId, baseUri, options) { if (credentials === null || credentials === undefined) { diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/asyncOperationResult.js b/lib/services/deviceprovisioningservicesManagement/lib/models/asyncOperationResult.js index a9052f8f0d..d888e3f0b1 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/asyncOperationResult.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/asyncOperationResult.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * Result of a long running operation. * @@ -19,12 +17,12 @@ const models = require('./index'); class AsyncOperationResult { /** * Create a AsyncOperationResult. - * @member {string} [status] current status of a long running operation. - * @member {object} [error] Error message containing code, description and + * @property {string} [status] current status of a long running operation. + * @property {object} [error] Error message containing code, description and * details - * @member {string} [error.code] standard error code - * @member {string} [error.message] standard error description - * @member {string} [error.details] detailed summary of error + * @property {string} [error.code] standard error code + * @property {string} [error.message] standard error description + * @property {string} [error.details] detailed summary of error */ constructor() { } diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/certificateBodyDescription.js b/lib/services/deviceprovisioningservicesManagement/lib/models/certificateBodyDescription.js index d30486aba3..108ec4a2d9 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/certificateBodyDescription.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/certificateBodyDescription.js @@ -17,7 +17,7 @@ class CertificateBodyDescription { /** * Create a CertificateBodyDescription. - * @member {string} [certificate] Base-64 representation of the X509 leaf + * @property {string} [certificate] Base-64 representation of the X509 leaf * certificate .cer file or just .pem file content. */ constructor() { diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/certificateListDescription.js b/lib/services/deviceprovisioningservicesManagement/lib/models/certificateListDescription.js index 84afde25bf..0bc7b2656f 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/certificateListDescription.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/certificateListDescription.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * The JSON-serialized array of Certificate objects. * @@ -19,7 +17,7 @@ const models = require('./index'); class CertificateListDescription { /** * Create a CertificateListDescription. - * @member {array} [value] The array of Certificate objects. + * @property {array} [value] The array of Certificate objects. */ constructor() { } diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/certificateProperties.js b/lib/services/deviceprovisioningservicesManagement/lib/models/certificateProperties.js index 65fb1f2196..4999405ae2 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/certificateProperties.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/certificateProperties.js @@ -17,13 +17,13 @@ class CertificateProperties { /** * Create a CertificateProperties. - * @member {string} [subject] The certificate's subject name. - * @member {date} [expiry] The certificate's expiration date and time. - * @member {string} [thumbprint] The certificate's thumbprint. - * @member {boolean} [isVerified] Determines whether certificate has been + * @property {string} [subject] The certificate's subject name. + * @property {date} [expiry] The certificate's expiration date and time. + * @property {string} [thumbprint] The certificate's thumbprint. + * @property {boolean} [isVerified] Determines whether certificate has been * verified. - * @member {date} [created] The certificate's creation date and time. - * @member {date} [updated] The certificate's last update date and time. + * @property {date} [created] The certificate's creation date and time. + * @property {date} [updated] The certificate's last update date and time. */ constructor() { } diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/certificateResponse.js b/lib/services/deviceprovisioningservicesManagement/lib/models/certificateResponse.js index 11485cf5a2..60c660ee5d 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/certificateResponse.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/certificateResponse.js @@ -20,21 +20,21 @@ const models = require('./index'); class CertificateResponse extends models['BaseResource'] { /** * Create a CertificateResponse. - * @member {object} [properties] properties of a certificate - * @member {string} [properties.subject] The certificate's subject name. - * @member {date} [properties.expiry] The certificate's expiration date and + * @property {object} [properties] properties of a certificate + * @property {string} [properties.subject] The certificate's subject name. + * @property {date} [properties.expiry] The certificate's expiration date and * time. - * @member {string} [properties.thumbprint] The certificate's thumbprint. - * @member {boolean} [properties.isVerified] Determines whether certificate + * @property {string} [properties.thumbprint] The certificate's thumbprint. + * @property {boolean} [properties.isVerified] Determines whether certificate * has been verified. - * @member {date} [properties.created] The certificate's creation date and + * @property {date} [properties.created] The certificate's creation date and * time. - * @member {date} [properties.updated] The certificate's last update date and - * time. - * @member {string} [id] The resource identifier. - * @member {string} [name] The name of the certificate. - * @member {string} [etag] The entity tag. - * @member {string} [type] The resource type. + * @property {date} [properties.updated] The certificate's last update date + * and time. + * @property {string} [id] The resource identifier. + * @property {string} [name] The name of the certificate. + * @property {string} [etag] The entity tag. + * @property {string} [type] The resource type. */ constructor() { super(); diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/errorDetails.js b/lib/services/deviceprovisioningservicesManagement/lib/models/errorDetails.js index 4c324936fc..a131aa88f6 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/errorDetails.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/errorDetails.js @@ -17,10 +17,10 @@ class ErrorDetails { /** * Create a ErrorDetails. - * @member {string} [code] The error code. - * @member {string} [httpStatusCode] The HTTP status code. - * @member {string} [message] The error message. - * @member {string} [details] The error details. + * @property {string} [code] The error code. + * @property {string} [httpStatusCode] The HTTP status code. + * @property {string} [message] The error message. + * @property {string} [details] The error details. */ constructor() { } diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/errorMesssage.js b/lib/services/deviceprovisioningservicesManagement/lib/models/errorMesssage.js index d732c59a2c..958435f1dc 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/errorMesssage.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/errorMesssage.js @@ -17,9 +17,9 @@ class ErrorMesssage { /** * Create a ErrorMesssage. - * @member {string} [code] standard error code - * @member {string} [message] standard error description - * @member {string} [details] detailed summary of error + * @property {string} [code] standard error code + * @property {string} [message] standard error description + * @property {string} [details] detailed summary of error */ constructor() { } diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/index.d.ts b/lib/services/deviceprovisioningservicesManagement/lib/models/index.d.ts index cfb264916e..55fca6e9ab 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/index.d.ts +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/index.d.ts @@ -1,507 +1,489 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ -import { BaseResource } from 'ms-rest-azure'; -import { CloudError } from 'ms-rest-azure'; -import * as moment from 'moment'; +import { BaseResource, CloudError } from "ms-rest-azure"; +import * as moment from "moment"; -export { BaseResource } from 'ms-rest-azure'; -export { CloudError } from 'ms-rest-azure'; +export { + BaseResource, + CloudError +}; /** - * @class - * Initializes a new instance of the ErrorMesssage class. - * @constructor * Error response containing message and code. - * - * @member {string} [code] standard error code - * @member {string} [message] standard error description - * @member {string} [details] detailed summary of error */ export interface ErrorMesssage { + /** + * standard error code + */ code?: string; + /** + * standard error description + */ message?: string; + /** + * detailed summary of error + */ details?: string; } /** - * @class - * Initializes a new instance of the AsyncOperationResult class. - * @constructor * Result of a long running operation. - * - * @member {string} [status] current status of a long running operation. - * @member {object} [error] Error message containing code, description and - * details - * @member {string} [error.code] standard error code - * @member {string} [error.message] standard error description - * @member {string} [error.details] detailed summary of error */ export interface AsyncOperationResult { + /** + * current status of a long running operation. + */ status?: string; + /** + * Error message containing code, description and details + */ error?: ErrorMesssage; } /** - * @class - * Initializes a new instance of the CertificateProperties class. - * @constructor * The description of an X509 CA Certificate. - * - * @member {string} [subject] The certificate's subject name. - * @member {date} [expiry] The certificate's expiration date and time. - * @member {string} [thumbprint] The certificate's thumbprint. - * @member {boolean} [isVerified] Determines whether certificate has been - * verified. - * @member {date} [created] The certificate's creation date and time. - * @member {date} [updated] The certificate's last update date and time. */ export interface CertificateProperties { + /** + * The certificate's subject name. + */ readonly subject?: string; + /** + * The certificate's expiration date and time. + */ readonly expiry?: Date; + /** + * The certificate's thumbprint. + */ readonly thumbprint?: string; + /** + * Determines whether certificate has been verified. + */ readonly isVerified?: boolean; + /** + * The certificate's creation date and time. + */ readonly created?: Date; + /** + * The certificate's last update date and time. + */ readonly updated?: Date; } /** - * @class - * Initializes a new instance of the CertificateResponse class. - * @constructor * The X509 Certificate. - * - * @member {object} [properties] properties of a certificate - * @member {string} [properties.subject] The certificate's subject name. - * @member {date} [properties.expiry] The certificate's expiration date and - * time. - * @member {string} [properties.thumbprint] The certificate's thumbprint. - * @member {boolean} [properties.isVerified] Determines whether certificate has - * been verified. - * @member {date} [properties.created] The certificate's creation date and - * time. - * @member {date} [properties.updated] The certificate's last update date and - * time. - * @member {string} [id] The resource identifier. - * @member {string} [name] The name of the certificate. - * @member {string} [etag] The entity tag. - * @member {string} [type] The resource type. */ export interface CertificateResponse extends BaseResource { + /** + * properties of a certificate + */ properties?: CertificateProperties; + /** + * The resource identifier. + */ readonly id?: string; + /** + * The name of the certificate. + */ readonly name?: string; + /** + * The entity tag. + */ readonly etag?: string; + /** + * The resource type. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the CertificateListDescription class. - * @constructor * The JSON-serialized array of Certificate objects. - * - * @member {array} [value] The array of Certificate objects. */ export interface CertificateListDescription { + /** + * The array of Certificate objects. + */ value?: CertificateResponse[]; } /** - * @class - * Initializes a new instance of the CertificateBodyDescription class. - * @constructor * The JSON-serialized X509 Certificate. - * - * @member {string} [certificate] Base-64 representation of the X509 leaf - * certificate .cer file or just .pem file content. */ export interface CertificateBodyDescription { + /** + * Base-64 representation of the X509 leaf certificate .cer file or just .pem file content. + */ certificate?: string; } /** - * @class - * Initializes a new instance of the IotDpsSkuInfo class. - * @constructor - * List of possible provisoning service SKUs. - * - * @member {string} [name] Sku name. Possible values include: 'S1' - * @member {string} [tier] Pricing tier name of the provisioning service. - * @member {number} [capacity] The number of units to provision + * List of possible provisioning service SKUs. */ export interface IotDpsSkuInfo { + /** + * Sku name. Possible values include: 'S1' + */ name?: string; + /** + * Pricing tier name of the provisioning service. + */ readonly tier?: string; + /** + * The number of units to provision + */ capacity?: number; } /** - * @class - * Initializes a new instance of the IotHubDefinitionDescription class. - * @constructor * Description of the IoT hub. - * - * @member {boolean} [applyAllocationPolicy] flag for applying allocationPolicy - * or not for a given iot hub. - * @member {number} [allocationWeight] weight to apply for a given iot h. - * @member {string} [name] Host name of the IoT hub. - * @member {string} connectionString Connection string og the IoT hub. - * @member {string} location ARM region of the IoT hub. */ export interface IotHubDefinitionDescription { + /** + * flag for applying allocationPolicy or not for a given iot hub. + */ applyAllocationPolicy?: boolean; + /** + * weight to apply for a given iot h. + */ allocationWeight?: number; + /** + * Host name of the IoT hub. + */ readonly name?: string; + /** + * Connection string og the IoT hub. + */ connectionString: string; + /** + * ARM region of the IoT hub. + */ location: string; } /** - * @class - * Initializes a new instance of the SharedAccessSignatureAuthorizationRuleAccessRightsDescription class. - * @constructor * Description of the shared access key. - * - * @member {string} keyName Name of the key. - * @member {string} [primaryKey] Primary SAS key value. - * @member {string} [secondaryKey] Secondary SAS key value. - * @member {string} rights Rights that this key has. Possible values include: - * 'ServiceConfig', 'EnrollmentRead', 'EnrollmentWrite', 'DeviceConnect', - * 'RegistrationStatusRead', 'RegistrationStatusWrite' */ export interface SharedAccessSignatureAuthorizationRuleAccessRightsDescription { + /** + * Name of the key. + */ keyName: string; + /** + * Primary SAS key value. + */ primaryKey?: string; + /** + * Secondary SAS key value. + */ secondaryKey?: string; + /** + * Rights that this key has. Possible values include: 'ServiceConfig', 'EnrollmentRead', + * 'EnrollmentWrite', 'DeviceConnect', 'RegistrationStatusRead', 'RegistrationStatusWrite' + */ rights: string; } /** - * @class - * Initializes a new instance of the IotDpsPropertiesDescription class. - * @constructor - * the service specific properties of a provisoning service, including keys, - * linked iot hubs, current state, and system generated properties such as - * hostname and idScope - * - * @member {string} [state] Current state of the provisioning service. Possible - * values include: 'Activating', 'Active', 'Deleting', 'Deleted', - * 'ActivationFailed', 'DeletionFailed', 'Transitioning', 'Suspending', - * 'Suspended', 'Resuming', 'FailingOver', 'FailoverFailed' - * @member {string} [provisioningState] The ARM provisioning state of the - * provisioning service. - * @member {array} [iotHubs] List of IoT hubs assosciated with this - * provisioning service. - * @member {string} [allocationPolicy] Allocation policy to be used by this - * provisioning service. Possible values include: 'Hashed', 'GeoLatency', - * 'Static' - * @member {string} [serviceOperationsHostName] Service endpoint for - * provisioning service. - * @member {string} [deviceProvisioningHostName] Device endpoint for this - * provisioning service. - * @member {string} [idScope] Unique identifier of this provisioning service. - * @member {array} [authorizationPolicies] List of authorization keys for a - * provisioning service. + * the service specific properties of a provisioning service, including keys, linked iot hubs, + * current state, and system generated properties such as hostname and idScope */ export interface IotDpsPropertiesDescription { + /** + * Current state of the provisioning service. Possible values include: 'Activating', 'Active', + * 'Deleting', 'Deleted', 'ActivationFailed', 'DeletionFailed', 'Transitioning', 'Suspending', + * 'Suspended', 'Resuming', 'FailingOver', 'FailoverFailed' + */ state?: string; + /** + * The ARM provisioning state of the provisioning service. + */ provisioningState?: string; + /** + * List of IoT hubs associated with this provisioning service. + */ iotHubs?: IotHubDefinitionDescription[]; + /** + * Allocation policy to be used by this provisioning service. Possible values include: 'Hashed', + * 'GeoLatency', 'Static' + */ allocationPolicy?: string; + /** + * Service endpoint for provisioning service. + */ readonly serviceOperationsHostName?: string; + /** + * Device endpoint for this provisioning service. + */ readonly deviceProvisioningHostName?: string; + /** + * Unique identifier of this provisioning service. + */ readonly idScope?: string; + /** + * List of authorization keys for a provisioning service. + */ authorizationPolicies?: SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]; } /** - * @class - * Initializes a new instance of the Resource class. - * @constructor * The common properties of an Azure resource. - * - * @member {string} [id] The resource identifier. - * @member {string} [name] The resource name. - * @member {string} [type] The resource type. - * @member {string} location The resource location. - * @member {object} [tags] The resource tags. */ export interface Resource extends BaseResource { + /** + * The resource identifier. + */ readonly id?: string; + /** + * The resource name. + */ readonly name?: string; + /** + * The resource type. + */ readonly type?: string; + /** + * The resource location. + */ location: string; + /** + * The resource tags. + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the ProvisioningServiceDescription class. - * @constructor * The description of the provisioning service. - * - * @member {string} [etag] The Etag field is *not* required. If it is provided - * in the response body, it must also be provided as a header per the normal - * ETag convention. - * @member {object} properties Service specific properties for a provisioning - * service - * @member {string} [properties.state] Current state of the provisioning - * service. Possible values include: 'Activating', 'Active', 'Deleting', - * 'Deleted', 'ActivationFailed', 'DeletionFailed', 'Transitioning', - * 'Suspending', 'Suspended', 'Resuming', 'FailingOver', 'FailoverFailed' - * @member {string} [properties.provisioningState] The ARM provisioning state - * of the provisioning service. - * @member {array} [properties.iotHubs] List of IoT hubs assosciated with this - * provisioning service. - * @member {string} [properties.allocationPolicy] Allocation policy to be used - * by this provisioning service. Possible values include: 'Hashed', - * 'GeoLatency', 'Static' - * @member {string} [properties.serviceOperationsHostName] Service endpoint for - * provisioning service. - * @member {string} [properties.deviceProvisioningHostName] Device endpoint for - * this provisioning service. - * @member {string} [properties.idScope] Unique identifier of this provisioning - * service. - * @member {array} [properties.authorizationPolicies] List of authorization - * keys for a provisioning service. - * @member {object} sku Sku info for a provisioning Service. - * @member {string} [sku.name] Sku name. Possible values include: 'S1' - * @member {string} [sku.tier] Pricing tier name of the provisioning service. - * @member {number} [sku.capacity] The number of units to provision */ export interface ProvisioningServiceDescription extends Resource { + /** + * The Etag field is *not* required. If it is provided in the response body, it must also be + * provided as a header per the normal ETag convention. + */ etag?: string; + /** + * Service specific properties for a provisioning service + */ properties: IotDpsPropertiesDescription; + /** + * Sku info for a provisioning Service. + */ sku: IotDpsSkuInfo; } /** - * @class - * Initializes a new instance of the OperationDisplay class. - * @constructor * The object that represents the operation. - * - * @member {string} [provider] Service provider: Microsoft Devices. - * @member {string} [resource] Resource Type: ProvisioningServices. - * @member {string} [operation] Name of the operation. */ export interface OperationDisplay { + /** + * Service provider: Microsoft Devices. + */ readonly provider?: string; + /** + * Resource Type: ProvisioningServices. + */ readonly resource?: string; + /** + * Name of the operation. + */ readonly operation?: string; } /** - * @class - * Initializes a new instance of the Operation class. - * @constructor * IoT Hub REST API operation. - * - * @member {string} [name] Operation name: {provider}/{resource}/{read | write - * | action | delete} - * @member {object} [display] The object that represents the operation. - * @member {string} [display.provider] Service provider: Microsoft Devices. - * @member {string} [display.resource] Resource Type: ProvisioningServices. - * @member {string} [display.operation] Name of the operation. */ export interface Operation { + /** + * Operation name: {provider}/{resource}/{read | write | action | delete} + */ readonly name?: string; + /** + * The object that represents the operation. + */ display?: OperationDisplay; } /** - * @class - * Initializes a new instance of the ErrorDetails class. - * @constructor * Error details. - * - * @member {string} [code] The error code. - * @member {string} [httpStatusCode] The HTTP status code. - * @member {string} [message] The error message. - * @member {string} [details] The error details. */ export interface ErrorDetails { + /** + * The error code. + */ readonly code?: string; + /** + * The HTTP status code. + */ readonly httpStatusCode?: string; + /** + * The error message. + */ readonly message?: string; + /** + * The error details. + */ readonly details?: string; } /** - * @class - * Initializes a new instance of the IotDpsSkuDefinition class. - * @constructor - * Available Sku's of tier and units. - * - * @member {string} [name] Sku name. Possible values include: 'S1' + * Available SKUs of tier and units. */ export interface IotDpsSkuDefinition { + /** + * Sku name. Possible values include: 'S1' + */ name?: string; } /** - * @class - * Initializes a new instance of the OperationInputs class. - * @constructor * Input values for operation results call. - * - * @member {string} name The name of the Provisioning Service to check. */ export interface OperationInputs { + /** + * The name of the Provisioning Service to check. + */ name: string; } /** - * @class - * Initializes a new instance of the NameAvailabilityInfo class. - * @constructor * Description of name availability. - * - * @member {boolean} [nameAvailable] specifies if a name is available or not - * @member {string} [reason] specifies the reason a name is unavailable. - * Possible values include: 'Invalid', 'AlreadyExists' - * @member {string} [message] message containing a etailed reason name is - * unavailable */ export interface NameAvailabilityInfo { + /** + * specifies if a name is available or not + */ nameAvailable?: boolean; + /** + * specifies the reason a name is unavailable. Possible values include: 'Invalid', + * 'AlreadyExists' + */ reason?: string; + /** + * message containing a detailed reason name is unavailable + */ message?: string; } /** - * @class - * Initializes a new instance of the TagsResource class. - * @constructor - * A container holding only the Tags for a resource, allowing the user to - * update the tags on a Provisioning Service instance. - * - * @member {object} [tags] Resource tags + * A container holding only the Tags for a resource, allowing the user to update the tags on a + * Provisioning Service instance. */ export interface TagsResource { + /** + * Resource tags + */ tags?: { [propertyName: string]: string }; } -/** - * @class - * Initializes a new instance of the VerificationCodeResponseProperties class. - * @constructor - * @member {string} [verificationCode] Verification code. - * @member {string} [subject] Certificate subject. - * @member {string} [expiry] Code expiry. - * @member {string} [thumbprint] Certificate thumbprint. - * @member {boolean} [isVerified] Indicate if the certificate is verified by - * owner of private key. - * @member {string} [created] Certificate created time. - * @member {string} [updated] Certificate updated time. - */ export interface VerificationCodeResponseProperties { + /** + * Verification code. + */ verificationCode?: string; + /** + * Certificate subject. + */ subject?: string; + /** + * Code expiry. + */ expiry?: string; + /** + * Certificate thumbprint. + */ thumbprint?: string; + /** + * Indicate if the certificate is verified by owner of private key. + */ isVerified?: boolean; + /** + * Certificate created time. + */ created?: string; + /** + * Certificate updated time. + */ updated?: string; } /** - * @class - * Initializes a new instance of the VerificationCodeResponse class. - * @constructor * Description of the response of the verification code. - * - * @member {string} [name] Name of certificate. - * @member {string} [etag] Request etag. - * @member {string} [id] The resource identifier. - * @member {string} [type] The resource type. - * @member {object} [properties] - * @member {string} [properties.verificationCode] Verification code. - * @member {string} [properties.subject] Certificate subject. - * @member {string} [properties.expiry] Code expiry. - * @member {string} [properties.thumbprint] Certificate thumbprint. - * @member {boolean} [properties.isVerified] Indicate if the certificate is - * verified by owner of private key. - * @member {string} [properties.created] Certificate created time. - * @member {string} [properties.updated] Certificate updated time. - */ +*/ export interface VerificationCodeResponse extends BaseResource { + /** + * Name of certificate. + */ readonly name?: string; + /** + * Request etag. + */ readonly etag?: string; + /** + * The resource identifier. + */ readonly id?: string; + /** + * The resource type. + */ readonly type?: string; properties?: VerificationCodeResponseProperties; } /** - * @class - * Initializes a new instance of the VerificationCodeRequest class. - * @constructor * The JSON-serialized leaf certificate - * - * @member {string} [certificate] base-64 representation of X509 certificate - * .cer file or just .pem file content. - */ +*/ export interface VerificationCodeRequest { + /** + * base-64 representation of X509 certificate .cer file or just .pem file content. + */ certificate?: string; } - /** - * @class - * Initializes a new instance of the OperationListResult class. - * @constructor - * Result of the request to list IoT Hub operations. It contains a list of - * operations and a URL link to get the next set of results. - * - * @member {string} [nextLink] URL to get the next set of operation list - * results if there are any. - */ + * Result of the request to list IoT Hub operations. It contains a list of operations and a URL + * link to get the next set of results. +*/ export interface OperationListResult extends Array { + /** + * URL to get the next set of operation list results if there are any. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the ProvisioningServiceDescriptionListResult class. - * @constructor * List of provisioning service descriptions. - * - * @member {string} [nextLink] the next link - */ -export interface ProvisioningServiceDescriptionListResult extends Array { +*/ +export interface ProvisioningServiceDescriptionListResult extends +Array { + /** + * the next link + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the IotDpsSkuDefinitionListResult class. - * @constructor * List of available SKUs. - * - * @member {string} [nextLink] The next link. - */ +*/ export interface IotDpsSkuDefinitionListResult extends Array { + /** + * The next link. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the SharedAccessSignatureAuthorizationRuleListResult class. - * @constructor * List of shared access keys. - * - * @member {string} [nextLink] The next link. - */ -export interface SharedAccessSignatureAuthorizationRuleListResult extends Array { +*/ +export interface SharedAccessSignatureAuthorizationRuleListResult extends +Array { + /** + * The next link. + */ readonly nextLink?: string; } diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/iotDpsPropertiesDescription.js b/lib/services/deviceprovisioningservicesManagement/lib/models/iotDpsPropertiesDescription.js index d24b040035..330f5ef85c 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/iotDpsPropertiesDescription.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/iotDpsPropertiesDescription.js @@ -10,10 +10,8 @@ 'use strict'; -const models = require('./index'); - /** - * the service specific properties of a provisoning service, including keys, + * the service specific properties of a provisioning service, including keys, * linked iot hubs, current state, and system generated properties such as * hostname and idScope * @@ -21,23 +19,24 @@ const models = require('./index'); class IotDpsPropertiesDescription { /** * Create a IotDpsPropertiesDescription. - * @member {string} [state] Current state of the provisioning service. + * @property {string} [state] Current state of the provisioning service. * Possible values include: 'Activating', 'Active', 'Deleting', 'Deleted', * 'ActivationFailed', 'DeletionFailed', 'Transitioning', 'Suspending', * 'Suspended', 'Resuming', 'FailingOver', 'FailoverFailed' - * @member {string} [provisioningState] The ARM provisioning state of the + * @property {string} [provisioningState] The ARM provisioning state of the * provisioning service. - * @member {array} [iotHubs] List of IoT hubs assosciated with this + * @property {array} [iotHubs] List of IoT hubs associated with this * provisioning service. - * @member {string} [allocationPolicy] Allocation policy to be used by this + * @property {string} [allocationPolicy] Allocation policy to be used by this * provisioning service. Possible values include: 'Hashed', 'GeoLatency', * 'Static' - * @member {string} [serviceOperationsHostName] Service endpoint for + * @property {string} [serviceOperationsHostName] Service endpoint for * provisioning service. - * @member {string} [deviceProvisioningHostName] Device endpoint for this + * @property {string} [deviceProvisioningHostName] Device endpoint for this * provisioning service. - * @member {string} [idScope] Unique identifier of this provisioning service. - * @member {array} [authorizationPolicies] List of authorization keys for a + * @property {string} [idScope] Unique identifier of this provisioning + * service. + * @property {array} [authorizationPolicies] List of authorization keys for a * provisioning service. */ constructor() { diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/iotDpsSkuDefinition.js b/lib/services/deviceprovisioningservicesManagement/lib/models/iotDpsSkuDefinition.js index 10dd44e701..544c2335d3 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/iotDpsSkuDefinition.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/iotDpsSkuDefinition.js @@ -11,13 +11,13 @@ 'use strict'; /** - * Available Sku's of tier and units. + * Available SKUs of tier and units. * */ class IotDpsSkuDefinition { /** * Create a IotDpsSkuDefinition. - * @member {string} [name] Sku name. Possible values include: 'S1' + * @property {string} [name] Sku name. Possible values include: 'S1' */ constructor() { } diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/iotDpsSkuDefinitionListResult.js b/lib/services/deviceprovisioningservicesManagement/lib/models/iotDpsSkuDefinitionListResult.js index 860357a9e2..0d0497bf12 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/iotDpsSkuDefinitionListResult.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/iotDpsSkuDefinitionListResult.js @@ -16,7 +16,7 @@ class IotDpsSkuDefinitionListResult extends Array { /** * Create a IotDpsSkuDefinitionListResult. - * @member {string} [nextLink] The next link. + * @property {string} [nextLink] The next link. */ constructor() { super(); diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/iotDpsSkuInfo.js b/lib/services/deviceprovisioningservicesManagement/lib/models/iotDpsSkuInfo.js index 804c05d929..afcc9144e8 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/iotDpsSkuInfo.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/iotDpsSkuInfo.js @@ -11,15 +11,15 @@ 'use strict'; /** - * List of possible provisoning service SKUs. + * List of possible provisioning service SKUs. * */ class IotDpsSkuInfo { /** * Create a IotDpsSkuInfo. - * @member {string} [name] Sku name. Possible values include: 'S1' - * @member {string} [tier] Pricing tier name of the provisioning service. - * @member {number} [capacity] The number of units to provision + * @property {string} [name] Sku name. Possible values include: 'S1' + * @property {string} [tier] Pricing tier name of the provisioning service. + * @property {number} [capacity] The number of units to provision */ constructor() { } diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/iotHubDefinitionDescription.js b/lib/services/deviceprovisioningservicesManagement/lib/models/iotHubDefinitionDescription.js index fe1185cf6f..dc49af70bd 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/iotHubDefinitionDescription.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/iotHubDefinitionDescription.js @@ -17,12 +17,12 @@ class IotHubDefinitionDescription { /** * Create a IotHubDefinitionDescription. - * @member {boolean} [applyAllocationPolicy] flag for applying + * @property {boolean} [applyAllocationPolicy] flag for applying * allocationPolicy or not for a given iot hub. - * @member {number} [allocationWeight] weight to apply for a given iot h. - * @member {string} [name] Host name of the IoT hub. - * @member {string} connectionString Connection string og the IoT hub. - * @member {string} location ARM region of the IoT hub. + * @property {number} [allocationWeight] weight to apply for a given iot h. + * @property {string} [name] Host name of the IoT hub. + * @property {string} connectionString Connection string og the IoT hub. + * @property {string} location ARM region of the IoT hub. */ constructor() { } diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/nameAvailabilityInfo.js b/lib/services/deviceprovisioningservicesManagement/lib/models/nameAvailabilityInfo.js index d54431d019..52c0b8cf61 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/nameAvailabilityInfo.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/nameAvailabilityInfo.js @@ -17,10 +17,11 @@ class NameAvailabilityInfo { /** * Create a NameAvailabilityInfo. - * @member {boolean} [nameAvailable] specifies if a name is available or not - * @member {string} [reason] specifies the reason a name is unavailable. + * @property {boolean} [nameAvailable] specifies if a name is available or + * not + * @property {string} [reason] specifies the reason a name is unavailable. * Possible values include: 'Invalid', 'AlreadyExists' - * @member {string} [message] message containing a etailed reason name is + * @property {string} [message] message containing a detailed reason name is * unavailable */ constructor() { diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/operation.js b/lib/services/deviceprovisioningservicesManagement/lib/models/operation.js index 0daac7f3c7..8c7e4efcc8 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/operation.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/operation.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * IoT Hub REST API operation. * @@ -19,12 +17,12 @@ const models = require('./index'); class Operation { /** * Create a Operation. - * @member {string} [name] Operation name: {provider}/{resource}/{read | + * @property {string} [name] Operation name: {provider}/{resource}/{read | * write | action | delete} - * @member {object} [display] The object that represents the operation. - * @member {string} [display.provider] Service provider: Microsoft Devices. - * @member {string} [display.resource] Resource Type: ProvisioningServices. - * @member {string} [display.operation] Name of the operation. + * @property {object} [display] The object that represents the operation. + * @property {string} [display.provider] Service provider: Microsoft Devices. + * @property {string} [display.resource] Resource Type: ProvisioningServices. + * @property {string} [display.operation] Name of the operation. */ constructor() { } diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/operationDisplay.js b/lib/services/deviceprovisioningservicesManagement/lib/models/operationDisplay.js index aeba707379..34d689b6e4 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/operationDisplay.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/operationDisplay.js @@ -17,9 +17,9 @@ class OperationDisplay { /** * Create a OperationDisplay. - * @member {string} [provider] Service provider: Microsoft Devices. - * @member {string} [resource] Resource Type: ProvisioningServices. - * @member {string} [operation] Name of the operation. + * @property {string} [provider] Service provider: Microsoft Devices. + * @property {string} [resource] Resource Type: ProvisioningServices. + * @property {string} [operation] Name of the operation. */ constructor() { } diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/operationInputs.js b/lib/services/deviceprovisioningservicesManagement/lib/models/operationInputs.js index f334592dfd..83000e19c1 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/operationInputs.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/operationInputs.js @@ -17,7 +17,7 @@ class OperationInputs { /** * Create a OperationInputs. - * @member {string} name The name of the Provisioning Service to check. + * @property {string} name The name of the Provisioning Service to check. */ constructor() { } diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/operationListResult.js b/lib/services/deviceprovisioningservicesManagement/lib/models/operationListResult.js index 60830f5405..9e9df059d0 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/operationListResult.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/operationListResult.js @@ -17,7 +17,7 @@ class OperationListResult extends Array { /** * Create a OperationListResult. - * @member {string} [nextLink] URL to get the next set of operation list + * @property {string} [nextLink] URL to get the next set of operation list * results if there are any. */ constructor() { diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/provisioningServiceDescription.js b/lib/services/deviceprovisioningservicesManagement/lib/models/provisioningServiceDescription.js index b5115573af..d00cc1060d 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/provisioningServiceDescription.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/provisioningServiceDescription.js @@ -20,34 +20,35 @@ const models = require('./index'); class ProvisioningServiceDescription extends models['Resource'] { /** * Create a ProvisioningServiceDescription. - * @member {string} [etag] The Etag field is *not* required. If it is + * @property {string} [etag] The Etag field is *not* required. If it is * provided in the response body, it must also be provided as a header per * the normal ETag convention. - * @member {object} properties Service specific properties for a provisioning - * service - * @member {string} [properties.state] Current state of the provisioning + * @property {object} properties Service specific properties for a + * provisioning service + * @property {string} [properties.state] Current state of the provisioning * service. Possible values include: 'Activating', 'Active', 'Deleting', * 'Deleted', 'ActivationFailed', 'DeletionFailed', 'Transitioning', * 'Suspending', 'Suspended', 'Resuming', 'FailingOver', 'FailoverFailed' - * @member {string} [properties.provisioningState] The ARM provisioning state - * of the provisioning service. - * @member {array} [properties.iotHubs] List of IoT hubs assosciated with + * @property {string} [properties.provisioningState] The ARM provisioning + * state of the provisioning service. + * @property {array} [properties.iotHubs] List of IoT hubs associated with * this provisioning service. - * @member {string} [properties.allocationPolicy] Allocation policy to be + * @property {string} [properties.allocationPolicy] Allocation policy to be * used by this provisioning service. Possible values include: 'Hashed', * 'GeoLatency', 'Static' - * @member {string} [properties.serviceOperationsHostName] Service endpoint + * @property {string} [properties.serviceOperationsHostName] Service endpoint * for provisioning service. - * @member {string} [properties.deviceProvisioningHostName] Device endpoint + * @property {string} [properties.deviceProvisioningHostName] Device endpoint * for this provisioning service. - * @member {string} [properties.idScope] Unique identifier of this + * @property {string} [properties.idScope] Unique identifier of this * provisioning service. - * @member {array} [properties.authorizationPolicies] List of authorization + * @property {array} [properties.authorizationPolicies] List of authorization * keys for a provisioning service. - * @member {object} sku Sku info for a provisioning Service. - * @member {string} [sku.name] Sku name. Possible values include: 'S1' - * @member {string} [sku.tier] Pricing tier name of the provisioning service. - * @member {number} [sku.capacity] The number of units to provision + * @property {object} sku Sku info for a provisioning Service. + * @property {string} [sku.name] Sku name. Possible values include: 'S1' + * @property {string} [sku.tier] Pricing tier name of the provisioning + * service. + * @property {number} [sku.capacity] The number of units to provision */ constructor() { super(); @@ -80,7 +81,7 @@ class ProvisioningServiceDescription extends models['Resource'] { readOnly: true, serializedName: 'name', constraints: { - Pattern: '^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$' + Pattern: /^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$/ }, type: { name: 'String' diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/provisioningServiceDescriptionListResult.js b/lib/services/deviceprovisioningservicesManagement/lib/models/provisioningServiceDescriptionListResult.js index 8b7df80e98..c379b9f14d 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/provisioningServiceDescriptionListResult.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/provisioningServiceDescriptionListResult.js @@ -16,7 +16,7 @@ class ProvisioningServiceDescriptionListResult extends Array { /** * Create a ProvisioningServiceDescriptionListResult. - * @member {string} [nextLink] the next link + * @property {string} [nextLink] the next link */ constructor() { super(); diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/resource.js b/lib/services/deviceprovisioningservicesManagement/lib/models/resource.js index 2dc0aa7ae7..b0dfced82c 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/resource.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/resource.js @@ -20,11 +20,11 @@ const models = require('./index'); class Resource extends models['BaseResource'] { /** * Create a Resource. - * @member {string} [id] The resource identifier. - * @member {string} [name] The resource name. - * @member {string} [type] The resource type. - * @member {string} location The resource location. - * @member {object} [tags] The resource tags. + * @property {string} [id] The resource identifier. + * @property {string} [name] The resource name. + * @property {string} [type] The resource type. + * @property {string} location The resource location. + * @property {object} [tags] The resource tags. */ constructor() { super(); @@ -57,7 +57,7 @@ class Resource extends models['BaseResource'] { readOnly: true, serializedName: 'name', constraints: { - Pattern: '^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$' + Pattern: /^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$/ }, type: { name: 'String' diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/sharedAccessSignatureAuthorizationRuleAccessRightsDescription.js b/lib/services/deviceprovisioningservicesManagement/lib/models/sharedAccessSignatureAuthorizationRuleAccessRightsDescription.js index d2d87eeabc..9ef636d590 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/sharedAccessSignatureAuthorizationRuleAccessRightsDescription.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/sharedAccessSignatureAuthorizationRuleAccessRightsDescription.js @@ -17,12 +17,12 @@ class SharedAccessSignatureAuthorizationRuleAccessRightsDescription { /** * Create a SharedAccessSignatureAuthorizationRuleAccessRightsDescription. - * @member {string} keyName Name of the key. - * @member {string} [primaryKey] Primary SAS key value. - * @member {string} [secondaryKey] Secondary SAS key value. - * @member {string} rights Rights that this key has. Possible values include: - * 'ServiceConfig', 'EnrollmentRead', 'EnrollmentWrite', 'DeviceConnect', - * 'RegistrationStatusRead', 'RegistrationStatusWrite' + * @property {string} keyName Name of the key. + * @property {string} [primaryKey] Primary SAS key value. + * @property {string} [secondaryKey] Secondary SAS key value. + * @property {string} rights Rights that this key has. Possible values + * include: 'ServiceConfig', 'EnrollmentRead', 'EnrollmentWrite', + * 'DeviceConnect', 'RegistrationStatusRead', 'RegistrationStatusWrite' */ constructor() { } diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/sharedAccessSignatureAuthorizationRuleListResult.js b/lib/services/deviceprovisioningservicesManagement/lib/models/sharedAccessSignatureAuthorizationRuleListResult.js index e4109a34ac..df9184a63d 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/sharedAccessSignatureAuthorizationRuleListResult.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/sharedAccessSignatureAuthorizationRuleListResult.js @@ -16,7 +16,7 @@ class SharedAccessSignatureAuthorizationRuleListResult extends Array { /** * Create a SharedAccessSignatureAuthorizationRuleListResult. - * @member {string} [nextLink] The next link. + * @property {string} [nextLink] The next link. */ constructor() { super(); diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/tagsResource.js b/lib/services/deviceprovisioningservicesManagement/lib/models/tagsResource.js index c40f043ec9..3e815ad92c 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/tagsResource.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/tagsResource.js @@ -18,7 +18,7 @@ class TagsResource { /** * Create a TagsResource. - * @member {object} [tags] Resource tags + * @property {object} [tags] Resource tags */ constructor() { } diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/verificationCodeRequest.js b/lib/services/deviceprovisioningservicesManagement/lib/models/verificationCodeRequest.js index 03bccfd98c..d619b6457d 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/verificationCodeRequest.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/verificationCodeRequest.js @@ -17,8 +17,8 @@ class VerificationCodeRequest { /** * Create a VerificationCodeRequest. - * @member {string} [certificate] base-64 representation of X509 certificate - * .cer file or just .pem file content. + * @property {string} [certificate] base-64 representation of X509 + * certificate .cer file or just .pem file content. */ constructor() { } diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/verificationCodeResponse.js b/lib/services/deviceprovisioningservicesManagement/lib/models/verificationCodeResponse.js index 34f6de02a2..2000b46398 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/verificationCodeResponse.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/verificationCodeResponse.js @@ -20,19 +20,19 @@ const models = require('./index'); class VerificationCodeResponse extends models['BaseResource'] { /** * Create a VerificationCodeResponse. - * @member {string} [name] Name of certificate. - * @member {string} [etag] Request etag. - * @member {string} [id] The resource identifier. - * @member {string} [type] The resource type. - * @member {object} [properties] - * @member {string} [properties.verificationCode] Verification code. - * @member {string} [properties.subject] Certificate subject. - * @member {string} [properties.expiry] Code expiry. - * @member {string} [properties.thumbprint] Certificate thumbprint. - * @member {boolean} [properties.isVerified] Indicate if the certificate is + * @property {string} [name] Name of certificate. + * @property {string} [etag] Request etag. + * @property {string} [id] The resource identifier. + * @property {string} [type] The resource type. + * @property {object} [properties] + * @property {string} [properties.verificationCode] Verification code. + * @property {string} [properties.subject] Certificate subject. + * @property {string} [properties.expiry] Code expiry. + * @property {string} [properties.thumbprint] Certificate thumbprint. + * @property {boolean} [properties.isVerified] Indicate if the certificate is * verified by owner of private key. - * @member {string} [properties.created] Certificate created time. - * @member {string} [properties.updated] Certificate updated time. + * @property {string} [properties.created] Certificate created time. + * @property {string} [properties.updated] Certificate updated time. */ constructor() { super(); diff --git a/lib/services/deviceprovisioningservicesManagement/lib/models/verificationCodeResponseProperties.js b/lib/services/deviceprovisioningservicesManagement/lib/models/verificationCodeResponseProperties.js index 75a4906d81..e733dda964 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/models/verificationCodeResponseProperties.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/models/verificationCodeResponseProperties.js @@ -16,14 +16,14 @@ class VerificationCodeResponseProperties { /** * Create a VerificationCodeResponseProperties. - * @member {string} [verificationCode] Verification code. - * @member {string} [subject] Certificate subject. - * @member {string} [expiry] Code expiry. - * @member {string} [thumbprint] Certificate thumbprint. - * @member {boolean} [isVerified] Indicate if the certificate is verified by - * owner of private key. - * @member {string} [created] Certificate created time. - * @member {string} [updated] Certificate updated time. + * @property {string} [verificationCode] Verification code. + * @property {string} [subject] Certificate subject. + * @property {string} [expiry] Code expiry. + * @property {string} [thumbprint] Certificate thumbprint. + * @property {boolean} [isVerified] Indicate if the certificate is verified + * by owner of private key. + * @property {string} [created] Certificate created time. + * @property {string} [updated] Certificate updated time. */ constructor() { } diff --git a/lib/services/deviceprovisioningservicesManagement/lib/operations/dpsCertificate.js b/lib/services/deviceprovisioningservicesManagement/lib/operations/dpsCertificate.js index d939454b00..4afa4afa5a 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/operations/dpsCertificate.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/operations/dpsCertificate.js @@ -374,7 +374,7 @@ function _createOrUpdate(resourceGroupName, provisioningServiceName, certificate /** * @summary Delete the Provisioning Service Certificate. * - * Deletes the specified certificate assosciated with the Provisioning Service + * Deletes the specified certificate associated with the Provisioning Service * * @param {string} resourceGroupName Resource group identifier. * @@ -1488,7 +1488,7 @@ class DpsCertificate { /** * @summary Delete the Provisioning Service Certificate. * - * Deletes the specified certificate assosciated with the Provisioning Service + * Deletes the specified certificate associated with the Provisioning Service * * @param {string} resourceGroupName Resource group identifier. * @@ -1553,7 +1553,7 @@ class DpsCertificate { /** * @summary Delete the Provisioning Service Certificate. * - * Deletes the specified certificate assosciated with the Provisioning Service + * Deletes the specified certificate associated with the Provisioning Service * * @param {string} resourceGroupName Resource group identifier. * diff --git a/lib/services/deviceprovisioningservicesManagement/lib/operations/index.d.ts b/lib/services/deviceprovisioningservicesManagement/lib/operations/index.d.ts index 5ed492edc2..5806b3e6dd 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/operations/index.d.ts +++ b/lib/services/deviceprovisioningservicesManagement/lib/operations/index.d.ts @@ -299,7 +299,7 @@ export interface DpsCertificate { /** * @summary Delete the Provisioning Service Certificate. * - * Deletes the specified certificate assosciated with the Provisioning Service + * Deletes the specified certificate associated with the Provisioning Service * * @param {string} resourceGroupName Resource group identifier. * @@ -352,7 +352,7 @@ export interface DpsCertificate { /** * @summary Delete the Provisioning Service Certificate. * - * Deletes the specified certificate assosciated with the Provisioning Service + * Deletes the specified certificate associated with the Provisioning Service * * @param {string} resourceGroupName Resource group identifier. * @@ -835,7 +835,7 @@ export interface IotDpsResource { * provisioning state of the provisioning service. * * @param {array} [iotDpsDescription.properties.iotHubs] List of IoT hubs - * assosciated with this provisioning service. + * associated with this provisioning service. * * @param {string} [iotDpsDescription.properties.allocationPolicy] Allocation * policy to be used by this provisioning service. Possible values include: @@ -902,7 +902,7 @@ export interface IotDpsResource { * provisioning state of the provisioning service. * * @param {array} [iotDpsDescription.properties.iotHubs] List of IoT hubs - * assosciated with this provisioning service. + * associated with this provisioning service. * * @param {string} [iotDpsDescription.properties.allocationPolicy] Allocation * policy to be used by this provisioning service. Possible values include: @@ -1589,7 +1589,7 @@ export interface IotDpsResource { * provisioning state of the provisioning service. * * @param {array} [iotDpsDescription.properties.iotHubs] List of IoT hubs - * assosciated with this provisioning service. + * associated with this provisioning service. * * @param {string} [iotDpsDescription.properties.allocationPolicy] Allocation * policy to be used by this provisioning service. Possible values include: @@ -1656,7 +1656,7 @@ export interface IotDpsResource { * provisioning state of the provisioning service. * * @param {array} [iotDpsDescription.properties.iotHubs] List of IoT hubs - * assosciated with this provisioning service. + * associated with this provisioning service. * * @param {string} [iotDpsDescription.properties.allocationPolicy] Allocation * policy to be used by this provisioning service. Possible values include: diff --git a/lib/services/deviceprovisioningservicesManagement/lib/operations/iotDpsResource.js b/lib/services/deviceprovisioningservicesManagement/lib/operations/iotDpsResource.js index b7f0b87be6..459427ac02 100644 --- a/lib/services/deviceprovisioningservicesManagement/lib/operations/iotDpsResource.js +++ b/lib/services/deviceprovisioningservicesManagement/lib/operations/iotDpsResource.js @@ -198,7 +198,7 @@ function _get(provisioningServiceName, resourceGroupName, options, callback) { * provisioning state of the provisioning service. * * @param {array} [iotDpsDescription.properties.iotHubs] List of IoT hubs - * assosciated with this provisioning service. + * associated with this provisioning service. * * @param {string} [iotDpsDescription.properties.allocationPolicy] Allocation * policy to be used by this provisioning service. Possible values include: @@ -1534,7 +1534,7 @@ function _listKeysForKeyName(provisioningServiceName, keyName, resourceGroupName * provisioning state of the provisioning service. * * @param {array} [iotDpsDescription.properties.iotHubs] List of IoT hubs - * assosciated with this provisioning service. + * associated with this provisioning service. * * @param {string} [iotDpsDescription.properties.allocationPolicy] Allocation * policy to be used by this provisioning service. Possible values include: @@ -2709,7 +2709,7 @@ class IotDpsResource { * provisioning state of the provisioning service. * * @param {array} [iotDpsDescription.properties.iotHubs] List of IoT hubs - * assosciated with this provisioning service. + * associated with this provisioning service. * * @param {string} [iotDpsDescription.properties.allocationPolicy] Allocation * policy to be used by this provisioning service. Possible values include: @@ -2788,7 +2788,7 @@ class IotDpsResource { * provisioning state of the provisioning service. * * @param {array} [iotDpsDescription.properties.iotHubs] List of IoT hubs - * assosciated with this provisioning service. + * associated with this provisioning service. * * @param {string} [iotDpsDescription.properties.allocationPolicy] Allocation * policy to be used by this provisioning service. Possible values include: @@ -3733,7 +3733,7 @@ class IotDpsResource { * provisioning state of the provisioning service. * * @param {array} [iotDpsDescription.properties.iotHubs] List of IoT hubs - * assosciated with this provisioning service. + * associated with this provisioning service. * * @param {string} [iotDpsDescription.properties.allocationPolicy] Allocation * policy to be used by this provisioning service. Possible values include: @@ -3812,7 +3812,7 @@ class IotDpsResource { * provisioning state of the provisioning service. * * @param {array} [iotDpsDescription.properties.iotHubs] List of IoT hubs - * assosciated with this provisioning service. + * associated with this provisioning service. * * @param {string} [iotDpsDescription.properties.allocationPolicy] Allocation * policy to be used by this provisioning service. Possible values include: diff --git a/lib/services/deviceprovisioningservicesManagement/package.json b/lib/services/deviceprovisioningservicesManagement/package.json index fb7e39b1aa..5ebae8d8e8 100644 --- a/lib/services/deviceprovisioningservicesManagement/package.json +++ b/lib/services/deviceprovisioningservicesManagement/package.json @@ -4,7 +4,7 @@ "description": "IotDpsClient Library with typescript type definitions for node", "version": "2.1.0", "dependencies": { - "ms-rest": "^2.3.2", + "ms-rest": "^2.3.3", "ms-rest-azure": "^2.5.5" }, "keywords": [ @@ -14,12 +14,12 @@ "license": "MIT", "main": "./lib/iotDpsClient.js", "types": "./lib/iotDpsClient.d.ts", - "homepage": "http://github.com/azure/azure-sdk-for-node", + "homepage": "https://github.com/azure/azure-sdk-for-node/tree/master/lib/services/deviceprovisioningservicesManagement", "repository": { "type": "git", "url": "https://github.com/azure/azure-sdk-for-node.git" }, "bugs": { - "url": "http://github.com/Azure/azure-sdk-for-node/issues" + "url": "https://github.com/azure/azure-sdk-for-node/issues" } -} \ No newline at end of file +}