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] cognitiveservices/resource-manager #712

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

This package contains an isomorphic SDK for CognitiveServicesManagementClient.

### Currently supported environments

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

### How to Install

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

### How to use

#### nodejs - Authentication, client creation and getProperties accounts 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 { CognitiveServicesManagementClient, CognitiveServicesManagementModels, CognitiveServicesManagementMappers } from "@azure/arm-cognitiveservices";
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];

msRestNodeAuth.interactiveLogin().then((creds) => {
const client = new CognitiveServicesManagementClient(creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
const accountName = "testaccountName";
client.accounts.getProperties(resourceGroupName, accountName).then((result) => {
console.log("The result is:");
console.log(result);
});
}).catch((err) => {
console.error(err);
});
```

#### browser - Authentication, client creation and getProperties accounts 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-cognitiveservices 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-cognitiveservices/dist/arm-cognitiveservices.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.ArmCognitiveservices.CognitiveServicesManagementClient(res.creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
const accountName = "testaccountName";
client.accounts.getProperties(resourceGroupName, accountName).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 CognitiveServicesManagementClient SDK for JavaScript
This package contains an isomorphic SDK for CognitiveServicesManagementClient.

## Currently supported environments
- Node.js version 6.x.x or higher
- Browser JavaScript

## How to Install
```
npm install @azure/arm-cognitiveservices
```


## How to use

### nodejs - Authentication, client creation and getProperties accounts as an example written in TypeScript.

```ts
import * as msRest from "ms-rest-js";
import * as msRestAzure from "ms-rest-azure-js";
import * as msRestNodeAuth from "ms-rest-nodeauth";
import { CognitiveServicesManagementClient, CognitiveServicesManagementModels, CognitiveServicesManagementMappers } from "@azure/arm-cognitiveservices";
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];

