diff --git a/lib/services/cognitiveServicesManagement/LICENSE.txt b/lib/services/cognitiveServicesManagement/LICENSE.txt index 5431ba98b9..8f3d856145 100644 --- a/lib/services/cognitiveServicesManagement/LICENSE.txt +++ b/lib/services/cognitiveServicesManagement/LICENSE.txt @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2018 Microsoft +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 diff --git a/lib/services/cognitiveServicesManagement/README.md b/lib/services/cognitiveServicesManagement/README.md index 3b8a88bab6..261bc6dbcf 100644 --- a/lib/services/cognitiveServicesManagement/README.md +++ b/lib/services/cognitiveServicesManagement/README.md @@ -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"); @@ -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) diff --git a/lib/services/cognitiveServicesManagement/lib/models/checkSkuAvailabilityParameter.js b/lib/services/cognitiveServicesManagement/lib/models/checkSkuAvailabilityParameter.js index 7c18c71894..9d60085294 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/checkSkuAvailabilityParameter.js +++ b/lib/services/cognitiveServicesManagement/lib/models/checkSkuAvailabilityParameter.js @@ -17,14 +17,9 @@ class CheckSkuAvailabilityParameter { /** * Create a CheckSkuAvailabilityParameter. - * @property {array} skus The SKU of the resource. - * @property {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 {array} skus The SKU of the resource. + * @member {string} kind The Kind of the resource. + * @member {string} type The Type of the resource. */ constructor() { } @@ -50,7 +45,7 @@ class CheckSkuAvailabilityParameter { name: 'Sequence', element: { required: false, - serializedName: 'SkuNameElementType', + serializedName: 'StringElementType', type: { name: 'String' } diff --git a/lib/services/cognitiveServicesManagement/lib/models/checkSkuAvailabilityResult.js b/lib/services/cognitiveServicesManagement/lib/models/checkSkuAvailabilityResult.js index 05b91081c6..9e73946f9a 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/checkSkuAvailabilityResult.js +++ b/lib/services/cognitiveServicesManagement/lib/models/checkSkuAvailabilityResult.js @@ -17,20 +17,13 @@ class CheckSkuAvailabilityResult { /** * Create a CheckSkuAvailabilityResult. - * @property {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} [kind] The Kind of the resource. + * @member {string} [type] The Type of the resource. + * @member {string} [skuName] The SKU of Cognitive Services account. + * @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() { } diff --git a/lib/services/cognitiveServicesManagement/lib/models/checkSkuAvailabilityResultList.js b/lib/services/cognitiveServicesManagement/lib/models/checkSkuAvailabilityResultList.js index 68a45f9b18..e333e39b9b 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/checkSkuAvailabilityResultList.js +++ b/lib/services/cognitiveServicesManagement/lib/models/checkSkuAvailabilityResultList.js @@ -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() { } diff --git a/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccount.js b/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccount.js index 99412c46b9..4fa88b9c77 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccount.js +++ b/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccount.js @@ -21,29 +21,30 @@ 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 - * 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} [endpoint] Endpoint of the created account. + * @member {string} [internalId] The internal identifier. + * @member {string} [customSubDomainName] Optional subdomain name used for + * token-based authentication. + * @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. + * @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(); @@ -122,6 +123,13 @@ class CognitiveServicesAccount extends models['BaseResource'] { name: 'String' } }, + customSubDomainName: { + required: false, + serializedName: 'properties.customSubDomainName', + type: { + name: 'String' + } + }, sku: { required: false, serializedName: 'sku', diff --git a/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountCreateParameters.js b/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountCreateParameters.js index f96fb106da..63b96a9249 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountCreateParameters.js +++ b/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountCreateParameters.js @@ -17,30 +17,23 @@ 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 - * 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 {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. + * @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. - * 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} kind Required. Gets or sets the Kind of the resource. + * @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() { diff --git a/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountEnumerateSkusResult.js b/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountEnumerateSkusResult.js index f1c3e73c44..591c93a783 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountEnumerateSkusResult.js +++ b/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountEnumerateSkusResult.js @@ -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() { diff --git a/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountKeys.js b/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountKeys.js index 7c96b04f96..d7259e4817 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountKeys.js +++ b/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountKeys.js @@ -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() { } diff --git a/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountListResult.js b/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountListResult.js index 6a93c52474..34391de9f5 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountListResult.js +++ b/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountListResult.js @@ -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() { diff --git a/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountUpdateParameters.js b/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountUpdateParameters.js index a016c4e8d2..5e4ee93344 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountUpdateParameters.js +++ b/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesAccountUpdateParameters.js @@ -17,13 +17,12 @@ 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 - * 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 {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. + * @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 diff --git a/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesResourceAndSku.js b/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesResourceAndSku.js index 34a5be8c5f..8ff3032c7c 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesResourceAndSku.js +++ b/lib/services/cognitiveServicesManagement/lib/models/cognitiveServicesResourceAndSku.js @@ -17,12 +17,11 @@ 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 - * 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} [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. + * @member {string} [sku.tier] Gets the sku tier. This is based on the SKU * name. Possible values include: 'Free', 'Standard', 'Premium' */ constructor() { diff --git a/lib/services/cognitiveServicesManagement/lib/models/errorBody.js b/lib/services/cognitiveServicesManagement/lib/models/errorBody.js index b05cc60eee..207a8ec98e 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/errorBody.js +++ b/lib/services/cognitiveServicesManagement/lib/models/errorBody.js @@ -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() { } diff --git a/lib/services/cognitiveServicesManagement/lib/models/errorModel.js b/lib/services/cognitiveServicesManagement/lib/models/errorModel.js index d326dde721..7a6335a40b 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/errorModel.js +++ b/lib/services/cognitiveServicesManagement/lib/models/errorModel.js @@ -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() { } diff --git a/lib/services/cognitiveServicesManagement/lib/models/index.d.ts b/lib/services/cognitiveServicesManagement/lib/models/index.d.ts index 8011123a4f..0f55268546 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/index.d.ts +++ b/lib/services/cognitiveServicesManagement/lib/models/index.d.ts @@ -22,10 +22,9 @@ export { CloudError } from 'ms-rest-azure'; * @constructor * The SKU of the cognitive services account. * - * @property {string} 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} [tier] Gets the sku tier. This is based on the SKU name. + * @member {string} name Gets or sets the sku name. Required for account + * creation, optional for update. + * @member {string} [tier] Gets the sku tier. This is based on the SKU name. * Possible values include: 'Free', 'Standard', 'Premium' */ export interface Sku { @@ -39,30 +38,23 @@ export interface Sku { * @constructor * The parameters to provide for the account. * - * @property {object} sku Required. Gets or sets the SKU of the resource. - * @property {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 {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. + * @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. - * 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} kind Required. Gets or sets the Kind of the resource. + * @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 - * 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} [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. + * @member {object} properties Must exist in the request. Must be an empty * object. Must not be null. */ export interface CognitiveServicesAccountCreateParameters { @@ -79,17 +71,16 @@ export interface CognitiveServicesAccountCreateParameters { * @constructor * The parameters to provide for the account. * - * @property {object} [sku] Gets or sets the SKU of the resource. - * @property {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 {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. + * @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 - * 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. + * @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. */ export interface CognitiveServicesAccountUpdateParameters { sku?: Sku; @@ -103,29 +94,30 @@ export interface CognitiveServicesAccountUpdateParameters { * Cognitive Services Account is an Azure resource representing the provisioned * account, its type, location and SKU. * - * @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 - * 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} [endpoint] Endpoint of the created account. + * @member {string} [internalId] The internal identifier. + * @member {string} [customSubDomainName] Optional subdomain name used for + * token-based authentication. + * @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. + * @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 - * 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 {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. + * @member {string} [type] Resource type */ export interface CognitiveServicesAccount extends BaseResource { etag?: string; @@ -136,6 +128,7 @@ export interface CognitiveServicesAccount extends BaseResource { readonly provisioningState?: string; endpoint?: string; internalId?: string; + customSubDomainName?: string; sku?: Sku; tags?: { [propertyName: string]: string }; readonly type?: string; @@ -147,8 +140,8 @@ export interface CognitiveServicesAccount extends BaseResource { * @constructor * The access keys for the cognitive services account. * - * @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. */ export interface CognitiveServicesAccountKeys { key1?: string; @@ -161,7 +154,7 @@ export interface CognitiveServicesAccountKeys { * @constructor * Regenerate key parameters. * - * @property {string} keyName key name to generate (Key1|Key2). Possible values + * @member {string} keyName key name to generate (Key1|Key2). Possible values * include: 'Key1', 'Key2' */ export interface RegenerateKeyParameters { @@ -174,12 +167,11 @@ export interface RegenerateKeyParameters { * @constructor * Cognitive Services resource type and SKU. * - * @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 - * 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} [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. + * @member {string} [sku.tier] Gets the sku tier. This is based on the SKU * name. Possible values include: 'Free', 'Standard', 'Premium' */ export interface CognitiveServicesResourceAndSku { @@ -193,7 +185,7 @@ export interface CognitiveServicesResourceAndSku { * @constructor * The list of cognitive services accounts operation response. * - * @property {array} [value] Gets the list of Cognitive Services accounts and + * @member {array} [value] Gets the list of Cognitive Services accounts and * their properties. */ export interface CognitiveServicesAccountEnumerateSkusResult { @@ -206,8 +198,8 @@ export interface CognitiveServicesAccountEnumerateSkusResult { * @constructor * A metric name. * - * @property {string} [value] The name of the metric. - * @property {string} [localizedValue] The friendly name of the metric. + * @member {string} [value] The name of the metric. + * @member {string} [localizedValue] The friendly name of the metric. */ export interface MetricName { readonly value?: string; @@ -220,18 +212,18 @@ export interface MetricName { * @constructor * The usage data for a usage request. * - * @property {string} [unit] The unit of the metric. Possible values include: + * @member {string} [unit] The unit of the metric. Possible values include: * 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond', * 'Milliseconds' - * @property {object} [name] The name information for the metric. - * @property {string} [name.value] The name of the metric. - * @property {string} [name.localizedValue] The friendly name of the metric. - * @property {string} [quotaPeriod] The quota period used to summarize the - * usage values. - * @property {number} [limit] Maximum value for this metric. - * @property {number} [currentValue] Current value for this metric. - * @property {string} [nextResetTime] Next reset time for current quota. - * @property {string} [status] Cognitive Services account quota usage status. + * @member {object} [name] The name information for the metric. + * @member {string} [name.value] The name of the metric. + * @member {string} [name.localizedValue] The friendly name of the metric. + * @member {string} [quotaPeriod] The quota period used to summarize the usage + * values. + * @member {number} [limit] Maximum value for this metric. + * @member {number} [currentValue] Current value for this metric. + * @member {string} [nextResetTime] Next reset time for current quota. + * @member {string} [status] Cognitive Services account quota usage status. * Possible values include: 'Included', 'Blocked', 'InOverage', 'Unknown' */ export interface Usage { @@ -250,7 +242,7 @@ export interface Usage { * @constructor * The response to a list usage request. * - * @property {array} [value] The list of usages for Cognitive Service account. + * @member {array} [value] The list of usages for Cognitive Service account. */ export interface UsagesResult { readonly value?: Usage[]; @@ -262,8 +254,8 @@ export interface UsagesResult { * @constructor * Cognitive Services error body. * - * @property {string} code error code - * @property {string} message error message + * @member {string} code error code + * @member {string} message error message */ export interface ErrorBody { code: string; @@ -276,9 +268,9 @@ export interface ErrorBody { * @constructor * Cognitive Services error object. * - * @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 */ export interface ErrorModel { error?: ErrorBody; @@ -290,12 +282,11 @@ export interface ErrorModel { * @constructor * The operation supported by Cognitive Services. * - * @property {string} [description] The description of the operation. - * @property {string} [operation] The action that users can perform, based on + * @member {string} [description] The description of the operation. + * @member {string} [operation] The action that users can perform, based on * their permission level. - * @property {string} [provider] Service provider: Microsoft Cognitive - * Services. - * @property {string} [resource] Resource on which the operation is performed. + * @member {string} [provider] Service provider: Microsoft Cognitive Services. + * @member {string} [resource] Resource on which the operation is performed. */ export interface OperationDisplayInfo { description?: string; @@ -310,17 +301,17 @@ export interface OperationDisplayInfo { * @constructor * The operation supported by Cognitive Services. * - * @property {string} [name] Operation name: {provider}/{resource}/{operation}. - * @property {object} [display] The operation supported by Cognitive Services. - * @property {string} [display.description] The description of the operation. - * @property {string} [display.operation] The action that users can perform, + * @member {string} [name] Operation name: {provider}/{resource}/{operation}. + * @member {object} [display] The operation supported by Cognitive Services. + * @member {string} [display.description] The description of the operation. + * @member {string} [display.operation] The action that users can perform, * based on their permission level. - * @property {string} [display.provider] Service provider: Microsoft Cognitive + * @member {string} [display.provider] Service provider: Microsoft Cognitive * Services. - * @property {string} [display.resource] Resource on which the operation is + * @member {string} [display.resource] Resource on which the operation is * performed. - * @property {string} [origin] The origin of the operation. - * @property {object} [properties] Additional properties. + * @member {string} [origin] The origin of the operation. + * @member {object} [properties] Additional properties. */ export interface OperationEntity { name?: string; @@ -335,14 +326,9 @@ export interface OperationEntity { * @constructor * Check SKU availability parameter. * - * @property {array} skus The SKU of the resource. - * @property {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 {array} skus The SKU of the resource. + * @member {string} kind The Kind of the resource. + * @member {string} type The Type of the resource. */ export interface CheckSkuAvailabilityParameter { skus: string[]; @@ -356,20 +342,13 @@ export interface CheckSkuAvailabilityParameter { * @constructor * Check SKU availability result. * - * @property {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} [kind] The Kind of the resource. + * @member {string} [type] The Type of the resource. + * @member {string} [skuName] The SKU of Cognitive Services account. + * @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. */ export interface CheckSkuAvailabilityResult { kind?: string; @@ -386,7 +365,7 @@ export interface CheckSkuAvailabilityResult { * @constructor * Check SKU availability result list. * - * @property {array} [value] Check SKU availability result list. + * @member {array} [value] Check SKU availability result list. */ export interface CheckSkuAvailabilityResultList { value?: CheckSkuAvailabilityResult[]; @@ -396,8 +375,8 @@ export interface CheckSkuAvailabilityResultList { * @class * Initializes a new instance of the ResourceSkuRestrictionInfo class. * @constructor - * @property {array} [locations] Locations where the SKU is restricted - * @property {array} [zones] List of availability zones where the SKU is + * @member {array} [locations] Locations where the SKU is restricted + * @member {array} [zones] List of availability zones where the SKU is * restricted. */ export interface ResourceSkuRestrictionInfo { @@ -411,18 +390,18 @@ export interface ResourceSkuRestrictionInfo { * @constructor * Describes restrictions of a SKU. * - * @property {string} [type] The type of restrictions. Possible values include: + * @member {string} [type] The type of restrictions. Possible values include: * 'Location', 'Zone' - * @property {array} [values] The value of restrictions. If the restriction - * type is set to location. This would be different locations where the SKU is + * @member {array} [values] The value of restrictions. If the restriction type + * is set to location. This would be different locations where the SKU is * restricted. - * @property {object} [restrictionInfo] The information about the restriction + * @member {object} [restrictionInfo] The information about the restriction * where the SKU cannot be used. - * @property {array} [restrictionInfo.locations] Locations where the SKU is + * @member {array} [restrictionInfo.locations] Locations where the SKU is * restricted - * @property {array} [restrictionInfo.zones] List of availability zones where - * the SKU is restricted. - * @property {string} [reasonCode] The reason for restriction. Possible values + * @member {array} [restrictionInfo.zones] List of availability zones where the + * SKU is restricted. + * @member {string} [reasonCode] The reason for restriction. Possible values * include: 'QuotaId', 'NotAvailableForSubscription' */ export interface ResourceSkuRestrictions { @@ -438,15 +417,14 @@ export interface ResourceSkuRestrictions { * @constructor * Describes an available Cognitive Services SKU. * - * @property {string} [resourceType] The type of resource the SKU applies to. - * @property {string} [name] The name of SKU. - * @property {string} [tier] Specifies the tier of Cognitive Services account. - * @property {string} [kind] The Kind of resources that are supported in this + * @member {string} [resourceType] The type of resource the SKU applies to. + * @member {string} [name] The name of SKU. + * @member {string} [tier] Specifies the tier of Cognitive Services account. + * @member {string} [kind] The Kind of resources that are supported in this * SKU. - * @property {array} [locations] The set of locations that the SKU is - * available. - * @property {array} [restrictions] The restrictions because of which SKU - * cannot be used. This is empty if there are no restrictions. + * @member {array} [locations] The set of locations that the SKU is available. + * @member {array} [restrictions] The restrictions because of which SKU cannot + * be used. This is empty if there are no restrictions. */ export interface ResourceSku { readonly resourceType?: string; @@ -464,8 +442,7 @@ export interface ResourceSku { * @constructor * The list of cognitive services accounts operation response. * - * @property {string} [nextLink] The link used to get the next page of - * accounts. + * @member {string} [nextLink] The link used to get the next page of accounts. */ export interface CognitiveServicesAccountListResult extends Array { nextLink?: string; @@ -477,7 +454,7 @@ export interface CognitiveServicesAccountListResult extends Array { nextLink?: string; @@ -489,7 +466,7 @@ export interface ResourceSkusResult extends Array { * @constructor * The list of cognitive services accounts operation response. * - * @property {string} [nextLink] The link used to get the next page of + * @member {string} [nextLink] The link used to get the next page of * operations. */ export interface OperationEntityListResult extends Array { diff --git a/lib/services/cognitiveServicesManagement/lib/models/metricName.js b/lib/services/cognitiveServicesManagement/lib/models/metricName.js index 067ad9a71b..03b48f02a4 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/metricName.js +++ b/lib/services/cognitiveServicesManagement/lib/models/metricName.js @@ -17,8 +17,8 @@ class MetricName { /** * Create a MetricName. - * @property {string} [value] The name of the metric. - * @property {string} [localizedValue] The friendly name of the metric. + * @member {string} [value] The name of the metric. + * @member {string} [localizedValue] The friendly name of the metric. */ constructor() { } diff --git a/lib/services/cognitiveServicesManagement/lib/models/operationDisplayInfo.js b/lib/services/cognitiveServicesManagement/lib/models/operationDisplayInfo.js index 3a668b4249..e842b06d53 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/operationDisplayInfo.js +++ b/lib/services/cognitiveServicesManagement/lib/models/operationDisplayInfo.js @@ -17,13 +17,12 @@ class OperationDisplayInfo { /** * Create a OperationDisplayInfo. - * @property {string} [description] The description of the operation. - * @property {string} [operation] The action that users can perform, based on + * @member {string} [description] The description of the operation. + * @member {string} [operation] The action that users can perform, based on * their permission level. - * @property {string} [provider] Service provider: Microsoft Cognitive + * @member {string} [provider] Service provider: Microsoft Cognitive * Services. - * @property {string} [resource] Resource on which the operation is - * performed. + * @member {string} [resource] Resource on which the operation is performed. */ constructor() { } diff --git a/lib/services/cognitiveServicesManagement/lib/models/operationEntity.js b/lib/services/cognitiveServicesManagement/lib/models/operationEntity.js index 562ccb5a4e..094f95def8 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/operationEntity.js +++ b/lib/services/cognitiveServicesManagement/lib/models/operationEntity.js @@ -17,19 +17,17 @@ class OperationEntity { /** * Create a OperationEntity. - * @property {string} [name] Operation name: - * {provider}/{resource}/{operation}. - * @property {object} [display] The operation supported by Cognitive - * Services. - * @property {string} [display.description] The description of the operation. - * @property {string} [display.operation] The action that users can perform, + * @member {string} [name] Operation name: {provider}/{resource}/{operation}. + * @member {object} [display] The operation supported by Cognitive Services. + * @member {string} [display.description] The description of the operation. + * @member {string} [display.operation] The action that users can perform, * based on their permission level. - * @property {string} [display.provider] Service provider: Microsoft - * Cognitive Services. - * @property {string} [display.resource] Resource on which the operation is + * @member {string} [display.provider] Service provider: Microsoft Cognitive + * Services. + * @member {string} [display.resource] Resource on which the operation is * performed. - * @property {string} [origin] The origin of the operation. - * @property {object} [properties] Additional properties. + * @member {string} [origin] The origin of the operation. + * @member {object} [properties] Additional properties. */ constructor() { } diff --git a/lib/services/cognitiveServicesManagement/lib/models/operationEntityListResult.js b/lib/services/cognitiveServicesManagement/lib/models/operationEntityListResult.js index a007c62ca8..6a62f1306f 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/operationEntityListResult.js +++ b/lib/services/cognitiveServicesManagement/lib/models/operationEntityListResult.js @@ -16,7 +16,7 @@ class OperationEntityListResult extends Array { /** * Create a OperationEntityListResult. - * @property {string} [nextLink] The link used to get the next page of + * @member {string} [nextLink] The link used to get the next page of * operations. */ constructor() { diff --git a/lib/services/cognitiveServicesManagement/lib/models/regenerateKeyParameters.js b/lib/services/cognitiveServicesManagement/lib/models/regenerateKeyParameters.js index 6310e35ddb..b4e7b06a35 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/regenerateKeyParameters.js +++ b/lib/services/cognitiveServicesManagement/lib/models/regenerateKeyParameters.js @@ -17,8 +17,8 @@ class RegenerateKeyParameters { /** * Create a RegenerateKeyParameters. - * @property {string} keyName key name to generate (Key1|Key2). Possible - * values include: 'Key1', 'Key2' + * @member {string} keyName key name to generate (Key1|Key2). Possible values + * include: 'Key1', 'Key2' */ constructor() { } diff --git a/lib/services/cognitiveServicesManagement/lib/models/resourceSku.js b/lib/services/cognitiveServicesManagement/lib/models/resourceSku.js index 84d8d6c26a..5393f6e1fa 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/resourceSku.js +++ b/lib/services/cognitiveServicesManagement/lib/models/resourceSku.js @@ -17,15 +17,14 @@ class ResourceSku { /** * Create a ResourceSku. - * @property {string} [resourceType] The type of resource the SKU applies to. - * @property {string} [name] The name of SKU. - * @property {string} [tier] Specifies the tier of Cognitive Services - * account. - * @property {string} [kind] The Kind of resources that are supported in this + * @member {string} [resourceType] The type of resource the SKU applies to. + * @member {string} [name] The name of SKU. + * @member {string} [tier] Specifies the tier of Cognitive Services account. + * @member {string} [kind] The Kind of resources that are supported in this * SKU. - * @property {array} [locations] The set of locations that the SKU is + * @member {array} [locations] The set of locations that the SKU is * available. - * @property {array} [restrictions] The restrictions because of which SKU + * @member {array} [restrictions] The restrictions because of which SKU * cannot be used. This is empty if there are no restrictions. */ constructor() { diff --git a/lib/services/cognitiveServicesManagement/lib/models/resourceSkuRestrictionInfo.js b/lib/services/cognitiveServicesManagement/lib/models/resourceSkuRestrictionInfo.js index 5d2bffb60c..9772ff3185 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/resourceSkuRestrictionInfo.js +++ b/lib/services/cognitiveServicesManagement/lib/models/resourceSkuRestrictionInfo.js @@ -16,8 +16,8 @@ class ResourceSkuRestrictionInfo { /** * Create a ResourceSkuRestrictionInfo. - * @property {array} [locations] Locations where the SKU is restricted - * @property {array} [zones] List of availability zones where the SKU is + * @member {array} [locations] Locations where the SKU is restricted + * @member {array} [zones] List of availability zones where the SKU is * restricted. */ constructor() { diff --git a/lib/services/cognitiveServicesManagement/lib/models/resourceSkuRestrictions.js b/lib/services/cognitiveServicesManagement/lib/models/resourceSkuRestrictions.js index 2001dad0d8..cc185ce659 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/resourceSkuRestrictions.js +++ b/lib/services/cognitiveServicesManagement/lib/models/resourceSkuRestrictions.js @@ -17,19 +17,19 @@ class ResourceSkuRestrictions { /** * Create a ResourceSkuRestrictions. - * @property {string} [type] The type of restrictions. Possible values - * include: 'Location', 'Zone' - * @property {array} [values] The value of restrictions. If the restriction + * @member {string} [type] The type of restrictions. Possible values include: + * 'Location', 'Zone' + * @member {array} [values] The value of restrictions. If the restriction * type is set to location. This would be different locations where the SKU * is restricted. - * @property {object} [restrictionInfo] The information about the restriction + * @member {object} [restrictionInfo] The information about the restriction * where the SKU cannot be used. - * @property {array} [restrictionInfo.locations] Locations where the SKU is + * @member {array} [restrictionInfo.locations] Locations where the SKU is * restricted - * @property {array} [restrictionInfo.zones] List of availability zones where + * @member {array} [restrictionInfo.zones] List of availability zones where * the SKU is restricted. - * @property {string} [reasonCode] The reason for restriction. Possible - * values include: 'QuotaId', 'NotAvailableForSubscription' + * @member {string} [reasonCode] The reason for restriction. Possible values + * include: 'QuotaId', 'NotAvailableForSubscription' */ constructor() { } diff --git a/lib/services/cognitiveServicesManagement/lib/models/resourceSkusResult.js b/lib/services/cognitiveServicesManagement/lib/models/resourceSkusResult.js index 9405fa7414..15219c5a14 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/resourceSkusResult.js +++ b/lib/services/cognitiveServicesManagement/lib/models/resourceSkusResult.js @@ -16,7 +16,7 @@ class ResourceSkusResult extends Array { /** * Create a ResourceSkusResult. - * @property {string} [nextLink] The uri to fetch the next page of Skus. + * @member {string} [nextLink] The uri to fetch the next page of Skus. */ constructor() { super(); diff --git a/lib/services/cognitiveServicesManagement/lib/models/sku.js b/lib/services/cognitiveServicesManagement/lib/models/sku.js index 2444cee111..d4d49f49c3 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/sku.js +++ b/lib/services/cognitiveServicesManagement/lib/models/sku.js @@ -17,11 +17,10 @@ class Sku { /** * Create a Sku. - * @property {string} 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} [tier] Gets the sku tier. This is based on the SKU - * name. Possible values include: 'Free', 'Standard', 'Premium' + * @member {string} name Gets or sets the sku name. Required for account + * creation, optional for update. + * @member {string} [tier] Gets the sku tier. This is based on the SKU name. + * Possible values include: 'Free', 'Standard', 'Premium' */ constructor() { } diff --git a/lib/services/cognitiveServicesManagement/lib/models/usage.js b/lib/services/cognitiveServicesManagement/lib/models/usage.js index adc2966451..5cc262f172 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/usage.js +++ b/lib/services/cognitiveServicesManagement/lib/models/usage.js @@ -17,18 +17,18 @@ class Usage { /** * Create a Usage. - * @property {string} [unit] The unit of the metric. Possible values include: + * @member {string} [unit] The unit of the metric. Possible values include: * 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', * 'BytesPerSecond', 'Milliseconds' - * @property {object} [name] The name information for the metric. - * @property {string} [name.value] The name of the metric. - * @property {string} [name.localizedValue] The friendly name of the metric. - * @property {string} [quotaPeriod] The quota period used to summarize the + * @member {object} [name] The name information for the metric. + * @member {string} [name.value] The name of the metric. + * @member {string} [name.localizedValue] The friendly name of the metric. + * @member {string} [quotaPeriod] The quota period used to summarize the * usage values. - * @property {number} [limit] Maximum value for this metric. - * @property {number} [currentValue] Current value for this metric. - * @property {string} [nextResetTime] Next reset time for current quota. - * @property {string} [status] Cognitive Services account quota usage status. + * @member {number} [limit] Maximum value for this metric. + * @member {number} [currentValue] Current value for this metric. + * @member {string} [nextResetTime] Next reset time for current quota. + * @member {string} [status] Cognitive Services account quota usage status. * Possible values include: 'Included', 'Blocked', 'InOverage', 'Unknown' */ constructor() { diff --git a/lib/services/cognitiveServicesManagement/lib/models/usagesResult.js b/lib/services/cognitiveServicesManagement/lib/models/usagesResult.js index 5c1a3868ac..df5c435f14 100644 --- a/lib/services/cognitiveServicesManagement/lib/models/usagesResult.js +++ b/lib/services/cognitiveServicesManagement/lib/models/usagesResult.js @@ -17,8 +17,7 @@ class UsagesResult { /** * Create a UsagesResult. - * @property {array} [value] The list of usages for Cognitive Service - * account. + * @member {array} [value] The list of usages for Cognitive Service account. */ constructor() { } diff --git a/lib/services/cognitiveServicesManagement/lib/operations/accounts.js b/lib/services/cognitiveServicesManagement/lib/operations/accounts.js index bb97a65ff5..ec73eeb299 100644 --- a/lib/services/cognitiveServicesManagement/lib/operations/accounts.js +++ b/lib/services/cognitiveServicesManagement/lib/operations/accounts.js @@ -31,16 +31,10 @@ const WebResource = msRest.WebResource; * resource. * * @param {string} parameters.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' + * account creation, optional for update. * * @param {string} parameters.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' + * resource. * * @param {string} parameters.location Required. Gets or sets the location of * the resource. This will be one of the supported and registered Azure Geo @@ -258,8 +252,7 @@ function _create(resourceGroupName, accountName, parameters, options, callback) * @param {object} [options.sku] Gets or sets the SKU of the resource. * * @param {string} options.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' + * account creation, optional for update. * * @param {object} [options.tags] Gets or sets a list of key value pairs that * describe the resource. These tags can be used in viewing and grouping this @@ -2016,16 +2009,10 @@ class Accounts { * resource. * * @param {string} parameters.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' + * account creation, optional for update. * * @param {string} parameters.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' + * resource. * * @param {string} parameters.location Required. Gets or sets the location of * the resource. This will be one of the supported and registered Azure Geo @@ -2084,16 +2071,10 @@ class Accounts { * resource. * * @param {string} parameters.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' + * account creation, optional for update. * * @param {string} parameters.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' + * resource. * * @param {string} parameters.location Required. Gets or sets the location of * the resource. This will be one of the supported and registered Azure Geo @@ -2171,8 +2152,7 @@ class Accounts { * @param {object} [options.sku] Gets or sets the SKU of the resource. * * @param {string} options.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' + * account creation, optional for update. * * @param {object} [options.tags] Gets or sets a list of key value pairs that * describe the resource. These tags can be used in viewing and grouping this @@ -2216,8 +2196,7 @@ class Accounts { * @param {object} [options.sku] Gets or sets the SKU of the resource. * * @param {string} options.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' + * account creation, optional for update. * * @param {object} [options.tags] Gets or sets a list of key value pairs that * describe the resource. These tags can be used in viewing and grouping this diff --git a/lib/services/cognitiveServicesManagement/lib/operations/checkSkuAvailability.js b/lib/services/cognitiveServicesManagement/lib/operations/checkSkuAvailability.js index c4104ec0e5..d7e8e92b09 100644 --- a/lib/services/cognitiveServicesManagement/lib/operations/checkSkuAvailability.js +++ b/lib/services/cognitiveServicesManagement/lib/operations/checkSkuAvailability.js @@ -21,12 +21,7 @@ const WebResource = msRest.WebResource; * * @param {array} skus The SKU of the resource. * - * @param {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' + * @param {string} kind The Kind of the resource. * * @param {string} type The Type of the resource. * @@ -218,12 +213,7 @@ class CheckSkuAvailability { * * @param {array} skus The SKU of the resource. * - * @param {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' + * @param {string} kind The Kind of the resource. * * @param {string} type The Type of the resource. * @@ -259,12 +249,7 @@ class CheckSkuAvailability { * * @param {array} skus The SKU of the resource. * - * @param {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' + * @param {string} kind The Kind of the resource. * * @param {string} type The Type of the resource. * diff --git a/lib/services/cognitiveServicesManagement/lib/operations/index.d.ts b/lib/services/cognitiveServicesManagement/lib/operations/index.d.ts index efb24cca8c..93833d8469 100644 --- a/lib/services/cognitiveServicesManagement/lib/operations/index.d.ts +++ b/lib/services/cognitiveServicesManagement/lib/operations/index.d.ts @@ -38,16 +38,10 @@ export interface Accounts { * resource. * * @param {string} parameters.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' + * account creation, optional for update. * * @param {string} parameters.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' + * resource. * * @param {string} parameters.location Required. Gets or sets the location of * the resource. This will be one of the supported and registered Azure Geo @@ -94,16 +88,10 @@ export interface Accounts { * resource. * * @param {string} parameters.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' + * account creation, optional for update. * * @param {string} parameters.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' + * resource. * * @param {string} parameters.location Required. Gets or sets the location of * the resource. This will be one of the supported and registered Azure Geo @@ -166,8 +154,7 @@ export interface Accounts { * @param {object} [options.sku] Gets or sets the SKU of the resource. * * @param {string} options.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' + * account creation, optional for update. * * @param {object} [options.tags] Gets or sets a list of key value pairs that * describe the resource. These tags can be used in viewing and grouping this @@ -199,8 +186,7 @@ export interface Accounts { * @param {object} [options.sku] Gets or sets the SKU of the resource. * * @param {string} options.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' + * account creation, optional for update. * * @param {object} [options.tags] Gets or sets a list of key value pairs that * describe the resource. These tags can be used in viewing and grouping this @@ -1106,12 +1092,7 @@ export interface CheckSkuAvailability { * * @param {array} skus The SKU of the resource. * - * @param {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' + * @param {string} kind The Kind of the resource. * * @param {string} type The Type of the resource. * @@ -1135,12 +1116,7 @@ export interface CheckSkuAvailability { * * @param {array} skus The SKU of the resource. * - * @param {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' + * @param {string} kind The Kind of the resource. * * @param {string} type The Type of the resource. *