diff --git a/lib/services/operationalInsightsManagement/README.md b/lib/services/operationalInsightsManagement/README.md index 9a049da4df..5c340f28c9 100644 --- a/lib/services/operationalInsightsManagement/README.md +++ b/lib/services/operationalInsightsManagement/README.md @@ -3,22 +3,23 @@ uid: azure-arm-operationalinsights summary: *content --- -# Microsoft Azure SDK for Node.js - OperationalInsightsManagementClient +**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 - OperationalInsightsManagementClient 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-operationalinsights ``` -## How to use +### How to use -### Authentication, client creation and get linkedServices as an example. +#### Authentication, client creation and get linkedServices as an example. ```javascript const msRestAzure = require("ms-rest-azure"); @@ -38,6 +39,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/operationalInsightsManagement/lib/models/dataSource.js b/lib/services/operationalInsightsManagement/lib/models/dataSource.js index 73f4e3ba49..11368daef5 100644 --- a/lib/services/operationalInsightsManagement/lib/models/dataSource.js +++ b/lib/services/operationalInsightsManagement/lib/models/dataSource.js @@ -20,10 +20,10 @@ const models = require('./index'); class DataSource extends models['BaseResource'] { /** * Create a DataSource. - * @member {object} properties The data source properties in raw json format, - * each kind of data source have it's own schema. - * @member {string} [eTag] The ETag of the data source. - * @member {string} kind Possible values include: 'AzureActivityLog', + * @property {object} properties The data source properties in raw json + * format, each kind of data source have it's own schema. + * @property {string} [eTag] The ETag of the data source. + * @property {string} kind Possible values include: 'AzureActivityLog', * 'ChangeTrackingPath', 'ChangeTrackingDefaultPath', * 'ChangeTrackingDefaultRegistry', 'ChangeTrackingCustomRegistry', * 'CustomLog', 'CustomLogCollection', 'GenericDataSource', 'IISLogs', diff --git a/lib/services/operationalInsightsManagement/lib/models/dataSourceFilter.js b/lib/services/operationalInsightsManagement/lib/models/dataSourceFilter.js index 5c552ab489..6bfe181638 100644 --- a/lib/services/operationalInsightsManagement/lib/models/dataSourceFilter.js +++ b/lib/services/operationalInsightsManagement/lib/models/dataSourceFilter.js @@ -17,7 +17,7 @@ class DataSourceFilter { /** * Create a DataSourceFilter. - * @member {string} [kind] Possible values include: 'AzureActivityLog', + * @property {string} [kind] Possible values include: 'AzureActivityLog', * 'ChangeTrackingPath', 'ChangeTrackingDefaultPath', * 'ChangeTrackingDefaultRegistry', 'ChangeTrackingCustomRegistry', * 'CustomLog', 'CustomLogCollection', 'GenericDataSource', 'IISLogs', diff --git a/lib/services/operationalInsightsManagement/lib/models/dataSourceListResult.js b/lib/services/operationalInsightsManagement/lib/models/dataSourceListResult.js index 9d95a332ee..132512cf07 100644 --- a/lib/services/operationalInsightsManagement/lib/models/dataSourceListResult.js +++ b/lib/services/operationalInsightsManagement/lib/models/dataSourceListResult.js @@ -16,7 +16,7 @@ class DataSourceListResult extends Array { /** * Create a DataSourceListResult. - * @member {string} [nextLink] The link (url) to the next page of + * @property {string} [nextLink] The link (url) to the next page of * datasources. */ constructor() { diff --git a/lib/services/operationalInsightsManagement/lib/models/index.d.ts b/lib/services/operationalInsightsManagement/lib/models/index.d.ts index 84a69a0222..4e19bf5118 100644 --- a/lib/services/operationalInsightsManagement/lib/models/index.d.ts +++ b/lib/services/operationalInsightsManagement/lib/models/index.d.ts @@ -22,11 +22,11 @@ export { CloudError } from 'ms-rest-azure'; * @constructor * Display metadata associated with the operation. * - * @member {string} [provider] Service provider: Microsoft + * @property {string} [provider] Service provider: Microsoft * OperationsManagement. - * @member {string} [resource] Resource on which the operation is performed + * @property {string} [resource] Resource on which the operation is performed * etc. - * @member {string} [operation] Type of operation: get, read, delete, etc. + * @property {string} [operation] Type of operation: get, read, delete, etc. */ export interface OperationDisplay { provider?: string; @@ -40,13 +40,13 @@ export interface OperationDisplay { * @constructor * Supported operation of OperationalInsights resource provider. * - * @member {string} [name] Operation name: {provider}/{resource}/{operation} - * @member {object} [display] Display metadata associated with the operation. - * @member {string} [display.provider] Service provider: Microsoft + * @property {string} [name] Operation name: {provider}/{resource}/{operation} + * @property {object} [display] Display metadata associated with the operation. + * @property {string} [display.provider] Service provider: Microsoft * OperationsManagement. - * @member {string} [display.resource] Resource on which the operation is + * @property {string} [display.resource] Resource on which the operation is * performed etc. - * @member {string} [display.operation] Type of operation: get, read, delete, + * @property {string} [display.operation] Type of operation: get, read, delete, * etc. */ export interface Operation { @@ -60,7 +60,7 @@ export interface Operation { * @constructor * The top level Linked service resource container. * - * @member {string} resourceId The resource id of the resource that will be + * @property {string} resourceId The resource id of the resource that will be * linked to the workspace. */ export interface LinkedService extends BaseResource { @@ -73,10 +73,10 @@ export interface LinkedService extends BaseResource { * @constructor * Datasources under OMS Workspace. * - * @member {object} properties The data source properties in raw json format, + * @property {object} properties The data source properties in raw json format, * each kind of data source have it's own schema. - * @member {string} [eTag] The ETag of the data source. - * @member {string} kind Possible values include: 'AzureActivityLog', + * @property {string} [eTag] The ETag of the data source. + * @property {string} kind Possible values include: 'AzureActivityLog', * 'ChangeTrackingPath', 'ChangeTrackingDefaultPath', * 'ChangeTrackingDefaultRegistry', 'ChangeTrackingCustomRegistry', * 'CustomLog', 'CustomLogCollection', 'GenericDataSource', 'IISLogs', @@ -95,7 +95,7 @@ export interface DataSource extends BaseResource { * @constructor * DataSource filter. Right now, only filter by kind is supported. * - * @member {string} [kind] Possible values include: 'AzureActivityLog', + * @property {string} [kind] Possible values include: 'AzureActivityLog', * 'ChangeTrackingPath', 'ChangeTrackingDefaultPath', * 'ChangeTrackingDefaultRegistry', 'ChangeTrackingCustomRegistry', * 'CustomLog', 'CustomLogCollection', 'GenericDataSource', 'IISLogs', @@ -113,9 +113,9 @@ export interface DataSourceFilter { * Intelligence Pack containing a string name and boolean indicating if it's * enabled. * - * @member {string} [name] The name of the intelligence pack. - * @member {boolean} [enabled] The enabled boolean for the intelligence pack. - * @member {string} [displayName] The display name of the intelligence pack. + * @property {string} [name] The name of the intelligence pack. + * @property {boolean} [enabled] The enabled boolean for the intelligence pack. + * @property {string} [displayName] The display name of the intelligence pack. */ export interface IntelligencePack { name?: string; @@ -129,8 +129,8 @@ export interface IntelligencePack { * @constructor * The shared keys for a workspace. * - * @member {string} [primarySharedKey] The primary shared key of a workspace. - * @member {string} [secondarySharedKey] The secondary shared key of a + * @property {string} [primarySharedKey] The primary shared key of a workspace. + * @property {string} [secondarySharedKey] The secondary shared key of a * workspace. */ export interface SharedKeys { @@ -144,8 +144,8 @@ export interface SharedKeys { * @constructor * The name of a metric. * - * @member {string} [value] The system name of the metric. - * @member {string} [localizedValue] The localized name of the metric. + * @property {string} [value] The system name of the metric. + * @property {string} [localizedValue] The localized name of the metric. */ export interface MetricName { value?: string; @@ -158,14 +158,15 @@ export interface MetricName { * @constructor * A metric describing the usage of a resource. * - * @member {object} [name] The name of the metric. - * @member {string} [name.value] The system name of the metric. - * @member {string} [name.localizedValue] The localized name of the metric. - * @member {string} [unit] The units used for the metric. - * @member {number} [currentValue] The current value of the metric. - * @member {number} [limit] The quota limit for the metric. - * @member {date} [nextResetTime] The time that the metric's value will reset. - * @member {string} [quotaPeriod] The quota period that determines the length + * @property {object} [name] The name of the metric. + * @property {string} [name.value] The system name of the metric. + * @property {string} [name.localizedValue] The localized name of the metric. + * @property {string} [unit] The units used for the metric. + * @property {number} [currentValue] The current value of the metric. + * @property {number} [limit] The quota limit for the metric. + * @property {date} [nextResetTime] The time that the metric's value will + * reset. + * @property {string} [quotaPeriod] The quota period that determines the length * of time between value resets. */ export interface UsageMetric { @@ -183,18 +184,19 @@ export interface UsageMetric { * @constructor * A management group that is connected to a workspace * - * @member {number} [serverCount] The number of servers connected to the + * @property {number} [serverCount] The number of servers connected to the * management group. - * @member {boolean} [isGateway] Gets or sets a value indicating whether the + * @property {boolean} [isGateway] Gets or sets a value indicating whether the * management group is a gateway. - * @member {string} [name] The name of the management group. - * @member {string} [id] The unique ID of the management group. - * @member {date} [created] The datetime that the management group was created. - * @member {date} [dataReceived] The last datetime that the management group + * @property {string} [name] The name of the management group. + * @property {string} [id] The unique ID of the management group. + * @property {date} [created] The datetime that the management group was + * created. + * @property {date} [dataReceived] The last datetime that the management group * received data. - * @member {string} [version] The version of System Center that is managing the - * management group. - * @member {string} [sku] The SKU of System Center that is managing the + * @property {string} [version] The version of System Center that is managing + * the management group. + * @property {string} [sku] The SKU of System Center that is managing the * management group. */ export interface ManagementGroup { @@ -214,8 +216,9 @@ export interface ManagementGroup { * @constructor * The SKU (tier) of a workspace. * - * @member {string} name The name of the SKU. Possible values include: 'Free', - * 'Standard', 'Premium', 'Unlimited', 'PerNode', 'PerGB2018', 'Standalone' + * @property {string} name The name of the SKU. Possible values include: + * 'Free', 'Standard', 'Premium', 'Unlimited', 'PerNode', 'PerGB2018', + * 'Standalone' */ export interface Sku { name: string; @@ -227,27 +230,27 @@ export interface Sku { * @constructor * The top level Workspace resource container. * - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * workspace. Possible values include: 'Creating', 'Succeeded', 'Failed', * 'Canceled', 'Deleting', 'ProvisioningAccount' - * @member {string} [source] The source of the workspace. Source defines where - * the workspace was created. 'Azure' implies it was created in Azure. + * @property {string} [source] The source of the workspace. Source defines + * where the workspace was created. 'Azure' implies it was created in Azure. * 'External' implies it was created via the Operational Insights Portal. This * value is set on the service side and read-only on the client side. - * @member {string} [customerId] The ID associated with the workspace. Setting - * this value at creation time allows the workspace being created to be linked - * to an existing workspace. - * @member {string} [portalUrl] The URL of the Operational Insights portal for - * this workspace. This value is set on the service side and read-only on the - * client side. - * @member {object} [sku] The SKU of the workspace. - * @member {string} [sku.name] The name of the SKU. Possible values include: + * @property {string} [customerId] The ID associated with the workspace. + * Setting this value at creation time allows the workspace being created to be + * linked to an existing workspace. + * @property {string} [portalUrl] The URL of the Operational Insights portal + * for this workspace. This value is set on the service side and read-only on + * the client side. + * @property {object} [sku] The SKU of the workspace. + * @property {string} [sku.name] The name of the SKU. Possible values include: * 'Free', 'Standard', 'Premium', 'Unlimited', 'PerNode', 'PerGB2018', * 'Standalone' - * @member {number} [retentionInDays] The workspace data retention in days. -1 - * means Unlimited retention for the Unlimited Sku. 730 days is the maximum + * @property {number} [retentionInDays] The workspace data retention in days. + * -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum * allowed for all other Skus. - * @member {string} [eTag] The ETag of the workspace. + * @property {string} [eTag] The ETag of the workspace. */ export interface Workspace extends BaseResource { provisioningState?: string; @@ -265,11 +268,11 @@ export interface Workspace extends BaseResource { * @constructor * The resource definition. * - * @member {string} [id] Resource Id - * @member {string} [name] Resource name - * @member {string} [type] Resource type - * @member {string} [location] Resource location - * @member {object} [tags] Resource tags + * @property {string} [id] Resource Id + * @property {string} [name] Resource name + * @property {string} [type] Resource type + * @property {string} [location] Resource location + * @property {object} [tags] Resource tags */ export interface Resource extends BaseResource { readonly id?: string; @@ -285,10 +288,10 @@ export interface Resource extends BaseResource { * @constructor * Common properties of proxy resource. * - * @member {string} [id] Resource ID. - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. - * @member {object} [tags] Resource tags + * @property {string} [id] Resource ID. + * @property {string} [name] Resource name. + * @property {string} [type] Resource type. + * @property {object} [tags] Resource tags */ export interface ProxyResource { readonly id?: string; @@ -314,7 +317,8 @@ export interface LinkedServiceListResult extends Array { * @constructor * The list data source by workspace operation response. * - * @member {string} [nextLink] The link (url) to the next page of datasources. + * @property {string} [nextLink] The link (url) to the next page of + * datasources. */ export interface DataSourceListResult extends Array { nextLink?: string; @@ -334,7 +338,7 @@ export interface WorkspaceListUsagesResult extends Array { * @class * Initializes a new instance of the WorkspaceListManagementGroupsResult class. * @constructor - * The list workspace managmement groups operation response. + * The list workspace management groups operation response. * */ export interface WorkspaceListManagementGroupsResult extends Array { @@ -356,7 +360,7 @@ export interface WorkspaceListResult extends Array { * @constructor * Result of the request to list solution operations. * - * @member {string} [nextLink] URL to get the next set of operation list + * @property {string} [nextLink] URL to get the next set of operation list * results if there are any. */ export interface OperationListResult extends Array { diff --git a/lib/services/operationalInsightsManagement/lib/models/intelligencePack.js b/lib/services/operationalInsightsManagement/lib/models/intelligencePack.js index c0a9ac8bf0..337522717e 100644 --- a/lib/services/operationalInsightsManagement/lib/models/intelligencePack.js +++ b/lib/services/operationalInsightsManagement/lib/models/intelligencePack.js @@ -18,9 +18,11 @@ class IntelligencePack { /** * Create a IntelligencePack. - * @member {string} [name] The name of the intelligence pack. - * @member {boolean} [enabled] The enabled boolean for the intelligence pack. - * @member {string} [displayName] The display name of the intelligence pack. + * @property {string} [name] The name of the intelligence pack. + * @property {boolean} [enabled] The enabled boolean for the intelligence + * pack. + * @property {string} [displayName] The display name of the intelligence + * pack. */ constructor() { } diff --git a/lib/services/operationalInsightsManagement/lib/models/linkedService.js b/lib/services/operationalInsightsManagement/lib/models/linkedService.js index d58e2745ec..ce755aa915 100644 --- a/lib/services/operationalInsightsManagement/lib/models/linkedService.js +++ b/lib/services/operationalInsightsManagement/lib/models/linkedService.js @@ -20,7 +20,7 @@ const models = require('./index'); class LinkedService extends models['BaseResource'] { /** * Create a LinkedService. - * @member {string} resourceId The resource id of the resource that will be + * @property {string} resourceId The resource id of the resource that will be * linked to the workspace. */ constructor() { diff --git a/lib/services/operationalInsightsManagement/lib/models/managementGroup.js b/lib/services/operationalInsightsManagement/lib/models/managementGroup.js index 2ac499bfab..c0bdcea038 100644 --- a/lib/services/operationalInsightsManagement/lib/models/managementGroup.js +++ b/lib/services/operationalInsightsManagement/lib/models/managementGroup.js @@ -17,19 +17,19 @@ class ManagementGroup { /** * Create a ManagementGroup. - * @member {number} [serverCount] The number of servers connected to the + * @property {number} [serverCount] The number of servers connected to the * management group. - * @member {boolean} [isGateway] Gets or sets a value indicating whether the - * management group is a gateway. - * @member {string} [name] The name of the management group. - * @member {string} [id] The unique ID of the management group. - * @member {date} [created] The datetime that the management group was + * @property {boolean} [isGateway] Gets or sets a value indicating whether + * the management group is a gateway. + * @property {string} [name] The name of the management group. + * @property {string} [id] The unique ID of the management group. + * @property {date} [created] The datetime that the management group was * created. - * @member {date} [dataReceived] The last datetime that the management group - * received data. - * @member {string} [version] The version of System Center that is managing + * @property {date} [dataReceived] The last datetime that the management + * group received data. + * @property {string} [version] The version of System Center that is managing * the management group. - * @member {string} [sku] The SKU of System Center that is managing the + * @property {string} [sku] The SKU of System Center that is managing the * management group. */ constructor() { diff --git a/lib/services/operationalInsightsManagement/lib/models/metricName.js b/lib/services/operationalInsightsManagement/lib/models/metricName.js index b4fde5479d..ef87e4e198 100644 --- a/lib/services/operationalInsightsManagement/lib/models/metricName.js +++ b/lib/services/operationalInsightsManagement/lib/models/metricName.js @@ -17,8 +17,8 @@ class MetricName { /** * Create a MetricName. - * @member {string} [value] The system name of the metric. - * @member {string} [localizedValue] The localized name of the metric. + * @property {string} [value] The system name of the metric. + * @property {string} [localizedValue] The localized name of the metric. */ constructor() { } diff --git a/lib/services/operationalInsightsManagement/lib/models/operation.js b/lib/services/operationalInsightsManagement/lib/models/operation.js index 892a49188a..48701b7261 100644 --- a/lib/services/operationalInsightsManagement/lib/models/operation.js +++ b/lib/services/operationalInsightsManagement/lib/models/operation.js @@ -17,14 +17,16 @@ class Operation { /** * Create a Operation. - * @member {string} [name] Operation name: {provider}/{resource}/{operation} - * @member {object} [display] Display metadata associated with the operation. - * @member {string} [display.provider] Service provider: Microsoft + * @property {string} [name] Operation name: + * {provider}/{resource}/{operation} + * @property {object} [display] Display metadata associated with the + * operation. + * @property {string} [display.provider] Service provider: Microsoft * OperationsManagement. - * @member {string} [display.resource] Resource on which the operation is + * @property {string} [display.resource] Resource on which the operation is * performed etc. - * @member {string} [display.operation] Type of operation: get, read, delete, - * etc. + * @property {string} [display.operation] Type of operation: get, read, + * delete, etc. */ constructor() { } diff --git a/lib/services/operationalInsightsManagement/lib/models/operationDisplay.js b/lib/services/operationalInsightsManagement/lib/models/operationDisplay.js index 4b43fd5874..4b26fe34e8 100644 --- a/lib/services/operationalInsightsManagement/lib/models/operationDisplay.js +++ b/lib/services/operationalInsightsManagement/lib/models/operationDisplay.js @@ -17,11 +17,11 @@ class OperationDisplay { /** * Create a OperationDisplay. - * @member {string} [provider] Service provider: Microsoft + * @property {string} [provider] Service provider: Microsoft * OperationsManagement. - * @member {string} [resource] Resource on which the operation is performed + * @property {string} [resource] Resource on which the operation is performed * etc. - * @member {string} [operation] Type of operation: get, read, delete, etc. + * @property {string} [operation] Type of operation: get, read, delete, etc. */ constructor() { } diff --git a/lib/services/operationalInsightsManagement/lib/models/operationListResult.js b/lib/services/operationalInsightsManagement/lib/models/operationListResult.js index 66424c65a0..2d8371ce52 100644 --- a/lib/services/operationalInsightsManagement/lib/models/operationListResult.js +++ b/lib/services/operationalInsightsManagement/lib/models/operationListResult.js @@ -16,7 +16,7 @@ class OperationListResult extends Array { /** * Create a OperationListResult. - * @member {string} [nextLink] URL to get the next set of operation list + * @property {string} [nextLink] URL to get the next set of operation list * results if there are any. */ constructor() { diff --git a/lib/services/operationalInsightsManagement/lib/models/proxyResource.js b/lib/services/operationalInsightsManagement/lib/models/proxyResource.js index e2169667f9..1bb9c7fe39 100644 --- a/lib/services/operationalInsightsManagement/lib/models/proxyResource.js +++ b/lib/services/operationalInsightsManagement/lib/models/proxyResource.js @@ -17,10 +17,10 @@ class ProxyResource { /** * Create a ProxyResource. - * @member {string} [id] Resource ID. - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. - * @member {object} [tags] Resource tags + * @property {string} [id] Resource ID. + * @property {string} [name] Resource name. + * @property {string} [type] Resource type. + * @property {object} [tags] Resource tags */ constructor() { } diff --git a/lib/services/operationalInsightsManagement/lib/models/resource.js b/lib/services/operationalInsightsManagement/lib/models/resource.js index 2209d439c9..99364a4b87 100644 --- a/lib/services/operationalInsightsManagement/lib/models/resource.js +++ b/lib/services/operationalInsightsManagement/lib/models/resource.js @@ -20,11 +20,11 @@ const models = require('./index'); class Resource extends models['BaseResource'] { /** * Create a Resource. - * @member {string} [id] Resource Id - * @member {string} [name] Resource name - * @member {string} [type] Resource type - * @member {string} [location] Resource location - * @member {object} [tags] Resource tags + * @property {string} [id] Resource Id + * @property {string} [name] Resource name + * @property {string} [type] Resource type + * @property {string} [location] Resource location + * @property {object} [tags] Resource tags */ constructor() { super(); diff --git a/lib/services/operationalInsightsManagement/lib/models/sharedKeys.js b/lib/services/operationalInsightsManagement/lib/models/sharedKeys.js index fcfa32789e..bfd0e6117f 100644 --- a/lib/services/operationalInsightsManagement/lib/models/sharedKeys.js +++ b/lib/services/operationalInsightsManagement/lib/models/sharedKeys.js @@ -17,8 +17,9 @@ class SharedKeys { /** * Create a SharedKeys. - * @member {string} [primarySharedKey] The primary shared key of a workspace. - * @member {string} [secondarySharedKey] The secondary shared key of a + * @property {string} [primarySharedKey] The primary shared key of a + * workspace. + * @property {string} [secondarySharedKey] The secondary shared key of a * workspace. */ constructor() { diff --git a/lib/services/operationalInsightsManagement/lib/models/sku.js b/lib/services/operationalInsightsManagement/lib/models/sku.js index f6a0fd2332..ec0a3db2da 100644 --- a/lib/services/operationalInsightsManagement/lib/models/sku.js +++ b/lib/services/operationalInsightsManagement/lib/models/sku.js @@ -17,7 +17,7 @@ class Sku { /** * Create a Sku. - * @member {string} name The name of the SKU. Possible values include: + * @property {string} name The name of the SKU. Possible values include: * 'Free', 'Standard', 'Premium', 'Unlimited', 'PerNode', 'PerGB2018', * 'Standalone' */ diff --git a/lib/services/operationalInsightsManagement/lib/models/usageMetric.js b/lib/services/operationalInsightsManagement/lib/models/usageMetric.js index 71cbe7e729..2921e5fb8b 100644 --- a/lib/services/operationalInsightsManagement/lib/models/usageMetric.js +++ b/lib/services/operationalInsightsManagement/lib/models/usageMetric.js @@ -17,16 +17,16 @@ class UsageMetric { /** * Create a UsageMetric. - * @member {object} [name] The name of the metric. - * @member {string} [name.value] The system name of the metric. - * @member {string} [name.localizedValue] The localized name of the metric. - * @member {string} [unit] The units used for the metric. - * @member {number} [currentValue] The current value of the metric. - * @member {number} [limit] The quota limit for the metric. - * @member {date} [nextResetTime] The time that the metric's value will + * @property {object} [name] The name of the metric. + * @property {string} [name.value] The system name of the metric. + * @property {string} [name.localizedValue] The localized name of the metric. + * @property {string} [unit] The units used for the metric. + * @property {number} [currentValue] The current value of the metric. + * @property {number} [limit] The quota limit for the metric. + * @property {date} [nextResetTime] The time that the metric's value will * reset. - * @member {string} [quotaPeriod] The quota period that determines the length - * of time between value resets. + * @property {string} [quotaPeriod] The quota period that determines the + * length of time between value resets. */ constructor() { } diff --git a/lib/services/operationalInsightsManagement/lib/models/workspace.js b/lib/services/operationalInsightsManagement/lib/models/workspace.js index f29cf35fc9..cad7ac5340 100644 --- a/lib/services/operationalInsightsManagement/lib/models/workspace.js +++ b/lib/services/operationalInsightsManagement/lib/models/workspace.js @@ -20,27 +20,27 @@ const models = require('./index'); class Workspace extends models['BaseResource'] { /** * Create a Workspace. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [provisioningState] The provisioning state of the * workspace. Possible values include: 'Creating', 'Succeeded', 'Failed', * 'Canceled', 'Deleting', 'ProvisioningAccount' - * @member {string} [source] The source of the workspace. Source defines + * @property {string} [source] The source of the workspace. Source defines * where the workspace was created. 'Azure' implies it was created in Azure. * 'External' implies it was created via the Operational Insights Portal. * This value is set on the service side and read-only on the client side. - * @member {string} [customerId] The ID associated with the workspace. + * @property {string} [customerId] The ID associated with the workspace. * Setting this value at creation time allows the workspace being created to * be linked to an existing workspace. - * @member {string} [portalUrl] The URL of the Operational Insights portal + * @property {string} [portalUrl] The URL of the Operational Insights portal * for this workspace. This value is set on the service side and read-only * on the client side. - * @member {object} [sku] The SKU of the workspace. - * @member {string} [sku.name] The name of the SKU. Possible values include: - * 'Free', 'Standard', 'Premium', 'Unlimited', 'PerNode', 'PerGB2018', - * 'Standalone' - * @member {number} [retentionInDays] The workspace data retention in days. + * @property {object} [sku] The SKU of the workspace. + * @property {string} [sku.name] The name of the SKU. Possible values + * include: 'Free', 'Standard', 'Premium', 'Unlimited', 'PerNode', + * 'PerGB2018', 'Standalone' + * @property {number} [retentionInDays] The workspace data retention in days. * -1 means Unlimited retention for the Unlimited Sku. 730 days is the * maximum allowed for all other Skus. - * @member {string} [eTag] The ETag of the workspace. + * @property {string} [eTag] The ETag of the workspace. */ constructor() { super(); diff --git a/lib/services/operationalInsightsManagement/lib/models/workspaceListManagementGroupsResult.js b/lib/services/operationalInsightsManagement/lib/models/workspaceListManagementGroupsResult.js index f5fec29e2d..714c62bfdf 100644 --- a/lib/services/operationalInsightsManagement/lib/models/workspaceListManagementGroupsResult.js +++ b/lib/services/operationalInsightsManagement/lib/models/workspaceListManagementGroupsResult.js @@ -11,7 +11,7 @@ 'use strict'; /** - * The list workspace managmement groups operation response. + * The list workspace management groups operation response. */ class WorkspaceListManagementGroupsResult extends Array { /** diff --git a/lib/services/operationalInsightsManagement/package.json b/lib/services/operationalInsightsManagement/package.json index b126be6382..08c5146793 100644 --- a/lib/services/operationalInsightsManagement/package.json +++ b/lib/services/operationalInsightsManagement/package.json @@ -22,4 +22,4 @@ "bugs": { "url": "https://github.com/azure/azure-sdk-for-node/issues" } -} \ No newline at end of file +}