msRestNodeAuth.interactiveLogin().then((creds) => {
const client = new CognitiveServicesManagementClient(creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
const accountName = "testaccountName";
client.accounts.getProperties(resourceGroupName, accountName).then((result) => {
console.log("The result is:");
console.log(result);
});
}).catch((err) => {
console.error(err);
});
```

### browser - Authentication, client creation and getProperties accounts as an example written in JavaScript.
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-cognitiveservices sample</title>
<script src="node_modules/ms-rest-js/dist/msRest.browser.js"></script>
<script src="node_modules/ms-rest-azure-js/dist/msRestAzure.js"></script>
<script src="node_modules/ms-rest-browserauth/dist/msAuth.js"></script>
<script src="node_modules/@azure/arm-cognitiveservices/dist/arm-cognitiveservices.js"></script>
<script>
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.ArmCognitiveservices.CognitiveServicesManagementClient(res.creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
const accountName = "testaccountName";
client.accounts.getProperties(resourceGroupName, accountName).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 @@ -8,7 +8,7 @@
* regenerated.
*/

import * as msRest from "@azure/ms-rest-js";
import * as msRest from "ms-rest-js";
import * as Models from "./models";
import * as Mappers from "./models/mappers";
import * as operations from "./operations";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
*/

import * as Models from "./models";
import * as msRest from "@azure/ms-rest-js";
import * as msRestAzure from "@azure/ms-rest-azure-js";
import * as msRest from "ms-rest-js";
import * as msRestAzure from "ms-rest-azure-js";

const packageName = "@azure/arm-cognitiveservices";
const packageVersion = "0.1.0";
Expand Down
73 changes: 20 additions & 53 deletions packages/@azure/arm-cognitiveservices/lib/models/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
* regenerated.
*/

import { BaseResource, CloudError, AzureServiceClientOptions } from "@azure/ms-rest-azure-js";
import * as msRest from "@azure/ms-rest-js";
import { BaseResource, CloudError, AzureServiceClientOptions } from "ms-rest-azure-js";
import * as msRest from "ms-rest-js";

export { BaseResource, CloudError };

Expand All @@ -22,11 +22,10 @@ export { BaseResource, CloudError };
*/
export interface Sku {
/**
* @member {SkuName} name Gets or sets the sku name. Required for account
* creation, optional for update. Possible values include: 'F0', 'P0', 'P1',
* 'P2', 'S0', 'S1', 'S2', 'S3', 'S4', 'S5', 'S6'
* @member {string} name Gets or sets the sku name. Required for account
* creation, optional for update.
*/
name: SkuName;
name: string;
/**
* @member {SkuTier} [tier] Gets the sku tier. This is based on the SKU name.
* Possible values include: 'Free', 'Standard', 'Premium'
Expand All @@ -48,15 +47,9 @@ export interface CognitiveServicesAccountCreateParameters {
*/
sku: Sku;
/**
* @member {Kind} kind Required. Gets or sets the Kind of the resource.
* Possible values include: 'Bing.Autosuggest.v7', 'Bing.CustomSearch',
* 'Bing.Search.v7', 'Bing.Speech', 'Bing.SpellCheck.v7', 'ComputerVision',
* 'ContentModerator', 'CustomSpeech', 'CustomVision.Prediction',
* 'CustomVision.Training', 'Emotion', 'Face', 'LUIS', 'QnAMaker',
* 'SpeakerRecognition', 'SpeechTranslation', 'TextAnalytics',
* 'TextTranslation', 'WebLM'
* @member {string} kind Required. Gets or sets the Kind of the resource.
*/
kind: Kind;
kind: string;
/**
* @member {string} location Required. Gets or sets the location of the
* resource. This will be one of the supported and registered Azure Geo
Expand Down Expand Up @@ -151,6 +144,11 @@ export interface CognitiveServicesAccount extends BaseResource {
* @member {string} [internalId] The internal identifier.
*/
internalId?: string;
/**
* @member {string} [customSubDomainName] Optional subdomain name used for
* token-based authentication.
*/
customSubDomainName?: string;
/**
* @member {Sku} [sku] The SKU of Cognitive Services account.
*/
Expand Down Expand Up @@ -415,18 +413,13 @@ export interface OperationEntity {
*/
export interface CheckSkuAvailabilityParameter {
/**
* @member {SkuName[]} skus The SKU of the resource.
* @member {string[]} skus The SKU of the resource.
*/
skus: SkuName[];
skus: string[];
/**
* @member {Kind} kind The Kind of the resource. Possible values include:
* 'Bing.Autosuggest.v7', 'Bing.CustomSearch', 'Bing.Search.v7',
* 'Bing.Speech', 'Bing.SpellCheck.v7', 'ComputerVision', 'ContentModerator',
* 'CustomSpeech', 'CustomVision.Prediction', 'CustomVision.Training',
* 'Emotion', 'Face', 'LUIS', 'QnAMaker', 'SpeakerRecognition',
* 'SpeechTranslation', 'TextAnalytics', 'TextTranslation', 'WebLM'
* @member {string} kind The Kind of the resource.
*/
kind: Kind;
kind: string;
/**
* @member {string} type The Type of the resource.
*/
Expand All @@ -441,24 +434,17 @@ export interface CheckSkuAvailabilityParameter {
*/
export interface CheckSkuAvailabilityResult {
/**
* @member {Kind} [kind] The Kind of the resource. Possible values include:
* 'Bing.Autosuggest.v7', 'Bing.CustomSearch', 'Bing.Search.v7',
* 'Bing.Speech', 'Bing.SpellCheck.v7', 'ComputerVision', 'ContentModerator',
* 'CustomSpeech', 'CustomVision.Prediction', 'CustomVision.Training',
* 'Emotion', 'Face', 'LUIS', 'QnAMaker', 'SpeakerRecognition',
* 'SpeechTranslation', 'TextAnalytics', 'TextTranslation', 'WebLM'
* @member {string} [kind] The Kind of the resource.
*/
kind?: Kind;
kind?: string;
/**
* @member {string} [type] The Type of the resource.
*/
type?: string;
/**
* @member {SkuName} [skuName] The SKU of Cognitive Services account.
* Possible values include: 'F0', 'P0', 'P1', 'P2', 'S0', 'S1', 'S2', 'S3',
* 'S4', 'S5', 'S6'
* @member {string} [skuName] The SKU of Cognitive Services account.
*/
skuName?: SkuName;
skuName?: string;
/**
* @member {boolean} [skuAvailable] Indicates the given SKU is available or
* not.
Expand Down Expand Up @@ -691,14 +677,6 @@ export interface OperationEntityListResult extends Array<OperationEntity> {
nextLink?: string;
}

/**
* Defines values for SkuName.
* Possible values include: 'F0', 'P0', 'P1', 'P2', 'S0', 'S1', 'S2', 'S3', 'S4', 'S5', 'S6'
* @readonly
* @enum {string}
*/
export type SkuName = 'F0' | 'P0' | 'P1' | 'P2' | 'S0' | 'S1' | 'S2' | 'S3' | 'S4' | 'S5' | 'S6';

/**
* Defines values for SkuTier.
* Possible values include: 'Free', 'Standard', 'Premium'
Expand All @@ -707,17 +685,6 @@ export type SkuName = 'F0' | 'P0' | 'P1' | 'P2' | 'S0' | 'S1' | 'S2' | 'S3' | 'S
*/
export type SkuTier = 'Free' | 'Standard' | 'Premium';

/**
* Defines values for Kind.
* Possible values include: 'Bing.Autosuggest.v7', 'Bing.CustomSearch', 'Bing.Search.v7',
* 'Bing.Speech', 'Bing.SpellCheck.v7', 'ComputerVision', 'ContentModerator', 'CustomSpeech',
* 'CustomVision.Prediction', 'CustomVision.Training', 'Emotion', 'Face', 'LUIS', 'QnAMaker',
* 'SpeakerRecognition', 'SpeechTranslation', 'TextAnalytics', 'TextTranslation', 'WebLM'
* @readonly
* @enum {string}
*/
export type Kind = 'Bing.Autosuggest.v7' | 'Bing.CustomSearch' | 'Bing.Search.v7' | 'Bing.Speech' | 'Bing.SpellCheck.v7' | 'ComputerVision' | 'ContentModerator' | 'CustomSpeech' | 'CustomVision.Prediction' | 'CustomVision.Training' | 'Emotion' | 'Face' | 'LUIS' | 'QnAMaker' | 'SpeakerRecognition' | 'SpeechTranslation' | 'TextAnalytics' | 'TextTranslation' | 'WebLM';

/**
* Defines values for ProvisioningState.
* Possible values include: 'Creating', 'ResolvingDNS', 'Moving', 'Deleting', 'Succeeded', 'Failed'
Expand Down
Loading