Skip to content
This repository was archived by the owner on May 5, 2023. It is now read-only.
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions lib/services/deviceprovisioningservicesManagement/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -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.
81 changes: 41 additions & 40 deletions lib/services/deviceprovisioningservicesManagement/README.md
Original file line number Diff line number Diff line change
@@ -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 = "<Subscription_Id>";
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 = "<Subscription_Id>";
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)
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,19 @@

'use strict';

const models = require('./index');

/**
* Result of a long running operation.
*
*/
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() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,14 @@

'use strict';

const models = require('./index');

/**
* The JSON-serialized array of Certificate objects.
*
*/
class CertificateListDescription {
/**
* Create a CertificateListDescription.
* @member {array} [value] The array of Certificate objects.
* @property {array} [value] The array of Certificate objects.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
}
Expand Down
Loading