diff --git a/lib/services/relayManagement/LICENSE.txt b/lib/services/relayManagement/LICENSE.txt index 0313a903d7..8f3d856145 100644 --- a/lib/services/relayManagement/LICENSE.txt +++ b/lib/services/relayManagement/LICENSE.txt @@ -1,21 +1,21 @@ -The MIT License (MIT) - -Copyright (c) 2017 Microsoft - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file +The MIT License (MIT) + +Copyright (c) 2019 Microsoft + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/lib/services/relayManagement/README.md b/lib/services/relayManagement/README.md index 8e0067b066..d8ba9969b5 100644 --- a/lib/services/relayManagement/README.md +++ b/lib/services/relayManagement/README.md @@ -1,37 +1,43 @@ -# Microsoft Azure SDK for Node.js - RelayManagement - -This project provides a Node.js package that makes it easy to manage Microsoft Azure Relay. -## Minimum node.js version >= 6.x.x - -## How to Install - -```bash -npm install azure-arm-relay -``` - -## How to Use - -### Authentication, client creation and listing namespaces as an example - - ```javascript - const msRestAzure = require('ms-rest-azure'); - const RelayManagement = require("azure-arm-relay"); - - // Interactive Login - // It provides a url and code that needs to be copied and pasted in a browser and authenticated over there. If successful, - // the user will get a DeviceTokenCredentials object. - msRestAzure.interactiveLogin().then((credentials) => { - let client = new RelayManagement(credentials, 'your-subscription-id'); - return client.namespaces.list(); - }).then((namespaces) => { - console.log('List of namespaces:'); - console.dir(namespaces, {depth: null, colors: true}); -}).catch((err) => { - console.log('An error ocurred'); - console.dir(err, {depth: null, colors: true}); - }); -``` - -## Related projects - -- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node) \ No newline at end of file +--- +uid: azure-arm-relay +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 - RelayManagementClient + +This project provides a Node.js package for accessing Azure. Right now it supports: +- **Node.js version 6.x.x or higher** + +### Features + + +### How to Install + +```bash +npm install azure-arm-relay +``` + +### How to use + +#### Authentication, client creation, and list operations as an example. + +```javascript +const msRestAzure = require("ms-rest-azure"); +const RelayManagementClient = require("azure-arm-relay"); +msRestAzure.interactiveLogin().then((creds) => { + const subscriptionId = ""; + const client = new RelayManagementClient(creds, subscriptionId); + + return client.operations.list().then((result) => { + console.log("The result is:"); + console.log(result); + }); +}).catch((err) => { + console.log('An error occurred:'); + console.dir(err, {depth: null, colors: true}); +}); +``` +### Related projects + +- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node) diff --git a/lib/services/relayManagement/lib/models/accessKeys.js b/lib/services/relayManagement/lib/models/accessKeys.js index dd6484523b..7179077efb 100644 --- a/lib/services/relayManagement/lib/models/accessKeys.js +++ b/lib/services/relayManagement/lib/models/accessKeys.js @@ -17,15 +17,16 @@ class AccessKeys { /** * Create a AccessKeys. - * @member {string} [primaryConnectionString] Primary connection string of + * @property {string} [primaryConnectionString] Primary connection string of * the created namespace authorization rule. - * @member {string} [secondaryConnectionString] Secondary connection string + * @property {string} [secondaryConnectionString] Secondary connection string * of the created namespace authorization rule. - * @member {string} [primaryKey] A base64-encoded 256-bit primary key for + * @property {string} [primaryKey] A base64-encoded 256-bit primary key for * signing and validating the SAS token. - * @member {string} [secondaryKey] A base64-encoded 256-bit secondary key for - * signing and validating the SAS token. - * @member {string} [keyName] A string that describes the authorization rule. + * @property {string} [secondaryKey] A base64-encoded 256-bit secondary key + * for signing and validating the SAS token. + * @property {string} [keyName] A string that describes the authorization + * rule. */ constructor() { } diff --git a/lib/services/relayManagement/lib/models/authorizationRule.js b/lib/services/relayManagement/lib/models/authorizationRule.js index 6d8796fec1..9bd5bf9e27 100644 --- a/lib/services/relayManagement/lib/models/authorizationRule.js +++ b/lib/services/relayManagement/lib/models/authorizationRule.js @@ -20,7 +20,7 @@ const models = require('./index'); class AuthorizationRule extends models['Resource'] { /** * Create a AuthorizationRule. - * @member {array} [rights] The rights associated with the rule. + * @property {array} rights The rights associated with the rule. */ constructor() { super(); @@ -65,7 +65,7 @@ class AuthorizationRule extends models['Resource'] { } }, rights: { - required: false, + required: true, serializedName: 'properties.rights', constraints: { UniqueItems: true diff --git a/lib/services/relayManagement/lib/models/authorizationRuleListResult.js b/lib/services/relayManagement/lib/models/authorizationRuleListResult.js index 6e4fbdbf08..9d0206896f 100644 --- a/lib/services/relayManagement/lib/models/authorizationRuleListResult.js +++ b/lib/services/relayManagement/lib/models/authorizationRuleListResult.js @@ -16,8 +16,8 @@ class AuthorizationRuleListResult extends Array { /** * Create a AuthorizationRuleListResult. - * @member {string} [nextLink] Link to the next set of results. Not empty if - * value contains incomplete list of authorization rules. + * @property {string} [nextLink] Link to the next set of results. Not empty + * if value contains incomplete list of authorization rules. */ constructor() { super(); diff --git a/lib/services/relayManagement/lib/models/checkNameAvailability.js b/lib/services/relayManagement/lib/models/checkNameAvailability.js index 0684408058..ad88bccc6e 100644 --- a/lib/services/relayManagement/lib/models/checkNameAvailability.js +++ b/lib/services/relayManagement/lib/models/checkNameAvailability.js @@ -17,7 +17,7 @@ class CheckNameAvailability { /** * Create a CheckNameAvailability. - * @member {string} name The namespace name to check for availability. The + * @property {string} name The namespace name to check for availability. The * namespace name can contain only letters, numbers, and hyphens. The * namespace must start with a letter, and it must end with a letter or * number. diff --git a/lib/services/relayManagement/lib/models/checkNameAvailabilityResult.js b/lib/services/relayManagement/lib/models/checkNameAvailabilityResult.js index 007277e6c6..1726874b4e 100644 --- a/lib/services/relayManagement/lib/models/checkNameAvailabilityResult.js +++ b/lib/services/relayManagement/lib/models/checkNameAvailabilityResult.js @@ -17,11 +17,11 @@ class CheckNameAvailabilityResult { /** * Create a CheckNameAvailabilityResult. - * @member {string} [message] The detailed info regarding the reason + * @property {string} [message] The detailed info regarding the reason * associated with the namespace. - * @member {boolean} [nameAvailable] Value indicating namespace is available. - * Returns true if the namespace is available; otherwise, false. - * @member {string} [reason] The reason for unavailability of a namespace. + * @property {boolean} [nameAvailable] Value indicating namespace is + * available. Returns true if the namespace is available; otherwise, false. + * @property {string} [reason] The reason for unavailability of a namespace. * Possible values include: 'None', 'InvalidName', 'SubscriptionIsDisabled', * 'NameInUse', 'NameInLockdown', 'TooManyNamespaceInCurrentSubscription' */ diff --git a/lib/services/relayManagement/lib/models/errorResponse.js b/lib/services/relayManagement/lib/models/errorResponse.js index 8e7fc61e83..5442a920fc 100644 --- a/lib/services/relayManagement/lib/models/errorResponse.js +++ b/lib/services/relayManagement/lib/models/errorResponse.js @@ -11,15 +11,15 @@ 'use strict'; /** - * Error reponse indicates Relay service is not able to process the incoming + * Error response indicates Relay service is not able to process the incoming * request. The reason is provided in the error message. * */ 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() { diff --git a/lib/services/relayManagement/lib/models/hybridConnection.js b/lib/services/relayManagement/lib/models/hybridConnection.js index 318c127c87..14c10c9708 100644 --- a/lib/services/relayManagement/lib/models/hybridConnection.js +++ b/lib/services/relayManagement/lib/models/hybridConnection.js @@ -20,17 +20,17 @@ const models = require('./index'); class HybridConnection extends models['Resource'] { /** * Create a HybridConnection. - * @member {date} [createdAt] The time the hybrid connection was created. - * @member {date} [updatedAt] The time the namespace was updated. - * @member {number} [listenerCount] The number of listeners for this hybrid + * @property {date} [createdAt] The time the hybrid connection was created. + * @property {date} [updatedAt] The time the namespace was updated. + * @property {number} [listenerCount] The number of listeners for this hybrid * connection. Note that min : 1 and max:25 are supported. - * @member {boolean} [requiresClientAuthorization] Returns true if client + * @property {boolean} [requiresClientAuthorization] Returns true if client * authorization is needed for this hybrid connection; otherwise, false. - * @member {string} [userMetadata] The usermetadata is a placeholder to store - * user-defined string data for the hybrid connection endpoint. For example, - * it can be used to store descriptive data, such as a list of teams and - * their contact information. Also, user-defined configuration settings can - * be stored. + * @property {string} [userMetadata] The userMetadata is a placeholder to + * store user-defined string data for the hybrid connection endpoint. For + * example, it can be used to store descriptive data, such as a list of teams + * and their contact information. Also, user-defined configuration settings + * can be stored. */ constructor() { super(); diff --git a/lib/services/relayManagement/lib/models/hybridConnectionListResult.js b/lib/services/relayManagement/lib/models/hybridConnectionListResult.js index b396e2a185..9b5e529a99 100644 --- a/lib/services/relayManagement/lib/models/hybridConnectionListResult.js +++ b/lib/services/relayManagement/lib/models/hybridConnectionListResult.js @@ -16,8 +16,8 @@ class HybridConnectionListResult extends Array { /** * Create a HybridConnectionListResult. - * @member {string} [nextLink] Link to the next set of results. Not empty if - * value contains incomplete list hybrid connection operation. + * @property {string} [nextLink] Link to the next set of results. Not empty + * if value contains incomplete list hybrid connection operation. */ constructor() { super(); diff --git a/lib/services/relayManagement/lib/models/index.d.ts b/lib/services/relayManagement/lib/models/index.d.ts index 86ea0b09eb..9baa87bb87 100644 --- a/lib/services/relayManagement/lib/models/index.d.ts +++ b/lib/services/relayManagement/lib/models/index.d.ts @@ -1,390 +1,382 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ -import { BaseResource } from 'ms-rest-azure'; -import { CloudError } from 'ms-rest-azure'; -import * as moment from 'moment'; +import { BaseResource, CloudError } from "ms-rest-azure"; +import * as moment from "moment"; -export { BaseResource } from 'ms-rest-azure'; -export { CloudError } from 'ms-rest-azure'; +export { + BaseResource, + CloudError +}; /** - * @class - * Initializes a new instance of the Resource class. - * @constructor * The resource definition. - * - * @member {string} [id] Resource ID. - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. */ export interface Resource extends BaseResource { + /** + * Resource ID. + */ readonly id?: string; + /** + * Resource name. + */ readonly name?: string; + /** + * Resource type. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the TrackedResource class. - * @constructor * Definition of resource. - * - * @member {string} location Resource location. - * @member {object} [tags] Resource tags. */ export interface TrackedResource extends Resource { + /** + * Resource location. + */ location: string; + /** + * Resource tags. + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the ResourceNamespacePatch class. - * @constructor * Definition of resource. - * - * @member {object} [tags] Resource tags. */ export interface ResourceNamespacePatch extends Resource { + /** + * Resource tags. + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the HybridConnection class. - * @constructor * Description of hybrid connection resource. - * - * @member {date} [createdAt] The time the hybrid connection was created. - * @member {date} [updatedAt] The time the namespace was updated. - * @member {number} [listenerCount] The number of listeners for this hybrid - * connection. Note that min : 1 and max:25 are supported. - * @member {boolean} [requiresClientAuthorization] Returns true if client - * authorization is needed for this hybrid connection; otherwise, false. - * @member {string} [userMetadata] The usermetadata is a placeholder to store - * user-defined string data for the hybrid connection endpoint. For example, it - * can be used to store descriptive data, such as a list of teams and their - * contact information. Also, user-defined configuration settings can be - * stored. */ export interface HybridConnection extends Resource { + /** + * The time the hybrid connection was created. + */ readonly createdAt?: Date; + /** + * The time the namespace was updated. + */ readonly updatedAt?: Date; + /** + * The number of listeners for this hybrid connection. Note that min : 1 and max:25 are + * supported. + */ readonly listenerCount?: number; + /** + * Returns true if client authorization is needed for this hybrid connection; otherwise, false. + */ requiresClientAuthorization?: boolean; + /** + * The userMetadata is a placeholder to store user-defined string data for the hybrid connection + * endpoint. For example, it can be used to store descriptive data, such as a list of teams and + * their contact information. Also, user-defined configuration settings can be stored. + */ userMetadata?: string; } /** - * @class - * Initializes a new instance of the WcfRelay class. - * @constructor * Description of the WCF relay resource. - * - * @member {boolean} [isDynamic] Returns true if the relay is dynamic; - * otherwise, false. - * @member {date} [createdAt] The time the WCF relay was created. - * @member {date} [updatedAt] The time the namespace was updated. - * @member {number} [listenerCount] The number of listeners for this relay. - * Note that min :1 and max:25 are supported. - * @member {string} [relayType] WCF relay type. Possible values include: - * 'NetTcp', 'Http' - * @member {boolean} [requiresClientAuthorization] Returns true if client - * authorization is needed for this relay; otherwise, false. - * @member {boolean} [requiresTransportSecurity] Returns true if transport - * security is needed for this relay; otherwise, false. - * @member {string} [userMetadata] The usermetadata is a placeholder to store - * user-defined string data for the WCF Relay endpoint. For example, it can be - * used to store descriptive data, such as list of teams and their contact - * information. Also, user-defined configuration settings can be stored. */ export interface WcfRelay extends Resource { + /** + * Returns true if the relay is dynamic; otherwise, false. + */ readonly isDynamic?: boolean; + /** + * The time the WCF relay was created. + */ readonly createdAt?: Date; + /** + * The time the namespace was updated. + */ readonly updatedAt?: Date; + /** + * The number of listeners for this relay. Note that min :1 and max:25 are supported. + */ readonly listenerCount?: number; + /** + * WCF relay type. Possible values include: 'NetTcp', 'Http' + */ relayType?: string; + /** + * Returns true if client authorization is needed for this relay; otherwise, false. + */ requiresClientAuthorization?: boolean; + /** + * Returns true if transport security is needed for this relay; otherwise, false. + */ requiresTransportSecurity?: boolean; + /** + * The userMetadata is a placeholder to store user-defined string data for the WCF Relay + * endpoint. For example, it can be used to store descriptive data, such as list of teams and + * their contact information. Also, user-defined configuration settings can be stored. + */ userMetadata?: string; } /** - * @class - * Initializes a new instance of the Sku class. - * @constructor * SKU of the namespace. - * - * @member {string} [tier] The tier of this SKU. Possible values include: - * 'Standard' */ export interface Sku { + /** + * The tier of this SKU. Possible values include: 'Standard' + */ tier?: string; } /** - * @class - * Initializes a new instance of the RelayNamespace class. - * @constructor * Description of a namespace resource. - * - * @member {object} [sku] SKU of the namespace. - * @member {string} [sku.tier] The tier of this SKU. Possible values include: - * 'Standard' - * @member {string} [provisioningState] Possible values include: 'Created', - * 'Succeeded', 'Deleted', 'Failed', 'Updating', 'Unknown' - * @member {date} [createdAt] The time the namespace was created. - * @member {date} [updatedAt] The time the namespace was updated. - * @member {string} [serviceBusEndpoint] Endpoint you can use to perform - * Service Bus operations. - * @member {string} [metricId] Identifier for Azure Insights metrics. */ export interface RelayNamespace extends TrackedResource { + /** + * SKU of the namespace. + */ sku?: Sku; + /** + * Possible values include: 'Created', 'Succeeded', 'Deleted', 'Failed', 'Updating', 'Unknown' + */ readonly provisioningState?: string; + /** + * The time the namespace was created. + */ readonly createdAt?: Date; + /** + * The time the namespace was updated. + */ readonly updatedAt?: Date; + /** + * Endpoint you can use to perform Service Bus operations. + */ readonly serviceBusEndpoint?: string; + /** + * Identifier for Azure Insights metrics. + */ readonly metricId?: string; } /** - * @class - * Initializes a new instance of the RelayUpdateParameters class. - * @constructor * Description of a namespace resource. - * - * @member {object} [sku] SKU of the namespace. - * @member {string} [sku.tier] The tier of this SKU. Possible values include: - * 'Standard' - * @member {string} [provisioningState] Possible values include: 'Created', - * 'Succeeded', 'Deleted', 'Failed', 'Updating', 'Unknown' - * @member {date} [createdAt] The time the namespace was created. - * @member {date} [updatedAt] The time the namespace was updated. - * @member {string} [serviceBusEndpoint] Endpoint you can use to perform - * Service Bus operations. - * @member {string} [metricId] Identifier for Azure Insights metrics. */ export interface RelayUpdateParameters extends ResourceNamespacePatch { + /** + * SKU of the namespace. + */ sku?: Sku; + /** + * Possible values include: 'Created', 'Succeeded', 'Deleted', 'Failed', 'Updating', 'Unknown' + */ readonly provisioningState?: string; + /** + * The time the namespace was created. + */ readonly createdAt?: Date; + /** + * The time the namespace was updated. + */ readonly updatedAt?: Date; + /** + * Endpoint you can use to perform Service Bus operations. + */ readonly serviceBusEndpoint?: string; + /** + * Identifier for Azure Insights metrics. + */ readonly metricId?: string; } /** - * @class - * Initializes a new instance of the AuthorizationRule class. - * @constructor * Description of a namespace authorization rule. - * - * @member {array} [rights] The rights associated with the rule. */ export interface AuthorizationRule extends Resource { - rights?: string[]; + /** + * The rights associated with the rule. + */ + rights: string[]; } /** - * @class - * Initializes a new instance of the AccessKeys class. - * @constructor * Namespace/Relay Connection String - * - * @member {string} [primaryConnectionString] Primary connection string of the - * created namespace authorization rule. - * @member {string} [secondaryConnectionString] Secondary connection string of - * the created namespace authorization rule. - * @member {string} [primaryKey] A base64-encoded 256-bit primary key for - * signing and validating the SAS token. - * @member {string} [secondaryKey] A base64-encoded 256-bit secondary key for - * signing and validating the SAS token. - * @member {string} [keyName] A string that describes the authorization rule. */ export interface AccessKeys { + /** + * Primary connection string of the created namespace authorization rule. + */ primaryConnectionString?: string; + /** + * Secondary connection string of the created namespace authorization rule. + */ secondaryConnectionString?: string; + /** + * A base64-encoded 256-bit primary key for signing and validating the SAS token. + */ primaryKey?: string; + /** + * A base64-encoded 256-bit secondary key for signing and validating the SAS token. + */ secondaryKey?: string; + /** + * A string that describes the authorization rule. + */ keyName?: string; } /** - * @class - * Initializes a new instance of the RegenerateAccessKeyParameters class. - * @constructor - * Parameters supplied to the regenerate authorization rule operation, - * specifies which key neeeds to be reset. - * - * @member {string} keyType The access key to regenerate. Possible values - * include: 'PrimaryKey', 'SecondaryKey' - * @member {string} [key] Optional. If the key value is provided, this is set - * to key type, or autogenerated key value set for key type. + * Parameters supplied to the regenerate authorization rule operation, specifies which key needs to + * be reset. */ export interface RegenerateAccessKeyParameters { + /** + * The access key to regenerate. Possible values include: 'PrimaryKey', 'SecondaryKey' + */ keyType: string; + /** + * Optional. If the key value is provided, this is set to key type, or autogenerated key value + * set for key type. + */ key?: string; } /** - * @class - * Initializes a new instance of the CheckNameAvailability class. - * @constructor * Description of the check name availability request properties. - * - * @member {string} name The namespace name to check for availability. The - * namespace name can contain only letters, numbers, and hyphens. The namespace - * must start with a letter, and it must end with a letter or number. */ export interface CheckNameAvailability { + /** + * The namespace name to check for availability. The namespace name can contain only letters, + * numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or + * number. + */ name: string; } /** - * @class - * Initializes a new instance of the CheckNameAvailabilityResult class. - * @constructor * Description of the check name availability request properties. - * - * @member {string} [message] The detailed info regarding the reason associated - * with the namespace. - * @member {boolean} [nameAvailable] Value indicating namespace is available. - * Returns true if the namespace is available; otherwise, false. - * @member {string} [reason] The reason for unavailability of a namespace. - * Possible values include: 'None', 'InvalidName', 'SubscriptionIsDisabled', - * 'NameInUse', 'NameInLockdown', 'TooManyNamespaceInCurrentSubscription' */ export interface CheckNameAvailabilityResult { + /** + * The detailed info regarding the reason associated with the namespace. + */ readonly message?: string; + /** + * Value indicating namespace is available. Returns true if the namespace is available; + * otherwise, false. + */ nameAvailable?: boolean; + /** + * The reason for unavailability of a namespace. Possible values include: 'None', 'InvalidName', + * 'SubscriptionIsDisabled', 'NameInUse', 'NameInLockdown', + * 'TooManyNamespaceInCurrentSubscription' + */ reason?: string; } /** - * @class - * Initializes a new instance of the OperationDisplay class. - * @constructor * The object that represents the operation. - * - * @member {string} [provider] Service provider: Relay. - * @member {string} [resource] Resource on which the operation is performed: - * Invoice, etc. - * @member {string} [operation] Operation type: Read, write, delete, etc. */ export interface OperationDisplay { + /** + * Service provider: Relay. + */ readonly provider?: string; + /** + * Resource on which the operation is performed: Invoice, etc. + */ readonly resource?: string; + /** + * Operation type: Read, write, delete, etc. + */ readonly operation?: string; } /** - * @class - * Initializes a new instance of the Operation class. - * @constructor * A Relay REST API operation. - * - * @member {string} [name] Operation name: {provider}/{resource}/{operation} - * @member {object} [display] The object that represents the operation. - * @member {string} [display.provider] Service provider: Relay. - * @member {string} [display.resource] Resource on which the operation is - * performed: Invoice, etc. - * @member {string} [display.operation] Operation type: Read, write, delete, - * etc. */ export interface Operation { + /** + * Operation name: {provider}/{resource}/{operation} + */ readonly name?: string; + /** + * The object that represents the operation. + */ display?: OperationDisplay; } /** - * @class - * Initializes a new instance of the ErrorResponse class. - * @constructor - * Error reponse indicates Relay service is not able to process the incoming - * request. The reason is provided in the error message. - * - * @member {string} [code] Error code. - * @member {string} [message] Error message indicating why the operation - * failed. + * Error response indicates Relay service is not able to process the incoming request. The reason + * is provided in the error message. */ export interface ErrorResponse { + /** + * Error code. + */ code?: string; + /** + * Error message indicating why the operation failed. + */ message?: string; } - /** - * @class - * Initializes a new instance of the OperationListResult class. - * @constructor - * Result of the request to list Relay operations. It contains a list of - * operations and a URL link to get the next set of results. - * - * @member {string} [nextLink] URL to get the next set of operation list - * results if there are any. + * Result of the request to list Relay operations. It contains a list of operations and a URL link + * to get the next set of results. */ export interface OperationListResult extends Array { + /** + * URL to get the next set of operation list results if there are any. + */ readonly nextLink?: string; } /** - * @class - * Initializes a new instance of the RelayNamespaceListResult class. - * @constructor * The response from the list namespace operation. - * - * @member {string} [nextLink] Link to the next set of results. Not empty if - * value contains incomplete list of namespaces. */ export interface RelayNamespaceListResult extends Array { + /** + * Link to the next set of results. Not empty if value contains incomplete list of namespaces. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the AuthorizationRuleListResult class. - * @constructor * The response from the list namespace operation. - * - * @member {string} [nextLink] Link to the next set of results. Not empty if - * value contains incomplete list of authorization rules. */ export interface AuthorizationRuleListResult extends Array { + /** + * Link to the next set of results. Not empty if value contains incomplete list of authorization + * rules. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the HybridConnectionListResult class. - * @constructor * The response of the list hybrid connection operation. - * - * @member {string} [nextLink] Link to the next set of results. Not empty if - * value contains incomplete list hybrid connection operation. */ export interface HybridConnectionListResult extends Array { + /** + * Link to the next set of results. Not empty if value contains incomplete list hybrid connection + * operation. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the WcfRelaysListResult class. - * @constructor * The response of the list WCF relay operation. - * - * @member {string} [nextLink] Link to the next set of results. Not empty if - * value contains incomplete list of WCF relays. */ export interface WcfRelaysListResult extends Array { + /** + * Link to the next set of results. Not empty if value contains incomplete list of WCF relays. + */ nextLink?: string; } diff --git a/lib/services/relayManagement/lib/models/operation.js b/lib/services/relayManagement/lib/models/operation.js index d7421358b7..ae1e862adc 100644 --- a/lib/services/relayManagement/lib/models/operation.js +++ b/lib/services/relayManagement/lib/models/operation.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * A Relay REST API operation. * @@ -19,13 +17,14 @@ const models = require('./index'); class Operation { /** * Create a Operation. - * @member {string} [name] Operation name: {provider}/{resource}/{operation} - * @member {object} [display] The object that represents the operation. - * @member {string} [display.provider] Service provider: Relay. - * @member {string} [display.resource] Resource on which the operation is + * @property {string} [name] Operation name: + * {provider}/{resource}/{operation} + * @property {object} [display] The object that represents the operation. + * @property {string} [display.provider] Service provider: Relay. + * @property {string} [display.resource] Resource on which the operation is * performed: Invoice, etc. - * @member {string} [display.operation] Operation type: Read, write, delete, - * etc. + * @property {string} [display.operation] Operation type: Read, write, + * delete, etc. */ constructor() { } diff --git a/lib/services/relayManagement/lib/models/operationDisplay.js b/lib/services/relayManagement/lib/models/operationDisplay.js index 52fe74f1ca..bc3cae816b 100644 --- a/lib/services/relayManagement/lib/models/operationDisplay.js +++ b/lib/services/relayManagement/lib/models/operationDisplay.js @@ -17,10 +17,10 @@ class OperationDisplay { /** * Create a OperationDisplay. - * @member {string} [provider] Service provider: Relay. - * @member {string} [resource] Resource on which the operation is performed: - * Invoice, etc. - * @member {string} [operation] Operation type: Read, write, delete, etc. + * @property {string} [provider] Service provider: Relay. + * @property {string} [resource] Resource on which the operation is + * performed: Invoice, etc. + * @property {string} [operation] Operation type: Read, write, delete, etc. */ constructor() { } diff --git a/lib/services/relayManagement/lib/models/operationListResult.js b/lib/services/relayManagement/lib/models/operationListResult.js index aa61856591..ad6ebce7f8 100644 --- a/lib/services/relayManagement/lib/models/operationListResult.js +++ b/lib/services/relayManagement/lib/models/operationListResult.js @@ -17,7 +17,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/relayManagement/lib/models/regenerateAccessKeyParameters.js b/lib/services/relayManagement/lib/models/regenerateAccessKeyParameters.js index 45b8584685..dede026b0d 100644 --- a/lib/services/relayManagement/lib/models/regenerateAccessKeyParameters.js +++ b/lib/services/relayManagement/lib/models/regenerateAccessKeyParameters.js @@ -12,16 +12,16 @@ /** * Parameters supplied to the regenerate authorization rule operation, - * specifies which key neeeds to be reset. + * specifies which key needs to be reset. * */ class RegenerateAccessKeyParameters { /** * Create a RegenerateAccessKeyParameters. - * @member {string} keyType The access key to regenerate. Possible values + * @property {string} keyType The access key to regenerate. Possible values * include: 'PrimaryKey', 'SecondaryKey' - * @member {string} [key] Optional. If the key value is provided, this is set - * to key type, or autogenerated key value set for key type. + * @property {string} [key] Optional. If the key value is provided, this is + * set to key type, or autogenerated key value set for key type. */ constructor() { } diff --git a/lib/services/relayManagement/lib/models/relayNamespace.js b/lib/services/relayManagement/lib/models/relayNamespace.js index 77b968d912..6897f96db3 100644 --- a/lib/services/relayManagement/lib/models/relayNamespace.js +++ b/lib/services/relayManagement/lib/models/relayNamespace.js @@ -20,16 +20,16 @@ const models = require('./index'); class RelayNamespace extends models['TrackedResource'] { /** * Create a RelayNamespace. - * @member {object} [sku] SKU of the namespace. - * @member {string} [sku.tier] The tier of this SKU. Possible values include: - * 'Standard' - * @member {string} [provisioningState] Possible values include: 'Created', + * @property {object} [sku] SKU of the namespace. + * @property {string} [sku.tier] The tier of this SKU. Possible values + * include: 'Standard' + * @property {string} [provisioningState] Possible values include: 'Created', * 'Succeeded', 'Deleted', 'Failed', 'Updating', 'Unknown' - * @member {date} [createdAt] The time the namespace was created. - * @member {date} [updatedAt] The time the namespace was updated. - * @member {string} [serviceBusEndpoint] Endpoint you can use to perform + * @property {date} [createdAt] The time the namespace was created. + * @property {date} [updatedAt] The time the namespace was updated. + * @property {string} [serviceBusEndpoint] Endpoint you can use to perform * Service Bus operations. - * @member {string} [metricId] Identifier for Azure Insights metrics. + * @property {string} [metricId] Identifier for Azure Insights metrics. */ constructor() { super(); diff --git a/lib/services/relayManagement/lib/models/relayNamespaceListResult.js b/lib/services/relayManagement/lib/models/relayNamespaceListResult.js index 4fb1cf62a0..c595461981 100644 --- a/lib/services/relayManagement/lib/models/relayNamespaceListResult.js +++ b/lib/services/relayManagement/lib/models/relayNamespaceListResult.js @@ -16,8 +16,8 @@ class RelayNamespaceListResult extends Array { /** * Create a RelayNamespaceListResult. - * @member {string} [nextLink] Link to the next set of results. Not empty if - * value contains incomplete list of namespaces. + * @property {string} [nextLink] Link to the next set of results. Not empty + * if value contains incomplete list of namespaces. */ constructor() { super(); diff --git a/lib/services/relayManagement/lib/models/relayUpdateParameters.js b/lib/services/relayManagement/lib/models/relayUpdateParameters.js index aeec25a3f3..4691ab755e 100644 --- a/lib/services/relayManagement/lib/models/relayUpdateParameters.js +++ b/lib/services/relayManagement/lib/models/relayUpdateParameters.js @@ -20,16 +20,16 @@ const models = require('./index'); class RelayUpdateParameters extends models['ResourceNamespacePatch'] { /** * Create a RelayUpdateParameters. - * @member {object} [sku] SKU of the namespace. - * @member {string} [sku.tier] The tier of this SKU. Possible values include: - * 'Standard' - * @member {string} [provisioningState] Possible values include: 'Created', + * @property {object} [sku] SKU of the namespace. + * @property {string} [sku.tier] The tier of this SKU. Possible values + * include: 'Standard' + * @property {string} [provisioningState] Possible values include: 'Created', * 'Succeeded', 'Deleted', 'Failed', 'Updating', 'Unknown' - * @member {date} [createdAt] The time the namespace was created. - * @member {date} [updatedAt] The time the namespace was updated. - * @member {string} [serviceBusEndpoint] Endpoint you can use to perform + * @property {date} [createdAt] The time the namespace was created. + * @property {date} [updatedAt] The time the namespace was updated. + * @property {string} [serviceBusEndpoint] Endpoint you can use to perform * Service Bus operations. - * @member {string} [metricId] Identifier for Azure Insights metrics. + * @property {string} [metricId] Identifier for Azure Insights metrics. */ constructor() { super(); diff --git a/lib/services/relayManagement/lib/models/resource.js b/lib/services/relayManagement/lib/models/resource.js index 36d31e2180..afe6f05c80 100644 --- a/lib/services/relayManagement/lib/models/resource.js +++ b/lib/services/relayManagement/lib/models/resource.js @@ -20,9 +20,9 @@ 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. + * @property {string} [id] Resource ID. + * @property {string} [name] Resource name. + * @property {string} [type] Resource type. */ constructor() { super(); diff --git a/lib/services/relayManagement/lib/models/resourceNamespacePatch.js b/lib/services/relayManagement/lib/models/resourceNamespacePatch.js index 2598417e75..4aed2791d8 100644 --- a/lib/services/relayManagement/lib/models/resourceNamespacePatch.js +++ b/lib/services/relayManagement/lib/models/resourceNamespacePatch.js @@ -20,7 +20,7 @@ const models = require('./index'); class ResourceNamespacePatch extends models['Resource'] { /** * Create a ResourceNamespacePatch. - * @member {object} [tags] Resource tags. + * @property {object} [tags] Resource tags. */ constructor() { super(); diff --git a/lib/services/relayManagement/lib/models/sku.js b/lib/services/relayManagement/lib/models/sku.js index 094b390bdd..cf972d9037 100644 --- a/lib/services/relayManagement/lib/models/sku.js +++ b/lib/services/relayManagement/lib/models/sku.js @@ -17,7 +17,7 @@ class Sku { /** * Create a Sku. - * @member {string} [tier] The tier of this SKU. Possible values include: + * @property {string} [tier] The tier of this SKU. Possible values include: * 'Standard' */ constructor() { diff --git a/lib/services/relayManagement/lib/models/trackedResource.js b/lib/services/relayManagement/lib/models/trackedResource.js index 51d35ce002..d2c4354ad6 100644 --- a/lib/services/relayManagement/lib/models/trackedResource.js +++ b/lib/services/relayManagement/lib/models/trackedResource.js @@ -20,8 +20,8 @@ const models = require('./index'); class TrackedResource extends models['Resource'] { /** * Create a TrackedResource. - * @member {string} location Resource location. - * @member {object} [tags] Resource tags. + * @property {string} location Resource location. + * @property {object} [tags] Resource tags. */ constructor() { super(); diff --git a/lib/services/relayManagement/lib/models/wcfRelay.js b/lib/services/relayManagement/lib/models/wcfRelay.js index e25aa47b94..ce093dcbb0 100644 --- a/lib/services/relayManagement/lib/models/wcfRelay.js +++ b/lib/services/relayManagement/lib/models/wcfRelay.js @@ -20,22 +20,23 @@ const models = require('./index'); class WcfRelay extends models['Resource'] { /** * Create a WcfRelay. - * @member {boolean} [isDynamic] Returns true if the relay is dynamic; + * @property {boolean} [isDynamic] Returns true if the relay is dynamic; * otherwise, false. - * @member {date} [createdAt] The time the WCF relay was created. - * @member {date} [updatedAt] The time the namespace was updated. - * @member {number} [listenerCount] The number of listeners for this relay. + * @property {date} [createdAt] The time the WCF relay was created. + * @property {date} [updatedAt] The time the namespace was updated. + * @property {number} [listenerCount] The number of listeners for this relay. * Note that min :1 and max:25 are supported. - * @member {string} [relayType] WCF relay type. Possible values include: + * @property {string} [relayType] WCF relay type. Possible values include: * 'NetTcp', 'Http' - * @member {boolean} [requiresClientAuthorization] Returns true if client + * @property {boolean} [requiresClientAuthorization] Returns true if client * authorization is needed for this relay; otherwise, false. - * @member {boolean} [requiresTransportSecurity] Returns true if transport + * @property {boolean} [requiresTransportSecurity] Returns true if transport * security is needed for this relay; otherwise, false. - * @member {string} [userMetadata] The usermetadata is a placeholder to store - * user-defined string data for the WCF Relay endpoint. For example, it can - * be used to store descriptive data, such as list of teams and their contact - * information. Also, user-defined configuration settings can be stored. + * @property {string} [userMetadata] The userMetadata is a placeholder to + * store user-defined string data for the WCF Relay endpoint. For example, it + * can be used to store descriptive data, such as list of teams and their + * contact information. Also, user-defined configuration settings can be + * stored. */ constructor() { super(); diff --git a/lib/services/relayManagement/lib/models/wcfRelaysListResult.js b/lib/services/relayManagement/lib/models/wcfRelaysListResult.js index 499b2250e7..74723780a9 100644 --- a/lib/services/relayManagement/lib/models/wcfRelaysListResult.js +++ b/lib/services/relayManagement/lib/models/wcfRelaysListResult.js @@ -16,8 +16,8 @@ class WcfRelaysListResult extends Array { /** * Create a WcfRelaysListResult. - * @member {string} [nextLink] Link to the next set of results. Not empty if - * value contains incomplete list of WCF relays. + * @property {string} [nextLink] Link to the next set of results. Not empty + * if value contains incomplete list of WCF relays. */ constructor() { super(); diff --git a/lib/services/relayManagement/lib/operations/hybridConnections.js b/lib/services/relayManagement/lib/operations/hybridConnections.js index b47570a26a..4f783b9a74 100644 --- a/lib/services/relayManagement/lib/operations/hybridConnections.js +++ b/lib/services/relayManagement/lib/operations/hybridConnections.js @@ -199,7 +199,7 @@ function _listByNamespace(resourceGroupName, namespaceName, options, callback) { * @param {boolean} [parameters.requiresClientAuthorization] Returns true if * client authorization is needed for this hybrid connection; otherwise, false. * - * @param {string} [parameters.userMetadata] The usermetadata is a placeholder + * @param {string} [parameters.userMetadata] The userMetadata is a placeholder * to store user-defined string data for the hybrid connection endpoint. For * example, it can be used to store descriptive data, such as a list of teams * and their contact information. Also, user-defined configuration settings can @@ -925,7 +925,7 @@ function _listAuthorizationRules(resourceGroupName, namespaceName, hybridConnect * * @param {object} parameters The authorization rule parameters. * - * @param {array} [parameters.rights] The rights associated with the rule. + * @param {array} parameters.rights The rights associated with the rule. * * @param {object} [options] Optional Parameters. * @@ -2282,7 +2282,7 @@ class HybridConnections { * @param {boolean} [parameters.requiresClientAuthorization] Returns true if * client authorization is needed for this hybrid connection; otherwise, false. * - * @param {string} [parameters.userMetadata] The usermetadata is a placeholder + * @param {string} [parameters.userMetadata] The userMetadata is a placeholder * to store user-defined string data for the hybrid connection endpoint. For * example, it can be used to store descriptive data, such as a list of teams * and their contact information. Also, user-defined configuration settings can @@ -2330,7 +2330,7 @@ class HybridConnections { * @param {boolean} [parameters.requiresClientAuthorization] Returns true if * client authorization is needed for this hybrid connection; otherwise, false. * - * @param {string} [parameters.userMetadata] The usermetadata is a placeholder + * @param {string} [parameters.userMetadata] The userMetadata is a placeholder * to store user-defined string data for the hybrid connection endpoint. For * example, it can be used to store descriptive data, such as a list of teams * and their contact information. Also, user-defined configuration settings can @@ -2673,7 +2673,7 @@ class HybridConnections { * * @param {object} parameters The authorization rule parameters. * - * @param {array} [parameters.rights] The rights associated with the rule. + * @param {array} parameters.rights The rights associated with the rule. * * @param {object} [options] Optional Parameters. * @@ -2714,7 +2714,7 @@ class HybridConnections { * * @param {object} parameters The authorization rule parameters. * - * @param {array} [parameters.rights] The rights associated with the rule. + * @param {array} parameters.rights The rights associated with the rule. * * @param {object} [options] Optional Parameters. * diff --git a/lib/services/relayManagement/lib/operations/index.d.ts b/lib/services/relayManagement/lib/operations/index.d.ts index 5ddaac4d25..f5d1997c79 100644 --- a/lib/services/relayManagement/lib/operations/index.d.ts +++ b/lib/services/relayManagement/lib/operations/index.d.ts @@ -681,7 +681,7 @@ export interface Namespaces { * * @param {object} parameters The authorization rule parameters. * - * @param {array} [parameters.rights] The rights associated with the rule. + * @param {array} parameters.rights The rights associated with the rule. * * @param {object} [options] Optional Parameters. * @@ -708,7 +708,7 @@ export interface Namespaces { * * @param {object} parameters The authorization rule parameters. * - * @param {array} [parameters.rights] The rights associated with the rule. + * @param {array} parameters.rights The rights associated with the rule. * * @param {object} [options] Optional Parameters. * @@ -1430,7 +1430,7 @@ export interface HybridConnections { * @param {boolean} [parameters.requiresClientAuthorization] Returns true if * client authorization is needed for this hybrid connection; otherwise, false. * - * @param {string} [parameters.userMetadata] The usermetadata is a placeholder + * @param {string} [parameters.userMetadata] The userMetadata is a placeholder * to store user-defined string data for the hybrid connection endpoint. For * example, it can be used to store descriptive data, such as a list of teams * and their contact information. Also, user-defined configuration settings can @@ -1466,7 +1466,7 @@ export interface HybridConnections { * @param {boolean} [parameters.requiresClientAuthorization] Returns true if * client authorization is needed for this hybrid connection; otherwise, false. * - * @param {string} [parameters.userMetadata] The usermetadata is a placeholder + * @param {string} [parameters.userMetadata] The userMetadata is a placeholder * to store user-defined string data for the hybrid connection endpoint. For * example, it can be used to store descriptive data, such as a list of teams * and their contact information. Also, user-defined configuration settings can @@ -1713,7 +1713,7 @@ export interface HybridConnections { * * @param {object} parameters The authorization rule parameters. * - * @param {array} [parameters.rights] The rights associated with the rule. + * @param {array} parameters.rights The rights associated with the rule. * * @param {object} [options] Optional Parameters. * @@ -1742,7 +1742,7 @@ export interface HybridConnections { * * @param {object} parameters The authorization rule parameters. * - * @param {array} [parameters.rights] The rights associated with the rule. + * @param {array} parameters.rights The rights associated with the rule. * * @param {object} [options] Optional Parameters. * @@ -2278,7 +2278,7 @@ export interface WCFRelays { * @param {boolean} [parameters.requiresTransportSecurity] Returns true if * transport security is needed for this relay; otherwise, false. * - * @param {string} [parameters.userMetadata] The usermetadata is a placeholder + * @param {string} [parameters.userMetadata] The userMetadata is a placeholder * to store user-defined string data for the WCF Relay endpoint. For example, * it can be used to store descriptive data, such as list of teams and their * contact information. Also, user-defined configuration settings can be @@ -2318,7 +2318,7 @@ export interface WCFRelays { * @param {boolean} [parameters.requiresTransportSecurity] Returns true if * transport security is needed for this relay; otherwise, false. * - * @param {string} [parameters.userMetadata] The usermetadata is a placeholder + * @param {string} [parameters.userMetadata] The userMetadata is a placeholder * to store user-defined string data for the WCF Relay endpoint. For example, * it can be used to store descriptive data, such as list of teams and their * contact information. Also, user-defined configuration settings can be @@ -2565,7 +2565,7 @@ export interface WCFRelays { * * @param {object} parameters The authorization rule parameters. * - * @param {array} [parameters.rights] The rights associated with the rule. + * @param {array} parameters.rights The rights associated with the rule. * * @param {object} [options] Optional Parameters. * @@ -2594,7 +2594,7 @@ export interface WCFRelays { * * @param {object} parameters The authorization rule parameters. * - * @param {array} [parameters.rights] The rights associated with the rule. + * @param {array} parameters.rights The rights associated with the rule. * * @param {object} [options] Optional Parameters. * diff --git a/lib/services/relayManagement/lib/operations/namespaces.js b/lib/services/relayManagement/lib/operations/namespaces.js index 43c9bda0d0..2664e80e3b 100644 --- a/lib/services/relayManagement/lib/operations/namespaces.js +++ b/lib/services/relayManagement/lib/operations/namespaces.js @@ -1180,7 +1180,7 @@ function _listAuthorizationRules(resourceGroupName, namespaceName, options, call * * @param {object} parameters The authorization rule parameters. * - * @param {array} [parameters.rights] The rights associated with the rule. + * @param {array} parameters.rights The rights associated with the rule. * * @param {object} [options] Optional Parameters. * @@ -3634,7 +3634,7 @@ class Namespaces { * * @param {object} parameters The authorization rule parameters. * - * @param {array} [parameters.rights] The rights associated with the rule. + * @param {array} parameters.rights The rights associated with the rule. * * @param {object} [options] Optional Parameters. * @@ -3673,7 +3673,7 @@ class Namespaces { * * @param {object} parameters The authorization rule parameters. * - * @param {array} [parameters.rights] The rights associated with the rule. + * @param {array} parameters.rights The rights associated with the rule. * * @param {object} [options] Optional Parameters. * diff --git a/lib/services/relayManagement/lib/operations/wCFRelays.js b/lib/services/relayManagement/lib/operations/wCFRelays.js index 9adf76aece..6878fd2eae 100644 --- a/lib/services/relayManagement/lib/operations/wCFRelays.js +++ b/lib/services/relayManagement/lib/operations/wCFRelays.js @@ -202,7 +202,7 @@ function _listByNamespace(resourceGroupName, namespaceName, options, callback) { * @param {boolean} [parameters.requiresTransportSecurity] Returns true if * transport security is needed for this relay; otherwise, false. * - * @param {string} [parameters.userMetadata] The usermetadata is a placeholder + * @param {string} [parameters.userMetadata] The userMetadata is a placeholder * to store user-defined string data for the WCF Relay endpoint. For example, * it can be used to store descriptive data, such as list of teams and their * contact information. Also, user-defined configuration settings can be @@ -927,7 +927,7 @@ function _listAuthorizationRules(resourceGroupName, namespaceName, relayName, op * * @param {object} parameters The authorization rule parameters. * - * @param {array} [parameters.rights] The rights associated with the rule. + * @param {array} parameters.rights The rights associated with the rule. * * @param {object} [options] Optional Parameters. * @@ -2284,7 +2284,7 @@ class WCFRelays { * @param {boolean} [parameters.requiresTransportSecurity] Returns true if * transport security is needed for this relay; otherwise, false. * - * @param {string} [parameters.userMetadata] The usermetadata is a placeholder + * @param {string} [parameters.userMetadata] The userMetadata is a placeholder * to store user-defined string data for the WCF Relay endpoint. For example, * it can be used to store descriptive data, such as list of teams and their * contact information. Also, user-defined configuration settings can be @@ -2336,7 +2336,7 @@ class WCFRelays { * @param {boolean} [parameters.requiresTransportSecurity] Returns true if * transport security is needed for this relay; otherwise, false. * - * @param {string} [parameters.userMetadata] The usermetadata is a placeholder + * @param {string} [parameters.userMetadata] The userMetadata is a placeholder * to store user-defined string data for the WCF Relay endpoint. For example, * it can be used to store descriptive data, such as list of teams and their * contact information. Also, user-defined configuration settings can be @@ -2679,7 +2679,7 @@ class WCFRelays { * * @param {object} parameters The authorization rule parameters. * - * @param {array} [parameters.rights] The rights associated with the rule. + * @param {array} parameters.rights The rights associated with the rule. * * @param {object} [options] Optional Parameters. * @@ -2720,7 +2720,7 @@ class WCFRelays { * * @param {object} parameters The authorization rule parameters. * - * @param {array} [parameters.rights] The rights associated with the rule. + * @param {array} parameters.rights The rights associated with the rule. * * @param {object} [options] Optional Parameters. * diff --git a/lib/services/relayManagement/lib/relayManagementClient.d.ts b/lib/services/relayManagement/lib/relayManagementClient.d.ts index b38258b429..f891bcc617 100644 --- a/lib/services/relayManagement/lib/relayManagementClient.d.ts +++ b/lib/services/relayManagement/lib/relayManagementClient.d.ts @@ -10,9 +10,10 @@ import { ServiceClientCredentials } from 'ms-rest'; import { AzureServiceClient, AzureServiceClientOptions } from 'ms-rest-azure'; +import * as models from "./models"; import * as operations from "./operations"; -declare class RelayManagementClient extends AzureServiceClient { +export default class RelayManagementClient extends AzureServiceClient { /** * Initializes a new instance of the RelayManagementClient class. * @constructor @@ -33,11 +34,11 @@ declare class RelayManagementClient extends AzureServiceClient { * * @param {boolean} [options.noRetryPolicy] - If set to true, turn off default retry policy * - * @param {string} [options.acceptLanguage] - Gets or sets the preferred language for the response. + * @param {string} [options.acceptLanguage] - The preferred language for the response. * - * @param {number} [options.longRunningOperationRetryTimeout] - Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30. + * @param {number} [options.longRunningOperationRetryTimeout] - The retry timeout in seconds for Long Running Operations. Default value is 30. * - * @param {boolean} [options.generateClientRequestId] - When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. + * @param {boolean} [options.generateClientRequestId] - Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. * */ constructor(credentials: ServiceClientCredentials, subscriptionId: string, baseUri?: string, options?: AzureServiceClientOptions); @@ -61,4 +62,4 @@ declare class RelayManagementClient extends AzureServiceClient { wCFRelays: operations.WCFRelays; } -export = RelayManagementClient; +export { RelayManagementClient, models as RelayManagementModels }; diff --git a/lib/services/relayManagement/lib/relayManagementClient.js b/lib/services/relayManagement/lib/relayManagementClient.js index a2dad8dfcf..4f93af4b1d 100644 --- a/lib/services/relayManagement/lib/relayManagementClient.js +++ b/lib/services/relayManagement/lib/relayManagementClient.js @@ -34,9 +34,9 @@ class RelayManagementClient extends ServiceClient { * @param {object} [options.requestOptions] - Options for the underlying request object * {@link https://github.com/request/request#requestoptions-callback Options doc} * @param {boolean} [options.noRetryPolicy] - If set to true, turn off default retry policy - * @param {string} [options.acceptLanguage] - Gets or sets the preferred language for the response. - * @param {number} [options.longRunningOperationRetryTimeout] - Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30. - * @param {boolean} [options.generateClientRequestId] - When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. + * @param {string} [options.acceptLanguage] - The preferred language for the response. + * @param {number} [options.longRunningOperationRetryTimeout] - The retry timeout in seconds for Long Running Operations. Default value is 30. + * @param {boolean} [options.generateClientRequestId] - Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. */ constructor(credentials, subscriptionId, baseUri, options) { if (credentials === null || credentials === undefined) { @@ -83,3 +83,6 @@ class RelayManagementClient extends ServiceClient { } module.exports = RelayManagementClient; +module.exports['default'] = RelayManagementClient; +module.exports.RelayManagementClient = RelayManagementClient; +module.exports.RelayManagementModels = models; diff --git a/lib/services/relayManagement/package.json b/lib/services/relayManagement/package.json index f025fa8518..5c6acbd8b0 100644 --- a/lib/services/relayManagement/package.json +++ b/lib/services/relayManagement/package.json @@ -1,35 +1,25 @@ { "name": "azure-arm-relay", "author": "Microsoft Corporation", - "contributors": [ - "Sayyed, Zeeshan " - ], + "description": "RelayManagementClient Library with typescript type definitions for node", "version": "2.1.0-preview", - "description": "Microsoft Azure Relay Management Client Library for node", - "tags": [ - "azure", - "sdk" - ], + "dependencies": { + "ms-rest": "^2.3.3", + "ms-rest-azure": "^2.5.5" + }, "keywords": [ "node", "azure" ], + "license": "MIT", "main": "./lib/relayManagementClient.js", "types": "./lib/relayManagementClient.d.ts", - "license": "MIT", - "dependencies": { - "ms-rest": "^2.2.2", - "ms-rest-azure": "^2.3.3" - }, - "homepage": "http://github.com/Azure/azure-sdk-for-node", + "homepage": "https://github.com/azure/azure-sdk-for-node/tree/master/lib/services/relayManagement", "repository": { "type": "git", - "url": "git@github.com:Azure/azure-sdk-for-node.git" + "url": "https://github.com/azure/azure-sdk-for-node.git" }, "bugs": { - "url": "http://github.com/Azure/azure-sdk-for-node/issues" - }, - "scripts": { - "test": "npm -s run-script jshint" + "url": "https://github.com/azure/azure-sdk-for-node/issues" } -} \ No newline at end of file +}