Skip to content
This repository was archived by the owner on May 5, 2023. It is now read-only.

[AutoPR cognitiveservices/resource-manager] typo: Microsoft.CognitiveServices #4248

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
13 changes: 6 additions & 7 deletions lib/services/cognitiveServicesManagement/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,22 @@ uid: azure-arm-cognitiveservices
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 - CognitiveServicesManagementClient
# Microsoft Azure SDK for Node.js - CognitiveServicesManagementClient
This project provides a Node.js package for accessing Azure. Right now it supports:
- **Node.js version 6.x.x or higher**

### Features
## Features


### How to Install
## How to Install

```bash
npm install azure-arm-cognitiveservices
```

### How to use
## How to use

#### Authentication, client creation and getProperties accounts as an example.
### Authentication, client creation and getProperties accounts as an example.

```javascript
const msRestAzure = require("ms-rest-azure");
Expand All @@ -38,6 +37,6 @@ msRestAzure.interactiveLogin().then((creds) => {
console.dir(err, {depth: null, colors: true});
});

### Related projects
## 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 @@ -17,14 +17,14 @@
class CheckSkuAvailabilityParameter {
/**
* Create a CheckSkuAvailabilityParameter.
* @property {array} skus The SKU of the resource.
* @property {string} kind The Kind of the resource. Possible values include:
* @member {array} skus The SKU of the resource.
* @member {string} 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'
* @property {string} type The Type of the resource.
* @member {string} type The Type of the resource.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,20 @@
class CheckSkuAvailabilityResult {
/**
* Create a CheckSkuAvailabilityResult.
* @property {string} [kind] The Kind of the resource. Possible values
* include: 'Bing.Autosuggest.v7', 'Bing.CustomSearch', 'Bing.Search.v7',
* @member {string} [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'
* @property {string} [type] The Type of the resource.
* @property {string} [skuName] The SKU of Cognitive Services account.
* Possible values include: 'F0', 'P0', 'P1', 'P2', 'S0', 'S1', 'S2', 'S3',
* 'S4', 'S5', 'S6'
* @property {boolean} [skuAvailable] Indicates the given SKU is available or
* @member {string} [type] The Type of the resource.
* @member {string} [skuName] The SKU of Cognitive Services account. Possible
* values include: 'F0', 'P0', 'P1', 'P2', 'S0', 'S1', 'S2', 'S3', 'S4',
* 'S5', 'S6'
* @member {boolean} [skuAvailable] Indicates the given SKU is available or
* not.
* @property {string} [reason] Reason why the SKU is not available.
* @property {string} [message] Additional error message.
* @member {string} [reason] Reason why the SKU is not available.
* @member {string} [message] Additional error message.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
class CheckSkuAvailabilityResultList {
/**
* Create a CheckSkuAvailabilityResultList.
* @property {array} [value] Check SKU availability result list.
* @member {array} [value] Check SKU availability result list.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,29 +21,29 @@ const models = require('./index');
class CognitiveServicesAccount extends models['BaseResource'] {
/**
* Create a CognitiveServicesAccount.
* @property {string} [etag] Entity Tag
* @property {string} [id] The id of the created account
* @property {string} [kind] Type of cognitive service account.
* @property {string} [location] The location of the resource
* @property {string} [name] The name of the created account
* @property {string} [provisioningState] Gets the status of the cognitive
* @member {string} [etag] Entity Tag
* @member {string} [id] The id of the created account
* @member {string} [kind] Type of cognitive service account.
* @member {string} [location] The location of the resource
* @member {string} [name] The name of the created account
* @member {string} [provisioningState] Gets the status of the cognitive
* services account at the time the operation was called. Possible values
* include: 'Creating', 'ResolvingDNS', 'Moving', 'Deleting', 'Succeeded',
* 'Failed'
* @property {string} [endpoint] Endpoint of the created account.
* @property {string} [internalId] The internal identifier.
* @property {object} [sku] The SKU of Cognitive Services account.
* @property {string} [sku.name] Gets or sets the sku name. Required for
* @member {string} [endpoint] Endpoint of the created account.
* @member {string} [internalId] The internal identifier.
* @member {object} [sku] The SKU of Cognitive Services account.
* @member {string} [sku.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'
* @property {string} [sku.tier] Gets the sku tier. This is based on the SKU
* @member {string} [sku.tier] Gets the sku tier. This is based on the SKU
* name. Possible values include: 'Free', 'Standard', 'Premium'
* @property {object} [tags] Gets or sets a list of key value pairs that
* @member {object} [tags] Gets or sets a list of key value pairs that
* describe the resource. These tags can be used in viewing and grouping this
* resource (across resource groups). A maximum of 15 tags can be provided
* for a resource. Each tag must have a key no greater than 128 characters
* and value no greater than 256 characters.
* @property {string} [type] Resource type
* @member {string} [type] Resource type
*/
constructor() {
super();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,30 +17,30 @@
class CognitiveServicesAccountCreateParameters {
/**
* Create a CognitiveServicesAccountCreateParameters.
* @property {object} sku Required. Gets or sets the SKU of the resource.
* @property {string} [sku.name] Gets or sets the sku name. Required for
* @member {object} sku Required. Gets or sets the SKU of the resource.
* @member {string} [sku.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'
* @property {string} [sku.tier] Gets the sku tier. This is based on the SKU
* @member {string} [sku.tier] Gets the sku tier. This is based on the SKU
* name. Possible values include: 'Free', 'Standard', 'Premium'
* @property {string} kind Required. Gets or sets the Kind of the resource.
* @member {string} 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'
* @property {string} location Required. Gets or sets the location of the
* @member {string} location Required. Gets or sets the location of the
* resource. This will be one of the supported and registered Azure Geo
* Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a
* resource cannot be changed once it is created, but if an identical geo
* region is specified on update the request will succeed.
* @property {object} [tags] Gets or sets a list of key value pairs that
* @member {object} [tags] Gets or sets a list of key value pairs that
* describe the resource. These tags can be used in viewing and grouping this
* resource (across resource groups). A maximum of 15 tags can be provided
* for a resource. Each tag must have a key no greater than 128 characters
* and value no greater than 256 characters.
* @property {object} properties Must exist in the request. Must be an empty
* @member {object} properties Must exist in the request. Must be an empty
* object. Must not be null.
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
class CognitiveServicesAccountEnumerateSkusResult {
/**
* Create a CognitiveServicesAccountEnumerateSkusResult.
* @property {array} [value] Gets the list of Cognitive Services accounts and
* @member {array} [value] Gets the list of Cognitive Services accounts and
* their properties.
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
class CognitiveServicesAccountKeys {
/**
* Create a CognitiveServicesAccountKeys.
* @property {string} [key1] Gets the value of key 1.
* @property {string} [key2] Gets the value of key 2.
* @member {string} [key1] Gets the value of key 1.
* @member {string} [key2] Gets the value of key 2.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
class CognitiveServicesAccountListResult extends Array {
/**
* Create a CognitiveServicesAccountListResult.
* @property {string} [nextLink] The link used to get the next page of
* @member {string} [nextLink] The link used to get the next page of
* accounts.
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@
class CognitiveServicesAccountUpdateParameters {
/**
* Create a CognitiveServicesAccountUpdateParameters.
* @property {object} [sku] Gets or sets the SKU of the resource.
* @property {string} [sku.name] Gets or sets the sku name. Required for
* @member {object} [sku] Gets or sets the SKU of the resource.
* @member {string} [sku.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'
* @property {string} [sku.tier] Gets the sku tier. This is based on the SKU
* @member {string} [sku.tier] Gets the sku tier. This is based on the SKU
* name. Possible values include: 'Free', 'Standard', 'Premium'
* @property {object} [tags] Gets or sets a list of key value pairs that
* @member {object} [tags] Gets or sets a list of key value pairs that
* describe the resource. These tags can be used in viewing and grouping this
* resource (across resource groups). A maximum of 15 tags can be provided
* for a resource. Each tag must have a key no greater than 128 characters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@
class CognitiveServicesResourceAndSku {
/**
* Create a CognitiveServicesResourceAndSku.
* @property {string} [resourceType] Resource Namespace and Type
* @property {object} [sku] The SKU of Cognitive Services account.
* @property {string} [sku.name] Gets or sets the sku name. Required for
* @member {string} [resourceType] Resource Namespace and Type
* @member {object} [sku] The SKU of Cognitive Services account.
* @member {string} [sku.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'
* @property {string} [sku.tier] Gets the sku tier. This is based on the SKU
* @member {string} [sku.tier] Gets the sku tier. This is based on the SKU
* name. Possible values include: 'Free', 'Standard', 'Premium'
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
class ErrorBody {
/**
* Create a ErrorBody.
* @property {string} code error code
* @property {string} message error message
* @member {string} code error code
* @member {string} message error message
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@
class ErrorModel {
/**
* Create a ErrorModel.
* @property {object} [error] The error body.
* @property {string} [error.code] error code
* @property {string} [error.message] error message
* @member {object} [error] The error body.
* @member {string} [error.code] error code
* @member {string} [error.message] error message
*/
constructor() {
}
Expand Down
Loading