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 iotcentral/resource-manager] [Hub Generated] Review request for Microsoft.IoTCentral to add version 2018-09-01 #2169

Closed
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 packages/@azure/arm-iotcentral/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.
203 changes: 100 additions & 103 deletions packages/@azure/arm-iotcentral/README.md
Original file line number Diff line number Diff line change
@@ -1,103 +1,100 @@
## Azure IotCentralClient SDK for JavaScript

This package contains an isomorphic SDK for IotCentralClient.

### Currently supported environments

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

### How to Install

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

### How to use

#### nodejs - Authentication, client creation and get apps 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 { IotCentralClient, IotCentralModels, IotCentralMappers } from "@azure/arm-iotcentral";
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];

msRestNodeAuth.interactiveLogin().then((creds) => {
const client = new IotCentralClient(creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
const resourceName = "testresourceName";
client.apps.get(resourceGroupName, resourceName).then((result) => {
console.log("The result is:");
console.log(result);
});
}).catch((err) => {
console.error(err);
});
```

#### browser - Authentication, client creation and get apps 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-iotcentral 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-iotcentral/dist/arm-iotcentral.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.ArmIotcentral.IotCentralClient(res.creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
const resourceName = "testresourceName";
client.apps.get(resourceGroupName, resourceName).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)


![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fpackages%2F%40azure%2Farm-iotcentral%2FREADME.png)
## Azure IotCentralClient SDK for JavaScript

This package contains an isomorphic SDK for IotCentralClient.

### Currently supported environments

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

### How to Install

```bash
npm install @azure/arm-iotcentral
```

### How to use

#### nodejs - Authentication, client creation and get apps 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 { IotCentralClient, IotCentralModels, IotCentralMappers } from "@azure/arm-iotcentral";
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];

msRestNodeAuth.interactiveLogin().then((creds) => {
const client = new IotCentralClient(creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
const resourceName = "testresourceName";
client.apps.get(resourceGroupName, resourceName).then((result) => {
console.log("The result is:");
console.log(result);
});
}).catch((err) => {
console.error(err);
});
```

#### browser - Authentication, client creation and get apps 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-iotcentral 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-iotcentral/dist/arm-iotcentral.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.ArmIotcentral.IotCentralClient(res.creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
const resourceName = "testresourceName";
client.apps.get(resourceGroupName, resourceName).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)
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-iotcentral";
const packageVersion = "0.1.0";
const packageVersion = "2.1.0";

export class IotCentralClientContext extends msRestAzure.AzureServiceClient {
credentials: msRest.ServiceClientCredentials;
Expand Down
4 changes: 3 additions & 1 deletion packages/@azure/arm-iotcentral/lib/models/appsMappers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ export {
AppPatch,
AppListResult,
OperationInputs,
AppAvailabilityInfo
AppAvailabilityInfo,
AppTemplatesResult,
AppTemplate
} from "../models/mappers";

98 changes: 98 additions & 0 deletions packages/@azure/arm-iotcentral/lib/models/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,51 @@ export interface AppAvailabilityInfo {
readonly message?: string;
}

/**
* @interface
* An interface representing AppTemplate.
* IoT Central Application Template.
*
*/
export interface AppTemplate {
/**
* @member {string} [manifestId] The ID of the template.
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
readonly manifestId?: string;
/**
* @member {string} [manifestVersion] The version of the template.
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
readonly manifestVersion?: string;
/**
* @member {string} [appTemplateName] The name of the template.
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
readonly appTemplateName?: string;
/**
* @member {string} [title] The title of the template.
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
readonly title?: string;
/**
* @member {number} [order] The order of the template in the templates list.
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
readonly order?: number;
/**
* @member {string} [description] The description of the template.
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
readonly description?: string;
}

/**
* @interface
* An interface representing IotCentralClientOptions.
Expand Down Expand Up @@ -327,6 +372,21 @@ export interface AppListResult extends Array<App> {
nextLink?: string;
}

/**
* @interface
* An interface representing the AppTemplatesResult.
* A list of IoT Central Application Templates with a next link.
*
* @extends Array<AppTemplate>
*/
export interface AppTemplatesResult extends Array<AppTemplate> {
/**
* @member {string} [nextLink] The link used to get the next page of IoT
* Central application templates.
*/
nextLink?: string;
}

/**
* @interface
* An interface representing the OperationListResult.
Expand Down Expand Up @@ -484,6 +544,25 @@ export type AppsCheckSubdomainAvailabilityResponse = AppAvailabilityInfo & {
};
};

/**
* Contains response data for the listTemplates operation.
*/
export type AppsListTemplatesResponse = AppTemplatesResult & {
/**
* The underlying HTTP response.
*/
_response: msRest.HttpResponse & {
/**
* The response body as text (string format)
*/
bodyAsText: string;
/**
* The response body as parsed JSON or XML
*/
parsedBody: AppTemplatesResult;
};
};

/**
* Contains response data for the beginCreateOrUpdate operation.
*/
Expand Down Expand Up @@ -560,6 +639,25 @@ export type AppsListByResourceGroupNextResponse = AppListResult & {
};
};

/**
* Contains response data for the listTemplatesNext operation.
*/
export type AppsListTemplatesNextResponse = AppTemplatesResult & {
/**
* The underlying HTTP response.
*/
_response: msRest.HttpResponse & {
/**
* The response body as text (string format)
*/
bodyAsText: string;
/**
* The response body as parsed JSON or XML
*/
parsedBody: AppTemplatesResult;
};
};

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