diff --git a/lib/services/frontdoorManagement/LICENSE.txt b/lib/services/frontdoorManagement/LICENSE.txt index a70e8cf660..5431ba98b9 100644 --- a/lib/services/frontdoorManagement/LICENSE.txt +++ b/lib/services/frontdoorManagement/LICENSE.txt @@ -1,21 +1,21 @@ -The MIT License (MIT) - -Copyright (c) 2018 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. +The MIT License (MIT) + +Copyright (c) 2018 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/frontdoorManagement/README.md b/lib/services/frontdoorManagement/README.md index ff5fb6f394..e72e25b833 100644 --- a/lib/services/frontdoorManagement/README.md +++ b/lib/services/frontdoorManagement/README.md @@ -1,40 +1,41 @@ ---- -uid: azure-arm-frontdoor -summary: *content - ---- -# Microsoft Azure SDK for Node.js - FrontDoorManagementClient -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-frontdoor -``` - -## How to use - -### Authentication, client creation and list frontDoors as an example. - -```javascript -const msRestAzure = require("ms-rest-azure"); -const FrontDoorManagementClient = require("azure-arm-frontdoor"); -msRestAzure.interactiveLogin().then((creds) => { - const subscriptionId = ""; - const client = new FrontDoorManagementClient(creds, subscriptionId); - return client.frontDoors.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) +--- +uid: azure-arm-frontdoor +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 - FrontDoorManagementClient +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-frontdoor +``` + +### How to use + +#### Authentication, client creation and list frontDoors as an example. + +```javascript +const msRestAzure = require("ms-rest-azure"); +const FrontDoorManagementClient = require("azure-arm-frontdoor"); +msRestAzure.interactiveLogin().then((creds) => { + const subscriptionId = ""; + const client = new FrontDoorManagementClient(creds, subscriptionId); + return client.frontDoors.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/frontdoorManagement/lib/models/azureAsyncOperationResult.js b/lib/services/frontdoorManagement/lib/models/azureAsyncOperationResult.js index 4870803217..7f6d7a5d49 100644 --- a/lib/services/frontdoorManagement/lib/models/azureAsyncOperationResult.js +++ b/lib/services/frontdoorManagement/lib/models/azureAsyncOperationResult.js @@ -24,15 +24,15 @@ class AzureAsyncOperationResult { /** * Create a AzureAsyncOperationResult. - * @member {string} [status] Status of the Azure async operation. Possible + * @property {string} [status] Status of the Azure async operation. Possible * values are: 'InProgress', 'Succeeded', and 'Failed'. Possible values * include: 'InProgress', 'Succeeded', 'Failed' - * @member {object} [error] - * @member {string} [error.code] - * @member {string} [error.message] - * @member {string} [error.target] - * @member {array} [error.details] - * @member {string} [error.innerError] + * @property {object} [error] + * @property {string} [error.code] + * @property {string} [error.message] + * @property {string} [error.target] + * @property {array} [error.details] + * @property {string} [error.innerError] */ constructor() { } diff --git a/lib/services/frontdoorManagement/lib/models/azureManagedOverrideRuleGroup.js b/lib/services/frontdoorManagement/lib/models/azureManagedOverrideRuleGroup.js index 57d51bc2ad..77bab5f9b7 100644 --- a/lib/services/frontdoorManagement/lib/models/azureManagedOverrideRuleGroup.js +++ b/lib/services/frontdoorManagement/lib/models/azureManagedOverrideRuleGroup.js @@ -17,10 +17,10 @@ class AzureManagedOverrideRuleGroup { /** * Create a AzureManagedOverrideRuleGroup. - * @member {string} ruleGroupOverride Describes overrideruleGroup. Possible - * values include: 'SqlInjection', 'XSS' - * @member {string} action Type of Actions. Possible values include: 'Allow', - * 'Block', 'Log' + * @property {string} ruleGroupOverride Describes override rule group. + * Possible values include: 'SqlInjection', 'XSS' + * @property {string} action Type of Actions. Possible values include: + * 'Allow', 'Block', 'Log' */ constructor() { } diff --git a/lib/services/frontdoorManagement/lib/models/azureManagedRuleSet.js b/lib/services/frontdoorManagement/lib/models/azureManagedRuleSet.js index 97b5305923..6c36f5b957 100644 --- a/lib/services/frontdoorManagement/lib/models/azureManagedRuleSet.js +++ b/lib/services/frontdoorManagement/lib/models/azureManagedRuleSet.js @@ -20,7 +20,7 @@ const models = require('./index'); class AzureManagedRuleSet extends models['ManagedRuleSet'] { /** * Create a AzureManagedRuleSet. - * @member {array} [ruleGroupOverrides] List of azure managed provider + * @property {array} [ruleGroupOverrides] List of azure managed provider * override configuration (optional) */ constructor() { diff --git a/lib/services/frontdoorManagement/lib/models/backend.js b/lib/services/frontdoorManagement/lib/models/backend.js index a20e8a4083..9eb98025db 100644 --- a/lib/services/frontdoorManagement/lib/models/backend.js +++ b/lib/services/frontdoorManagement/lib/models/backend.js @@ -17,20 +17,20 @@ class Backend { /** * Create a Backend. - * @member {string} [address] Location of the backend (IP address or FQDN) - * @member {number} [httpPort] The HTTP TCP port number. Must be between 1 + * @property {string} [address] Location of the backend (IP address or FQDN) + * @property {number} [httpPort] The HTTP TCP port number. Must be between 1 * and 65535. - * @member {number} [httpsPort] The HTTPS TCP port number. Must be between 1 - * and 65535. - * @member {string} [enabledState] Whether to enable use of this backend. + * @property {number} [httpsPort] The HTTPS TCP port number. Must be between + * 1 and 65535. + * @property {string} [enabledState] Whether to enable use of this backend. * Permitted values are 'Enabled' or 'Disabled'. Possible values include: * 'Enabled', 'Disabled' - * @member {number} [priority] Priority to use for load balancing. Higher + * @property {number} [priority] Priority to use for load balancing. Higher * priorities will not be used for load balancing if any lower priority * backend is healthy. - * @member {number} [weight] Weight of this endpoint for load balancing + * @property {number} [weight] Weight of this endpoint for load balancing * purposes. - * @member {string} [backendHostHeader] The value to use as the host header + * @property {string} [backendHostHeader] The value to use as the host header * sent to the backend. If blank or unspecified, this defaults to the * incoming host. */ diff --git a/lib/services/frontdoorManagement/lib/models/backendPool.js b/lib/services/frontdoorManagement/lib/models/backendPool.js index f7ff8a02f2..5aeec2c638 100644 --- a/lib/services/frontdoorManagement/lib/models/backendPool.js +++ b/lib/services/frontdoorManagement/lib/models/backendPool.js @@ -20,17 +20,18 @@ const models = require('./index'); class BackendPool extends models['SubResource'] { /** * Create a BackendPool. - * @member {array} [backends] The set of backends for this pool - * @member {object} [loadBalancingSettings] Load balancing settings for a + * @property {array} [backends] The set of backends for this pool + * @property {object} [loadBalancingSettings] Load balancing settings for a * backend pool - * @member {string} [loadBalancingSettings.id] Resource ID. - * @member {object} [healthProbeSettings] L7 health probe settings for a + * @property {string} [loadBalancingSettings.id] Resource ID. + * @property {object} [healthProbeSettings] L7 health probe settings for a * backend pool - * @member {string} [healthProbeSettings.id] Resource ID. - * @member {string} [resourceState] Resource status. Possible values include: - * 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', 'Deleting' - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. + * @property {string} [healthProbeSettings.id] Resource ID. + * @property {string} [resourceState] Resource status. Possible values + * include: 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', + * 'Deleting' + * @property {string} [name] Resource name. + * @property {string} [type] Resource type. */ constructor() { super(); diff --git a/lib/services/frontdoorManagement/lib/models/backendPoolListResult.js b/lib/services/frontdoorManagement/lib/models/backendPoolListResult.js index 4d77352f50..d1635bf6f5 100644 --- a/lib/services/frontdoorManagement/lib/models/backendPoolListResult.js +++ b/lib/services/frontdoorManagement/lib/models/backendPoolListResult.js @@ -12,13 +12,13 @@ /** * Result of the request to list Backend Pools. It contains a list of Backend - * Pools objects and a URL link to get the the next set of results. + * Pools objects and a URL link to get the next set of results. */ class BackendPoolListResult extends Array { /** * Create a BackendPoolListResult. - * @member {string} [nextLink] URL to get the next set of BackendPool objects - * if there are any. + * @property {string} [nextLink] URL to get the next set of BackendPool + * objects if there are any. */ constructor() { super(); diff --git a/lib/services/frontdoorManagement/lib/models/backendPoolUpdateParameters.js b/lib/services/frontdoorManagement/lib/models/backendPoolUpdateParameters.js index f812b39aa7..7c20bdc91d 100644 --- a/lib/services/frontdoorManagement/lib/models/backendPoolUpdateParameters.js +++ b/lib/services/frontdoorManagement/lib/models/backendPoolUpdateParameters.js @@ -17,13 +17,13 @@ class BackendPoolUpdateParameters { /** * Create a BackendPoolUpdateParameters. - * @member {array} [backends] The set of backends for this pool - * @member {object} [loadBalancingSettings] Load balancing settings for a + * @property {array} [backends] The set of backends for this pool + * @property {object} [loadBalancingSettings] Load balancing settings for a * backend pool - * @member {string} [loadBalancingSettings.id] Resource ID. - * @member {object} [healthProbeSettings] L7 health probe settings for a + * @property {string} [loadBalancingSettings.id] Resource ID. + * @property {object} [healthProbeSettings] L7 health probe settings for a * backend pool - * @member {string} [healthProbeSettings.id] Resource ID. + * @property {string} [healthProbeSettings.id] Resource ID. */ constructor() { } diff --git a/lib/services/frontdoorManagement/lib/models/cacheConfiguration.js b/lib/services/frontdoorManagement/lib/models/cacheConfiguration.js index 198afe5622..36217493d2 100644 --- a/lib/services/frontdoorManagement/lib/models/cacheConfiguration.js +++ b/lib/services/frontdoorManagement/lib/models/cacheConfiguration.js @@ -18,10 +18,10 @@ class CacheConfiguration { /** * Create a CacheConfiguration. - * @member {string} [queryParameterStripDirective] Treatment of URL query + * @property {string} [queryParameterStripDirective] Treatment of URL query * terms when forming the cache key. Possible values include: 'StripNone', * 'StripAll' - * @member {string} [dynamicCompression] Whether to use dynamic compression + * @property {string} [dynamicCompression] Whether to use dynamic compression * for cached content. Possible values include: 'Enabled', 'Disabled' */ constructor() { diff --git a/lib/services/frontdoorManagement/lib/models/checkNameAvailabilityInput.js b/lib/services/frontdoorManagement/lib/models/checkNameAvailabilityInput.js index a3108083d2..a68f49cf36 100644 --- a/lib/services/frontdoorManagement/lib/models/checkNameAvailabilityInput.js +++ b/lib/services/frontdoorManagement/lib/models/checkNameAvailabilityInput.js @@ -17,8 +17,8 @@ class CheckNameAvailabilityInput { /** * Create a CheckNameAvailabilityInput. - * @member {string} name The resource name to validate. - * @member {string} type The type of the resource whose name is to be + * @property {string} name The resource name to validate. + * @property {string} type The type of the resource whose name is to be * validated. Possible values include: 'Microsoft.Network/frontDoors', * 'Microsoft.Network/frontDoors/frontendEndpoints' */ diff --git a/lib/services/frontdoorManagement/lib/models/checkNameAvailabilityOutput.js b/lib/services/frontdoorManagement/lib/models/checkNameAvailabilityOutput.js index 7699b34c79..dcc5696bc3 100644 --- a/lib/services/frontdoorManagement/lib/models/checkNameAvailabilityOutput.js +++ b/lib/services/frontdoorManagement/lib/models/checkNameAvailabilityOutput.js @@ -17,10 +17,10 @@ class CheckNameAvailabilityOutput { /** * Create a CheckNameAvailabilityOutput. - * @member {string} [nameAvailability] Indicates whether the name is + * @property {string} [nameAvailability] Indicates whether the name is * available. Possible values include: 'Available', 'Unavailable' - * @member {string} [reason] The reason why the name is not available. - * @member {string} [message] The detailed error message describing why the + * @property {string} [reason] The reason why the name is not available. + * @property {string} [message] The detailed error message describing why the * name is not available. */ constructor() { diff --git a/lib/services/frontdoorManagement/lib/models/customHttpsConfiguration.js b/lib/services/frontdoorManagement/lib/models/customHttpsConfiguration.js index 6efe7fe9fe..4f6bec0b63 100644 --- a/lib/services/frontdoorManagement/lib/models/customHttpsConfiguration.js +++ b/lib/services/frontdoorManagement/lib/models/customHttpsConfiguration.js @@ -17,17 +17,18 @@ class CustomHttpsConfiguration { /** * Create a CustomHttpsConfiguration. - * @member {string} [certificateSource] Defines the source of the SSL + * @property {string} [certificateSource] Defines the source of the SSL * certificate. Possible values include: 'AzureKeyVault', 'FrontDoor' - * @member {string} [protocolType] Defines the TLS extension protocol that is - * used for secure delivery. Possible values include: 'ServerNameIndication' - * @member {object} [vault] The Key Vault containing the SSL certificate - * @member {string} [vault.id] Resource ID. - * @member {string} [secretName] The name of the Key Vault secret + * @property {string} [protocolType] Defines the TLS extension protocol that + * is used for secure delivery. Possible values include: + * 'ServerNameIndication' + * @property {object} [vault] The Key Vault containing the SSL certificate + * @property {string} [vault.id] Resource ID. + * @property {string} [secretName] The name of the Key Vault secret * representing the full certificate PFX - * @member {string} [secretVersion] The version of the Key Vault secret + * @property {string} [secretVersion] The version of the Key Vault secret * representing the full certificate PFX - * @member {string} [certificateType] Defines the type of the certificate + * @property {string} [certificateType] Defines the type of the certificate * used for secure connections to a frontendEndpoint. Possible values * include: 'Dedicated' */ diff --git a/lib/services/frontdoorManagement/lib/models/customRule.js b/lib/services/frontdoorManagement/lib/models/customRule.js index 1276b3f49a..ffc68b74fa 100644 --- a/lib/services/frontdoorManagement/lib/models/customRule.js +++ b/lib/services/frontdoorManagement/lib/models/customRule.js @@ -17,21 +17,21 @@ class CustomRule { /** * Create a CustomRule. - * @member {string} [name] Gets name of the resource that is unique within a - * policy. This name can be used to access the resource. - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [name] Gets name of the resource that is unique within + * a policy. This name can be used to access the resource. + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. - * @member {number} priority Describes priority of the rule. Rules with a + * @property {number} priority Describes priority of the rule. Rules with a * lower value will be evaluated before rules with a higher value - * @member {string} ruleType Describes type of rule. Possible values include: - * 'MatchRule', 'RateLimitRule' - * @member {number} [rateLimitDurationInMinutes] Defines rate limit duration. - * Default - 1 minute - * @member {number} [rateLimitThreshold] Defines rate limit thresold - * @member {array} matchConditions List of match conditions - * @member {string} action Type of Actions. Possible values include: 'Allow', - * 'Block', 'Log' - * @member {array} [transforms] List of transforms + * @property {string} ruleType Describes type of rule. Possible values + * include: 'MatchRule', 'RateLimitRule' + * @property {number} [rateLimitDurationInMinutes] Defines rate limit + * duration. Default - 1 minute + * @property {number} [rateLimitThreshold] Defines rate limit threshold + * @property {array} matchConditions List of match conditions + * @property {string} action Type of Actions. Possible values include: + * 'Allow', 'Block', 'Log' + * @property {array} [transforms] List of transforms */ constructor() { } diff --git a/lib/services/frontdoorManagement/lib/models/customRules.js b/lib/services/frontdoorManagement/lib/models/customRules.js index 90cbc888df..2ba009138b 100644 --- a/lib/services/frontdoorManagement/lib/models/customRules.js +++ b/lib/services/frontdoorManagement/lib/models/customRules.js @@ -17,7 +17,7 @@ class CustomRules { /** * Create a CustomRules. - * @member {array} [rules] List of rules + * @property {array} [rules] List of rules */ constructor() { } diff --git a/lib/services/frontdoorManagement/lib/models/errorDetails.js b/lib/services/frontdoorManagement/lib/models/errorDetails.js index fcac88503a..7393f66139 100644 --- a/lib/services/frontdoorManagement/lib/models/errorDetails.js +++ b/lib/services/frontdoorManagement/lib/models/errorDetails.js @@ -16,9 +16,9 @@ class ErrorDetails { /** * Create a ErrorDetails. - * @member {string} [code] - * @member {string} [target] - * @member {string} [message] + * @property {string} [code] + * @property {string} [target] + * @property {string} [message] */ constructor() { } diff --git a/lib/services/frontdoorManagement/lib/models/errorModel.js b/lib/services/frontdoorManagement/lib/models/errorModel.js index 955cde1528..6ef42630b7 100644 --- a/lib/services/frontdoorManagement/lib/models/errorModel.js +++ b/lib/services/frontdoorManagement/lib/models/errorModel.js @@ -16,11 +16,11 @@ class ErrorModel { /** * Create a ErrorModel. - * @member {string} [code] - * @member {string} [message] - * @member {string} [target] - * @member {array} [details] - * @member {string} [innerError] + * @property {string} [code] + * @property {string} [message] + * @property {string} [target] + * @property {array} [details] + * @property {string} [innerError] */ constructor() { } diff --git a/lib/services/frontdoorManagement/lib/models/errorResponse.js b/lib/services/frontdoorManagement/lib/models/errorResponse.js index f7411b7340..7277f3bb5d 100644 --- a/lib/services/frontdoorManagement/lib/models/errorResponse.js +++ b/lib/services/frontdoorManagement/lib/models/errorResponse.js @@ -11,15 +11,15 @@ 'use strict'; /** - * Error reponse indicates Front Door service is not able to process the + * Error response indicates Front Door 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/frontdoorManagement/lib/models/frontDoor.js b/lib/services/frontdoorManagement/lib/models/frontDoor.js index 90c3366037..371180f0fb 100644 --- a/lib/services/frontdoorManagement/lib/models/frontDoor.js +++ b/lib/services/frontdoorManagement/lib/models/frontDoor.js @@ -21,24 +21,25 @@ const models = require('./index'); class FrontDoor extends models['Resource'] { /** * Create a FrontDoor. - * @member {string} [friendlyName] A friendly name for the frontDoor - * @member {array} [routingRules] Routing rules associated with this Front + * @property {string} [friendlyName] A friendly name for the frontDoor + * @property {array} [routingRules] Routing rules associated with this Front * Door. - * @member {array} [loadBalancingSettings] Load balancing settings associated + * @property {array} [loadBalancingSettings] Load balancing settings + * associated with this Front Door instance. + * @property {array} [healthProbeSettings] Health probe settings associated * with this Front Door instance. - * @member {array} [healthProbeSettings] Health probe settings associated - * with this Front Door instance. - * @member {array} [backendPools] Backend pools available to routing rules. - * @member {array} [frontendEndpoints] Frontend endpoints available to + * @property {array} [backendPools] Backend pools available to routing rules. + * @property {array} [frontendEndpoints] Frontend endpoints available to * routing rules. - * @member {string} [enabledState] Operational status of the Front Door load - * balancer. Permitted values are 'Enabled' or 'Disabled'. Possible values - * include: 'Enabled', 'Disabled' - * @member {string} [resourceState] Resource status of the Front Door. + * @property {string} [enabledState] Operational status of the Front Door + * load balancer. Permitted values are 'Enabled' or 'Disabled'. Possible + * values include: 'Enabled', 'Disabled' + * @property {string} [resourceState] Resource status of the Front Door. * Possible values include: 'Creating', 'Enabling', 'Enabled', 'Disabling', * 'Disabled', 'Deleting' - * @member {string} [provisioningState] Provisioning state of the Front Door. - * @member {string} [cname] The host that each frontendEndpoint must CNAME + * @property {string} [provisioningState] Provisioning state of the Front + * Door. + * @property {string} [cname] The host that each frontendEndpoint must CNAME * to. */ constructor() { diff --git a/lib/services/frontdoorManagement/lib/models/frontDoorListResult.js b/lib/services/frontdoorManagement/lib/models/frontDoorListResult.js index d719fd6e2e..7e24b70138 100644 --- a/lib/services/frontdoorManagement/lib/models/frontDoorListResult.js +++ b/lib/services/frontdoorManagement/lib/models/frontDoorListResult.js @@ -12,13 +12,13 @@ /** * Result of the request to list Front Doors. It contains a list of Front Door - * objects and a URL link to get the the next set of results. + * objects and a URL link to get the next set of results. */ class FrontDoorListResult extends Array { /** * Create a FrontDoorListResult. - * @member {string} [nextLink] URL to get the next set of Front Door objects - * if there are any. + * @property {string} [nextLink] URL to get the next set of Front Door + * objects if there are any. */ constructor() { super(); diff --git a/lib/services/frontdoorManagement/lib/models/frontDoorUpdateParameters.js b/lib/services/frontdoorManagement/lib/models/frontDoorUpdateParameters.js index f6dd2a0426..9fc5dcd53a 100644 --- a/lib/services/frontdoorManagement/lib/models/frontDoorUpdateParameters.js +++ b/lib/services/frontdoorManagement/lib/models/frontDoorUpdateParameters.js @@ -17,19 +17,19 @@ class FrontDoorUpdateParameters { /** * Create a FrontDoorUpdateParameters. - * @member {string} [friendlyName] A friendly name for the frontDoor - * @member {array} [routingRules] Routing rules associated with this Front + * @property {string} [friendlyName] A friendly name for the frontDoor + * @property {array} [routingRules] Routing rules associated with this Front * Door. - * @member {array} [loadBalancingSettings] Load balancing settings associated + * @property {array} [loadBalancingSettings] Load balancing settings + * associated with this Front Door instance. + * @property {array} [healthProbeSettings] Health probe settings associated * with this Front Door instance. - * @member {array} [healthProbeSettings] Health probe settings associated - * with this Front Door instance. - * @member {array} [backendPools] Backend pools available to routing rules. - * @member {array} [frontendEndpoints] Frontend endpoints available to + * @property {array} [backendPools] Backend pools available to routing rules. + * @property {array} [frontendEndpoints] Frontend endpoints available to * routing rules. - * @member {string} [enabledState] Operational status of the Front Door load - * balancer. Permitted values are 'Enabled' or 'Disabled'. Possible values - * include: 'Enabled', 'Disabled' + * @property {string} [enabledState] Operational status of the Front Door + * load balancer. Permitted values are 'Enabled' or 'Disabled'. Possible + * values include: 'Enabled', 'Disabled' */ constructor() { } diff --git a/lib/services/frontdoorManagement/lib/models/frontendEndpoint.js b/lib/services/frontdoorManagement/lib/models/frontendEndpoint.js index d4cd4f4d82..eb8df59aea 100644 --- a/lib/services/frontdoorManagement/lib/models/frontendEndpoint.js +++ b/lib/services/frontdoorManagement/lib/models/frontendEndpoint.js @@ -20,22 +20,23 @@ const models = require('./index'); class FrontendEndpoint extends models['SubResource'] { /** * Create a FrontendEndpoint. - * @member {string} [hostName] The host name of the frontendEndpoint. Must be - * a domain name. - * @member {string} [sessionAffinityEnabledState] Whether to allow session + * @property {string} [hostName] The host name of the frontendEndpoint. Must + * be a domain name. + * @property {string} [sessionAffinityEnabledState] Whether to allow session * affinity on this host. Valid options are 'Enabled' or 'Disabled'. Possible * values include: 'Enabled', 'Disabled' - * @member {number} [sessionAffinityTtlSeconds] UNUSED. This field will be + * @property {number} [sessionAffinityTtlSeconds] UNUSED. This field will be * ignored. The TTL to use in seconds for session affinity, if applicable. - * @member {object} [webApplicationFirewallPolicyLink] Defines the Web + * @property {object} [webApplicationFirewallPolicyLink] Defines the Web * Application Firewall policy for each host (if applicable) - * @member {string} [webApplicationFirewallPolicyLink.id] Resource ID. - * @member {string} [resourceState] Resource status. Possible values include: - * 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', 'Deleting' - * @member {string} [customHttpsProvisioningState] Provisioning status of + * @property {string} [webApplicationFirewallPolicyLink.id] Resource ID. + * @property {string} [resourceState] Resource status. Possible values + * include: 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', + * 'Deleting' + * @property {string} [customHttpsProvisioningState] Provisioning status of * Custom Https of the frontendEndpoint. Possible values include: 'Enabling', * 'Enabled', 'Disabling', 'Disabled', 'Failed' - * @member {string} [customHttpsProvisioningSubstate] Provisioning substate + * @property {string} [customHttpsProvisioningSubstate] Provisioning substate * shows the progress of custom HTTPS enabling/disabling process step by * step. Possible values include: 'SubmittingDomainControlValidationRequest', * 'PendingDomainControlValidationREquestApproval', @@ -44,26 +45,26 @@ class FrontendEndpoint extends models['SubResource'] { * 'DomainControlValidationRequestTimedOut', 'IssuingCertificate', * 'DeployingCertificate', 'CertificateDeployed', 'DeletingCertificate', * 'CertificateDeleted' - * @member {object} [customHttpsConfiguration] The configuration specifying + * @property {object} [customHttpsConfiguration] The configuration specifying * how to enable HTTPS - * @member {string} [customHttpsConfiguration.certificateSource] Defines the - * source of the SSL certificate. Possible values include: 'AzureKeyVault', - * 'FrontDoor' - * @member {string} [customHttpsConfiguration.protocolType] Defines the TLS + * @property {string} [customHttpsConfiguration.certificateSource] Defines + * the source of the SSL certificate. Possible values include: + * 'AzureKeyVault', 'FrontDoor' + * @property {string} [customHttpsConfiguration.protocolType] Defines the TLS * extension protocol that is used for secure delivery. Possible values * include: 'ServerNameIndication' - * @member {object} [customHttpsConfiguration.vault] The Key Vault containing - * the SSL certificate - * @member {string} [customHttpsConfiguration.vault.id] Resource ID. - * @member {string} [customHttpsConfiguration.secretName] The name of the Key - * Vault secret representing the full certificate PFX - * @member {string} [customHttpsConfiguration.secretVersion] The version of + * @property {object} [customHttpsConfiguration.vault] The Key Vault + * containing the SSL certificate + * @property {string} [customHttpsConfiguration.vault.id] Resource ID. + * @property {string} [customHttpsConfiguration.secretName] The name of the + * Key Vault secret representing the full certificate PFX + * @property {string} [customHttpsConfiguration.secretVersion] The version of * the Key Vault secret representing the full certificate PFX - * @member {string} [customHttpsConfiguration.certificateType] Defines the + * @property {string} [customHttpsConfiguration.certificateType] Defines the * type of the certificate used for secure connections to a frontendEndpoint. * Possible values include: 'Dedicated' - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. + * @property {string} [name] Resource name. + * @property {string} [type] Resource type. */ constructor() { super(); diff --git a/lib/services/frontdoorManagement/lib/models/frontendEndpointUpdateParameters.js b/lib/services/frontdoorManagement/lib/models/frontendEndpointUpdateParameters.js index 4661f6aed1..cb81e5faca 100644 --- a/lib/services/frontdoorManagement/lib/models/frontendEndpointUpdateParameters.js +++ b/lib/services/frontdoorManagement/lib/models/frontendEndpointUpdateParameters.js @@ -17,16 +17,16 @@ class FrontendEndpointUpdateParameters { /** * Create a FrontendEndpointUpdateParameters. - * @member {string} [hostName] The host name of the frontendEndpoint. Must be - * a domain name. - * @member {string} [sessionAffinityEnabledState] Whether to allow session + * @property {string} [hostName] The host name of the frontendEndpoint. Must + * be a domain name. + * @property {string} [sessionAffinityEnabledState] Whether to allow session * affinity on this host. Valid options are 'Enabled' or 'Disabled'. Possible * values include: 'Enabled', 'Disabled' - * @member {number} [sessionAffinityTtlSeconds] UNUSED. This field will be + * @property {number} [sessionAffinityTtlSeconds] UNUSED. This field will be * ignored. The TTL to use in seconds for session affinity, if applicable. - * @member {object} [webApplicationFirewallPolicyLink] Defines the Web + * @property {object} [webApplicationFirewallPolicyLink] Defines the Web * Application Firewall policy for each host (if applicable) - * @member {string} [webApplicationFirewallPolicyLink.id] Resource ID. + * @property {string} [webApplicationFirewallPolicyLink.id] Resource ID. */ constructor() { } diff --git a/lib/services/frontdoorManagement/lib/models/frontendEndpointUpdateParametersWebApplicationFirewallPolicyLink.js b/lib/services/frontdoorManagement/lib/models/frontendEndpointUpdateParametersWebApplicationFirewallPolicyLink.js index 3fa1e51455..17f6c065ec 100644 --- a/lib/services/frontdoorManagement/lib/models/frontendEndpointUpdateParametersWebApplicationFirewallPolicyLink.js +++ b/lib/services/frontdoorManagement/lib/models/frontendEndpointUpdateParametersWebApplicationFirewallPolicyLink.js @@ -17,7 +17,7 @@ class FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink { /** * Create a FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink. - * @member {string} [id] Resource ID. + * @property {string} [id] Resource ID. */ constructor() { } diff --git a/lib/services/frontdoorManagement/lib/models/frontendEndpointsListResult.js b/lib/services/frontdoorManagement/lib/models/frontendEndpointsListResult.js index 381bdce9c5..3c9a9b8d6d 100644 --- a/lib/services/frontdoorManagement/lib/models/frontendEndpointsListResult.js +++ b/lib/services/frontdoorManagement/lib/models/frontendEndpointsListResult.js @@ -12,13 +12,13 @@ /** * Result of the request to list frontend endpoints. It contains a list of - * Frontend endpoint objects and a URL link to get the the next set of results. + * Frontend endpoint objects and a URL link to get the next set of results. */ class FrontendEndpointsListResult extends Array { /** * Create a FrontendEndpointsListResult. - * @member {string} [nextLink] URL to get the next set of frontend endpoints - * if there are any. + * @property {string} [nextLink] URL to get the next set of frontend + * endpoints if there are any. */ constructor() { super(); diff --git a/lib/services/frontdoorManagement/lib/models/healthProbeSettingsListResult.js b/lib/services/frontdoorManagement/lib/models/healthProbeSettingsListResult.js index 6449669558..926ec93975 100644 --- a/lib/services/frontdoorManagement/lib/models/healthProbeSettingsListResult.js +++ b/lib/services/frontdoorManagement/lib/models/healthProbeSettingsListResult.js @@ -12,14 +12,13 @@ /** * Result of the request to list HealthProbeSettings. It contains a list of - * HealthProbeSettings objects and a URL link to get the the next set of - * results. + * HealthProbeSettings objects and a URL link to get the next set of results. */ class HealthProbeSettingsListResult extends Array { /** * Create a HealthProbeSettingsListResult. - * @member {string} [nextLink] URL to get the next set of HealthProbeSettings - * objects if there are any. + * @property {string} [nextLink] URL to get the next set of + * HealthProbeSettings objects if there are any. */ constructor() { super(); diff --git a/lib/services/frontdoorManagement/lib/models/healthProbeSettingsModel.js b/lib/services/frontdoorManagement/lib/models/healthProbeSettingsModel.js index 551e3d35b2..ce2068c453 100644 --- a/lib/services/frontdoorManagement/lib/models/healthProbeSettingsModel.js +++ b/lib/services/frontdoorManagement/lib/models/healthProbeSettingsModel.js @@ -20,15 +20,17 @@ const models = require('./index'); class HealthProbeSettingsModel extends models['SubResource'] { /** * Create a HealthProbeSettingsModel. - * @member {string} [path] The path to use for the health probe. Default is / - * @member {string} [protocol] Protocol scheme to use for this probe. + * @property {string} [path] The path to use for the health probe. Default is + * / + * @property {string} [protocol] Protocol scheme to use for this probe. * Possible values include: 'Http', 'Https' - * @member {number} [intervalInSeconds] The number of seconds between health - * probes. - * @member {string} [resourceState] Resource status. Possible values include: - * 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', 'Deleting' - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. + * @property {number} [intervalInSeconds] The number of seconds between + * health probes. + * @property {string} [resourceState] Resource status. Possible values + * include: 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', + * 'Deleting' + * @property {string} [name] Resource name. + * @property {string} [type] Resource type. */ constructor() { super(); diff --git a/lib/services/frontdoorManagement/lib/models/healthProbeSettingsUpdateParameters.js b/lib/services/frontdoorManagement/lib/models/healthProbeSettingsUpdateParameters.js index 6c87904add..b526599c9d 100644 --- a/lib/services/frontdoorManagement/lib/models/healthProbeSettingsUpdateParameters.js +++ b/lib/services/frontdoorManagement/lib/models/healthProbeSettingsUpdateParameters.js @@ -17,11 +17,12 @@ class HealthProbeSettingsUpdateParameters { /** * Create a HealthProbeSettingsUpdateParameters. - * @member {string} [path] The path to use for the health probe. Default is / - * @member {string} [protocol] Protocol scheme to use for this probe. + * @property {string} [path] The path to use for the health probe. Default is + * / + * @property {string} [protocol] Protocol scheme to use for this probe. * Possible values include: 'Http', 'Https' - * @member {number} [intervalInSeconds] The number of seconds between health - * probes. + * @property {number} [intervalInSeconds] The number of seconds between + * health probes. */ constructor() { } diff --git a/lib/services/frontdoorManagement/lib/models/index.d.ts b/lib/services/frontdoorManagement/lib/models/index.d.ts index 78bf28e1b7..41b301bb15 100644 --- a/lib/services/frontdoorManagement/lib/models/index.d.ts +++ b/lib/services/frontdoorManagement/lib/models/index.d.ts @@ -1,656 +1,661 @@ /* * 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 * Common resource representation. - * - * @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. */ export interface Resource extends BaseResource { + /** + * Resource ID. + */ readonly id?: string; + /** + * Resource name. + */ readonly name?: string; + /** + * Resource type. + */ readonly type?: string; + /** + * Resource location. + */ location?: string; + /** + * Resource tags. + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the FrontDoor class. - * @constructor - * Front Door represents a collection of backend endpoints to route traffic to - * along with rules that specify how traffic is sent there. - * - * @member {string} [friendlyName] A friendly name for the frontDoor - * @member {array} [routingRules] Routing rules associated with this Front - * Door. - * @member {array} [loadBalancingSettings] Load balancing settings associated - * with this Front Door instance. - * @member {array} [healthProbeSettings] Health probe settings associated with - * this Front Door instance. - * @member {array} [backendPools] Backend pools available to routing rules. - * @member {array} [frontendEndpoints] Frontend endpoints available to routing - * rules. - * @member {string} [enabledState] Operational status of the Front Door load - * balancer. Permitted values are 'Enabled' or 'Disabled'. Possible values - * include: 'Enabled', 'Disabled' - * @member {string} [resourceState] Resource status of the Front Door. Possible - * values include: 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', - * 'Deleting' - * @member {string} [provisioningState] Provisioning state of the Front Door. - * @member {string} [cname] The host that each frontendEndpoint must CNAME to. + * Front Door represents a collection of backend endpoints to route traffic to along with rules + * that specify how traffic is sent there. */ export interface FrontDoor extends Resource { + /** + * A friendly name for the frontDoor + */ friendlyName?: string; + /** + * Routing rules associated with this Front Door. + */ routingRules?: RoutingRule[]; + /** + * Load balancing settings associated with this Front Door instance. + */ loadBalancingSettings?: LoadBalancingSettingsModel[]; + /** + * Health probe settings associated with this Front Door instance. + */ healthProbeSettings?: HealthProbeSettingsModel[]; + /** + * Backend pools available to routing rules. + */ backendPools?: BackendPool[]; + /** + * Frontend endpoints available to routing rules. + */ frontendEndpoints?: FrontendEndpoint[]; + /** + * Operational status of the Front Door load balancer. Permitted values are 'Enabled' or + * 'Disabled'. Possible values include: 'Enabled', 'Disabled' + */ enabledState?: string; + /** + * Resource status of the Front Door. Possible values include: 'Creating', 'Enabling', 'Enabled', + * 'Disabling', 'Disabled', 'Deleting' + */ resourceState?: string; + /** + * Provisioning state of the Front Door. + */ readonly provisioningState?: string; + /** + * The host that each frontendEndpoint must CNAME to. + */ readonly cname?: string; } /** - * @class - * Initializes a new instance of the SubResource class. - * @constructor * Reference to another subresource. - * - * @member {string} [id] Resource ID. */ export interface SubResource extends BaseResource { + /** + * Resource ID. + */ id?: string; } /** - * @class - * Initializes a new instance of the RoutingRule class. - * @constructor - * A routing rule represents a specification for traffic to treat and where to - * send it, along with health probe information. - * - * @member {array} [frontendEndpoints] Frontend endpoints associated with this - * rule - * @member {array} [acceptedProtocols] Protocol schemes to match for this rule - * @member {array} [patternsToMatch] The route patterns of the rule. - * @member {string} [customForwardingPath] A custom path used to rewrite - * resource paths matched by this rule. Leave empty to use incoming path. - * @member {string} [forwardingProtocol] Protocol this rule will use when - * forwarding traffic to backends. Possible values include: 'HttpOnly', - * 'HttpsOnly', 'MatchRequest' - * @member {object} [cacheConfiguration] The caching configuration associated - * with this rule. - * @member {string} [cacheConfiguration.queryParameterStripDirective] Treatment - * of URL query terms when forming the cache key. Possible values include: - * 'StripNone', 'StripAll' - * @member {string} [cacheConfiguration.dynamicCompression] Whether to use - * dynamic compression for cached content. Possible values include: 'Enabled', - * 'Disabled' - * @member {object} [backendPool] A reference to the BackendPool which this - * rule routes to. - * @member {string} [backendPool.id] Resource ID. - * @member {string} [enabledState] Whether to enable use of this rule. - * Permitted values are 'Enabled' or 'Disabled'. Possible values include: - * 'Enabled', 'Disabled' - * @member {string} [resourceState] Resource status. Possible values include: - * 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', 'Deleting' - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. + * A routing rule represents a specification for traffic to treat and where to send it, along with + * health probe information. */ export interface RoutingRule extends SubResource { + /** + * Frontend endpoints associated with this rule + */ frontendEndpoints?: SubResource[]; + /** + * Protocol schemes to match for this rule + */ acceptedProtocols?: string[]; + /** + * The route patterns of the rule. + */ patternsToMatch?: string[]; + /** + * A custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming + * path. + */ customForwardingPath?: string; + /** + * Protocol this rule will use when forwarding traffic to backends. Possible values include: + * 'HttpOnly', 'HttpsOnly', 'MatchRequest' + */ forwardingProtocol?: string; + /** + * The caching configuration associated with this rule. + */ cacheConfiguration?: CacheConfiguration; + /** + * A reference to the BackendPool which this rule routes to. + */ backendPool?: SubResource; + /** + * Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Possible + * values include: 'Enabled', 'Disabled' + */ enabledState?: string; + /** + * Resource status. Possible values include: 'Creating', 'Enabling', 'Enabled', 'Disabling', + * 'Disabled', 'Deleting' + */ resourceState?: string; + /** + * Resource name. + */ name?: string; + /** + * Resource type. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the LoadBalancingSettingsModel class. - * @constructor * Load balancing settings for a backend pool - * - * @member {number} [sampleSize] The number of samples to consider for load - * balancing decisions - * @member {number} [successfulSamplesRequired] The number of samples within - * the sample period that must succeed - * @member {number} [additionalLatencyMilliseconds] The additional latency in - * milliseconds for probes to fall into the lowest latency bucket - * @member {string} [resourceState] Resource status. Possible values include: - * 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', 'Deleting' - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. */ export interface LoadBalancingSettingsModel extends SubResource { + /** + * The number of samples to consider for load balancing decisions + */ sampleSize?: number; + /** + * The number of samples within the sample period that must succeed + */ successfulSamplesRequired?: number; + /** + * The additional latency in milliseconds for probes to fall into the lowest latency bucket + */ additionalLatencyMilliseconds?: number; + /** + * Resource status. Possible values include: 'Creating', 'Enabling', 'Enabled', 'Disabling', + * 'Disabled', 'Deleting' + */ resourceState?: string; + /** + * Resource name. + */ name?: string; + /** + * Resource type. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the HealthProbeSettingsModel class. - * @constructor * Load balancing settings for a backend pool - * - * @member {string} [path] The path to use for the health probe. Default is / - * @member {string} [protocol] Protocol scheme to use for this probe. Possible - * values include: 'Http', 'Https' - * @member {number} [intervalInSeconds] The number of seconds between health - * probes. - * @member {string} [resourceState] Resource status. Possible values include: - * 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', 'Deleting' - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. */ export interface HealthProbeSettingsModel extends SubResource { + /** + * The path to use for the health probe. Default is / + */ path?: string; + /** + * Protocol scheme to use for this probe. Possible values include: 'Http', 'Https' + */ protocol?: string; + /** + * The number of seconds between health probes. + */ intervalInSeconds?: number; + /** + * Resource status. Possible values include: 'Creating', 'Enabling', 'Enabled', 'Disabling', + * 'Disabled', 'Deleting' + */ resourceState?: string; + /** + * Resource name. + */ name?: string; + /** + * Resource type. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the BackendPool class. - * @constructor * A backend pool is a collection of backends that can be routed to. - * - * @member {array} [backends] The set of backends for this pool - * @member {object} [loadBalancingSettings] Load balancing settings for a - * backend pool - * @member {string} [loadBalancingSettings.id] Resource ID. - * @member {object} [healthProbeSettings] L7 health probe settings for a - * backend pool - * @member {string} [healthProbeSettings.id] Resource ID. - * @member {string} [resourceState] Resource status. Possible values include: - * 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', 'Deleting' - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. */ export interface BackendPool extends SubResource { + /** + * The set of backends for this pool + */ backends?: Backend[]; + /** + * Load balancing settings for a backend pool + */ loadBalancingSettings?: SubResource; + /** + * L7 health probe settings for a backend pool + */ healthProbeSettings?: SubResource; + /** + * Resource status. Possible values include: 'Creating', 'Enabling', 'Enabled', 'Disabling', + * 'Disabled', 'Deleting' + */ resourceState?: string; + /** + * Resource name. + */ name?: string; + /** + * Resource type. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the KeyVaultCertificateSourceParametersVault class. - * @constructor * The Key Vault containing the SSL certificate - * - * @member {string} [id] Resource ID. */ export interface KeyVaultCertificateSourceParametersVault { + /** + * Resource ID. + */ id?: string; } /** - * @class - * Initializes a new instance of the CustomHttpsConfiguration class. - * @constructor * Https settings for a domain - * - * @member {string} [certificateSource] Defines the source of the SSL - * certificate. Possible values include: 'AzureKeyVault', 'FrontDoor' - * @member {string} [protocolType] Defines the TLS extension protocol that is - * used for secure delivery. Possible values include: 'ServerNameIndication' - * @member {object} [vault] The Key Vault containing the SSL certificate - * @member {string} [vault.id] Resource ID. - * @member {string} [secretName] The name of the Key Vault secret representing - * the full certificate PFX - * @member {string} [secretVersion] The version of the Key Vault secret - * representing the full certificate PFX - * @member {string} [certificateType] Defines the type of the certificate used - * for secure connections to a frontendEndpoint. Possible values include: - * 'Dedicated' */ export interface CustomHttpsConfiguration { + /** + * Defines the source of the SSL certificate. Possible values include: 'AzureKeyVault', + * 'FrontDoor' + */ certificateSource?: string; + /** + * Defines the TLS extension protocol that is used for secure delivery. Possible values include: + * 'ServerNameIndication' + */ protocolType?: string; + /** + * The Key Vault containing the SSL certificate + */ vault?: KeyVaultCertificateSourceParametersVault; + /** + * The name of the Key Vault secret representing the full certificate PFX + */ secretName?: string; + /** + * The version of the Key Vault secret representing the full certificate PFX + */ secretVersion?: string; + /** + * Defines the type of the certificate used for secure connections to a frontendEndpoint. + * Possible values include: 'Dedicated' + */ certificateType?: string; } /** - * @class - * Initializes a new instance of the FrontendEndpoint class. - * @constructor * A frontend endpoint used for routing. - * - * @member {string} [hostName] The host name of the frontendEndpoint. Must be a - * domain name. - * @member {string} [sessionAffinityEnabledState] Whether to allow session - * affinity on this host. Valid options are 'Enabled' or 'Disabled'. Possible - * values include: 'Enabled', 'Disabled' - * @member {number} [sessionAffinityTtlSeconds] UNUSED. This field will be - * ignored. The TTL to use in seconds for session affinity, if applicable. - * @member {object} [webApplicationFirewallPolicyLink] Defines the Web - * Application Firewall policy for each host (if applicable) - * @member {string} [webApplicationFirewallPolicyLink.id] Resource ID. - * @member {string} [resourceState] Resource status. Possible values include: - * 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', 'Deleting' - * @member {string} [customHttpsProvisioningState] Provisioning status of - * Custom Https of the frontendEndpoint. Possible values include: 'Enabling', - * 'Enabled', 'Disabling', 'Disabled', 'Failed' - * @member {string} [customHttpsProvisioningSubstate] Provisioning substate - * shows the progress of custom HTTPS enabling/disabling process step by step. - * Possible values include: 'SubmittingDomainControlValidationRequest', - * 'PendingDomainControlValidationREquestApproval', - * 'DomainControlValidationRequestApproved', - * 'DomainControlValidationRequestRejected', - * 'DomainControlValidationRequestTimedOut', 'IssuingCertificate', - * 'DeployingCertificate', 'CertificateDeployed', 'DeletingCertificate', - * 'CertificateDeleted' - * @member {object} [customHttpsConfiguration] The configuration specifying how - * to enable HTTPS - * @member {string} [customHttpsConfiguration.certificateSource] Defines the - * source of the SSL certificate. Possible values include: 'AzureKeyVault', - * 'FrontDoor' - * @member {string} [customHttpsConfiguration.protocolType] Defines the TLS - * extension protocol that is used for secure delivery. Possible values - * include: 'ServerNameIndication' - * @member {object} [customHttpsConfiguration.vault] The Key Vault containing - * the SSL certificate - * @member {string} [customHttpsConfiguration.vault.id] Resource ID. - * @member {string} [customHttpsConfiguration.secretName] The name of the Key - * Vault secret representing the full certificate PFX - * @member {string} [customHttpsConfiguration.secretVersion] The version of the - * Key Vault secret representing the full certificate PFX - * @member {string} [customHttpsConfiguration.certificateType] Defines the type - * of the certificate used for secure connections to a frontendEndpoint. - * Possible values include: 'Dedicated' - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. */ export interface FrontendEndpoint extends SubResource { + /** + * The host name of the frontendEndpoint. Must be a domain name. + */ hostName?: string; + /** + * Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'. + * Possible values include: 'Enabled', 'Disabled' + */ sessionAffinityEnabledState?: string; + /** + * UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if + * applicable. + */ sessionAffinityTtlSeconds?: number; + /** + * Defines the Web Application Firewall policy for each host (if applicable) + */ webApplicationFirewallPolicyLink?: FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink; + /** + * Resource status. Possible values include: 'Creating', 'Enabling', 'Enabled', 'Disabling', + * 'Disabled', 'Deleting' + */ resourceState?: string; + /** + * Provisioning status of Custom Https of the frontendEndpoint. Possible values include: + * 'Enabling', 'Enabled', 'Disabling', 'Disabled', 'Failed' + */ readonly customHttpsProvisioningState?: string; + /** + * Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by + * step. Possible values include: 'SubmittingDomainControlValidationRequest', + * 'PendingDomainControlValidationREquestApproval', 'DomainControlValidationRequestApproved', + * 'DomainControlValidationRequestRejected', 'DomainControlValidationRequestTimedOut', + * 'IssuingCertificate', 'DeployingCertificate', 'CertificateDeployed', 'DeletingCertificate', + * 'CertificateDeleted' + */ readonly customHttpsProvisioningSubstate?: string; + /** + * The configuration specifying how to enable HTTPS + */ readonly customHttpsConfiguration?: CustomHttpsConfiguration; + /** + * Resource name. + */ name?: string; + /** + * Resource type. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the FrontDoorUpdateParameters class. - * @constructor * The properties needed to update a Front Door - * - * @member {string} [friendlyName] A friendly name for the frontDoor - * @member {array} [routingRules] Routing rules associated with this Front - * Door. - * @member {array} [loadBalancingSettings] Load balancing settings associated - * with this Front Door instance. - * @member {array} [healthProbeSettings] Health probe settings associated with - * this Front Door instance. - * @member {array} [backendPools] Backend pools available to routing rules. - * @member {array} [frontendEndpoints] Frontend endpoints available to routing - * rules. - * @member {string} [enabledState] Operational status of the Front Door load - * balancer. Permitted values are 'Enabled' or 'Disabled'. Possible values - * include: 'Enabled', 'Disabled' */ export interface FrontDoorUpdateParameters { + /** + * A friendly name for the frontDoor + */ friendlyName?: string; + /** + * Routing rules associated with this Front Door. + */ routingRules?: RoutingRule[]; + /** + * Load balancing settings associated with this Front Door instance. + */ loadBalancingSettings?: LoadBalancingSettingsModel[]; + /** + * Health probe settings associated with this Front Door instance. + */ healthProbeSettings?: HealthProbeSettingsModel[]; + /** + * Backend pools available to routing rules. + */ backendPools?: BackendPool[]; + /** + * Frontend endpoints available to routing rules. + */ frontendEndpoints?: FrontendEndpoint[]; + /** + * Operational status of the Front Door load balancer. Permitted values are 'Enabled' or + * 'Disabled'. Possible values include: 'Enabled', 'Disabled' + */ enabledState?: string; } /** - * @class - * Initializes a new instance of the PurgeParameters class. - * @constructor * Parameters required for content purge. - * - * @member {array} contentPaths The path to the content to be purged. Can - * describe a file path or a wild card directory. */ export interface PurgeParameters { + /** + * The path to the content to be purged. Can describe a file path or a wild card directory. + */ contentPaths: string[]; } /** - * @class - * Initializes a new instance of the CacheConfiguration class. - * @constructor - * Caching settings for a caching-type route. To disable caching, do not - * provide a cacheConfiguration object. - * - * @member {string} [queryParameterStripDirective] Treatment of URL query terms - * when forming the cache key. Possible values include: 'StripNone', 'StripAll' - * @member {string} [dynamicCompression] Whether to use dynamic compression for - * cached content. Possible values include: 'Enabled', 'Disabled' + * Caching settings for a caching-type route. To disable caching, do not provide a + * cacheConfiguration object. */ export interface CacheConfiguration { + /** + * Treatment of URL query terms when forming the cache key. Possible values include: 'StripNone', + * 'StripAll' + */ queryParameterStripDirective?: string; + /** + * Whether to use dynamic compression for cached content. Possible values include: 'Enabled', + * 'Disabled' + */ dynamicCompression?: string; } /** - * @class - * Initializes a new instance of the RoutingRuleUpdateParameters class. - * @constructor * Routing rules to apply to an endpoint - * - * @member {array} [frontendEndpoints] Frontend endpoints associated with this - * rule - * @member {array} [acceptedProtocols] Protocol schemes to match for this rule - * @member {array} [patternsToMatch] The route patterns of the rule. - * @member {string} [customForwardingPath] A custom path used to rewrite - * resource paths matched by this rule. Leave empty to use incoming path. - * @member {string} [forwardingProtocol] Protocol this rule will use when - * forwarding traffic to backends. Possible values include: 'HttpOnly', - * 'HttpsOnly', 'MatchRequest' - * @member {object} [cacheConfiguration] The caching configuration associated - * with this rule. - * @member {string} [cacheConfiguration.queryParameterStripDirective] Treatment - * of URL query terms when forming the cache key. Possible values include: - * 'StripNone', 'StripAll' - * @member {string} [cacheConfiguration.dynamicCompression] Whether to use - * dynamic compression for cached content. Possible values include: 'Enabled', - * 'Disabled' - * @member {object} [backendPool] A reference to the BackendPool which this - * rule routes to. - * @member {string} [backendPool.id] Resource ID. - * @member {string} [enabledState] Whether to enable use of this rule. - * Permitted values are 'Enabled' or 'Disabled'. Possible values include: - * 'Enabled', 'Disabled' */ export interface RoutingRuleUpdateParameters { + /** + * Frontend endpoints associated with this rule + */ frontendEndpoints?: SubResource[]; + /** + * Protocol schemes to match for this rule + */ acceptedProtocols?: string[]; + /** + * The route patterns of the rule. + */ patternsToMatch?: string[]; + /** + * A custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming + * path. + */ customForwardingPath?: string; + /** + * Protocol this rule will use when forwarding traffic to backends. Possible values include: + * 'HttpOnly', 'HttpsOnly', 'MatchRequest' + */ forwardingProtocol?: string; + /** + * The caching configuration associated with this rule. + */ cacheConfiguration?: CacheConfiguration; + /** + * A reference to the BackendPool which this rule routes to. + */ backendPool?: SubResource; + /** + * Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Possible + * values include: 'Enabled', 'Disabled' + */ enabledState?: string; } /** - * @class - * Initializes a new instance of the Backend class. - * @constructor * Backend address of a frontDoor load balancer. - * - * @member {string} [address] Location of the backend (IP address or FQDN) - * @member {number} [httpPort] The HTTP TCP port number. Must be between 1 and - * 65535. - * @member {number} [httpsPort] The HTTPS TCP port number. Must be between 1 - * and 65535. - * @member {string} [enabledState] Whether to enable use of this backend. - * Permitted values are 'Enabled' or 'Disabled'. Possible values include: - * 'Enabled', 'Disabled' - * @member {number} [priority] Priority to use for load balancing. Higher - * priorities will not be used for load balancing if any lower priority backend - * is healthy. - * @member {number} [weight] Weight of this endpoint for load balancing - * purposes. - * @member {string} [backendHostHeader] The value to use as the host header - * sent to the backend. If blank or unspecified, this defaults to the incoming - * host. */ export interface Backend { + /** + * Location of the backend (IP address or FQDN) + */ address?: string; + /** + * The HTTP TCP port number. Must be between 1 and 65535. + */ httpPort?: number; + /** + * The HTTPS TCP port number. Must be between 1 and 65535. + */ httpsPort?: number; + /** + * Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled'. Possible + * values include: 'Enabled', 'Disabled' + */ enabledState?: string; + /** + * Priority to use for load balancing. Higher priorities will not be used for load balancing if + * any lower priority backend is healthy. + */ priority?: number; + /** + * Weight of this endpoint for load balancing purposes. + */ weight?: number; + /** + * The value to use as the host header sent to the backend. If blank or unspecified, this + * defaults to the incoming host. + */ backendHostHeader?: string; } /** - * @class - * Initializes a new instance of the LoadBalancingSettingsUpdateParameters class. - * @constructor * Round-Robin load balancing settings for a backend pool - * - * @member {number} [sampleSize] The number of samples to consider for load - * balancing decisions - * @member {number} [successfulSamplesRequired] The number of samples within - * the sample period that must succeed - * @member {number} [additionalLatencyMilliseconds] The additional latency in - * milliseconds for probes to fall into the lowest latency bucket */ export interface LoadBalancingSettingsUpdateParameters { + /** + * The number of samples to consider for load balancing decisions + */ sampleSize?: number; + /** + * The number of samples within the sample period that must succeed + */ successfulSamplesRequired?: number; + /** + * The additional latency in milliseconds for probes to fall into the lowest latency bucket + */ additionalLatencyMilliseconds?: number; } /** - * @class - * Initializes a new instance of the HealthProbeSettingsUpdateParameters class. - * @constructor * L7 health probe settings for a backend pool - * - * @member {string} [path] The path to use for the health probe. Default is / - * @member {string} [protocol] Protocol scheme to use for this probe. Possible - * values include: 'Http', 'Https' - * @member {number} [intervalInSeconds] The number of seconds between health - * probes. */ export interface HealthProbeSettingsUpdateParameters { + /** + * The path to use for the health probe. Default is / + */ path?: string; + /** + * Protocol scheme to use for this probe. Possible values include: 'Http', 'Https' + */ protocol?: string; + /** + * The number of seconds between health probes. + */ intervalInSeconds?: number; } /** - * @class - * Initializes a new instance of the BackendPoolUpdateParameters class. - * @constructor * A collection of backends that can be routed to. - * - * @member {array} [backends] The set of backends for this pool - * @member {object} [loadBalancingSettings] Load balancing settings for a - * backend pool - * @member {string} [loadBalancingSettings.id] Resource ID. - * @member {object} [healthProbeSettings] L7 health probe settings for a - * backend pool - * @member {string} [healthProbeSettings.id] Resource ID. */ export interface BackendPoolUpdateParameters { + /** + * The set of backends for this pool + */ backends?: Backend[]; + /** + * Load balancing settings for a backend pool + */ loadBalancingSettings?: SubResource; + /** + * L7 health probe settings for a backend pool + */ healthProbeSettings?: SubResource; } /** - * @class - * Initializes a new instance of the FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink class. - * @constructor * Defines the Web Application Firewall policy for each host (if applicable) - * - * @member {string} [id] Resource ID. */ export interface FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink { + /** + * Resource ID. + */ id?: string; } /** - * @class - * Initializes a new instance of the FrontendEndpointUpdateParameters class. - * @constructor * Frontend endpoint used in routing rule - * - * @member {string} [hostName] The host name of the frontendEndpoint. Must be a - * domain name. - * @member {string} [sessionAffinityEnabledState] Whether to allow session - * affinity on this host. Valid options are 'Enabled' or 'Disabled'. Possible - * values include: 'Enabled', 'Disabled' - * @member {number} [sessionAffinityTtlSeconds] UNUSED. This field will be - * ignored. The TTL to use in seconds for session affinity, if applicable. - * @member {object} [webApplicationFirewallPolicyLink] Defines the Web - * Application Firewall policy for each host (if applicable) - * @member {string} [webApplicationFirewallPolicyLink.id] Resource ID. */ export interface FrontendEndpointUpdateParameters { + /** + * The host name of the frontendEndpoint. Must be a domain name. + */ hostName?: string; + /** + * Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'. + * Possible values include: 'Enabled', 'Disabled' + */ sessionAffinityEnabledState?: string; + /** + * UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if + * applicable. + */ sessionAffinityTtlSeconds?: number; + /** + * Defines the Web Application Firewall policy for each host (if applicable) + */ webApplicationFirewallPolicyLink?: FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink; } /** - * @class - * Initializes a new instance of the ValidateCustomDomainInput class. - * @constructor * Input of the custom domain to be validated for DNS mapping. - * - * @member {string} hostName The host name of the custom domain. Must be a - * domain name. */ export interface ValidateCustomDomainInput { + /** + * The host name of the custom domain. Must be a domain name. + */ hostName: string; } /** - * @class - * Initializes a new instance of the ValidateCustomDomainOutput class. - * @constructor * Output of custom domain validation. - * - * @member {boolean} [customDomainValidated] Indicates whether the custom - * domain is valid or not. - * @member {string} [reason] The reason why the custom domain is not valid. - * @member {string} [message] Error message describing why the custom domain is - * not valid. */ export interface ValidateCustomDomainOutput { + /** + * Indicates whether the custom domain is valid or not. + */ readonly customDomainValidated?: boolean; + /** + * The reason why the custom domain is not valid. + */ readonly reason?: string; + /** + * Error message describing why the custom domain is not valid. + */ readonly message?: string; } /** - * @class - * Initializes a new instance of the ErrorResponse class. - * @constructor - * Error reponse indicates Front Door 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 Front Door service is not able to process the incoming request. The + * reason is provided in the error message. */ export interface ErrorResponse { + /** + * Error code. + */ readonly code?: string; + /** + * Error message indicating why the operation failed. + */ readonly message?: string; } /** - * @class - * Initializes a new instance of the CheckNameAvailabilityInput class. - * @constructor * Input of CheckNameAvailability API. - * - * @member {string} name The resource name to validate. - * @member {string} type The type of the resource whose name is to be - * validated. Possible values include: 'Microsoft.Network/frontDoors', - * 'Microsoft.Network/frontDoors/frontendEndpoints' */ export interface CheckNameAvailabilityInput { + /** + * The resource name to validate. + */ name: string; + /** + * The type of the resource whose name is to be validated. Possible values include: + * 'Microsoft.Network/frontDoors', 'Microsoft.Network/frontDoors/frontendEndpoints' + */ type: string; } /** - * @class - * Initializes a new instance of the CheckNameAvailabilityOutput class. - * @constructor * Output of check name availability API. - * - * @member {string} [nameAvailability] Indicates whether the name is available. - * Possible values include: 'Available', 'Unavailable' - * @member {string} [reason] The reason why the name is not available. - * @member {string} [message] The detailed error message describing why the - * name is not available. */ export interface CheckNameAvailabilityOutput { + /** + * Indicates whether the name is available. Possible values include: 'Available', 'Unavailable' + */ readonly nameAvailability?: string; + /** + * The reason why the name is not available. + */ readonly reason?: string; + /** + * The detailed error message describing why the name is not available. + */ readonly message?: string; } -/** - * @class - * Initializes a new instance of the ErrorDetails class. - * @constructor - * @member {string} [code] - * @member {string} [target] - * @member {string} [message] - */ export interface ErrorDetails { code?: string; target?: string; message?: string; } -/** - * @class - * Initializes a new instance of the ErrorModel class. - * @constructor - * @member {string} [code] - * @member {string} [message] - * @member {string} [target] - * @member {array} [details] - * @member {string} [innerError] - */ export interface ErrorModel { code?: string; message?: string; @@ -660,323 +665,289 @@ export interface ErrorModel { } /** - * @class - * Initializes a new instance of the AzureAsyncOperationResult class. - * @constructor - * The response body contains the status of the specified asynchronous - * operation, indicating whether it has succeeded, is in progress, or has - * failed. Note that this status is distinct from the HTTP status code returned - * for the Get Operation Status operation itself. If the asynchronous operation - * succeeded, the response body includes the HTTP status code for the - * successful request. If the asynchronous operation failed, the response body - * includes the HTTP status code for the failed request and error information - * regarding the failure. - * - * @member {string} [status] Status of the Azure async operation. Possible - * values are: 'InProgress', 'Succeeded', and 'Failed'. Possible values - * include: 'InProgress', 'Succeeded', 'Failed' - * @member {object} [error] - * @member {string} [error.code] - * @member {string} [error.message] - * @member {string} [error.target] - * @member {array} [error.details] - * @member {string} [error.innerError] - */ + * The response body contains the status of the specified asynchronous operation, indicating + * whether it has succeeded, is in progress, or has failed. Note that this status is distinct from + * the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous + * operation succeeded, the response body includes the HTTP status code for the successful request. + * If the asynchronous operation failed, the response body includes the HTTP status code for the + * failed request and error information regarding the failure. +*/ export interface AzureAsyncOperationResult { + /** + * Status of the Azure async operation. Possible values are: 'InProgress', 'Succeeded', and + * 'Failed'. Possible values include: 'InProgress', 'Succeeded', 'Failed' + */ status?: string; error?: ErrorModel; } /** - * @class - * Initializes a new instance of the TagsObject class. - * @constructor * Tags object for patch operations. - * - * @member {object} [tags] Resource tags. - */ +*/ export interface TagsObject { + /** + * Resource tags. + */ tags?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the PolicySettings class. - * @constructor * Defines contents of a web application firewall global configuration - * - * @member {string} [enabledState] describes if the policy is in enabled state - * or disabled state. Possible values include: 'Disabled', 'Enabled' - * @member {string} [mode] Describes if it is in detection mode or prevention - * mode at policy level. Possible values include: 'Prevention', 'Detection' - */ +*/ export interface PolicySettings { + /** + * describes if the policy is in enabled state or disabled state. Possible values include: + * 'Disabled', 'Enabled' + */ enabledState?: string; + /** + * Describes if it is in detection mode or prevention mode at policy level. Possible values + * include: 'Prevention', 'Detection' + */ mode?: string; } /** - * @class - * Initializes a new instance of the MatchCondition1 class. - * @constructor * Define match conditions - * - * @member {string} matchVariable Match Variable. Possible values include: - * 'RemoteAddr', 'RequestMethod', 'QueryString', 'PostArgs', 'RequestUri', - * 'RequestHeader', 'RequestBody' - * @member {string} [selector] Name of selector in RequestHeader or RequestBody - * to be matched - * @member {string} operator Describes operator to be matched. Possible values - * include: 'Any', 'IPMatch', 'GeoMatch', 'Equal', 'Contains', 'LessThan', - * 'GreaterThan', 'LessThanOrEqual', 'GreaterThanOrEqual', 'BeginsWith', - * 'EndsWith' - * @member {boolean} [negateCondition] Describes if this is negate condition or - * not - * @member {array} matchValue Match value - */ +*/ export interface MatchCondition1 { + /** + * Match Variable. Possible values include: 'RemoteAddr', 'RequestMethod', 'QueryString', + * 'PostArgs', 'RequestUri', 'RequestHeader', 'RequestBody' + */ matchVariable: string; + /** + * Name of selector in RequestHeader or RequestBody to be matched + */ selector?: string; + /** + * Describes operator to be matched. Possible values include: 'Any', 'IPMatch', 'GeoMatch', + * 'Equal', 'Contains', 'LessThan', 'GreaterThan', 'LessThanOrEqual', 'GreaterThanOrEqual', + * 'BeginsWith', 'EndsWith' + */ operator: string; + /** + * Describes if this is negate condition or not + */ negateCondition?: boolean; + /** + * Match value + */ matchValue: string[]; } /** - * @class - * Initializes a new instance of the CustomRule class. - * @constructor * Defines contents of a web application rule - * - * @member {string} [name] Gets name of the resource that is unique within a - * policy. This name can be used to access the resource. - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - * @member {number} priority Describes priority of the rule. Rules with a lower - * value will be evaluated before rules with a higher value - * @member {string} ruleType Describes type of rule. Possible values include: - * 'MatchRule', 'RateLimitRule' - * @member {number} [rateLimitDurationInMinutes] Defines rate limit duration. - * Default - 1 minute - * @member {number} [rateLimitThreshold] Defines rate limit thresold - * @member {array} matchConditions List of match conditions - * @member {string} action Type of Actions. Possible values include: 'Allow', - * 'Block', 'Log' - * @member {array} [transforms] List of transforms - */ +*/ export interface CustomRule { + /** + * Gets name of the resource that is unique within a policy. This name can be used to access the + * resource. + */ name?: string; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ readonly etag?: string; + /** + * Describes priority of the rule. Rules with a lower value will be evaluated before rules with a + * higher value + */ priority: number; + /** + * Describes type of rule. Possible values include: 'MatchRule', 'RateLimitRule' + */ ruleType: string; + /** + * Defines rate limit duration. Default - 1 minute + */ rateLimitDurationInMinutes?: number; + /** + * Defines rate limit threshold + */ rateLimitThreshold?: number; + /** + * List of match conditions + */ matchConditions: MatchCondition1[]; + /** + * Type of Actions. Possible values include: 'Allow', 'Block', 'Log' + */ action: string; + /** + * List of transforms + */ transforms?: string[]; } /** - * @class - * Initializes a new instance of the CustomRules class. - * @constructor * Defines contents of custom rules - * - * @member {array} [rules] List of rules - */ +*/ export interface CustomRules { + /** + * List of rules + */ rules?: CustomRule[]; } /** - * @class - * Initializes a new instance of the ManagedRuleSet class. - * @constructor * Base class for all types of ManagedRuleSet. - * - * @member {number} [priority] Describes priority of the rule - * @member {number} [version] defines version of the ruleset - * @member {string} ruleSetType Polymorphic Discriminator - */ +*/ export interface ManagedRuleSet { + /** + * Describes priority of the rule + */ priority?: number; + /** + * defines version of the rule set + */ version?: number; + /** + * Polymorphic Discriminator + */ ruleSetType: string; } /** - * @class - * Initializes a new instance of the ManagedRuleSets class. - * @constructor * Defines ManagedRuleSets - array of managedRuleSet - * - * @member {array} [ruleSets] List of rules - */ +*/ export interface ManagedRuleSets { + /** + * List of rules + */ ruleSets?: ManagedRuleSet[]; } /** - * @class - * Initializes a new instance of the WebApplicationFirewallPolicy1 class. - * @constructor * Defines web application firewall policy. - * - * @member {object} [policySettings] Describes policySettings for policy - * @member {string} [policySettings.enabledState] describes if the policy is in - * enabled state or disabled state. Possible values include: 'Disabled', - * 'Enabled' - * @member {string} [policySettings.mode] Describes if it is in detection mode - * or prevention mode at policy level. Possible values include: 'Prevention', - * 'Detection' - * @member {object} [customRules] Describes custom rules inside the policy - * @member {array} [customRules.rules] List of rules - * @member {object} [managedRules] Describes managed rules inside the policy - * @member {array} [managedRules.ruleSets] List of rules - * @member {string} [provisioningState] Provisioning state of the - * WebApplicationFirewallPolicy. - * @member {string} [resourceState] Resource status of the policy. Possible - * values include: 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', - * 'Deleting' - * @member {string} [etag] Gets a unique read-only string that changes whenever - * the resource is updated. - */ +*/ export interface WebApplicationFirewallPolicy1 extends Resource { + /** + * Describes policySettings for policy + */ policySettings?: PolicySettings; + /** + * Describes custom rules inside the policy + */ customRules?: CustomRules; + /** + * Describes managed rules inside the policy + */ managedRules?: ManagedRuleSets; + /** + * Provisioning state of the WebApplicationFirewallPolicy. + */ readonly provisioningState?: string; + /** + * @summary Resource status of the policy. + * @description Possible values include: 'Creating', 'Enabling', 'Enabled', 'Disabling', + * 'Disabled', 'Deleting' + */ readonly resourceState?: string; + /** + * Gets a unique read-only string that changes whenever the resource is updated. + */ etag?: string; } /** - * @class - * Initializes a new instance of the AzureManagedOverrideRuleGroup class. - * @constructor * Defines contents of a web application rule - * - * @member {string} ruleGroupOverride Describes overrideruleGroup. Possible - * values include: 'SqlInjection', 'XSS' - * @member {string} action Type of Actions. Possible values include: 'Allow', - * 'Block', 'Log' - */ +*/ export interface AzureManagedOverrideRuleGroup { + /** + * Describes override rule group. Possible values include: 'SqlInjection', 'XSS' + */ ruleGroupOverride: string; + /** + * Type of Actions. Possible values include: 'Allow', 'Block', 'Log' + */ action: string; } /** - * @class - * Initializes a new instance of the AzureManagedRuleSet class. - * @constructor * Describes azure managed provider. - * - * @member {array} [ruleGroupOverrides] List of azure managed provider override - * configuration (optional) - */ +*/ export interface AzureManagedRuleSet extends ManagedRuleSet { + /** + * List of azure managed provider override configuration (optional) + */ ruleGroupOverrides?: AzureManagedOverrideRuleGroup[]; } - /** - * @class - * Initializes a new instance of the FrontDoorListResult class. - * @constructor - * Result of the request to list Front Doors. It contains a list of Front Door - * objects and a URL link to get the the next set of results. - * - * @member {string} [nextLink] URL to get the next set of Front Door objects if - * there are any. - */ + * Result of the request to list Front Doors. It contains a list of Front Door objects and a URL + * link to get the next set of results. +*/ export interface FrontDoorListResult extends Array { + /** + * URL to get the next set of Front Door objects if there are any. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the RoutingRuleListResult class. - * @constructor - * Result of the request to list Routing Rules. It contains a list of Routing - * Rule objects and a URL link to get the the next set of results. - * - * @member {string} [nextLink] URL to get the next set of RoutingRule objects - * if there are any. - */ + * Result of the request to list Routing Rules. It contains a list of Routing Rule objects and a + * URL link to get the next set of results. +*/ export interface RoutingRuleListResult extends Array { + /** + * URL to get the next set of RoutingRule objects if there are any. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the HealthProbeSettingsListResult class. - * @constructor - * Result of the request to list HealthProbeSettings. It contains a list of - * HealthProbeSettings objects and a URL link to get the the next set of - * results. - * - * @member {string} [nextLink] URL to get the next set of HealthProbeSettings - * objects if there are any. - */ + * Result of the request to list HealthProbeSettings. It contains a list of HealthProbeSettings + * objects and a URL link to get the next set of results. +*/ export interface HealthProbeSettingsListResult extends Array { + /** + * URL to get the next set of HealthProbeSettings objects if there are any. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the LoadBalancingSettingsListResult class. - * @constructor - * Result of the request to list load balancing settings. It contains a list of - * load balancing settings objects and a URL link to get the the next set of - * results. - * - * @member {string} [nextLink] URL to get the next set of LoadBalancingSettings - * objects if there are any. - */ + * Result of the request to list load balancing settings. It contains a list of load balancing + * settings objects and a URL link to get the next set of results. +*/ export interface LoadBalancingSettingsListResult extends Array { + /** + * URL to get the next set of LoadBalancingSettings objects if there are any. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the BackendPoolListResult class. - * @constructor - * Result of the request to list Backend Pools. It contains a list of Backend - * Pools objects and a URL link to get the the next set of results. - * - * @member {string} [nextLink] URL to get the next set of BackendPool objects - * if there are any. - */ + * Result of the request to list Backend Pools. It contains a list of Backend Pools objects and a + * URL link to get the next set of results. +*/ export interface BackendPoolListResult extends Array { + /** + * URL to get the next set of BackendPool objects if there are any. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the FrontendEndpointsListResult class. - * @constructor - * Result of the request to list frontend endpoints. It contains a list of - * Frontend endpoint objects and a URL link to get the the next set of results. - * - * @member {string} [nextLink] URL to get the next set of frontend endpoints if - * there are any. - */ + * Result of the request to list frontend endpoints. It contains a list of Frontend endpoint + * objects and a URL link to get the next set of results. +*/ export interface FrontendEndpointsListResult extends Array { + /** + * URL to get the next set of frontend endpoints if there are any. + */ nextLink?: string; } /** - * @class - * Initializes a new instance of the WebApplicationFirewallPolicyListResult class. - * @constructor - * Result of the request to list WebApplicationFirewallPolicies. It contains a - * list of WebApplicationFirewallPolicy objects and a URL link to get the the - * next set of results. - * - * @member {string} [nextLink] URL to get the next set of - * WebApplicationFirewallPolicy objects if there are any. - */ -export interface WebApplicationFirewallPolicyListResult extends Array { + * Result of the request to list WebApplicationFirewallPolicies. It contains a list of + * WebApplicationFirewallPolicy objects and a URL link to get the next set of results. +*/ +export interface WebApplicationFirewallPolicyListResult extends +Array { + /** + * URL to get the next set of WebApplicationFirewallPolicy objects if there are any. + */ nextLink?: string; } diff --git a/lib/services/frontdoorManagement/lib/models/keyVaultCertificateSourceParametersVault.js b/lib/services/frontdoorManagement/lib/models/keyVaultCertificateSourceParametersVault.js index b7cef60222..c0eaca4274 100644 --- a/lib/services/frontdoorManagement/lib/models/keyVaultCertificateSourceParametersVault.js +++ b/lib/services/frontdoorManagement/lib/models/keyVaultCertificateSourceParametersVault.js @@ -17,7 +17,7 @@ class KeyVaultCertificateSourceParametersVault { /** * Create a KeyVaultCertificateSourceParametersVault. - * @member {string} [id] Resource ID. + * @property {string} [id] Resource ID. */ constructor() { } diff --git a/lib/services/frontdoorManagement/lib/models/loadBalancingSettingsListResult.js b/lib/services/frontdoorManagement/lib/models/loadBalancingSettingsListResult.js index e184b7ccde..cd8f567c79 100644 --- a/lib/services/frontdoorManagement/lib/models/loadBalancingSettingsListResult.js +++ b/lib/services/frontdoorManagement/lib/models/loadBalancingSettingsListResult.js @@ -12,13 +12,13 @@ /** * Result of the request to list load balancing settings. It contains a list of - * load balancing settings objects and a URL link to get the the next set of + * load balancing settings objects and a URL link to get the next set of * results. */ class LoadBalancingSettingsListResult extends Array { /** * Create a LoadBalancingSettingsListResult. - * @member {string} [nextLink] URL to get the next set of + * @property {string} [nextLink] URL to get the next set of * LoadBalancingSettings objects if there are any. */ constructor() { diff --git a/lib/services/frontdoorManagement/lib/models/loadBalancingSettingsModel.js b/lib/services/frontdoorManagement/lib/models/loadBalancingSettingsModel.js index e1388e021e..ed829f110f 100644 --- a/lib/services/frontdoorManagement/lib/models/loadBalancingSettingsModel.js +++ b/lib/services/frontdoorManagement/lib/models/loadBalancingSettingsModel.js @@ -20,16 +20,17 @@ const models = require('./index'); class LoadBalancingSettingsModel extends models['SubResource'] { /** * Create a LoadBalancingSettingsModel. - * @member {number} [sampleSize] The number of samples to consider for load + * @property {number} [sampleSize] The number of samples to consider for load * balancing decisions - * @member {number} [successfulSamplesRequired] The number of samples within - * the sample period that must succeed - * @member {number} [additionalLatencyMilliseconds] The additional latency in - * milliseconds for probes to fall into the lowest latency bucket - * @member {string} [resourceState] Resource status. Possible values include: - * 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', 'Deleting' - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. + * @property {number} [successfulSamplesRequired] The number of samples + * within the sample period that must succeed + * @property {number} [additionalLatencyMilliseconds] The additional latency + * in milliseconds for probes to fall into the lowest latency bucket + * @property {string} [resourceState] Resource status. Possible values + * include: 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', + * 'Deleting' + * @property {string} [name] Resource name. + * @property {string} [type] Resource type. */ constructor() { super(); diff --git a/lib/services/frontdoorManagement/lib/models/loadBalancingSettingsUpdateParameters.js b/lib/services/frontdoorManagement/lib/models/loadBalancingSettingsUpdateParameters.js index 1abb521224..c171819fe3 100644 --- a/lib/services/frontdoorManagement/lib/models/loadBalancingSettingsUpdateParameters.js +++ b/lib/services/frontdoorManagement/lib/models/loadBalancingSettingsUpdateParameters.js @@ -17,12 +17,12 @@ class LoadBalancingSettingsUpdateParameters { /** * Create a LoadBalancingSettingsUpdateParameters. - * @member {number} [sampleSize] The number of samples to consider for load + * @property {number} [sampleSize] The number of samples to consider for load * balancing decisions - * @member {number} [successfulSamplesRequired] The number of samples within - * the sample period that must succeed - * @member {number} [additionalLatencyMilliseconds] The additional latency in - * milliseconds for probes to fall into the lowest latency bucket + * @property {number} [successfulSamplesRequired] The number of samples + * within the sample period that must succeed + * @property {number} [additionalLatencyMilliseconds] The additional latency + * in milliseconds for probes to fall into the lowest latency bucket */ constructor() { } diff --git a/lib/services/frontdoorManagement/lib/models/managedRuleSet.js b/lib/services/frontdoorManagement/lib/models/managedRuleSet.js index e115d2a68c..0b601e5fbe 100644 --- a/lib/services/frontdoorManagement/lib/models/managedRuleSet.js +++ b/lib/services/frontdoorManagement/lib/models/managedRuleSet.js @@ -17,9 +17,9 @@ class ManagedRuleSet { /** * Create a ManagedRuleSet. - * @member {number} [priority] Describes priority of the rule - * @member {number} [version] defines version of the ruleset - * @member {string} ruleSetType Polymorphic Discriminator + * @property {number} [priority] Describes priority of the rule + * @property {number} [version] defines version of the rule set + * @property {string} ruleSetType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/frontdoorManagement/lib/models/managedRuleSets.js b/lib/services/frontdoorManagement/lib/models/managedRuleSets.js index ffc9449879..5b21303e0e 100644 --- a/lib/services/frontdoorManagement/lib/models/managedRuleSets.js +++ b/lib/services/frontdoorManagement/lib/models/managedRuleSets.js @@ -17,7 +17,7 @@ class ManagedRuleSets { /** * Create a ManagedRuleSets. - * @member {array} [ruleSets] List of rules + * @property {array} [ruleSets] List of rules */ constructor() { } diff --git a/lib/services/frontdoorManagement/lib/models/matchCondition1.js b/lib/services/frontdoorManagement/lib/models/matchCondition1.js index e480792f23..d40f6ac826 100644 --- a/lib/services/frontdoorManagement/lib/models/matchCondition1.js +++ b/lib/services/frontdoorManagement/lib/models/matchCondition1.js @@ -17,18 +17,18 @@ class MatchCondition1 { /** * Create a MatchCondition1. - * @member {string} matchVariable Match Variable. Possible values include: + * @property {string} matchVariable Match Variable. Possible values include: * 'RemoteAddr', 'RequestMethod', 'QueryString', 'PostArgs', 'RequestUri', * 'RequestHeader', 'RequestBody' - * @member {string} [selector] Name of selector in RequestHeader or + * @property {string} [selector] Name of selector in RequestHeader or * RequestBody to be matched - * @member {string} operator Describes operator to be matched. Possible + * @property {string} operator Describes operator to be matched. Possible * values include: 'Any', 'IPMatch', 'GeoMatch', 'Equal', 'Contains', * 'LessThan', 'GreaterThan', 'LessThanOrEqual', 'GreaterThanOrEqual', * 'BeginsWith', 'EndsWith' - * @member {boolean} [negateCondition] Describes if this is negate condition - * or not - * @member {array} matchValue Match value + * @property {boolean} [negateCondition] Describes if this is negate + * condition or not + * @property {array} matchValue Match value */ constructor() { } diff --git a/lib/services/frontdoorManagement/lib/models/policySettings.js b/lib/services/frontdoorManagement/lib/models/policySettings.js index f75fd99adb..c05d506ed9 100644 --- a/lib/services/frontdoorManagement/lib/models/policySettings.js +++ b/lib/services/frontdoorManagement/lib/models/policySettings.js @@ -17,9 +17,9 @@ class PolicySettings { /** * Create a PolicySettings. - * @member {string} [enabledState] describes if the policy is in enabled + * @property {string} [enabledState] describes if the policy is in enabled * state or disabled state. Possible values include: 'Disabled', 'Enabled' - * @member {string} [mode] Describes if it is in detection mode or + * @property {string} [mode] Describes if it is in detection mode or * prevention mode at policy level. Possible values include: 'Prevention', * 'Detection' */ diff --git a/lib/services/frontdoorManagement/lib/models/purgeParameters.js b/lib/services/frontdoorManagement/lib/models/purgeParameters.js index e3be748479..8d01f8a0ca 100644 --- a/lib/services/frontdoorManagement/lib/models/purgeParameters.js +++ b/lib/services/frontdoorManagement/lib/models/purgeParameters.js @@ -17,7 +17,7 @@ class PurgeParameters { /** * Create a PurgeParameters. - * @member {array} contentPaths The path to the content to be purged. Can + * @property {array} contentPaths The path to the content to be purged. Can * describe a file path or a wild card directory. */ constructor() { diff --git a/lib/services/frontdoorManagement/lib/models/resource.js b/lib/services/frontdoorManagement/lib/models/resource.js index 4b70929508..740d1b9d45 100644 --- a/lib/services/frontdoorManagement/lib/models/resource.js +++ b/lib/services/frontdoorManagement/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/frontdoorManagement/lib/models/routingRule.js b/lib/services/frontdoorManagement/lib/models/routingRule.js index 4bbb21cafb..5b137c7c8f 100644 --- a/lib/services/frontdoorManagement/lib/models/routingRule.js +++ b/lib/services/frontdoorManagement/lib/models/routingRule.js @@ -21,34 +21,35 @@ const models = require('./index'); class RoutingRule extends models['SubResource'] { /** * Create a RoutingRule. - * @member {array} [frontendEndpoints] Frontend endpoints associated with + * @property {array} [frontendEndpoints] Frontend endpoints associated with * this rule - * @member {array} [acceptedProtocols] Protocol schemes to match for this + * @property {array} [acceptedProtocols] Protocol schemes to match for this * rule - * @member {array} [patternsToMatch] The route patterns of the rule. - * @member {string} [customForwardingPath] A custom path used to rewrite + * @property {array} [patternsToMatch] The route patterns of the rule. + * @property {string} [customForwardingPath] A custom path used to rewrite * resource paths matched by this rule. Leave empty to use incoming path. - * @member {string} [forwardingProtocol] Protocol this rule will use when + * @property {string} [forwardingProtocol] Protocol this rule will use when * forwarding traffic to backends. Possible values include: 'HttpOnly', * 'HttpsOnly', 'MatchRequest' - * @member {object} [cacheConfiguration] The caching configuration associated - * with this rule. - * @member {string} [cacheConfiguration.queryParameterStripDirective] + * @property {object} [cacheConfiguration] The caching configuration + * associated with this rule. + * @property {string} [cacheConfiguration.queryParameterStripDirective] * Treatment of URL query terms when forming the cache key. Possible values * include: 'StripNone', 'StripAll' - * @member {string} [cacheConfiguration.dynamicCompression] Whether to use + * @property {string} [cacheConfiguration.dynamicCompression] Whether to use * dynamic compression for cached content. Possible values include: * 'Enabled', 'Disabled' - * @member {object} [backendPool] A reference to the BackendPool which this + * @property {object} [backendPool] A reference to the BackendPool which this * rule routes to. - * @member {string} [backendPool.id] Resource ID. - * @member {string} [enabledState] Whether to enable use of this rule. + * @property {string} [backendPool.id] Resource ID. + * @property {string} [enabledState] Whether to enable use of this rule. * Permitted values are 'Enabled' or 'Disabled'. Possible values include: * 'Enabled', 'Disabled' - * @member {string} [resourceState] Resource status. Possible values include: - * 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', 'Deleting' - * @member {string} [name] Resource name. - * @member {string} [type] Resource type. + * @property {string} [resourceState] Resource status. Possible values + * include: 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', + * 'Deleting' + * @property {string} [name] Resource name. + * @property {string} [type] Resource type. */ constructor() { super(); diff --git a/lib/services/frontdoorManagement/lib/models/routingRuleListResult.js b/lib/services/frontdoorManagement/lib/models/routingRuleListResult.js index 004f60a9f5..793fadc39d 100644 --- a/lib/services/frontdoorManagement/lib/models/routingRuleListResult.js +++ b/lib/services/frontdoorManagement/lib/models/routingRuleListResult.js @@ -12,13 +12,13 @@ /** * Result of the request to list Routing Rules. It contains a list of Routing - * Rule objects and a URL link to get the the next set of results. + * Rule objects and a URL link to get the next set of results. */ class RoutingRuleListResult extends Array { /** * Create a RoutingRuleListResult. - * @member {string} [nextLink] URL to get the next set of RoutingRule objects - * if there are any. + * @property {string} [nextLink] URL to get the next set of RoutingRule + * objects if there are any. */ constructor() { super(); diff --git a/lib/services/frontdoorManagement/lib/models/routingRuleUpdateParameters.js b/lib/services/frontdoorManagement/lib/models/routingRuleUpdateParameters.js index 7f02de2afd..39cb6672eb 100644 --- a/lib/services/frontdoorManagement/lib/models/routingRuleUpdateParameters.js +++ b/lib/services/frontdoorManagement/lib/models/routingRuleUpdateParameters.js @@ -17,28 +17,28 @@ class RoutingRuleUpdateParameters { /** * Create a RoutingRuleUpdateParameters. - * @member {array} [frontendEndpoints] Frontend endpoints associated with + * @property {array} [frontendEndpoints] Frontend endpoints associated with * this rule - * @member {array} [acceptedProtocols] Protocol schemes to match for this + * @property {array} [acceptedProtocols] Protocol schemes to match for this * rule - * @member {array} [patternsToMatch] The route patterns of the rule. - * @member {string} [customForwardingPath] A custom path used to rewrite + * @property {array} [patternsToMatch] The route patterns of the rule. + * @property {string} [customForwardingPath] A custom path used to rewrite * resource paths matched by this rule. Leave empty to use incoming path. - * @member {string} [forwardingProtocol] Protocol this rule will use when + * @property {string} [forwardingProtocol] Protocol this rule will use when * forwarding traffic to backends. Possible values include: 'HttpOnly', * 'HttpsOnly', 'MatchRequest' - * @member {object} [cacheConfiguration] The caching configuration associated - * with this rule. - * @member {string} [cacheConfiguration.queryParameterStripDirective] + * @property {object} [cacheConfiguration] The caching configuration + * associated with this rule. + * @property {string} [cacheConfiguration.queryParameterStripDirective] * Treatment of URL query terms when forming the cache key. Possible values * include: 'StripNone', 'StripAll' - * @member {string} [cacheConfiguration.dynamicCompression] Whether to use + * @property {string} [cacheConfiguration.dynamicCompression] Whether to use * dynamic compression for cached content. Possible values include: * 'Enabled', 'Disabled' - * @member {object} [backendPool] A reference to the BackendPool which this + * @property {object} [backendPool] A reference to the BackendPool which this * rule routes to. - * @member {string} [backendPool.id] Resource ID. - * @member {string} [enabledState] Whether to enable use of this rule. + * @property {string} [backendPool.id] Resource ID. + * @property {string} [enabledState] Whether to enable use of this rule. * Permitted values are 'Enabled' or 'Disabled'. Possible values include: * 'Enabled', 'Disabled' */ diff --git a/lib/services/frontdoorManagement/lib/models/subResource.js b/lib/services/frontdoorManagement/lib/models/subResource.js index 51215f1707..f59dea3bbf 100644 --- a/lib/services/frontdoorManagement/lib/models/subResource.js +++ b/lib/services/frontdoorManagement/lib/models/subResource.js @@ -20,7 +20,7 @@ const models = require('./index'); class SubResource extends models['BaseResource'] { /** * Create a SubResource. - * @member {string} [id] Resource ID. + * @property {string} [id] Resource ID. */ constructor() { super(); diff --git a/lib/services/frontdoorManagement/lib/models/tagsObject.js b/lib/services/frontdoorManagement/lib/models/tagsObject.js index 755b116391..a22fc07dfd 100644 --- a/lib/services/frontdoorManagement/lib/models/tagsObject.js +++ b/lib/services/frontdoorManagement/lib/models/tagsObject.js @@ -17,7 +17,7 @@ class TagsObject { /** * Create a TagsObject. - * @member {object} [tags] Resource tags. + * @property {object} [tags] Resource tags. */ constructor() { } diff --git a/lib/services/frontdoorManagement/lib/models/validateCustomDomainInput.js b/lib/services/frontdoorManagement/lib/models/validateCustomDomainInput.js index 71bf5ec871..eba1b99c5d 100644 --- a/lib/services/frontdoorManagement/lib/models/validateCustomDomainInput.js +++ b/lib/services/frontdoorManagement/lib/models/validateCustomDomainInput.js @@ -17,7 +17,7 @@ class ValidateCustomDomainInput { /** * Create a ValidateCustomDomainInput. - * @member {string} hostName The host name of the custom domain. Must be a + * @property {string} hostName The host name of the custom domain. Must be a * domain name. */ constructor() { diff --git a/lib/services/frontdoorManagement/lib/models/validateCustomDomainOutput.js b/lib/services/frontdoorManagement/lib/models/validateCustomDomainOutput.js index cf285a32b7..52edf6e2a6 100644 --- a/lib/services/frontdoorManagement/lib/models/validateCustomDomainOutput.js +++ b/lib/services/frontdoorManagement/lib/models/validateCustomDomainOutput.js @@ -17,11 +17,11 @@ class ValidateCustomDomainOutput { /** * Create a ValidateCustomDomainOutput. - * @member {boolean} [customDomainValidated] Indicates whether the custom + * @property {boolean} [customDomainValidated] Indicates whether the custom * domain is valid or not. - * @member {string} [reason] The reason why the custom domain is not valid. - * @member {string} [message] Error message describing why the custom domain - * is not valid. + * @property {string} [reason] The reason why the custom domain is not valid. + * @property {string} [message] Error message describing why the custom + * domain is not valid. */ constructor() { } diff --git a/lib/services/frontdoorManagement/lib/models/webApplicationFirewallPolicy1.js b/lib/services/frontdoorManagement/lib/models/webApplicationFirewallPolicy1.js index f9385e9118..6b4c59bd81 100644 --- a/lib/services/frontdoorManagement/lib/models/webApplicationFirewallPolicy1.js +++ b/lib/services/frontdoorManagement/lib/models/webApplicationFirewallPolicy1.js @@ -20,23 +20,24 @@ const models = require('./index'); class WebApplicationFirewallPolicy1 extends models['Resource'] { /** * Create a WebApplicationFirewallPolicy1. - * @member {object} [policySettings] Describes policySettings for policy - * @member {string} [policySettings.enabledState] describes if the policy is - * in enabled state or disabled state. Possible values include: 'Disabled', - * 'Enabled' - * @member {string} [policySettings.mode] Describes if it is in detection + * @property {object} [policySettings] Describes policySettings for policy + * @property {string} [policySettings.enabledState] describes if the policy + * is in enabled state or disabled state. Possible values include: + * 'Disabled', 'Enabled' + * @property {string} [policySettings.mode] Describes if it is in detection * mode or prevention mode at policy level. Possible values include: * 'Prevention', 'Detection' - * @member {object} [customRules] Describes custom rules inside the policy - * @member {array} [customRules.rules] List of rules - * @member {object} [managedRules] Describes managed rules inside the policy - * @member {array} [managedRules.ruleSets] List of rules - * @member {string} [provisioningState] Provisioning state of the + * @property {object} [customRules] Describes custom rules inside the policy + * @property {array} [customRules.rules] List of rules + * @property {object} [managedRules] Describes managed rules inside the + * policy + * @property {array} [managedRules.ruleSets] List of rules + * @property {string} [provisioningState] Provisioning state of the * WebApplicationFirewallPolicy. - * @member {string} [resourceState] Resource status of the policy. Possible + * @property {string} [resourceState] Resource status of the policy. Possible * values include: 'Creating', 'Enabling', 'Enabled', 'Disabling', * 'Disabled', 'Deleting' - * @member {string} [etag] Gets a unique read-only string that changes + * @property {string} [etag] Gets a unique read-only string that changes * whenever the resource is updated. */ constructor() { diff --git a/lib/services/frontdoorManagement/lib/models/webApplicationFirewallPolicyListResult.js b/lib/services/frontdoorManagement/lib/models/webApplicationFirewallPolicyListResult.js index 501e486108..2c1a62ffa6 100644 --- a/lib/services/frontdoorManagement/lib/models/webApplicationFirewallPolicyListResult.js +++ b/lib/services/frontdoorManagement/lib/models/webApplicationFirewallPolicyListResult.js @@ -12,13 +12,13 @@ /** * Result of the request to list WebApplicationFirewallPolicies. It contains a - * list of WebApplicationFirewallPolicy objects and a URL link to get the the - * next set of results. + * list of WebApplicationFirewallPolicy objects and a URL link to get the next + * set of results. */ class WebApplicationFirewallPolicyListResult extends Array { /** * Create a WebApplicationFirewallPolicyListResult. - * @member {string} [nextLink] URL to get the next set of + * @property {string} [nextLink] URL to get the next set of * WebApplicationFirewallPolicy objects if there are any. */ constructor() { diff --git a/lib/services/frontdoorManagement/lib/operations/index.d.ts b/lib/services/frontdoorManagement/lib/operations/index.d.ts index 4ae89abdd6..af18924d44 100644 --- a/lib/services/frontdoorManagement/lib/operations/index.d.ts +++ b/lib/services/frontdoorManagement/lib/operations/index.d.ts @@ -4415,7 +4415,7 @@ export interface Policies { /** - * Creates or update policy with specified ruleset name within a resource + * Creates or update policy with specified rule set name within a resource * group. * * @param {string} resourceGroupName The name of the resource group. @@ -4466,7 +4466,7 @@ export interface Policies { createOrUpdateWithHttpOperationResponse(resourceGroupName: string, policyName: string, parameters: models.WebApplicationFirewallPolicy1, options?: { customHeaders? : { [headerName: string]: string; } }): Promise>; /** - * Creates or update policy with specified ruleset name within a resource + * Creates or update policy with specified rule set name within a resource * group. * * @param {string} resourceGroupName The name of the resource group. diff --git a/lib/services/frontdoorManagement/lib/operations/policies.js b/lib/services/frontdoorManagement/lib/operations/policies.js index 9f6c54f933..4192f3e91c 100644 --- a/lib/services/frontdoorManagement/lib/operations/policies.js +++ b/lib/services/frontdoorManagement/lib/operations/policies.js @@ -305,7 +305,7 @@ function _get(resourceGroupName, policyName, options, callback) { } /** - * Creates or update policy with specified ruleset name within a resource + * Creates or update policy with specified rule set name within a resource * group. * * @param {string} resourceGroupName The name of the resource group. @@ -1030,7 +1030,7 @@ class Policies { } /** - * Creates or update policy with specified ruleset name within a resource + * Creates or update policy with specified rule set name within a resource * group. * * @param {string} resourceGroupName The name of the resource group. @@ -1093,7 +1093,7 @@ class Policies { } /** - * Creates or update policy with specified ruleset name within a resource + * Creates or update policy with specified rule set name within a resource * group. * * @param {string} resourceGroupName The name of the resource group. diff --git a/lib/services/frontdoorManagement/package.json b/lib/services/frontdoorManagement/package.json index ed915d4c03..604287fa5a 100644 --- a/lib/services/frontdoorManagement/package.json +++ b/lib/services/frontdoorManagement/package.json @@ -22,4 +22,4 @@ "bugs": { "url": "https://github.com/azure/azure-sdk-for-node/issues" } -} \ No newline at end of file +}