[AutoPR] cosmos-db/resource-manager

lib/services/cosmosdbManagement/README.md

@@ -3,22 +3,23 @@ uid: azure-arm-cosmosdb
 summary: *content
 
 ---
-# Microsoft Azure SDK for Node.js - CosmosDBManagementClient
+**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 - CosmosDBManagementClient
 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-cosmosdb
 ```
 
-## How to use
+### How to use
 
-### Authentication, client creation and get databaseAccounts as an example.
+#### Authentication, client creation and get databaseAccounts as an example.
 
 ```javascript
 const msRestAzure = require("ms-rest-azure");
@@ -37,6 +38,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)

lib/services/cosmosdbManagement/lib/models/capability.js

@@ -17,7 +17,7 @@
 class Capability {
   /**
    * Create a Capability.
-   * @member {string} [name] Name of the Cosmos DB capability. For example,
+   * @property {string} [name] Name of the Cosmos DB capability. For example,
    * "name": "EnableCassandra". Current values also include "EnableTable" and
    * "EnableGremlin".
    */

lib/services/cosmosdbManagement/lib/models/consistencyPolicy.js

@@ -17,14 +17,15 @@
 class ConsistencyPolicy {
   /**
    * Create a ConsistencyPolicy.
-   * @member {string} defaultConsistencyLevel The default consistency level and
-   * configuration settings of the Cosmos DB account. Possible values include:
-   * 'Eventual', 'Session', 'BoundedStaleness', 'Strong', 'ConsistentPrefix'
-   * @member {number} [maxStalenessPrefix] When used with the Bounded Staleness
-   * consistency level, this value represents the number of stale requests
-   * tolerated. Accepted range for this value is 1 – 2,147,483,647. Required
-   * when defaultConsistencyPolicy is set to 'BoundedStaleness'.
-   * @member {number} [maxIntervalInSeconds] When used with the Bounded
+   * @property {string} defaultConsistencyLevel The default consistency level
+   * and configuration settings of the Cosmos DB account. Possible values
+   * include: 'Eventual', 'Session', 'BoundedStaleness', 'Strong',
+   * 'ConsistentPrefix'
+   * @property {number} [maxStalenessPrefix] When used with the Bounded
+   * Staleness consistency level, this value represents the number of stale
+   * requests tolerated. Accepted range for this value is 1 – 2,147,483,647.
+   * Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
+   * @property {number} [maxIntervalInSeconds] When used with the Bounded
    * Staleness consistency level, this value represents the time amount of
    * staleness (in seconds) tolerated. Accepted range for this value is 5 -
    * 86400. Required when defaultConsistencyPolicy is set to

lib/services/cosmosdbManagement/lib/models/databaseAccount.js

@@ -20,55 +20,55 @@ const models = require('./index');
 class DatabaseAccount extends models['Resource'] {
   /**
    * Create a DatabaseAccount.
-   * @member {string} [kind] Indicates the type of database account. This can
+   * @property {string} [kind] Indicates the type of database account. This can
    * only be set at database account creation. Possible values include:
    * 'GlobalDocumentDB', 'MongoDB', 'Parse'. Default value: 'GlobalDocumentDB'
    * .
-   * @member {string} [provisioningState]
-   * @member {string} [documentEndpoint] The connection endpoint for the Cosmos
-   * DB database account.
-   * @member {string} [databaseAccountOfferType] The offer type for the Cosmos
-   * DB database account. Default value: Standard. Possible values include:
-   * 'Standard'
-   * @member {string} [ipRangeFilter] Cosmos DB Firewall Support: This value
+   * @property {string} [provisioningState]
+   * @property {string} [documentEndpoint] The connection endpoint for the
+   * Cosmos DB database account.
+   * @property {string} [databaseAccountOfferType] The offer type for the
+   * Cosmos DB database account. Default value: Standard. Possible values
+   * include: 'Standard'
+   * @property {string} [ipRangeFilter] Cosmos DB Firewall Support: This value
    * specifies the set of IP addresses or IP address ranges in CIDR form to be
    * included as the allowed list of client IPs for a given database account.
    * IP addresses/ranges must be comma separated and must not contain any
    * spaces.
-   * @member {boolean} [isVirtualNetworkFilterEnabled] Flag to indicate whether
-   * to enable/disable Virtual Network ACL rules.
-   * @member {boolean} [enableAutomaticFailover] Enables automatic failover of
-   * the write region in the rare event that the region is unavailable due to
-   * an outage. Automatic failover will result in a new write region for the
+   * @property {boolean} [isVirtualNetworkFilterEnabled] Flag to indicate
+   * whether to enable/disable Virtual Network ACL rules.
+   * @property {boolean} [enableAutomaticFailover] Enables automatic failover
+   * of the write region in the rare event that the region is unavailable due
+   * to an outage. Automatic failover will result in a new write region for the
    * account and is chosen based on the failover priorities configured for the
    * account.
-   * @member {object} [consistencyPolicy] The consistency policy for the Cosmos
-   * DB database account.
-   * @member {string} [consistencyPolicy.defaultConsistencyLevel] The default
+   * @property {object} [consistencyPolicy] The consistency policy for the
+   * Cosmos DB database account.
+   * @property {string} [consistencyPolicy.defaultConsistencyLevel] The default
    * consistency level and configuration settings of the Cosmos DB account.
    * Possible values include: 'Eventual', 'Session', 'BoundedStaleness',
    * 'Strong', 'ConsistentPrefix'
-   * @member {number} [consistencyPolicy.maxStalenessPrefix] When used with the
-   * Bounded Staleness consistency level, this value represents the number of
-   * stale requests tolerated. Accepted range for this value is 1 –
+   * @property {number} [consistencyPolicy.maxStalenessPrefix] When used with
+   * the Bounded Staleness consistency level, this value represents the number
+   * of stale requests tolerated. Accepted range for this value is 1 –
    * 2,147,483,647. Required when defaultConsistencyPolicy is set to
    * 'BoundedStaleness'.
-   * @member {number} [consistencyPolicy.maxIntervalInSeconds] When used with
+   * @property {number} [consistencyPolicy.maxIntervalInSeconds] When used with
    * the Bounded Staleness consistency level, this value represents the time
    * amount of staleness (in seconds) tolerated. Accepted range for this value
    * is 5 - 86400. Required when defaultConsistencyPolicy is set to
    * 'BoundedStaleness'.
-   * @member {array} [capabilities] List of Cosmos DB capabilities for the
+   * @property {array} [capabilities] List of Cosmos DB capabilities for the
    * account
-   * @member {array} [writeLocations] An array that contains the write location
-   * for the Cosmos DB account.
-   * @member {array} [readLocations] An array that contains of the read
+   * @property {array} [writeLocations] An array that contains the write
+   * location for the Cosmos DB account.
+   * @property {array} [readLocations] An array that contains of the read
    * locations enabled for the Cosmos DB account.
-   * @member {array} [failoverPolicies] An array that contains the regions
+   * @property {array} [failoverPolicies] An array that contains the regions
    * ordered by their failover priorities.
-   * @member {array} [virtualNetworkRules] List of Virtual Network ACL rules
+   * @property {array} [virtualNetworkRules] List of Virtual Network ACL rules
    * configured for the Cosmos DB account.
-   * @member {boolean} [enableMultipleWriteLocations] Enables the account to
+   * @property {boolean} [enableMultipleWriteLocations] Enables the account to
    * write in multiple locations
    */
   constructor() {

lib/services/cosmosdbManagement/lib/models/databaseAccountConnectionString.js

@@ -17,8 +17,8 @@
 class DatabaseAccountConnectionString {
   /**
    * Create a DatabaseAccountConnectionString.
-   * @member {string} [connectionString] Value of the connection string
-   * @member {string} [description] Description of the connection string
+   * @property {string} [connectionString] Value of the connection string
+   * @property {string} [description] Description of the connection string
    */
   constructor() {
   }

lib/services/cosmosdbManagement/lib/models/databaseAccountCreateUpdateParameters.js

@@ -20,45 +20,45 @@ const models = require('./index');
 class DatabaseAccountCreateUpdateParameters extends models['Resource'] {
   /**
    * Create a DatabaseAccountCreateUpdateParameters.
-   * @member {string} [kind] Indicates the type of database account. This can
+   * @property {string} [kind] Indicates the type of database account. This can
    * only be set at database account creation. Possible values include:
    * 'GlobalDocumentDB', 'MongoDB', 'Parse'. Default value: 'GlobalDocumentDB'
    * .
-   * @member {object} [consistencyPolicy] The consistency policy for the Cosmos
-   * DB account.
-   * @member {string} [consistencyPolicy.defaultConsistencyLevel] The default
+   * @property {object} [consistencyPolicy] The consistency policy for the
+   * Cosmos DB account.
+   * @property {string} [consistencyPolicy.defaultConsistencyLevel] The default
    * consistency level and configuration settings of the Cosmos DB account.
    * Possible values include: 'Eventual', 'Session', 'BoundedStaleness',
    * 'Strong', 'ConsistentPrefix'
-   * @member {number} [consistencyPolicy.maxStalenessPrefix] When used with the
-   * Bounded Staleness consistency level, this value represents the number of
-   * stale requests tolerated. Accepted range for this value is 1 –
+   * @property {number} [consistencyPolicy.maxStalenessPrefix] When used with
+   * the Bounded Staleness consistency level, this value represents the number
+   * of stale requests tolerated. Accepted range for this value is 1 –
    * 2,147,483,647. Required when defaultConsistencyPolicy is set to
    * 'BoundedStaleness'.
-   * @member {number} [consistencyPolicy.maxIntervalInSeconds] When used with
+   * @property {number} [consistencyPolicy.maxIntervalInSeconds] When used with
    * the Bounded Staleness consistency level, this value represents the time
    * amount of staleness (in seconds) tolerated. Accepted range for this value
    * is 5 - 86400. Required when defaultConsistencyPolicy is set to
    * 'BoundedStaleness'.
-   * @member {array} locations An array that contains the georeplication
+   * @property {array} locations An array that contains the georeplication
    * locations enabled for the Cosmos DB account.
-   * @member {string} [ipRangeFilter] Cosmos DB Firewall Support: This value
+   * @property {string} [ipRangeFilter] Cosmos DB Firewall Support: This value
    * specifies the set of IP addresses or IP address ranges in CIDR form to be
    * included as the allowed list of client IPs for a given database account.
    * IP addresses/ranges must be comma separated and must not contain any
    * spaces.
-   * @member {boolean} [isVirtualNetworkFilterEnabled] Flag to indicate whether
-   * to enable/disable Virtual Network ACL rules.
-   * @member {boolean} [enableAutomaticFailover] Enables automatic failover of
-   * the write region in the rare event that the region is unavailable due to
-   * an outage. Automatic failover will result in a new write region for the
+   * @property {boolean} [isVirtualNetworkFilterEnabled] Flag to indicate
+   * whether to enable/disable Virtual Network ACL rules.
+   * @property {boolean} [enableAutomaticFailover] Enables automatic failover
+   * of the write region in the rare event that the region is unavailable due
+   * to an outage. Automatic failover will result in a new write region for the
    * account and is chosen based on the failover priorities configured for the
    * account.
-   * @member {array} [capabilities] List of Cosmos DB capabilities for the
+   * @property {array} [capabilities] List of Cosmos DB capabilities for the
    * account
-   * @member {array} [virtualNetworkRules] List of Virtual Network ACL rules
+   * @property {array} [virtualNetworkRules] List of Virtual Network ACL rules
    * configured for the Cosmos DB account.
-   * @member {boolean} [enableMultipleWriteLocations] Enables the account to
+   * @property {boolean} [enableMultipleWriteLocations] Enables the account to
    * write in multiple locations
    */
   constructor() {

lib/services/cosmosdbManagement/lib/models/databaseAccountListConnectionStringsResult.js

@@ -17,8 +17,8 @@
 class DatabaseAccountListConnectionStringsResult {
   /**
    * Create a DatabaseAccountListConnectionStringsResult.
-   * @member {array} [connectionStrings] An array that contains the connection
-   * strings for the Cosmos DB account.
+   * @property {array} [connectionStrings] An array that contains the
+   * connection strings for the Cosmos DB account.
    */
   constructor() {
   }

lib/services/cosmosdbManagement/lib/models/databaseAccountListKeysResult.js

@@ -17,14 +17,14 @@
 class DatabaseAccountListKeysResult {
   /**
    * Create a DatabaseAccountListKeysResult.
-   * @member {string} [primaryMasterKey] Base 64 encoded value of the primary
+   * @property {string} [primaryMasterKey] Base 64 encoded value of the primary
    * read-write key.
-   * @member {string} [secondaryMasterKey] Base 64 encoded value of the
+   * @property {string} [secondaryMasterKey] Base 64 encoded value of the
    * secondary read-write key.
-   * @member {string} [primaryReadonlyMasterKey] Base 64 encoded value of the
+   * @property {string} [primaryReadonlyMasterKey] Base 64 encoded value of the
    * primary read-only key.
-   * @member {string} [secondaryReadonlyMasterKey] Base 64 encoded value of the
-   * secondary read-only key.
+   * @property {string} [secondaryReadonlyMasterKey] Base 64 encoded value of
+   * the secondary read-only key.
    */
   constructor() {
   }

lib/services/cosmosdbManagement/lib/models/databaseAccountListReadOnlyKeysResult.js

@@ -17,10 +17,10 @@
 class DatabaseAccountListReadOnlyKeysResult {
   /**
    * Create a DatabaseAccountListReadOnlyKeysResult.
-   * @member {string} [primaryReadonlyMasterKey] Base 64 encoded value of the
+   * @property {string} [primaryReadonlyMasterKey] Base 64 encoded value of the
    * primary read-only key.
-   * @member {string} [secondaryReadonlyMasterKey] Base 64 encoded value of the
-   * secondary read-only key.
+   * @property {string} [secondaryReadonlyMasterKey] Base 64 encoded value of
+   * the secondary read-only key.
    */
   constructor() {
   }

lib/services/cosmosdbManagement/lib/models/databaseAccountPatchParameters.js

@@ -17,8 +17,8 @@
 class DatabaseAccountPatchParameters {
   /**
    * Create a DatabaseAccountPatchParameters.
-   * @member {object} [tags]
-   * @member {array} [capabilities] List of Cosmos DB capabilities for the
+   * @property {object} [tags]
+   * @property {array} [capabilities] List of Cosmos DB capabilities for the
    * account
    */
   constructor() {

lib/services/cosmosdbManagement/lib/models/databaseAccountRegenerateKeyParameters.js

@@ -17,7 +17,7 @@
 class DatabaseAccountRegenerateKeyParameters {
   /**
    * Create a DatabaseAccountRegenerateKeyParameters.
-   * @member {string} keyKind The access key to regenerate. Possible values
+   * @property {string} keyKind The access key to regenerate. Possible values
    * include: 'primary', 'secondary', 'primaryReadonly', 'secondaryReadonly'
    */
   constructor() {

lib/services/cosmosdbManagement/lib/models/errorResponse.js

@@ -17,8 +17,8 @@
 class ErrorResponse {
   /**
    * Create a ErrorResponse.
-   * @member {string} [code] Error code.
-   * @member {string} [message] Error message indicating why the operation
+   * @property {string} [code] Error code.
+   * @property {string} [message] Error message indicating why the operation
    * failed.
    */
   constructor() {

lib/services/cosmosdbManagement/lib/models/failoverPolicies.js

@@ -17,7 +17,7 @@
 class FailoverPolicies {
   /**
    * Create a FailoverPolicies.
-   * @member {array} failoverPolicies List of failover policies.
+   * @property {array} failoverPolicies List of failover policies.
    */
   constructor() {
   }

lib/services/cosmosdbManagement/lib/models/failoverPolicy.js

@@ -17,13 +17,13 @@
 class FailoverPolicy {
   /**
    * Create a FailoverPolicy.
-   * @member {string} [id] The unique identifier of the region in which the
+   * @property {string} [id] The unique identifier of the region in which the
    * database account replicates to. Example:
    * <accountName>-<locationName>.
-   * @member {string} [locationName] The name of the region in which the
+   * @property {string} [locationName] The name of the region in which the
    * database account exists.
-   * @member {number} [failoverPriority] The failover priority of the region. A
-   * failover priority of 0 indicates a write region. The maximum value for a
+   * @property {number} [failoverPriority] The failover priority of the region.
+   * A failover priority of 0 indicates a write region. The maximum value for a
    * failover priority = (total number of regions - 1). Failover priority
    * values must be unique for each of the regions in which the database
    * account exists.