Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[AutoPR iothub/resource-manager] changes to improve documentation of endpoint health statuses for routing #1382

Merged
merged 1 commit into from
Feb 28, 2019
Merged
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 packages/@azure/arm-iothub/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) 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
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.
192 changes: 96 additions & 96 deletions packages/@azure/arm-iothub/README.md
Original file line number Diff line number Diff line change
@@ -1,96 +1,96 @@
## Azure IotHubClient SDK for JavaScript

This package contains an isomorphic SDK for IotHubClient.

### Currently supported environments

- Node.js version 6.x.x or higher
- Browser JavaScript

### How to Install

```
npm install @azure/arm-iothub
```

### How to use

#### nodejs - Authentication, client creation and list operations as an example written in TypeScript.

##### Install @azure/ms-rest-nodeauth

```
npm install @azure/ms-rest-nodeauth
```

##### Sample code

```ts
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";
import { IotHubClient, IotHubModels, IotHubMappers } from "@azure/arm-iothub";
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];

msRestNodeAuth.interactiveLogin().then((creds) => {
const client = new IotHubClient(creds, subscriptionId);
client.operations.list().then((result) => {
console.log("The result is:");
console.log(result);
});
}).catch((err) => {
console.error(err);
});
```

#### browser - Authentication, client creation and list operations as an example written in JavaScript.

##### Install @azure/ms-rest-browserauth

```
npm install @azure/ms-rest-browserauth
```

##### Sample code

See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.

- index.html
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>@azure/arm-iothub sample</title>
<script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
<script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script>
<script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
<script src="node_modules/@azure/arm-iothub/dist/arm-iothub.js"></script>
<script type="text/javascript">
const subscriptionId = "<Subscription_Id>";
const authManager = new msAuth.AuthManager({
clientId: "<client id for your Azure AD app>",
tenant: "<optional tenant for your organization>"
});
authManager.finalizeLogin().then((res) => {
if (!res.isLoggedIn) {
// may cause redirects
authManager.login();
}
const client = new Azure.ArmIothub.IotHubClient(res.creds, subscriptionId);
client.operations.list().then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.log("An error occurred:");
console.error(err);
});
});
</script>
</head>
<body></body>
</html>
```

## Related projects

- [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js)
## Azure IotHubClient SDK for JavaScript
This package contains an isomorphic SDK for IotHubClient.
### Currently supported environments
- Node.js version 6.x.x or higher
- Browser JavaScript
### How to Install
```bash
npm install @azure/arm-iothub
```
### How to use
#### nodejs - Authentication, client creation and list operations as an example written in TypeScript.
##### Install @azure/ms-rest-nodeauth
```bash
npm install @azure/ms-rest-nodeauth
```
##### Sample code
```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";
import { IotHubClient, IotHubModels, IotHubMappers } from "@azure/arm-iothub";
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
msRestNodeAuth.interactiveLogin().then((creds) => {
const client = new IotHubClient(creds, subscriptionId);
client.operations.list().then((result) => {
console.log("The result is:");
console.log(result);
});
}).catch((err) => {
console.error(err);
});
```
#### browser - Authentication, client creation and list operations as an example written in JavaScript.
##### Install @azure/ms-rest-browserauth
```bash
npm install @azure/ms-rest-browserauth
```
##### Sample code
See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.
- index.html
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>@azure/arm-iothub sample</title>
<script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
<script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script>
<script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
<script src="node_modules/@azure/arm-iothub/dist/arm-iothub.js"></script>
<script type="text/javascript">
const subscriptionId = "<Subscription_Id>";
const authManager = new msAuth.AuthManager({
clientId: "<client id for your Azure AD app>",
tenant: "<optional tenant for your organization>"
});
authManager.finalizeLogin().then((res) => {
if (!res.isLoggedIn) {
// may cause redirects
authManager.login();
}
const client = new Azure.ArmIothub.IotHubClient(res.creds, subscriptionId);
client.operations.list().then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.log("An error occurred:");
console.error(err);
});
});
</script>
</head>
<body></body>
</html>
```
## Related projects
- [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js)
4 changes: 2 additions & 2 deletions packages/@azure/arm-iothub/lib/iotHubClientContext.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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-iothub";
const packageVersion = "0.1.0";
const packageVersion = "2.1.0";

