diff --git a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/LICENSE.txt b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/LICENSE.txt index a70e8cf66038..b73b4a1293c3 100644 --- a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/LICENSE.txt +++ b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/LICENSE.txt @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2018 Microsoft +Copyright (c) 2019 Microsoft Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/README.md b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/README.md index 8440129bcabb..f24985736863 100644 --- a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/README.md +++ b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/README.md @@ -9,7 +9,7 @@ This package contains an isomorphic SDK for IotDpsClient. ### How to Install -``` +```bash npm install @azure/arm-deviceprovisioningservices ``` @@ -19,13 +19,14 @@ npm install @azure/arm-deviceprovisioningservices ##### Install @azure/ms-rest-nodeauth -``` -npm install @azure/ms-rest-nodeauth +- Please install minimum version of `"@azure/ms-rest-nodeauth": "^3.0.0"`. +```bash +npm install @azure/ms-rest-nodeauth@"^3.0.0" ``` ##### Sample code -```ts +```typescript import * as msRest from "@azure/ms-rest-js"; import * as msRestAzure from "@azure/ms-rest-azure-js"; import * as msRestNodeAuth from "@azure/ms-rest-nodeauth"; @@ -47,7 +48,7 @@ msRestNodeAuth.interactiveLogin().then((creds) => { ##### Install @azure/ms-rest-browserauth -``` +```bash npm install @azure/ms-rest-browserauth ``` @@ -95,5 +96,4 @@ See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to - [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js) - ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/README.png) diff --git a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/package.json b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/package.json index 94c0afc8568d..c274bd66cf73 100644 --- a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/package.json +++ b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/package.json @@ -4,9 +4,9 @@ "description": "IotDpsClient Library with typescript type definitions for node.js and browser.", "version": "2.1.0", "dependencies": { - "@azure/ms-rest-azure-js": "^1.1.0", - "@azure/ms-rest-js": "^1.1.0", - "tslib": "^1.9.3" + "@azure/ms-rest-azure-js": "^2.0.1", + "@azure/ms-rest-js": "^2.0.4", + "tslib": "^1.10.0" }, "keywords": [ "node", @@ -20,18 +20,19 @@ "module": "./esm/iotDpsClient.js", "types": "./esm/iotDpsClient.d.ts", "devDependencies": { - "typescript": "^3.1.1", - "rollup": "^0.66.2", - "rollup-plugin-node-resolve": "^3.4.0", - "uglify-js": "^3.4.9" + "typescript": "^3.5.3", + "rollup": "^1.18.0", + "rollup-plugin-node-resolve": "^5.2.0", + "rollup-plugin-sourcemaps": "^0.4.2", + "uglify-js": "^3.6.0" }, - "homepage": "https://github.com/azure/azure-sdk-for-js/tree/master/sdk/deviceprovisioningservices/arm-deviceprovisioningservices", + "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/deviceprovisioningservices/arm-deviceprovisioningservices", "repository": { "type": "git", - "url": "https://github.com/azure/azure-sdk-for-js.git" + "url": "https://github.com/Azure/azure-sdk-for-js.git" }, "bugs": { - "url": "https://github.com/azure/azure-sdk-for-js/issues" + "url": "https://github.com/Azure/azure-sdk-for-js/issues" }, "files": [ "dist/**/*.js", @@ -43,6 +44,7 @@ "esm/**/*.d.ts", "esm/**/*.d.ts.map", "src/**/*.ts", + "README.md", "rollup.config.js", "tsconfig.json" ], @@ -52,5 +54,5 @@ "prepack": "npm install && npm run build" }, "sideEffects": false, - "authPublish": true + "autoPublish": true } diff --git a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/rollup.config.js b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/rollup.config.js index 17c78b89da67..daceb8cdee3f 100644 --- a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/rollup.config.js +++ b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/rollup.config.js @@ -1,10 +1,16 @@ +import rollup from "rollup"; import nodeResolve from "rollup-plugin-node-resolve"; +import sourcemaps from "rollup-plugin-sourcemaps"; + /** - * @type {import('rollup').RollupFileOptions} + * @type {rollup.RollupFileOptions} */ const config = { - input: './esm/iotDpsClient.js', - external: ["@azure/ms-rest-js", "@azure/ms-rest-azure-js"], + input: "./esm/iotDpsClient.js", + external: [ + "@azure/ms-rest-js", + "@azure/ms-rest-azure-js" + ], output: { file: "./dist/arm-deviceprovisioningservices.js", format: "umd", @@ -16,16 +22,16 @@ const config = { }, banner: `/* * 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. */` }, plugins: [ - nodeResolve({ module: true }) + nodeResolve({ mainFields: ['module', 'main'] }), + sourcemaps() ] }; + export default config; diff --git a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/iotDpsClientContext.ts b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/iotDpsClientContext.ts index 48146b6d20a3..45a7b7f41d05 100644 --- a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/iotDpsClientContext.ts +++ b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/iotDpsClientContext.ts @@ -13,7 +13,7 @@ import * as msRest from "@azure/ms-rest-js"; import * as msRestAzure from "@azure/ms-rest-azure-js"; const packageName = "@azure/arm-deviceprovisioningservices"; -const packageVersion = "0.1.0"; +const packageVersion = "2.1.0"; export class IotDpsClientContext extends msRestAzure.AzureServiceClient { credentials: msRest.ServiceClientCredentials; diff --git a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/dpsCertificateMappers.ts b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/dpsCertificateMappers.ts index 1f211111d514..bc59e73b045a 100644 --- a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/dpsCertificateMappers.ts +++ b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/dpsCertificateMappers.ts @@ -1,28 +1,25 @@ /* * 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. */ export { - CertificateResponse, BaseResource, - CertificateProperties, - ErrorDetails, CertificateBodyDescription, CertificateListDescription, - VerificationCodeResponse, - VerificationCodeResponseProperties, - VerificationCodeRequest, - Resource, - ProvisioningServiceDescription, + CertificateProperties, + CertificateResponse, + ErrorDetails, IotDpsPropertiesDescription, + IotDpsSkuInfo, IotHubDefinitionDescription, + ProvisioningServiceDescription, + Resource, SharedAccessSignatureAuthorizationRuleAccessRightsDescription, - IotDpsSkuInfo + VerificationCodeRequest, + VerificationCodeResponse, + VerificationCodeResponseProperties } from "../models/mappers"; - diff --git a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/index.ts b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/index.ts index 67af3c02b6fc..74bae3df4d96 100644 --- a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/index.ts +++ b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/index.ts @@ -1,11 +1,9 @@ /* * 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, CloudError, AzureServiceClientOptions } from "@azure/ms-rest-azure-js"; @@ -13,842 +11,663 @@ import * as msRest from "@azure/ms-rest-js"; export { BaseResource, CloudError }; - /** - * @interface - * An interface representing ErrorMesssage. * Error response containing message and code. - * */ export interface ErrorMesssage { /** - * @member {string} [code] standard error code + * standard error code */ code?: string; /** - * @member {string} [message] standard error description + * standard error description */ message?: string; /** - * @member {string} [details] detailed summary of error + * detailed summary of error */ details?: string; } /** - * @interface - * An interface representing AsyncOperationResult. * Result of a long running operation. - * */ export interface AsyncOperationResult { /** - * @member {string} [status] current status of a long running operation. + * current status of a long running operation. */ status?: string; /** - * @member {ErrorMesssage} [error] Error message containing code, description - * and details + * Error message containing code, description and details */ error?: ErrorMesssage; } /** - * @interface - * An interface representing CertificateProperties. * The description of an X509 CA Certificate. - * */ export interface CertificateProperties { /** - * @member {string} [subject] The certificate's subject name. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The certificate's subject name. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly subject?: string; /** - * @member {Date} [expiry] The certificate's expiration date and time. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The certificate's expiration date and time. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly expiry?: Date; /** - * @member {string} [thumbprint] The certificate's thumbprint. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The certificate's thumbprint. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly thumbprint?: string; /** - * @member {boolean} [isVerified] Determines whether certificate has been - * verified. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Determines whether certificate has been verified. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly isVerified?: boolean; /** - * @member {Date} [created] The certificate's creation date and time. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The certificate's creation date and time. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly created?: Date; /** - * @member {Date} [updated] The certificate's last update date and time. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The certificate's last update date and time. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly updated?: Date; } /** - * @interface - * An interface representing CertificateResponse. * The X509 Certificate. - * - * @extends BaseResource */ export interface CertificateResponse extends BaseResource { /** - * @member {CertificateProperties} [properties] properties of a certificate + * properties of a certificate */ properties?: CertificateProperties; /** - * @member {string} [id] The resource identifier. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The resource identifier. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly id?: string; /** - * @member {string} [name] The name of the certificate. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The name of the certificate. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly name?: string; /** - * @member {string} [etag] The entity tag. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The entity tag. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly etag?: string; /** - * @member {string} [type] The resource type. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The resource type. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly type?: string; } /** - * @interface - * An interface representing CertificateListDescription. * The JSON-serialized array of Certificate objects. - * */ export interface CertificateListDescription { /** - * @member {CertificateResponse[]} [value] The array of Certificate objects. + * The array of Certificate objects. */ value?: CertificateResponse[]; } /** - * @interface - * An interface representing CertificateBodyDescription. * The JSON-serialized X509 Certificate. - * */ export interface CertificateBodyDescription { /** - * @member {string} [certificate] Base-64 representation of the X509 leaf - * certificate .cer file or just .pem file content. + * Base-64 representation of the X509 leaf certificate .cer file or just .pem file content. */ certificate?: string; } /** - * @interface - * An interface representing IotDpsSkuInfo. - * List of possible provisoning service SKUs. - * + * List of possible provisioning service SKUs. */ export interface IotDpsSkuInfo { /** - * @member {IotDpsSku} [name] Sku name. Possible values include: 'S1' + * Sku name. Possible values include: 'S1' */ name?: IotDpsSku; /** - * @member {string} [tier] Pricing tier name of the provisioning service. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Pricing tier name of the provisioning service. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly tier?: string; /** - * @member {number} [capacity] The number of units to provision + * The number of units to provision */ capacity?: number; } /** - * @interface - * An interface representing IotHubDefinitionDescription. * Description of the IoT hub. - * */ export interface IotHubDefinitionDescription { /** - * @member {boolean} [applyAllocationPolicy] flag for applying - * allocationPolicy or not for a given iot hub. + * flag for applying allocationPolicy or not for a given iot hub. */ applyAllocationPolicy?: boolean; /** - * @member {number} [allocationWeight] weight to apply for a given iot h. + * weight to apply for a given iot h. */ allocationWeight?: number; /** - * @member {string} [name] Host name of the IoT hub. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Host name of the IoT hub. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly name?: string; /** - * @member {string} connectionString Connection string og the IoT hub. + * Connection string og the IoT hub. */ connectionString: string; /** - * @member {string} location ARM region of the IoT hub. + * ARM region of the IoT hub. */ location: string; } /** - * @interface - * An interface representing SharedAccessSignatureAuthorizationRuleAccessRightsDescription. * Description of the shared access key. - * */ export interface SharedAccessSignatureAuthorizationRuleAccessRightsDescription { /** - * @member {string} keyName Name of the key. + * Name of the key. */ keyName: string; /** - * @member {string} [primaryKey] Primary SAS key value. + * Primary SAS key value. */ primaryKey?: string; /** - * @member {string} [secondaryKey] Secondary SAS key value. + * Secondary SAS key value. */ secondaryKey?: string; /** - * @member {AccessRightsDescription} rights Rights that this key has. - * Possible values include: 'ServiceConfig', 'EnrollmentRead', - * 'EnrollmentWrite', 'DeviceConnect', 'RegistrationStatusRead', - * 'RegistrationStatusWrite' + * Rights that this key has. Possible values include: 'ServiceConfig', 'EnrollmentRead', + * 'EnrollmentWrite', 'DeviceConnect', 'RegistrationStatusRead', 'RegistrationStatusWrite' */ rights: AccessRightsDescription; } /** - * @interface - * An interface representing IotDpsPropertiesDescription. - * the service specific properties of a provisoning service, including keys, - * linked iot hubs, current state, and system generated properties such as - * hostname and idScope - * + * 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 { /** - * @member {State} [state] Current state of the provisioning service. - * Possible values include: 'Activating', 'Active', 'Deleting', 'Deleted', - * 'ActivationFailed', 'DeletionFailed', 'Transitioning', 'Suspending', + * Current state of the provisioning service. Possible values include: 'Activating', 'Active', + * 'Deleting', 'Deleted', 'ActivationFailed', 'DeletionFailed', 'Transitioning', 'Suspending', * 'Suspended', 'Resuming', 'FailingOver', 'FailoverFailed' */ state?: State; /** - * @member {string} [provisioningState] The ARM provisioning state of the - * provisioning service. + * The ARM provisioning state of the provisioning service. */ provisioningState?: string; /** - * @member {IotHubDefinitionDescription[]} [iotHubs] List of IoT hubs - * assosciated with this provisioning service. + * List of IoT hubs associated with this provisioning service. */ iotHubs?: IotHubDefinitionDescription[]; /** - * @member {AllocationPolicy} [allocationPolicy] Allocation policy to be used - * by this provisioning service. Possible values include: 'Hashed', + * Allocation policy to be used by this provisioning service. Possible values include: 'Hashed', * 'GeoLatency', 'Static' */ allocationPolicy?: AllocationPolicy; /** - * @member {string} [serviceOperationsHostName] Service endpoint for - * provisioning service. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Service endpoint for provisioning service. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly serviceOperationsHostName?: string; /** - * @member {string} [deviceProvisioningHostName] Device endpoint for this - * provisioning service. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Device endpoint for this provisioning service. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly deviceProvisioningHostName?: string; /** - * @member {string} [idScope] Unique identifier of this provisioning service. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Unique identifier of this provisioning service. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly idScope?: string; /** - * @member {SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]} - * [authorizationPolicies] List of authorization keys for a provisioning - * service. + * List of authorization keys for a provisioning service. */ authorizationPolicies?: SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]; } /** - * @interface - * An interface representing Resource. * The common properties of an Azure resource. - * - * @extends BaseResource */ export interface Resource extends BaseResource { /** - * @member {string} [id] The resource identifier. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The resource identifier. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly id?: string; /** - * @member {string} [name] The resource name. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The resource name. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly name?: string; /** - * @member {string} [type] The resource type. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The resource type. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly type?: string; /** - * @member {string} location The resource location. + * The resource location. */ location: string; /** - * @member {{ [propertyName: string]: string }} [tags] The resource tags. + * The resource tags. */ tags?: { [propertyName: string]: string }; } /** - * @interface - * An interface representing ProvisioningServiceDescription. * The description of the provisioning service. - * - * @extends Resource */ export interface ProvisioningServiceDescription extends Resource { /** - * @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. + * 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; /** - * @member {IotDpsPropertiesDescription} properties Service specific - * properties for a provisioning service + * Service specific properties for a provisioning service */ properties: IotDpsPropertiesDescription; /** - * @member {IotDpsSkuInfo} sku Sku info for a provisioning Service. + * Sku info for a provisioning Service. */ sku: IotDpsSkuInfo; } /** - * @interface - * An interface representing OperationDisplay. * The object that represents the operation. - * */ export interface OperationDisplay { /** - * @member {string} [provider] Service provider: Microsoft Devices. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Service provider: Microsoft Devices. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly provider?: string; /** - * @member {string} [resource] Resource Type: ProvisioningServices. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Resource Type: ProvisioningServices. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly resource?: string; /** - * @member {string} [operation] Name of the operation. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Name of the operation. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly operation?: string; } /** - * @interface - * An interface representing Operation. * IoT Hub REST API operation. - * */ export interface Operation { /** - * @member {string} [name] Operation name: {provider}/{resource}/{read | - * write | action | delete} - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Operation name: {provider}/{resource}/{read | write | action | delete} + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly name?: string; /** - * @member {OperationDisplay} [display] The object that represents the - * operation. + * The object that represents the operation. */ display?: OperationDisplay; } /** - * @interface - * An interface representing ErrorDetails. * Error details. - * */ export interface ErrorDetails { /** - * @member {string} [code] The error code. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The error code. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly code?: string; /** - * @member {string} [httpStatusCode] The HTTP status code. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The HTTP status code. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly httpStatusCode?: string; /** - * @member {string} [message] The error message. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The error message. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly message?: string; /** - * @member {string} [details] The error details. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The error details. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly details?: string; } /** - * @interface - * An interface representing IotDpsSkuDefinition. - * Available Sku's of tier and units. - * + * Available SKUs of tier and units. */ export interface IotDpsSkuDefinition { /** - * @member {IotDpsSku} [name] Sku name. Possible values include: 'S1' + * Sku name. Possible values include: 'S1' */ name?: IotDpsSku; } /** - * @interface - * An interface representing OperationInputs. * Input values for operation results call. - * */ export interface OperationInputs { /** - * @member {string} name The name of the Provisioning Service to check. + * The name of the Provisioning Service to check. */ name: string; } /** - * @interface - * An interface representing NameAvailabilityInfo. * Description of name availability. - * */ export interface NameAvailabilityInfo { /** - * @member {boolean} [nameAvailable] specifies if a name is available or not + * specifies if a name is available or not */ nameAvailable?: boolean; /** - * @member {NameUnavailabilityReason} [reason] specifies the reason a name is - * unavailable. Possible values include: 'Invalid', 'AlreadyExists' + * specifies the reason a name is unavailable. Possible values include: 'Invalid', + * 'AlreadyExists' */ reason?: NameUnavailabilityReason; /** - * @member {string} [message] message containing a etailed reason name is - * unavailable + * message containing a detailed reason name is unavailable */ message?: string; } /** - * @interface - * An interface representing TagsResource. - * A container holding only the Tags for a resource, allowing the user to - * update the tags on a Provisioning Service instance. - * + * A container holding only the Tags for a resource, allowing the user to update the tags on a + * Provisioning Service instance. */ export interface TagsResource { /** - * @member {{ [propertyName: string]: string }} [tags] Resource tags + * Resource tags */ tags?: { [propertyName: string]: string }; } /** - * @interface * An interface representing VerificationCodeResponseProperties. */ export interface VerificationCodeResponseProperties { /** - * @member {string} [verificationCode] Verification code. + * Verification code. */ verificationCode?: string; /** - * @member {string} [subject] Certificate subject. + * Certificate subject. */ subject?: string; /** - * @member {string} [expiry] Code expiry. + * Code expiry. */ expiry?: string; /** - * @member {string} [thumbprint] Certificate thumbprint. + * Certificate thumbprint. */ thumbprint?: string; /** - * @member {boolean} [isVerified] Indicate if the certificate is verified by - * owner of private key. + * Indicate if the certificate is verified by owner of private key. */ isVerified?: boolean; /** - * @member {string} [created] Certificate created time. + * Certificate created time. */ created?: string; /** - * @member {string} [updated] Certificate updated time. + * Certificate updated time. */ updated?: string; } /** - * @interface - * An interface representing VerificationCodeResponse. * Description of the response of the verification code. - * - * @extends BaseResource */ export interface VerificationCodeResponse extends BaseResource { /** - * @member {string} [name] Name of certificate. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Name of certificate. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly name?: string; /** - * @member {string} [etag] Request etag. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Request etag. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly etag?: string; /** - * @member {string} [id] The resource identifier. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The resource identifier. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly id?: string; /** - * @member {string} [type] The resource type. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The resource type. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly type?: string; - /** - * @member {VerificationCodeResponseProperties} [properties] - */ properties?: VerificationCodeResponseProperties; } /** - * @interface - * An interface representing VerificationCodeRequest. * The JSON-serialized leaf certificate - * */ export interface VerificationCodeRequest { /** - * @member {string} [certificate] base-64 representation of X509 certificate - * .cer file or just .pem file content. + * base-64 representation of X509 certificate .cer file or just .pem file content. */ certificate?: string; } /** - * @interface - * An interface representing DpsCertificateGetOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface DpsCertificateGetOptionalParams extends msRest.RequestOptionsBase { /** - * @member {string} [ifMatch] ETag of the certificate. + * ETag of the certificate. */ ifMatch?: string; } /** - * @interface - * An interface representing DpsCertificateCreateOrUpdateOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface DpsCertificateCreateOrUpdateOptionalParams extends msRest.RequestOptionsBase { /** - * @member {string} [ifMatch] ETag of the certificate. This is required to - * update an existing certificate, and ignored while creating a brand new - * certificate. + * ETag of the certificate. This is required to update an existing certificate, and ignored while + * creating a brand new certificate. */ ifMatch?: string; } /** - * @interface - * An interface representing DpsCertificateDeleteMethodOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface DpsCertificateDeleteMethodOptionalParams extends msRest.RequestOptionsBase { /** - * @member {string} [certificatename] This is optional, and it is the Common - * Name of the certificate. + * This is optional, and it is the Common Name of the certificate. */ certificatename?: string; /** - * @member {Uint8Array} [certificaterawBytes] Raw data within the - * certificate. + * Raw data within the certificate. */ certificaterawBytes?: Uint8Array; /** - * @member {boolean} [certificateisVerified] Indicates if certificate has - * been verified by owner of the private key. + * Indicates if certificate has been verified by owner of the private key. */ certificateisVerified?: boolean; /** - * @member {CertificatePurpose} [certificatepurpose] A description that - * mentions the purpose of the certificate. Possible values include: + * A description that mentions the purpose of the certificate. Possible values include: * 'clientAuthentication', 'serverAuthentication' */ certificatepurpose?: CertificatePurpose; /** - * @member {Date} [certificatecreated] Time the certificate is created. + * Time the certificate is created. */ certificatecreated?: Date; /** - * @member {Date} [certificatelastUpdated] Time the certificate is last - * updated. + * Time the certificate is last updated. */ certificatelastUpdated?: Date; /** - * @member {boolean} [certificatehasPrivateKey] Indicates if the certificate - * contains a private key. + * Indicates if the certificate contains a private key. */ certificatehasPrivateKey?: boolean; /** - * @member {string} [certificatenonce] Random number generated to indicate - * Proof of Possession. + * Random number generated to indicate Proof of Possession. */ certificatenonce?: string; } /** - * @interface - * An interface representing DpsCertificateGenerateVerificationCodeOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface DpsCertificateGenerateVerificationCodeOptionalParams extends msRest.RequestOptionsBase { /** - * @member {string} [certificatename] Common Name for the certificate. + * Common Name for the certificate. */ certificatename?: string; /** - * @member {Uint8Array} [certificaterawBytes] Raw data of certificate. + * Raw data of certificate. */ certificaterawBytes?: Uint8Array; /** - * @member {boolean} [certificateisVerified] Indicates if the certificate has - * been verified by owner of the private key. + * Indicates if the certificate has been verified by owner of the private key. */ certificateisVerified?: boolean; /** - * @member {CertificatePurpose} [certificatepurpose] Description mentioning - * the purpose of the certificate. Possible values include: + * Description mentioning the purpose of the certificate. Possible values include: * 'clientAuthentication', 'serverAuthentication' */ certificatepurpose?: CertificatePurpose; /** - * @member {Date} [certificatecreated] Certificate creation time. + * Certificate creation time. */ certificatecreated?: Date; /** - * @member {Date} [certificatelastUpdated] Certificate last updated time. + * Certificate last updated time. */ certificatelastUpdated?: Date; /** - * @member {boolean} [certificatehasPrivateKey] Indicates if the certificate - * contains private key. + * Indicates if the certificate contains private key. */ certificatehasPrivateKey?: boolean; /** - * @member {string} [certificatenonce] Random number generated to indicate - * Proof of Possession. + * Random number generated to indicate Proof of Possession. */ certificatenonce?: string; } /** - * @interface - * An interface representing DpsCertificateVerifyCertificateOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface DpsCertificateVerifyCertificateOptionalParams extends msRest.RequestOptionsBase { /** - * @member {string} [certificatename] Common Name for the certificate. + * Common Name for the certificate. */ certificatename?: string; /** - * @member {Uint8Array} [certificaterawBytes] Raw data of certificate. + * Raw data of certificate. */ certificaterawBytes?: Uint8Array; /** - * @member {boolean} [certificateisVerified] Indicates if the certificate has - * been verified by owner of the private key. + * Indicates if the certificate has been verified by owner of the private key. */ certificateisVerified?: boolean; /** - * @member {CertificatePurpose} [certificatepurpose] Describe the purpose of - * the certificate. Possible values include: 'clientAuthentication', + * Describe the purpose of the certificate. Possible values include: 'clientAuthentication', * 'serverAuthentication' */ certificatepurpose?: CertificatePurpose; /** - * @member {Date} [certificatecreated] Certificate creation time. + * Certificate creation time. */ certificatecreated?: Date; /** - * @member {Date} [certificatelastUpdated] Certificate last updated time. + * Certificate last updated time. */ certificatelastUpdated?: Date; /** - * @member {boolean} [certificatehasPrivateKey] Indicates if the certificate - * contains private key. + * Indicates if the certificate contains private key. */ certificatehasPrivateKey?: boolean; /** - * @member {string} [certificatenonce] Random number generated to indicate - * Proof of Possession. + * Random number generated to indicate Proof of Possession. */ certificatenonce?: string; } /** - * @interface * An interface representing IotDpsClientOptions. - * @extends AzureServiceClientOptions */ export interface IotDpsClientOptions extends AzureServiceClientOptions { - /** - * @member {string} [baseUri] - */ baseUri?: string; } - /** * @interface - * An interface representing the OperationListResult. - * 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. - * + * 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. * @extends Array */ export interface OperationListResult extends Array { /** - * @member {string} [nextLink] URL to get the next set of operation list - * results if there are any. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * URL to get the next set of operation list results if there are any. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly nextLink?: string; } /** * @interface - * An interface representing the ProvisioningServiceDescriptionListResult. * List of provisioning service descriptions. - * * @extends Array */ export interface ProvisioningServiceDescriptionListResult extends Array { /** - * @member {string} [nextLink] the next link - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * the next link + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly nextLink?: string; } /** * @interface - * An interface representing the IotDpsSkuDefinitionListResult. * List of available SKUs. - * * @extends Array */ export interface IotDpsSkuDefinitionListResult extends Array { /** - * @member {string} [nextLink] The next link. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The next link. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly nextLink?: string; } /** * @interface - * An interface representing the SharedAccessSignatureAuthorizationRuleListResult. * List of shared access keys. - * * @extends Array */ export interface SharedAccessSignatureAuthorizationRuleListResult extends Array { /** - * @member {string} [nextLink] The next link. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The next link. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly nextLink?: string; } @@ -916,6 +735,7 @@ export type OperationsListResponse = OperationListResult & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -935,6 +755,7 @@ export type OperationsListNextResponse = OperationListResult & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -954,6 +775,7 @@ export type DpsCertificateGetResponse = CertificateResponse & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -973,6 +795,7 @@ export type DpsCertificateCreateOrUpdateResponse = CertificateResponse & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -992,6 +815,7 @@ export type DpsCertificateListResponse = CertificateListDescription & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1011,6 +835,7 @@ export type DpsCertificateGenerateVerificationCodeResponse = VerificationCodeRes * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1030,6 +855,7 @@ export type DpsCertificateVerifyCertificateResponse = CertificateResponse & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1049,6 +875,7 @@ export type IotDpsResourceGetResponse = ProvisioningServiceDescription & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1068,6 +895,7 @@ export type IotDpsResourceCreateOrUpdateResponse = ProvisioningServiceDescriptio * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1087,6 +915,7 @@ export type IotDpsResourceUpdateResponse = ProvisioningServiceDescription & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1106,6 +935,7 @@ export type IotDpsResourceListBySubscriptionResponse = ProvisioningServiceDescri * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1125,6 +955,7 @@ export type IotDpsResourceListByResourceGroupResponse = ProvisioningServiceDescr * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1144,6 +975,7 @@ export type IotDpsResourceGetOperationResultResponse = AsyncOperationResult & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1163,6 +995,7 @@ export type IotDpsResourceListValidSkusResponse = IotDpsSkuDefinitionListResult * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1182,6 +1015,7 @@ export type IotDpsResourceCheckProvisioningServiceNameAvailabilityResponse = Nam * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1201,6 +1035,7 @@ export type IotDpsResourceListKeysResponse = SharedAccessSignatureAuthorizationR * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1220,6 +1055,7 @@ export type IotDpsResourceListKeysForKeyNameResponse = SharedAccessSignatureAuth * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1239,6 +1075,7 @@ export type IotDpsResourceBeginCreateOrUpdateResponse = ProvisioningServiceDescr * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1258,6 +1095,7 @@ export type IotDpsResourceBeginUpdateResponse = ProvisioningServiceDescription & * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1277,6 +1115,7 @@ export type IotDpsResourceListBySubscriptionNextResponse = ProvisioningServiceDe * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1296,6 +1135,7 @@ export type IotDpsResourceListByResourceGroupNextResponse = ProvisioningServiceD * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1315,6 +1155,7 @@ export type IotDpsResourceListValidSkusNextResponse = IotDpsSkuDefinitionListRes * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1334,6 +1175,7 @@ export type IotDpsResourceListKeysNextResponse = SharedAccessSignatureAuthorizat * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ diff --git a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/iotDpsResourceMappers.ts b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/iotDpsResourceMappers.ts index cad91fb75ceb..cc25ae4b2c14 100644 --- a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/iotDpsResourceMappers.ts +++ b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/iotDpsResourceMappers.ts @@ -1,35 +1,32 @@ /* * 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. */ export { - ProvisioningServiceDescription, - Resource, + AsyncOperationResult, BaseResource, - IotDpsPropertiesDescription, - IotHubDefinitionDescription, - SharedAccessSignatureAuthorizationRuleAccessRightsDescription, - IotDpsSkuInfo, - ErrorDetails, - TagsResource, + CertificateProperties, + CertificateResponse, CloudError, - ProvisioningServiceDescriptionListResult, - AsyncOperationResult, + ErrorDetails, ErrorMesssage, - IotDpsSkuDefinitionListResult, + IotDpsPropertiesDescription, IotDpsSkuDefinition, - OperationInputs, + IotDpsSkuDefinitionListResult, + IotDpsSkuInfo, + IotHubDefinitionDescription, NameAvailabilityInfo, + OperationInputs, + ProvisioningServiceDescription, + ProvisioningServiceDescriptionListResult, + Resource, + SharedAccessSignatureAuthorizationRuleAccessRightsDescription, SharedAccessSignatureAuthorizationRuleListResult, - CertificateResponse, - CertificateProperties, + TagsResource, VerificationCodeResponse, VerificationCodeResponseProperties } from "../models/mappers"; - diff --git a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/mappers.ts b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/mappers.ts index 91c501da2866..584c84ec2935 100644 --- a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/mappers.ts +++ b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/mappers.ts @@ -1,11 +1,9 @@ /* * 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 { CloudErrorMapper, BaseResourceMapper } from "@azure/ms-rest-azure-js"; diff --git a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/operationsMappers.ts b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/operationsMappers.ts index 50fee90a2573..5d69c8a954f1 100644 --- a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/operationsMappers.ts +++ b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/models/operationsMappers.ts @@ -1,17 +1,14 @@ /* * 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. */ export { - OperationListResult, + ErrorDetails, Operation, OperationDisplay, - ErrorDetails + OperationListResult } from "../models/mappers"; - diff --git a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/operations/dpsCertificate.ts b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/operations/dpsCertificate.ts index 48dd486b2027..1dea99da330c 100644 --- a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/operations/dpsCertificate.ts +++ b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/src/operations/dpsCertificate.ts @@ -107,7 +107,7 @@ export class DpsCertificate { } /** - * Deletes the specified certificate assosciated with the Provisioning Service + * Deletes the specified certificate associated with the Provisioning Service * @summary Delete the Provisioning Service Certificate. * @param resourceGroupName Resource group identifier. * @param ifMatch ETag of the certificate diff --git a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/tsconfig.json b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/tsconfig.json index 87bbf5b5fa49..422b584abd5e 100644 --- a/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/tsconfig.json +++ b/sdk/deviceprovisioningservices/arm-deviceprovisioningservices/tsconfig.json @@ -9,7 +9,7 @@ "esModuleInterop": true, "allowSyntheticDefaultImports": true, "forceConsistentCasingInFileNames": true, - "lib": ["es6"], + "lib": ["es6", "dom"], "declaration": true, "outDir": "./esm", "importHelpers": true