export class IotHubClientContext extends msRestAzure.AzureServiceClient {
credentials: msRest.ServiceClientCredentials;
Expand Down Expand Up @@ -44,7 +44,7 @@ export class IotHubClientContext extends msRestAzure.AzureServiceClient {

super(credentials, options);

this.apiVersion = '2018-04-01';
this.apiVersion = '2018-12-01-preview';
this.acceptLanguage = 'en-US';
this.longRunningOperationRetryTimeout = 30;
this.baseUri = options.baseUri || this.baseUri || "https://management.azure.com";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ export {
CloudToDeviceProperties,
FeedbackProperties,
OperationsMonitoringProperties,
IotHubPropertiesDeviceStreams,
IotHubSkuInfo
} from "../models/mappers";

69 changes: 56 additions & 13 deletions packages/@azure/arm-iothub/lib/models/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -492,11 +492,11 @@ export interface RoutingStorageContainerProperties {
*/
maxChunkSizeInBytes?: number;
/**
* @member {string} [encoding] Encoding that is used to serialize messages to
* blobs. Supported values are 'avro' and 'avrodeflate'. Default value is
* 'avro'.
* @member {Encoding} [encoding] Encoding that is used to serialize messages
* to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default
* value is 'avro'. Possible values include: 'Avro', 'AvroDeflate', 'JSON'
*/
encoding?: string;
encoding?: Encoding;
}

/**
Expand Down Expand Up @@ -647,8 +647,8 @@ export interface RoutingProperties {
*/
export interface StorageEndpointProperties {
/**
* @member {string} [sasTtlAsIso8601] The period of time for which the the
* SAS URI generated by IoT Hub for file upload is valid. See:
* @member {string} [sasTtlAsIso8601] The period of time for which the SAS
* URI generated by IoT Hub for file upload is valid. See:
* https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.
*/
sasTtlAsIso8601?: string;
Expand Down Expand Up @@ -759,6 +759,19 @@ export interface OperationsMonitoringProperties {
events?: { [propertyName: string]: OperationMonitoringLevel };
}

/**
* @interface
* An interface representing IotHubPropertiesDeviceStreams.
* The device streams properties of iothub.
*
*/
export interface IotHubPropertiesDeviceStreams {
/**
* @member {string[]} [streamingEndpoints] List of Device Streams Endpoints.
*/
streamingEndpoints?: string[];
}

/**
* @interface
* An interface representing IotHubProperties.
Expand All @@ -783,7 +796,7 @@ export interface IotHubProperties {
*/
readonly provisioningState?: string;
/**
* @member {string} [state] Thehub state state.
* @member {string} [state] The hub state.
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
Expand Down Expand Up @@ -839,6 +852,11 @@ export interface IotHubProperties {
* @member {OperationsMonitoringProperties} [operationsMonitoringProperties]
*/
operationsMonitoringProperties?: OperationsMonitoringProperties;
/**
* @member {IotHubPropertiesDeviceStreams} [deviceStreams] The device streams
* properties of iothub.
*/
deviceStreams?: IotHubPropertiesDeviceStreams;
/**
* @member {Capabilities} [features] The capabilities and features enabled
* for the IoT hub. Possible values include: 'None', 'DeviceManagement'
Expand Down Expand Up @@ -957,6 +975,12 @@ export interface OperationDisplay {
* the server.**
*/
readonly operation?: string;
/**
* @member {string} [description] Description of the operation
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
readonly description?: string;
}

/**
Expand Down Expand Up @@ -1052,8 +1076,19 @@ export interface EndpointHealthData {
*/
endpointId?: string;
/**
* @member {EndpointHealthStatus} [healthStatus] Health status. Possible
* values include: 'unknown', 'healthy', 'unhealthy', 'dead'
* @member {EndpointHealthStatus} [healthStatus] Health statuses have
* following meanings. The 'healthy' status shows that the endpoint is
* accepting messages as expected. The 'unhealthy' status shows that the
* endpoint is not accepting messages as expected and IoT Hub is retrying to
* send data to this endpoint. The status of an unhealthy endpoint will be
* updated to healthy when IoT Hub has established an eventually consistent
* state of health. The 'dead' status shows that the endpoint is not
* accepting messages, after IoT Hub retried sending messages for the retrial
* period. See IoT Hub metrics to identify errors and monitor issues with
* endpoints. The 'unknown' status shows that the IoT Hub has not established
* a connection with the endpoint. No messages have been delivered to or
* rejected from this endpoint. Possible values include: 'unknown',
* 'healthy', 'unhealthy', 'dead'
*/
healthStatus?: EndpointHealthStatus;
}
Expand Down Expand Up @@ -1398,13 +1433,13 @@ export interface RoutingMessage {
*/
export interface RoutingTwinProperties {
/**
* @member {any} [desiredProperties] Twin desired properties
* @member {any} [desired] Twin desired properties
*/
desiredProperties?: any;
desired?: any;
/**
* @member {any} [reportedProperties] Twin desired properties
* @member {any} [reported] Twin desired properties
*/
reportedProperties?: any;
reported?: any;
}

/**
Expand Down Expand Up @@ -1979,6 +2014,14 @@ export type TestResultStatus = 'undefined' | 'false' | 'true';
*/
export type RouteErrorSeverity = 'error' | 'warning';

/**
* Defines values for Encoding.
* Possible values include: 'Avro', 'AvroDeflate', 'JSON'
* @readonly
* @enum {string}
*/
export type Encoding = 'Avro' | 'AvroDeflate' | 'JSON';

/**
* Contains response data for the list operation.
*/
Expand Down
Loading