diff --git a/lib/services/websiteManagement2/README.md b/lib/services/websiteManagement2/README.md
index 74dfd85526..8b41e1b534 100644
--- a/lib/services/websiteManagement2/README.md
+++ b/lib/services/websiteManagement2/README.md
@@ -3,22 +3,23 @@ uid: azure-arm-website
summary: *content
---
-# Microsoft Azure SDK for Node.js - WebSiteManagementClient
+**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 - WebSiteManagementClient
This project provides a Node.js package for accessing Azure. Right now it supports:
- **Node.js version 6.x.x or higher**
-## Features
+### Features
-## How to Install
+### How to Install
```bash
npm install azure-arm-website
```
-## How to use
+### How to use
-### Authentication, client creation and list appServiceCertificateOrders as an example.
+#### Authentication, client creation and list appServiceCertificateOrders as an example.
```javascript
const msRestAzure = require("ms-rest-azure");
@@ -35,6 +36,6 @@ msRestAzure.interactiveLogin().then((creds) => {
console.dir(err, {depth: null, colors: true});
});
-## Related projects
+### Related projects
- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node)
diff --git a/lib/services/websiteManagement2/lib/models/abnormalTimePeriod.js b/lib/services/websiteManagement2/lib/models/abnormalTimePeriod.js
index af74f2332a..a1e102e202 100644
--- a/lib/services/websiteManagement2/lib/models/abnormalTimePeriod.js
+++ b/lib/services/websiteManagement2/lib/models/abnormalTimePeriod.js
@@ -17,10 +17,10 @@
class AbnormalTimePeriod {
/**
* Create a AbnormalTimePeriod.
- * @member {date} [startTime] Start time of the downtime
- * @member {date} [endTime] End time of the downtime
- * @member {array} [events] List of Possible Cause of downtime
- * @member {array} [solutions] List of proposed solutions
+ * @property {date} [startTime] Start time of the downtime
+ * @property {date} [endTime] End time of the downtime
+ * @property {array} [events] List of Possible Cause of downtime
+ * @property {array} [solutions] List of proposed solutions
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/address.js b/lib/services/websiteManagement2/lib/models/address.js
index 31450935e3..73917e7c3c 100644
--- a/lib/services/websiteManagement2/lib/models/address.js
+++ b/lib/services/websiteManagement2/lib/models/address.js
@@ -17,12 +17,12 @@
class Address {
/**
* Create a Address.
- * @member {string} address1 First line of an Address.
- * @member {string} [address2] The second line of the Address. Optional.
- * @member {string} city The city for the address.
- * @member {string} country The country for the address.
- * @member {string} postalCode The postal code for the address.
- * @member {string} state The state or province for the address.
+ * @property {string} address1 First line of an Address.
+ * @property {string} [address2] The second line of the Address. Optional.
+ * @property {string} city The city for the address.
+ * @property {string} country The country for the address.
+ * @property {string} postalCode The postal code for the address.
+ * @property {string} state The state or province for the address.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/addressResponse.js b/lib/services/websiteManagement2/lib/models/addressResponse.js
index 28dcbfbd00..07e700eeb4 100644
--- a/lib/services/websiteManagement2/lib/models/addressResponse.js
+++ b/lib/services/websiteManagement2/lib/models/addressResponse.js
@@ -17,12 +17,12 @@
class AddressResponse {
/**
* Create a AddressResponse.
- * @member {string} [serviceIpAddress] Main public virtual IP.
- * @member {string} [internalIpAddress] Virtual Network internal IP address
+ * @property {string} [serviceIpAddress] Main public virtual IP.
+ * @property {string} [internalIpAddress] Virtual Network internal IP address
* of the App Service Environment if it is in internal load-balancing mode.
- * @member {array} [outboundIpAddresses] IP addresses appearing on outbound
+ * @property {array} [outboundIpAddresses] IP addresses appearing on outbound
* connections.
- * @member {array} [vipMappings] Additional virtual IPs.
+ * @property {array} [vipMappings] Additional virtual IPs.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/analysisData.js b/lib/services/websiteManagement2/lib/models/analysisData.js
index f23e81d09b..56ce04ab08 100644
--- a/lib/services/websiteManagement2/lib/models/analysisData.js
+++ b/lib/services/websiteManagement2/lib/models/analysisData.js
@@ -17,23 +17,23 @@
class AnalysisData {
/**
* Create a AnalysisData.
- * @member {string} [source] Name of the Detector
- * @member {object} [detectorDefinition] Detector Definition
- * @member {string} [detectorDefinition.displayName] Display name of the
+ * @property {string} [source] Name of the Detector
+ * @property {object} [detectorDefinition] Detector Definition
+ * @property {string} [detectorDefinition.displayName] Display name of the
* detector
- * @member {string} [detectorDefinition.description] Description of the
+ * @property {string} [detectorDefinition.description] Description of the
* detector
- * @member {number} [detectorDefinition.rank] Detector Rank
- * @member {boolean} [detectorDefinition.isEnabled] Flag representing whether
- * detector is enabled or not.
- * @member {array} [metrics] Source Metrics
- * @member {array} [data] Additional Source Data
- * @member {object} [detectorMetaData] Detector Meta Data
- * @member {object} [detectorMetaData.dataSource] Source of the Data
- * @member {array} [detectorMetaData.dataSource.instructions] Instrunctions
+ * @property {number} [detectorDefinition.rank] Detector Rank
+ * @property {boolean} [detectorDefinition.isEnabled] Flag representing
+ * whether detector is enabled or not.
+ * @property {array} [metrics] Source Metrics
+ * @property {array} [data] Additional Source Data
+ * @property {object} [detectorMetaData] Detector Meta Data
+ * @property {object} [detectorMetaData.dataSource] Source of the Data
+ * @property {array} [detectorMetaData.dataSource.instructions] Instrunctions
* if any for the data source
- * @member {array} [detectorMetaData.dataSource.dataSourceUri] Datasource Uri
- * Links
+ * @property {array} [detectorMetaData.dataSource.dataSourceUri] Datasource
+ * Uri Links
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/analysisDefinition.js b/lib/services/websiteManagement2/lib/models/analysisDefinition.js
index 66545279fd..d336633213 100644
--- a/lib/services/websiteManagement2/lib/models/analysisDefinition.js
+++ b/lib/services/websiteManagement2/lib/models/analysisDefinition.js
@@ -20,7 +20,7 @@ const models = require('./index');
class AnalysisDefinition extends models['ProxyOnlyResource'] {
/**
* Create a AnalysisDefinition.
- * @member {string} [description] Description of the Analysis
+ * @property {string} [description] Description of the Analysis
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/apiDefinitionInfo.js b/lib/services/websiteManagement2/lib/models/apiDefinitionInfo.js
index c7bc43edc4..1610dbb540 100644
--- a/lib/services/websiteManagement2/lib/models/apiDefinitionInfo.js
+++ b/lib/services/websiteManagement2/lib/models/apiDefinitionInfo.js
@@ -17,7 +17,7 @@
class ApiDefinitionInfo {
/**
* Create a ApiDefinitionInfo.
- * @member {string} [url] The URL of the API definition.
+ * @property {string} [url] The URL of the API definition.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/appServiceCertificate.js b/lib/services/websiteManagement2/lib/models/appServiceCertificate.js
index 299b1210d7..a61e115add 100644
--- a/lib/services/websiteManagement2/lib/models/appServiceCertificate.js
+++ b/lib/services/websiteManagement2/lib/models/appServiceCertificate.js
@@ -17,9 +17,9 @@
class AppServiceCertificate {
/**
* Create a AppServiceCertificate.
- * @member {string} [keyVaultId] Key Vault resource Id.
- * @member {string} [keyVaultSecretName] Key Vault secret name.
- * @member {string} [provisioningState] Status of the Key Vault secret.
+ * @property {string} [keyVaultId] Key Vault resource Id.
+ * @property {string} [keyVaultSecretName] Key Vault secret name.
+ * @property {string} [provisioningState] Status of the Key Vault secret.
* Possible values include: 'Initialized', 'WaitingOnCertificateOrder',
* 'Succeeded', 'CertificateOrderFailed', 'OperationNotPermittedOnKeyVault',
* 'AzureServiceUnauthorizedToAccessKeyVault', 'KeyVaultDoesNotExist',
diff --git a/lib/services/websiteManagement2/lib/models/appServiceCertificateCollection.js b/lib/services/websiteManagement2/lib/models/appServiceCertificateCollection.js
index 5ca5f99e91..40da8b4cdd 100644
--- a/lib/services/websiteManagement2/lib/models/appServiceCertificateCollection.js
+++ b/lib/services/websiteManagement2/lib/models/appServiceCertificateCollection.js
@@ -16,7 +16,7 @@
class AppServiceCertificateCollection extends Array {
/**
* Create a AppServiceCertificateCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/appServiceCertificateOrder.js b/lib/services/websiteManagement2/lib/models/appServiceCertificateOrder.js
index 4adc193a58..9debadfa9b 100644
--- a/lib/services/websiteManagement2/lib/models/appServiceCertificateOrder.js
+++ b/lib/services/websiteManagement2/lib/models/appServiceCertificateOrder.js
@@ -20,70 +20,72 @@ const models = require('./index');
class AppServiceCertificateOrder extends models['Resource'] {
/**
* Create a AppServiceCertificateOrder.
- * @member {object} [certificates] State of the Key Vault secret.
- * @member {string} [distinguishedName] Certificate distinguished name.
- * @member {string} [domainVerificationToken] Domain verification token.
- * @member {number} [validityInYears] Duration in years (must be between 1
+ * @property {object} [certificates] State of the Key Vault secret.
+ * @property {string} [distinguishedName] Certificate distinguished name.
+ * @property {string} [domainVerificationToken] Domain verification token.
+ * @property {number} [validityInYears] Duration in years (must be between 1
* and 3). Default value: 1 .
- * @member {number} [keySize] Certificate key size. Default value: 2048 .
- * @member {string} productType Certificate product type. Possible values
+ * @property {number} [keySize] Certificate key size. Default value: 2048 .
+ * @property {string} productType Certificate product type. Possible values
* include: 'StandardDomainValidatedSsl',
* 'StandardDomainValidatedWildCardSsl'
- * @member {boolean} [autoRenew] true if the certificate should
- * be automatically renewed when it expires; otherwise, false.
- * Default value: true .
- * @member {string} [provisioningState] Status of certificate order. Possible
- * values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress',
+ * @property {boolean} [autoRenew] true if the certificate
+ * should be automatically renewed when it expires; otherwise,
+ * false. Default value: true .
+ * @property {string} [provisioningState] Status of certificate order.
+ * Possible values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress',
* 'Deleting'
- * @member {string} [status] Current order status. Possible values include:
+ * @property {string} [status] Current order status. Possible values include:
* 'Pendingissuance', 'Issued', 'Revoked', 'Canceled', 'Denied',
* 'Pendingrevocation', 'PendingRekey', 'Unused', 'Expired', 'NotSubmitted'
- * @member {object} [signedCertificate] Signed certificate.
- * @member {number} [signedCertificate.version] Certificate Version.
- * @member {string} [signedCertificate.serialNumber] Certificate Serial
+ * @property {object} [signedCertificate] Signed certificate.
+ * @property {number} [signedCertificate.version] Certificate Version.
+ * @property {string} [signedCertificate.serialNumber] Certificate Serial
* Number.
- * @member {string} [signedCertificate.thumbprint] Certificate Thumbprint.
- * @member {string} [signedCertificate.subject] Certificate Subject.
- * @member {date} [signedCertificate.notBefore] Date Certificate is valid
+ * @property {string} [signedCertificate.thumbprint] Certificate Thumbprint.
+ * @property {string} [signedCertificate.subject] Certificate Subject.
+ * @property {date} [signedCertificate.notBefore] Date Certificate is valid
* from.
- * @member {date} [signedCertificate.notAfter] Date Certificate is valid to.
- * @member {string} [signedCertificate.signatureAlgorithm] Certificate
+ * @property {date} [signedCertificate.notAfter] Date Certificate is valid
+ * to.
+ * @property {string} [signedCertificate.signatureAlgorithm] Certificate
* Signature algorithm.
- * @member {string} [signedCertificate.issuer] Certificate Issuer.
- * @member {string} [signedCertificate.rawData] Raw certificate data.
- * @member {string} [csr] Last CSR that was created for this order.
- * @member {object} [intermediate] Intermediate certificate.
- * @member {number} [intermediate.version] Certificate Version.
- * @member {string} [intermediate.serialNumber] Certificate Serial Number.
- * @member {string} [intermediate.thumbprint] Certificate Thumbprint.
- * @member {string} [intermediate.subject] Certificate Subject.
- * @member {date} [intermediate.notBefore] Date Certificate is valid from.
- * @member {date} [intermediate.notAfter] Date Certificate is valid to.
- * @member {string} [intermediate.signatureAlgorithm] Certificate Signature
+ * @property {string} [signedCertificate.issuer] Certificate Issuer.
+ * @property {string} [signedCertificate.rawData] Raw certificate data.
+ * @property {string} [csr] Last CSR that was created for this order.
+ * @property {object} [intermediate] Intermediate certificate.
+ * @property {number} [intermediate.version] Certificate Version.
+ * @property {string} [intermediate.serialNumber] Certificate Serial Number.
+ * @property {string} [intermediate.thumbprint] Certificate Thumbprint.
+ * @property {string} [intermediate.subject] Certificate Subject.
+ * @property {date} [intermediate.notBefore] Date Certificate is valid from.
+ * @property {date} [intermediate.notAfter] Date Certificate is valid to.
+ * @property {string} [intermediate.signatureAlgorithm] Certificate Signature
* algorithm.
- * @member {string} [intermediate.issuer] Certificate Issuer.
- * @member {string} [intermediate.rawData] Raw certificate data.
- * @member {object} [root] Root certificate.
- * @member {number} [root.version] Certificate Version.
- * @member {string} [root.serialNumber] Certificate Serial Number.
- * @member {string} [root.thumbprint] Certificate Thumbprint.
- * @member {string} [root.subject] Certificate Subject.
- * @member {date} [root.notBefore] Date Certificate is valid from.
- * @member {date} [root.notAfter] Date Certificate is valid to.
- * @member {string} [root.signatureAlgorithm] Certificate Signature
+ * @property {string} [intermediate.issuer] Certificate Issuer.
+ * @property {string} [intermediate.rawData] Raw certificate data.
+ * @property {object} [root] Root certificate.
+ * @property {number} [root.version] Certificate Version.
+ * @property {string} [root.serialNumber] Certificate Serial Number.
+ * @property {string} [root.thumbprint] Certificate Thumbprint.
+ * @property {string} [root.subject] Certificate Subject.
+ * @property {date} [root.notBefore] Date Certificate is valid from.
+ * @property {date} [root.notAfter] Date Certificate is valid to.
+ * @property {string} [root.signatureAlgorithm] Certificate Signature
* algorithm.
- * @member {string} [root.issuer] Certificate Issuer.
- * @member {string} [root.rawData] Raw certificate data.
- * @member {string} [serialNumber] Current serial number of the certificate.
- * @member {date} [lastCertificateIssuanceTime] Certificate last issuance
+ * @property {string} [root.issuer] Certificate Issuer.
+ * @property {string} [root.rawData] Raw certificate data.
+ * @property {string} [serialNumber] Current serial number of the
+ * certificate.
+ * @property {date} [lastCertificateIssuanceTime] Certificate last issuance
* time.
- * @member {date} [expirationTime] Certificate expiration time.
- * @member {boolean} [isPrivateKeyExternal] true if private key
- * is external; otherwise, false.
- * @member {array} [appServiceCertificateNotRenewableReasons] Reasons why App
- * Service Certificate is not renewable at the current moment.
- * @member {date} [nextAutoRenewalTimeStamp] Time stamp when the certificate
- * would be auto renewed next
+ * @property {date} [expirationTime] Certificate expiration time.
+ * @property {boolean} [isPrivateKeyExternal] true if private
+ * key is external; otherwise, false.
+ * @property {array} [appServiceCertificateNotRenewableReasons] Reasons why
+ * App Service Certificate is not renewable at the current moment.
+ * @property {date} [nextAutoRenewalTimeStamp] Time stamp when the
+ * certificate would be auto renewed next
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/appServiceCertificateOrderCollection.js b/lib/services/websiteManagement2/lib/models/appServiceCertificateOrderCollection.js
index 6f45eabab2..c39cbf19af 100644
--- a/lib/services/websiteManagement2/lib/models/appServiceCertificateOrderCollection.js
+++ b/lib/services/websiteManagement2/lib/models/appServiceCertificateOrderCollection.js
@@ -11,12 +11,12 @@
'use strict';
/**
- * Collection of certitificate orders.
+ * Collection of certificate orders.
*/
class AppServiceCertificateOrderCollection extends Array {
/**
* Create a AppServiceCertificateOrderCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/appServiceCertificateOrderPatchResource.js b/lib/services/websiteManagement2/lib/models/appServiceCertificateOrderPatchResource.js
index 2601b56004..a3ebf9a93a 100644
--- a/lib/services/websiteManagement2/lib/models/appServiceCertificateOrderPatchResource.js
+++ b/lib/services/websiteManagement2/lib/models/appServiceCertificateOrderPatchResource.js
@@ -20,70 +20,72 @@ const models = require('./index');
class AppServiceCertificateOrderPatchResource extends models['ProxyOnlyResource'] {
/**
* Create a AppServiceCertificateOrderPatchResource.
- * @member {object} [certificates] State of the Key Vault secret.
- * @member {string} [distinguishedName] Certificate distinguished name.
- * @member {string} [domainVerificationToken] Domain verification token.
- * @member {number} [validityInYears] Duration in years (must be between 1
+ * @property {object} [certificates] State of the Key Vault secret.
+ * @property {string} [distinguishedName] Certificate distinguished name.
+ * @property {string} [domainVerificationToken] Domain verification token.
+ * @property {number} [validityInYears] Duration in years (must be between 1
* and 3). Default value: 1 .
- * @member {number} [keySize] Certificate key size. Default value: 2048 .
- * @member {string} productType Certificate product type. Possible values
+ * @property {number} [keySize] Certificate key size. Default value: 2048 .
+ * @property {string} productType Certificate product type. Possible values
* include: 'StandardDomainValidatedSsl',
* 'StandardDomainValidatedWildCardSsl'
- * @member {boolean} [autoRenew] true if the certificate should
- * be automatically renewed when it expires; otherwise, false.
- * Default value: true .
- * @member {string} [provisioningState] Status of certificate order. Possible
- * values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress',
+ * @property {boolean} [autoRenew] true if the certificate
+ * should be automatically renewed when it expires; otherwise,
+ * false. Default value: true .
+ * @property {string} [provisioningState] Status of certificate order.
+ * Possible values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress',
* 'Deleting'
- * @member {string} [status] Current order status. Possible values include:
+ * @property {string} [status] Current order status. Possible values include:
* 'Pendingissuance', 'Issued', 'Revoked', 'Canceled', 'Denied',
* 'Pendingrevocation', 'PendingRekey', 'Unused', 'Expired', 'NotSubmitted'
- * @member {object} [signedCertificate] Signed certificate.
- * @member {number} [signedCertificate.version] Certificate Version.
- * @member {string} [signedCertificate.serialNumber] Certificate Serial
+ * @property {object} [signedCertificate] Signed certificate.
+ * @property {number} [signedCertificate.version] Certificate Version.
+ * @property {string} [signedCertificate.serialNumber] Certificate Serial
* Number.
- * @member {string} [signedCertificate.thumbprint] Certificate Thumbprint.
- * @member {string} [signedCertificate.subject] Certificate Subject.
- * @member {date} [signedCertificate.notBefore] Date Certificate is valid
+ * @property {string} [signedCertificate.thumbprint] Certificate Thumbprint.
+ * @property {string} [signedCertificate.subject] Certificate Subject.
+ * @property {date} [signedCertificate.notBefore] Date Certificate is valid
* from.
- * @member {date} [signedCertificate.notAfter] Date Certificate is valid to.
- * @member {string} [signedCertificate.signatureAlgorithm] Certificate
+ * @property {date} [signedCertificate.notAfter] Date Certificate is valid
+ * to.
+ * @property {string} [signedCertificate.signatureAlgorithm] Certificate
* Signature algorithm.
- * @member {string} [signedCertificate.issuer] Certificate Issuer.
- * @member {string} [signedCertificate.rawData] Raw certificate data.
- * @member {string} [csr] Last CSR that was created for this order.
- * @member {object} [intermediate] Intermediate certificate.
- * @member {number} [intermediate.version] Certificate Version.
- * @member {string} [intermediate.serialNumber] Certificate Serial Number.
- * @member {string} [intermediate.thumbprint] Certificate Thumbprint.
- * @member {string} [intermediate.subject] Certificate Subject.
- * @member {date} [intermediate.notBefore] Date Certificate is valid from.
- * @member {date} [intermediate.notAfter] Date Certificate is valid to.
- * @member {string} [intermediate.signatureAlgorithm] Certificate Signature
+ * @property {string} [signedCertificate.issuer] Certificate Issuer.
+ * @property {string} [signedCertificate.rawData] Raw certificate data.
+ * @property {string} [csr] Last CSR that was created for this order.
+ * @property {object} [intermediate] Intermediate certificate.
+ * @property {number} [intermediate.version] Certificate Version.
+ * @property {string} [intermediate.serialNumber] Certificate Serial Number.
+ * @property {string} [intermediate.thumbprint] Certificate Thumbprint.
+ * @property {string} [intermediate.subject] Certificate Subject.
+ * @property {date} [intermediate.notBefore] Date Certificate is valid from.
+ * @property {date} [intermediate.notAfter] Date Certificate is valid to.
+ * @property {string} [intermediate.signatureAlgorithm] Certificate Signature
* algorithm.
- * @member {string} [intermediate.issuer] Certificate Issuer.
- * @member {string} [intermediate.rawData] Raw certificate data.
- * @member {object} [root] Root certificate.
- * @member {number} [root.version] Certificate Version.
- * @member {string} [root.serialNumber] Certificate Serial Number.
- * @member {string} [root.thumbprint] Certificate Thumbprint.
- * @member {string} [root.subject] Certificate Subject.
- * @member {date} [root.notBefore] Date Certificate is valid from.
- * @member {date} [root.notAfter] Date Certificate is valid to.
- * @member {string} [root.signatureAlgorithm] Certificate Signature
+ * @property {string} [intermediate.issuer] Certificate Issuer.
+ * @property {string} [intermediate.rawData] Raw certificate data.
+ * @property {object} [root] Root certificate.
+ * @property {number} [root.version] Certificate Version.
+ * @property {string} [root.serialNumber] Certificate Serial Number.
+ * @property {string} [root.thumbprint] Certificate Thumbprint.
+ * @property {string} [root.subject] Certificate Subject.
+ * @property {date} [root.notBefore] Date Certificate is valid from.
+ * @property {date} [root.notAfter] Date Certificate is valid to.
+ * @property {string} [root.signatureAlgorithm] Certificate Signature
* algorithm.
- * @member {string} [root.issuer] Certificate Issuer.
- * @member {string} [root.rawData] Raw certificate data.
- * @member {string} [serialNumber] Current serial number of the certificate.
- * @member {date} [lastCertificateIssuanceTime] Certificate last issuance
+ * @property {string} [root.issuer] Certificate Issuer.
+ * @property {string} [root.rawData] Raw certificate data.
+ * @property {string} [serialNumber] Current serial number of the
+ * certificate.
+ * @property {date} [lastCertificateIssuanceTime] Certificate last issuance
* time.
- * @member {date} [expirationTime] Certificate expiration time.
- * @member {boolean} [isPrivateKeyExternal] true if private key
- * is external; otherwise, false.
- * @member {array} [appServiceCertificateNotRenewableReasons] Reasons why App
- * Service Certificate is not renewable at the current moment.
- * @member {date} [nextAutoRenewalTimeStamp] Time stamp when the certificate
- * would be auto renewed next
+ * @property {date} [expirationTime] Certificate expiration time.
+ * @property {boolean} [isPrivateKeyExternal] true if private
+ * key is external; otherwise, false.
+ * @property {array} [appServiceCertificateNotRenewableReasons] Reasons why
+ * App Service Certificate is not renewable at the current moment.
+ * @property {date} [nextAutoRenewalTimeStamp] Time stamp when the
+ * certificate would be auto renewed next
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/appServiceCertificatePatchResource.js b/lib/services/websiteManagement2/lib/models/appServiceCertificatePatchResource.js
index 6abc5ec0e5..ad85901a7a 100644
--- a/lib/services/websiteManagement2/lib/models/appServiceCertificatePatchResource.js
+++ b/lib/services/websiteManagement2/lib/models/appServiceCertificatePatchResource.js
@@ -21,9 +21,9 @@ const models = require('./index');
class AppServiceCertificatePatchResource extends models['ProxyOnlyResource'] {
/**
* Create a AppServiceCertificatePatchResource.
- * @member {string} [keyVaultId] Key Vault resource Id.
- * @member {string} [keyVaultSecretName] Key Vault secret name.
- * @member {string} [provisioningState] Status of the Key Vault secret.
+ * @property {string} [keyVaultId] Key Vault resource Id.
+ * @property {string} [keyVaultSecretName] Key Vault secret name.
+ * @property {string} [provisioningState] Status of the Key Vault secret.
* Possible values include: 'Initialized', 'WaitingOnCertificateOrder',
* 'Succeeded', 'CertificateOrderFailed', 'OperationNotPermittedOnKeyVault',
* 'AzureServiceUnauthorizedToAccessKeyVault', 'KeyVaultDoesNotExist',
diff --git a/lib/services/websiteManagement2/lib/models/appServiceCertificateResource.js b/lib/services/websiteManagement2/lib/models/appServiceCertificateResource.js
index b55a592086..e89733927d 100644
--- a/lib/services/websiteManagement2/lib/models/appServiceCertificateResource.js
+++ b/lib/services/websiteManagement2/lib/models/appServiceCertificateResource.js
@@ -21,9 +21,9 @@ const models = require('./index');
class AppServiceCertificateResource extends models['Resource'] {
/**
* Create a AppServiceCertificateResource.
- * @member {string} [keyVaultId] Key Vault resource Id.
- * @member {string} [keyVaultSecretName] Key Vault secret name.
- * @member {string} [provisioningState] Status of the Key Vault secret.
+ * @property {string} [keyVaultId] Key Vault resource Id.
+ * @property {string} [keyVaultSecretName] Key Vault secret name.
+ * @property {string} [provisioningState] Status of the Key Vault secret.
* Possible values include: 'Initialized', 'WaitingOnCertificateOrder',
* 'Succeeded', 'CertificateOrderFailed', 'OperationNotPermittedOnKeyVault',
* 'AzureServiceUnauthorizedToAccessKeyVault', 'KeyVaultDoesNotExist',
diff --git a/lib/services/websiteManagement2/lib/models/appServiceEnvironment.js b/lib/services/websiteManagement2/lib/models/appServiceEnvironment.js
index 8419104377..58d6045546 100644
--- a/lib/services/websiteManagement2/lib/models/appServiceEnvironment.js
+++ b/lib/services/websiteManagement2/lib/models/appServiceEnvironment.js
@@ -17,90 +17,90 @@
class AppServiceEnvironment {
/**
* Create a AppServiceEnvironment.
- * @member {string} name Name of the App Service Environment.
- * @member {string} location Location of the App Service Environment, e.g.
+ * @property {string} name Name of the App Service Environment.
+ * @property {string} location Location of the App Service Environment, e.g.
* "West US".
- * @member {string} [provisioningState] Provisioning state of the App Service
- * Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled',
- * 'InProgress', 'Deleting'
- * @member {string} [status] Current status of the App Service Environment.
+ * @property {string} [provisioningState] Provisioning state of the App
+ * Service Environment. Possible values include: 'Succeeded', 'Failed',
+ * 'Canceled', 'InProgress', 'Deleting'
+ * @property {string} [status] Current status of the App Service Environment.
* Possible values include: 'Preparing', 'Ready', 'Scaling', 'Deleting'
- * @member {string} [vnetName] Name of the Virtual Network for the App
+ * @property {string} [vnetName] Name of the Virtual Network for the App
* Service Environment.
- * @member {string} [vnetResourceGroupName] Resource group of the Virtual
+ * @property {string} [vnetResourceGroupName] Resource group of the Virtual
* Network.
- * @member {string} [vnetSubnetName] Subnet of the Virtual Network.
- * @member {object} virtualNetwork Description of the Virtual Network.
- * @member {string} [virtualNetwork.id] Resource id of the Virtual Network.
- * @member {string} [virtualNetwork.name] Name of the Virtual Network
+ * @property {string} [vnetSubnetName] Subnet of the Virtual Network.
+ * @property {object} virtualNetwork Description of the Virtual Network.
+ * @property {string} [virtualNetwork.id] Resource id of the Virtual Network.
+ * @property {string} [virtualNetwork.name] Name of the Virtual Network
* (read-only).
- * @member {string} [virtualNetwork.type] Resource type of the Virtual
+ * @property {string} [virtualNetwork.type] Resource type of the Virtual
* Network (read-only).
- * @member {string} [virtualNetwork.subnet] Subnet within the Virtual
+ * @property {string} [virtualNetwork.subnet] Subnet within the Virtual
* Network.
- * @member {string} [internalLoadBalancingMode] Specifies which endpoints to
- * serve internally in the Virtual Network for the App Service Environment.
- * Possible values include: 'None', 'Web', 'Publishing'
- * @member {string} [multiSize] Front-end VM size, e.g. "Medium", "Large".
- * @member {number} [multiRoleCount] Number of front-end instances.
- * @member {array} workerPools Description of worker pools with worker size
+ * @property {string} [internalLoadBalancingMode] Specifies which endpoints
+ * to serve internally in the Virtual Network for the App Service
+ * Environment. Possible values include: 'None', 'Web', 'Publishing'
+ * @property {string} [multiSize] Front-end VM size, e.g. "Medium", "Large".
+ * @property {number} [multiRoleCount] Number of front-end instances.
+ * @property {array} workerPools Description of worker pools with worker size
* IDs, VM sizes, and number of workers in each pool.
- * @member {number} [ipsslAddressCount] Number of IP SSL addresses reserved
+ * @property {number} [ipsslAddressCount] Number of IP SSL addresses reserved
* for the App Service Environment.
- * @member {string} [databaseEdition] Edition of the metadata database for
+ * @property {string} [databaseEdition] Edition of the metadata database for
* the App Service Environment, e.g. "Standard".
- * @member {string} [databaseServiceObjective] Service objective of the
+ * @property {string} [databaseServiceObjective] Service objective of the
* metadata database for the App Service Environment, e.g. "S0".
- * @member {number} [upgradeDomains] Number of upgrade domains of the App
+ * @property {number} [upgradeDomains] Number of upgrade domains of the App
* Service Environment.
- * @member {string} [subscriptionId] Subscription of the App Service
+ * @property {string} [subscriptionId] Subscription of the App Service
* Environment.
- * @member {string} [dnsSuffix] DNS suffix of the App Service Environment.
- * @member {string} [lastAction] Last deployment action on the App Service
+ * @property {string} [dnsSuffix] DNS suffix of the App Service Environment.
+ * @property {string} [lastAction] Last deployment action on the App Service
* Environment.
- * @member {string} [lastActionResult] Result of the last deployment action
+ * @property {string} [lastActionResult] Result of the last deployment action
* on the App Service Environment.
- * @member {string} [allowedMultiSizes] List of comma separated strings
+ * @property {string} [allowedMultiSizes] List of comma separated strings
* describing which VM sizes are allowed for front-ends.
- * @member {string} [allowedWorkerSizes] List of comma separated strings
+ * @property {string} [allowedWorkerSizes] List of comma separated strings
* describing which VM sizes are allowed for workers.
- * @member {number} [maximumNumberOfMachines] Maximum number of VMs in the
+ * @property {number} [maximumNumberOfMachines] Maximum number of VMs in the
* App Service Environment.
- * @member {array} [vipMappings] Description of IP SSL mapping for the App
+ * @property {array} [vipMappings] Description of IP SSL mapping for the App
* Service Environment.
- * @member {array} [environmentCapacities] Current total, used, and available
- * worker capacities.
- * @member {array} [networkAccessControlList] Access control list for
+ * @property {array} [environmentCapacities] Current total, used, and
+ * available worker capacities.
+ * @property {array} [networkAccessControlList] Access control list for
* controlling traffic to the App Service Environment.
- * @member {boolean} [environmentIsHealthy] True/false indicating whether the
- * App Service Environment is healthy.
- * @member {string} [environmentStatus] Detailed message about with results
+ * @property {boolean} [environmentIsHealthy] True/false indicating whether
+ * the App Service Environment is healthy.
+ * @property {string} [environmentStatus] Detailed message about with results
* of the last check of the App Service Environment.
- * @member {string} [resourceGroup] Resource group of the App Service
+ * @property {string} [resourceGroup] Resource group of the App Service
* Environment.
- * @member {number} [frontEndScaleFactor] Scale factor for front-ends.
- * @member {number} [defaultFrontEndScaleFactor] Default Scale Factor for
+ * @property {number} [frontEndScaleFactor] Scale factor for front-ends.
+ * @property {number} [defaultFrontEndScaleFactor] Default Scale Factor for
* FrontEnds.
- * @member {string} [apiManagementAccountId] API Management Account
+ * @property {string} [apiManagementAccountId] API Management Account
* associated with the App Service Environment.
- * @member {boolean} [suspended] true if the App Service
+ * @property {boolean} [suspended] true if the App Service
* Environment is suspended; otherwise, false. The environment
* can be suspended, e.g. when the management endpoint is no longer available
* (most likely because NSG blocked the incoming traffic).
- * @member {boolean} [dynamicCacheEnabled] True/false indicating whether the
- * App Service Environment is suspended. The environment can be suspended
+ * @property {boolean} [dynamicCacheEnabled] True/false indicating whether
+ * the App Service Environment is suspended. The environment can be suspended
* e.g. when the management endpoint is no longer available
* (most likely because NSG blocked the incoming traffic).
- * @member {array} [clusterSettings] Custom settings for changing the
+ * @property {array} [clusterSettings] Custom settings for changing the
* behavior of the App Service Environment.
- * @member {array} [userWhitelistedIpRanges] User added ip ranges to
+ * @property {array} [userWhitelistedIpRanges] User added ip ranges to
* whitelist on ASE db
- * @member {boolean} [hasLinuxWorkers] Flag that displays whether an ASE has
- * linux workers or not
- * @member {string} [sslCertKeyVaultId] Key Vault ID for ILB App Service
+ * @property {boolean} [hasLinuxWorkers] Flag that displays whether an ASE
+ * has linux workers or not
+ * @property {string} [sslCertKeyVaultId] Key Vault ID for ILB App Service
* Environment default SSL certificate
- * @member {string} [sslCertKeyVaultSecretName] Key Vault Secret Name for ILB
- * App Service Environment default SSL certificate
+ * @property {string} [sslCertKeyVaultSecretName] Key Vault Secret Name for
+ * ILB App Service Environment default SSL certificate
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/appServiceEnvironmentCollection.js b/lib/services/websiteManagement2/lib/models/appServiceEnvironmentCollection.js
index 7c44f399b6..1ad05ea00e 100644
--- a/lib/services/websiteManagement2/lib/models/appServiceEnvironmentCollection.js
+++ b/lib/services/websiteManagement2/lib/models/appServiceEnvironmentCollection.js
@@ -16,7 +16,7 @@
class AppServiceEnvironmentCollection extends Array {
/**
* Create a AppServiceEnvironmentCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/appServiceEnvironmentPatchResource.js b/lib/services/websiteManagement2/lib/models/appServiceEnvironmentPatchResource.js
index ab454a36fc..54787ed169 100644
--- a/lib/services/websiteManagement2/lib/models/appServiceEnvironmentPatchResource.js
+++ b/lib/services/websiteManagement2/lib/models/appServiceEnvironmentPatchResource.js
@@ -13,98 +13,98 @@
const models = require('./index');
/**
- * ARM resource for a app service enviroment.
+ * ARM resource for a app service environment.
*
* @extends models['ProxyOnlyResource']
*/
class AppServiceEnvironmentPatchResource extends models['ProxyOnlyResource'] {
/**
* Create a AppServiceEnvironmentPatchResource.
- * @member {string} appServiceEnvironmentPatchResourceName Name of the App
+ * @property {string} appServiceEnvironmentPatchResourceName Name of the App
* Service Environment.
- * @member {string} location Location of the App Service Environment, e.g.
+ * @property {string} location Location of the App Service Environment, e.g.
* "West US".
- * @member {string} [provisioningState] Provisioning state of the App Service
- * Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled',
- * 'InProgress', 'Deleting'
- * @member {string} [status] Current status of the App Service Environment.
+ * @property {string} [provisioningState] Provisioning state of the App
+ * Service Environment. Possible values include: 'Succeeded', 'Failed',
+ * 'Canceled', 'InProgress', 'Deleting'
+ * @property {string} [status] Current status of the App Service Environment.
* Possible values include: 'Preparing', 'Ready', 'Scaling', 'Deleting'
- * @member {string} [vnetName] Name of the Virtual Network for the App
+ * @property {string} [vnetName] Name of the Virtual Network for the App
* Service Environment.
- * @member {string} [vnetResourceGroupName] Resource group of the Virtual
+ * @property {string} [vnetResourceGroupName] Resource group of the Virtual
* Network.
- * @member {string} [vnetSubnetName] Subnet of the Virtual Network.
- * @member {object} virtualNetwork Description of the Virtual Network.
- * @member {string} [virtualNetwork.id] Resource id of the Virtual Network.
- * @member {string} [virtualNetwork.name] Name of the Virtual Network
+ * @property {string} [vnetSubnetName] Subnet of the Virtual Network.
+ * @property {object} virtualNetwork Description of the Virtual Network.
+ * @property {string} [virtualNetwork.id] Resource id of the Virtual Network.
+ * @property {string} [virtualNetwork.name] Name of the Virtual Network
* (read-only).
- * @member {string} [virtualNetwork.type] Resource type of the Virtual
+ * @property {string} [virtualNetwork.type] Resource type of the Virtual
* Network (read-only).
- * @member {string} [virtualNetwork.subnet] Subnet within the Virtual
+ * @property {string} [virtualNetwork.subnet] Subnet within the Virtual
* Network.
- * @member {string} [internalLoadBalancingMode] Specifies which endpoints to
- * serve internally in the Virtual Network for the App Service Environment.
- * Possible values include: 'None', 'Web', 'Publishing'
- * @member {string} [multiSize] Front-end VM size, e.g. "Medium", "Large".
- * @member {number} [multiRoleCount] Number of front-end instances.
- * @member {array} workerPools Description of worker pools with worker size
+ * @property {string} [internalLoadBalancingMode] Specifies which endpoints
+ * to serve internally in the Virtual Network for the App Service
+ * Environment. Possible values include: 'None', 'Web', 'Publishing'
+ * @property {string} [multiSize] Front-end VM size, e.g. "Medium", "Large".
+ * @property {number} [multiRoleCount] Number of front-end instances.
+ * @property {array} workerPools Description of worker pools with worker size
* IDs, VM sizes, and number of workers in each pool.
- * @member {number} [ipsslAddressCount] Number of IP SSL addresses reserved
+ * @property {number} [ipsslAddressCount] Number of IP SSL addresses reserved
* for the App Service Environment.
- * @member {string} [databaseEdition] Edition of the metadata database for
+ * @property {string} [databaseEdition] Edition of the metadata database for
* the App Service Environment, e.g. "Standard".
- * @member {string} [databaseServiceObjective] Service objective of the
+ * @property {string} [databaseServiceObjective] Service objective of the
* metadata database for the App Service Environment, e.g. "S0".
- * @member {number} [upgradeDomains] Number of upgrade domains of the App
+ * @property {number} [upgradeDomains] Number of upgrade domains of the App
* Service Environment.
- * @member {string} [subscriptionId] Subscription of the App Service
+ * @property {string} [subscriptionId] Subscription of the App Service
* Environment.
- * @member {string} [dnsSuffix] DNS suffix of the App Service Environment.
- * @member {string} [lastAction] Last deployment action on the App Service
+ * @property {string} [dnsSuffix] DNS suffix of the App Service Environment.
+ * @property {string} [lastAction] Last deployment action on the App Service
* Environment.
- * @member {string} [lastActionResult] Result of the last deployment action
+ * @property {string} [lastActionResult] Result of the last deployment action
* on the App Service Environment.
- * @member {string} [allowedMultiSizes] List of comma separated strings
+ * @property {string} [allowedMultiSizes] List of comma separated strings
* describing which VM sizes are allowed for front-ends.
- * @member {string} [allowedWorkerSizes] List of comma separated strings
+ * @property {string} [allowedWorkerSizes] List of comma separated strings
* describing which VM sizes are allowed for workers.
- * @member {number} [maximumNumberOfMachines] Maximum number of VMs in the
+ * @property {number} [maximumNumberOfMachines] Maximum number of VMs in the
* App Service Environment.
- * @member {array} [vipMappings] Description of IP SSL mapping for the App
+ * @property {array} [vipMappings] Description of IP SSL mapping for the App
* Service Environment.
- * @member {array} [environmentCapacities] Current total, used, and available
- * worker capacities.
- * @member {array} [networkAccessControlList] Access control list for
+ * @property {array} [environmentCapacities] Current total, used, and
+ * available worker capacities.
+ * @property {array} [networkAccessControlList] Access control list for
* controlling traffic to the App Service Environment.
- * @member {boolean} [environmentIsHealthy] True/false indicating whether the
- * App Service Environment is healthy.
- * @member {string} [environmentStatus] Detailed message about with results
+ * @property {boolean} [environmentIsHealthy] True/false indicating whether
+ * the App Service Environment is healthy.
+ * @property {string} [environmentStatus] Detailed message about with results
* of the last check of the App Service Environment.
- * @member {string} [resourceGroup] Resource group of the App Service
+ * @property {string} [resourceGroup] Resource group of the App Service
* Environment.
- * @member {number} [frontEndScaleFactor] Scale factor for front-ends.
- * @member {number} [defaultFrontEndScaleFactor] Default Scale Factor for
+ * @property {number} [frontEndScaleFactor] Scale factor for front-ends.
+ * @property {number} [defaultFrontEndScaleFactor] Default Scale Factor for
* FrontEnds.
- * @member {string} [apiManagementAccountId] API Management Account
+ * @property {string} [apiManagementAccountId] API Management Account
* associated with the App Service Environment.
- * @member {boolean} [suspended] true if the App Service
+ * @property {boolean} [suspended] true if the App Service
* Environment is suspended; otherwise, false. The environment
* can be suspended, e.g. when the management endpoint is no longer available
* (most likely because NSG blocked the incoming traffic).
- * @member {boolean} [dynamicCacheEnabled] True/false indicating whether the
- * App Service Environment is suspended. The environment can be suspended
+ * @property {boolean} [dynamicCacheEnabled] True/false indicating whether
+ * the App Service Environment is suspended. The environment can be suspended
* e.g. when the management endpoint is no longer available
* (most likely because NSG blocked the incoming traffic).
- * @member {array} [clusterSettings] Custom settings for changing the
+ * @property {array} [clusterSettings] Custom settings for changing the
* behavior of the App Service Environment.
- * @member {array} [userWhitelistedIpRanges] User added ip ranges to
+ * @property {array} [userWhitelistedIpRanges] User added ip ranges to
* whitelist on ASE db
- * @member {boolean} [hasLinuxWorkers] Flag that displays whether an ASE has
- * linux workers or not
- * @member {string} [sslCertKeyVaultId] Key Vault ID for ILB App Service
+ * @property {boolean} [hasLinuxWorkers] Flag that displays whether an ASE
+ * has linux workers or not
+ * @property {string} [sslCertKeyVaultId] Key Vault ID for ILB App Service
* Environment default SSL certificate
- * @member {string} [sslCertKeyVaultSecretName] Key Vault Secret Name for ILB
- * App Service Environment default SSL certificate
+ * @property {string} [sslCertKeyVaultSecretName] Key Vault Secret Name for
+ * ILB App Service Environment default SSL certificate
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/appServiceEnvironmentResource.js b/lib/services/websiteManagement2/lib/models/appServiceEnvironmentResource.js
index 462a7c2f8b..f1bc303671 100644
--- a/lib/services/websiteManagement2/lib/models/appServiceEnvironmentResource.js
+++ b/lib/services/websiteManagement2/lib/models/appServiceEnvironmentResource.js
@@ -20,91 +20,91 @@ const models = require('./index');
class AppServiceEnvironmentResource extends models['Resource'] {
/**
* Create a AppServiceEnvironmentResource.
- * @member {string} appServiceEnvironmentResourceName Name of the App Service
- * Environment.
- * @member {string} appServiceEnvironmentResourceLocation Location of the App
- * Service Environment, e.g. "West US".
- * @member {string} [provisioningState] Provisioning state of the App Service
- * Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled',
- * 'InProgress', 'Deleting'
- * @member {string} [status] Current status of the App Service Environment.
+ * @property {string} appServiceEnvironmentResourceName Name of the App
+ * Service Environment.
+ * @property {string} appServiceEnvironmentResourceLocation Location of the
+ * App Service Environment, e.g. "West US".
+ * @property {string} [provisioningState] Provisioning state of the App
+ * Service Environment. Possible values include: 'Succeeded', 'Failed',
+ * 'Canceled', 'InProgress', 'Deleting'
+ * @property {string} [status] Current status of the App Service Environment.
* Possible values include: 'Preparing', 'Ready', 'Scaling', 'Deleting'
- * @member {string} [vnetName] Name of the Virtual Network for the App
+ * @property {string} [vnetName] Name of the Virtual Network for the App
* Service Environment.
- * @member {string} [vnetResourceGroupName] Resource group of the Virtual
+ * @property {string} [vnetResourceGroupName] Resource group of the Virtual
* Network.
- * @member {string} [vnetSubnetName] Subnet of the Virtual Network.
- * @member {object} virtualNetwork Description of the Virtual Network.
- * @member {string} [virtualNetwork.id] Resource id of the Virtual Network.
- * @member {string} [virtualNetwork.name] Name of the Virtual Network
+ * @property {string} [vnetSubnetName] Subnet of the Virtual Network.
+ * @property {object} virtualNetwork Description of the Virtual Network.
+ * @property {string} [virtualNetwork.id] Resource id of the Virtual Network.
+ * @property {string} [virtualNetwork.name] Name of the Virtual Network
* (read-only).
- * @member {string} [virtualNetwork.type] Resource type of the Virtual
+ * @property {string} [virtualNetwork.type] Resource type of the Virtual
* Network (read-only).
- * @member {string} [virtualNetwork.subnet] Subnet within the Virtual
+ * @property {string} [virtualNetwork.subnet] Subnet within the Virtual
* Network.
- * @member {string} [internalLoadBalancingMode] Specifies which endpoints to
- * serve internally in the Virtual Network for the App Service Environment.
- * Possible values include: 'None', 'Web', 'Publishing'
- * @member {string} [multiSize] Front-end VM size, e.g. "Medium", "Large".
- * @member {number} [multiRoleCount] Number of front-end instances.
- * @member {array} workerPools Description of worker pools with worker size
+ * @property {string} [internalLoadBalancingMode] Specifies which endpoints
+ * to serve internally in the Virtual Network for the App Service
+ * Environment. Possible values include: 'None', 'Web', 'Publishing'
+ * @property {string} [multiSize] Front-end VM size, e.g. "Medium", "Large".
+ * @property {number} [multiRoleCount] Number of front-end instances.
+ * @property {array} workerPools Description of worker pools with worker size
* IDs, VM sizes, and number of workers in each pool.
- * @member {number} [ipsslAddressCount] Number of IP SSL addresses reserved
+ * @property {number} [ipsslAddressCount] Number of IP SSL addresses reserved
* for the App Service Environment.
- * @member {string} [databaseEdition] Edition of the metadata database for
+ * @property {string} [databaseEdition] Edition of the metadata database for
* the App Service Environment, e.g. "Standard".
- * @member {string} [databaseServiceObjective] Service objective of the
+ * @property {string} [databaseServiceObjective] Service objective of the
* metadata database for the App Service Environment, e.g. "S0".
- * @member {number} [upgradeDomains] Number of upgrade domains of the App
+ * @property {number} [upgradeDomains] Number of upgrade domains of the App
* Service Environment.
- * @member {string} [subscriptionId] Subscription of the App Service
+ * @property {string} [subscriptionId] Subscription of the App Service
* Environment.
- * @member {string} [dnsSuffix] DNS suffix of the App Service Environment.
- * @member {string} [lastAction] Last deployment action on the App Service
+ * @property {string} [dnsSuffix] DNS suffix of the App Service Environment.
+ * @property {string} [lastAction] Last deployment action on the App Service
* Environment.
- * @member {string} [lastActionResult] Result of the last deployment action
+ * @property {string} [lastActionResult] Result of the last deployment action
* on the App Service Environment.
- * @member {string} [allowedMultiSizes] List of comma separated strings
+ * @property {string} [allowedMultiSizes] List of comma separated strings
* describing which VM sizes are allowed for front-ends.
- * @member {string} [allowedWorkerSizes] List of comma separated strings
+ * @property {string} [allowedWorkerSizes] List of comma separated strings
* describing which VM sizes are allowed for workers.
- * @member {number} [maximumNumberOfMachines] Maximum number of VMs in the
+ * @property {number} [maximumNumberOfMachines] Maximum number of VMs in the
* App Service Environment.
- * @member {array} [vipMappings] Description of IP SSL mapping for the App
+ * @property {array} [vipMappings] Description of IP SSL mapping for the App
* Service Environment.
- * @member {array} [environmentCapacities] Current total, used, and available
- * worker capacities.
- * @member {array} [networkAccessControlList] Access control list for
+ * @property {array} [environmentCapacities] Current total, used, and
+ * available worker capacities.
+ * @property {array} [networkAccessControlList] Access control list for
* controlling traffic to the App Service Environment.
- * @member {boolean} [environmentIsHealthy] True/false indicating whether the
- * App Service Environment is healthy.
- * @member {string} [environmentStatus] Detailed message about with results
+ * @property {boolean} [environmentIsHealthy] True/false indicating whether
+ * the App Service Environment is healthy.
+ * @property {string} [environmentStatus] Detailed message about with results
* of the last check of the App Service Environment.
- * @member {string} [resourceGroup] Resource group of the App Service
+ * @property {string} [resourceGroup] Resource group of the App Service
* Environment.
- * @member {number} [frontEndScaleFactor] Scale factor for front-ends.
- * @member {number} [defaultFrontEndScaleFactor] Default Scale Factor for
+ * @property {number} [frontEndScaleFactor] Scale factor for front-ends.
+ * @property {number} [defaultFrontEndScaleFactor] Default Scale Factor for
* FrontEnds.
- * @member {string} [apiManagementAccountId] API Management Account
+ * @property {string} [apiManagementAccountId] API Management Account
* associated with the App Service Environment.
- * @member {boolean} [suspended] true if the App Service
+ * @property {boolean} [suspended] true if the App Service
* Environment is suspended; otherwise, false. The environment
* can be suspended, e.g. when the management endpoint is no longer available
* (most likely because NSG blocked the incoming traffic).
- * @member {boolean} [dynamicCacheEnabled] True/false indicating whether the
- * App Service Environment is suspended. The environment can be suspended
+ * @property {boolean} [dynamicCacheEnabled] True/false indicating whether
+ * the App Service Environment is suspended. The environment can be suspended
* e.g. when the management endpoint is no longer available
* (most likely because NSG blocked the incoming traffic).
- * @member {array} [clusterSettings] Custom settings for changing the
+ * @property {array} [clusterSettings] Custom settings for changing the
* behavior of the App Service Environment.
- * @member {array} [userWhitelistedIpRanges] User added ip ranges to
+ * @property {array} [userWhitelistedIpRanges] User added ip ranges to
* whitelist on ASE db
- * @member {boolean} [hasLinuxWorkers] Flag that displays whether an ASE has
- * linux workers or not
- * @member {string} [sslCertKeyVaultId] Key Vault ID for ILB App Service
+ * @property {boolean} [hasLinuxWorkers] Flag that displays whether an ASE
+ * has linux workers or not
+ * @property {string} [sslCertKeyVaultId] Key Vault ID for ILB App Service
* Environment default SSL certificate
- * @member {string} [sslCertKeyVaultSecretName] Key Vault Secret Name for ILB
- * App Service Environment default SSL certificate
+ * @property {string} [sslCertKeyVaultSecretName] Key Vault Secret Name for
+ * ILB App Service Environment default SSL certificate
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/appServicePlan.js b/lib/services/websiteManagement2/lib/models/appServicePlan.js
index 52f4a0c0fb..338221c04a 100644
--- a/lib/services/websiteManagement2/lib/models/appServicePlan.js
+++ b/lib/services/websiteManagement2/lib/models/appServicePlan.js
@@ -20,70 +20,70 @@ const models = require('./index');
class AppServicePlan extends models['Resource'] {
/**
* Create a AppServicePlan.
- * @member {string} [workerTierName] Target worker tier assigned to the App
+ * @property {string} [workerTierName] Target worker tier assigned to the App
* Service plan.
- * @member {string} [status] App Service plan status. Possible values
+ * @property {string} [status] App Service plan status. Possible values
* include: 'Ready', 'Pending', 'Creating'
- * @member {string} [subscription] App Service plan subscription.
- * @member {string} [adminSiteName] App Service plan administration site.
- * @member {object} [hostingEnvironmentProfile] Specification for the App
+ * @property {string} [subscription] App Service plan subscription.
+ * @property {string} [adminSiteName] App Service plan administration site.
+ * @property {object} [hostingEnvironmentProfile] Specification for the App
* Service Environment to use for the App Service plan.
- * @member {string} [hostingEnvironmentProfile.id] Resource ID of the App
+ * @property {string} [hostingEnvironmentProfile.id] Resource ID of the App
* Service Environment.
- * @member {string} [hostingEnvironmentProfile.name] Name of the App Service
- * Environment.
- * @member {string} [hostingEnvironmentProfile.type] Resource type of the App
+ * @property {string} [hostingEnvironmentProfile.name] Name of the App
* Service Environment.
- * @member {number} [maximumNumberOfWorkers] Maximum number of instances that
- * can be assigned to this App Service plan.
- * @member {string} [geoRegion] Geographical location for the App Service
+ * @property {string} [hostingEnvironmentProfile.type] Resource type of the
+ * App Service Environment.
+ * @property {number} [maximumNumberOfWorkers] Maximum number of instances
+ * that can be assigned to this App Service plan.
+ * @property {string} [geoRegion] Geographical location for the App Service
* plan.
- * @member {boolean} [perSiteScaling] If true, apps assigned to
- * this App Service plan can be scaled independently.
+ * @property {boolean} [perSiteScaling] If true, apps assigned
+ * to this App Service plan can be scaled independently.
* If false, apps assigned to this App Service plan will scale
* to all instances of the plan. Default value: false .
- * @member {number} [maximumElasticWorkerCount] Maximum number of total
+ * @property {number} [maximumElasticWorkerCount] Maximum number of total
* workers allowed for this ElasticScaleEnabled App Service Plan
- * @member {number} [numberOfSites] Number of apps assigned to this App
+ * @property {number} [numberOfSites] Number of apps assigned to this App
* Service plan.
- * @member {boolean} [isSpot] If true, this App Service Plan
+ * @property {boolean} [isSpot] If true, this App Service Plan
* owns spot instances.
- * @member {date} [spotExpirationTime] The time when the server farm expires.
- * Valid only if it is a spot server farm.
- * @member {date} [freeOfferExpirationTime] The time when the server farm
+ * @property {date} [spotExpirationTime] The time when the server farm
+ * expires. Valid only if it is a spot server farm.
+ * @property {date} [freeOfferExpirationTime] The time when the server farm
* free offer expires.
- * @member {string} [resourceGroup] Resource group of the App Service plan.
- * @member {boolean} [reserved] If Linux app service plan true,
- * false otherwise. Default value: false .
- * @member {boolean} [isXenon] Obsolete: If Hyper-V container app service
+ * @property {string} [resourceGroup] Resource group of the App Service plan.
+ * @property {boolean} [reserved] If Linux app service plan
+ * true, false otherwise. Default value: false .
+ * @property {boolean} [isXenon] Obsolete: If Hyper-V container app service
* plan true, false otherwise. Default value: false
* .
- * @member {boolean} [hyperV] If Hyper-V container app service plan
+ * @property {boolean} [hyperV] If Hyper-V container app service plan
* true, false otherwise. Default value: false .
- * @member {number} [targetWorkerCount] Scaling worker count.
- * @member {number} [targetWorkerSizeId] Scaling worker size ID.
- * @member {string} [provisioningState] Provisioning state of the App Service
- * Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled',
- * 'InProgress', 'Deleting'
- * @member {object} [sku]
- * @member {string} [sku.name] Name of the resource SKU.
- * @member {string} [sku.tier] Service tier of the resource SKU.
- * @member {string} [sku.size] Size specifier of the resource SKU.
- * @member {string} [sku.family] Family code of the resource SKU.
- * @member {number} [sku.capacity] Current number of instances assigned to
+ * @property {number} [targetWorkerCount] Scaling worker count.
+ * @property {number} [targetWorkerSizeId] Scaling worker size ID.
+ * @property {string} [provisioningState] Provisioning state of the App
+ * Service Environment. Possible values include: 'Succeeded', 'Failed',
+ * 'Canceled', 'InProgress', 'Deleting'
+ * @property {object} [sku]
+ * @property {string} [sku.name] Name of the resource SKU.
+ * @property {string} [sku.tier] Service tier of the resource SKU.
+ * @property {string} [sku.size] Size specifier of the resource SKU.
+ * @property {string} [sku.family] Family code of the resource SKU.
+ * @property {number} [sku.capacity] Current number of instances assigned to
* the resource.
- * @member {object} [sku.skuCapacity] Min, max, and default scale values of
+ * @property {object} [sku.skuCapacity] Min, max, and default scale values of
* the SKU.
- * @member {number} [sku.skuCapacity.minimum] Minimum number of workers for
+ * @property {number} [sku.skuCapacity.minimum] Minimum number of workers for
* this App Service plan SKU.
- * @member {number} [sku.skuCapacity.maximum] Maximum number of workers for
+ * @property {number} [sku.skuCapacity.maximum] Maximum number of workers for
* this App Service plan SKU.
- * @member {number} [sku.skuCapacity.default] Default number of workers for
+ * @property {number} [sku.skuCapacity.default] Default number of workers for
* this App Service plan SKU.
- * @member {string} [sku.skuCapacity.scaleType] Available scale
+ * @property {string} [sku.skuCapacity.scaleType] Available scale
* configurations for an App Service plan.
- * @member {array} [sku.locations] Locations of the SKU.
- * @member {array} [sku.capabilities] Capabilities of the SKU, e.g., is
+ * @property {array} [sku.locations] Locations of the SKU.
+ * @property {array} [sku.capabilities] Capabilities of the SKU, e.g., is
* traffic manager enabled?
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/appServicePlanCollection.js b/lib/services/websiteManagement2/lib/models/appServicePlanCollection.js
index 74827eafd6..e14190905d 100644
--- a/lib/services/websiteManagement2/lib/models/appServicePlanCollection.js
+++ b/lib/services/websiteManagement2/lib/models/appServicePlanCollection.js
@@ -16,7 +16,7 @@
class AppServicePlanCollection extends Array {
/**
* Create a AppServicePlanCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/appServicePlanPatchResource.js b/lib/services/websiteManagement2/lib/models/appServicePlanPatchResource.js
index d16dc241df..85c53ee562 100644
--- a/lib/services/websiteManagement2/lib/models/appServicePlanPatchResource.js
+++ b/lib/services/websiteManagement2/lib/models/appServicePlanPatchResource.js
@@ -20,51 +20,51 @@ const models = require('./index');
class AppServicePlanPatchResource extends models['ProxyOnlyResource'] {
/**
* Create a AppServicePlanPatchResource.
- * @member {string} [workerTierName] Target worker tier assigned to the App
+ * @property {string} [workerTierName] Target worker tier assigned to the App
* Service plan.
- * @member {string} [status] App Service plan status. Possible values
+ * @property {string} [status] App Service plan status. Possible values
* include: 'Ready', 'Pending', 'Creating'
- * @member {string} [subscription] App Service plan subscription.
- * @member {string} [adminSiteName] App Service plan administration site.
- * @member {object} [hostingEnvironmentProfile] Specification for the App
+ * @property {string} [subscription] App Service plan subscription.
+ * @property {string} [adminSiteName] App Service plan administration site.
+ * @property {object} [hostingEnvironmentProfile] Specification for the App
* Service Environment to use for the App Service plan.
- * @member {string} [hostingEnvironmentProfile.id] Resource ID of the App
+ * @property {string} [hostingEnvironmentProfile.id] Resource ID of the App
* Service Environment.
- * @member {string} [hostingEnvironmentProfile.name] Name of the App Service
- * Environment.
- * @member {string} [hostingEnvironmentProfile.type] Resource type of the App
+ * @property {string} [hostingEnvironmentProfile.name] Name of the App
* Service Environment.
- * @member {number} [maximumNumberOfWorkers] Maximum number of instances that
- * can be assigned to this App Service plan.
- * @member {string} [geoRegion] Geographical location for the App Service
+ * @property {string} [hostingEnvironmentProfile.type] Resource type of the
+ * App Service Environment.
+ * @property {number} [maximumNumberOfWorkers] Maximum number of instances
+ * that can be assigned to this App Service plan.
+ * @property {string} [geoRegion] Geographical location for the App Service
* plan.
- * @member {boolean} [perSiteScaling] If true, apps assigned to
- * this App Service plan can be scaled independently.
+ * @property {boolean} [perSiteScaling] If true, apps assigned
+ * to this App Service plan can be scaled independently.
* If false, apps assigned to this App Service plan will scale
* to all instances of the plan. Default value: false .
- * @member {number} [maximumElasticWorkerCount] Maximum number of total
+ * @property {number} [maximumElasticWorkerCount] Maximum number of total
* workers allowed for this ElasticScaleEnabled App Service Plan
- * @member {number} [numberOfSites] Number of apps assigned to this App
+ * @property {number} [numberOfSites] Number of apps assigned to this App
* Service plan.
- * @member {boolean} [isSpot] If true, this App Service Plan
+ * @property {boolean} [isSpot] If true, this App Service Plan
* owns spot instances.
- * @member {date} [spotExpirationTime] The time when the server farm expires.
- * Valid only if it is a spot server farm.
- * @member {date} [freeOfferExpirationTime] The time when the server farm
+ * @property {date} [spotExpirationTime] The time when the server farm
+ * expires. Valid only if it is a spot server farm.
+ * @property {date} [freeOfferExpirationTime] The time when the server farm
* free offer expires.
- * @member {string} [resourceGroup] Resource group of the App Service plan.
- * @member {boolean} [reserved] If Linux app service plan true,
- * false otherwise. Default value: false .
- * @member {boolean} [isXenon] Obsolete: If Hyper-V container app service
+ * @property {string} [resourceGroup] Resource group of the App Service plan.
+ * @property {boolean} [reserved] If Linux app service plan
+ * true, false otherwise. Default value: false .
+ * @property {boolean} [isXenon] Obsolete: If Hyper-V container app service
* plan true, false otherwise. Default value: false
* .
- * @member {boolean} [hyperV] If Hyper-V container app service plan
+ * @property {boolean} [hyperV] If Hyper-V container app service plan
* true, false otherwise. Default value: false .
- * @member {number} [targetWorkerCount] Scaling worker count.
- * @member {number} [targetWorkerSizeId] Scaling worker size ID.
- * @member {string} [provisioningState] Provisioning state of the App Service
- * Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled',
- * 'InProgress', 'Deleting'
+ * @property {number} [targetWorkerCount] Scaling worker count.
+ * @property {number} [targetWorkerSizeId] Scaling worker size ID.
+ * @property {string} [provisioningState] Provisioning state of the App
+ * Service Environment. Possible values include: 'Succeeded', 'Failed',
+ * 'Canceled', 'InProgress', 'Deleting'
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/applicationLogsConfig.js b/lib/services/websiteManagement2/lib/models/applicationLogsConfig.js
index ab1e59ff5f..2332ec8d9f 100644
--- a/lib/services/websiteManagement2/lib/models/applicationLogsConfig.js
+++ b/lib/services/websiteManagement2/lib/models/applicationLogsConfig.js
@@ -17,23 +17,23 @@
class ApplicationLogsConfig {
/**
* Create a ApplicationLogsConfig.
- * @member {object} [fileSystem] Application logs to file system
+ * @property {object} [fileSystem] Application logs to file system
* configuration.
- * @member {string} [fileSystem.level] Log level. Possible values include:
+ * @property {string} [fileSystem.level] Log level. Possible values include:
* 'Off', 'Verbose', 'Information', 'Warning', 'Error'
- * @member {object} [azureTableStorage] Application logs to azure table
+ * @property {object} [azureTableStorage] Application logs to azure table
* storage configuration.
- * @member {string} [azureTableStorage.level] Log level. Possible values
+ * @property {string} [azureTableStorage.level] Log level. Possible values
* include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'
- * @member {string} [azureTableStorage.sasUrl] SAS URL to an Azure table with
- * add/query/delete permissions.
- * @member {object} [azureBlobStorage] Application logs to blob storage
+ * @property {string} [azureTableStorage.sasUrl] SAS URL to an Azure table
+ * with add/query/delete permissions.
+ * @property {object} [azureBlobStorage] Application logs to blob storage
* configuration.
- * @member {string} [azureBlobStorage.level] Log level. Possible values
+ * @property {string} [azureBlobStorage.level] Log level. Possible values
* include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'
- * @member {string} [azureBlobStorage.sasUrl] SAS url to a azure blob
+ * @property {string} [azureBlobStorage.sasUrl] SAS url to a azure blob
* container with read/write/list/delete permissions.
- * @member {number} [azureBlobStorage.retentionInDays] Retention in days.
+ * @property {number} [azureBlobStorage.retentionInDays] Retention in days.
* Remove blobs older than X days.
* 0 or lower means no retention.
*/
diff --git a/lib/services/websiteManagement2/lib/models/applicationStack.js b/lib/services/websiteManagement2/lib/models/applicationStack.js
index 50974c2600..fed42c9692 100644
--- a/lib/services/websiteManagement2/lib/models/applicationStack.js
+++ b/lib/services/websiteManagement2/lib/models/applicationStack.js
@@ -17,11 +17,11 @@
class ApplicationStack {
/**
* Create a ApplicationStack.
- * @member {string} [name] Application stack name.
- * @member {string} [display] Application stack display name.
- * @member {string} [dependency] Application stack dependency.
- * @member {array} [majorVersions] List of major versions available.
- * @member {array} [frameworks] List of frameworks associated with
+ * @property {string} [name] Application stack name.
+ * @property {string} [display] Application stack display name.
+ * @property {string} [dependency] Application stack dependency.
+ * @property {array} [majorVersions] List of major versions available.
+ * @property {array} [frameworks] List of frameworks associated with
* application stack.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/applicationStackCollection.js b/lib/services/websiteManagement2/lib/models/applicationStackCollection.js
index 03e5ff0ee5..7172038145 100644
--- a/lib/services/websiteManagement2/lib/models/applicationStackCollection.js
+++ b/lib/services/websiteManagement2/lib/models/applicationStackCollection.js
@@ -16,7 +16,7 @@
class ApplicationStackCollection extends Array {
/**
* Create a ApplicationStackCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/autoHealActions.js b/lib/services/websiteManagement2/lib/models/autoHealActions.js
index 87cba99f34..d3f01aaee5 100644
--- a/lib/services/websiteManagement2/lib/models/autoHealActions.js
+++ b/lib/services/websiteManagement2/lib/models/autoHealActions.js
@@ -17,12 +17,13 @@
class AutoHealActions {
/**
* Create a AutoHealActions.
- * @member {string} [actionType] Predefined action to be taken. Possible
+ * @property {string} [actionType] Predefined action to be taken. Possible
* values include: 'Recycle', 'LogEvent', 'CustomAction'
- * @member {object} [customAction] Custom action to be taken.
- * @member {string} [customAction.exe] Executable to be run.
- * @member {string} [customAction.parameters] Parameters for the executable.
- * @member {string} [minProcessExecutionTime] Minimum time the process must
+ * @property {object} [customAction] Custom action to be taken.
+ * @property {string} [customAction.exe] Executable to be run.
+ * @property {string} [customAction.parameters] Parameters for the
+ * executable.
+ * @property {string} [minProcessExecutionTime] Minimum time the process must
* execute
* before taking the action
*/
diff --git a/lib/services/websiteManagement2/lib/models/autoHealCustomAction.js b/lib/services/websiteManagement2/lib/models/autoHealCustomAction.js
index d60d7dc348..04dfb4585c 100644
--- a/lib/services/websiteManagement2/lib/models/autoHealCustomAction.js
+++ b/lib/services/websiteManagement2/lib/models/autoHealCustomAction.js
@@ -18,8 +18,8 @@
class AutoHealCustomAction {
/**
* Create a AutoHealCustomAction.
- * @member {string} [exe] Executable to be run.
- * @member {string} [parameters] Parameters for the executable.
+ * @property {string} [exe] Executable to be run.
+ * @property {string} [parameters] Parameters for the executable.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/autoHealRules.js b/lib/services/websiteManagement2/lib/models/autoHealRules.js
index d2975a1396..2744a19805 100644
--- a/lib/services/websiteManagement2/lib/models/autoHealRules.js
+++ b/lib/services/websiteManagement2/lib/models/autoHealRules.js
@@ -17,28 +17,28 @@
class AutoHealRules {
/**
* Create a AutoHealRules.
- * @member {object} [triggers] Conditions that describe when to execute the
+ * @property {object} [triggers] Conditions that describe when to execute the
* auto-heal actions.
- * @member {object} [triggers.requests] A rule based on total requests.
- * @member {number} [triggers.requests.count] Request Count.
- * @member {string} [triggers.requests.timeInterval] Time interval.
- * @member {number} [triggers.privateBytesInKB] A rule based on private
+ * @property {object} [triggers.requests] A rule based on total requests.
+ * @property {number} [triggers.requests.count] Request Count.
+ * @property {string} [triggers.requests.timeInterval] Time interval.
+ * @property {number} [triggers.privateBytesInKB] A rule based on private
* bytes.
- * @member {array} [triggers.statusCodes] A rule based on status codes.
- * @member {object} [triggers.slowRequests] A rule based on request execution
- * time.
- * @member {string} [triggers.slowRequests.timeTaken] Time taken.
- * @member {number} [triggers.slowRequests.count] Request Count.
- * @member {string} [triggers.slowRequests.timeInterval] Time interval.
- * @member {object} [actions] Actions to be executed when a rule is
+ * @property {array} [triggers.statusCodes] A rule based on status codes.
+ * @property {object} [triggers.slowRequests] A rule based on request
+ * execution time.
+ * @property {string} [triggers.slowRequests.timeTaken] Time taken.
+ * @property {number} [triggers.slowRequests.count] Request Count.
+ * @property {string} [triggers.slowRequests.timeInterval] Time interval.
+ * @property {object} [actions] Actions to be executed when a rule is
* triggered.
- * @member {string} [actions.actionType] Predefined action to be taken.
+ * @property {string} [actions.actionType] Predefined action to be taken.
* Possible values include: 'Recycle', 'LogEvent', 'CustomAction'
- * @member {object} [actions.customAction] Custom action to be taken.
- * @member {string} [actions.customAction.exe] Executable to be run.
- * @member {string} [actions.customAction.parameters] Parameters for the
+ * @property {object} [actions.customAction] Custom action to be taken.
+ * @property {string} [actions.customAction.exe] Executable to be run.
+ * @property {string} [actions.customAction.parameters] Parameters for the
* executable.
- * @member {string} [actions.minProcessExecutionTime] Minimum time the
+ * @property {string} [actions.minProcessExecutionTime] Minimum time the
* process must execute
* before taking the action
*/
diff --git a/lib/services/websiteManagement2/lib/models/autoHealTriggers.js b/lib/services/websiteManagement2/lib/models/autoHealTriggers.js
index f14f8dd067..d5d92c1d6e 100644
--- a/lib/services/websiteManagement2/lib/models/autoHealTriggers.js
+++ b/lib/services/websiteManagement2/lib/models/autoHealTriggers.js
@@ -17,15 +17,15 @@
class AutoHealTriggers {
/**
* Create a AutoHealTriggers.
- * @member {object} [requests] A rule based on total requests.
- * @member {number} [requests.count] Request Count.
- * @member {string} [requests.timeInterval] Time interval.
- * @member {number} [privateBytesInKB] A rule based on private bytes.
- * @member {array} [statusCodes] A rule based on status codes.
- * @member {object} [slowRequests] A rule based on request execution time.
- * @member {string} [slowRequests.timeTaken] Time taken.
- * @member {number} [slowRequests.count] Request Count.
- * @member {string} [slowRequests.timeInterval] Time interval.
+ * @property {object} [requests] A rule based on total requests.
+ * @property {number} [requests.count] Request Count.
+ * @property {string} [requests.timeInterval] Time interval.
+ * @property {number} [privateBytesInKB] A rule based on private bytes.
+ * @property {array} [statusCodes] A rule based on status codes.
+ * @property {object} [slowRequests] A rule based on request execution time.
+ * @property {string} [slowRequests.timeTaken] Time taken.
+ * @property {number} [slowRequests.count] Request Count.
+ * @property {string} [slowRequests.timeInterval] Time interval.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/azureBlobStorageApplicationLogsConfig.js b/lib/services/websiteManagement2/lib/models/azureBlobStorageApplicationLogsConfig.js
index 34571a8b2d..05657b237e 100644
--- a/lib/services/websiteManagement2/lib/models/azureBlobStorageApplicationLogsConfig.js
+++ b/lib/services/websiteManagement2/lib/models/azureBlobStorageApplicationLogsConfig.js
@@ -17,11 +17,11 @@
class AzureBlobStorageApplicationLogsConfig {
/**
* Create a AzureBlobStorageApplicationLogsConfig.
- * @member {string} [level] Log level. Possible values include: 'Off',
+ * @property {string} [level] Log level. Possible values include: 'Off',
* 'Verbose', 'Information', 'Warning', 'Error'
- * @member {string} [sasUrl] SAS url to a azure blob container with
+ * @property {string} [sasUrl] SAS url to a azure blob container with
* read/write/list/delete permissions.
- * @member {number} [retentionInDays] Retention in days.
+ * @property {number} [retentionInDays] Retention in days.
* Remove blobs older than X days.
* 0 or lower means no retention.
*/
diff --git a/lib/services/websiteManagement2/lib/models/azureBlobStorageHttpLogsConfig.js b/lib/services/websiteManagement2/lib/models/azureBlobStorageHttpLogsConfig.js
index e7d85bf50e..55ecd6f7f8 100644
--- a/lib/services/websiteManagement2/lib/models/azureBlobStorageHttpLogsConfig.js
+++ b/lib/services/websiteManagement2/lib/models/azureBlobStorageHttpLogsConfig.js
@@ -17,13 +17,13 @@
class AzureBlobStorageHttpLogsConfig {
/**
* Create a AzureBlobStorageHttpLogsConfig.
- * @member {string} [sasUrl] SAS url to a azure blob container with
+ * @property {string} [sasUrl] SAS url to a azure blob container with
* read/write/list/delete permissions.
- * @member {number} [retentionInDays] Retention in days.
+ * @property {number} [retentionInDays] Retention in days.
* Remove blobs older than X days.
* 0 or lower means no retention.
- * @member {boolean} [enabled] True if configuration is enabled, false if it
- * is disabled and null if configuration is not set.
+ * @property {boolean} [enabled] True if configuration is enabled, false if
+ * it is disabled and null if configuration is not set.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/azureStorageInfoValue.js b/lib/services/websiteManagement2/lib/models/azureStorageInfoValue.js
index e30422f824..da381cae56 100644
--- a/lib/services/websiteManagement2/lib/models/azureStorageInfoValue.js
+++ b/lib/services/websiteManagement2/lib/models/azureStorageInfoValue.js
@@ -17,15 +17,15 @@
class AzureStorageInfoValue {
/**
* Create a AzureStorageInfoValue.
- * @member {string} [type] Type of storage. Possible values include:
+ * @property {string} [type] Type of storage. Possible values include:
* 'AzureFiles', 'AzureBlob'
- * @member {string} [accountName] Name of the storage account.
- * @member {string} [shareName] Name of the file share (container name, for
+ * @property {string} [accountName] Name of the storage account.
+ * @property {string} [shareName] Name of the file share (container name, for
* Blob storage).
- * @member {string} [accessKey] Access key for the storage account.
- * @member {string} [mountPath] Path to mount the storage within the site's
+ * @property {string} [accessKey] Access key for the storage account.
+ * @property {string} [mountPath] Path to mount the storage within the site's
* runtime environment.
- * @member {string} [state] State of the storage account. Possible values
+ * @property {string} [state] State of the storage account. Possible values
* include: 'Ok', 'InvalidCredentials', 'InvalidShare'
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/azureStoragePropertyDictionaryResource.js b/lib/services/websiteManagement2/lib/models/azureStoragePropertyDictionaryResource.js
index 0b1b19dc61..d1991b3812 100644
--- a/lib/services/websiteManagement2/lib/models/azureStoragePropertyDictionaryResource.js
+++ b/lib/services/websiteManagement2/lib/models/azureStoragePropertyDictionaryResource.js
@@ -20,7 +20,7 @@ const models = require('./index');
class AzureStoragePropertyDictionaryResource extends models['ProxyOnlyResource'] {
/**
* Create a AzureStoragePropertyDictionaryResource.
- * @member {object} [properties] Azure storage accounts.
+ * @property {object} [properties] Azure storage accounts.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/azureTableStorageApplicationLogsConfig.js b/lib/services/websiteManagement2/lib/models/azureTableStorageApplicationLogsConfig.js
index ae109442ed..047b164f92 100644
--- a/lib/services/websiteManagement2/lib/models/azureTableStorageApplicationLogsConfig.js
+++ b/lib/services/websiteManagement2/lib/models/azureTableStorageApplicationLogsConfig.js
@@ -17,9 +17,9 @@
class AzureTableStorageApplicationLogsConfig {
/**
* Create a AzureTableStorageApplicationLogsConfig.
- * @member {string} [level] Log level. Possible values include: 'Off',
+ * @property {string} [level] Log level. Possible values include: 'Off',
* 'Verbose', 'Information', 'Warning', 'Error'
- * @member {string} sasUrl SAS URL to an Azure table with add/query/delete
+ * @property {string} sasUrl SAS URL to an Azure table with add/query/delete
* permissions.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/backupItem.js b/lib/services/websiteManagement2/lib/models/backupItem.js
index abff5af787..df84343d55 100644
--- a/lib/services/websiteManagement2/lib/models/backupItem.js
+++ b/lib/services/websiteManagement2/lib/models/backupItem.js
@@ -20,28 +20,28 @@ const models = require('./index');
class BackupItem extends models['ProxyOnlyResource'] {
/**
* Create a BackupItem.
- * @member {number} [backupId] Id of the backup.
- * @member {string} [storageAccountUrl] SAS URL for the storage account
+ * @property {number} [backupId] Id of the backup.
+ * @property {string} [storageAccountUrl] SAS URL for the storage account
* container which contains this backup.
- * @member {string} [blobName] Name of the blob which contains data for this
- * backup.
- * @member {string} [backupItemName] Name of this backup.
- * @member {string} [status] Backup status. Possible values include:
+ * @property {string} [blobName] Name of the blob which contains data for
+ * this backup.
+ * @property {string} [backupItemName] Name of this backup.
+ * @property {string} [status] Backup status. Possible values include:
* 'InProgress', 'Failed', 'Succeeded', 'TimedOut', 'Created', 'Skipped',
* 'PartiallySucceeded', 'DeleteInProgress', 'DeleteFailed', 'Deleted'
- * @member {number} [sizeInBytes] Size of the backup in bytes.
- * @member {date} [created] Timestamp of the backup creation.
- * @member {string} [log] Details regarding this backup. Might contain an
+ * @property {number} [sizeInBytes] Size of the backup in bytes.
+ * @property {date} [created] Timestamp of the backup creation.
+ * @property {string} [log] Details regarding this backup. Might contain an
* error message.
- * @member {array} [databases] List of databases included in the backup.
- * @member {boolean} [scheduled] True if this backup has been created due to
- * a schedule being triggered.
- * @member {date} [lastRestoreTimeStamp] Timestamp of a last restore
+ * @property {array} [databases] List of databases included in the backup.
+ * @property {boolean} [scheduled] True if this backup has been created due
+ * to a schedule being triggered.
+ * @property {date} [lastRestoreTimeStamp] Timestamp of a last restore
* operation which used this backup.
- * @member {date} [finishedTimeStamp] Timestamp when this backup finished.
- * @member {string} [correlationId] Unique correlation identifier. Please use
- * this along with the timestamp while communicating with Azure support.
- * @member {number} [websiteSizeInBytes] Size of the original web app which
+ * @property {date} [finishedTimeStamp] Timestamp when this backup finished.
+ * @property {string} [correlationId] Unique correlation identifier. Please
+ * use this along with the timestamp while communicating with Azure support.
+ * @property {number} [websiteSizeInBytes] Size of the original web app which
* has been backed up.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/backupItemCollection.js b/lib/services/websiteManagement2/lib/models/backupItemCollection.js
index 769f26fe98..a9c351702a 100644
--- a/lib/services/websiteManagement2/lib/models/backupItemCollection.js
+++ b/lib/services/websiteManagement2/lib/models/backupItemCollection.js
@@ -16,7 +16,7 @@
class BackupItemCollection extends Array {
/**
* Create a BackupItemCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/backupRequest.js b/lib/services/websiteManagement2/lib/models/backupRequest.js
index d2d1195789..686d4ae9eb 100644
--- a/lib/services/websiteManagement2/lib/models/backupRequest.js
+++ b/lib/services/websiteManagement2/lib/models/backupRequest.js
@@ -20,30 +20,30 @@ const models = require('./index');
class BackupRequest extends models['ProxyOnlyResource'] {
/**
* Create a BackupRequest.
- * @member {string} [backupName] Name of the backup.
- * @member {boolean} [enabled] True if the backup schedule is enabled (must
+ * @property {string} [backupName] Name of the backup.
+ * @property {boolean} [enabled] True if the backup schedule is enabled (must
* be included in that case), false if the backup schedule should be
* disabled.
- * @member {string} storageAccountUrl SAS URL to the container.
- * @member {object} [backupSchedule] Schedule for the backup if it is
+ * @property {string} storageAccountUrl SAS URL to the container.
+ * @property {object} [backupSchedule] Schedule for the backup if it is
* executed periodically.
- * @member {number} [backupSchedule.frequencyInterval] How often the backup
+ * @property {number} [backupSchedule.frequencyInterval] How often the backup
* should be executed (e.g. for weekly backup, this should be set to 7 and
* FrequencyUnit should be set to Day)
- * @member {string} [backupSchedule.frequencyUnit] The unit of time for how
+ * @property {string} [backupSchedule.frequencyUnit] The unit of time for how
* often the backup should be executed (e.g. for weekly backup, this should
* be set to Day and FrequencyInterval should be set to 7). Possible values
* include: 'Day', 'Hour'
- * @member {boolean} [backupSchedule.keepAtLeastOneBackup] True if the
+ * @property {boolean} [backupSchedule.keepAtLeastOneBackup] True if the
* retention policy should always keep at least one backup in the storage
* account, regardless how old it is; false otherwise.
- * @member {number} [backupSchedule.retentionPeriodInDays] After how many
+ * @property {number} [backupSchedule.retentionPeriodInDays] After how many
* days backups should be deleted.
- * @member {date} [backupSchedule.startTime] When the schedule should start
+ * @property {date} [backupSchedule.startTime] When the schedule should start
* working.
- * @member {date} [backupSchedule.lastExecutionTime] Last time when this
+ * @property {date} [backupSchedule.lastExecutionTime] Last time when this
* schedule was triggered.
- * @member {array} [databases] Databases included in the backup.
+ * @property {array} [databases] Databases included in the backup.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/backupSchedule.js b/lib/services/websiteManagement2/lib/models/backupSchedule.js
index b8d86ca61a..ff90506f87 100644
--- a/lib/services/websiteManagement2/lib/models/backupSchedule.js
+++ b/lib/services/websiteManagement2/lib/models/backupSchedule.js
@@ -18,20 +18,20 @@
class BackupSchedule {
/**
* Create a BackupSchedule.
- * @member {number} frequencyInterval How often the backup should be executed
- * (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should
- * be set to Day). Default value: 7 .
- * @member {string} frequencyUnit The unit of time for how often the backup
+ * @property {number} frequencyInterval How often the backup should be
+ * executed (e.g. for weekly backup, this should be set to 7 and
+ * FrequencyUnit should be set to Day). Default value: 7 .
+ * @property {string} frequencyUnit The unit of time for how often the backup
* should be executed (e.g. for weekly backup, this should be set to Day and
* FrequencyInterval should be set to 7). Possible values include: 'Day',
* 'Hour'. Default value: 'Day' .
- * @member {boolean} keepAtLeastOneBackup True if the retention policy should
- * always keep at least one backup in the storage account, regardless how old
- * it is; false otherwise. Default value: true .
- * @member {number} retentionPeriodInDays After how many days backups should
- * be deleted. Default value: 30 .
- * @member {date} [startTime] When the schedule should start working.
- * @member {date} [lastExecutionTime] Last time when this schedule was
+ * @property {boolean} keepAtLeastOneBackup True if the retention policy
+ * should always keep at least one backup in the storage account, regardless
+ * how old it is; false otherwise. Default value: true .
+ * @property {number} retentionPeriodInDays After how many days backups
+ * should be deleted. Default value: 30 .
+ * @property {date} [startTime] When the schedule should start working.
+ * @property {date} [lastExecutionTime] Last time when this schedule was
* triggered.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/billingMeter.js b/lib/services/websiteManagement2/lib/models/billingMeter.js
index aba6effb23..6c20bdc45a 100644
--- a/lib/services/websiteManagement2/lib/models/billingMeter.js
+++ b/lib/services/websiteManagement2/lib/models/billingMeter.js
@@ -21,13 +21,13 @@ const models = require('./index');
class BillingMeter extends models['ProxyOnlyResource'] {
/**
* Create a BillingMeter.
- * @member {string} [meterId] Meter GUID onboarded in Commerce
- * @member {string} [billingLocation] Azure Location of billable resource
- * @member {string} [shortName] Short Name from App Service Azure pricing
+ * @property {string} [meterId] Meter GUID onboarded in Commerce
+ * @property {string} [billingLocation] Azure Location of billable resource
+ * @property {string} [shortName] Short Name from App Service Azure pricing
* Page
- * @member {string} [friendlyName] Friendly name of the meter
- * @member {string} [resourceType] App Service ResourceType meter used for
- * @member {string} [osType] App Service OS type meter used for
+ * @property {string} [friendlyName] Friendly name of the meter
+ * @property {string} [resourceType] App Service ResourceType meter used for
+ * @property {string} [osType] App Service OS type meter used for
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/billingMeterCollection.js b/lib/services/websiteManagement2/lib/models/billingMeterCollection.js
index 731a97562d..a6a7147cc5 100644
--- a/lib/services/websiteManagement2/lib/models/billingMeterCollection.js
+++ b/lib/services/websiteManagement2/lib/models/billingMeterCollection.js
@@ -16,7 +16,7 @@
class BillingMeterCollection extends Array {
/**
* Create a BillingMeterCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/capability.js b/lib/services/websiteManagement2/lib/models/capability.js
index 1d81f3149e..4ab18a8e9b 100644
--- a/lib/services/websiteManagement2/lib/models/capability.js
+++ b/lib/services/websiteManagement2/lib/models/capability.js
@@ -17,9 +17,9 @@
class Capability {
/**
* Create a Capability.
- * @member {string} [name] Name of the SKU capability.
- * @member {string} [value] Value of the SKU capability.
- * @member {string} [reason] Reason of the SKU capability.
+ * @property {string} [name] Name of the SKU capability.
+ * @property {string} [value] Value of the SKU capability.
+ * @property {string} [reason] Reason of the SKU capability.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/certificate.js b/lib/services/websiteManagement2/lib/models/certificate.js
index f7b9f4da55..0b5caa6356 100644
--- a/lib/services/websiteManagement2/lib/models/certificate.js
+++ b/lib/services/websiteManagement2/lib/models/certificate.js
@@ -20,38 +20,38 @@ const models = require('./index');
class Certificate extends models['Resource'] {
/**
* Create a Certificate.
- * @member {string} [friendlyName] Friendly name of the certificate.
- * @member {string} [subjectName] Subject name of the certificate.
- * @member {array} [hostNames] Host names the certificate applies to.
- * @member {buffer} [pfxBlob] Pfx blob.
- * @member {string} [siteName] App name.
- * @member {string} [selfLink] Self link.
- * @member {string} [issuer] Certificate issuer.
- * @member {date} [issueDate] Certificate issue Date.
- * @member {date} [expirationDate] Certificate expriration date.
- * @member {string} password Certificate password.
- * @member {string} [thumbprint] Certificate thumbprint.
- * @member {boolean} [valid] Is the certificate valid?.
- * @member {buffer} [cerBlob] Raw bytes of .cer file
- * @member {string} [publicKeyHash] Public key hash.
- * @member {object} [hostingEnvironmentProfile] Specification for the App
+ * @property {string} [friendlyName] Friendly name of the certificate.
+ * @property {string} [subjectName] Subject name of the certificate.
+ * @property {array} [hostNames] Host names the certificate applies to.
+ * @property {buffer} [pfxBlob] Pfx blob.
+ * @property {string} [siteName] App name.
+ * @property {string} [selfLink] Self link.
+ * @property {string} [issuer] Certificate issuer.
+ * @property {date} [issueDate] Certificate issue Date.
+ * @property {date} [expirationDate] Certificate expriration date.
+ * @property {string} password Certificate password.
+ * @property {string} [thumbprint] Certificate thumbprint.
+ * @property {boolean} [valid] Is the certificate valid?.
+ * @property {buffer} [cerBlob] Raw bytes of .cer file
+ * @property {string} [publicKeyHash] Public key hash.
+ * @property {object} [hostingEnvironmentProfile] Specification for the App
* Service Environment to use for the certificate.
- * @member {string} [hostingEnvironmentProfile.id] Resource ID of the App
+ * @property {string} [hostingEnvironmentProfile.id] Resource ID of the App
* Service Environment.
- * @member {string} [hostingEnvironmentProfile.name] Name of the App Service
- * Environment.
- * @member {string} [hostingEnvironmentProfile.type] Resource type of the App
+ * @property {string} [hostingEnvironmentProfile.name] Name of the App
* Service Environment.
- * @member {string} [keyVaultId] Key Vault Csm resource Id.
- * @member {string} [keyVaultSecretName] Key Vault secret name.
- * @member {string} [keyVaultSecretStatus] Status of the Key Vault secret.
+ * @property {string} [hostingEnvironmentProfile.type] Resource type of the
+ * App Service Environment.
+ * @property {string} [keyVaultId] Key Vault Csm resource Id.
+ * @property {string} [keyVaultSecretName] Key Vault secret name.
+ * @property {string} [keyVaultSecretStatus] Status of the Key Vault secret.
* Possible values include: 'Initialized', 'WaitingOnCertificateOrder',
* 'Succeeded', 'CertificateOrderFailed', 'OperationNotPermittedOnKeyVault',
* 'AzureServiceUnauthorizedToAccessKeyVault', 'KeyVaultDoesNotExist',
* 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey',
* 'Unknown'
- * @member {string} [serverFarmId] Resource ID of the associated App Service
- * plan, formatted as:
+ * @property {string} [serverFarmId] Resource ID of the associated App
+ * Service plan, formatted as:
* "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/certificateCollection.js b/lib/services/websiteManagement2/lib/models/certificateCollection.js
index 43f9fd446c..df513fed95 100644
--- a/lib/services/websiteManagement2/lib/models/certificateCollection.js
+++ b/lib/services/websiteManagement2/lib/models/certificateCollection.js
@@ -16,7 +16,7 @@
class CertificateCollection extends Array {
/**
* Create a CertificateCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/certificateDetails.js b/lib/services/websiteManagement2/lib/models/certificateDetails.js
index affae5c9fc..ad79b9366d 100644
--- a/lib/services/websiteManagement2/lib/models/certificateDetails.js
+++ b/lib/services/websiteManagement2/lib/models/certificateDetails.js
@@ -17,15 +17,15 @@
class CertificateDetails {
/**
* Create a CertificateDetails.
- * @member {number} [version] Certificate Version.
- * @member {string} [serialNumber] Certificate Serial Number.
- * @member {string} [thumbprint] Certificate Thumbprint.
- * @member {string} [subject] Certificate Subject.
- * @member {date} [notBefore] Date Certificate is valid from.
- * @member {date} [notAfter] Date Certificate is valid to.
- * @member {string} [signatureAlgorithm] Certificate Signature algorithm.
- * @member {string} [issuer] Certificate Issuer.
- * @member {string} [rawData] Raw certificate data.
+ * @property {number} [version] Certificate Version.
+ * @property {string} [serialNumber] Certificate Serial Number.
+ * @property {string} [thumbprint] Certificate Thumbprint.
+ * @property {string} [subject] Certificate Subject.
+ * @property {date} [notBefore] Date Certificate is valid from.
+ * @property {date} [notAfter] Date Certificate is valid to.
+ * @property {string} [signatureAlgorithm] Certificate Signature algorithm.
+ * @property {string} [issuer] Certificate Issuer.
+ * @property {string} [rawData] Raw certificate data.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/certificateEmail.js b/lib/services/websiteManagement2/lib/models/certificateEmail.js
index 5ffdc8fae5..ae239eb000 100644
--- a/lib/services/websiteManagement2/lib/models/certificateEmail.js
+++ b/lib/services/websiteManagement2/lib/models/certificateEmail.js
@@ -20,8 +20,8 @@ const models = require('./index');
class CertificateEmail extends models['ProxyOnlyResource'] {
/**
* Create a CertificateEmail.
- * @member {string} [emailId] Email id.
- * @member {date} [timeStamp] Time stamp.
+ * @property {string} [emailId] Email id.
+ * @property {date} [timeStamp] Time stamp.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/certificateOrderAction.js b/lib/services/websiteManagement2/lib/models/certificateOrderAction.js
index 123fb2ad46..458b7ca6bd 100644
--- a/lib/services/websiteManagement2/lib/models/certificateOrderAction.js
+++ b/lib/services/websiteManagement2/lib/models/certificateOrderAction.js
@@ -20,13 +20,13 @@ const models = require('./index');
class CertificateOrderAction extends models['ProxyOnlyResource'] {
/**
* Create a CertificateOrderAction.
- * @member {string} [actionType] Action type. Possible values include:
+ * @property {string} [actionType] Action type. Possible values include:
* 'CertificateIssued', 'CertificateOrderCanceled',
* 'CertificateOrderCreated', 'CertificateRevoked',
* 'DomainValidationComplete', 'FraudDetected', 'OrgNameChange',
* 'OrgValidationComplete', 'SanDrop', 'FraudCleared', 'CertificateExpired',
* 'CertificateExpirationWarning', 'FraudDocumentationRequired', 'Unknown'
- * @member {date} [createdAt] Time at which the certificate action was
+ * @property {date} [createdAt] Time at which the certificate action was
* performed.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/certificatePatchResource.js b/lib/services/websiteManagement2/lib/models/certificatePatchResource.js
index 708ccf5cf0..9dd2ea0510 100644
--- a/lib/services/websiteManagement2/lib/models/certificatePatchResource.js
+++ b/lib/services/websiteManagement2/lib/models/certificatePatchResource.js
@@ -20,38 +20,38 @@ const models = require('./index');
class CertificatePatchResource extends models['ProxyOnlyResource'] {
/**
* Create a CertificatePatchResource.
- * @member {string} [friendlyName] Friendly name of the certificate.
- * @member {string} [subjectName] Subject name of the certificate.
- * @member {array} [hostNames] Host names the certificate applies to.
- * @member {buffer} [pfxBlob] Pfx blob.
- * @member {string} [siteName] App name.
- * @member {string} [selfLink] Self link.
- * @member {string} [issuer] Certificate issuer.
- * @member {date} [issueDate] Certificate issue Date.
- * @member {date} [expirationDate] Certificate expriration date.
- * @member {string} password Certificate password.
- * @member {string} [thumbprint] Certificate thumbprint.
- * @member {boolean} [valid] Is the certificate valid?.
- * @member {buffer} [cerBlob] Raw bytes of .cer file
- * @member {string} [publicKeyHash] Public key hash.
- * @member {object} [hostingEnvironmentProfile] Specification for the App
+ * @property {string} [friendlyName] Friendly name of the certificate.
+ * @property {string} [subjectName] Subject name of the certificate.
+ * @property {array} [hostNames] Host names the certificate applies to.
+ * @property {buffer} [pfxBlob] Pfx blob.
+ * @property {string} [siteName] App name.
+ * @property {string} [selfLink] Self link.
+ * @property {string} [issuer] Certificate issuer.
+ * @property {date} [issueDate] Certificate issue Date.
+ * @property {date} [expirationDate] Certificate expriration date.
+ * @property {string} password Certificate password.
+ * @property {string} [thumbprint] Certificate thumbprint.
+ * @property {boolean} [valid] Is the certificate valid?.
+ * @property {buffer} [cerBlob] Raw bytes of .cer file
+ * @property {string} [publicKeyHash] Public key hash.
+ * @property {object} [hostingEnvironmentProfile] Specification for the App
* Service Environment to use for the certificate.
- * @member {string} [hostingEnvironmentProfile.id] Resource ID of the App
+ * @property {string} [hostingEnvironmentProfile.id] Resource ID of the App
* Service Environment.
- * @member {string} [hostingEnvironmentProfile.name] Name of the App Service
- * Environment.
- * @member {string} [hostingEnvironmentProfile.type] Resource type of the App
+ * @property {string} [hostingEnvironmentProfile.name] Name of the App
* Service Environment.
- * @member {string} [keyVaultId] Key Vault Csm resource Id.
- * @member {string} [keyVaultSecretName] Key Vault secret name.
- * @member {string} [keyVaultSecretStatus] Status of the Key Vault secret.
+ * @property {string} [hostingEnvironmentProfile.type] Resource type of the
+ * App Service Environment.
+ * @property {string} [keyVaultId] Key Vault Csm resource Id.
+ * @property {string} [keyVaultSecretName] Key Vault secret name.
+ * @property {string} [keyVaultSecretStatus] Status of the Key Vault secret.
* Possible values include: 'Initialized', 'WaitingOnCertificateOrder',
* 'Succeeded', 'CertificateOrderFailed', 'OperationNotPermittedOnKeyVault',
* 'AzureServiceUnauthorizedToAccessKeyVault', 'KeyVaultDoesNotExist',
* 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey',
* 'Unknown'
- * @member {string} [serverFarmId] Resource ID of the associated App Service
- * plan, formatted as:
+ * @property {string} [serverFarmId] Resource ID of the associated App
+ * Service plan, formatted as:
* "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/cloningInfo.js b/lib/services/websiteManagement2/lib/models/cloningInfo.js
index 971b705122..6d85e5581a 100644
--- a/lib/services/websiteManagement2/lib/models/cloningInfo.js
+++ b/lib/services/websiteManagement2/lib/models/cloningInfo.js
@@ -17,33 +17,33 @@
class CloningInfo {
/**
* Create a CloningInfo.
- * @member {uuid} [correlationId] Correlation ID of cloning operation. This
+ * @property {uuid} [correlationId] Correlation ID of cloning operation. This
* ID ties multiple cloning operations
* together to use the same snapshot.
- * @member {boolean} [overwrite] true to overwrite destination
+ * @property {boolean} [overwrite] true to overwrite destination
* app; otherwise, false.
- * @member {boolean} [cloneCustomHostNames] true to clone custom
- * hostnames from source app; otherwise, false.
- * @member {boolean} [cloneSourceControl] true to clone source
+ * @property {boolean} [cloneCustomHostNames] true to clone
+ * custom hostnames from source app; otherwise, false.
+ * @property {boolean} [cloneSourceControl] true to clone source
* control from source app; otherwise, false.
- * @member {string} sourceWebAppId ARM resource ID of the source app. App
+ * @property {string} sourceWebAppId ARM resource ID of the source app. App
* resource ID is of the form
* /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}
* for production slots and
* /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName}
* for other slots.
- * @member {string} [hostingEnvironment] App Service Environment.
- * @member {object} [appSettingsOverrides] Application setting overrides for
- * cloned app. If specified, these settings override the settings cloned
+ * @property {string} [hostingEnvironment] App Service Environment.
+ * @property {object} [appSettingsOverrides] Application setting overrides
+ * for cloned app. If specified, these settings override the settings cloned
* from source app. Otherwise, application settings from source app are
* retained.
- * @member {boolean} [configureLoadBalancing] true to configure
- * load balancing for source and destination app.
- * @member {string} [trafficManagerProfileId] ARM resource ID of the Traffic
- * Manager profile to use, if it exists. Traffic Manager resource ID is of
- * the form
+ * @property {boolean} [configureLoadBalancing] true to
+ * configure load balancing for source and destination app.
+ * @property {string} [trafficManagerProfileId] ARM resource ID of the
+ * Traffic Manager profile to use, if it exists. Traffic Manager resource ID
+ * is of the form
* /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.
- * @member {string} [trafficManagerProfileName] Name of Traffic Manager
+ * @property {string} [trafficManagerProfileName] Name of Traffic Manager
* profile to create. This is only needed if Traffic Manager profile does not
* already exist.
*/
diff --git a/lib/services/websiteManagement2/lib/models/connStringInfo.js b/lib/services/websiteManagement2/lib/models/connStringInfo.js
index e45a358633..9b7f0f4eb1 100644
--- a/lib/services/websiteManagement2/lib/models/connStringInfo.js
+++ b/lib/services/websiteManagement2/lib/models/connStringInfo.js
@@ -17,9 +17,9 @@
class ConnStringInfo {
/**
* Create a ConnStringInfo.
- * @member {string} [name] Name of connection string.
- * @member {string} [connectionString] Connection string value.
- * @member {string} [type] Type of database. Possible values include:
+ * @property {string} [name] Name of connection string.
+ * @property {string} [connectionString] Connection string value.
+ * @property {string} [type] Type of database. Possible values include:
* 'MySql', 'SQLServer', 'SQLAzure', 'Custom', 'NotificationHub',
* 'ServiceBus', 'EventHub', 'ApiHub', 'DocDb', 'RedisCache', 'PostgreSQL'
*/
diff --git a/lib/services/websiteManagement2/lib/models/connStringValueTypePair.js b/lib/services/websiteManagement2/lib/models/connStringValueTypePair.js
index b2d1bf7ca1..4621a79ae6 100644
--- a/lib/services/websiteManagement2/lib/models/connStringValueTypePair.js
+++ b/lib/services/websiteManagement2/lib/models/connStringValueTypePair.js
@@ -17,10 +17,10 @@
class ConnStringValueTypePair {
/**
* Create a ConnStringValueTypePair.
- * @member {string} value Value of pair.
- * @member {string} type Type of database. Possible values include: 'MySql',
- * 'SQLServer', 'SQLAzure', 'Custom', 'NotificationHub', 'ServiceBus',
- * 'EventHub', 'ApiHub', 'DocDb', 'RedisCache', 'PostgreSQL'
+ * @property {string} value Value of pair.
+ * @property {string} type Type of database. Possible values include:
+ * 'MySql', 'SQLServer', 'SQLAzure', 'Custom', 'NotificationHub',
+ * 'ServiceBus', 'EventHub', 'ApiHub', 'DocDb', 'RedisCache', 'PostgreSQL'
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/connectionStringDictionary.js b/lib/services/websiteManagement2/lib/models/connectionStringDictionary.js
index 4166de86d0..08933781eb 100644
--- a/lib/services/websiteManagement2/lib/models/connectionStringDictionary.js
+++ b/lib/services/websiteManagement2/lib/models/connectionStringDictionary.js
@@ -20,7 +20,7 @@ const models = require('./index');
class ConnectionStringDictionary extends models['ProxyOnlyResource'] {
/**
* Create a ConnectionStringDictionary.
- * @member {object} [properties] Connection strings.
+ * @property {object} [properties] Connection strings.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/contact.js b/lib/services/websiteManagement2/lib/models/contact.js
index d566aebb48..f492ddfe96 100644
--- a/lib/services/websiteManagement2/lib/models/contact.js
+++ b/lib/services/websiteManagement2/lib/models/contact.js
@@ -20,24 +20,24 @@
class Contact {
/**
* Create a Contact.
- * @member {object} [addressMailing] Mailing address.
- * @member {string} [addressMailing.address1] First line of an Address.
- * @member {string} [addressMailing.address2] The second line of the Address.
- * Optional.
- * @member {string} [addressMailing.city] The city for the address.
- * @member {string} [addressMailing.country] The country for the address.
- * @member {string} [addressMailing.postalCode] The postal code for the
+ * @property {object} [addressMailing] Mailing address.
+ * @property {string} [addressMailing.address1] First line of an Address.
+ * @property {string} [addressMailing.address2] The second line of the
+ * Address. Optional.
+ * @property {string} [addressMailing.city] The city for the address.
+ * @property {string} [addressMailing.country] The country for the address.
+ * @property {string} [addressMailing.postalCode] The postal code for the
* address.
- * @member {string} [addressMailing.state] The state or province for the
+ * @property {string} [addressMailing.state] The state or province for the
* address.
- * @member {string} email Email address.
- * @member {string} [fax] Fax number.
- * @member {string} [jobTitle] Job title.
- * @member {string} nameFirst First name.
- * @member {string} nameLast Last name.
- * @member {string} [nameMiddle] Middle name.
- * @member {string} [organization] Organization contact belongs to.
- * @member {string} phone Phone number.
+ * @property {string} email Email address.
+ * @property {string} [fax] Fax number.
+ * @property {string} [jobTitle] Job title.
+ * @property {string} nameFirst First name.
+ * @property {string} nameLast Last name.
+ * @property {string} [nameMiddle] Middle name.
+ * @property {string} [organization] Organization contact belongs to.
+ * @property {string} phone Phone number.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/continuousWebJob.js b/lib/services/websiteManagement2/lib/models/continuousWebJob.js
index 7ae4000f49..a9b821ce31 100644
--- a/lib/services/websiteManagement2/lib/models/continuousWebJob.js
+++ b/lib/services/websiteManagement2/lib/models/continuousWebJob.js
@@ -20,18 +20,18 @@ const models = require('./index');
class ContinuousWebJob extends models['ProxyOnlyResource'] {
/**
* Create a ContinuousWebJob.
- * @member {string} [status] Job status. Possible values include:
+ * @property {string} [status] Job status. Possible values include:
* 'Initializing', 'Starting', 'Running', 'PendingRestart', 'Stopped'
- * @member {string} [detailedStatus] Detailed status.
- * @member {string} [logUrl] Log URL.
- * @member {string} [runCommand] Run command.
- * @member {string} [url] Job URL.
- * @member {string} [extraInfoUrl] Extra Info URL.
- * @member {string} [webJobType] Job type. Possible values include:
+ * @property {string} [detailedStatus] Detailed status.
+ * @property {string} [logUrl] Log URL.
+ * @property {string} [runCommand] Run command.
+ * @property {string} [url] Job URL.
+ * @property {string} [extraInfoUrl] Extra Info URL.
+ * @property {string} [webJobType] Job type. Possible values include:
* 'Continuous', 'Triggered'
- * @member {string} [error] Error information.
- * @member {boolean} [usingSdk] Using SDK?
- * @member {object} [settings] Job settings.
+ * @property {string} [error] Error information.
+ * @property {boolean} [usingSdk] Using SDK?
+ * @property {object} [settings] Job settings.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/continuousWebJobCollection.js b/lib/services/websiteManagement2/lib/models/continuousWebJobCollection.js
index 5d82a581b7..68107ed9cb 100644
--- a/lib/services/websiteManagement2/lib/models/continuousWebJobCollection.js
+++ b/lib/services/websiteManagement2/lib/models/continuousWebJobCollection.js
@@ -16,7 +16,7 @@
class ContinuousWebJobCollection extends Array {
/**
* Create a ContinuousWebJobCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/corsSettings.js b/lib/services/websiteManagement2/lib/models/corsSettings.js
index 888cff3aac..294a621ffa 100644
--- a/lib/services/websiteManagement2/lib/models/corsSettings.js
+++ b/lib/services/websiteManagement2/lib/models/corsSettings.js
@@ -17,7 +17,7 @@
class CorsSettings {
/**
* Create a CorsSettings.
- * @member {array} [allowedOrigins] Gets or sets the list of origins that
+ * @property {array} [allowedOrigins] Gets or sets the list of origins that
* should be allowed to make cross-origin
* calls (for example: http://example.com:12345). Use "*" to allow all.
*/
diff --git a/lib/services/websiteManagement2/lib/models/csmMoveResourceEnvelope.js b/lib/services/websiteManagement2/lib/models/csmMoveResourceEnvelope.js
index fef33a9910..d943ed483a 100644
--- a/lib/services/websiteManagement2/lib/models/csmMoveResourceEnvelope.js
+++ b/lib/services/websiteManagement2/lib/models/csmMoveResourceEnvelope.js
@@ -18,8 +18,8 @@
class CsmMoveResourceEnvelope {
/**
* Create a CsmMoveResourceEnvelope.
- * @member {string} [targetResourceGroup]
- * @member {array} [resources]
+ * @property {string} [targetResourceGroup]
+ * @property {array} [resources]
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/csmOperationCollection.js b/lib/services/websiteManagement2/lib/models/csmOperationCollection.js
index 24c2e9b665..8ba5bfe5bd 100644
--- a/lib/services/websiteManagement2/lib/models/csmOperationCollection.js
+++ b/lib/services/websiteManagement2/lib/models/csmOperationCollection.js
@@ -16,7 +16,7 @@
class CsmOperationCollection extends Array {
/**
* Create a CsmOperationCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/csmOperationDescription.js b/lib/services/websiteManagement2/lib/models/csmOperationDescription.js
index e22042e62d..2bd2c6d931 100644
--- a/lib/services/websiteManagement2/lib/models/csmOperationDescription.js
+++ b/lib/services/websiteManagement2/lib/models/csmOperationDescription.js
@@ -17,17 +17,17 @@
class CsmOperationDescription {
/**
* Create a CsmOperationDescription.
- * @member {string} [name]
- * @member {object} [display]
- * @member {string} [display.provider]
- * @member {string} [display.resource]
- * @member {string} [display.operation]
- * @member {string} [display.description]
- * @member {string} [origin]
- * @member {object} [properties]
- * @member {object} [properties.serviceSpecification]
- * @member {array} [properties.serviceSpecification.metricSpecifications]
- * @member {array} [properties.serviceSpecification.logSpecifications]
+ * @property {string} [name]
+ * @property {object} [display]
+ * @property {string} [display.provider]
+ * @property {string} [display.resource]
+ * @property {string} [display.operation]
+ * @property {string} [display.description]
+ * @property {string} [origin]
+ * @property {object} [properties]
+ * @property {object} [properties.serviceSpecification]
+ * @property {array} [properties.serviceSpecification.metricSpecifications]
+ * @property {array} [properties.serviceSpecification.logSpecifications]
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/csmOperationDescriptionProperties.js b/lib/services/websiteManagement2/lib/models/csmOperationDescriptionProperties.js
index af0b006db8..989ef3680d 100644
--- a/lib/services/websiteManagement2/lib/models/csmOperationDescriptionProperties.js
+++ b/lib/services/websiteManagement2/lib/models/csmOperationDescriptionProperties.js
@@ -17,9 +17,9 @@
class CsmOperationDescriptionProperties {
/**
* Create a CsmOperationDescriptionProperties.
- * @member {object} [serviceSpecification]
- * @member {array} [serviceSpecification.metricSpecifications]
- * @member {array} [serviceSpecification.logSpecifications]
+ * @property {object} [serviceSpecification]
+ * @property {array} [serviceSpecification.metricSpecifications]
+ * @property {array} [serviceSpecification.logSpecifications]
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/csmOperationDisplay.js b/lib/services/websiteManagement2/lib/models/csmOperationDisplay.js
index fa90f6c44d..ec50fc10e9 100644
--- a/lib/services/websiteManagement2/lib/models/csmOperationDisplay.js
+++ b/lib/services/websiteManagement2/lib/models/csmOperationDisplay.js
@@ -17,10 +17,10 @@
class CsmOperationDisplay {
/**
* Create a CsmOperationDisplay.
- * @member {string} [provider]
- * @member {string} [resource]
- * @member {string} [operation]
- * @member {string} [description]
+ * @property {string} [provider]
+ * @property {string} [resource]
+ * @property {string} [operation]
+ * @property {string} [description]
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/csmPublishingProfileOptions.js b/lib/services/websiteManagement2/lib/models/csmPublishingProfileOptions.js
index 2ff11f2d9c..ea1e40d226 100644
--- a/lib/services/websiteManagement2/lib/models/csmPublishingProfileOptions.js
+++ b/lib/services/websiteManagement2/lib/models/csmPublishingProfileOptions.js
@@ -17,11 +17,11 @@
class CsmPublishingProfileOptions {
/**
* Create a CsmPublishingProfileOptions.
- * @member {string} [format] Name of the format. Valid values are:
+ * @property {string} [format] Name of the format. Valid values are:
* FileZilla3
* WebDeploy -- default
* Ftp. Possible values include: 'FileZilla3', 'WebDeploy', 'Ftp'
- * @member {boolean} [includeDisasterRecoveryEndpoints] Include the
+ * @property {boolean} [includeDisasterRecoveryEndpoints] Include the
* DisasterRecover endpoint if true
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/csmSlotEntity.js b/lib/services/websiteManagement2/lib/models/csmSlotEntity.js
index 286ea2fdd5..229f6b4ec0 100644
--- a/lib/services/websiteManagement2/lib/models/csmSlotEntity.js
+++ b/lib/services/websiteManagement2/lib/models/csmSlotEntity.js
@@ -17,9 +17,9 @@
class CsmSlotEntity {
/**
* Create a CsmSlotEntity.
- * @member {string} targetSlot Destination deployment slot during swap
+ * @property {string} targetSlot Destination deployment slot during swap
* operation.
- * @member {boolean} preserveVnet true to preserve Virtual
+ * @property {boolean} preserveVnet true to preserve Virtual
* Network to the slot during swap; otherwise, false.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/csmUsageQuota.js b/lib/services/websiteManagement2/lib/models/csmUsageQuota.js
index 6a7322c0d3..ed8be6653a 100644
--- a/lib/services/websiteManagement2/lib/models/csmUsageQuota.js
+++ b/lib/services/websiteManagement2/lib/models/csmUsageQuota.js
@@ -17,13 +17,14 @@
class CsmUsageQuota {
/**
* Create a CsmUsageQuota.
- * @member {string} [unit] Units of measurement for the quota resourse.
- * @member {date} [nextResetTime] Next reset time for the resource counter.
- * @member {number} [currentValue] The current value of the resource counter.
- * @member {number} [limit] The resource limit.
- * @member {object} [name] Quota name.
- * @member {string} [name.value] Non-localized name.
- * @member {string} [name.localizedValue] Localized name.
+ * @property {string} [unit] Units of measurement for the quota resourse.
+ * @property {date} [nextResetTime] Next reset time for the resource counter.
+ * @property {number} [currentValue] The current value of the resource
+ * counter.
+ * @property {number} [limit] The resource limit.
+ * @property {object} [name] Quota name.
+ * @property {string} [name.value] Non-localized name.
+ * @property {string} [name.localizedValue] Localized name.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/csmUsageQuotaCollection.js b/lib/services/websiteManagement2/lib/models/csmUsageQuotaCollection.js
index 80459abab5..fac44b784c 100644
--- a/lib/services/websiteManagement2/lib/models/csmUsageQuotaCollection.js
+++ b/lib/services/websiteManagement2/lib/models/csmUsageQuotaCollection.js
@@ -16,7 +16,7 @@
class CsmUsageQuotaCollection extends Array {
/**
* Create a CsmUsageQuotaCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/customHostnameAnalysisResult.js b/lib/services/websiteManagement2/lib/models/customHostnameAnalysisResult.js
index e141ca367e..12bcdafcf7 100644
--- a/lib/services/websiteManagement2/lib/models/customHostnameAnalysisResult.js
+++ b/lib/services/websiteManagement2/lib/models/customHostnameAnalysisResult.js
@@ -20,39 +20,40 @@ const models = require('./index');
class CustomHostnameAnalysisResult extends models['ProxyOnlyResource'] {
/**
* Create a CustomHostnameAnalysisResult.
- * @member {boolean} [isHostnameAlreadyVerified] true if
+ * @property {boolean} [isHostnameAlreadyVerified] true if
* hostname is already verified; otherwise, false.
- * @member {string} [customDomainVerificationTest] DNS verification test
+ * @property {string} [customDomainVerificationTest] DNS verification test
* result. Possible values include: 'Passed', 'Failed', 'Skipped'
- * @member {object} [customDomainVerificationFailureInfo] Raw failure
+ * @property {object} [customDomainVerificationFailureInfo] Raw failure
* information if DNS verification fails.
- * @member {string} [customDomainVerificationFailureInfo.extendedCode] Type
+ * @property {string} [customDomainVerificationFailureInfo.extendedCode] Type
* of error.
- * @member {string} [customDomainVerificationFailureInfo.messageTemplate]
+ * @property {string} [customDomainVerificationFailureInfo.messageTemplate]
* Message template.
- * @member {array} [customDomainVerificationFailureInfo.parameters]
+ * @property {array} [customDomainVerificationFailureInfo.parameters]
* Parameters for the template.
- * @member {array} [customDomainVerificationFailureInfo.innerErrors] Inner
+ * @property {array} [customDomainVerificationFailureInfo.innerErrors] Inner
* errors.
- * @member {string} [customDomainVerificationFailureInfo.code] Basic error
+ * @property {string} [customDomainVerificationFailureInfo.code] Basic error
* code.
- * @member {string} [customDomainVerificationFailureInfo.message] Any details
- * of the error.
- * @member {boolean} [hasConflictOnScaleUnit] true if there is a
- * conflict on a scale unit; otherwise, false.
- * @member {boolean} [hasConflictAcrossSubscription] true if
+ * @property {string} [customDomainVerificationFailureInfo.message] Any
+ * details of the error.
+ * @property {boolean} [hasConflictOnScaleUnit] true if there is
+ * a conflict on a scale unit; otherwise, false.
+ * @property {boolean} [hasConflictAcrossSubscription] true if
* htere is a conflict across subscriptions; otherwise, false.
- * @member {string} [conflictingAppResourceId] Name of the conflicting app on
- * scale unit if it's within the same subscription.
- * @member {array} [cNameRecords] CName records controller can see for this
+ * @property {string} [conflictingAppResourceId] Name of the conflicting app
+ * on scale unit if it's within the same subscription.
+ * @property {array} [cNameRecords] CName records controller can see for this
* hostname.
- * @member {array} [txtRecords] TXT records controller can see for this
+ * @property {array} [txtRecords] TXT records controller can see for this
* hostname.
- * @member {array} [aRecords] A records controller can see for this hostname.
- * @member {array} [alternateCNameRecords] Alternate CName records controller
+ * @property {array} [aRecords] A records controller can see for this
+ * hostname.
+ * @property {array} [alternateCNameRecords] Alternate CName records
+ * controller can see for this hostname.
+ * @property {array} [alternateTxtRecords] Alternate TXT records controller
* can see for this hostname.
- * @member {array} [alternateTxtRecords] Alternate TXT records controller can
- * see for this hostname.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/dataSource.js b/lib/services/websiteManagement2/lib/models/dataSource.js
index 480579c108..88c601d260 100644
--- a/lib/services/websiteManagement2/lib/models/dataSource.js
+++ b/lib/services/websiteManagement2/lib/models/dataSource.js
@@ -17,8 +17,8 @@
class DataSource {
/**
* Create a DataSource.
- * @member {array} [instructions] Instrunctions if any for the data source
- * @member {array} [dataSourceUri] Datasource Uri Links
+ * @property {array} [instructions] Instrunctions if any for the data source
+ * @property {array} [dataSourceUri] Datasource Uri Links
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/dataTableResponseColumn.js b/lib/services/websiteManagement2/lib/models/dataTableResponseColumn.js
index 0d4f245e13..0c9d02d38b 100644
--- a/lib/services/websiteManagement2/lib/models/dataTableResponseColumn.js
+++ b/lib/services/websiteManagement2/lib/models/dataTableResponseColumn.js
@@ -17,10 +17,10 @@
class DataTableResponseColumn {
/**
* Create a DataTableResponseColumn.
- * @member {string} [columnName] Name of the column
- * @member {string} [dataType] Data type which looks like 'String' or
+ * @property {string} [columnName] Name of the column
+ * @property {string} [dataType] Data type which looks like 'String' or
* 'Int32'.
- * @member {string} [columnType] Column Type
+ * @property {string} [columnType] Column Type
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/dataTableResponseObject.js b/lib/services/websiteManagement2/lib/models/dataTableResponseObject.js
index 5120ad3d04..eb657741d7 100644
--- a/lib/services/websiteManagement2/lib/models/dataTableResponseObject.js
+++ b/lib/services/websiteManagement2/lib/models/dataTableResponseObject.js
@@ -17,9 +17,9 @@
class DataTableResponseObject {
/**
* Create a DataTableResponseObject.
- * @member {string} [tableName] Name of the table
- * @member {array} [columns] List of columns with data types
- * @member {array} [rows] Raw row values
+ * @property {string} [tableName] Name of the table
+ * @property {array} [columns] List of columns with data types
+ * @property {array} [rows] Raw row values
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/databaseBackupSetting.js b/lib/services/websiteManagement2/lib/models/databaseBackupSetting.js
index 09b9255796..2348666384 100644
--- a/lib/services/websiteManagement2/lib/models/databaseBackupSetting.js
+++ b/lib/services/websiteManagement2/lib/models/databaseBackupSetting.js
@@ -17,13 +17,13 @@
class DatabaseBackupSetting {
/**
* Create a DatabaseBackupSetting.
- * @member {string} databaseType Database type (e.g. SqlAzure / MySql).
+ * @property {string} databaseType Database type (e.g. SqlAzure / MySql).
* Possible values include: 'SqlAzure', 'MySql', 'LocalMySql', 'PostgreSql'
- * @member {string} [name]
- * @member {string} [connectionStringName] Contains a connection string name
- * that is linked to the SiteConfig.ConnectionStrings.
+ * @property {string} [name]
+ * @property {string} [connectionStringName] Contains a connection string
+ * name that is linked to the SiteConfig.ConnectionStrings.
* This is used during restore with overwrite connection strings options.
- * @member {string} [connectionString] Contains a connection string to a
+ * @property {string} [connectionString] Contains a connection string to a
* database which is being backed up or restored. If the restore should
* happen to a new database, the database name inside is the new one.
*/
diff --git a/lib/services/websiteManagement2/lib/models/defaultErrorResponse.js b/lib/services/websiteManagement2/lib/models/defaultErrorResponse.js
index 5a7ecbca5a..d14c5488b0 100644
--- a/lib/services/websiteManagement2/lib/models/defaultErrorResponse.js
+++ b/lib/services/websiteManagement2/lib/models/defaultErrorResponse.js
@@ -17,15 +17,15 @@
class DefaultErrorResponse {
/**
* Create a DefaultErrorResponse.
- * @member {object} [error] Error model.
- * @member {string} [error.code] Standardized string to programmatically
+ * @property {object} [error] Error model.
+ * @property {string} [error.code] Standardized string to programmatically
* identify the error.
- * @member {string} [error.message] Detailed error description and debugging
+ * @property {string} [error.message] Detailed error description and
+ * debugging information.
+ * @property {string} [error.target] Detailed error description and debugging
* information.
- * @member {string} [error.target] Detailed error description and debugging
- * information.
- * @member {array} [error.details]
- * @member {string} [error.innererror] More information to debug error.
+ * @property {array} [error.details]
+ * @property {string} [error.innererror] More information to debug error.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/defaultErrorResponseError.js b/lib/services/websiteManagement2/lib/models/defaultErrorResponseError.js
index 53e7b42b06..c147d250b9 100644
--- a/lib/services/websiteManagement2/lib/models/defaultErrorResponseError.js
+++ b/lib/services/websiteManagement2/lib/models/defaultErrorResponseError.js
@@ -17,14 +17,14 @@
class DefaultErrorResponseError {
/**
* Create a DefaultErrorResponseError.
- * @member {string} [code] Standardized string to programmatically identify
+ * @property {string} [code] Standardized string to programmatically identify
* the error.
- * @member {string} [message] Detailed error description and debugging
+ * @property {string} [message] Detailed error description and debugging
* information.
- * @member {string} [target] Detailed error description and debugging
+ * @property {string} [target] Detailed error description and debugging
* information.
- * @member {array} [details]
- * @member {string} [innererror] More information to debug error.
+ * @property {array} [details]
+ * @property {string} [innererror] More information to debug error.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/defaultErrorResponseErrorDetailsItem.js b/lib/services/websiteManagement2/lib/models/defaultErrorResponseErrorDetailsItem.js
index 5462c48e7a..b70d43c409 100644
--- a/lib/services/websiteManagement2/lib/models/defaultErrorResponseErrorDetailsItem.js
+++ b/lib/services/websiteManagement2/lib/models/defaultErrorResponseErrorDetailsItem.js
@@ -17,11 +17,11 @@
class DefaultErrorResponseErrorDetailsItem {
/**
* Create a DefaultErrorResponseErrorDetailsItem.
- * @member {string} [code] Standardized string to programmatically identify
+ * @property {string} [code] Standardized string to programmatically identify
* the error.
- * @member {string} [message] Detailed error description and debugging
+ * @property {string} [message] Detailed error description and debugging
* information.
- * @member {string} [target] Detailed error description and debugging
+ * @property {string} [target] Detailed error description and debugging
* information.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/deletedAppRestoreRequest.js b/lib/services/websiteManagement2/lib/models/deletedAppRestoreRequest.js
index 4d5d895f02..9fda64e9e3 100644
--- a/lib/services/websiteManagement2/lib/models/deletedAppRestoreRequest.js
+++ b/lib/services/websiteManagement2/lib/models/deletedAppRestoreRequest.js
@@ -20,16 +20,16 @@ const models = require('./index');
class DeletedAppRestoreRequest extends models['ProxyOnlyResource'] {
/**
* Create a DeletedAppRestoreRequest.
- * @member {string} [deletedSiteId] ARM resource ID of the deleted app.
+ * @property {string} [deletedSiteId] ARM resource ID of the deleted app.
* Example:
* /subscriptions/{subId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}
- * @member {boolean} [recoverConfiguration] If true, deleted site
+ * @property {boolean} [recoverConfiguration] If true, deleted site
* configuration, in addition to content, will be restored.
- * @member {string} [snapshotTime] Point in time to restore the deleted app
+ * @property {string} [snapshotTime] Point in time to restore the deleted app
* from, formatted as a DateTime string.
* If unspecified, default value is the time that the app was deleted.
- * @member {boolean} [useDRSecondary] If true, the snapshot is retrieved from
- * DRSecondary endpoint.
+ * @property {boolean} [useDRSecondary] If true, the snapshot is retrieved
+ * from DRSecondary endpoint.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/deletedSite.js b/lib/services/websiteManagement2/lib/models/deletedSite.js
index b313ad0c41..cf2c0865bc 100644
--- a/lib/services/websiteManagement2/lib/models/deletedSite.js
+++ b/lib/services/websiteManagement2/lib/models/deletedSite.js
@@ -20,15 +20,16 @@ const models = require('./index');
class DeletedSite extends models['ProxyOnlyResource'] {
/**
* Create a DeletedSite.
- * @member {number} [deletedSiteId] Numeric id for the deleted site
- * @member {string} [deletedTimestamp] Time in UTC when the app was deleted.
- * @member {string} [subscription] Subscription containing the deleted site
- * @member {string} [resourceGroup] ResourceGroup that contained the deleted
- * site
- * @member {string} [deletedSiteName] Name of the deleted site
- * @member {string} [slot] Slot of the deleted site
- * @member {string} [deletedSiteKind] Kind of site that was deleted
- * @member {string} [geoRegionName] Geo Region of the deleted site
+ * @property {number} [deletedSiteId] Numeric id for the deleted site
+ * @property {string} [deletedTimestamp] Time in UTC when the app was
+ * deleted.
+ * @property {string} [subscription] Subscription containing the deleted site
+ * @property {string} [resourceGroup] ResourceGroup that contained the
+ * deleted site
+ * @property {string} [deletedSiteName] Name of the deleted site
+ * @property {string} [slot] Slot of the deleted site
+ * @property {string} [deletedSiteKind] Kind of site that was deleted
+ * @property {string} [geoRegionName] Geo Region of the deleted site
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/deletedWebAppCollection.js b/lib/services/websiteManagement2/lib/models/deletedWebAppCollection.js
index e4e74927f6..604f425c69 100644
--- a/lib/services/websiteManagement2/lib/models/deletedWebAppCollection.js
+++ b/lib/services/websiteManagement2/lib/models/deletedWebAppCollection.js
@@ -16,7 +16,7 @@
class DeletedWebAppCollection extends Array {
/**
* Create a DeletedWebAppCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/deployment.js b/lib/services/websiteManagement2/lib/models/deployment.js
index f8fdc08349..6d1445d166 100644
--- a/lib/services/websiteManagement2/lib/models/deployment.js
+++ b/lib/services/websiteManagement2/lib/models/deployment.js
@@ -20,16 +20,16 @@ const models = require('./index');
class Deployment extends models['ProxyOnlyResource'] {
/**
* Create a Deployment.
- * @member {number} [status] Deployment status.
- * @member {string} [message] Details about deployment status.
- * @member {string} [author] Who authored the deployment.
- * @member {string} [deployer] Who performed the deployment.
- * @member {string} [authorEmail] Author email.
- * @member {date} [startTime] Start time.
- * @member {date} [endTime] End time.
- * @member {boolean} [active] True if deployment is currently active, false
+ * @property {number} [status] Deployment status.
+ * @property {string} [message] Details about deployment status.
+ * @property {string} [author] Who authored the deployment.
+ * @property {string} [deployer] Who performed the deployment.
+ * @property {string} [authorEmail] Author email.
+ * @property {date} [startTime] Start time.
+ * @property {date} [endTime] End time.
+ * @property {boolean} [active] True if deployment is currently active, false
* if completed and null if not started.
- * @member {string} [details] Details on deployment.
+ * @property {string} [details] Details on deployment.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/deploymentCollection.js b/lib/services/websiteManagement2/lib/models/deploymentCollection.js
index a8428276d9..c6f5ae6de2 100644
--- a/lib/services/websiteManagement2/lib/models/deploymentCollection.js
+++ b/lib/services/websiteManagement2/lib/models/deploymentCollection.js
@@ -16,7 +16,7 @@
class DeploymentCollection extends Array {
/**
* Create a DeploymentCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/deploymentLocations.js b/lib/services/websiteManagement2/lib/models/deploymentLocations.js
index 04d37df313..40babbfafa 100644
--- a/lib/services/websiteManagement2/lib/models/deploymentLocations.js
+++ b/lib/services/websiteManagement2/lib/models/deploymentLocations.js
@@ -18,11 +18,11 @@
class DeploymentLocations {
/**
* Create a DeploymentLocations.
- * @member {array} [locations] Available regions.
- * @member {array} [hostingEnvironments] Available App Service Environments
+ * @property {array} [locations] Available regions.
+ * @property {array} [hostingEnvironments] Available App Service Environments
* with full descriptions of the environments.
- * @member {array} [hostingEnvironmentDeploymentInfos] Available App Service
- * Environments with basic information.
+ * @property {array} [hostingEnvironmentDeploymentInfos] Available App
+ * Service Environments with basic information.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/detectorAbnormalTimePeriod.js b/lib/services/websiteManagement2/lib/models/detectorAbnormalTimePeriod.js
index 2080fbf6f4..f67bf41b84 100644
--- a/lib/services/websiteManagement2/lib/models/detectorAbnormalTimePeriod.js
+++ b/lib/services/websiteManagement2/lib/models/detectorAbnormalTimePeriod.js
@@ -17,17 +17,17 @@
class DetectorAbnormalTimePeriod {
/**
* Create a DetectorAbnormalTimePeriod.
- * @member {date} [startTime] Start time of the corelated event
- * @member {date} [endTime] End time of the corelated event
- * @member {string} [message] Message describing the event
- * @member {string} [source] Represents the name of the Detector
- * @member {number} [priority] Represents the rank of the Detector
- * @member {array} [metaData] Downtime metadata
- * @member {string} [type] Represents the type of the Detector. Possible
+ * @property {date} [startTime] Start time of the corelated event
+ * @property {date} [endTime] End time of the corelated event
+ * @property {string} [message] Message describing the event
+ * @property {string} [source] Represents the name of the Detector
+ * @property {number} [priority] Represents the rank of the Detector
+ * @property {array} [metaData] Downtime metadata
+ * @property {string} [type] Represents the type of the Detector. Possible
* values include: 'ServiceIncident', 'AppDeployment', 'AppCrash',
* 'RuntimeIssueDetected', 'AseDeployment', 'UserIssue', 'PlatformIssue',
* 'Other'
- * @member {array} [solutions] List of proposed solutions
+ * @property {array} [solutions] List of proposed solutions
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/detectorDefinition.js b/lib/services/websiteManagement2/lib/models/detectorDefinition.js
index 0c4aa92814..5f3b06d76b 100644
--- a/lib/services/websiteManagement2/lib/models/detectorDefinition.js
+++ b/lib/services/websiteManagement2/lib/models/detectorDefinition.js
@@ -20,10 +20,10 @@ const models = require('./index');
class DetectorDefinition extends models['ProxyOnlyResource'] {
/**
* Create a DetectorDefinition.
- * @member {string} [displayName] Display name of the detector
- * @member {string} [description] Description of the detector
- * @member {number} [rank] Detector Rank
- * @member {boolean} [isEnabled] Flag representing whether detector is
+ * @property {string} [displayName] Display name of the detector
+ * @property {string} [description] Description of the detector
+ * @property {number} [rank] Detector Rank
+ * @property {boolean} [isEnabled] Flag representing whether detector is
* enabled or not.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/detectorInfo.js b/lib/services/websiteManagement2/lib/models/detectorInfo.js
index 7dc038b07c..3831f2ba73 100644
--- a/lib/services/websiteManagement2/lib/models/detectorInfo.js
+++ b/lib/services/websiteManagement2/lib/models/detectorInfo.js
@@ -17,11 +17,11 @@
class DetectorInfo {
/**
* Create a DetectorInfo.
- * @member {string} [description] Short description of the detector and its
+ * @property {string} [description] Short description of the detector and its
* purpose
- * @member {string} [category] Support Category
- * @member {string} [subCategory] Support Sub Category
- * @member {string} [supportTopicId] Support Topic Id
+ * @property {string} [category] Support Category
+ * @property {string} [subCategory] Support Sub Category
+ * @property {string} [supportTopicId] Support Topic Id
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/detectorResponse.js b/lib/services/websiteManagement2/lib/models/detectorResponse.js
index 6cfb11fcf6..61e2774018 100644
--- a/lib/services/websiteManagement2/lib/models/detectorResponse.js
+++ b/lib/services/websiteManagement2/lib/models/detectorResponse.js
@@ -20,13 +20,13 @@ const models = require('./index');
class DetectorResponse extends models['ProxyOnlyResource'] {
/**
* Create a DetectorResponse.
- * @member {object} [metadata] metadata for the detector
- * @member {string} [metadata.description] Short description of the detector
- * and its purpose
- * @member {string} [metadata.category] Support Category
- * @member {string} [metadata.subCategory] Support Sub Category
- * @member {string} [metadata.supportTopicId] Support Topic Id
- * @member {array} [dataset] Data Set
+ * @property {object} [metadata] metadata for the detector
+ * @property {string} [metadata.description] Short description of the
+ * detector and its purpose
+ * @property {string} [metadata.category] Support Category
+ * @property {string} [metadata.subCategory] Support Sub Category
+ * @property {string} [metadata.supportTopicId] Support Topic Id
+ * @property {array} [dataset] Data Set
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/detectorResponseCollection.js b/lib/services/websiteManagement2/lib/models/detectorResponseCollection.js
index 4d168e407d..618418ff7a 100644
--- a/lib/services/websiteManagement2/lib/models/detectorResponseCollection.js
+++ b/lib/services/websiteManagement2/lib/models/detectorResponseCollection.js
@@ -16,7 +16,7 @@
class DetectorResponseCollection extends Array {
/**
* Create a DetectorResponseCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/diagnosticAnalysis.js b/lib/services/websiteManagement2/lib/models/diagnosticAnalysis.js
index 350a897abb..575d99e360 100644
--- a/lib/services/websiteManagement2/lib/models/diagnosticAnalysis.js
+++ b/lib/services/websiteManagement2/lib/models/diagnosticAnalysis.js
@@ -20,11 +20,11 @@ const models = require('./index');
class DiagnosticAnalysis extends models['ProxyOnlyResource'] {
/**
* Create a DiagnosticAnalysis.
- * @member {date} [startTime] Start time of the period
- * @member {date} [endTime] End time of the period
- * @member {array} [abnormalTimePeriods] List of time periods.
- * @member {array} [payload] Data by each detector
- * @member {array} [nonCorrelatedDetectors] Data by each detector for
+ * @property {date} [startTime] Start time of the period
+ * @property {date} [endTime] End time of the period
+ * @property {array} [abnormalTimePeriods] List of time periods.
+ * @property {array} [payload] Data by each detector
+ * @property {array} [nonCorrelatedDetectors] Data by each detector for
* detectors that did not corelate
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/diagnosticAnalysisCollection.js b/lib/services/websiteManagement2/lib/models/diagnosticAnalysisCollection.js
index 526e3d5542..6d47056736 100644
--- a/lib/services/websiteManagement2/lib/models/diagnosticAnalysisCollection.js
+++ b/lib/services/websiteManagement2/lib/models/diagnosticAnalysisCollection.js
@@ -16,7 +16,7 @@
class DiagnosticAnalysisCollection extends Array {
/**
* Create a DiagnosticAnalysisCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/diagnosticCategory.js b/lib/services/websiteManagement2/lib/models/diagnosticCategory.js
index f36e3076cc..8c14aa4b79 100644
--- a/lib/services/websiteManagement2/lib/models/diagnosticCategory.js
+++ b/lib/services/websiteManagement2/lib/models/diagnosticCategory.js
@@ -20,7 +20,7 @@ const models = require('./index');
class DiagnosticCategory extends models['ProxyOnlyResource'] {
/**
* Create a DiagnosticCategory.
- * @member {string} [description] Description of the diagnostic category
+ * @property {string} [description] Description of the diagnostic category
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/diagnosticCategoryCollection.js b/lib/services/websiteManagement2/lib/models/diagnosticCategoryCollection.js
index fc20ff19c1..9a229d10f3 100644
--- a/lib/services/websiteManagement2/lib/models/diagnosticCategoryCollection.js
+++ b/lib/services/websiteManagement2/lib/models/diagnosticCategoryCollection.js
@@ -16,7 +16,7 @@
class DiagnosticCategoryCollection extends Array {
/**
* Create a DiagnosticCategoryCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/diagnosticData.js b/lib/services/websiteManagement2/lib/models/diagnosticData.js
index 515871b8d6..adfefa1850 100644
--- a/lib/services/websiteManagement2/lib/models/diagnosticData.js
+++ b/lib/services/websiteManagement2/lib/models/diagnosticData.js
@@ -17,17 +17,17 @@
class DiagnosticData {
/**
* Create a DiagnosticData.
- * @member {object} [table] Data in table form
- * @member {string} [table.tableName] Name of the table
- * @member {array} [table.columns] List of columns with data types
- * @member {array} [table.rows] Raw row values
- * @member {object} [renderingProperties] Properties that describe how the
+ * @property {object} [table] Data in table form
+ * @property {string} [table.tableName] Name of the table
+ * @property {array} [table.columns] List of columns with data types
+ * @property {array} [table.rows] Raw row values
+ * @property {object} [renderingProperties] Properties that describe how the
* table should be rendered
- * @member {string} [renderingProperties.type] Rendering Type. Possible
+ * @property {string} [renderingProperties.type] Rendering Type. Possible
* values include: 'NoGraph', 'Table', 'TimeSeries', 'TimeSeriesPerInstance'
- * @member {string} [renderingProperties.title] Title of data
- * @member {string} [renderingProperties.description] Description of the data
- * that will help it be interpreted
+ * @property {string} [renderingProperties.title] Title of data
+ * @property {string} [renderingProperties.description] Description of the
+ * data that will help it be interpreted
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/diagnosticDetectorCollection.js b/lib/services/websiteManagement2/lib/models/diagnosticDetectorCollection.js
index 9b17e34ecb..9ff0b81ab0 100644
--- a/lib/services/websiteManagement2/lib/models/diagnosticDetectorCollection.js
+++ b/lib/services/websiteManagement2/lib/models/diagnosticDetectorCollection.js
@@ -16,7 +16,7 @@
class DiagnosticDetectorCollection extends Array {
/**
* Create a DiagnosticDetectorCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/diagnosticDetectorResponse.js b/lib/services/websiteManagement2/lib/models/diagnosticDetectorResponse.js
index 880a1116cf..bcddb63c14 100644
--- a/lib/services/websiteManagement2/lib/models/diagnosticDetectorResponse.js
+++ b/lib/services/websiteManagement2/lib/models/diagnosticDetectorResponse.js
@@ -20,27 +20,27 @@ const models = require('./index');
class DiagnosticDetectorResponse extends models['ProxyOnlyResource'] {
/**
* Create a DiagnosticDetectorResponse.
- * @member {date} [startTime] Start time of the period
- * @member {date} [endTime] End time of the period
- * @member {boolean} [issueDetected] Flag representing Issue was detected.
- * @member {object} [detectorDefinition] Detector's definition
- * @member {string} [detectorDefinition.displayName] Display name of the
+ * @property {date} [startTime] Start time of the period
+ * @property {date} [endTime] End time of the period
+ * @property {boolean} [issueDetected] Flag representing Issue was detected.
+ * @property {object} [detectorDefinition] Detector's definition
+ * @property {string} [detectorDefinition.displayName] Display name of the
* detector
- * @member {string} [detectorDefinition.description] Description of the
+ * @property {string} [detectorDefinition.description] Description of the
* detector
- * @member {number} [detectorDefinition.rank] Detector Rank
- * @member {boolean} [detectorDefinition.isEnabled] Flag representing whether
- * detector is enabled or not.
- * @member {array} [metrics] Metrics provided by the detector
- * @member {array} [abnormalTimePeriods] List of Correlated events found by
+ * @property {number} [detectorDefinition.rank] Detector Rank
+ * @property {boolean} [detectorDefinition.isEnabled] Flag representing
+ * whether detector is enabled or not.
+ * @property {array} [metrics] Metrics provided by the detector
+ * @property {array} [abnormalTimePeriods] List of Correlated events found by
* the detector
- * @member {array} [data] Additional Data that detector wants to send.
- * @member {object} [responseMetaData] Meta Data
- * @member {object} [responseMetaData.dataSource] Source of the Data
- * @member {array} [responseMetaData.dataSource.instructions] Instrunctions
+ * @property {array} [data] Additional Data that detector wants to send.
+ * @property {object} [responseMetaData] Meta Data
+ * @property {object} [responseMetaData.dataSource] Source of the Data
+ * @property {array} [responseMetaData.dataSource.instructions] Instrunctions
* if any for the data source
- * @member {array} [responseMetaData.dataSource.dataSourceUri] Datasource Uri
- * Links
+ * @property {array} [responseMetaData.dataSource.dataSourceUri] Datasource
+ * Uri Links
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/diagnosticMetricSample.js b/lib/services/websiteManagement2/lib/models/diagnosticMetricSample.js
index 334dc95c9f..0497e0c438 100644
--- a/lib/services/websiteManagement2/lib/models/diagnosticMetricSample.js
+++ b/lib/services/websiteManagement2/lib/models/diagnosticMetricSample.js
@@ -17,22 +17,22 @@
class DiagnosticMetricSample {
/**
* Create a DiagnosticMetricSample.
- * @member {date} [timestamp] Time at which metric is measured
- * @member {string} [roleInstance] Role Instance. Null if this counter is not
- * per instance
+ * @property {date} [timestamp] Time at which metric is measured
+ * @property {string} [roleInstance] Role Instance. Null if this counter is
+ * not per instance
* This is returned and should be whichever instance name we desire to be
* returned
* i.e. CPU and Memory return RDWORKERNAME (LargeDed..._IN_0)
* where RDWORKERNAME is Machine name below and RoleInstance name in
* parenthesis
- * @member {number} [total] Total value of the metric. If multiple
+ * @property {number} [total] Total value of the metric. If multiple
* measurements are made this will have sum of all.
- * @member {number} [maximum] Maximum of the metric sampled during the time
+ * @property {number} [maximum] Maximum of the metric sampled during the time
* period
- * @member {number} [minimum] Minimum of the metric sampled during the time
+ * @property {number} [minimum] Minimum of the metric sampled during the time
* period
- * @member {boolean} [isAggregated] Whether the values are aggregates across
- * all workers or not
+ * @property {boolean} [isAggregated] Whether the values are aggregates
+ * across all workers or not
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/diagnosticMetricSet.js b/lib/services/websiteManagement2/lib/models/diagnosticMetricSet.js
index f7cdef2b06..5cde0f1151 100644
--- a/lib/services/websiteManagement2/lib/models/diagnosticMetricSet.js
+++ b/lib/services/websiteManagement2/lib/models/diagnosticMetricSet.js
@@ -17,13 +17,13 @@
class DiagnosticMetricSet {
/**
* Create a DiagnosticMetricSet.
- * @member {string} [name] Name of the metric
- * @member {string} [unit] Metric's unit
- * @member {date} [startTime] Start time of the period
- * @member {date} [endTime] End time of the period
- * @member {string} [timeGrain] Presented time grain. Supported grains at the
- * moment are PT1M, PT1H, P1D
- * @member {array} [values] Collection of metric values for the selected
+ * @property {string} [name] Name of the metric
+ * @property {string} [unit] Metric's unit
+ * @property {date} [startTime] Start time of the period
+ * @property {date} [endTime] End time of the period
+ * @property {string} [timeGrain] Presented time grain. Supported grains at
+ * the moment are PT1M, PT1H, P1D
+ * @property {array} [values] Collection of metric values for the selected
* period based on the
* {Microsoft.Web.Hosting.Administration.DiagnosticMetricSet.TimeGrain}
*/
diff --git a/lib/services/websiteManagement2/lib/models/dimension.js b/lib/services/websiteManagement2/lib/models/dimension.js
index 53cbe470f0..f50c0ac7d8 100644
--- a/lib/services/websiteManagement2/lib/models/dimension.js
+++ b/lib/services/websiteManagement2/lib/models/dimension.js
@@ -19,10 +19,10 @@
class Dimension {
/**
* Create a Dimension.
- * @member {string} [name]
- * @member {string} [displayName]
- * @member {string} [internalName]
- * @member {boolean} [toBeExportedForShoebox]
+ * @property {string} [name]
+ * @property {string} [displayName]
+ * @property {string} [internalName]
+ * @property {boolean} [toBeExportedForShoebox]
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/domain.js b/lib/services/websiteManagement2/lib/models/domain.js
index 8eed458789..3f8597af73 100644
--- a/lib/services/websiteManagement2/lib/models/domain.js
+++ b/lib/services/websiteManagement2/lib/models/domain.js
@@ -20,139 +20,139 @@ const models = require('./index');
class Domain extends models['Resource'] {
/**
* Create a Domain.
- * @member {object} contactAdmin Administrative contact.
- * @member {object} [contactAdmin.addressMailing] Mailing address.
- * @member {string} [contactAdmin.addressMailing.address1] First line of an
+ * @property {object} contactAdmin Administrative contact.
+ * @property {object} [contactAdmin.addressMailing] Mailing address.
+ * @property {string} [contactAdmin.addressMailing.address1] First line of an
* Address.
- * @member {string} [contactAdmin.addressMailing.address2] The second line of
- * the Address. Optional.
- * @member {string} [contactAdmin.addressMailing.city] The city for the
- * address.
- * @member {string} [contactAdmin.addressMailing.country] The country for the
- * address.
- * @member {string} [contactAdmin.addressMailing.postalCode] The postal code
- * for the address.
- * @member {string} [contactAdmin.addressMailing.state] The state or province
- * for the address.
- * @member {string} [contactAdmin.email] Email address.
- * @member {string} [contactAdmin.fax] Fax number.
- * @member {string} [contactAdmin.jobTitle] Job title.
- * @member {string} [contactAdmin.nameFirst] First name.
- * @member {string} [contactAdmin.nameLast] Last name.
- * @member {string} [contactAdmin.nameMiddle] Middle name.
- * @member {string} [contactAdmin.organization] Organization contact belongs
- * to.
- * @member {string} [contactAdmin.phone] Phone number.
- * @member {object} contactBilling Billing contact.
- * @member {object} [contactBilling.addressMailing] Mailing address.
- * @member {string} [contactBilling.addressMailing.address1] First line of an
- * Address.
- * @member {string} [contactBilling.addressMailing.address2] The second line
+ * @property {string} [contactAdmin.addressMailing.address2] The second line
* of the Address. Optional.
- * @member {string} [contactBilling.addressMailing.city] The city for the
+ * @property {string} [contactAdmin.addressMailing.city] The city for the
* address.
- * @member {string} [contactBilling.addressMailing.country] The country for
+ * @property {string} [contactAdmin.addressMailing.country] The country for
* the address.
- * @member {string} [contactBilling.addressMailing.postalCode] The postal
+ * @property {string} [contactAdmin.addressMailing.postalCode] The postal
* code for the address.
- * @member {string} [contactBilling.addressMailing.state] The state or
+ * @property {string} [contactAdmin.addressMailing.state] The state or
* province for the address.
- * @member {string} [contactBilling.email] Email address.
- * @member {string} [contactBilling.fax] Fax number.
- * @member {string} [contactBilling.jobTitle] Job title.
- * @member {string} [contactBilling.nameFirst] First name.
- * @member {string} [contactBilling.nameLast] Last name.
- * @member {string} [contactBilling.nameMiddle] Middle name.
- * @member {string} [contactBilling.organization] Organization contact
+ * @property {string} [contactAdmin.email] Email address.
+ * @property {string} [contactAdmin.fax] Fax number.
+ * @property {string} [contactAdmin.jobTitle] Job title.
+ * @property {string} [contactAdmin.nameFirst] First name.
+ * @property {string} [contactAdmin.nameLast] Last name.
+ * @property {string} [contactAdmin.nameMiddle] Middle name.
+ * @property {string} [contactAdmin.organization] Organization contact
* belongs to.
- * @member {string} [contactBilling.phone] Phone number.
- * @member {object} contactRegistrant Registrant contact.
- * @member {object} [contactRegistrant.addressMailing] Mailing address.
- * @member {string} [contactRegistrant.addressMailing.address1] First line of
+ * @property {string} [contactAdmin.phone] Phone number.
+ * @property {object} contactBilling Billing contact.
+ * @property {object} [contactBilling.addressMailing] Mailing address.
+ * @property {string} [contactBilling.addressMailing.address1] First line of
* an Address.
- * @member {string} [contactRegistrant.addressMailing.address2] The second
+ * @property {string} [contactBilling.addressMailing.address2] The second
* line of the Address. Optional.
- * @member {string} [contactRegistrant.addressMailing.city] The city for the
+ * @property {string} [contactBilling.addressMailing.city] The city for the
* address.
- * @member {string} [contactRegistrant.addressMailing.country] The country
- * for the address.
- * @member {string} [contactRegistrant.addressMailing.postalCode] The postal
+ * @property {string} [contactBilling.addressMailing.country] The country for
+ * the address.
+ * @property {string} [contactBilling.addressMailing.postalCode] The postal
* code for the address.
- * @member {string} [contactRegistrant.addressMailing.state] The state or
+ * @property {string} [contactBilling.addressMailing.state] The state or
+ * province for the address.
+ * @property {string} [contactBilling.email] Email address.
+ * @property {string} [contactBilling.fax] Fax number.
+ * @property {string} [contactBilling.jobTitle] Job title.
+ * @property {string} [contactBilling.nameFirst] First name.
+ * @property {string} [contactBilling.nameLast] Last name.
+ * @property {string} [contactBilling.nameMiddle] Middle name.
+ * @property {string} [contactBilling.organization] Organization contact
+ * belongs to.
+ * @property {string} [contactBilling.phone] Phone number.
+ * @property {object} contactRegistrant Registrant contact.
+ * @property {object} [contactRegistrant.addressMailing] Mailing address.
+ * @property {string} [contactRegistrant.addressMailing.address1] First line
+ * of an Address.
+ * @property {string} [contactRegistrant.addressMailing.address2] The second
+ * line of the Address. Optional.
+ * @property {string} [contactRegistrant.addressMailing.city] The city for
+ * the address.
+ * @property {string} [contactRegistrant.addressMailing.country] The country
+ * for the address.
+ * @property {string} [contactRegistrant.addressMailing.postalCode] The
+ * postal code for the address.
+ * @property {string} [contactRegistrant.addressMailing.state] The state or
* province for the address.
- * @member {string} [contactRegistrant.email] Email address.
- * @member {string} [contactRegistrant.fax] Fax number.
- * @member {string} [contactRegistrant.jobTitle] Job title.
- * @member {string} [contactRegistrant.nameFirst] First name.
- * @member {string} [contactRegistrant.nameLast] Last name.
- * @member {string} [contactRegistrant.nameMiddle] Middle name.
- * @member {string} [contactRegistrant.organization] Organization contact
+ * @property {string} [contactRegistrant.email] Email address.
+ * @property {string} [contactRegistrant.fax] Fax number.
+ * @property {string} [contactRegistrant.jobTitle] Job title.
+ * @property {string} [contactRegistrant.nameFirst] First name.
+ * @property {string} [contactRegistrant.nameLast] Last name.
+ * @property {string} [contactRegistrant.nameMiddle] Middle name.
+ * @property {string} [contactRegistrant.organization] Organization contact
* belongs to.
- * @member {string} [contactRegistrant.phone] Phone number.
- * @member {object} contactTech Technical contact.
- * @member {object} [contactTech.addressMailing] Mailing address.
- * @member {string} [contactTech.addressMailing.address1] First line of an
+ * @property {string} [contactRegistrant.phone] Phone number.
+ * @property {object} contactTech Technical contact.
+ * @property {object} [contactTech.addressMailing] Mailing address.
+ * @property {string} [contactTech.addressMailing.address1] First line of an
* Address.
- * @member {string} [contactTech.addressMailing.address2] The second line of
- * the Address. Optional.
- * @member {string} [contactTech.addressMailing.city] The city for the
- * address.
- * @member {string} [contactTech.addressMailing.country] The country for the
+ * @property {string} [contactTech.addressMailing.address2] The second line
+ * of the Address. Optional.
+ * @property {string} [contactTech.addressMailing.city] The city for the
* address.
- * @member {string} [contactTech.addressMailing.postalCode] The postal code
- * for the address.
- * @member {string} [contactTech.addressMailing.state] The state or province
+ * @property {string} [contactTech.addressMailing.country] The country for
+ * the address.
+ * @property {string} [contactTech.addressMailing.postalCode] The postal code
* for the address.
- * @member {string} [contactTech.email] Email address.
- * @member {string} [contactTech.fax] Fax number.
- * @member {string} [contactTech.jobTitle] Job title.
- * @member {string} [contactTech.nameFirst] First name.
- * @member {string} [contactTech.nameLast] Last name.
- * @member {string} [contactTech.nameMiddle] Middle name.
- * @member {string} [contactTech.organization] Organization contact belongs
+ * @property {string} [contactTech.addressMailing.state] The state or
+ * province for the address.
+ * @property {string} [contactTech.email] Email address.
+ * @property {string} [contactTech.fax] Fax number.
+ * @property {string} [contactTech.jobTitle] Job title.
+ * @property {string} [contactTech.nameFirst] First name.
+ * @property {string} [contactTech.nameLast] Last name.
+ * @property {string} [contactTech.nameMiddle] Middle name.
+ * @property {string} [contactTech.organization] Organization contact belongs
* to.
- * @member {string} [contactTech.phone] Phone number.
- * @member {string} [registrationStatus] Domain registration status. Possible
- * values include: 'Active', 'Awaiting', 'Cancelled', 'Confiscated',
+ * @property {string} [contactTech.phone] Phone number.
+ * @property {string} [registrationStatus] Domain registration status.
+ * Possible values include: 'Active', 'Awaiting', 'Cancelled', 'Confiscated',
* 'Disabled', 'Excluded', 'Expired', 'Failed', 'Held', 'Locked', 'Parked',
* 'Pending', 'Reserved', 'Reverted', 'Suspended', 'Transferred', 'Unknown',
* 'Unlocked', 'Unparked', 'Updated', 'JsonConverterFailed'
- * @member {string} [provisioningState] Domain provisioning state. Possible
+ * @property {string} [provisioningState] Domain provisioning state. Possible
* values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress',
* 'Deleting'
- * @member {array} [nameServers] Name servers.
- * @member {boolean} [privacy] true if domain privacy is enabled
- * for this domain; otherwise, false.
- * @member {date} [createdTime] Domain creation timestamp.
- * @member {date} [expirationTime] Domain expiration timestamp.
- * @member {date} [lastRenewedTime] Timestamp when the domain was renewed
+ * @property {array} [nameServers] Name servers.
+ * @property {boolean} [privacy] true if domain privacy is
+ * enabled for this domain; otherwise, false.
+ * @property {date} [createdTime] Domain creation timestamp.
+ * @property {date} [expirationTime] Domain expiration timestamp.
+ * @property {date} [lastRenewedTime] Timestamp when the domain was renewed
* last time.
- * @member {boolean} [autoRenew] true if the domain should be
+ * @property {boolean} [autoRenew] true if the domain should be
* automatically renewed; otherwise, false. Default value: true
* .
- * @member {boolean} [readyForDnsRecordManagement] true if Azure
- * can assign this domain to App Service apps; otherwise, false.
- * This value will be true if domain registration status is
- * active and
+ * @property {boolean} [readyForDnsRecordManagement] true if
+ * Azure can assign this domain to App Service apps; otherwise,
+ * false. This value will be true if domain
+ * registration status is active and
* it is hosted on name servers Azure has programmatic access to.
- * @member {array} [managedHostNames] All hostnames derived from the domain
+ * @property {array} [managedHostNames] All hostnames derived from the domain
* and assigned to Azure resources.
- * @member {object} consent Legal agreement consent.
- * @member {array} [consent.agreementKeys] List of applicable legal agreement
- * keys. This list can be retrieved using ListLegalAgreements API under
- * TopLevelDomain resource.
- * @member {string} [consent.agreedBy] Client IP address.
- * @member {date} [consent.agreedAt] Timestamp when the agreements were
+ * @property {object} consent Legal agreement consent.
+ * @property {array} [consent.agreementKeys] List of applicable legal
+ * agreement keys. This list can be retrieved using ListLegalAgreements API
+ * under TopLevelDomain resource.
+ * @property {string} [consent.agreedBy] Client IP address.
+ * @property {date} [consent.agreedAt] Timestamp when the agreements were
* accepted.
- * @member {array} [domainNotRenewableReasons] Reasons why domain is not
+ * @property {array} [domainNotRenewableReasons] Reasons why domain is not
* renewable.
- * @member {string} [dnsType] Current DNS type. Possible values include:
+ * @property {string} [dnsType] Current DNS type. Possible values include:
* 'AzureDns', 'DefaultDomainRegistrarDns'
- * @member {string} [dnsZoneId] Azure DNS Zone to use
- * @member {string} [targetDnsType] Target DNS type (would be used for
+ * @property {string} [dnsZoneId] Azure DNS Zone to use
+ * @property {string} [targetDnsType] Target DNS type (would be used for
* migration). Possible values include: 'AzureDns',
* 'DefaultDomainRegistrarDns'
- * @member {string} [authCode]
+ * @property {string} [authCode]
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/domainAvailablilityCheckResult.js b/lib/services/websiteManagement2/lib/models/domainAvailablilityCheckResult.js
index 545642c394..76f651aa98 100644
--- a/lib/services/websiteManagement2/lib/models/domainAvailablilityCheckResult.js
+++ b/lib/services/websiteManagement2/lib/models/domainAvailablilityCheckResult.js
@@ -17,13 +17,13 @@
class DomainAvailablilityCheckResult {
/**
* Create a DomainAvailablilityCheckResult.
- * @member {string} [name] Name of the domain.
- * @member {boolean} [available] true if domain can be purchased
- * using CreateDomain API; otherwise, false.
- * @member {string} [domainType] Valid values are Regular domain: Azure will
- * charge the full price of domain registration, SoftDeleted: Purchasing this
- * domain will simply restore it and this operation will not cost anything.
- * Possible values include: 'Regular', 'SoftDeleted'
+ * @property {string} [name] Name of the domain.
+ * @property {boolean} [available] true if domain can be
+ * purchased using CreateDomain API; otherwise, false.
+ * @property {string} [domainType] Valid values are Regular domain: Azure
+ * will charge the full price of domain registration, SoftDeleted: Purchasing
+ * this domain will simply restore it and this operation will not cost
+ * anything. Possible values include: 'Regular', 'SoftDeleted'
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/domainCollection.js b/lib/services/websiteManagement2/lib/models/domainCollection.js
index bd23f8a9b7..a456f71f93 100644
--- a/lib/services/websiteManagement2/lib/models/domainCollection.js
+++ b/lib/services/websiteManagement2/lib/models/domainCollection.js
@@ -16,7 +16,7 @@
class DomainCollection extends Array {
/**
* Create a DomainCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/domainControlCenterSsoRequest.js b/lib/services/websiteManagement2/lib/models/domainControlCenterSsoRequest.js
index c383cb4e4a..19578a9cbe 100644
--- a/lib/services/websiteManagement2/lib/models/domainControlCenterSsoRequest.js
+++ b/lib/services/websiteManagement2/lib/models/domainControlCenterSsoRequest.js
@@ -17,10 +17,11 @@
class DomainControlCenterSsoRequest {
/**
* Create a DomainControlCenterSsoRequest.
- * @member {string} [url] URL where the single sign-on request is to be made.
- * @member {string} [postParameterKey] Post parameter key.
- * @member {string} [postParameterValue] Post parameter value. Client should
- * use 'application/x-www-form-urlencoded' encoding for this value.
+ * @property {string} [url] URL where the single sign-on request is to be
+ * made.
+ * @property {string} [postParameterKey] Post parameter key.
+ * @property {string} [postParameterValue] Post parameter value. Client
+ * should use 'application/x-www-form-urlencoded' encoding for this value.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/domainOwnershipIdentifier.js b/lib/services/websiteManagement2/lib/models/domainOwnershipIdentifier.js
index 357f342bab..5ebeb0cf87 100644
--- a/lib/services/websiteManagement2/lib/models/domainOwnershipIdentifier.js
+++ b/lib/services/websiteManagement2/lib/models/domainOwnershipIdentifier.js
@@ -20,7 +20,7 @@ const models = require('./index');
class DomainOwnershipIdentifier extends models['ProxyOnlyResource'] {
/**
* Create a DomainOwnershipIdentifier.
- * @member {string} [ownershipId] Ownership Id.
+ * @property {string} [ownershipId] Ownership Id.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/domainOwnershipIdentifierCollection.js b/lib/services/websiteManagement2/lib/models/domainOwnershipIdentifierCollection.js
index a15ca8300a..7d81f77d39 100644
--- a/lib/services/websiteManagement2/lib/models/domainOwnershipIdentifierCollection.js
+++ b/lib/services/websiteManagement2/lib/models/domainOwnershipIdentifierCollection.js
@@ -16,7 +16,7 @@
class DomainOwnershipIdentifierCollection extends Array {
/**
* Create a DomainOwnershipIdentifierCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/domainPatchResource.js b/lib/services/websiteManagement2/lib/models/domainPatchResource.js
index 65093da110..3f00600e2c 100644
--- a/lib/services/websiteManagement2/lib/models/domainPatchResource.js
+++ b/lib/services/websiteManagement2/lib/models/domainPatchResource.js
@@ -20,139 +20,139 @@ const models = require('./index');
class DomainPatchResource extends models['ProxyOnlyResource'] {
/**
* Create a DomainPatchResource.
- * @member {object} contactAdmin Administrative contact.
- * @member {object} [contactAdmin.addressMailing] Mailing address.
- * @member {string} [contactAdmin.addressMailing.address1] First line of an
+ * @property {object} contactAdmin Administrative contact.
+ * @property {object} [contactAdmin.addressMailing] Mailing address.
+ * @property {string} [contactAdmin.addressMailing.address1] First line of an
* Address.
- * @member {string} [contactAdmin.addressMailing.address2] The second line of
- * the Address. Optional.
- * @member {string} [contactAdmin.addressMailing.city] The city for the
- * address.
- * @member {string} [contactAdmin.addressMailing.country] The country for the
- * address.
- * @member {string} [contactAdmin.addressMailing.postalCode] The postal code
- * for the address.
- * @member {string} [contactAdmin.addressMailing.state] The state or province
- * for the address.
- * @member {string} [contactAdmin.email] Email address.
- * @member {string} [contactAdmin.fax] Fax number.
- * @member {string} [contactAdmin.jobTitle] Job title.
- * @member {string} [contactAdmin.nameFirst] First name.
- * @member {string} [contactAdmin.nameLast] Last name.
- * @member {string} [contactAdmin.nameMiddle] Middle name.
- * @member {string} [contactAdmin.organization] Organization contact belongs
- * to.
- * @member {string} [contactAdmin.phone] Phone number.
- * @member {object} contactBilling Billing contact.
- * @member {object} [contactBilling.addressMailing] Mailing address.
- * @member {string} [contactBilling.addressMailing.address1] First line of an
- * Address.
- * @member {string} [contactBilling.addressMailing.address2] The second line
+ * @property {string} [contactAdmin.addressMailing.address2] The second line
* of the Address. Optional.
- * @member {string} [contactBilling.addressMailing.city] The city for the
+ * @property {string} [contactAdmin.addressMailing.city] The city for the
* address.
- * @member {string} [contactBilling.addressMailing.country] The country for
+ * @property {string} [contactAdmin.addressMailing.country] The country for
* the address.
- * @member {string} [contactBilling.addressMailing.postalCode] The postal
+ * @property {string} [contactAdmin.addressMailing.postalCode] The postal
* code for the address.
- * @member {string} [contactBilling.addressMailing.state] The state or
+ * @property {string} [contactAdmin.addressMailing.state] The state or
* province for the address.
- * @member {string} [contactBilling.email] Email address.
- * @member {string} [contactBilling.fax] Fax number.
- * @member {string} [contactBilling.jobTitle] Job title.
- * @member {string} [contactBilling.nameFirst] First name.
- * @member {string} [contactBilling.nameLast] Last name.
- * @member {string} [contactBilling.nameMiddle] Middle name.
- * @member {string} [contactBilling.organization] Organization contact
+ * @property {string} [contactAdmin.email] Email address.
+ * @property {string} [contactAdmin.fax] Fax number.
+ * @property {string} [contactAdmin.jobTitle] Job title.
+ * @property {string} [contactAdmin.nameFirst] First name.
+ * @property {string} [contactAdmin.nameLast] Last name.
+ * @property {string} [contactAdmin.nameMiddle] Middle name.
+ * @property {string} [contactAdmin.organization] Organization contact
* belongs to.
- * @member {string} [contactBilling.phone] Phone number.
- * @member {object} contactRegistrant Registrant contact.
- * @member {object} [contactRegistrant.addressMailing] Mailing address.
- * @member {string} [contactRegistrant.addressMailing.address1] First line of
+ * @property {string} [contactAdmin.phone] Phone number.
+ * @property {object} contactBilling Billing contact.
+ * @property {object} [contactBilling.addressMailing] Mailing address.
+ * @property {string} [contactBilling.addressMailing.address1] First line of
* an Address.
- * @member {string} [contactRegistrant.addressMailing.address2] The second
+ * @property {string} [contactBilling.addressMailing.address2] The second
* line of the Address. Optional.
- * @member {string} [contactRegistrant.addressMailing.city] The city for the
+ * @property {string} [contactBilling.addressMailing.city] The city for the
* address.
- * @member {string} [contactRegistrant.addressMailing.country] The country
- * for the address.
- * @member {string} [contactRegistrant.addressMailing.postalCode] The postal
+ * @property {string} [contactBilling.addressMailing.country] The country for
+ * the address.
+ * @property {string} [contactBilling.addressMailing.postalCode] The postal
* code for the address.
- * @member {string} [contactRegistrant.addressMailing.state] The state or
+ * @property {string} [contactBilling.addressMailing.state] The state or
+ * province for the address.
+ * @property {string} [contactBilling.email] Email address.
+ * @property {string} [contactBilling.fax] Fax number.
+ * @property {string} [contactBilling.jobTitle] Job title.
+ * @property {string} [contactBilling.nameFirst] First name.
+ * @property {string} [contactBilling.nameLast] Last name.
+ * @property {string} [contactBilling.nameMiddle] Middle name.
+ * @property {string} [contactBilling.organization] Organization contact
+ * belongs to.
+ * @property {string} [contactBilling.phone] Phone number.
+ * @property {object} contactRegistrant Registrant contact.
+ * @property {object} [contactRegistrant.addressMailing] Mailing address.
+ * @property {string} [contactRegistrant.addressMailing.address1] First line
+ * of an Address.
+ * @property {string} [contactRegistrant.addressMailing.address2] The second
+ * line of the Address. Optional.
+ * @property {string} [contactRegistrant.addressMailing.city] The city for
+ * the address.
+ * @property {string} [contactRegistrant.addressMailing.country] The country
+ * for the address.
+ * @property {string} [contactRegistrant.addressMailing.postalCode] The
+ * postal code for the address.
+ * @property {string} [contactRegistrant.addressMailing.state] The state or
* province for the address.
- * @member {string} [contactRegistrant.email] Email address.
- * @member {string} [contactRegistrant.fax] Fax number.
- * @member {string} [contactRegistrant.jobTitle] Job title.
- * @member {string} [contactRegistrant.nameFirst] First name.
- * @member {string} [contactRegistrant.nameLast] Last name.
- * @member {string} [contactRegistrant.nameMiddle] Middle name.
- * @member {string} [contactRegistrant.organization] Organization contact
+ * @property {string} [contactRegistrant.email] Email address.
+ * @property {string} [contactRegistrant.fax] Fax number.
+ * @property {string} [contactRegistrant.jobTitle] Job title.
+ * @property {string} [contactRegistrant.nameFirst] First name.
+ * @property {string} [contactRegistrant.nameLast] Last name.
+ * @property {string} [contactRegistrant.nameMiddle] Middle name.
+ * @property {string} [contactRegistrant.organization] Organization contact
* belongs to.
- * @member {string} [contactRegistrant.phone] Phone number.
- * @member {object} contactTech Technical contact.
- * @member {object} [contactTech.addressMailing] Mailing address.
- * @member {string} [contactTech.addressMailing.address1] First line of an
+ * @property {string} [contactRegistrant.phone] Phone number.
+ * @property {object} contactTech Technical contact.
+ * @property {object} [contactTech.addressMailing] Mailing address.
+ * @property {string} [contactTech.addressMailing.address1] First line of an
* Address.
- * @member {string} [contactTech.addressMailing.address2] The second line of
- * the Address. Optional.
- * @member {string} [contactTech.addressMailing.city] The city for the
- * address.
- * @member {string} [contactTech.addressMailing.country] The country for the
+ * @property {string} [contactTech.addressMailing.address2] The second line
+ * of the Address. Optional.
+ * @property {string} [contactTech.addressMailing.city] The city for the
* address.
- * @member {string} [contactTech.addressMailing.postalCode] The postal code
- * for the address.
- * @member {string} [contactTech.addressMailing.state] The state or province
+ * @property {string} [contactTech.addressMailing.country] The country for
+ * the address.
+ * @property {string} [contactTech.addressMailing.postalCode] The postal code
* for the address.
- * @member {string} [contactTech.email] Email address.
- * @member {string} [contactTech.fax] Fax number.
- * @member {string} [contactTech.jobTitle] Job title.
- * @member {string} [contactTech.nameFirst] First name.
- * @member {string} [contactTech.nameLast] Last name.
- * @member {string} [contactTech.nameMiddle] Middle name.
- * @member {string} [contactTech.organization] Organization contact belongs
+ * @property {string} [contactTech.addressMailing.state] The state or
+ * province for the address.
+ * @property {string} [contactTech.email] Email address.
+ * @property {string} [contactTech.fax] Fax number.
+ * @property {string} [contactTech.jobTitle] Job title.
+ * @property {string} [contactTech.nameFirst] First name.
+ * @property {string} [contactTech.nameLast] Last name.
+ * @property {string} [contactTech.nameMiddle] Middle name.
+ * @property {string} [contactTech.organization] Organization contact belongs
* to.
- * @member {string} [contactTech.phone] Phone number.
- * @member {string} [registrationStatus] Domain registration status. Possible
- * values include: 'Active', 'Awaiting', 'Cancelled', 'Confiscated',
+ * @property {string} [contactTech.phone] Phone number.
+ * @property {string} [registrationStatus] Domain registration status.
+ * Possible values include: 'Active', 'Awaiting', 'Cancelled', 'Confiscated',
* 'Disabled', 'Excluded', 'Expired', 'Failed', 'Held', 'Locked', 'Parked',
* 'Pending', 'Reserved', 'Reverted', 'Suspended', 'Transferred', 'Unknown',
* 'Unlocked', 'Unparked', 'Updated', 'JsonConverterFailed'
- * @member {string} [provisioningState] Domain provisioning state. Possible
+ * @property {string} [provisioningState] Domain provisioning state. Possible
* values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress',
* 'Deleting'
- * @member {array} [nameServers] Name servers.
- * @member {boolean} [privacy] true if domain privacy is enabled
- * for this domain; otherwise, false.
- * @member {date} [createdTime] Domain creation timestamp.
- * @member {date} [expirationTime] Domain expiration timestamp.
- * @member {date} [lastRenewedTime] Timestamp when the domain was renewed
+ * @property {array} [nameServers] Name servers.
+ * @property {boolean} [privacy] true if domain privacy is
+ * enabled for this domain; otherwise, false.
+ * @property {date} [createdTime] Domain creation timestamp.
+ * @property {date} [expirationTime] Domain expiration timestamp.
+ * @property {date} [lastRenewedTime] Timestamp when the domain was renewed
* last time.
- * @member {boolean} [autoRenew] true if the domain should be
+ * @property {boolean} [autoRenew] true if the domain should be
* automatically renewed; otherwise, false. Default value: true
* .
- * @member {boolean} [readyForDnsRecordManagement] true if Azure
- * can assign this domain to App Service apps; otherwise, false.
- * This value will be true if domain registration status is
- * active and
+ * @property {boolean} [readyForDnsRecordManagement] true if
+ * Azure can assign this domain to App Service apps; otherwise,
+ * false. This value will be true if domain
+ * registration status is active and
* it is hosted on name servers Azure has programmatic access to.
- * @member {array} [managedHostNames] All hostnames derived from the domain
+ * @property {array} [managedHostNames] All hostnames derived from the domain
* and assigned to Azure resources.
- * @member {object} consent Legal agreement consent.
- * @member {array} [consent.agreementKeys] List of applicable legal agreement
- * keys. This list can be retrieved using ListLegalAgreements API under
- * TopLevelDomain resource.
- * @member {string} [consent.agreedBy] Client IP address.
- * @member {date} [consent.agreedAt] Timestamp when the agreements were
+ * @property {object} consent Legal agreement consent.
+ * @property {array} [consent.agreementKeys] List of applicable legal
+ * agreement keys. This list can be retrieved using ListLegalAgreements API
+ * under TopLevelDomain resource.
+ * @property {string} [consent.agreedBy] Client IP address.
+ * @property {date} [consent.agreedAt] Timestamp when the agreements were
* accepted.
- * @member {array} [domainNotRenewableReasons] Reasons why domain is not
+ * @property {array} [domainNotRenewableReasons] Reasons why domain is not
* renewable.
- * @member {string} [dnsType] Current DNS type. Possible values include:
+ * @property {string} [dnsType] Current DNS type. Possible values include:
* 'AzureDns', 'DefaultDomainRegistrarDns'
- * @member {string} [dnsZoneId] Azure DNS Zone to use
- * @member {string} [targetDnsType] Target DNS type (would be used for
+ * @property {string} [dnsZoneId] Azure DNS Zone to use
+ * @property {string} [targetDnsType] Target DNS type (would be used for
* migration). Possible values include: 'AzureDns',
* 'DefaultDomainRegistrarDns'
- * @member {string} [authCode]
+ * @property {string} [authCode]
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/domainPurchaseConsent.js b/lib/services/websiteManagement2/lib/models/domainPurchaseConsent.js
index 9cd02ca121..3f85dfcad8 100644
--- a/lib/services/websiteManagement2/lib/models/domainPurchaseConsent.js
+++ b/lib/services/websiteManagement2/lib/models/domainPurchaseConsent.js
@@ -18,11 +18,11 @@
class DomainPurchaseConsent {
/**
* Create a DomainPurchaseConsent.
- * @member {array} [agreementKeys] List of applicable legal agreement keys.
+ * @property {array} [agreementKeys] List of applicable legal agreement keys.
* This list can be retrieved using ListLegalAgreements API under
* TopLevelDomain resource.
- * @member {string} [agreedBy] Client IP address.
- * @member {date} [agreedAt] Timestamp when the agreements were accepted.
+ * @property {string} [agreedBy] Client IP address.
+ * @property {date} [agreedAt] Timestamp when the agreements were accepted.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/domainRecommendationSearchParameters.js b/lib/services/websiteManagement2/lib/models/domainRecommendationSearchParameters.js
index dd3a3b6af9..448c91b91d 100644
--- a/lib/services/websiteManagement2/lib/models/domainRecommendationSearchParameters.js
+++ b/lib/services/websiteManagement2/lib/models/domainRecommendationSearchParameters.js
@@ -17,9 +17,9 @@
class DomainRecommendationSearchParameters {
/**
* Create a DomainRecommendationSearchParameters.
- * @member {string} [keywords] Keywords to be used for generating domain
+ * @property {string} [keywords] Keywords to be used for generating domain
* recommendations.
- * @member {number} [maxDomainRecommendations] Maximum number of
+ * @property {number} [maxDomainRecommendations] Maximum number of
* recommendations.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/enabledConfig.js b/lib/services/websiteManagement2/lib/models/enabledConfig.js
index b45f899d15..dfee0477f1 100644
--- a/lib/services/websiteManagement2/lib/models/enabledConfig.js
+++ b/lib/services/websiteManagement2/lib/models/enabledConfig.js
@@ -17,8 +17,8 @@
class EnabledConfig {
/**
* Create a EnabledConfig.
- * @member {boolean} [enabled] True if configuration is enabled, false if it
- * is disabled and null if configuration is not set.
+ * @property {boolean} [enabled] True if configuration is enabled, false if
+ * it is disabled and null if configuration is not set.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/errorEntity.js b/lib/services/websiteManagement2/lib/models/errorEntity.js
index 36492b145d..82a215769d 100644
--- a/lib/services/websiteManagement2/lib/models/errorEntity.js
+++ b/lib/services/websiteManagement2/lib/models/errorEntity.js
@@ -17,12 +17,12 @@
class ErrorEntity {
/**
* Create a ErrorEntity.
- * @member {string} [extendedCode] Type of error.
- * @member {string} [messageTemplate] Message template.
- * @member {array} [parameters] Parameters for the template.
- * @member {array} [innerErrors] Inner errors.
- * @member {string} [code] Basic error code.
- * @member {string} [message] Any details of the error.
+ * @property {string} [extendedCode] Type of error.
+ * @property {string} [messageTemplate] Message template.
+ * @property {array} [parameters] Parameters for the template.
+ * @property {array} [innerErrors] Inner errors.
+ * @property {string} [code] Basic error code.
+ * @property {string} [message] Any details of the error.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/experiments.js b/lib/services/websiteManagement2/lib/models/experiments.js
index 3dd1828dcd..1a5c817968 100644
--- a/lib/services/websiteManagement2/lib/models/experiments.js
+++ b/lib/services/websiteManagement2/lib/models/experiments.js
@@ -17,7 +17,7 @@
class Experiments {
/**
* Create a Experiments.
- * @member {array} [rampUpRules] List of ramp-up rules.
+ * @property {array} [rampUpRules] List of ramp-up rules.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/fileSystemApplicationLogsConfig.js b/lib/services/websiteManagement2/lib/models/fileSystemApplicationLogsConfig.js
index b64d80772f..f149333e2a 100644
--- a/lib/services/websiteManagement2/lib/models/fileSystemApplicationLogsConfig.js
+++ b/lib/services/websiteManagement2/lib/models/fileSystemApplicationLogsConfig.js
@@ -17,7 +17,7 @@
class FileSystemApplicationLogsConfig {
/**
* Create a FileSystemApplicationLogsConfig.
- * @member {string} [level] Log level. Possible values include: 'Off',
+ * @property {string} [level] Log level. Possible values include: 'Off',
* 'Verbose', 'Information', 'Warning', 'Error'. Default value: 'Off' .
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/fileSystemHttpLogsConfig.js b/lib/services/websiteManagement2/lib/models/fileSystemHttpLogsConfig.js
index e85d48eb3b..413c3ad524 100644
--- a/lib/services/websiteManagement2/lib/models/fileSystemHttpLogsConfig.js
+++ b/lib/services/websiteManagement2/lib/models/fileSystemHttpLogsConfig.js
@@ -17,15 +17,15 @@
class FileSystemHttpLogsConfig {
/**
* Create a FileSystemHttpLogsConfig.
- * @member {number} [retentionInMb] Maximum size in megabytes that http log
+ * @property {number} [retentionInMb] Maximum size in megabytes that http log
* files can use.
* When reached old log files will be removed to make space for new ones.
* Value can range between 25 and 100.
- * @member {number} [retentionInDays] Retention in days.
+ * @property {number} [retentionInDays] Retention in days.
* Remove files older than X days.
* 0 or lower means no retention.
- * @member {boolean} [enabled] True if configuration is enabled, false if it
- * is disabled and null if configuration is not set.
+ * @property {boolean} [enabled] True if configuration is enabled, false if
+ * it is disabled and null if configuration is not set.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/functionEnvelope.js b/lib/services/websiteManagement2/lib/models/functionEnvelope.js
index de01948153..9ab8ddf51a 100644
--- a/lib/services/websiteManagement2/lib/models/functionEnvelope.js
+++ b/lib/services/websiteManagement2/lib/models/functionEnvelope.js
@@ -20,15 +20,15 @@ const models = require('./index');
class FunctionEnvelope extends models['ProxyOnlyResource'] {
/**
* Create a FunctionEnvelope.
- * @member {string} [functionAppId] Function App ID.
- * @member {string} [scriptRootPathHref] Script root path URI.
- * @member {string} [scriptHref] Script URI.
- * @member {string} [configHref] Config URI.
- * @member {string} [secretsFileHref] Secrets file URI.
- * @member {string} [href] Function URI.
- * @member {object} [config] Config information.
- * @member {object} [files] File list.
- * @member {string} [testData] Test data used when testing via the Azure
+ * @property {string} [functionAppId] Function App ID.
+ * @property {string} [scriptRootPathHref] Script root path URI.
+ * @property {string} [scriptHref] Script URI.
+ * @property {string} [configHref] Config URI.
+ * @property {string} [secretsFileHref] Secrets file URI.
+ * @property {string} [href] Function URI.
+ * @property {object} [config] Config information.
+ * @property {object} [files] File list.
+ * @property {string} [testData] Test data used when testing via the Azure
* Portal.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/functionEnvelopeCollection.js b/lib/services/websiteManagement2/lib/models/functionEnvelopeCollection.js
index 11a87f9e7b..7c0f44fcb9 100644
--- a/lib/services/websiteManagement2/lib/models/functionEnvelopeCollection.js
+++ b/lib/services/websiteManagement2/lib/models/functionEnvelopeCollection.js
@@ -16,7 +16,7 @@
class FunctionEnvelopeCollection extends Array {
/**
* Create a FunctionEnvelopeCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/functionSecrets.js b/lib/services/websiteManagement2/lib/models/functionSecrets.js
index 89769cbd49..f2faf9ca0a 100644
--- a/lib/services/websiteManagement2/lib/models/functionSecrets.js
+++ b/lib/services/websiteManagement2/lib/models/functionSecrets.js
@@ -20,8 +20,8 @@ const models = require('./index');
class FunctionSecrets extends models['ProxyOnlyResource'] {
/**
* Create a FunctionSecrets.
- * @member {string} [key] Secret key.
- * @member {string} [triggerUrl] Trigger URL.
+ * @property {string} [key] Secret key.
+ * @property {string} [triggerUrl] Trigger URL.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/geoRegion.js b/lib/services/websiteManagement2/lib/models/geoRegion.js
index 6488f76da4..3a2fb244a2 100644
--- a/lib/services/websiteManagement2/lib/models/geoRegion.js
+++ b/lib/services/websiteManagement2/lib/models/geoRegion.js
@@ -20,8 +20,8 @@ const models = require('./index');
class GeoRegion extends models['ProxyOnlyResource'] {
/**
* Create a GeoRegion.
- * @member {string} [description] Region description.
- * @member {string} [displayName] Display name for region.
+ * @property {string} [description] Region description.
+ * @property {string} [displayName] Display name for region.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/geoRegionCollection.js b/lib/services/websiteManagement2/lib/models/geoRegionCollection.js
index b4383a4013..7e4dd92367 100644
--- a/lib/services/websiteManagement2/lib/models/geoRegionCollection.js
+++ b/lib/services/websiteManagement2/lib/models/geoRegionCollection.js
@@ -16,7 +16,7 @@
class GeoRegionCollection extends Array {
/**
* Create a GeoRegionCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/globalCsmSkuDescription.js b/lib/services/websiteManagement2/lib/models/globalCsmSkuDescription.js
index a2c77faba9..aa6a0c8a2e 100644
--- a/lib/services/websiteManagement2/lib/models/globalCsmSkuDescription.js
+++ b/lib/services/websiteManagement2/lib/models/globalCsmSkuDescription.js
@@ -17,21 +17,22 @@
class GlobalCsmSkuDescription {
/**
* Create a GlobalCsmSkuDescription.
- * @member {string} [name] Name of the resource SKU.
- * @member {string} [tier] Service Tier of the resource SKU.
- * @member {string} [size] Size specifier of the resource SKU.
- * @member {string} [family] Family code of the resource SKU.
- * @member {object} [capacity] Min, max, and default scale values of the SKU.
- * @member {number} [capacity.minimum] Minimum number of workers for this App
- * Service plan SKU.
- * @member {number} [capacity.maximum] Maximum number of workers for this App
- * Service plan SKU.
- * @member {number} [capacity.default] Default number of workers for this App
- * Service plan SKU.
- * @member {string} [capacity.scaleType] Available scale configurations for
+ * @property {string} [name] Name of the resource SKU.
+ * @property {string} [tier] Service Tier of the resource SKU.
+ * @property {string} [size] Size specifier of the resource SKU.
+ * @property {string} [family] Family code of the resource SKU.
+ * @property {object} [capacity] Min, max, and default scale values of the
+ * SKU.
+ * @property {number} [capacity.minimum] Minimum number of workers for this
+ * App Service plan SKU.
+ * @property {number} [capacity.maximum] Maximum number of workers for this
+ * App Service plan SKU.
+ * @property {number} [capacity.default] Default number of workers for this
+ * App Service plan SKU.
+ * @property {string} [capacity.scaleType] Available scale configurations for
* an App Service plan.
- * @member {array} [locations] Locations of the SKU.
- * @member {array} [capabilities] Capabilities of the SKU, e.g., is traffic
+ * @property {array} [locations] Locations of the SKU.
+ * @property {array} [capabilities] Capabilities of the SKU, e.g., is traffic
* manager enabled?
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/handlerMapping.js b/lib/services/websiteManagement2/lib/models/handlerMapping.js
index ee5dc87e3b..2d55e6e40f 100644
--- a/lib/services/websiteManagement2/lib/models/handlerMapping.js
+++ b/lib/services/websiteManagement2/lib/models/handlerMapping.js
@@ -20,11 +20,11 @@
class HandlerMapping {
/**
* Create a HandlerMapping.
- * @member {string} [extension] Requests with this extension will be handled
- * using the specified FastCGI application.
- * @member {string} [scriptProcessor] The absolute path to the FastCGI
+ * @property {string} [extension] Requests with this extension will be
+ * handled using the specified FastCGI application.
+ * @property {string} [scriptProcessor] The absolute path to the FastCGI
* application.
- * @member {string} [argumentsProperty] Command-line arguments to be passed
+ * @property {string} [argumentsProperty] Command-line arguments to be passed
* to the script processor.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/hostName.js b/lib/services/websiteManagement2/lib/models/hostName.js
index 04e7ae98f7..7e79acba1c 100644
--- a/lib/services/websiteManagement2/lib/models/hostName.js
+++ b/lib/services/websiteManagement2/lib/models/hostName.js
@@ -17,19 +17,19 @@
class HostName {
/**
* Create a HostName.
- * @member {string} [name] Name of the hostname.
- * @member {array} [siteNames] List of apps the hostname is assigned to. This
- * list will have more than one app only if the hostname is pointing to a
- * Traffic Manager.
- * @member {string} [azureResourceName] Name of the Azure resource the
+ * @property {string} [name] Name of the hostname.
+ * @property {array} [siteNames] List of apps the hostname is assigned to.
+ * This list will have more than one app only if the hostname is pointing to
+ * a Traffic Manager.
+ * @property {string} [azureResourceName] Name of the Azure resource the
* hostname is assigned to. If it is assigned to a Traffic Manager then it
* will be the Traffic Manager name otherwise it will be the app name.
- * @member {string} [azureResourceType] Type of the Azure resource the
+ * @property {string} [azureResourceType] Type of the Azure resource the
* hostname is assigned to. Possible values include: 'Website',
* 'TrafficManager'
- * @member {string} [customHostNameDnsRecordType] Type of the DNS record.
+ * @property {string} [customHostNameDnsRecordType] Type of the DNS record.
* Possible values include: 'CName', 'A'
- * @member {string} [hostNameType] Type of the hostname. Possible values
+ * @property {string} [hostNameType] Type of the hostname. Possible values
* include: 'Verified', 'Managed'
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/hostNameBinding.js b/lib/services/websiteManagement2/lib/models/hostNameBinding.js
index f18fcbe373..14fd3e9ebe 100644
--- a/lib/services/websiteManagement2/lib/models/hostNameBinding.js
+++ b/lib/services/websiteManagement2/lib/models/hostNameBinding.js
@@ -20,19 +20,19 @@ const models = require('./index');
class HostNameBinding extends models['ProxyOnlyResource'] {
/**
* Create a HostNameBinding.
- * @member {string} [siteName] App Service app name.
- * @member {string} [domainId] Fully qualified ARM domain resource URI.
- * @member {string} [azureResourceName] Azure resource name.
- * @member {string} [azureResourceType] Azure resource type. Possible values
- * include: 'Website', 'TrafficManager'
- * @member {string} [customHostNameDnsRecordType] Custom DNS record type.
+ * @property {string} [siteName] App Service app name.
+ * @property {string} [domainId] Fully qualified ARM domain resource URI.
+ * @property {string} [azureResourceName] Azure resource name.
+ * @property {string} [azureResourceType] Azure resource type. Possible
+ * values include: 'Website', 'TrafficManager'
+ * @property {string} [customHostNameDnsRecordType] Custom DNS record type.
* Possible values include: 'CName', 'A'
- * @member {string} [hostNameType] Hostname type. Possible values include:
+ * @property {string} [hostNameType] Hostname type. Possible values include:
* 'Verified', 'Managed'
- * @member {string} [sslState] SSL type. Possible values include: 'Disabled',
- * 'SniEnabled', 'IpBasedEnabled'
- * @member {string} [thumbprint] SSL certificate thumbprint
- * @member {string} [virtualIP] Virtual IP address assigned to the hostname
+ * @property {string} [sslState] SSL type. Possible values include:
+ * 'Disabled', 'SniEnabled', 'IpBasedEnabled'
+ * @property {string} [thumbprint] SSL certificate thumbprint
+ * @property {string} [virtualIP] Virtual IP address assigned to the hostname
* if IP based SSL is enabled.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/hostNameBindingCollection.js b/lib/services/websiteManagement2/lib/models/hostNameBindingCollection.js
index 701310c452..27662e72a9 100644
--- a/lib/services/websiteManagement2/lib/models/hostNameBindingCollection.js
+++ b/lib/services/websiteManagement2/lib/models/hostNameBindingCollection.js
@@ -16,7 +16,7 @@
class HostNameBindingCollection extends Array {
/**
* Create a HostNameBindingCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/hostNameSslState.js b/lib/services/websiteManagement2/lib/models/hostNameSslState.js
index 2158c960f7..a4074d0dc6 100644
--- a/lib/services/websiteManagement2/lib/models/hostNameSslState.js
+++ b/lib/services/websiteManagement2/lib/models/hostNameSslState.js
@@ -17,15 +17,15 @@
class HostNameSslState {
/**
* Create a HostNameSslState.
- * @member {string} [name] Hostname.
- * @member {string} [sslState] SSL type. Possible values include: 'Disabled',
- * 'SniEnabled', 'IpBasedEnabled'
- * @member {string} [virtualIP] Virtual IP address assigned to the hostname
+ * @property {string} [name] Hostname.
+ * @property {string} [sslState] SSL type. Possible values include:
+ * 'Disabled', 'SniEnabled', 'IpBasedEnabled'
+ * @property {string} [virtualIP] Virtual IP address assigned to the hostname
* if IP based SSL is enabled.
- * @member {string} [thumbprint] SSL certificate thumbprint.
- * @member {boolean} [toUpdate] Set to true to update existing
+ * @property {string} [thumbprint] SSL certificate thumbprint.
+ * @property {boolean} [toUpdate] Set to true to update existing
* hostname.
- * @member {string} [hostType] Indicates whether the hostname is a standard
+ * @property {string} [hostType] Indicates whether the hostname is a standard
* or repository hostname. Possible values include: 'Standard', 'Repository'
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/hostingEnvironmentDeploymentInfo.js b/lib/services/websiteManagement2/lib/models/hostingEnvironmentDeploymentInfo.js
index 08dd21c8d2..2da50b9f2f 100644
--- a/lib/services/websiteManagement2/lib/models/hostingEnvironmentDeploymentInfo.js
+++ b/lib/services/websiteManagement2/lib/models/hostingEnvironmentDeploymentInfo.js
@@ -17,8 +17,8 @@
class HostingEnvironmentDeploymentInfo {
/**
* Create a HostingEnvironmentDeploymentInfo.
- * @member {string} [name] Name of the App Service Environment.
- * @member {string} [location] Location of the App Service Environment.
+ * @property {string} [name] Name of the App Service Environment.
+ * @property {string} [location] Location of the App Service Environment.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/hostingEnvironmentDiagnostics.js b/lib/services/websiteManagement2/lib/models/hostingEnvironmentDiagnostics.js
index 2ea639d385..f83c5360a2 100644
--- a/lib/services/websiteManagement2/lib/models/hostingEnvironmentDiagnostics.js
+++ b/lib/services/websiteManagement2/lib/models/hostingEnvironmentDiagnostics.js
@@ -17,8 +17,8 @@
class HostingEnvironmentDiagnostics {
/**
* Create a HostingEnvironmentDiagnostics.
- * @member {string} [name] Name/identifier of the diagnostics.
- * @member {string} [diagnosicsOutput] Diagnostics output.
+ * @property {string} [name] Name/identifier of the diagnostics.
+ * @property {string} [diagnosicsOutput] Diagnostics output.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/hostingEnvironmentProfile.js b/lib/services/websiteManagement2/lib/models/hostingEnvironmentProfile.js
index e339a1cc17..e1b559c4cf 100644
--- a/lib/services/websiteManagement2/lib/models/hostingEnvironmentProfile.js
+++ b/lib/services/websiteManagement2/lib/models/hostingEnvironmentProfile.js
@@ -17,9 +17,9 @@
class HostingEnvironmentProfile {
/**
* Create a HostingEnvironmentProfile.
- * @member {string} [id] Resource ID of the App Service Environment.
- * @member {string} [name] Name of the App Service Environment.
- * @member {string} [type] Resource type of the App Service Environment.
+ * @property {string} [id] Resource ID of the App Service Environment.
+ * @property {string} [name] Name of the App Service Environment.
+ * @property {string} [type] Resource type of the App Service Environment.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/httpLogsConfig.js b/lib/services/websiteManagement2/lib/models/httpLogsConfig.js
index 36309201ef..a0f2361317 100644
--- a/lib/services/websiteManagement2/lib/models/httpLogsConfig.js
+++ b/lib/services/websiteManagement2/lib/models/httpLogsConfig.js
@@ -17,24 +17,24 @@
class HttpLogsConfig {
/**
* Create a HttpLogsConfig.
- * @member {object} [fileSystem] Http logs to file system configuration.
- * @member {number} [fileSystem.retentionInMb] Maximum size in megabytes that
- * http log files can use.
+ * @property {object} [fileSystem] Http logs to file system configuration.
+ * @property {number} [fileSystem.retentionInMb] Maximum size in megabytes
+ * that http log files can use.
* When reached old log files will be removed to make space for new ones.
* Value can range between 25 and 100.
- * @member {number} [fileSystem.retentionInDays] Retention in days.
+ * @property {number} [fileSystem.retentionInDays] Retention in days.
* Remove files older than X days.
* 0 or lower means no retention.
- * @member {boolean} [fileSystem.enabled] True if configuration is enabled,
+ * @property {boolean} [fileSystem.enabled] True if configuration is enabled,
* false if it is disabled and null if configuration is not set.
- * @member {object} [azureBlobStorage] Http logs to azure blob storage
+ * @property {object} [azureBlobStorage] Http logs to azure blob storage
* configuration.
- * @member {string} [azureBlobStorage.sasUrl] SAS url to a azure blob
+ * @property {string} [azureBlobStorage.sasUrl] SAS url to a azure blob
* container with read/write/list/delete permissions.
- * @member {number} [azureBlobStorage.retentionInDays] Retention in days.
+ * @property {number} [azureBlobStorage.retentionInDays] Retention in days.
* Remove blobs older than X days.
* 0 or lower means no retention.
- * @member {boolean} [azureBlobStorage.enabled] True if configuration is
+ * @property {boolean} [azureBlobStorage.enabled] True if configuration is
* enabled, false if it is disabled and null if configuration is not set.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/hybridConnection.js b/lib/services/websiteManagement2/lib/models/hybridConnection.js
index 8c40a4b549..7837d7e52a 100644
--- a/lib/services/websiteManagement2/lib/models/hybridConnection.js
+++ b/lib/services/websiteManagement2/lib/models/hybridConnection.js
@@ -20,18 +20,19 @@ const models = require('./index');
class HybridConnection extends models['ProxyOnlyResource'] {
/**
* Create a HybridConnection.
- * @member {string} [serviceBusNamespace] The name of the Service Bus
+ * @property {string} [serviceBusNamespace] The name of the Service Bus
* namespace.
- * @member {string} [relayName] The name of the Service Bus relay.
- * @member {string} [relayArmUri] The ARM URI to the Service Bus relay.
- * @member {string} [hostname] The hostname of the endpoint.
- * @member {number} [port] The port of the endpoint.
- * @member {string} [sendKeyName] The name of the Service Bus key which has
+ * @property {string} [relayName] The name of the Service Bus relay.
+ * @property {string} [relayArmUri] The ARM URI to the Service Bus relay.
+ * @property {string} [hostname] The hostname of the endpoint.
+ * @property {number} [port] The port of the endpoint.
+ * @property {string} [sendKeyName] The name of the Service Bus key which has
* Send permissions. This is used to authenticate to Service Bus.
- * @member {string} [sendKeyValue] The value of the Service Bus key. This is
- * used to authenticate to Service Bus. In ARM this key will not be returned
+ * @property {string} [sendKeyValue] The value of the Service Bus key. This
+ * is used to authenticate to Service Bus. In ARM this key will not be
+ * returned
* normally, use the POST /listKeys API instead.
- * @member {string} [serviceBusSuffix] The suffix for the service bus
+ * @property {string} [serviceBusSuffix] The suffix for the service bus
* endpoint. By default this is .servicebus.windows.net
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/hybridConnectionCollection.js b/lib/services/websiteManagement2/lib/models/hybridConnectionCollection.js
index ae824224f0..74d4737091 100644
--- a/lib/services/websiteManagement2/lib/models/hybridConnectionCollection.js
+++ b/lib/services/websiteManagement2/lib/models/hybridConnectionCollection.js
@@ -16,7 +16,7 @@
class HybridConnectionCollection extends Array {
/**
* Create a HybridConnectionCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/hybridConnectionKey.js b/lib/services/websiteManagement2/lib/models/hybridConnectionKey.js
index 1f4ee6efc7..da1176e7a1 100644
--- a/lib/services/websiteManagement2/lib/models/hybridConnectionKey.js
+++ b/lib/services/websiteManagement2/lib/models/hybridConnectionKey.js
@@ -21,8 +21,8 @@ const models = require('./index');
class HybridConnectionKey extends models['ProxyOnlyResource'] {
/**
* Create a HybridConnectionKey.
- * @member {string} [sendKeyName] The name of the send key.
- * @member {string} [sendKeyValue] The value of the send key.
+ * @property {string} [sendKeyName] The name of the send key.
+ * @property {string} [sendKeyValue] The value of the send key.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/hybridConnectionLimits.js b/lib/services/websiteManagement2/lib/models/hybridConnectionLimits.js
index dcae3a5dc1..3d28c2082d 100644
--- a/lib/services/websiteManagement2/lib/models/hybridConnectionLimits.js
+++ b/lib/services/websiteManagement2/lib/models/hybridConnectionLimits.js
@@ -21,8 +21,8 @@ const models = require('./index');
class HybridConnectionLimits extends models['ProxyOnlyResource'] {
/**
* Create a HybridConnectionLimits.
- * @member {number} [current] The current number of Hybrid Connections.
- * @member {number} [maximum] The maximum number of Hybrid Connections
+ * @property {number} [current] The current number of Hybrid Connections.
+ * @property {number} [maximum] The maximum number of Hybrid Connections
* allowed.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/identifier.js b/lib/services/websiteManagement2/lib/models/identifier.js
index 6f2bbdd90e..0971b5a15b 100644
--- a/lib/services/websiteManagement2/lib/models/identifier.js
+++ b/lib/services/websiteManagement2/lib/models/identifier.js
@@ -20,7 +20,7 @@ const models = require('./index');
class Identifier extends models['ProxyOnlyResource'] {
/**
* Create a Identifier.
- * @member {string} [identifierId] String representation of the identity.
+ * @property {string} [identifierId] String representation of the identity.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/identifierCollection.js b/lib/services/websiteManagement2/lib/models/identifierCollection.js
index 849810dc14..067ea0b16d 100644
--- a/lib/services/websiteManagement2/lib/models/identifierCollection.js
+++ b/lib/services/websiteManagement2/lib/models/identifierCollection.js
@@ -16,7 +16,7 @@
class IdentifierCollection extends Array {
/**
* Create a IdentifierCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/index.d.ts b/lib/services/websiteManagement2/lib/models/index.d.ts
index 9728f841cf..4520423946 100644
--- a/lib/services/websiteManagement2/lib/models/index.d.ts
+++ b/lib/services/websiteManagement2/lib/models/index.d.ts
@@ -1,1969 +1,1884 @@
/*
* 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 AppServiceCertificate class.
- * @constructor
* Key Vault container for a certificate that is purchased through Azure.
- *
- * @member {string} [keyVaultId] Key Vault resource Id.
- * @member {string} [keyVaultSecretName] Key Vault secret name.
- * @member {string} [provisioningState] Status of the Key Vault secret.
- * Possible values include: 'Initialized', 'WaitingOnCertificateOrder',
- * 'Succeeded', 'CertificateOrderFailed', 'OperationNotPermittedOnKeyVault',
- * 'AzureServiceUnauthorizedToAccessKeyVault', 'KeyVaultDoesNotExist',
- * 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey',
- * 'Unknown'
*/
export interface AppServiceCertificate {
+ /**
+ * Key Vault resource Id.
+ */
keyVaultId?: string;
+ /**
+ * Key Vault secret name.
+ */
keyVaultSecretName?: string;
+ /**
+ * Status of the Key Vault secret. Possible values include: 'Initialized',
+ * 'WaitingOnCertificateOrder', 'Succeeded', 'CertificateOrderFailed',
+ * 'OperationNotPermittedOnKeyVault', 'AzureServiceUnauthorizedToAccessKeyVault',
+ * 'KeyVaultDoesNotExist', 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey',
+ * 'Unknown'
+ */
readonly provisioningState?: string;
}
/**
- * @class
- * Initializes a new instance of the Resource class.
- * @constructor
* Azure resource. This resource is tracked in Azure Resource Manager
- *
- * @member {string} [id] Resource Id.
- * @member {string} [name] Resource Name.
- * @member {string} [kind] Kind of resource.
- * @member {string} location Resource Location.
- * @member {string} [type] Resource type.
- * @member {object} [tags] Resource tags.
*/
export interface Resource extends BaseResource {
+ /**
+ * Resource Id.
+ */
readonly id?: string;
+ /**
+ * Resource Name.
+ */
readonly name?: string;
+ /**
+ * Kind of resource.
+ */
kind?: string;
+ /**
+ * Resource Location.
+ */
location: string;
+ /**
+ * Resource type.
+ */
readonly type?: string;
+ /**
+ * Resource tags.
+ */
tags?: { [propertyName: string]: string };
}
/**
- * @class
- * Initializes a new instance of the AppServiceCertificateResource class.
- * @constructor
- * Key Vault container ARM resource for a certificate that is purchased through
- * Azure.
- *
- * @member {string} [keyVaultId] Key Vault resource Id.
- * @member {string} [keyVaultSecretName] Key Vault secret name.
- * @member {string} [provisioningState] Status of the Key Vault secret.
- * Possible values include: 'Initialized', 'WaitingOnCertificateOrder',
- * 'Succeeded', 'CertificateOrderFailed', 'OperationNotPermittedOnKeyVault',
- * 'AzureServiceUnauthorizedToAccessKeyVault', 'KeyVaultDoesNotExist',
- * 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey',
- * 'Unknown'
+ * Key Vault container ARM resource for a certificate that is purchased through Azure.
*/
export interface AppServiceCertificateResource extends Resource {
+ /**
+ * Key Vault resource Id.
+ */
keyVaultId?: string;
+ /**
+ * Key Vault secret name.
+ */
keyVaultSecretName?: string;
+ /**
+ * Status of the Key Vault secret. Possible values include: 'Initialized',
+ * 'WaitingOnCertificateOrder', 'Succeeded', 'CertificateOrderFailed',
+ * 'OperationNotPermittedOnKeyVault', 'AzureServiceUnauthorizedToAccessKeyVault',
+ * 'KeyVaultDoesNotExist', 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey',
+ * 'Unknown'
+ */
readonly provisioningState?: string;
}
/**
- * @class
- * Initializes a new instance of the CertificateDetails class.
- * @constructor
* SSL certificate details.
- *
- * @member {number} [version] Certificate Version.
- * @member {string} [serialNumber] Certificate Serial Number.
- * @member {string} [thumbprint] Certificate Thumbprint.
- * @member {string} [subject] Certificate Subject.
- * @member {date} [notBefore] Date Certificate is valid from.
- * @member {date} [notAfter] Date Certificate is valid to.
- * @member {string} [signatureAlgorithm] Certificate Signature algorithm.
- * @member {string} [issuer] Certificate Issuer.
- * @member {string} [rawData] Raw certificate data.
*/
export interface CertificateDetails {
+ /**
+ * Certificate Version.
+ */
readonly version?: number;
+ /**
+ * Certificate Serial Number.
+ */
readonly serialNumber?: string;
+ /**
+ * Certificate Thumbprint.
+ */
readonly thumbprint?: string;
+ /**
+ * Certificate Subject.
+ */
readonly subject?: string;
+ /**
+ * Date Certificate is valid from.
+ */
readonly notBefore?: Date;
+ /**
+ * Date Certificate is valid to.
+ */
readonly notAfter?: Date;
+ /**
+ * Certificate Signature algorithm.
+ */
readonly signatureAlgorithm?: string;
+ /**
+ * Certificate Issuer.
+ */
readonly issuer?: string;
+ /**
+ * Raw certificate data.
+ */
readonly rawData?: string;
}
/**
- * @class
- * Initializes a new instance of the AppServiceCertificateOrder class.
- * @constructor
* SSL certificate purchase order.
- *
- * @member {object} [certificates] State of the Key Vault secret.
- * @member {string} [distinguishedName] Certificate distinguished name.
- * @member {string} [domainVerificationToken] Domain verification token.
- * @member {number} [validityInYears] Duration in years (must be between 1 and
- * 3). Default value: 1 .
- * @member {number} [keySize] Certificate key size. Default value: 2048 .
- * @member {string} productType Certificate product type. Possible values
- * include: 'StandardDomainValidatedSsl', 'StandardDomainValidatedWildCardSsl'
- * @member {boolean} [autoRenew] true if the certificate should be
- * automatically renewed when it expires; otherwise, false.
- * Default value: true .
- * @member {string} [provisioningState] Status of certificate order. Possible
- * values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting'
- * @member {string} [status] Current order status. Possible values include:
- * 'Pendingissuance', 'Issued', 'Revoked', 'Canceled', 'Denied',
- * 'Pendingrevocation', 'PendingRekey', 'Unused', 'Expired', 'NotSubmitted'
- * @member {object} [signedCertificate] Signed certificate.
- * @member {number} [signedCertificate.version] Certificate Version.
- * @member {string} [signedCertificate.serialNumber] Certificate Serial Number.
- * @member {string} [signedCertificate.thumbprint] Certificate Thumbprint.
- * @member {string} [signedCertificate.subject] Certificate Subject.
- * @member {date} [signedCertificate.notBefore] Date Certificate is valid from.
- * @member {date} [signedCertificate.notAfter] Date Certificate is valid to.
- * @member {string} [signedCertificate.signatureAlgorithm] Certificate
- * Signature algorithm.
- * @member {string} [signedCertificate.issuer] Certificate Issuer.
- * @member {string} [signedCertificate.rawData] Raw certificate data.
- * @member {string} [csr] Last CSR that was created for this order.
- * @member {object} [intermediate] Intermediate certificate.
- * @member {number} [intermediate.version] Certificate Version.
- * @member {string} [intermediate.serialNumber] Certificate Serial Number.
- * @member {string} [intermediate.thumbprint] Certificate Thumbprint.
- * @member {string} [intermediate.subject] Certificate Subject.
- * @member {date} [intermediate.notBefore] Date Certificate is valid from.
- * @member {date} [intermediate.notAfter] Date Certificate is valid to.
- * @member {string} [intermediate.signatureAlgorithm] Certificate Signature
- * algorithm.
- * @member {string} [intermediate.issuer] Certificate Issuer.
- * @member {string} [intermediate.rawData] Raw certificate data.
- * @member {object} [root] Root certificate.
- * @member {number} [root.version] Certificate Version.
- * @member {string} [root.serialNumber] Certificate Serial Number.
- * @member {string} [root.thumbprint] Certificate Thumbprint.
- * @member {string} [root.subject] Certificate Subject.
- * @member {date} [root.notBefore] Date Certificate is valid from.
- * @member {date} [root.notAfter] Date Certificate is valid to.
- * @member {string} [root.signatureAlgorithm] Certificate Signature algorithm.
- * @member {string} [root.issuer] Certificate Issuer.
- * @member {string} [root.rawData] Raw certificate data.
- * @member {string} [serialNumber] Current serial number of the certificate.
- * @member {date} [lastCertificateIssuanceTime] Certificate last issuance time.
- * @member {date} [expirationTime] Certificate expiration time.
- * @member {boolean} [isPrivateKeyExternal] true if private key is
- * external; otherwise, false.
- * @member {array} [appServiceCertificateNotRenewableReasons] Reasons why App
- * Service Certificate is not renewable at the current moment.
- * @member {date} [nextAutoRenewalTimeStamp] Time stamp when the certificate
- * would be auto renewed next
*/
export interface AppServiceCertificateOrder extends Resource {
+ /**
+ * State of the Key Vault secret.
+ */
certificates?: { [propertyName: string]: AppServiceCertificate };
+ /**
+ * Certificate distinguished name.
+ */
distinguishedName?: string;
+ /**
+ * Domain verification token.
+ */
readonly domainVerificationToken?: string;
+ /**
+ * Duration in years (must be between 1 and 3).
+ */
validityInYears?: number;
+ /**
+ * Certificate key size.
+ */
keySize?: number;
+ /**
+ * Certificate product type. Possible values include: 'StandardDomainValidatedSsl',
+ * 'StandardDomainValidatedWildCardSsl'
+ */
productType: string;
+ /**
+ * true if the certificate should be automatically renewed when it expires;
+ * otherwise, false.
+ */
autoRenew?: boolean;
+ /**
+ * Status of certificate order. Possible values include: 'Succeeded', 'Failed', 'Canceled',
+ * 'InProgress', 'Deleting'
+ */
readonly provisioningState?: string;
+ /**
+ * Current order status. Possible values include: 'Pendingissuance', 'Issued', 'Revoked',
+ * 'Canceled', 'Denied', 'Pendingrevocation', 'PendingRekey', 'Unused', 'Expired', 'NotSubmitted'
+ */
readonly status?: string;
+ /**
+ * Signed certificate.
+ */
readonly signedCertificate?: CertificateDetails;
+ /**
+ * Last CSR that was created for this order.
+ */
csr?: string;
+ /**
+ * Intermediate certificate.
+ */
readonly intermediate?: CertificateDetails;
+ /**
+ * Root certificate.
+ */
readonly root?: CertificateDetails;
+ /**
+ * Current serial number of the certificate.
+ */
readonly serialNumber?: string;
+ /**
+ * Certificate last issuance time.
+ */
readonly lastCertificateIssuanceTime?: Date;
+ /**
+ * Certificate expiration time.
+ */
readonly expirationTime?: Date;
+ /**
+ * true if private key is external; otherwise, false.
+ */
readonly isPrivateKeyExternal?: boolean;
+ /**
+ * Reasons why App Service Certificate is not renewable at the current moment.
+ */
readonly appServiceCertificateNotRenewableReasons?: string[];
+ /**
+ * Time stamp when the certificate would be auto renewed next
+ */
readonly nextAutoRenewalTimeStamp?: Date;
}
/**
- * @class
- * Initializes a new instance of the ProxyOnlyResource class.
- * @constructor
- * Azure proxy only resource. This resource is not tracked by Azure Resource
- * Manager.
- *
- * @member {string} [id] Resource Id.
- * @member {string} [name] Resource Name.
- * @member {string} [kind] Kind of resource.
- * @member {string} [type] Resource type.
+ * Azure proxy only resource. This resource is not tracked by Azure Resource Manager.
*/
export interface ProxyOnlyResource extends BaseResource {
+ /**
+ * Resource Id.
+ */
readonly id?: string;
+ /**
+ * Resource Name.
+ */
readonly name?: string;
+ /**
+ * Kind of resource.
+ */
kind?: string;
+ /**
+ * Resource type.
+ */
readonly type?: string;
}
/**
- * @class
- * Initializes a new instance of the AppServiceCertificateOrderPatchResource class.
- * @constructor
* ARM resource for a certificate order that is purchased through Azure.
- *
- * @member {object} [certificates] State of the Key Vault secret.
- * @member {string} [distinguishedName] Certificate distinguished name.
- * @member {string} [domainVerificationToken] Domain verification token.
- * @member {number} [validityInYears] Duration in years (must be between 1 and
- * 3). Default value: 1 .
- * @member {number} [keySize] Certificate key size. Default value: 2048 .
- * @member {string} productType Certificate product type. Possible values
- * include: 'StandardDomainValidatedSsl', 'StandardDomainValidatedWildCardSsl'
- * @member {boolean} [autoRenew] true if the certificate should be
- * automatically renewed when it expires; otherwise, false.
- * Default value: true .
- * @member {string} [provisioningState] Status of certificate order. Possible
- * values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting'
- * @member {string} [status] Current order status. Possible values include:
- * 'Pendingissuance', 'Issued', 'Revoked', 'Canceled', 'Denied',
- * 'Pendingrevocation', 'PendingRekey', 'Unused', 'Expired', 'NotSubmitted'
- * @member {object} [signedCertificate] Signed certificate.
- * @member {number} [signedCertificate.version] Certificate Version.
- * @member {string} [signedCertificate.serialNumber] Certificate Serial Number.
- * @member {string} [signedCertificate.thumbprint] Certificate Thumbprint.
- * @member {string} [signedCertificate.subject] Certificate Subject.
- * @member {date} [signedCertificate.notBefore] Date Certificate is valid from.
- * @member {date} [signedCertificate.notAfter] Date Certificate is valid to.
- * @member {string} [signedCertificate.signatureAlgorithm] Certificate
- * Signature algorithm.
- * @member {string} [signedCertificate.issuer] Certificate Issuer.
- * @member {string} [signedCertificate.rawData] Raw certificate data.
- * @member {string} [csr] Last CSR that was created for this order.
- * @member {object} [intermediate] Intermediate certificate.
- * @member {number} [intermediate.version] Certificate Version.
- * @member {string} [intermediate.serialNumber] Certificate Serial Number.
- * @member {string} [intermediate.thumbprint] Certificate Thumbprint.
- * @member {string} [intermediate.subject] Certificate Subject.
- * @member {date} [intermediate.notBefore] Date Certificate is valid from.
- * @member {date} [intermediate.notAfter] Date Certificate is valid to.
- * @member {string} [intermediate.signatureAlgorithm] Certificate Signature
- * algorithm.
- * @member {string} [intermediate.issuer] Certificate Issuer.
- * @member {string} [intermediate.rawData] Raw certificate data.
- * @member {object} [root] Root certificate.
- * @member {number} [root.version] Certificate Version.
- * @member {string} [root.serialNumber] Certificate Serial Number.
- * @member {string} [root.thumbprint] Certificate Thumbprint.
- * @member {string} [root.subject] Certificate Subject.
- * @member {date} [root.notBefore] Date Certificate is valid from.
- * @member {date} [root.notAfter] Date Certificate is valid to.
- * @member {string} [root.signatureAlgorithm] Certificate Signature algorithm.
- * @member {string} [root.issuer] Certificate Issuer.
- * @member {string} [root.rawData] Raw certificate data.
- * @member {string} [serialNumber] Current serial number of the certificate.
- * @member {date} [lastCertificateIssuanceTime] Certificate last issuance time.
- * @member {date} [expirationTime] Certificate expiration time.
- * @member {boolean} [isPrivateKeyExternal] true if private key is
- * external; otherwise, false.
- * @member {array} [appServiceCertificateNotRenewableReasons] Reasons why App
- * Service Certificate is not renewable at the current moment.
- * @member {date} [nextAutoRenewalTimeStamp] Time stamp when the certificate
- * would be auto renewed next
*/
export interface AppServiceCertificateOrderPatchResource extends ProxyOnlyResource {
+ /**
+ * State of the Key Vault secret.
+ */
certificates?: { [propertyName: string]: AppServiceCertificate };
+ /**
+ * Certificate distinguished name.
+ */
distinguishedName?: string;
+ /**
+ * Domain verification token.
+ */
readonly domainVerificationToken?: string;
+ /**
+ * Duration in years (must be between 1 and 3).
+ */
validityInYears?: number;
+ /**
+ * Certificate key size.
+ */
keySize?: number;
+ /**
+ * Certificate product type. Possible values include: 'StandardDomainValidatedSsl',
+ * 'StandardDomainValidatedWildCardSsl'
+ */
productType: string;
+ /**
+ * true if the certificate should be automatically renewed when it expires;
+ * otherwise, false.
+ */
autoRenew?: boolean;
+ /**
+ * Status of certificate order. Possible values include: 'Succeeded', 'Failed', 'Canceled',
+ * 'InProgress', 'Deleting'
+ */
readonly provisioningState?: string;
+ /**
+ * Current order status. Possible values include: 'Pendingissuance', 'Issued', 'Revoked',
+ * 'Canceled', 'Denied', 'Pendingrevocation', 'PendingRekey', 'Unused', 'Expired', 'NotSubmitted'
+ */
readonly status?: string;
+ /**
+ * Signed certificate.
+ */
readonly signedCertificate?: CertificateDetails;
+ /**
+ * Last CSR that was created for this order.
+ */
csr?: string;
+ /**
+ * Intermediate certificate.
+ */
readonly intermediate?: CertificateDetails;
+ /**
+ * Root certificate.
+ */
readonly root?: CertificateDetails;
+ /**
+ * Current serial number of the certificate.
+ */
readonly serialNumber?: string;
+ /**
+ * Certificate last issuance time.
+ */
readonly lastCertificateIssuanceTime?: Date;
+ /**
+ * Certificate expiration time.
+ */
readonly expirationTime?: Date;
+ /**
+ * true if private key is external; otherwise, false.
+ */
readonly isPrivateKeyExternal?: boolean;
+ /**
+ * Reasons why App Service Certificate is not renewable at the current moment.
+ */
readonly appServiceCertificateNotRenewableReasons?: string[];
+ /**
+ * Time stamp when the certificate would be auto renewed next
+ */
readonly nextAutoRenewalTimeStamp?: Date;
}
/**
- * @class
- * Initializes a new instance of the AppServiceCertificatePatchResource class.
- * @constructor
- * Key Vault container ARM resource for a certificate that is purchased through
- * Azure.
- *
- * @member {string} [keyVaultId] Key Vault resource Id.
- * @member {string} [keyVaultSecretName] Key Vault secret name.
- * @member {string} [provisioningState] Status of the Key Vault secret.
- * Possible values include: 'Initialized', 'WaitingOnCertificateOrder',
- * 'Succeeded', 'CertificateOrderFailed', 'OperationNotPermittedOnKeyVault',
- * 'AzureServiceUnauthorizedToAccessKeyVault', 'KeyVaultDoesNotExist',
- * 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey',
- * 'Unknown'
+ * Key Vault container ARM resource for a certificate that is purchased through Azure.
*/
export interface AppServiceCertificatePatchResource extends ProxyOnlyResource {
+ /**
+ * Key Vault resource Id.
+ */
keyVaultId?: string;
+ /**
+ * Key Vault secret name.
+ */
keyVaultSecretName?: string;
+ /**
+ * Status of the Key Vault secret. Possible values include: 'Initialized',
+ * 'WaitingOnCertificateOrder', 'Succeeded', 'CertificateOrderFailed',
+ * 'OperationNotPermittedOnKeyVault', 'AzureServiceUnauthorizedToAccessKeyVault',
+ * 'KeyVaultDoesNotExist', 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey',
+ * 'Unknown'
+ */
readonly provisioningState?: string;
}
/**
- * @class
- * Initializes a new instance of the CertificateEmail class.
- * @constructor
* SSL certificate email.
- *
- * @member {string} [emailId] Email id.
- * @member {date} [timeStamp] Time stamp.
*/
export interface CertificateEmail extends ProxyOnlyResource {
+ /**
+ * Email id.
+ */
emailId?: string;
+ /**
+ * Time stamp.
+ */
timeStamp?: Date;
}
/**
- * @class
- * Initializes a new instance of the CertificateOrderAction class.
- * @constructor
* Certificate order action.
- *
- * @member {string} [actionType] Action type. Possible values include:
- * 'CertificateIssued', 'CertificateOrderCanceled', 'CertificateOrderCreated',
- * 'CertificateRevoked', 'DomainValidationComplete', 'FraudDetected',
- * 'OrgNameChange', 'OrgValidationComplete', 'SanDrop', 'FraudCleared',
- * 'CertificateExpired', 'CertificateExpirationWarning',
- * 'FraudDocumentationRequired', 'Unknown'
- * @member {date} [createdAt] Time at which the certificate action was
- * performed.
*/
export interface CertificateOrderAction extends ProxyOnlyResource {
+ /**
+ * Action type. Possible values include: 'CertificateIssued', 'CertificateOrderCanceled',
+ * 'CertificateOrderCreated', 'CertificateRevoked', 'DomainValidationComplete', 'FraudDetected',
+ * 'OrgNameChange', 'OrgValidationComplete', 'SanDrop', 'FraudCleared', 'CertificateExpired',
+ * 'CertificateExpirationWarning', 'FraudDocumentationRequired', 'Unknown'
+ */
readonly actionType?: string;
+ /**
+ * Time at which the certificate action was performed.
+ */
readonly createdAt?: Date;
}
/**
- * @class
- * Initializes a new instance of the ReissueCertificateOrderRequest class.
- * @constructor
* Class representing certificate reissue request.
- *
- * @member {number} [keySize] Certificate Key Size.
- * @member {number} [delayExistingRevokeInHours] Delay in hours to revoke
- * existing certificate after the new certificate is issued.
- * @member {string} [csr] Csr to be used for re-key operation.
- * @member {boolean} [isPrivateKeyExternal] Should we change the ASC type (from
- * managed private key to external private key and vice versa).
*/
export interface ReissueCertificateOrderRequest extends ProxyOnlyResource {
+ /**
+ * Certificate Key Size.
+ */
keySize?: number;
+ /**
+ * Delay in hours to revoke existing certificate after the new certificate is issued.
+ */
delayExistingRevokeInHours?: number;
+ /**
+ * Csr to be used for re-key operation.
+ */
csr?: string;
+ /**
+ * Should we change the ASC type (from managed private key to external private key and vice
+ * versa).
+ */
isPrivateKeyExternal?: boolean;
}
/**
- * @class
- * Initializes a new instance of the RenewCertificateOrderRequest class.
- * @constructor
* Class representing certificate renew request.
- *
- * @member {number} [keySize] Certificate Key Size.
- * @member {string} [csr] Csr to be used for re-key operation.
- * @member {boolean} [isPrivateKeyExternal] Should we change the ASC type (from
- * managed private key to external private key and vice versa).
*/
export interface RenewCertificateOrderRequest extends ProxyOnlyResource {
+ /**
+ * Certificate Key Size.
+ */
keySize?: number;
+ /**
+ * Csr to be used for re-key operation.
+ */
csr?: string;
+ /**
+ * Should we change the ASC type (from managed private key to external private key and vice
+ * versa).
+ */
isPrivateKeyExternal?: boolean;
}
/**
- * @class
- * Initializes a new instance of the SiteSeal class.
- * @constructor
* Site seal
- *
- * @member {string} html HTML snippet
*/
export interface SiteSeal {
+ /**
+ * HTML snippet
+ */
html: string;
}
/**
- * @class
- * Initializes a new instance of the SiteSealRequest class.
- * @constructor
* Site seal request.
- *
- * @member {boolean} [lightTheme] If true use the light color
- * theme for site seal; otherwise, use the default color theme.
- * @member {string} [locale] Locale of site seal.
*/
export interface SiteSealRequest {
+ /**
+ * If true use the light color theme for site seal; otherwise, use the default color
+ * theme.
+ */
lightTheme?: boolean;
+ /**
+ * Locale of site seal.
+ */
locale?: string;
}
/**
- * @class
- * Initializes a new instance of the VnetRoute class.
- * @constructor
- * Virtual Network route contract used to pass routing information for a
- * Virtual Network.
- *
- * @member {string} [startAddress] The starting address for this route. This
- * may also include a CIDR notation, in which case the end address must not be
- * specified.
- * @member {string} [endAddress] The ending address for this route. If the
- * start address is specified in CIDR notation, this must be omitted.
- * @member {string} [routeType] The type of route this is:
- * DEFAULT - By default, every app has routes to the local address ranges
- * specified by RFC1918
- * INHERITED - Routes inherited from the real Virtual Network routes
- * STATIC - Static route set on the app only
- *
- * These values will be used for syncing an app's routes with those from a
- * Virtual Network. Possible values include: 'DEFAULT', 'INHERITED', 'STATIC'
+ * Virtual Network route contract used to pass routing information for a Virtual Network.
*/
export interface VnetRoute extends ProxyOnlyResource {
+ /**
+ * The starting address for this route. This may also include a CIDR notation, in which case the
+ * end address must not be specified.
+ */
startAddress?: string;
+ /**
+ * The ending address for this route. If the start address is specified in CIDR notation, this
+ * must be omitted.
+ */
endAddress?: string;
+ /**
+ * The type of route this is:
+ * DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918
+ * INHERITED - Routes inherited from the real Virtual Network routes
+ * STATIC - Static route set on the app only
+ *
+ * These values will be used for syncing an app's routes with those from a Virtual Network.
+ * Possible values include: 'DEFAULT', 'INHERITED', 'STATIC'
+ */
routeType?: string;
}
/**
- * @class
- * Initializes a new instance of the VnetInfo class.
- * @constructor
* Virtual Network information contract.
- *
- * @member {string} [vnetResourceId] The Virtual Network's resource ID.
- * @member {string} [certThumbprint] The client certificate thumbprint.
- * @member {buffer} [certBlob] A certificate file (.cer) blob containing the
- * public key of the private key used to authenticate a
- * Point-To-Site VPN connection.
- * @member {array} [routes] The routes that this Virtual Network connection
- * uses.
- * @member {boolean} [resyncRequired] true if a resync is
- * required; otherwise, false.
- * @member {string} [dnsServers] DNS servers to be used by this Virtual
- * Network. This should be a comma-separated list of IP addresses.
*/
export interface VnetInfo extends ProxyOnlyResource {
+ /**
+ * The Virtual Network's resource ID.
+ */
vnetResourceId?: string;
+ /**
+ * The client certificate thumbprint.
+ */
readonly certThumbprint?: string;
+ /**
+ * A certificate file (.cer) blob containing the public key of the private key used to
+ * authenticate a
+ * Point-To-Site VPN connection.
+ */
certBlob?: Buffer;
+ /**
+ * The routes that this Virtual Network connection uses.
+ */
readonly routes?: VnetRoute[];
+ /**
+ * true if a resync is required; otherwise, false.
+ */
readonly resyncRequired?: boolean;
+ /**
+ * DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP
+ * addresses.
+ */
dnsServers?: string;
}
/**
- * @class
- * Initializes a new instance of the VnetGateway class.
- * @constructor
- * The Virtual Network gateway contract. This is used to give the Virtual
- * Network gateway access to the VPN package.
- *
- * @member {string} [vnetName] The Virtual Network name.
- * @member {string} vpnPackageUri The URI where the VPN package can be
- * downloaded.
+ * The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to
+ * the VPN package.
*/
export interface VnetGateway extends ProxyOnlyResource {
+ /**
+ * The Virtual Network name.
+ */
vnetName?: string;
+ /**
+ * The URI where the VPN package can be downloaded.
+ */
vpnPackageUri: string;
}
/**
- * @class
- * Initializes a new instance of the User class.
- * @constructor
- * User crendentials used for publishing activity.
- *
- * @member {string} publishingUserName Username used for publishing.
- * @member {string} [publishingPassword] Password used for publishing.
- * @member {string} [publishingPasswordHash] Password hash used for publishing.
- * @member {string} [publishingPasswordHashSalt] Password hash salt used for
- * publishing.
- * @member {string} [scmUri] Url of SCM site.
+ * User credentials used for publishing activity.
*/
export interface User extends ProxyOnlyResource {
+ /**
+ * Username used for publishing.
+ */
publishingUserName: string;
+ /**
+ * Password used for publishing.
+ */
publishingPassword?: string;
+ /**
+ * Password hash used for publishing.
+ */
publishingPasswordHash?: string;
+ /**
+ * Password hash salt used for publishing.
+ */
publishingPasswordHashSalt?: string;
+ /**
+ * Url of SCM site.
+ */
scmUri?: string;
}
/**
- * @class
- * Initializes a new instance of the Snapshot class.
- * @constructor
* A snapshot of an app.
- *
- * @member {string} [time] The time the snapshot was taken.
*/
export interface Snapshot extends ProxyOnlyResource {
+ /**
+ * The time the snapshot was taken.
+ */
readonly time?: string;
}
/**
- * @class
- * Initializes a new instance of the ResourceMetricAvailability class.
- * @constructor
* Metrics availability and retention.
- *
- * @member {string} [timeGrain] Time grain .
- * @member {string} [retention] Retention period for the current time grain.
*/
export interface ResourceMetricAvailability {
+ /**
+ * Time grain .
+ */
readonly timeGrain?: string;
+ /**
+ * Retention period for the current time grain.
+ */
readonly retention?: string;
}
/**
- * @class
- * Initializes a new instance of the ResourceMetricDefinition class.
- * @constructor
* Metadata for the metrics.
- *
- * @member {string} [unit] Unit of the metric.
- * @member {string} [primaryAggregationType] Primary aggregation type.
- * @member {array} [metricAvailabilities] List of time grains supported for the
- * metric together with retention period.
- * @member {string} [resourceUri] Resource URI.
- * @member {object} [properties] Resource metric definition properties.
*/
export interface ResourceMetricDefinition extends ProxyOnlyResource {
+ /**
+ * Unit of the metric.
+ */
readonly unit?: string;
+ /**
+ * Primary aggregation type.
+ */
readonly primaryAggregationType?: string;
+ /**
+ * List of time grains supported for the metric together with retention period.
+ */
readonly metricAvailabilities?: ResourceMetricAvailability[];
+ /**
+ * Resource URI.
+ */
readonly resourceUri?: string;
+ /**
+ * Resource metric definition properties.
+ */
readonly properties?: { [propertyName: string]: string };
}
/**
- * @class
- * Initializes a new instance of the PushSettings class.
- * @constructor
* Push settings for the App.
- *
- * @member {boolean} isPushEnabled Gets or sets a flag indicating whether the
- * Push endpoint is enabled.
- * @member {string} [tagWhitelistJson] Gets or sets a JSON string containing a
- * list of tags that are whitelisted for use by the push registration endpoint.
- * @member {string} [tagsRequiringAuth] Gets or sets a JSON string containing a
- * list of tags that require user authentication to be used in the push
- * registration endpoint.
- * Tags can consist of alphanumeric characters and the following:
- * '_', '@', '#', '.', ':', '-'.
- * Validation should be performed at the PushRequestHandler.
- * @member {string} [dynamicTagsJson] Gets or sets a JSON string containing a
- * list of dynamic tags that will be evaluated from user claims in the push
- * registration endpoint.
*/
export interface PushSettings extends ProxyOnlyResource {
+ /**
+ * Gets or sets a flag indicating whether the Push endpoint is enabled.
+ */
isPushEnabled: boolean;
+ /**
+ * Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push
+ * registration endpoint.
+ */
tagWhitelistJson?: string;
+ /**
+ * Gets or sets a JSON string containing a list of tags that require user authentication to be
+ * used in the push registration endpoint.
+ * Tags can consist of alphanumeric characters and the following:
+ * '_', '@', '#', '.', ':', '-'.
+ * Validation should be performed at the PushRequestHandler.
+ */
tagsRequiringAuth?: string;
+ /**
+ * Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user
+ * claims in the push registration endpoint.
+ */
dynamicTagsJson?: string;
}
/**
- * @class
- * Initializes a new instance of the Identifier class.
- * @constructor
* A domain specific resource identifier.
- *
- * @member {string} [identifierId] String representation of the identity.
*/
export interface Identifier extends ProxyOnlyResource {
+ /**
+ * String representation of the identity.
+ */
identifierId?: string;
}
/**
- * @class
- * Initializes a new instance of the HybridConnectionKey class.
- * @constructor
- * Hybrid Connection key contract. This has the send key name and value for a
- * Hybrid Connection.
- *
- * @member {string} [sendKeyName] The name of the send key.
- * @member {string} [sendKeyValue] The value of the send key.
+ * Hybrid Connection key contract. This has the send key name and value for a Hybrid Connection.
*/
export interface HybridConnectionKey extends ProxyOnlyResource {
+ /**
+ * The name of the send key.
+ */
readonly sendKeyName?: string;
+ /**
+ * The value of the send key.
+ */
readonly sendKeyValue?: string;
}
/**
- * @class
- * Initializes a new instance of the HybridConnection class.
- * @constructor
* Hybrid Connection contract. This is used to configure a Hybrid Connection.
- *
- * @member {string} [serviceBusNamespace] The name of the Service Bus
- * namespace.
- * @member {string} [relayName] The name of the Service Bus relay.
- * @member {string} [relayArmUri] The ARM URI to the Service Bus relay.
- * @member {string} [hostname] The hostname of the endpoint.
- * @member {number} [port] The port of the endpoint.
- * @member {string} [sendKeyName] The name of the Service Bus key which has
- * Send permissions. This is used to authenticate to Service Bus.
- * @member {string} [sendKeyValue] The value of the Service Bus key. This is
- * used to authenticate to Service Bus. In ARM this key will not be returned
- * normally, use the POST /listKeys API instead.
- * @member {string} [serviceBusSuffix] The suffix for the service bus endpoint.
- * By default this is .servicebus.windows.net
*/
export interface HybridConnection extends ProxyOnlyResource {
+ /**
+ * The name of the Service Bus namespace.
+ */
serviceBusNamespace?: string;
+ /**
+ * The name of the Service Bus relay.
+ */
relayName?: string;
+ /**
+ * The ARM URI to the Service Bus relay.
+ */
relayArmUri?: string;
+ /**
+ * The hostname of the endpoint.
+ */
hostname?: string;
+ /**
+ * The port of the endpoint.
+ */
port?: number;
+ /**
+ * The name of the Service Bus key which has Send permissions. This is used to authenticate to
+ * Service Bus.
+ */
sendKeyName?: string;
+ /**
+ * The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key
+ * will not be returned
+ * normally, use the POST /listKeys API instead.
+ */
sendKeyValue?: string;
+ /**
+ * The suffix for the service bus endpoint. By default this is .servicebus.windows.net
+ */
serviceBusSuffix?: string;
}
/**
- * @class
- * Initializes a new instance of the DeletedSite class.
- * @constructor
* A deleted app.
- *
- * @member {number} [deletedSiteId] Numeric id for the deleted site
- * @member {string} [deletedTimestamp] Time in UTC when the app was deleted.
- * @member {string} [subscription] Subscription containing the deleted site
- * @member {string} [resourceGroup] ResourceGroup that contained the deleted
- * site
- * @member {string} [deletedSiteName] Name of the deleted site
- * @member {string} [slot] Slot of the deleted site
- * @member {string} [deletedSiteKind] Kind of site that was deleted
- * @member {string} [geoRegionName] Geo Region of the deleted site
*/
export interface DeletedSite extends ProxyOnlyResource {
+ /**
+ * Numeric id for the deleted site
+ */
readonly deletedSiteId?: number;
+ /**
+ * Time in UTC when the app was deleted.
+ */
readonly deletedTimestamp?: string;
+ /**
+ * Subscription containing the deleted site
+ */
readonly subscription?: string;
+ /**
+ * ResourceGroup that contained the deleted site
+ */
readonly resourceGroup?: string;
+ /**
+ * Name of the deleted site
+ */
readonly deletedSiteName?: string;
+ /**
+ * Slot of the deleted site
+ */
readonly slot?: string;
+ /**
+ * Kind of site that was deleted
+ */
readonly deletedSiteKind?: string;
+ /**
+ * Geo Region of the deleted site
+ */
readonly geoRegionName?: string;
}
/**
- * @class
- * Initializes a new instance of the ManagedServiceIdentity class.
- * @constructor
* Managed service identity.
- *
- * @member {string} [type] Type of managed service identity. Possible values
- * include: 'SystemAssigned', 'UserAssigned'
- * @member {string} [tenantId] Tenant of managed service identity.
- * @member {string} [principalId] Principal Id of managed service identity.
- * @member {array} [identityIds] Array of UserAssigned managed service
- * identities.
*/
export interface ManagedServiceIdentity {
+ /**
+ * Type of managed service identity. Possible values include: 'SystemAssigned', 'UserAssigned'
+ */
type?: string;
+ /**
+ * Tenant of managed service identity.
+ */
readonly tenantId?: string;
+ /**
+ * Principal Id of managed service identity.
+ */
readonly principalId?: string;
+ /**
+ * Array of UserAssigned managed service identities.
+ */
identityIds?: string[];
}
/**
- * @class
- * Initializes a new instance of the SlotSwapStatus class.
- * @constructor
- * The status of the last successfull slot swap operation.
- *
- * @member {date} [timestampUtc] The time the last successful slot swap
- * completed.
- * @member {string} [sourceSlotName] The source slot of the last swap
- * operation.
- * @member {string} [destinationSlotName] The destination slot of the last swap
- * operation.
+ * The status of the last successful slot swap operation.
*/
export interface SlotSwapStatus {
+ /**
+ * The time the last successful slot swap completed.
+ */
readonly timestampUtc?: Date;
+ /**
+ * The source slot of the last swap operation.
+ */
readonly sourceSlotName?: string;
+ /**
+ * The destination slot of the last swap operation.
+ */
readonly destinationSlotName?: string;
}
/**
- * @class
- * Initializes a new instance of the CloningInfo class.
- * @constructor
* Information needed for cloning operation.
- *
- * @member {uuid} [correlationId] Correlation ID of cloning operation. This ID
- * ties multiple cloning operations
- * together to use the same snapshot.
- * @member {boolean} [overwrite] true to overwrite destination
- * app; otherwise, false.
- * @member {boolean} [cloneCustomHostNames] true to clone custom
- * hostnames from source app; otherwise, false.
- * @member {boolean} [cloneSourceControl] true to clone source
- * control from source app; otherwise, false.
- * @member {string} sourceWebAppId ARM resource ID of the source app. App
- * resource ID is of the form
- * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}
- * for production slots and
- * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName}
- * for other slots.
- * @member {string} [hostingEnvironment] App Service Environment.
- * @member {object} [appSettingsOverrides] Application setting overrides for
- * cloned app. If specified, these settings override the settings cloned
- * from source app. Otherwise, application settings from source app are
- * retained.
- * @member {boolean} [configureLoadBalancing] true to configure
- * load balancing for source and destination app.
- * @member {string} [trafficManagerProfileId] ARM resource ID of the Traffic
- * Manager profile to use, if it exists. Traffic Manager resource ID is of the
- * form
- * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.
- * @member {string} [trafficManagerProfileName] Name of Traffic Manager profile
- * to create. This is only needed if Traffic Manager profile does not already
- * exist.
*/
export interface CloningInfo {
+ /**
+ * Correlation ID of cloning operation. This ID ties multiple cloning operations
+ * together to use the same snapshot.
+ */
correlationId?: string;
+ /**
+ * true to overwrite destination app; otherwise, false.
+ */
overwrite?: boolean;
+ /**
+ * true to clone custom hostnames from source app; otherwise, false.
+ */
cloneCustomHostNames?: boolean;
+ /**
+ * true to clone source control from source app; otherwise, false.
+ */
cloneSourceControl?: boolean;
+ /**
+ * ARM resource ID of the source app. App resource ID is of the form
+ * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}
+ * for production slots and
+ * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName}
+ * for other slots.
+ */
sourceWebAppId: string;
+ /**
+ * App Service Environment.
+ */
hostingEnvironment?: string;
+ /**
+ * Application setting overrides for cloned app. If specified, these settings override the
+ * settings cloned
+ * from source app. Otherwise, application settings from source app are retained.
+ */
appSettingsOverrides?: { [propertyName: string]: string };
+ /**
+ * true to configure load balancing for source and destination app.
+ */
configureLoadBalancing?: boolean;
+ /**
+ * ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource
+ * ID is of the form
+ * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.
+ */
trafficManagerProfileId?: string;
+ /**
+ * Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does
+ * not already exist.
+ */
trafficManagerProfileName?: string;
}
/**
- * @class
- * Initializes a new instance of the HostingEnvironmentProfile class.
- * @constructor
* Specification for an App Service Environment to use for this resource.
- *
- * @member {string} [id] Resource ID of the App Service Environment.
- * @member {string} [name] Name of the App Service Environment.
- * @member {string} [type] Resource type of the App Service Environment.
*/
export interface HostingEnvironmentProfile {
+ /**
+ * Resource ID of the App Service Environment.
+ */
id?: string;
+ /**
+ * Name of the App Service Environment.
+ */
readonly name?: string;
+ /**
+ * Resource type of the App Service Environment.
+ */
readonly type?: string;
}
/**
- * @class
- * Initializes a new instance of the IpSecurityRestriction class.
- * @constructor
* IP security restriction on an app.
- *
- * @member {string} ipAddress IP address the security restriction is valid for.
- * It can be in form of pure ipv4 address (required SubnetMask property) or
- * CIDR notation such as ipv4/mask (leading bit match). For CIDR,
- * SubnetMask property must not be specified.
- * @member {string} [subnetMask] Subnet mask for the range of IP addresses the
- * restriction is valid for.
- * @member {string} [action] Allow or Deny access for this IP range.
- * @member {string} [tag] Defines what this IP filter will be used for. This is
- * to support IP filtering on proxies. Possible values include: 'Default',
- * 'XffProxy'
- * @member {number} [priority] Priority of IP restriction rule.
- * @member {string} [name] IP restriction rule name.
- * @member {string} [description] IP restriction rule description.
*/
export interface IpSecurityRestriction {
+ /**
+ * IP address the security restriction is valid for.
+ * It can be in form of pure ipv4 address (required SubnetMask property) or
+ * CIDR notation such as ipv4/mask (leading bit match). For CIDR,
+ * SubnetMask property must not be specified.
+ */
ipAddress: string;
+ /**
+ * Subnet mask for the range of IP addresses the restriction is valid for.
+ */
subnetMask?: string;
+ /**
+ * Allow or Deny access for this IP range.
+ */
action?: string;
+ /**
+ * Defines what this IP filter will be used for. This is to support IP filtering on proxies.
+ * Possible values include: 'Default', 'XffProxy'
+ */
tag?: string;
+ /**
+ * Priority of IP restriction rule.
+ */
priority?: number;
+ /**
+ * IP restriction rule name.
+ */
name?: string;
+ /**
+ * IP restriction rule description.
+ */
description?: string;
}
/**
- * @class
- * Initializes a new instance of the ApiDefinitionInfo class.
- * @constructor
* Information about the formal API definition for the app.
- *
- * @member {string} [url] The URL of the API definition.
*/
export interface ApiDefinitionInfo {
+ /**
+ * The URL of the API definition.
+ */
url?: string;
}
/**
- * @class
- * Initializes a new instance of the CorsSettings class.
- * @constructor
* Cross-Origin Resource Sharing (CORS) settings for the app.
- *
- * @member {array} [allowedOrigins] Gets or sets the list of origins that
- * should be allowed to make cross-origin
- * calls (for example: http://example.com:12345). Use "*" to allow all.
*/
export interface CorsSettings {
+ /**
+ * Gets or sets the list of origins that should be allowed to make cross-origin
+ * calls (for example: http://example.com:12345). Use "*" to allow all.
+ */
allowedOrigins?: string[];
}
/**
- * @class
- * Initializes a new instance of the AutoHealCustomAction class.
- * @constructor
* Custom action to be executed
* when an auto heal rule is triggered.
- *
- * @member {string} [exe] Executable to be run.
- * @member {string} [parameters] Parameters for the executable.
*/
export interface AutoHealCustomAction {
+ /**
+ * Executable to be run.
+ */
exe?: string;
+ /**
+ * Parameters for the executable.
+ */
parameters?: string;
}
/**
- * @class
- * Initializes a new instance of the AutoHealActions class.
- * @constructor
* Actions which to take by the auto-heal module when a rule is triggered.
- *
- * @member {string} [actionType] Predefined action to be taken. Possible values
- * include: 'Recycle', 'LogEvent', 'CustomAction'
- * @member {object} [customAction] Custom action to be taken.
- * @member {string} [customAction.exe] Executable to be run.
- * @member {string} [customAction.parameters] Parameters for the executable.
- * @member {string} [minProcessExecutionTime] Minimum time the process must
- * execute
- * before taking the action
*/
export interface AutoHealActions {
+ /**
+ * Predefined action to be taken. Possible values include: 'Recycle', 'LogEvent', 'CustomAction'
+ */
actionType?: string;
+ /**
+ * Custom action to be taken.
+ */
customAction?: AutoHealCustomAction;
+ /**
+ * Minimum time the process must execute
+ * before taking the action
+ */
minProcessExecutionTime?: string;
}
/**
- * @class
- * Initializes a new instance of the SlowRequestsBasedTrigger class.
- * @constructor
* Trigger based on request execution time.
- *
- * @member {string} [timeTaken] Time taken.
- * @member {number} [count] Request Count.
- * @member {string} [timeInterval] Time interval.
*/
export interface SlowRequestsBasedTrigger {
+ /**
+ * Time taken.
+ */
timeTaken?: string;
+ /**
+ * Request Count.
+ */
count?: number;
+ /**
+ * Time interval.
+ */
timeInterval?: string;
}
/**
- * @class
- * Initializes a new instance of the StatusCodesBasedTrigger class.
- * @constructor
* Trigger based on status code.
- *
- * @member {number} [status] HTTP status code.
- * @member {number} [subStatus] Request Sub Status.
- * @member {number} [win32Status] Win32 error code.
- * @member {number} [count] Request Count.
- * @member {string} [timeInterval] Time interval.
*/
export interface StatusCodesBasedTrigger {
+ /**
+ * HTTP status code.
+ */
status?: number;
+ /**
+ * Request Sub Status.
+ */
subStatus?: number;
+ /**
+ * Win32 error code.
+ */
win32Status?: number;
+ /**
+ * Request Count.
+ */
count?: number;
+ /**
+ * Time interval.
+ */
timeInterval?: string;
}
/**
- * @class
- * Initializes a new instance of the RequestsBasedTrigger class.
- * @constructor
* Trigger based on total requests.
- *
- * @member {number} [count] Request Count.
- * @member {string} [timeInterval] Time interval.
*/
export interface RequestsBasedTrigger {
+ /**
+ * Request Count.
+ */
count?: number;
+ /**
+ * Time interval.
+ */
timeInterval?: string;
}
/**
- * @class
- * Initializes a new instance of the AutoHealTriggers class.
- * @constructor
* Triggers for auto-heal.
- *
- * @member {object} [requests] A rule based on total requests.
- * @member {number} [requests.count] Request Count.
- * @member {string} [requests.timeInterval] Time interval.
- * @member {number} [privateBytesInKB] A rule based on private bytes.
- * @member {array} [statusCodes] A rule based on status codes.
- * @member {object} [slowRequests] A rule based on request execution time.
- * @member {string} [slowRequests.timeTaken] Time taken.
- * @member {number} [slowRequests.count] Request Count.
- * @member {string} [slowRequests.timeInterval] Time interval.
*/
export interface AutoHealTriggers {
+ /**
+ * A rule based on total requests.
+ */
requests?: RequestsBasedTrigger;
+ /**
+ * A rule based on private bytes.
+ */
privateBytesInKB?: number;
+ /**
+ * A rule based on status codes.
+ */
statusCodes?: StatusCodesBasedTrigger[];
+ /**
+ * A rule based on request execution time.
+ */
slowRequests?: SlowRequestsBasedTrigger;
}
/**
- * @class
- * Initializes a new instance of the AutoHealRules class.
- * @constructor
* Rules that can be defined for auto-heal.
- *
- * @member {object} [triggers] Conditions that describe when to execute the
- * auto-heal actions.
- * @member {object} [triggers.requests] A rule based on total requests.
- * @member {number} [triggers.requests.count] Request Count.
- * @member {string} [triggers.requests.timeInterval] Time interval.
- * @member {number} [triggers.privateBytesInKB] A rule based on private bytes.
- * @member {array} [triggers.statusCodes] A rule based on status codes.
- * @member {object} [triggers.slowRequests] A rule based on request execution
- * time.
- * @member {string} [triggers.slowRequests.timeTaken] Time taken.
- * @member {number} [triggers.slowRequests.count] Request Count.
- * @member {string} [triggers.slowRequests.timeInterval] Time interval.
- * @member {object} [actions] Actions to be executed when a rule is triggered.
- * @member {string} [actions.actionType] Predefined action to be taken.
- * Possible values include: 'Recycle', 'LogEvent', 'CustomAction'
- * @member {object} [actions.customAction] Custom action to be taken.
- * @member {string} [actions.customAction.exe] Executable to be run.
- * @member {string} [actions.customAction.parameters] Parameters for the
- * executable.
- * @member {string} [actions.minProcessExecutionTime] Minimum time the process
- * must execute
- * before taking the action
*/
export interface AutoHealRules {
+ /**
+ * Conditions that describe when to execute the auto-heal actions.
+ */
triggers?: AutoHealTriggers;
+ /**
+ * Actions to be executed when a rule is triggered.
+ */
actions?: AutoHealActions;
}
/**
- * @class
- * Initializes a new instance of the SiteLimits class.
- * @constructor
* Metric limits set on an app.
- *
- * @member {number} [maxPercentageCpu] Maximum allowed CPU usage percentage.
- * @member {number} [maxMemoryInMb] Maximum allowed memory usage in MB.
- * @member {number} [maxDiskSizeInMb] Maximum allowed disk size usage in MB.
*/
export interface SiteLimits {
+ /**
+ * Maximum allowed CPU usage percentage.
+ */
maxPercentageCpu?: number;
+ /**
+ * Maximum allowed memory usage in MB.
+ */
maxMemoryInMb?: number;
+ /**
+ * Maximum allowed disk size usage in MB.
+ */
maxDiskSizeInMb?: number;
}
/**
- * @class
- * Initializes a new instance of the RampUpRule class.
- * @constructor
- * Routing rules for ramp up testing. This rule allows to redirect static
- * traffic % to a slot or to gradually change routing % based on performance.
- *
- * @member {string} [actionHostName] Hostname of a slot to which the traffic
- * will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.
- * @member {number} [reroutePercentage] Percentage of the traffic which will be
- * redirected to ActionHostName.
- * @member {number} [changeStep] In auto ramp up scenario this is the step to
- * to add/remove from ReroutePercentage until it reaches
- * MinReroutePercentage or MaxReroutePercentage. Site
- * metrics are checked every N minutes specificed in
- * ChangeIntervalInMinutes.
- * Custom decision algorithm can be provided in TiPCallback site extension
- * which URL can be specified in ChangeDecisionCallbackUrl.
- * @member {number} [changeIntervalInMinutes] Specifies interval in mimuntes to
- * reevaluate ReroutePercentage.
- * @member {number} [minReroutePercentage] Specifies lower boundary above which
- * ReroutePercentage will stay.
- * @member {number} [maxReroutePercentage] Specifies upper boundary below which
- * ReroutePercentage will stay.
- * @member {string} [changeDecisionCallbackUrl] Custom decision algorithm can
- * be provided in TiPCallback site extension which URL can be specified. See
- * TiPCallback site extension for the scaffold and contracts.
- * https://www.siteextensions.net/packages/TiPCallback/
- * @member {string} [name] Name of the routing rule. The recommended name would
- * be to point to the slot which will receive the traffic in the experiment.
+ * Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to
+ * gradually change routing % based on performance.
*/
export interface RampUpRule {
+ /**
+ * Hostname of a slot to which the traffic will be redirected if decided to. E.g.
+ * myapp-stage.azurewebsites.net.
+ */
actionHostName?: string;
+ /**
+ * Percentage of the traffic which will be redirected to ActionHostName.
+ */
reroutePercentage?: number;
+ /**
+ * In auto ramp up scenario this is the step to add/remove from ReroutePercentage
+ * until it reaches
+ * MinReroutePercentage or MaxReroutePercentage. Site metrics are
+ * checked every N minutes specified in ChangeIntervalInMinutes.
+ * Custom decision algorithm can be provided in TiPCallback site extension which URL can be
+ * specified in ChangeDecisionCallbackUrl.
+ */
changeStep?: number;
+ /**
+ * Specifies interval in minutes to reevaluate ReroutePercentage.
+ */
changeIntervalInMinutes?: number;
+ /**
+ * Specifies lower boundary above which ReroutePercentage will stay.
+ */
minReroutePercentage?: number;
+ /**
+ * Specifies upper boundary below which ReroutePercentage will stay.
+ */
maxReroutePercentage?: number;
+ /**
+ * Custom decision algorithm can be provided in TiPCallback site extension which URL can be
+ * specified. See TiPCallback site extension for the scaffold and contracts.
+ * https://www.siteextensions.net/packages/TiPCallback/
+ */
changeDecisionCallbackUrl?: string;
+ /**
+ * Name of the routing rule. The recommended name would be to point to the slot which will
+ * receive the traffic in the experiment.
+ */
name?: string;
}
/**
- * @class
- * Initializes a new instance of the Experiments class.
- * @constructor
* Routing rules in production experiments.
- *
- * @member {array} [rampUpRules] List of ramp-up rules.
*/
export interface Experiments {
+ /**
+ * List of ramp-up rules.
+ */
rampUpRules?: RampUpRule[];
}
/**
- * @class
- * Initializes a new instance of the VirtualDirectory class.
- * @constructor
* Directory for virtual application.
- *
- * @member {string} [virtualPath] Path to virtual application.
- * @member {string} [physicalPath] Physical path.
*/
export interface VirtualDirectory {
+ /**
+ * Path to virtual application.
+ */
virtualPath?: string;
+ /**
+ * Physical path.
+ */
physicalPath?: string;
}
/**
- * @class
- * Initializes a new instance of the VirtualApplication class.
- * @constructor
* Virtual application in an app.
- *
- * @member {string} [virtualPath] Virtual path.
- * @member {string} [physicalPath] Physical path.
- * @member {boolean} [preloadEnabled] true if preloading is
- * enabled; otherwise, false.
- * @member {array} [virtualDirectories] Virtual directories for virtual
- * application.
*/
export interface VirtualApplication {
+ /**
+ * Virtual path.
+ */
virtualPath?: string;
+ /**
+ * Physical path.
+ */
physicalPath?: string;
+ /**
+ * true if preloading is enabled; otherwise, false.
+ */
preloadEnabled?: boolean;
+ /**
+ * Virtual directories for virtual application.
+ */
virtualDirectories?: VirtualDirectory[];
}
/**
- * @class
- * Initializes a new instance of the HandlerMapping class.
- * @constructor
- * The IIS handler mappings used to define which handler processes HTTP
- * requests with certain extension.
- * For example, it is used to configure php-cgi.exe process to handle all HTTP
- * requests with *.php extension.
- *
- * @member {string} [extension] Requests with this extension will be handled
- * using the specified FastCGI application.
- * @member {string} [scriptProcessor] The absolute path to the FastCGI
- * application.
- * @member {string} [argumentsProperty] Command-line arguments to be passed to
- * the script processor.
+ * The IIS handler mappings used to define which handler processes HTTP requests with certain
+ * extension.
+ * For example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php
+ * extension.
*/
export interface HandlerMapping {
+ /**
+ * Requests with this extension will be handled using the specified FastCGI application.
+ */
extension?: string;
+ /**
+ * The absolute path to the FastCGI application.
+ */
scriptProcessor?: string;
+ /**
+ * Command-line arguments to be passed to the script processor.
+ */
argumentsProperty?: string;
}
/**
- * @class
- * Initializes a new instance of the SiteMachineKey class.
- * @constructor
* MachineKey of an app.
- *
- * @member {string} [validation] MachineKey validation.
- * @member {string} [validationKey] Validation key.
- * @member {string} [decryption] Algorithm used for decryption.
- * @member {string} [decryptionKey] Decryption key.
*/
export interface SiteMachineKey {
+ /**
+ * MachineKey validation.
+ */
validation?: string;
+ /**
+ * Validation key.
+ */
validationKey?: string;
+ /**
+ * Algorithm used for decryption.
+ */
decryption?: string;
+ /**
+ * Decryption key.
+ */
decryptionKey?: string;
}
/**
- * @class
- * Initializes a new instance of the ConnStringInfo class.
- * @constructor
* Database connection string information.
- *
- * @member {string} [name] Name of connection string.
- * @member {string} [connectionString] Connection string value.
- * @member {string} [type] Type of database. Possible values include: 'MySql',
- * 'SQLServer', 'SQLAzure', 'Custom', 'NotificationHub', 'ServiceBus',
- * 'EventHub', 'ApiHub', 'DocDb', 'RedisCache', 'PostgreSQL'
*/
export interface ConnStringInfo {
+ /**
+ * Name of connection string.
+ */
name?: string;
+ /**
+ * Connection string value.
+ */
connectionString?: string;
+ /**
+ * Type of database. Possible values include: 'MySql', 'SQLServer', 'SQLAzure', 'Custom',
+ * 'NotificationHub', 'ServiceBus', 'EventHub', 'ApiHub', 'DocDb', 'RedisCache', 'PostgreSQL'
+ */
type?: string;
}
/**
- * @class
- * Initializes a new instance of the AzureStorageInfoValue class.
- * @constructor
* Azure Files or Blob Storage access information value for dictionary storage.
- *
- * @member {string} [type] Type of storage. Possible values include:
- * 'AzureFiles', 'AzureBlob'
- * @member {string} [accountName] Name of the storage account.
- * @member {string} [shareName] Name of the file share (container name, for
- * Blob storage).
- * @member {string} [accessKey] Access key for the storage account.
- * @member {string} [mountPath] Path to mount the storage within the site's
- * runtime environment.
- * @member {string} [state] State of the storage account. Possible values
- * include: 'Ok', 'InvalidCredentials', 'InvalidShare'
*/
export interface AzureStorageInfoValue {
+ /**
+ * Type of storage. Possible values include: 'AzureFiles', 'AzureBlob'
+ */
type?: string;
+ /**
+ * Name of the storage account.
+ */
accountName?: string;
+ /**
+ * Name of the file share (container name, for Blob storage).
+ */
shareName?: string;
+ /**
+ * Access key for the storage account.
+ */
accessKey?: string;
+ /**
+ * Path to mount the storage within the site's runtime environment.
+ */
mountPath?: string;
+ /**
+ * State of the storage account. Possible values include: 'Ok', 'InvalidCredentials',
+ * 'InvalidShare'
+ */
readonly state?: string;
}
/**
- * @class
- * Initializes a new instance of the NameValuePair class.
- * @constructor
* Name value pair.
- *
- * @member {string} [name] Pair name.
- * @member {string} [value] Pair value.
*/
export interface NameValuePair {
+ /**
+ * Pair name.
+ */
name?: string;
+ /**
+ * Pair value.
+ */
value?: string;
}
/**
- * @class
- * Initializes a new instance of the SiteConfig class.
- * @constructor
* Configuration of an App Service app.
- *
- * @member {number} [numberOfWorkers] Number of workers.
- * @member {array} [defaultDocuments] Default documents.
- * @member {string} [netFrameworkVersion] .NET Framework version. Default
- * value: 'v4.6' .
- * @member {string} [phpVersion] Version of PHP.
- * @member {string} [pythonVersion] Version of Python.
- * @member {string} [nodeVersion] Version of Node.js.
- * @member {string} [linuxFxVersion] Linux App Framework and version
- * @member {string} [windowsFxVersion] Xenon App Framework and version
- * @member {boolean} [requestTracingEnabled] true if request
- * tracing is enabled; otherwise, false.
- * @member {date} [requestTracingExpirationTime] Request tracing expiration
- * time.
- * @member {boolean} [remoteDebuggingEnabled] true if remote
- * debugging is enabled; otherwise, false.
- * @member {string} [remoteDebuggingVersion] Remote debugging version.
- * @member {boolean} [httpLoggingEnabled] true if HTTP logging is
- * enabled; otherwise, false.
- * @member {number} [logsDirectorySizeLimit] HTTP logs directory size limit.
- * @member {boolean} [detailedErrorLoggingEnabled] true if
- * detailed error logging is enabled; otherwise, false.
- * @member {string} [publishingUsername] Publishing user name.
- * @member {array} [appSettings] Application settings.
- * @member {object} [azureStorageAccounts] User-provided Azure storage
- * accounts.
- * @member {array} [connectionStrings] Connection strings.
- * @member {object} [machineKey] Site MachineKey.
- * @member {string} [machineKey.validation] MachineKey validation.
- * @member {string} [machineKey.validationKey] Validation key.
- * @member {string} [machineKey.decryption] Algorithm used for decryption.
- * @member {string} [machineKey.decryptionKey] Decryption key.
- * @member {array} [handlerMappings] Handler mappings.
- * @member {string} [documentRoot] Document root.
- * @member {string} [scmType] SCM type. Possible values include: 'None',
- * 'Dropbox', 'Tfs', 'LocalGit', 'GitHub', 'CodePlexGit', 'CodePlexHg',
- * 'BitbucketGit', 'BitbucketHg', 'ExternalGit', 'ExternalHg', 'OneDrive',
- * 'VSO'
- * @member {boolean} [use32BitWorkerProcess] true to use 32-bit
- * worker process; otherwise, false.
- * @member {boolean} [webSocketsEnabled] true if WebSocket is
- * enabled; otherwise, false.
- * @member {boolean} [alwaysOn] true if Always On is enabled;
- * otherwise, false.
- * @member {string} [javaVersion] Java version.
- * @member {string} [javaContainer] Java container.
- * @member {string} [javaContainerVersion] Java container version.
- * @member {string} [appCommandLine] App command line to launch.
- * @member {string} [managedPipelineMode] Managed pipeline mode. Possible
- * values include: 'Integrated', 'Classic'
- * @member {array} [virtualApplications] Virtual applications.
- * @member {string} [loadBalancing] Site load balancing. Possible values
- * include: 'WeightedRoundRobin', 'LeastRequests', 'LeastResponseTime',
- * 'WeightedTotalTraffic', 'RequestHash'
- * @member {object} [experiments] This is work around for polymophic types.
- * @member {array} [experiments.rampUpRules] List of ramp-up rules.
- * @member {object} [limits] Site limits.
- * @member {number} [limits.maxPercentageCpu] Maximum allowed CPU usage
- * percentage.
- * @member {number} [limits.maxMemoryInMb] Maximum allowed memory usage in MB.
- * @member {number} [limits.maxDiskSizeInMb] Maximum allowed disk size usage in
- * MB.
- * @member {boolean} [autoHealEnabled] true if Auto Heal is
- * enabled; otherwise, false.
- * @member {object} [autoHealRules] Auto Heal rules.
- * @member {object} [autoHealRules.triggers] Conditions that describe when to
- * execute the auto-heal actions.
- * @member {object} [autoHealRules.triggers.requests] A rule based on total
- * requests.
- * @member {number} [autoHealRules.triggers.requests.count] Request Count.
- * @member {string} [autoHealRules.triggers.requests.timeInterval] Time
- * interval.
- * @member {number} [autoHealRules.triggers.privateBytesInKB] A rule based on
- * private bytes.
- * @member {array} [autoHealRules.triggers.statusCodes] A rule based on status
- * codes.
- * @member {object} [autoHealRules.triggers.slowRequests] A rule based on
- * request execution time.
- * @member {string} [autoHealRules.triggers.slowRequests.timeTaken] Time taken.
- * @member {number} [autoHealRules.triggers.slowRequests.count] Request Count.
- * @member {string} [autoHealRules.triggers.slowRequests.timeInterval] Time
- * interval.
- * @member {object} [autoHealRules.actions] Actions to be executed when a rule
- * is triggered.
- * @member {string} [autoHealRules.actions.actionType] Predefined action to be
- * taken. Possible values include: 'Recycle', 'LogEvent', 'CustomAction'
- * @member {object} [autoHealRules.actions.customAction] Custom action to be
- * taken.
- * @member {string} [autoHealRules.actions.customAction.exe] Executable to be
- * run.
- * @member {string} [autoHealRules.actions.customAction.parameters] Parameters
- * for the executable.
- * @member {string} [autoHealRules.actions.minProcessExecutionTime] Minimum
- * time the process must execute
- * before taking the action
- * @member {string} [tracingOptions] Tracing options.
- * @member {string} [vnetName] Virtual Network name.
- * @member {object} [cors] Cross-Origin Resource Sharing (CORS) settings.
- * @member {array} [cors.allowedOrigins] Gets or sets the list of origins that
- * should be allowed to make cross-origin
- * calls (for example: http://example.com:12345). Use "*" to allow all.
- * @member {object} [push] Push endpoint settings.
- * @member {boolean} [push.isPushEnabled] Gets or sets a flag indicating
- * whether the Push endpoint is enabled.
- * @member {string} [push.tagWhitelistJson] Gets or sets a JSON string
- * containing a list of tags that are whitelisted for use by the push
- * registration endpoint.
- * @member {string} [push.tagsRequiringAuth] Gets or sets a JSON string
- * containing a list of tags that require user authentication to be used in the
- * push registration endpoint.
- * Tags can consist of alphanumeric characters and the following:
- * '_', '@', '#', '.', ':', '-'.
- * Validation should be performed at the PushRequestHandler.
- * @member {string} [push.dynamicTagsJson] Gets or sets a JSON string
- * containing a list of dynamic tags that will be evaluated from user claims in
- * the push registration endpoint.
- * @member {object} [apiDefinition] Information about the formal API definition
- * for the app.
- * @member {string} [apiDefinition.url] The URL of the API definition.
- * @member {string} [autoSwapSlotName] Auto-swap slot name.
- * @member {boolean} [localMySqlEnabled] true to enable local
- * MySQL; otherwise, false. Default value: false .
- * @member {number} [managedServiceIdentityId] Managed Service Identity Id
- * @member {number} [xManagedServiceIdentityId] Explicit Managed Service
- * Identity Id
- * @member {array} [ipSecurityRestrictions] IP security restrictions.
- * @member {boolean} [http20Enabled] Http20Enabled: configures a web site to
- * allow clients to connect over http2.0. Default value: true .
- * @member {string} [minTlsVersion] MinTlsVersion: configures the minimum
- * version of TLS required for SSL requests. Possible values include: '1.0',
- * '1.1', '1.2'
- * @member {string} [ftpsState] State of FTP / FTPS service. Possible values
- * include: 'AllAllowed', 'FtpsOnly', 'Disabled'
- * @member {number} [reservedInstanceCount] Number of reserved instances.
- * This setting only applies to the Consumption Plan
*/
export interface SiteConfig {
+ /**
+ * Number of workers.
+ */
numberOfWorkers?: number;
+ /**
+ * Default documents.
+ */
defaultDocuments?: string[];
+ /**
+ * .NET Framework version.
+ */
netFrameworkVersion?: string;
+ /**
+ * Version of PHP.
+ */
phpVersion?: string;
+ /**
+ * Version of Python.
+ */
pythonVersion?: string;
+ /**
+ * Version of Node.js.
+ */
nodeVersion?: string;
+ /**
+ * Linux App Framework and version
+ */
linuxFxVersion?: string;
+ /**
+ * Xenon App Framework and version
+ */
windowsFxVersion?: string;
+ /**
+ * true if request tracing is enabled; otherwise, false.
+ */
requestTracingEnabled?: boolean;
+ /**
+ * Request tracing expiration time.
+ */
requestTracingExpirationTime?: Date;
+ /**
+ * true if remote debugging is enabled; otherwise, false.
+ */
remoteDebuggingEnabled?: boolean;
+ /**
+ * Remote debugging version.
+ */
remoteDebuggingVersion?: string;
+ /**
+ * true if HTTP logging is enabled; otherwise, false.
+ */
httpLoggingEnabled?: boolean;
+ /**
+ * HTTP logs directory size limit.
+ */
logsDirectorySizeLimit?: number;
+ /**
+ * true if detailed error logging is enabled; otherwise, false.
+ */
detailedErrorLoggingEnabled?: boolean;
+ /**
+ * Publishing user name.
+ */
publishingUsername?: string;
+ /**
+ * Application settings.
+ */
appSettings?: NameValuePair[];
+ /**
+ * User-provided Azure storage accounts.
+ */
azureStorageAccounts?: { [propertyName: string]: AzureStorageInfoValue };
+ /**
+ * Connection strings.
+ */
connectionStrings?: ConnStringInfo[];
+ /**
+ * Site MachineKey.
+ */
readonly machineKey?: SiteMachineKey;
+ /**
+ * Handler mappings.
+ */
handlerMappings?: HandlerMapping[];
+ /**
+ * Document root.
+ */
documentRoot?: string;
+ /**
+ * SCM type. Possible values include: 'None', 'Dropbox', 'Tfs', 'LocalGit', 'GitHub',
+ * 'CodePlexGit', 'CodePlexHg', 'BitbucketGit', 'BitbucketHg', 'ExternalGit', 'ExternalHg',
+ * 'OneDrive', 'VSO'
+ */
scmType?: string;
+ /**
+ * true to use 32-bit worker process; otherwise, false.
+ */
use32BitWorkerProcess?: boolean;
+ /**
+ * true if WebSocket is enabled; otherwise, false.
+ */
webSocketsEnabled?: boolean;
+ /**
+ * true if Always On is enabled; otherwise, false.
+ */
alwaysOn?: boolean;
+ /**
+ * Java version.
+ */
javaVersion?: string;
+ /**
+ * Java container.
+ */
javaContainer?: string;
+ /**
+ * Java container version.
+ */
javaContainerVersion?: string;
+ /**
+ * App command line to launch.
+ */
appCommandLine?: string;
+ /**
+ * Managed pipeline mode. Possible values include: 'Integrated', 'Classic'
+ */
managedPipelineMode?: string;
+ /**
+ * Virtual applications.
+ */
virtualApplications?: VirtualApplication[];
+ /**
+ * Site load balancing. Possible values include: 'WeightedRoundRobin', 'LeastRequests',
+ * 'LeastResponseTime', 'WeightedTotalTraffic', 'RequestHash'
+ */
loadBalancing?: string;
+ /**
+ * This is work around for polymophic types.
+ */
experiments?: Experiments;
+ /**
+ * Site limits.
+ */
limits?: SiteLimits;
+ /**
+ * true if Auto Heal is enabled; otherwise, false.
+ */
autoHealEnabled?: boolean;
+ /**
+ * Auto Heal rules.
+ */
autoHealRules?: AutoHealRules;
+ /**
+ * Tracing options.
+ */
tracingOptions?: string;
+ /**
+ * Virtual Network name.
+ */
vnetName?: string;
+ /**
+ * Cross-Origin Resource Sharing (CORS) settings.
+ */
cors?: CorsSettings;
+ /**
+ * Push endpoint settings.
+ */
push?: PushSettings;
+ /**
+ * Information about the formal API definition for the app.
+ */
apiDefinition?: ApiDefinitionInfo;
+ /**
+ * Auto-swap slot name.
+ */
autoSwapSlotName?: string;
+ /**
+ * true to enable local MySQL; otherwise, false.
+ */
localMySqlEnabled?: boolean;
+ /**
+ * Managed Service Identity Id
+ */
managedServiceIdentityId?: number;
+ /**
+ * Explicit Managed Service Identity Id
+ */
xManagedServiceIdentityId?: number;
+ /**
+ * IP security restrictions.
+ */
ipSecurityRestrictions?: IpSecurityRestriction[];
+ /**
+ * Http20Enabled: configures a web site to allow clients to connect over http2.0
+ */
http20Enabled?: boolean;
+ /**
+ * MinTlsVersion: configures the minimum version of TLS required for SSL requests. Possible
+ * values include: '1.0', '1.1', '1.2'
+ */
minTlsVersion?: string;
+ /**
+ * State of FTP / FTPS service. Possible values include: 'AllAllowed', 'FtpsOnly', 'Disabled'
+ */
ftpsState?: string;
+ /**
+ * Number of reserved instances.
+ * This setting only applies to the Consumption Plan
+ */
reservedInstanceCount?: number;
}
/**
- * @class
- * Initializes a new instance of the HostNameSslState class.
- * @constructor
* SSL-enabled hostname.
- *
- * @member {string} [name] Hostname.
- * @member {string} [sslState] SSL type. Possible values include: 'Disabled',
- * 'SniEnabled', 'IpBasedEnabled'
- * @member {string} [virtualIP] Virtual IP address assigned to the hostname if
- * IP based SSL is enabled.
- * @member {string} [thumbprint] SSL certificate thumbprint.
- * @member {boolean} [toUpdate] Set to true to update existing
- * hostname.
- * @member {string} [hostType] Indicates whether the hostname is a standard or
- * repository hostname. Possible values include: 'Standard', 'Repository'
*/
export interface HostNameSslState {
+ /**
+ * Hostname.
+ */
name?: string;
+ /**
+ * SSL type. Possible values include: 'Disabled', 'SniEnabled', 'IpBasedEnabled'
+ */
sslState?: string;
+ /**
+ * Virtual IP address assigned to the hostname if IP based SSL is enabled.
+ */
virtualIP?: string;
+ /**
+ * SSL certificate thumbprint.
+ */
thumbprint?: string;
+ /**
+ * Set to true to update existing hostname.
+ */
toUpdate?: boolean;
+ /**
+ * Indicates whether the hostname is a standard or repository hostname. Possible values include:
+ * 'Standard', 'Repository'
+ */
hostType?: string;
}
/**
- * @class
- * Initializes a new instance of the Site class.
- * @constructor
* A web app, a mobile app backend, or an API app.
- *
- * @member {string} [state] Current state of the app.
- * @member {array} [hostNames] Hostnames associated with the app.
- * @member {string} [repositorySiteName] Name of the repository site.
- * @member {string} [usageState] State indicating whether the app has exceeded
- * its quota usage. Read-only. Possible values include: 'Normal', 'Exceeded'
- * @member {boolean} [enabled] true if the app is enabled;
- * otherwise, false. Setting this value to false disables the app
- * (takes the app offline).
- * @member {array} [enabledHostNames] Enabled hostnames for the app.Hostnames
- * need to be assigned (see HostNames) AND enabled. Otherwise,
- * the app is not served on those hostnames.
- * @member {string} [availabilityState] Management information availability
- * state for the app. Possible values include: 'Normal', 'Limited',
- * 'DisasterRecoveryMode'
- * @member {array} [hostNameSslStates] Hostname SSL states are used to manage
- * the SSL bindings for app's hostnames.
- * @member {string} [serverFarmId] Resource ID of the associated App Service
- * plan, formatted as:
- * "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
- * @member {boolean} [reserved] true if reserved; otherwise,
- * false. Default value: false .
- * @member {boolean} [isXenon] Obsolete: Hyper-V sandbox. Default value: false
- * .
- * @member {boolean} [hyperV] Hyper-V sandbox. Default value: false .
- * @member {date} [lastModifiedTimeUtc] Last time the app was modified, in UTC.
- * Read-only.
- * @member {object} [siteConfig] Configuration of the app.
- * @member {number} [siteConfig.numberOfWorkers] Number of workers.
- * @member {array} [siteConfig.defaultDocuments] Default documents.
- * @member {string} [siteConfig.netFrameworkVersion] .NET Framework version.
- * @member {string} [siteConfig.phpVersion] Version of PHP.
- * @member {string} [siteConfig.pythonVersion] Version of Python.
- * @member {string} [siteConfig.nodeVersion] Version of Node.js.
- * @member {string} [siteConfig.linuxFxVersion] Linux App Framework and version
- * @member {string} [siteConfig.windowsFxVersion] Xenon App Framework and
- * version
- * @member {boolean} [siteConfig.requestTracingEnabled] true if
- * request tracing is enabled; otherwise, false.
- * @member {date} [siteConfig.requestTracingExpirationTime] Request tracing
- * expiration time.
- * @member {boolean} [siteConfig.remoteDebuggingEnabled] true if
- * remote debugging is enabled; otherwise, false.
- * @member {string} [siteConfig.remoteDebuggingVersion] Remote debugging
- * version.
- * @member {boolean} [siteConfig.httpLoggingEnabled] true if HTTP
- * logging is enabled; otherwise, false.
- * @member {number} [siteConfig.logsDirectorySizeLimit] HTTP logs directory
- * size limit.
- * @member {boolean} [siteConfig.detailedErrorLoggingEnabled] true
- * if detailed error logging is enabled; otherwise, false.
- * @member {string} [siteConfig.publishingUsername] Publishing user name.
- * @member {array} [siteConfig.appSettings] Application settings.
- * @member {object} [siteConfig.azureStorageAccounts] User-provided Azure
- * storage accounts.
- * @member {array} [siteConfig.connectionStrings] Connection strings.
- * @member {object} [siteConfig.machineKey] Site MachineKey.
- * @member {string} [siteConfig.machineKey.validation] MachineKey validation.
- * @member {string} [siteConfig.machineKey.validationKey] Validation key.
- * @member {string} [siteConfig.machineKey.decryption] Algorithm used for
- * decryption.
- * @member {string} [siteConfig.machineKey.decryptionKey] Decryption key.
- * @member {array} [siteConfig.handlerMappings] Handler mappings.
- * @member {string} [siteConfig.documentRoot] Document root.
- * @member {string} [siteConfig.scmType] SCM type. Possible values include:
- * 'None', 'Dropbox', 'Tfs', 'LocalGit', 'GitHub', 'CodePlexGit', 'CodePlexHg',
- * 'BitbucketGit', 'BitbucketHg', 'ExternalGit', 'ExternalHg', 'OneDrive',
- * 'VSO'
- * @member {boolean} [siteConfig.use32BitWorkerProcess] true to
- * use 32-bit worker process; otherwise, false.
- * @member {boolean} [siteConfig.webSocketsEnabled] true if
- * WebSocket is enabled; otherwise, false.
- * @member {boolean} [siteConfig.alwaysOn] true if Always On is
- * enabled; otherwise, false.
- * @member {string} [siteConfig.javaVersion] Java version.
- * @member {string} [siteConfig.javaContainer] Java container.
- * @member {string} [siteConfig.javaContainerVersion] Java container version.
- * @member {string} [siteConfig.appCommandLine] App command line to launch.
- * @member {string} [siteConfig.managedPipelineMode] Managed pipeline mode.
- * Possible values include: 'Integrated', 'Classic'
- * @member {array} [siteConfig.virtualApplications] Virtual applications.
- * @member {string} [siteConfig.loadBalancing] Site load balancing. Possible
- * values include: 'WeightedRoundRobin', 'LeastRequests', 'LeastResponseTime',
- * 'WeightedTotalTraffic', 'RequestHash'
- * @member {object} [siteConfig.experiments] This is work around for polymophic
- * types.
- * @member {array} [siteConfig.experiments.rampUpRules] List of ramp-up rules.
- * @member {object} [siteConfig.limits] Site limits.
- * @member {number} [siteConfig.limits.maxPercentageCpu] Maximum allowed CPU
- * usage percentage.
- * @member {number} [siteConfig.limits.maxMemoryInMb] Maximum allowed memory
- * usage in MB.
- * @member {number} [siteConfig.limits.maxDiskSizeInMb] Maximum allowed disk
- * size usage in MB.
- * @member {boolean} [siteConfig.autoHealEnabled] true if Auto
- * Heal is enabled; otherwise, false.
- * @member {object} [siteConfig.autoHealRules] Auto Heal rules.
- * @member {object} [siteConfig.autoHealRules.triggers] Conditions that
- * describe when to execute the auto-heal actions.
- * @member {object} [siteConfig.autoHealRules.triggers.requests] A rule based
- * on total requests.
- * @member {number} [siteConfig.autoHealRules.triggers.requests.count] Request
- * Count.
- * @member {string} [siteConfig.autoHealRules.triggers.requests.timeInterval]
- * Time interval.
- * @member {number} [siteConfig.autoHealRules.triggers.privateBytesInKB] A rule
- * based on private bytes.
- * @member {array} [siteConfig.autoHealRules.triggers.statusCodes] A rule based
- * on status codes.
- * @member {object} [siteConfig.autoHealRules.triggers.slowRequests] A rule
- * based on request execution time.
- * @member {string} [siteConfig.autoHealRules.triggers.slowRequests.timeTaken]
- * Time taken.
- * @member {number} [siteConfig.autoHealRules.triggers.slowRequests.count]
- * Request Count.
- * @member {string}
- * [siteConfig.autoHealRules.triggers.slowRequests.timeInterval] Time interval.
- * @member {object} [siteConfig.autoHealRules.actions] Actions to be executed
- * when a rule is triggered.
- * @member {string} [siteConfig.autoHealRules.actions.actionType] Predefined
- * action to be taken. Possible values include: 'Recycle', 'LogEvent',
- * 'CustomAction'
- * @member {object} [siteConfig.autoHealRules.actions.customAction] Custom
- * action to be taken.
- * @member {string} [siteConfig.autoHealRules.actions.customAction.exe]
- * Executable to be run.
- * @member {string} [siteConfig.autoHealRules.actions.customAction.parameters]
- * Parameters for the executable.
- * @member {string} [siteConfig.autoHealRules.actions.minProcessExecutionTime]
- * Minimum time the process must execute
- * before taking the action
- * @member {string} [siteConfig.tracingOptions] Tracing options.
- * @member {string} [siteConfig.vnetName] Virtual Network name.
- * @member {object} [siteConfig.cors] Cross-Origin Resource Sharing (CORS)
- * settings.
- * @member {array} [siteConfig.cors.allowedOrigins] Gets or sets the list of
- * origins that should be allowed to make cross-origin
- * calls (for example: http://example.com:12345). Use "*" to allow all.
- * @member {object} [siteConfig.push] Push endpoint settings.
- * @member {boolean} [siteConfig.push.isPushEnabled] Gets or sets a flag
- * indicating whether the Push endpoint is enabled.
- * @member {string} [siteConfig.push.tagWhitelistJson] Gets or sets a JSON
- * string containing a list of tags that are whitelisted for use by the push
- * registration endpoint.
- * @member {string} [siteConfig.push.tagsRequiringAuth] Gets or sets a JSON
- * string containing a list of tags that require user authentication to be used
- * in the push registration endpoint.
- * Tags can consist of alphanumeric characters and the following:
- * '_', '@', '#', '.', ':', '-'.
- * Validation should be performed at the PushRequestHandler.
- * @member {string} [siteConfig.push.dynamicTagsJson] Gets or sets a JSON
- * string containing a list of dynamic tags that will be evaluated from user
- * claims in the push registration endpoint.
- * @member {object} [siteConfig.apiDefinition] Information about the formal API
- * definition for the app.
- * @member {string} [siteConfig.apiDefinition.url] The URL of the API
- * definition.
- * @member {string} [siteConfig.autoSwapSlotName] Auto-swap slot name.
- * @member {boolean} [siteConfig.localMySqlEnabled] true to enable
- * local MySQL; otherwise, false.
- * @member {number} [siteConfig.managedServiceIdentityId] Managed Service
- * Identity Id
- * @member {number} [siteConfig.xManagedServiceIdentityId] Explicit Managed
- * Service Identity Id
- * @member {array} [siteConfig.ipSecurityRestrictions] IP security
- * restrictions.
- * @member {boolean} [siteConfig.http20Enabled] Http20Enabled: configures a web
- * site to allow clients to connect over http2.0
- * @member {string} [siteConfig.minTlsVersion] MinTlsVersion: configures the
- * minimum version of TLS required for SSL requests. Possible values include:
- * '1.0', '1.1', '1.2'
- * @member {string} [siteConfig.ftpsState] State of FTP / FTPS service.
- * Possible values include: 'AllAllowed', 'FtpsOnly', 'Disabled'
- * @member {number} [siteConfig.reservedInstanceCount] Number of reserved
- * instances.
- * This setting only applies to the Consumption Plan
- * @member {array} [trafficManagerHostNames] Azure Traffic Manager hostnames
- * associated with the app. Read-only.
- * @member {boolean} [scmSiteAlsoStopped] true to stop SCM (KUDU)
- * site when the app is stopped; otherwise, false. The default is
- * false. Default value: false .
- * @member {string} [targetSwapSlot] Specifies which deployment slot this app
- * will swap into. Read-only.
- * @member {object} [hostingEnvironmentProfile] App Service Environment to use
- * for the app.
- * @member {string} [hostingEnvironmentProfile.id] Resource ID of the App
- * Service Environment.
- * @member {string} [hostingEnvironmentProfile.name] Name of the App Service
- * Environment.
- * @member {string} [hostingEnvironmentProfile.type] Resource type of the App
- * Service Environment.
- * @member {boolean} [clientAffinityEnabled] true to enable client
- * affinity; false to stop sending session affinity cookies, which
- * route client requests in the same session to the same instance. Default is
- * true.
- * @member {boolean} [clientCertEnabled] true to enable client
- * certificate authentication (TLS mutual authentication); otherwise,
- * false. Default is false.
- * @member {boolean} [hostNamesDisabled] true to disable the
- * public hostnames of the app; otherwise, false.
- * If true, the app is only accessible via API management process.
- * @member {string} [outboundIpAddresses] List of IP addresses that the app
- * uses for outbound connections (e.g. database access). Includes VIPs from
- * tenants that site can be hosted with current settings. Read-only.
- * @member {string} [possibleOutboundIpAddresses] List of IP addresses that the
- * app uses for outbound connections (e.g. database access). Includes VIPs from
- * all tenants. Read-only.
- * @member {number} [containerSize] Size of the function container.
- * @member {number} [dailyMemoryTimeQuota] Maximum allowed daily memory-time
- * quota (applicable on dynamic apps only).
- * @member {date} [suspendedTill] App suspended till in case memory-time quota
- * is exceeded.
- * @member {number} [maxNumberOfWorkers] Maximum number of workers.
- * This only applies to Functions container.
- * @member {object} [cloningInfo] If specified during app creation, the app is
- * cloned from a source app.
- * @member {uuid} [cloningInfo.correlationId] Correlation ID of cloning
- * operation. This ID ties multiple cloning operations
- * together to use the same snapshot.
- * @member {boolean} [cloningInfo.overwrite] true to overwrite
- * destination app; otherwise, false.
- * @member {boolean} [cloningInfo.cloneCustomHostNames] true to
- * clone custom hostnames from source app; otherwise, false.
- * @member {boolean} [cloningInfo.cloneSourceControl] true to
- * clone source control from source app; otherwise, false.
- * @member {string} [cloningInfo.sourceWebAppId] ARM resource ID of the source
- * app. App resource ID is of the form
- * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}
- * for production slots and
- * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName}
- * for other slots.
- * @member {string} [cloningInfo.hostingEnvironment] App Service Environment.
- * @member {object} [cloningInfo.appSettingsOverrides] Application setting
- * overrides for cloned app. If specified, these settings override the settings
- * cloned
- * from source app. Otherwise, application settings from source app are
- * retained.
- * @member {boolean} [cloningInfo.configureLoadBalancing] true to
- * configure load balancing for source and destination app.
- * @member {string} [cloningInfo.trafficManagerProfileId] ARM resource ID of
- * the Traffic Manager profile to use, if it exists. Traffic Manager resource
- * ID is of the form
- * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.
- * @member {string} [cloningInfo.trafficManagerProfileName] Name of Traffic
- * Manager profile to create. This is only needed if Traffic Manager profile
- * does not already exist.
- * @member {string} [resourceGroup] Name of the resource group the app belongs
- * to. Read-only.
- * @member {boolean} [isDefaultContainer] true if the app is a
- * default container; otherwise, false.
- * @member {string} [defaultHostName] Default hostname of the app. Read-only.
- * @member {object} [slotSwapStatus] Status of the last deployment slot swap
- * operation.
- * @member {date} [slotSwapStatus.timestampUtc] The time the last successful
- * slot swap completed.
- * @member {string} [slotSwapStatus.sourceSlotName] The source slot of the last
- * swap operation.
- * @member {string} [slotSwapStatus.destinationSlotName] The destination slot
- * of the last swap operation.
- * @member {boolean} [httpsOnly] HttpsOnly: configures a web site to accept
- * only https requests. Issues redirect for
- * http requests
- * @member {object} [identity]
- * @member {string} [identity.type] Type of managed service identity. Possible
- * values include: 'SystemAssigned', 'UserAssigned'
- * @member {string} [identity.tenantId] Tenant of managed service identity.
- * @member {string} [identity.principalId] Principal Id of managed service
- * identity.
- * @member {array} [identity.identityIds] Array of UserAssigned managed service
- * identities.
*/
export interface Site extends Resource {
+ /**
+ * Current state of the app.
+ */
readonly state?: string;
+ /**
+ * Hostnames associated with the app.
+ */
readonly hostNames?: string[];
+ /**
+ * Name of the repository site.
+ */
readonly repositorySiteName?: string;
+ /**
+ * State indicating whether the app has exceeded its quota usage. Read-only. Possible values
+ * include: 'Normal', 'Exceeded'
+ */
readonly usageState?: string;
+ /**
+ * true if the app is enabled; otherwise, false. Setting this value to
+ * false disables the app (takes the app offline).
+ */
enabled?: boolean;
+ /**
+ * Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled.
+ * Otherwise,
+ * the app is not served on those hostnames.
+ */
readonly enabledHostNames?: string[];
+ /**
+ * Management information availability state for the app. Possible values include: 'Normal',
+ * 'Limited', 'DisasterRecoveryMode'
+ */
readonly availabilityState?: string;
+ /**
+ * Hostname SSL states are used to manage the SSL bindings for app's hostnames.
+ */
hostNameSslStates?: HostNameSslState[];
+ /**
+ * Resource ID of the associated App Service plan, formatted as:
+ * "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
+ */
serverFarmId?: string;
+ /**
+ * true if reserved; otherwise, false.
+ */
reserved?: boolean;
+ /**
+ * Obsolete: Hyper-V sandbox.
+ */
isXenon?: boolean;
+ /**
+ * Hyper-V sandbox.
+ */
hyperV?: boolean;
+ /**
+ * Last time the app was modified, in UTC. Read-only.
+ */
readonly lastModifiedTimeUtc?: Date;
+ /**
+ * Configuration of the app.
+ */
siteConfig?: SiteConfig;
+ /**
+ * Azure Traffic Manager hostnames associated with the app. Read-only.
+ */
readonly trafficManagerHostNames?: string[];
+ /**
+ * true to stop SCM (KUDU) site when the app is stopped; otherwise,
+ * false. The default is false.
+ */
scmSiteAlsoStopped?: boolean;
+ /**
+ * Specifies which deployment slot this app will swap into. Read-only.
+ */
readonly targetSwapSlot?: string;
+ /**
+ * App Service Environment to use for the app.
+ */
hostingEnvironmentProfile?: HostingEnvironmentProfile;
+ /**
+ * true to enable client affinity; false to stop sending session
+ * affinity cookies, which route client requests in the same session to the same instance.
+ * Default is true.
+ */
clientAffinityEnabled?: boolean;
+ /**
+ * true to enable client certificate authentication (TLS mutual authentication);
+ * otherwise, false. Default is false.
+ */
clientCertEnabled?: boolean;
+ /**
+ * true to disable the public hostnames of the app; otherwise, false.
+ * If true, the app is only accessible via API management process.
+ */
hostNamesDisabled?: boolean;
+ /**
+ * List of IP addresses that the app uses for outbound connections (e.g. database access).
+ * Includes VIPs from tenants that site can be hosted with current settings. Read-only.
+ */
readonly outboundIpAddresses?: string;
+ /**
+ * List of IP addresses that the app uses for outbound connections (e.g. database access).
+ * Includes VIPs from all tenants. Read-only.
+ */
readonly possibleOutboundIpAddresses?: string;
+ /**
+ * Size of the function container.
+ */
containerSize?: number;
+ /**
+ * Maximum allowed daily memory-time quota (applicable on dynamic apps only).
+ */
dailyMemoryTimeQuota?: number;
+ /**
+ * App suspended till in case memory-time quota is exceeded.
+ */
readonly suspendedTill?: Date;
+ /**
+ * Maximum number of workers.
+ * This only applies to Functions container.
+ */
readonly maxNumberOfWorkers?: number;
+ /**
+ * If specified during app creation, the app is cloned from a source app.
+ */
cloningInfo?: CloningInfo;
+ /**
+ * Name of the resource group the app belongs to. Read-only.
+ */
readonly resourceGroup?: string;
+ /**
+ * true if the app is a default container; otherwise, false.
+ */
readonly isDefaultContainer?: boolean;
+ /**
+ * Default hostname of the app. Read-only.
+ */
readonly defaultHostName?: string;
+ /**
+ * Status of the last deployment slot swap operation.
+ */
readonly slotSwapStatus?: SlotSwapStatus;
+ /**
+ * HttpsOnly: configures a web site to accept only https requests. Issues redirect for
+ * http requests
+ */
httpsOnly?: boolean;
identity?: ManagedServiceIdentity;
}
/**
- * @class
- * Initializes a new instance of the Capability class.
- * @constructor
* Describes the capabilities/features allowed for a specific SKU.
- *
- * @member {string} [name] Name of the SKU capability.
- * @member {string} [value] Value of the SKU capability.
- * @member {string} [reason] Reason of the SKU capability.
- */
+*/
export interface Capability {
+ /**
+ * Name of the SKU capability.
+ */
name?: string;
+ /**
+ * Value of the SKU capability.
+ */
value?: string;
+ /**
+ * Reason of the SKU capability.
+ */
reason?: string;
}
/**
- * @class
- * Initializes a new instance of the SkuCapacity class.
- * @constructor
* Description of the App Service plan scale options.
- *
- * @member {number} [minimum] Minimum number of workers for this App Service
- * plan SKU.
- * @member {number} [maximum] Maximum number of workers for this App Service
- * plan SKU.
- * @member {number} [default] Default number of workers for this App Service
- * plan SKU.
- * @member {string} [scaleType] Available scale configurations for an App
- * Service plan.
- */
+*/
export interface SkuCapacity {
+ /**
+ * Minimum number of workers for this App Service plan SKU.
+ */
minimum?: number;
+ /**
+ * Maximum number of workers for this App Service plan SKU.
+ */
maximum?: number;
+ /**
+ * Default number of workers for this App Service plan SKU.
+ */
default?: number;
+ /**
+ * Available scale configurations for an App Service plan.
+ */
scaleType?: string;
}
/**
- * @class
- * Initializes a new instance of the SkuDescription class.
- * @constructor
* Description of a SKU for a scalable resource.
- *
- * @member {string} [name] Name of the resource SKU.
- * @member {string} [tier] Service tier of the resource SKU.
- * @member {string} [size] Size specifier of the resource SKU.
- * @member {string} [family] Family code of the resource SKU.
- * @member {number} [capacity] Current number of instances assigned to the
- * resource.
- * @member {object} [skuCapacity] Min, max, and default scale values of the
- * SKU.
- * @member {number} [skuCapacity.minimum] Minimum number of workers for this
- * App Service plan SKU.
- * @member {number} [skuCapacity.maximum] Maximum number of workers for this
- * App Service plan SKU.
- * @member {number} [skuCapacity.default] Default number of workers for this
- * App Service plan SKU.
- * @member {string} [skuCapacity.scaleType] Available scale configurations for
- * an App Service plan.
- * @member {array} [locations] Locations of the SKU.
- * @member {array} [capabilities] Capabilities of the SKU, e.g., is traffic
- * manager enabled?
- */
+*/
export interface SkuDescription {
+ /**
+ * Name of the resource SKU.
+ */
name?: string;
+ /**
+ * Service tier of the resource SKU.
+ */
tier?: string;
+ /**
+ * Size specifier of the resource SKU.
+ */
size?: string;
+ /**
+ * Family code of the resource SKU.
+ */
family?: string;
+ /**
+ * Current number of instances assigned to the resource.
+ */
capacity?: number;
+ /**
+ * Min, max, and default scale values of the SKU.
+ */
skuCapacity?: SkuCapacity;
+ /**
+ * Locations of the SKU.
+ */
locations?: string[];
+ /**
+ * Capabilities of the SKU, e.g., is traffic manager enabled?
+ */
capabilities?: Capability[];
}
/**
- * @class
- * Initializes a new instance of the AppServicePlan class.
- * @constructor
* App Service plan.
- *
- * @member {string} [workerTierName] Target worker tier assigned to the App
- * Service plan.
- * @member {string} [status] App Service plan status. Possible values include:
- * 'Ready', 'Pending', 'Creating'
- * @member {string} [subscription] App Service plan subscription.
- * @member {string} [adminSiteName] App Service plan administration site.
- * @member {object} [hostingEnvironmentProfile] Specification for the App
- * Service Environment to use for the App Service plan.
- * @member {string} [hostingEnvironmentProfile.id] Resource ID of the App
- * Service Environment.
- * @member {string} [hostingEnvironmentProfile.name] Name of the App Service
- * Environment.
- * @member {string} [hostingEnvironmentProfile.type] Resource type of the App
- * Service Environment.
- * @member {number} [maximumNumberOfWorkers] Maximum number of instances that
- * can be assigned to this App Service plan.
- * @member {string} [geoRegion] Geographical location for the App Service plan.
- * @member {boolean} [perSiteScaling] If true, apps assigned to
- * this App Service plan can be scaled independently.
- * If false, apps assigned to this App Service plan will scale to
- * all instances of the plan. Default value: false .
- * @member {number} [maximumElasticWorkerCount] Maximum number of total workers
- * allowed for this ElasticScaleEnabled App Service Plan
- * @member {number} [numberOfSites] Number of apps assigned to this App Service
- * plan.
- * @member {boolean} [isSpot] If true, this App Service Plan owns
- * spot instances.
- * @member {date} [spotExpirationTime] The time when the server farm expires.
- * Valid only if it is a spot server farm.
- * @member {date} [freeOfferExpirationTime] The time when the server farm free
- * offer expires.
- * @member {string} [resourceGroup] Resource group of the App Service plan.
- * @member {boolean} [reserved] If Linux app service plan true,
- * false otherwise. Default value: false .
- * @member {boolean} [isXenon] Obsolete: If Hyper-V container app service plan
- * true, false otherwise. Default value: false .
- * @member {boolean} [hyperV] If Hyper-V container app service plan
- * true, false otherwise. Default value: false .
- * @member {number} [targetWorkerCount] Scaling worker count.
- * @member {number} [targetWorkerSizeId] Scaling worker size ID.
- * @member {string} [provisioningState] Provisioning state of the App Service
- * Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled',
- * 'InProgress', 'Deleting'
- * @member {object} [sku]
- * @member {string} [sku.name] Name of the resource SKU.
- * @member {string} [sku.tier] Service tier of the resource SKU.
- * @member {string} [sku.size] Size specifier of the resource SKU.
- * @member {string} [sku.family] Family code of the resource SKU.
- * @member {number} [sku.capacity] Current number of instances assigned to the
- * resource.
- * @member {object} [sku.skuCapacity] Min, max, and default scale values of the
- * SKU.
- * @member {number} [sku.skuCapacity.minimum] Minimum number of workers for
- * this App Service plan SKU.
- * @member {number} [sku.skuCapacity.maximum] Maximum number of workers for
- * this App Service plan SKU.
- * @member {number} [sku.skuCapacity.default] Default number of workers for
- * this App Service plan SKU.
- * @member {string} [sku.skuCapacity.scaleType] Available scale configurations
- * for an App Service plan.
- * @member {array} [sku.locations] Locations of the SKU.
- * @member {array} [sku.capabilities] Capabilities of the SKU, e.g., is traffic
- * manager enabled?
- */
+*/
export interface AppServicePlan extends Resource {
+ /**
+ * Target worker tier assigned to the App Service plan.
+ */
workerTierName?: string;
+ /**
+ * App Service plan status. Possible values include: 'Ready', 'Pending', 'Creating'
+ */
readonly status?: string;
+ /**
+ * App Service plan subscription.
+ */
readonly subscription?: string;
+ /**
+ * App Service plan administration site.
+ */
adminSiteName?: string;
+ /**
+ * Specification for the App Service Environment to use for the App Service plan.
+ */
hostingEnvironmentProfile?: HostingEnvironmentProfile;
+ /**
+ * Maximum number of instances that can be assigned to this App Service plan.
+ */
readonly maximumNumberOfWorkers?: number;
+ /**
+ * Geographical location for the App Service plan.
+ */
readonly geoRegion?: string;
+ /**
+ * If true, apps assigned to this App Service plan can be scaled independently.
+ * If false, apps assigned to this App Service plan will scale to all instances of
+ * the plan.
+ */
perSiteScaling?: boolean;
+ /**
+ * Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
+ */
maximumElasticWorkerCount?: number;
+ /**
+ * Number of apps assigned to this App Service plan.
+ */
readonly numberOfSites?: number;
+ /**
+ * If true, this App Service Plan owns spot instances.
+ */
isSpot?: boolean;
+ /**
+ * The time when the server farm expires. Valid only if it is a spot server farm.
+ */
spotExpirationTime?: Date;
+ /**
+ * The time when the server farm free offer expires.
+ */
freeOfferExpirationTime?: Date;
+ /**
+ * Resource group of the App Service plan.
+ */
readonly resourceGroup?: string;
+ /**
+ * If Linux app service plan true, false otherwise.
+ */
reserved?: boolean;
+ /**
+ * Obsolete: If Hyper-V container app service plan true, false
+ * otherwise.
+ */
isXenon?: boolean;
+ /**
+ * If Hyper-V container app service plan true, false otherwise.
+ */
hyperV?: boolean;
+ /**
+ * Scaling worker count.
+ */
targetWorkerCount?: number;
+ /**
+ * Scaling worker size ID.
+ */
targetWorkerSizeId?: number;
+ /**
+ * Provisioning state of the App Service Environment. Possible values include: 'Succeeded',
+ * 'Failed', 'Canceled', 'InProgress', 'Deleting'
+ */
readonly provisioningState?: string;
sku?: SkuDescription;
}
/**
- * @class
- * Initializes a new instance of the DefaultErrorResponseErrorDetailsItem class.
- * @constructor
* Detailed errors.
- *
- * @member {string} [code] Standardized string to programmatically identify the
- * error.
- * @member {string} [message] Detailed error description and debugging
- * information.
- * @member {string} [target] Detailed error description and debugging
- * information.
- */
+*/
export interface DefaultErrorResponseErrorDetailsItem {
+ /**
+ * Standardized string to programmatically identify the error.
+ */
readonly code?: string;
+ /**
+ * Detailed error description and debugging information.
+ */
readonly message?: string;
+ /**
+ * Detailed error description and debugging information.
+ */
readonly target?: string;
}
/**
- * @class
- * Initializes a new instance of the DefaultErrorResponseError class.
- * @constructor
* Error model.
- *
- * @member {string} [code] Standardized string to programmatically identify the
- * error.
- * @member {string} [message] Detailed error description and debugging
- * information.
- * @member {string} [target] Detailed error description and debugging
- * information.
- * @member {array} [details]
- * @member {string} [innererror] More information to debug error.
- */
+*/
export interface DefaultErrorResponseError {
+ /**
+ * Standardized string to programmatically identify the error.
+ */
readonly code?: string;
+ /**
+ * Detailed error description and debugging information.
+ */
readonly message?: string;
+ /**
+ * Detailed error description and debugging information.
+ */
readonly target?: string;
details?: DefaultErrorResponseErrorDetailsItem[];
+ /**
+ * More information to debug error.
+ */
readonly innererror?: string;
}
/**
- * @class
- * Initializes a new instance of the DefaultErrorResponse class.
- * @constructor
* App Service error response.
- *
- * @member {object} [error] Error model.
- * @member {string} [error.code] Standardized string to programmatically
- * identify the error.
- * @member {string} [error.message] Detailed error description and debugging
- * information.
- * @member {string} [error.target] Detailed error description and debugging
- * information.
- * @member {array} [error.details]
- * @member {string} [error.innererror] More information to debug error.
- */
+*/
export interface DefaultErrorResponse {
+ /**
+ * Error model.
+ */
readonly error?: DefaultErrorResponseError;
}
/**
- * @class
- * Initializes a new instance of the NameIdentifier class.
- * @constructor
* Identifies an object.
- *
- * @member {string} [name] Name of the object.
- */
+*/
export interface NameIdentifier {
+ /**
+ * Name of the object.
+ */
name?: string;
}
/**
- * @class
- * Initializes a new instance of the LogSpecification class.
- * @constructor
* Log Definition of a single resource metric.
- *
- * @member {string} [name]
- * @member {string} [displayName]
- * @member {string} [blobDuration]
- */
+*/
export interface LogSpecification {
name?: string;
displayName?: string;
@@ -1971,32 +1886,17 @@ export interface LogSpecification {
}
/**
- * @class
- * Initializes a new instance of the MetricAvailability class.
- * @constructor
* Retention policy of a resource metric.
- *
- * @member {string} [timeGrain]
- * @member {string} [blobDuration]
- */
+*/
export interface MetricAvailability {
timeGrain?: string;
blobDuration?: string;
}
/**
- * @class
- * Initializes a new instance of the Dimension class.
- * @constructor
- * Dimension of a resource metric. For e.g. instance specific HTTP requests for
- * a web app,
+ * Dimension of a resource metric. For e.g. instance specific HTTP requests for a web app,
* where instance name is dimension of the metric HTTP request
- *
- * @member {string} [name]
- * @member {string} [displayName]
- * @member {string} [internalName]
- * @member {boolean} [toBeExportedForShoebox]
- */
+*/
export interface Dimension {
name?: string;
displayName?: string;
@@ -2005,27 +1905,8 @@ export interface Dimension {
}
/**
- * @class
- * Initializes a new instance of the MetricSpecification class.
- * @constructor
* Definition of a single resource metric.
- *
- * @member {string} [name]
- * @member {string} [displayName]
- * @member {string} [displayDescription]
- * @member {string} [unit]
- * @member {string} [aggregationType]
- * @member {boolean} [supportsInstanceLevelAggregation]
- * @member {boolean} [enableRegionalMdmAccount]
- * @member {string} [sourceMdmAccount]
- * @member {string} [sourceMdmNamespace]
- * @member {string} [metricFilterPattern]
- * @member {boolean} [fillGapWithZero]
- * @member {boolean} [isInternal]
- * @member {array} [dimensions]
- * @member {string} [category]
- * @member {array} [availabilities]
- */
+*/
export interface MetricSpecification {
name?: string;
displayName?: string;
@@ -2045,44 +1926,23 @@ export interface MetricSpecification {
}
/**
- * @class
- * Initializes a new instance of the ServiceSpecification class.
- * @constructor
* Resource metrics service provided by Microsoft.Insights resource provider.
- *
- * @member {array} [metricSpecifications]
- * @member {array} [logSpecifications]
- */
+*/
export interface ServiceSpecification {
metricSpecifications?: MetricSpecification[];
logSpecifications?: LogSpecification[];
}
/**
- * @class
- * Initializes a new instance of the CsmOperationDescriptionProperties class.
- * @constructor
* Properties available for a Microsoft.Web resource provider operation.
- *
- * @member {object} [serviceSpecification]
- * @member {array} [serviceSpecification.metricSpecifications]
- * @member {array} [serviceSpecification.logSpecifications]
- */
+*/
export interface CsmOperationDescriptionProperties {
serviceSpecification?: ServiceSpecification;
}
/**
- * @class
- * Initializes a new instance of the CsmOperationDisplay class.
- * @constructor
* Meta data about operation used for display in portal.
- *
- * @member {string} [provider]
- * @member {string} [resource]
- * @member {string} [operation]
- * @member {string} [description]
- */
+*/
export interface CsmOperationDisplay {
provider?: string;
resource?: string;
@@ -2091,23 +1951,8 @@ export interface CsmOperationDisplay {
}
/**
- * @class
- * Initializes a new instance of the CsmOperationDescription class.
- * @constructor
* Description of an operation available for Microsoft.Web resource provider.
- *
- * @member {string} [name]
- * @member {object} [display]
- * @member {string} [display.provider]
- * @member {string} [display.resource]
- * @member {string} [display.operation]
- * @member {string} [display.description]
- * @member {string} [origin]
- * @member {object} [properties]
- * @member {object} [properties.serviceSpecification]
- * @member {array} [properties.serviceSpecification.metricSpecifications]
- * @member {array} [properties.serviceSpecification.logSpecifications]
- */
+*/
export interface CsmOperationDescription {
name?: string;
display?: CsmOperationDisplay;
@@ -2116,2746 +1961,2887 @@ export interface CsmOperationDescription {
}
/**
- * @class
- * Initializes a new instance of the Address class.
- * @constructor
* Address information for domain registration.
- *
- * @member {string} address1 First line of an Address.
- * @member {string} [address2] The second line of the Address. Optional.
- * @member {string} city The city for the address.
- * @member {string} country The country for the address.
- * @member {string} postalCode The postal code for the address.
- * @member {string} state The state or province for the address.
- */
+*/
export interface Address {
+ /**
+ * First line of an Address.
+ */
address1: string;
+ /**
+ * The second line of the Address. Optional.
+ */
address2?: string;
+ /**
+ * The city for the address.
+ */
city: string;
+ /**
+ * The country for the address.
+ */
country: string;
+ /**
+ * The postal code for the address.
+ */
postalCode: string;
+ /**
+ * The state or province for the address.
+ */
state: string;
}
/**
- * @class
- * Initializes a new instance of the Contact class.
- * @constructor
- * Contact information for domain registration. If 'Domain Privacy' option is
- * not selected then the contact information is made publicly available through
- * the Whois
+ * Contact information for domain registration. If 'Domain Privacy' option is not selected then the
+ * contact information is made publicly available through the Whois
* directories as per ICANN requirements.
- *
- * @member {object} [addressMailing] Mailing address.
- * @member {string} [addressMailing.address1] First line of an Address.
- * @member {string} [addressMailing.address2] The second line of the Address.
- * Optional.
- * @member {string} [addressMailing.city] The city for the address.
- * @member {string} [addressMailing.country] The country for the address.
- * @member {string} [addressMailing.postalCode] The postal code for the
- * address.
- * @member {string} [addressMailing.state] The state or province for the
- * address.
- * @member {string} email Email address.
- * @member {string} [fax] Fax number.
- * @member {string} [jobTitle] Job title.
- * @member {string} nameFirst First name.
- * @member {string} nameLast Last name.
- * @member {string} [nameMiddle] Middle name.
- * @member {string} [organization] Organization contact belongs to.
- * @member {string} phone Phone number.
- */
+*/
export interface Contact {
+ /**
+ * Mailing address.
+ */
addressMailing?: Address;
+ /**
+ * Email address.
+ */
email: string;
+ /**
+ * Fax number.
+ */
fax?: string;
+ /**
+ * Job title.
+ */
jobTitle?: string;
+ /**
+ * First name.
+ */
nameFirst: string;
+ /**
+ * Last name.
+ */
nameLast: string;
+ /**
+ * Middle name.
+ */
nameMiddle?: string;
+ /**
+ * Organization contact belongs to.
+ */
organization?: string;
+ /**
+ * Phone number.
+ */
phone: string;
}
/**
- * @class
- * Initializes a new instance of the HostName class.
- * @constructor
* Details of a hostname derived from a domain.
- *
- * @member {string} [name] Name of the hostname.
- * @member {array} [siteNames] List of apps the hostname is assigned to. This
- * list will have more than one app only if the hostname is pointing to a
- * Traffic Manager.
- * @member {string} [azureResourceName] Name of the Azure resource the hostname
- * is assigned to. If it is assigned to a Traffic Manager then it will be the
- * Traffic Manager name otherwise it will be the app name.
- * @member {string} [azureResourceType] Type of the Azure resource the hostname
- * is assigned to. Possible values include: 'Website', 'TrafficManager'
- * @member {string} [customHostNameDnsRecordType] Type of the DNS record.
- * Possible values include: 'CName', 'A'
- * @member {string} [hostNameType] Type of the hostname. Possible values
- * include: 'Verified', 'Managed'
- */
+*/
export interface HostName {
+ /**
+ * Name of the hostname.
+ */
name?: string;
+ /**
+ * List of apps the hostname is assigned to. This list will have more than one app only if the
+ * hostname is pointing to a Traffic Manager.
+ */
siteNames?: string[];
+ /**
+ * Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager
+ * then it will be the Traffic Manager name otherwise it will be the app name.
+ */
azureResourceName?: string;
+ /**
+ * Type of the Azure resource the hostname is assigned to. Possible values include: 'Website',
+ * 'TrafficManager'
+ */
azureResourceType?: string;
+ /**
+ * Type of the DNS record. Possible values include: 'CName', 'A'
+ */
customHostNameDnsRecordType?: string;
+ /**
+ * Type of the hostname. Possible values include: 'Verified', 'Managed'
+ */
hostNameType?: string;
}
/**
- * @class
- * Initializes a new instance of the DomainPurchaseConsent class.
- * @constructor
- * Domain purchase consent object, representing acceptance of applicable legal
- * agreements.
- *
- * @member {array} [agreementKeys] List of applicable legal agreement keys.
- * This list can be retrieved using ListLegalAgreements API under
- * TopLevelDomain resource.
- * @member {string} [agreedBy] Client IP address.
- * @member {date} [agreedAt] Timestamp when the agreements were accepted.
- */
+ * Domain purchase consent object, representing acceptance of applicable legal agreements.
+*/
export interface DomainPurchaseConsent {
+ /**
+ * List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements
+ * API under TopLevelDomain resource.
+ */
agreementKeys?: string[];
+ /**
+ * Client IP address.
+ */
agreedBy?: string;
+ /**
+ * Timestamp when the agreements were accepted.
+ */
agreedAt?: Date;
}
/**
- * @class
- * Initializes a new instance of the Domain class.
- * @constructor
* Information about a domain.
- *
- * @member {object} contactAdmin Administrative contact.
- * @member {object} [contactAdmin.addressMailing] Mailing address.
- * @member {string} [contactAdmin.addressMailing.address1] First line of an
- * Address.
- * @member {string} [contactAdmin.addressMailing.address2] The second line of
- * the Address. Optional.
- * @member {string} [contactAdmin.addressMailing.city] The city for the
- * address.
- * @member {string} [contactAdmin.addressMailing.country] The country for the
- * address.
- * @member {string} [contactAdmin.addressMailing.postalCode] The postal code
- * for the address.
- * @member {string} [contactAdmin.addressMailing.state] The state or province
- * for the address.
- * @member {string} [contactAdmin.email] Email address.
- * @member {string} [contactAdmin.fax] Fax number.
- * @member {string} [contactAdmin.jobTitle] Job title.
- * @member {string} [contactAdmin.nameFirst] First name.
- * @member {string} [contactAdmin.nameLast] Last name.
- * @member {string} [contactAdmin.nameMiddle] Middle name.
- * @member {string} [contactAdmin.organization] Organization contact belongs
- * to.
- * @member {string} [contactAdmin.phone] Phone number.
- * @member {object} contactBilling Billing contact.
- * @member {object} [contactBilling.addressMailing] Mailing address.
- * @member {string} [contactBilling.addressMailing.address1] First line of an
- * Address.
- * @member {string} [contactBilling.addressMailing.address2] The second line of
- * the Address. Optional.
- * @member {string} [contactBilling.addressMailing.city] The city for the
- * address.
- * @member {string} [contactBilling.addressMailing.country] The country for the
- * address.
- * @member {string} [contactBilling.addressMailing.postalCode] The postal code
- * for the address.
- * @member {string} [contactBilling.addressMailing.state] The state or province
- * for the address.
- * @member {string} [contactBilling.email] Email address.
- * @member {string} [contactBilling.fax] Fax number.
- * @member {string} [contactBilling.jobTitle] Job title.
- * @member {string} [contactBilling.nameFirst] First name.
- * @member {string} [contactBilling.nameLast] Last name.
- * @member {string} [contactBilling.nameMiddle] Middle name.
- * @member {string} [contactBilling.organization] Organization contact belongs
- * to.
- * @member {string} [contactBilling.phone] Phone number.
- * @member {object} contactRegistrant Registrant contact.
- * @member {object} [contactRegistrant.addressMailing] Mailing address.
- * @member {string} [contactRegistrant.addressMailing.address1] First line of
- * an Address.
- * @member {string} [contactRegistrant.addressMailing.address2] The second line
- * of the Address. Optional.
- * @member {string} [contactRegistrant.addressMailing.city] The city for the
- * address.
- * @member {string} [contactRegistrant.addressMailing.country] The country for
- * the address.
- * @member {string} [contactRegistrant.addressMailing.postalCode] The postal
- * code for the address.
- * @member {string} [contactRegistrant.addressMailing.state] The state or
- * province for the address.
- * @member {string} [contactRegistrant.email] Email address.
- * @member {string} [contactRegistrant.fax] Fax number.
- * @member {string} [contactRegistrant.jobTitle] Job title.
- * @member {string} [contactRegistrant.nameFirst] First name.
- * @member {string} [contactRegistrant.nameLast] Last name.
- * @member {string} [contactRegistrant.nameMiddle] Middle name.
- * @member {string} [contactRegistrant.organization] Organization contact
- * belongs to.
- * @member {string} [contactRegistrant.phone] Phone number.
- * @member {object} contactTech Technical contact.
- * @member {object} [contactTech.addressMailing] Mailing address.
- * @member {string} [contactTech.addressMailing.address1] First line of an
- * Address.
- * @member {string} [contactTech.addressMailing.address2] The second line of
- * the Address. Optional.
- * @member {string} [contactTech.addressMailing.city] The city for the address.
- * @member {string} [contactTech.addressMailing.country] The country for the
- * address.
- * @member {string} [contactTech.addressMailing.postalCode] The postal code for
- * the address.
- * @member {string} [contactTech.addressMailing.state] The state or province
- * for the address.
- * @member {string} [contactTech.email] Email address.
- * @member {string} [contactTech.fax] Fax number.
- * @member {string} [contactTech.jobTitle] Job title.
- * @member {string} [contactTech.nameFirst] First name.
- * @member {string} [contactTech.nameLast] Last name.
- * @member {string} [contactTech.nameMiddle] Middle name.
- * @member {string} [contactTech.organization] Organization contact belongs to.
- * @member {string} [contactTech.phone] Phone number.
- * @member {string} [registrationStatus] Domain registration status. Possible
- * values include: 'Active', 'Awaiting', 'Cancelled', 'Confiscated',
- * 'Disabled', 'Excluded', 'Expired', 'Failed', 'Held', 'Locked', 'Parked',
- * 'Pending', 'Reserved', 'Reverted', 'Suspended', 'Transferred', 'Unknown',
- * 'Unlocked', 'Unparked', 'Updated', 'JsonConverterFailed'
- * @member {string} [provisioningState] Domain provisioning state. Possible
- * values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting'
- * @member {array} [nameServers] Name servers.
- * @member {boolean} [privacy] true if domain privacy is enabled
- * for this domain; otherwise, false.
- * @member {date} [createdTime] Domain creation timestamp.
- * @member {date} [expirationTime] Domain expiration timestamp.
- * @member {date} [lastRenewedTime] Timestamp when the domain was renewed last
- * time.
- * @member {boolean} [autoRenew] true if the domain should be
- * automatically renewed; otherwise, false. Default value: true .
- * @member {boolean} [readyForDnsRecordManagement] true if Azure
- * can assign this domain to App Service apps; otherwise, false.
- * This value will be true if domain registration status is active
- * and
- * it is hosted on name servers Azure has programmatic access to.
- * @member {array} [managedHostNames] All hostnames derived from the domain and
- * assigned to Azure resources.
- * @member {object} consent Legal agreement consent.
- * @member {array} [consent.agreementKeys] List of applicable legal agreement
- * keys. This list can be retrieved using ListLegalAgreements API under
- * TopLevelDomain resource.
- * @member {string} [consent.agreedBy] Client IP address.
- * @member {date} [consent.agreedAt] Timestamp when the agreements were
- * accepted.
- * @member {array} [domainNotRenewableReasons] Reasons why domain is not
- * renewable.
- * @member {string} [dnsType] Current DNS type. Possible values include:
- * 'AzureDns', 'DefaultDomainRegistrarDns'
- * @member {string} [dnsZoneId] Azure DNS Zone to use
- * @member {string} [targetDnsType] Target DNS type (would be used for
- * migration). Possible values include: 'AzureDns', 'DefaultDomainRegistrarDns'
- * @member {string} [authCode]
- */
+*/
export interface Domain extends Resource {
+ /**
+ * Administrative contact.
+ */
contactAdmin: Contact;
+ /**
+ * Billing contact.
+ */
contactBilling: Contact;
+ /**
+ * Registrant contact.
+ */
contactRegistrant: Contact;
+ /**
+ * Technical contact.
+ */
contactTech: Contact;
+ /**
+ * Domain registration status. Possible values include: 'Active', 'Awaiting', 'Cancelled',
+ * 'Confiscated', 'Disabled', 'Excluded', 'Expired', 'Failed', 'Held', 'Locked', 'Parked',
+ * 'Pending', 'Reserved', 'Reverted', 'Suspended', 'Transferred', 'Unknown', 'Unlocked',
+ * 'Unparked', 'Updated', 'JsonConverterFailed'
+ */
readonly registrationStatus?: string;
+ /**
+ * Domain provisioning state. Possible values include: 'Succeeded', 'Failed', 'Canceled',
+ * 'InProgress', 'Deleting'
+ */
readonly provisioningState?: string;
+ /**
+ * Name servers.
+ */
readonly nameServers?: string[];
+ /**
+ * true if domain privacy is enabled for this domain; otherwise, false.
+ */
privacy?: boolean;
+ /**
+ * Domain creation timestamp.
+ */
readonly createdTime?: Date;
+ /**
+ * Domain expiration timestamp.
+ */
readonly expirationTime?: Date;
+ /**
+ * Timestamp when the domain was renewed last time.
+ */
readonly lastRenewedTime?: Date;
+ /**
+ * true if the domain should be automatically renewed; otherwise,
+ * false.
+ */
autoRenew?: boolean;
+ /**
+ * true if Azure can assign this domain to App Service apps; otherwise,
+ * false. This value will be true if domain registration status is
+ * active and
+ * it is hosted on name servers Azure has programmatic access to.
+ */
readonly readyForDnsRecordManagement?: boolean;
+ /**
+ * All hostnames derived from the domain and assigned to Azure resources.
+ */
readonly managedHostNames?: HostName[];
+ /**
+ * Legal agreement consent.
+ */
consent: DomainPurchaseConsent;
+ /**
+ * Reasons why domain is not renewable.
+ */
readonly domainNotRenewableReasons?: string[];
+ /**
+ * Current DNS type. Possible values include: 'AzureDns', 'DefaultDomainRegistrarDns'
+ */
dnsType?: string;
+ /**
+ * Azure DNS Zone to use
+ */
dnsZoneId?: string;
+ /**
+ * Target DNS type (would be used for migration). Possible values include: 'AzureDns',
+ * 'DefaultDomainRegistrarDns'
+ */
targetDnsType?: string;
authCode?: string;
}
/**
- * @class
- * Initializes a new instance of the DomainAvailablilityCheckResult class.
- * @constructor
* Domain availablility check result.
- *
- * @member {string} [name] Name of the domain.
- * @member {boolean} [available] true if domain can be purchased
- * using CreateDomain API; otherwise, false.
- * @member {string} [domainType] Valid values are Regular domain: Azure will
- * charge the full price of domain registration, SoftDeleted: Purchasing this
- * domain will simply restore it and this operation will not cost anything.
- * Possible values include: 'Regular', 'SoftDeleted'
- */
+*/
export interface DomainAvailablilityCheckResult {
+ /**
+ * Name of the domain.
+ */
name?: string;
+ /**
+ * true if domain can be purchased using CreateDomain API; otherwise,
+ * false.
+ */
available?: boolean;
+ /**
+ * Valid values are Regular domain: Azure will charge the full price of domain registration,
+ * SoftDeleted: Purchasing this domain will simply restore it and this operation will not cost
+ * anything. Possible values include: 'Regular', 'SoftDeleted'
+ */
domainType?: string;
}
/**
- * @class
- * Initializes a new instance of the DomainControlCenterSsoRequest class.
- * @constructor
* Single sign-on request information for domain management.
- *
- * @member {string} [url] URL where the single sign-on request is to be made.
- * @member {string} [postParameterKey] Post parameter key.
- * @member {string} [postParameterValue] Post parameter value. Client should
- * use 'application/x-www-form-urlencoded' encoding for this value.
- */
+*/
export interface DomainControlCenterSsoRequest {
+ /**
+ * URL where the single sign-on request is to be made.
+ */
readonly url?: string;
+ /**
+ * Post parameter key.
+ */
readonly postParameterKey?: string;
+ /**
+ * Post parameter value. Client should use 'application/x-www-form-urlencoded' encoding for this
+ * value.
+ */
readonly postParameterValue?: string;
}
/**
- * @class
- * Initializes a new instance of the DomainOwnershipIdentifier class.
- * @constructor
* Domain ownership Identifier.
- *
- * @member {string} [ownershipId] Ownership Id.
- */
+*/
export interface DomainOwnershipIdentifier extends ProxyOnlyResource {
+ /**
+ * Ownership Id.
+ */
ownershipId?: string;
}
/**
- * @class
- * Initializes a new instance of the DomainPatchResource class.
- * @constructor
* ARM resource for a domain.
- *
- * @member {object} contactAdmin Administrative contact.
- * @member {object} [contactAdmin.addressMailing] Mailing address.
- * @member {string} [contactAdmin.addressMailing.address1] First line of an
- * Address.
- * @member {string} [contactAdmin.addressMailing.address2] The second line of
- * the Address. Optional.
- * @member {string} [contactAdmin.addressMailing.city] The city for the
- * address.
- * @member {string} [contactAdmin.addressMailing.country] The country for the
- * address.
- * @member {string} [contactAdmin.addressMailing.postalCode] The postal code
- * for the address.
- * @member {string} [contactAdmin.addressMailing.state] The state or province
- * for the address.
- * @member {string} [contactAdmin.email] Email address.
- * @member {string} [contactAdmin.fax] Fax number.
- * @member {string} [contactAdmin.jobTitle] Job title.
- * @member {string} [contactAdmin.nameFirst] First name.
- * @member {string} [contactAdmin.nameLast] Last name.
- * @member {string} [contactAdmin.nameMiddle] Middle name.
- * @member {string} [contactAdmin.organization] Organization contact belongs
- * to.
- * @member {string} [contactAdmin.phone] Phone number.
- * @member {object} contactBilling Billing contact.
- * @member {object} [contactBilling.addressMailing] Mailing address.
- * @member {string} [contactBilling.addressMailing.address1] First line of an
- * Address.
- * @member {string} [contactBilling.addressMailing.address2] The second line of
- * the Address. Optional.
- * @member {string} [contactBilling.addressMailing.city] The city for the
- * address.
- * @member {string} [contactBilling.addressMailing.country] The country for the
- * address.
- * @member {string} [contactBilling.addressMailing.postalCode] The postal code
- * for the address.
- * @member {string} [contactBilling.addressMailing.state] The state or province
- * for the address.
- * @member {string} [contactBilling.email] Email address.
- * @member {string} [contactBilling.fax] Fax number.
- * @member {string} [contactBilling.jobTitle] Job title.
- * @member {string} [contactBilling.nameFirst] First name.
- * @member {string} [contactBilling.nameLast] Last name.
- * @member {string} [contactBilling.nameMiddle] Middle name.
- * @member {string} [contactBilling.organization] Organization contact belongs
- * to.
- * @member {string} [contactBilling.phone] Phone number.
- * @member {object} contactRegistrant Registrant contact.
- * @member {object} [contactRegistrant.addressMailing] Mailing address.
- * @member {string} [contactRegistrant.addressMailing.address1] First line of
- * an Address.
- * @member {string} [contactRegistrant.addressMailing.address2] The second line
- * of the Address. Optional.
- * @member {string} [contactRegistrant.addressMailing.city] The city for the
- * address.
- * @member {string} [contactRegistrant.addressMailing.country] The country for
- * the address.
- * @member {string} [contactRegistrant.addressMailing.postalCode] The postal
- * code for the address.
- * @member {string} [contactRegistrant.addressMailing.state] The state or
- * province for the address.
- * @member {string} [contactRegistrant.email] Email address.
- * @member {string} [contactRegistrant.fax] Fax number.
- * @member {string} [contactRegistrant.jobTitle] Job title.
- * @member {string} [contactRegistrant.nameFirst] First name.
- * @member {string} [contactRegistrant.nameLast] Last name.
- * @member {string} [contactRegistrant.nameMiddle] Middle name.
- * @member {string} [contactRegistrant.organization] Organization contact
- * belongs to.
- * @member {string} [contactRegistrant.phone] Phone number.
- * @member {object} contactTech Technical contact.
- * @member {object} [contactTech.addressMailing] Mailing address.
- * @member {string} [contactTech.addressMailing.address1] First line of an
- * Address.
- * @member {string} [contactTech.addressMailing.address2] The second line of
- * the Address. Optional.
- * @member {string} [contactTech.addressMailing.city] The city for the address.
- * @member {string} [contactTech.addressMailing.country] The country for the
- * address.
- * @member {string} [contactTech.addressMailing.postalCode] The postal code for
- * the address.
- * @member {string} [contactTech.addressMailing.state] The state or province
- * for the address.
- * @member {string} [contactTech.email] Email address.
- * @member {string} [contactTech.fax] Fax number.
- * @member {string} [contactTech.jobTitle] Job title.
- * @member {string} [contactTech.nameFirst] First name.
- * @member {string} [contactTech.nameLast] Last name.
- * @member {string} [contactTech.nameMiddle] Middle name.
- * @member {string} [contactTech.organization] Organization contact belongs to.
- * @member {string} [contactTech.phone] Phone number.
- * @member {string} [registrationStatus] Domain registration status. Possible
- * values include: 'Active', 'Awaiting', 'Cancelled', 'Confiscated',
- * 'Disabled', 'Excluded', 'Expired', 'Failed', 'Held', 'Locked', 'Parked',
- * 'Pending', 'Reserved', 'Reverted', 'Suspended', 'Transferred', 'Unknown',
- * 'Unlocked', 'Unparked', 'Updated', 'JsonConverterFailed'
- * @member {string} [provisioningState] Domain provisioning state. Possible
- * values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting'
- * @member {array} [nameServers] Name servers.
- * @member {boolean} [privacy] true if domain privacy is enabled
- * for this domain; otherwise, false.
- * @member {date} [createdTime] Domain creation timestamp.
- * @member {date} [expirationTime] Domain expiration timestamp.
- * @member {date} [lastRenewedTime] Timestamp when the domain was renewed last
- * time.
- * @member {boolean} [autoRenew] true if the domain should be
- * automatically renewed; otherwise, false. Default value: true .
- * @member {boolean} [readyForDnsRecordManagement] true if Azure
- * can assign this domain to App Service apps; otherwise, false.
- * This value will be true if domain registration status is active
- * and
- * it is hosted on name servers Azure has programmatic access to.
- * @member {array} [managedHostNames] All hostnames derived from the domain and
- * assigned to Azure resources.
- * @member {object} consent Legal agreement consent.
- * @member {array} [consent.agreementKeys] List of applicable legal agreement
- * keys. This list can be retrieved using ListLegalAgreements API under
- * TopLevelDomain resource.
- * @member {string} [consent.agreedBy] Client IP address.
- * @member {date} [consent.agreedAt] Timestamp when the agreements were
- * accepted.
- * @member {array} [domainNotRenewableReasons] Reasons why domain is not
- * renewable.
- * @member {string} [dnsType] Current DNS type. Possible values include:
- * 'AzureDns', 'DefaultDomainRegistrarDns'
- * @member {string} [dnsZoneId] Azure DNS Zone to use
- * @member {string} [targetDnsType] Target DNS type (would be used for
- * migration). Possible values include: 'AzureDns', 'DefaultDomainRegistrarDns'
- * @member {string} [authCode]
- */
+*/
export interface DomainPatchResource extends ProxyOnlyResource {
+ /**
+ * Administrative contact.
+ */
contactAdmin: Contact;
+ /**
+ * Billing contact.
+ */
contactBilling: Contact;
+ /**
+ * Registrant contact.
+ */
contactRegistrant: Contact;
+ /**
+ * Technical contact.
+ */
contactTech: Contact;
+ /**
+ * Domain registration status. Possible values include: 'Active', 'Awaiting', 'Cancelled',
+ * 'Confiscated', 'Disabled', 'Excluded', 'Expired', 'Failed', 'Held', 'Locked', 'Parked',
+ * 'Pending', 'Reserved', 'Reverted', 'Suspended', 'Transferred', 'Unknown', 'Unlocked',
+ * 'Unparked', 'Updated', 'JsonConverterFailed'
+ */
readonly registrationStatus?: string;
+ /**
+ * Domain provisioning state. Possible values include: 'Succeeded', 'Failed', 'Canceled',
+ * 'InProgress', 'Deleting'
+ */
readonly provisioningState?: string;
+ /**
+ * Name servers.
+ */
readonly nameServers?: string[];
+ /**
+ * true if domain privacy is enabled for this domain; otherwise, false.
+ */
privacy?: boolean;
+ /**
+ * Domain creation timestamp.
+ */
readonly createdTime?: Date;
+ /**
+ * Domain expiration timestamp.
+ */
readonly expirationTime?: Date;
+ /**
+ * Timestamp when the domain was renewed last time.
+ */
readonly lastRenewedTime?: Date;
+ /**
+ * true if the domain should be automatically renewed; otherwise,
+ * false.
+ */
autoRenew?: boolean;
+ /**
+ * true if Azure can assign this domain to App Service apps; otherwise,
+ * false. This value will be true if domain registration status is
+ * active and
+ * it is hosted on name servers Azure has programmatic access to.
+ */
readonly readyForDnsRecordManagement?: boolean;
+ /**
+ * All hostnames derived from the domain and assigned to Azure resources.
+ */
readonly managedHostNames?: HostName[];
+ /**
+ * Legal agreement consent.
+ */
consent: DomainPurchaseConsent;
+ /**
+ * Reasons why domain is not renewable.
+ */
readonly domainNotRenewableReasons?: string[];
+ /**
+ * Current DNS type. Possible values include: 'AzureDns', 'DefaultDomainRegistrarDns'
+ */
dnsType?: string;
+ /**
+ * Azure DNS Zone to use
+ */
dnsZoneId?: string;
+ /**
+ * Target DNS type (would be used for migration). Possible values include: 'AzureDns',
+ * 'DefaultDomainRegistrarDns'
+ */
targetDnsType?: string;
authCode?: string;
}
/**
- * @class
- * Initializes a new instance of the DomainRecommendationSearchParameters class.
- * @constructor
* Domain recommendation search parameters.
- *
- * @member {string} [keywords] Keywords to be used for generating domain
- * recommendations.
- * @member {number} [maxDomainRecommendations] Maximum number of
- * recommendations.
- */
+*/
export interface DomainRecommendationSearchParameters {
+ /**
+ * Keywords to be used for generating domain recommendations.
+ */
keywords?: string;
+ /**
+ * Maximum number of recommendations.
+ */
maxDomainRecommendations?: number;
}
/**
- * @class
- * Initializes a new instance of the TldLegalAgreement class.
- * @constructor
* Legal agreement for a top level domain.
- *
- * @member {string} agreementKey Unique identifier for the agreement.
- * @member {string} title Agreement title.
- * @member {string} content Agreement details.
- * @member {string} [url] URL where a copy of the agreement details is hosted.
- */
+*/
export interface TldLegalAgreement {
+ /**
+ * Unique identifier for the agreement.
+ */
agreementKey: string;
+ /**
+ * Agreement title.
+ */
title: string;
+ /**
+ * Agreement details.
+ */
content: string;
+ /**
+ * URL where a copy of the agreement details is hosted.
+ */
url?: string;
}
/**
- * @class
- * Initializes a new instance of the TopLevelDomain class.
- * @constructor
* A top level domain object.
- *
- * @member {boolean} [privacy] If true, then the top level domain
- * supports domain privacy; otherwise, false.
- */
+*/
export interface TopLevelDomain extends ProxyOnlyResource {
+ /**
+ * If true, then the top level domain supports domain privacy; otherwise,
+ * false.
+ */
privacy?: boolean;
}
/**
- * @class
- * Initializes a new instance of the TopLevelDomainAgreementOption class.
- * @constructor
* Options for retrieving the list of top level domain legal agreements.
- *
- * @member {boolean} [includePrivacy] If true, then the list of
- * agreements will include agreements for domain privacy as well; otherwise,
- * false.
- * @member {boolean} [forTransfer] If true, then the list of
- * agreements will include agreements for domain transfer as well; otherwise,
- * false.
- */
+*/
export interface TopLevelDomainAgreementOption {
+ /**
+ * If true, then the list of agreements will include agreements for domain privacy
+ * as well; otherwise, false.
+ */
includePrivacy?: boolean;
+ /**
+ * If true, then the list of agreements will include agreements for domain transfer
+ * as well; otherwise, false.
+ */
forTransfer?: boolean;
}
/**
- * @class
- * Initializes a new instance of the Certificate class.
- * @constructor
* SSL certificate for an app.
- *
- * @member {string} [friendlyName] Friendly name of the certificate.
- * @member {string} [subjectName] Subject name of the certificate.
- * @member {array} [hostNames] Host names the certificate applies to.
- * @member {buffer} [pfxBlob] Pfx blob.
- * @member {string} [siteName] App name.
- * @member {string} [selfLink] Self link.
- * @member {string} [issuer] Certificate issuer.
- * @member {date} [issueDate] Certificate issue Date.
- * @member {date} [expirationDate] Certificate expriration date.
- * @member {string} password Certificate password.
- * @member {string} [thumbprint] Certificate thumbprint.
- * @member {boolean} [valid] Is the certificate valid?.
- * @member {buffer} [cerBlob] Raw bytes of .cer file
- * @member {string} [publicKeyHash] Public key hash.
- * @member {object} [hostingEnvironmentProfile] Specification for the App
- * Service Environment to use for the certificate.
- * @member {string} [hostingEnvironmentProfile.id] Resource ID of the App
- * Service Environment.
- * @member {string} [hostingEnvironmentProfile.name] Name of the App Service
- * Environment.
- * @member {string} [hostingEnvironmentProfile.type] Resource type of the App
- * Service Environment.
- * @member {string} [keyVaultId] Key Vault Csm resource Id.
- * @member {string} [keyVaultSecretName] Key Vault secret name.
- * @member {string} [keyVaultSecretStatus] Status of the Key Vault secret.
- * Possible values include: 'Initialized', 'WaitingOnCertificateOrder',
- * 'Succeeded', 'CertificateOrderFailed', 'OperationNotPermittedOnKeyVault',
- * 'AzureServiceUnauthorizedToAccessKeyVault', 'KeyVaultDoesNotExist',
- * 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey',
- * 'Unknown'
- * @member {string} [serverFarmId] Resource ID of the associated App Service
- * plan, formatted as:
- * "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
- */
+*/
export interface Certificate extends Resource {
+ /**
+ * Friendly name of the certificate.
+ */
readonly friendlyName?: string;
+ /**
+ * Subject name of the certificate.
+ */
readonly subjectName?: string;
+ /**
+ * Host names the certificate applies to.
+ */
hostNames?: string[];
+ /**
+ * Pfx blob.
+ */
pfxBlob?: Buffer;
+ /**
+ * App name.
+ */
readonly siteName?: string;
+ /**
+ * Self link.
+ */
readonly selfLink?: string;
+ /**
+ * Certificate issuer.
+ */
readonly issuer?: string;
+ /**
+ * Certificate issue Date.
+ */
readonly issueDate?: Date;
+ /**
+ * Certificate expriration date.
+ */
readonly expirationDate?: Date;
+ /**
+ * Certificate password.
+ */
password: string;
+ /**
+ * Certificate thumbprint.
+ */
readonly thumbprint?: string;
+ /**
+ * Is the certificate valid?.
+ */
readonly valid?: boolean;
+ /**
+ * Raw bytes of .cer file
+ */
readonly cerBlob?: Buffer;
+ /**
+ * Public key hash.
+ */
readonly publicKeyHash?: string;
+ /**
+ * Specification for the App Service Environment to use for the certificate.
+ */
readonly hostingEnvironmentProfile?: HostingEnvironmentProfile;
+ /**
+ * Key Vault Csm resource Id.
+ */
keyVaultId?: string;
+ /**
+ * Key Vault secret name.
+ */
keyVaultSecretName?: string;
+ /**
+ * Status of the Key Vault secret. Possible values include: 'Initialized',
+ * 'WaitingOnCertificateOrder', 'Succeeded', 'CertificateOrderFailed',
+ * 'OperationNotPermittedOnKeyVault', 'AzureServiceUnauthorizedToAccessKeyVault',
+ * 'KeyVaultDoesNotExist', 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey',
+ * 'Unknown'
+ */
readonly keyVaultSecretStatus?: string;
+ /**
+ * Resource ID of the associated App Service plan, formatted as:
+ * "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
+ */
serverFarmId?: string;
}
/**
- * @class
- * Initializes a new instance of the CertificatePatchResource class.
- * @constructor
* ARM resource for a certificate.
- *
- * @member {string} [friendlyName] Friendly name of the certificate.
- * @member {string} [subjectName] Subject name of the certificate.
- * @member {array} [hostNames] Host names the certificate applies to.
- * @member {buffer} [pfxBlob] Pfx blob.
- * @member {string} [siteName] App name.
- * @member {string} [selfLink] Self link.
- * @member {string} [issuer] Certificate issuer.
- * @member {date} [issueDate] Certificate issue Date.
- * @member {date} [expirationDate] Certificate expriration date.
- * @member {string} password Certificate password.
- * @member {string} [thumbprint] Certificate thumbprint.
- * @member {boolean} [valid] Is the certificate valid?.
- * @member {buffer} [cerBlob] Raw bytes of .cer file
- * @member {string} [publicKeyHash] Public key hash.
- * @member {object} [hostingEnvironmentProfile] Specification for the App
- * Service Environment to use for the certificate.
- * @member {string} [hostingEnvironmentProfile.id] Resource ID of the App
- * Service Environment.
- * @member {string} [hostingEnvironmentProfile.name] Name of the App Service
- * Environment.
- * @member {string} [hostingEnvironmentProfile.type] Resource type of the App
- * Service Environment.
- * @member {string} [keyVaultId] Key Vault Csm resource Id.
- * @member {string} [keyVaultSecretName] Key Vault secret name.
- * @member {string} [keyVaultSecretStatus] Status of the Key Vault secret.
- * Possible values include: 'Initialized', 'WaitingOnCertificateOrder',
- * 'Succeeded', 'CertificateOrderFailed', 'OperationNotPermittedOnKeyVault',
- * 'AzureServiceUnauthorizedToAccessKeyVault', 'KeyVaultDoesNotExist',
- * 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey',
- * 'Unknown'
- * @member {string} [serverFarmId] Resource ID of the associated App Service
- * plan, formatted as:
- * "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
- */
+*/
export interface CertificatePatchResource extends ProxyOnlyResource {
+ /**
+ * Friendly name of the certificate.
+ */
readonly friendlyName?: string;
+ /**
+ * Subject name of the certificate.
+ */
readonly subjectName?: string;
+ /**
+ * Host names the certificate applies to.
+ */
hostNames?: string[];
+ /**
+ * Pfx blob.
+ */
pfxBlob?: Buffer;
+ /**
+ * App name.
+ */
readonly siteName?: string;
+ /**
+ * Self link.
+ */
readonly selfLink?: string;
+ /**
+ * Certificate issuer.
+ */
readonly issuer?: string;
+ /**
+ * Certificate issue Date.
+ */
readonly issueDate?: Date;
+ /**
+ * Certificate expriration date.
+ */
readonly expirationDate?: Date;
+ /**
+ * Certificate password.
+ */
password: string;
+ /**
+ * Certificate thumbprint.
+ */
readonly thumbprint?: string;
+ /**
+ * Is the certificate valid?.
+ */
readonly valid?: boolean;
+ /**
+ * Raw bytes of .cer file
+ */
readonly cerBlob?: Buffer;
+ /**
+ * Public key hash.
+ */
readonly publicKeyHash?: string;
+ /**
+ * Specification for the App Service Environment to use for the certificate.
+ */
readonly hostingEnvironmentProfile?: HostingEnvironmentProfile;
+ /**
+ * Key Vault Csm resource Id.
+ */
keyVaultId?: string;
+ /**
+ * Key Vault secret name.
+ */
keyVaultSecretName?: string;
+ /**
+ * Status of the Key Vault secret. Possible values include: 'Initialized',
+ * 'WaitingOnCertificateOrder', 'Succeeded', 'CertificateOrderFailed',
+ * 'OperationNotPermittedOnKeyVault', 'AzureServiceUnauthorizedToAccessKeyVault',
+ * 'KeyVaultDoesNotExist', 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey',
+ * 'Unknown'
+ */
readonly keyVaultSecretStatus?: string;
+ /**
+ * Resource ID of the associated App Service plan, formatted as:
+ * "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
+ */
serverFarmId?: string;
}
/**
- * @class
- * Initializes a new instance of the VirtualNetworkProfile class.
- * @constructor
* Specification for using a Virtual Network.
- *
- * @member {string} [id] Resource id of the Virtual Network.
- * @member {string} [name] Name of the Virtual Network (read-only).
- * @member {string} [type] Resource type of the Virtual Network (read-only).
- * @member {string} [subnet] Subnet within the Virtual Network.
- */
+*/
export interface VirtualNetworkProfile {
+ /**
+ * Resource id of the Virtual Network.
+ */
id?: string;
+ /**
+ * Name of the Virtual Network (read-only).
+ */
readonly name?: string;
+ /**
+ * Resource type of the Virtual Network (read-only).
+ */
readonly type?: string;
+ /**
+ * Subnet within the Virtual Network.
+ */
subnet?: string;
}
/**
- * @class
- * Initializes a new instance of the WorkerPool class.
- * @constructor
* Worker pool of an App Service Environment.
- *
- * @member {number} [workerSizeId] Worker size ID for referencing this worker
- * pool.
- * @member {string} [computeMode] Shared or dedicated app hosting. Possible
- * values include: 'Shared', 'Dedicated', 'Dynamic'
- * @member {string} [workerSize] VM size of the worker pool instances.
- * @member {number} [workerCount] Number of instances in the worker pool.
- * @member {array} [instanceNames] Names of all instances in the worker pool
- * (read only).
- */
+*/
export interface WorkerPool {
+ /**
+ * Worker size ID for referencing this worker pool.
+ */
workerSizeId?: number;
+ /**
+ * Shared or dedicated app hosting. Possible values include: 'Shared', 'Dedicated', 'Dynamic'
+ */
computeMode?: string;
+ /**
+ * VM size of the worker pool instances.
+ */
workerSize?: string;
+ /**
+ * Number of instances in the worker pool.
+ */
workerCount?: number;
+ /**
+ * Names of all instances in the worker pool (read only).
+ */
readonly instanceNames?: string[];
}
/**
- * @class
- * Initializes a new instance of the VirtualIPMapping class.
- * @constructor
* Virtual IP mapping.
- *
- * @member {string} [virtualIP] Virtual IP address.
- * @member {number} [internalHttpPort] Internal HTTP port.
- * @member {number} [internalHttpsPort] Internal HTTPS port.
- * @member {boolean} [inUse] Is virtual IP mapping in use.
- */
+*/
export interface VirtualIPMapping {
+ /**
+ * Virtual IP address.
+ */
virtualIP?: string;
+ /**
+ * Internal HTTP port.
+ */
internalHttpPort?: number;
+ /**
+ * Internal HTTPS port.
+ */
internalHttpsPort?: number;
+ /**
+ * Is virtual IP mapping in use.
+ */
inUse?: boolean;
}
/**
- * @class
- * Initializes a new instance of the StampCapacity class.
- * @constructor
* Stamp capacity information.
- *
- * @member {string} [name] Name of the stamp.
- * @member {number} [availableCapacity] Available capacity (# of machines,
- * bytes of storage etc...).
- * @member {number} [totalCapacity] Total capacity (# of machines, bytes of
- * storage etc...).
- * @member {string} [unit] Name of the unit.
- * @member {string} [computeMode] Shared/dedicated workers. Possible values
- * include: 'Shared', 'Dedicated', 'Dynamic'
- * @member {string} [workerSize] Size of the machines. Possible values include:
- * 'Small', 'Medium', 'Large', 'D1', 'D2', 'D3', 'Default'
- * @member {number} [workerSizeId] Size ID of machines:
- * 0 - Small
- * 1 - Medium
- * 2 - Large
- * @member {boolean} [excludeFromCapacityAllocation] If true, it
- * includes basic apps.
- * Basic apps are not used for capacity allocation.
- * @member {boolean} [isApplicableForAllComputeModes] true if
- * capacity is applicable for all apps; otherwise, false.
- * @member {string} [siteMode] Shared or Dedicated.
- * @member {boolean} [isLinux] Is this a linux stamp capacity
- */
+*/
export interface StampCapacity {
+ /**
+ * Name of the stamp.
+ */
name?: string;
+ /**
+ * Available capacity (# of machines, bytes of storage etc...).
+ */
availableCapacity?: number;
+ /**
+ * Total capacity (# of machines, bytes of storage etc...).
+ */
totalCapacity?: number;
+ /**
+ * Name of the unit.
+ */
unit?: string;
+ /**
+ * Shared/dedicated workers. Possible values include: 'Shared', 'Dedicated', 'Dynamic'
+ */
computeMode?: string;
+ /**
+ * Size of the machines. Possible values include: 'Small', 'Medium', 'Large', 'D1', 'D2', 'D3',
+ * 'Default'
+ */
workerSize?: string;
+ /**
+ * Size ID of machines:
+ * 0 - Small
+ * 1 - Medium
+ * 2 - Large
+ */
workerSizeId?: number;
+ /**
+ * If true, it includes basic apps.
+ * Basic apps are not used for capacity allocation.
+ */
excludeFromCapacityAllocation?: boolean;
+ /**
+ * true if capacity is applicable for all apps; otherwise, false.
+ */
isApplicableForAllComputeModes?: boolean;
+ /**
+ * Shared or Dedicated.
+ */
siteMode?: string;
+ /**
+ * Is this a linux stamp capacity
+ */
isLinux?: boolean;
}
/**
- * @class
- * Initializes a new instance of the NetworkAccessControlEntry class.
- * @constructor
* Network access control entry.
- *
- * @member {string} [action] Action object. Possible values include: 'Permit',
- * 'Deny'
- * @member {string} [description] Description of network access control entry.
- * @member {number} [order] Order of precedence.
- * @member {string} [remoteSubnet] Remote subnet.
- */
+*/
export interface NetworkAccessControlEntry {
+ /**
+ * Action object. Possible values include: 'Permit', 'Deny'
+ */
action?: string;
+ /**
+ * Description of network access control entry.
+ */
description?: string;
+ /**
+ * Order of precedence.
+ */
order?: number;
+ /**
+ * Remote subnet.
+ */
remoteSubnet?: string;
}
/**
- * @class
- * Initializes a new instance of the AppServiceEnvironment class.
- * @constructor
* Description of an App Service Environment.
- *
- * @member {string} name Name of the App Service Environment.
- * @member {string} location Location of the App Service Environment, e.g.
- * "West US".
- * @member {string} [provisioningState] Provisioning state of the App Service
- * Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled',
- * 'InProgress', 'Deleting'
- * @member {string} [status] Current status of the App Service Environment.
- * Possible values include: 'Preparing', 'Ready', 'Scaling', 'Deleting'
- * @member {string} [vnetName] Name of the Virtual Network for the App Service
- * Environment.
- * @member {string} [vnetResourceGroupName] Resource group of the Virtual
- * Network.
- * @member {string} [vnetSubnetName] Subnet of the Virtual Network.
- * @member {object} virtualNetwork Description of the Virtual Network.
- * @member {string} [virtualNetwork.id] Resource id of the Virtual Network.
- * @member {string} [virtualNetwork.name] Name of the Virtual Network
- * (read-only).
- * @member {string} [virtualNetwork.type] Resource type of the Virtual Network
- * (read-only).
- * @member {string} [virtualNetwork.subnet] Subnet within the Virtual Network.
- * @member {string} [internalLoadBalancingMode] Specifies which endpoints to
- * serve internally in the Virtual Network for the App Service Environment.
- * Possible values include: 'None', 'Web', 'Publishing'
- * @member {string} [multiSize] Front-end VM size, e.g. "Medium", "Large".
- * @member {number} [multiRoleCount] Number of front-end instances.
- * @member {array} workerPools Description of worker pools with worker size
- * IDs, VM sizes, and number of workers in each pool.
- * @member {number} [ipsslAddressCount] Number of IP SSL addresses reserved for
- * the App Service Environment.
- * @member {string} [databaseEdition] Edition of the metadata database for the
- * App Service Environment, e.g. "Standard".
- * @member {string} [databaseServiceObjective] Service objective of the
- * metadata database for the App Service Environment, e.g. "S0".
- * @member {number} [upgradeDomains] Number of upgrade domains of the App
- * Service Environment.
- * @member {string} [subscriptionId] Subscription of the App Service
- * Environment.
- * @member {string} [dnsSuffix] DNS suffix of the App Service Environment.
- * @member {string} [lastAction] Last deployment action on the App Service
- * Environment.
- * @member {string} [lastActionResult] Result of the last deployment action on
- * the App Service Environment.
- * @member {string} [allowedMultiSizes] List of comma separated strings
- * describing which VM sizes are allowed for front-ends.
- * @member {string} [allowedWorkerSizes] List of comma separated strings
- * describing which VM sizes are allowed for workers.
- * @member {number} [maximumNumberOfMachines] Maximum number of VMs in the App
- * Service Environment.
- * @member {array} [vipMappings] Description of IP SSL mapping for the App
- * Service Environment.
- * @member {array} [environmentCapacities] Current total, used, and available
- * worker capacities.
- * @member {array} [networkAccessControlList] Access control list for
- * controlling traffic to the App Service Environment.
- * @member {boolean} [environmentIsHealthy] True/false indicating whether the
- * App Service Environment is healthy.
- * @member {string} [environmentStatus] Detailed message about with results of
- * the last check of the App Service Environment.
- * @member {string} [resourceGroup] Resource group of the App Service
- * Environment.
- * @member {number} [frontEndScaleFactor] Scale factor for front-ends.
- * @member {number} [defaultFrontEndScaleFactor] Default Scale Factor for
- * FrontEnds.
- * @member {string} [apiManagementAccountId] API Management Account associated
- * with the App Service Environment.
- * @member {boolean} [suspended] true if the App Service
- * Environment is suspended; otherwise, false. The environment can
- * be suspended, e.g. when the management endpoint is no longer available
- * (most likely because NSG blocked the incoming traffic).
- * @member {boolean} [dynamicCacheEnabled] True/false indicating whether the
- * App Service Environment is suspended. The environment can be suspended e.g.
- * when the management endpoint is no longer available
- * (most likely because NSG blocked the incoming traffic).
- * @member {array} [clusterSettings] Custom settings for changing the behavior
- * of the App Service Environment.
- * @member {array} [userWhitelistedIpRanges] User added ip ranges to whitelist
- * on ASE db
- * @member {boolean} [hasLinuxWorkers] Flag that displays whether an ASE has
- * linux workers or not
- * @member {string} [sslCertKeyVaultId] Key Vault ID for ILB App Service
- * Environment default SSL certificate
- * @member {string} [sslCertKeyVaultSecretName] Key Vault Secret Name for ILB
- * App Service Environment default SSL certificate
- */
+*/
export interface AppServiceEnvironment {
+ /**
+ * Name of the App Service Environment.
+ */
name: string;
+ /**
+ * Location of the App Service Environment, e.g. "West US".
+ */
location: string;
+ /**
+ * Provisioning state of the App Service Environment. Possible values include: 'Succeeded',
+ * 'Failed', 'Canceled', 'InProgress', 'Deleting'
+ */
readonly provisioningState?: string;
+ /**
+ * Current status of the App Service Environment. Possible values include: 'Preparing', 'Ready',
+ * 'Scaling', 'Deleting'
+ */
readonly status?: string;
+ /**
+ * Name of the Virtual Network for the App Service Environment.
+ */
vnetName?: string;
+ /**
+ * Resource group of the Virtual Network.
+ */
vnetResourceGroupName?: string;
+ /**
+ * Subnet of the Virtual Network.
+ */
vnetSubnetName?: string;
+ /**
+ * Description of the Virtual Network.
+ */
virtualNetwork: VirtualNetworkProfile;
+ /**
+ * Specifies which endpoints to serve internally in the Virtual Network for the App Service
+ * Environment. Possible values include: 'None', 'Web', 'Publishing'
+ */
internalLoadBalancingMode?: string;
+ /**
+ * Front-end VM size, e.g. "Medium", "Large".
+ */
multiSize?: string;
+ /**
+ * Number of front-end instances.
+ */
multiRoleCount?: number;
+ /**
+ * Description of worker pools with worker size IDs, VM sizes, and number of workers in each
+ * pool.
+ */
workerPools: WorkerPool[];
+ /**
+ * Number of IP SSL addresses reserved for the App Service Environment.
+ */
ipsslAddressCount?: number;
+ /**
+ * Edition of the metadata database for the App Service Environment, e.g. "Standard".
+ */
readonly databaseEdition?: string;
+ /**
+ * Service objective of the metadata database for the App Service Environment, e.g. "S0".
+ */
readonly databaseServiceObjective?: string;
+ /**
+ * Number of upgrade domains of the App Service Environment.
+ */
readonly upgradeDomains?: number;
+ /**
+ * Subscription of the App Service Environment.
+ */
readonly subscriptionId?: string;
+ /**
+ * DNS suffix of the App Service Environment.
+ */
dnsSuffix?: string;
+ /**
+ * Last deployment action on the App Service Environment.
+ */
readonly lastAction?: string;
+ /**
+ * Result of the last deployment action on the App Service Environment.
+ */
readonly lastActionResult?: string;
+ /**
+ * List of comma separated strings describing which VM sizes are allowed for front-ends.
+ */
readonly allowedMultiSizes?: string;
+ /**
+ * List of comma separated strings describing which VM sizes are allowed for workers.
+ */
readonly allowedWorkerSizes?: string;
+ /**
+ * Maximum number of VMs in the App Service Environment.
+ */
readonly maximumNumberOfMachines?: number;
+ /**
+ * Description of IP SSL mapping for the App Service Environment.
+ */
readonly vipMappings?: VirtualIPMapping[];
+ /**
+ * Current total, used, and available worker capacities.
+ */
readonly environmentCapacities?: StampCapacity[];
+ /**
+ * Access control list for controlling traffic to the App Service Environment.
+ */
networkAccessControlList?: NetworkAccessControlEntry[];
+ /**
+ * True/false indicating whether the App Service Environment is healthy.
+ */
readonly environmentIsHealthy?: boolean;
+ /**
+ * Detailed message about with results of the last check of the App Service Environment.
+ */
readonly environmentStatus?: string;
+ /**
+ * Resource group of the App Service Environment.
+ */
readonly resourceGroup?: string;
+ /**
+ * Scale factor for front-ends.
+ */
frontEndScaleFactor?: number;
+ /**
+ * Default Scale Factor for FrontEnds.
+ */
readonly defaultFrontEndScaleFactor?: number;
+ /**
+ * API Management Account associated with the App Service Environment.
+ */
apiManagementAccountId?: string;
+ /**
+ * true if the App Service Environment is suspended; otherwise, false.
+ * The environment can be suspended, e.g. when the management endpoint is no longer available
+ * (most likely because NSG blocked the incoming traffic).
+ */
suspended?: boolean;
+ /**
+ * True/false indicating whether the App Service Environment is suspended. The environment can be
+ * suspended e.g. when the management endpoint is no longer available
+ * (most likely because NSG blocked the incoming traffic).
+ */
dynamicCacheEnabled?: boolean;
+ /**
+ * Custom settings for changing the behavior of the App Service Environment.
+ */
clusterSettings?: NameValuePair[];
+ /**
+ * User added ip ranges to whitelist on ASE db
+ */
userWhitelistedIpRanges?: string[];
+ /**
+ * Flag that displays whether an ASE has linux workers or not
+ */
hasLinuxWorkers?: boolean;
+ /**
+ * Key Vault ID for ILB App Service Environment default SSL certificate
+ */
sslCertKeyVaultId?: string;
+ /**
+ * Key Vault Secret Name for ILB App Service Environment default SSL certificate
+ */
sslCertKeyVaultSecretName?: string;
}
/**
- * @class
- * Initializes a new instance of the LocalizableString class.
- * @constructor
* Localizable string object containing the name and a localized value.
- *
- * @member {string} [value] Non-localized name.
- * @member {string} [localizedValue] Localized name.
- */
+*/
export interface LocalizableString {
+ /**
+ * Non-localized name.
+ */
value?: string;
+ /**
+ * Localized name.
+ */
localizedValue?: string;
}
/**
- * @class
- * Initializes a new instance of the CsmUsageQuota class.
- * @constructor
* Usage of the quota resource.
- *
- * @member {string} [unit] Units of measurement for the quota resourse.
- * @member {date} [nextResetTime] Next reset time for the resource counter.
- * @member {number} [currentValue] The current value of the resource counter.
- * @member {number} [limit] The resource limit.
- * @member {object} [name] Quota name.
- * @member {string} [name.value] Non-localized name.
- * @member {string} [name.localizedValue] Localized name.
- */
+*/
export interface CsmUsageQuota {
+ /**
+ * Units of measurement for the quota resourse.
+ */
unit?: string;
+ /**
+ * Next reset time for the resource counter.
+ */
nextResetTime?: Date;
+ /**
+ * The current value of the resource counter.
+ */
currentValue?: number;
+ /**
+ * The resource limit.
+ */
limit?: number;
+ /**
+ * Quota name.
+ */
name?: LocalizableString;
}
/**
- * @class
- * Initializes a new instance of the ErrorEntity class.
- * @constructor
* Body of the error response returned from the API.
- *
- * @member {string} [extendedCode] Type of error.
- * @member {string} [messageTemplate] Message template.
- * @member {array} [parameters] Parameters for the template.
- * @member {array} [innerErrors] Inner errors.
- * @member {string} [code] Basic error code.
- * @member {string} [message] Any details of the error.
- */
+*/
export interface ErrorEntity {
+ /**
+ * Type of error.
+ */
extendedCode?: string;
+ /**
+ * Message template.
+ */
messageTemplate?: string;
+ /**
+ * Parameters for the template.
+ */
parameters?: string[];
+ /**
+ * Inner errors.
+ */
innerErrors?: ErrorEntity[];
+ /**
+ * Basic error code.
+ */
code?: string;
+ /**
+ * Any details of the error.
+ */
message?: string;
}
/**
- * @class
- * Initializes a new instance of the Operation class.
- * @constructor
* An operation on a resource.
- *
- * @member {string} [id] Operation ID.
- * @member {string} [name] Operation name.
- * @member {string} [status] The current status of the operation. Possible
- * values include: 'InProgress', 'Failed', 'Succeeded', 'TimedOut', 'Created'
- * @member {array} [errors] Any errors associate with the operation.
- * @member {date} [createdTime] Time when operation has started.
- * @member {date} [modifiedTime] Time when operation has been updated.
- * @member {date} [expirationTime] Time when operation will expire.
- * @member {uuid} [geoMasterOperationId] Applicable only for stamp operation
- * ids.
- */
+*/
export interface Operation {
+ /**
+ * Operation ID.
+ */
id?: string;
+ /**
+ * Operation name.
+ */
name?: string;
+ /**
+ * The current status of the operation. Possible values include: 'InProgress', 'Failed',
+ * 'Succeeded', 'TimedOut', 'Created'
+ */
status?: string;
+ /**
+ * Any errors associate with the operation.
+ */
errors?: ErrorEntity[];
+ /**
+ * Time when operation has started.
+ */
createdTime?: Date;
+ /**
+ * Time when operation has been updated.
+ */
modifiedTime?: Date;
+ /**
+ * Time when operation will expire.
+ */
expirationTime?: Date;
+ /**
+ * Applicable only for stamp operation ids.
+ */
geoMasterOperationId?: string;
}
/**
- * @class
- * Initializes a new instance of the ResourceMetricName class.
- * @constructor
* Name of a metric for any resource .
- *
- * @member {string} [value] metric name value.
- * @member {string} [localizedValue] Localized metric name value.
- */
+*/
export interface ResourceMetricName {
+ /**
+ * metric name value.
+ */
readonly value?: string;
+ /**
+ * Localized metric name value.
+ */
readonly localizedValue?: string;
}
/**
- * @class
- * Initializes a new instance of the ResourceMetricProperty class.
- * @constructor
* Resource metric property.
- *
- * @member {string} [key] Key for resource metric property.
- * @member {string} [value] Value of pair.
- */
+*/
export interface ResourceMetricProperty {
+ /**
+ * Key for resource metric property.
+ */
key?: string;
+ /**
+ * Value of pair.
+ */
value?: string;
}
/**
- * @class
- * Initializes a new instance of the ResourceMetricValue class.
- * @constructor
* Value of resource metric.
- *
- * @member {string} [timestamp] Value timestamp.
- * @member {number} [average] Value average.
- * @member {number} [minimum] Value minimum.
- * @member {number} [maximum] Value maximum.
- * @member {number} [total] Value total.
- * @member {number} [count] Value count.
- * @member {array} [properties] Resource metric properties collection.
- */
+*/
export interface ResourceMetricValue {
+ /**
+ * Value timestamp.
+ */
readonly timestamp?: string;
+ /**
+ * Value average.
+ */
readonly average?: number;
+ /**
+ * Value minimum.
+ */
readonly minimum?: number;
+ /**
+ * Value maximum.
+ */
readonly maximum?: number;
+ /**
+ * Value total.
+ */
readonly total?: number;
+ /**
+ * Value count.
+ */
readonly count?: number;
+ /**
+ * Resource metric properties collection.
+ */
readonly properties?: ResourceMetricProperty[];
}
/**
- * @class
- * Initializes a new instance of the ResourceMetric class.
- * @constructor
* Object representing a metric for any resource .
- *
- * @member {object} [name] Name of metric.
- * @member {string} [name.value] metric name value.
- * @member {string} [name.localizedValue] Localized metric name value.
- * @member {string} [unit] Metric unit.
- * @member {string} [timeGrain] Metric granularity. E.g PT1H, PT5M, P1D
- * @member {date} [startTime] Metric start time.
- * @member {date} [endTime] Metric end time.
- * @member {string} [resourceId] Metric resource Id.
- * @member {string} [id] Resource Id.
- * @member {array} [metricValues] Metric values.
- * @member {array} [properties] Resource metric properties collection.
- */
+*/
export interface ResourceMetric {
+ /**
+ * Name of metric.
+ */
readonly name?: ResourceMetricName;
+ /**
+ * Metric unit.
+ */
readonly unit?: string;
+ /**
+ * Metric granularity. E.g PT1H, PT5M, P1D
+ */
readonly timeGrain?: string;
+ /**
+ * Metric start time.
+ */
readonly startTime?: Date;
+ /**
+ * Metric end time.
+ */
readonly endTime?: Date;
+ /**
+ * Metric resource Id.
+ */
readonly resourceId?: string;
+ /**
+ * Resource Id.
+ */
readonly id?: string;
+ /**
+ * Metric values.
+ */
readonly metricValues?: ResourceMetricValue[];
+ /**
+ * Resource metric properties collection.
+ */
readonly properties?: ResourceMetricProperty[];
}
/**
- * @class
- * Initializes a new instance of the Solution class.
- * @constructor
* Class Representing Solution for problems detected.
- *
- * @member {number} [id] Solution Id.
- * @member {string} [displayName] Display Name of the solution
- * @member {number} [order] Order of the solution.
- * @member {string} [description] Description of the solution
- * @member {string} [type] Type of Solution. Possible values include:
- * 'QuickSolution', 'DeepInvestigation', 'BestPractices'
- * @member {array} [data] Solution Data.
- * @member {array} [metadata] Solution Metadata.
- */
+*/
export interface Solution {
+ /**
+ * Solution Id.
+ */
id?: number;
+ /**
+ * Display Name of the solution
+ */
displayName?: string;
+ /**
+ * Order of the solution.
+ */
order?: number;
+ /**
+ * Description of the solution
+ */
description?: string;
+ /**
+ * Type of Solution. Possible values include: 'QuickSolution', 'DeepInvestigation',
+ * 'BestPractices'
+ */
type?: string;
+ /**
+ * Solution Data.
+ */
data?: NameValuePair[][];
+ /**
+ * Solution Metadata.
+ */
metadata?: NameValuePair[][];
}
/**
- * @class
- * Initializes a new instance of the DetectorAbnormalTimePeriod class.
- * @constructor
* Class representing Abnormal Time Period detected.
- *
- * @member {date} [startTime] Start time of the corelated event
- * @member {date} [endTime] End time of the corelated event
- * @member {string} [message] Message describing the event
- * @member {string} [source] Represents the name of the Detector
- * @member {number} [priority] Represents the rank of the Detector
- * @member {array} [metaData] Downtime metadata
- * @member {string} [type] Represents the type of the Detector. Possible values
- * include: 'ServiceIncident', 'AppDeployment', 'AppCrash',
- * 'RuntimeIssueDetected', 'AseDeployment', 'UserIssue', 'PlatformIssue',
- * 'Other'
- * @member {array} [solutions] List of proposed solutions
- */
+*/
export interface DetectorAbnormalTimePeriod {
+ /**
+ * Start time of the corelated event
+ */
startTime?: Date;
+ /**
+ * End time of the corelated event
+ */
endTime?: Date;
+ /**
+ * Message describing the event
+ */
message?: string;
+ /**
+ * Represents the name of the Detector
+ */
source?: string;
+ /**
+ * Represents the rank of the Detector
+ */
priority?: number;
+ /**
+ * Downtime metadata
+ */
metaData?: NameValuePair[][];
+ /**
+ * Represents the type of the Detector. Possible values include: 'ServiceIncident',
+ * 'AppDeployment', 'AppCrash', 'RuntimeIssueDetected', 'AseDeployment', 'UserIssue',
+ * 'PlatformIssue', 'Other'
+ */
type?: string;
+ /**
+ * List of proposed solutions
+ */
solutions?: Solution[];
}
/**
- * @class
- * Initializes a new instance of the AbnormalTimePeriod class.
- * @constructor
* Class representing Abnormal Time Period identified in diagnosis
- *
- * @member {date} [startTime] Start time of the downtime
- * @member {date} [endTime] End time of the downtime
- * @member {array} [events] List of Possible Cause of downtime
- * @member {array} [solutions] List of proposed solutions
- */
+*/
export interface AbnormalTimePeriod {
+ /**
+ * Start time of the downtime
+ */
startTime?: Date;
+ /**
+ * End time of the downtime
+ */
endTime?: Date;
+ /**
+ * List of Possible Cause of downtime
+ */
events?: DetectorAbnormalTimePeriod[];
+ /**
+ * List of proposed solutions
+ */
solutions?: Solution[];
}
/**
- * @class
- * Initializes a new instance of the DetectorDefinition class.
- * @constructor
* Class representing detector definition
- *
- * @member {string} [displayName] Display name of the detector
- * @member {string} [description] Description of the detector
- * @member {number} [rank] Detector Rank
- * @member {boolean} [isEnabled] Flag representing whether detector is enabled
- * or not.
- */
+*/
export interface DetectorDefinition extends ProxyOnlyResource {
+ /**
+ * Display name of the detector
+ */
readonly displayName?: string;
+ /**
+ * Description of the detector
+ */
readonly description?: string;
+ /**
+ * Detector Rank
+ */
readonly rank?: number;
+ /**
+ * Flag representing whether detector is enabled or not.
+ */
readonly isEnabled?: boolean;
}
/**
- * @class
- * Initializes a new instance of the DiagnosticMetricSample class.
- * @constructor
* Class representing Diagnostic Metric
- *
- * @member {date} [timestamp] Time at which metric is measured
- * @member {string} [roleInstance] Role Instance. Null if this counter is not
- * per instance
- * This is returned and should be whichever instance name we desire to be
- * returned
- * i.e. CPU and Memory return RDWORKERNAME (LargeDed..._IN_0)
- * where RDWORKERNAME is Machine name below and RoleInstance name in
- * parenthesis
- * @member {number} [total] Total value of the metric. If multiple measurements
- * are made this will have sum of all.
- * @member {number} [maximum] Maximum of the metric sampled during the time
- * period
- * @member {number} [minimum] Minimum of the metric sampled during the time
- * period
- * @member {boolean} [isAggregated] Whether the values are aggregates across
- * all workers or not
- */
+*/
export interface DiagnosticMetricSample {
+ /**
+ * Time at which metric is measured
+ */
timestamp?: Date;
+ /**
+ * Role Instance. Null if this counter is not per instance
+ * This is returned and should be whichever instance name we desire to be returned
+ * i.e. CPU and Memory return RDWORKERNAME (LargeDed..._IN_0)
+ * where RDWORKERNAME is Machine name below and RoleInstance name in parenthesis
+ */
roleInstance?: string;
+ /**
+ * Total value of the metric. If multiple measurements are made this will have sum of all.
+ */
total?: number;
+ /**
+ * Maximum of the metric sampled during the time period
+ */
maximum?: number;
+ /**
+ * Minimum of the metric sampled during the time period
+ */
minimum?: number;
+ /**
+ * Whether the values are aggregates across all workers or not
+ */
isAggregated?: boolean;
}
/**
- * @class
- * Initializes a new instance of the DiagnosticMetricSet class.
- * @constructor
* Class representing Diagnostic Metric information
- *
- * @member {string} [name] Name of the metric
- * @member {string} [unit] Metric's unit
- * @member {date} [startTime] Start time of the period
- * @member {date} [endTime] End time of the period
- * @member {string} [timeGrain] Presented time grain. Supported grains at the
- * moment are PT1M, PT1H, P1D
- * @member {array} [values] Collection of metric values for the selected period
- * based on the
- * {Microsoft.Web.Hosting.Administration.DiagnosticMetricSet.TimeGrain}
- */
+*/
export interface DiagnosticMetricSet {
+ /**
+ * Name of the metric
+ */
name?: string;
+ /**
+ * Metric's unit
+ */
unit?: string;
+ /**
+ * Start time of the period
+ */
startTime?: Date;
+ /**
+ * End time of the period
+ */
endTime?: Date;
+ /**
+ * Presented time grain. Supported grains at the moment are PT1M, PT1H, P1D
+ */
timeGrain?: string;
+ /**
+ * Collection of metric values for the selected period based on the
+ * {Microsoft.Web.Hosting.Administration.DiagnosticMetricSet.TimeGrain}
+ */
values?: DiagnosticMetricSample[];
}
/**
- * @class
- * Initializes a new instance of the DataSource class.
- * @constructor
* Class representing data source used by the detectors
- *
- * @member {array} [instructions] Instrunctions if any for the data source
- * @member {array} [dataSourceUri] Datasource Uri Links
- */
+*/
export interface DataSource {
+ /**
+ * Instrunctions if any for the data source
+ */
instructions?: string[];
+ /**
+ * Datasource Uri Links
+ */
dataSourceUri?: NameValuePair[];
}
-/**
- * @class
- * Initializes a new instance of the ResponseMetaData class.
- * @constructor
- * @member {object} [dataSource] Source of the Data
- * @member {array} [dataSource.instructions] Instrunctions if any for the data
- * source
- * @member {array} [dataSource.dataSourceUri] Datasource Uri Links
- */
export interface ResponseMetaData {
+ /**
+ * Source of the Data
+ */
dataSource?: DataSource;
}
/**
- * @class
- * Initializes a new instance of the AnalysisData class.
- * @constructor
* Class Representing Detector Evidence used for analysis
- *
- * @member {string} [source] Name of the Detector
- * @member {object} [detectorDefinition] Detector Definition
- * @member {string} [detectorDefinition.displayName] Display name of the
- * detector
- * @member {string} [detectorDefinition.description] Description of the
- * detector
- * @member {number} [detectorDefinition.rank] Detector Rank
- * @member {boolean} [detectorDefinition.isEnabled] Flag representing whether
- * detector is enabled or not.
- * @member {array} [metrics] Source Metrics
- * @member {array} [data] Additional Source Data
- * @member {object} [detectorMetaData] Detector Meta Data
- * @member {object} [detectorMetaData.dataSource] Source of the Data
- * @member {array} [detectorMetaData.dataSource.instructions] Instrunctions if
- * any for the data source
- * @member {array} [detectorMetaData.dataSource.dataSourceUri] Datasource Uri
- * Links
- */
+*/
export interface AnalysisData {
+ /**
+ * Name of the Detector
+ */
source?: string;
+ /**
+ * Detector Definition
+ */
detectorDefinition?: DetectorDefinition;
+ /**
+ * Source Metrics
+ */
metrics?: DiagnosticMetricSet[];
+ /**
+ * Additional Source Data
+ */
data?: NameValuePair[][];
+ /**
+ * Detector Meta Data
+ */
detectorMetaData?: ResponseMetaData;
}
/**
- * @class
- * Initializes a new instance of the AnalysisDefinition class.
- * @constructor
* Definition of Analysis
- *
- * @member {string} [description] Description of the Analysis
- */
+*/
export interface AnalysisDefinition extends ProxyOnlyResource {
+ /**
+ * Description of the Analysis
+ */
readonly description?: string;
}
/**
- * @class
- * Initializes a new instance of the DataTableResponseColumn class.
- * @constructor
* Column definition
- *
- * @member {string} [columnName] Name of the column
- * @member {string} [dataType] Data type which looks like 'String' or 'Int32'.
- * @member {string} [columnType] Column Type
- */
+*/
export interface DataTableResponseColumn {
+ /**
+ * Name of the column
+ */
columnName?: string;
+ /**
+ * Data type which looks like 'String' or 'Int32'.
+ */
dataType?: string;
+ /**
+ * Column Type
+ */
columnType?: string;
}
/**
- * @class
- * Initializes a new instance of the DataTableResponseObject class.
- * @constructor
* Data Table which defines columns and raw row values
- *
- * @member {string} [tableName] Name of the table
- * @member {array} [columns] List of columns with data types
- * @member {array} [rows] Raw row values
- */
+*/
export interface DataTableResponseObject {
+ /**
+ * Name of the table
+ */
tableName?: string;
+ /**
+ * List of columns with data types
+ */
columns?: DataTableResponseColumn[];
+ /**
+ * Raw row values
+ */
rows?: string[][];
}
/**
- * @class
- * Initializes a new instance of the DetectorInfo class.
- * @constructor
* Definition of Detector
- *
- * @member {string} [description] Short description of the detector and its
- * purpose
- * @member {string} [category] Support Category
- * @member {string} [subCategory] Support Sub Category
- * @member {string} [supportTopicId] Support Topic Id
- */
+*/
export interface DetectorInfo {
+ /**
+ * Short description of the detector and its purpose
+ */
readonly description?: string;
+ /**
+ * Support Category
+ */
readonly category?: string;
+ /**
+ * Support Sub Category
+ */
readonly subCategory?: string;
+ /**
+ * Support Topic Id
+ */
readonly supportTopicId?: string;
}
/**
- * @class
- * Initializes a new instance of the Rendering class.
- * @constructor
* Instructions for rendering the data
- *
- * @member {string} [type] Rendering Type. Possible values include: 'NoGraph',
- * 'Table', 'TimeSeries', 'TimeSeriesPerInstance'
- * @member {string} [title] Title of data
- * @member {string} [description] Description of the data that will help it be
- * interpreted
- */
+*/
export interface Rendering {
+ /**
+ * Rendering Type. Possible values include: 'NoGraph', 'Table', 'TimeSeries',
+ * 'TimeSeriesPerInstance'
+ */
type?: string;
+ /**
+ * Title of data
+ */
title?: string;
+ /**
+ * Description of the data that will help it be interpreted
+ */
description?: string;
}
/**
- * @class
- * Initializes a new instance of the DiagnosticData class.
- * @constructor
* Set of data with rendering instructions
- *
- * @member {object} [table] Data in table form
- * @member {string} [table.tableName] Name of the table
- * @member {array} [table.columns] List of columns with data types
- * @member {array} [table.rows] Raw row values
- * @member {object} [renderingProperties] Properties that describe how the
- * table should be rendered
- * @member {string} [renderingProperties.type] Rendering Type. Possible values
- * include: 'NoGraph', 'Table', 'TimeSeries', 'TimeSeriesPerInstance'
- * @member {string} [renderingProperties.title] Title of data
- * @member {string} [renderingProperties.description] Description of the data
- * that will help it be interpreted
- */
+*/
export interface DiagnosticData {
+ /**
+ * Data in table form
+ */
table?: DataTableResponseObject;
+ /**
+ * Properties that describe how the table should be rendered
+ */
renderingProperties?: Rendering;
}
/**
- * @class
- * Initializes a new instance of the DetectorResponse class.
- * @constructor
* Class representing Response from Detector
- *
- * @member {object} [metadata] metadata for the detector
- * @member {string} [metadata.description] Short description of the detector
- * and its purpose
- * @member {string} [metadata.category] Support Category
- * @member {string} [metadata.subCategory] Support Sub Category
- * @member {string} [metadata.supportTopicId] Support Topic Id
- * @member {array} [dataset] Data Set
- */
+*/
export interface DetectorResponse extends ProxyOnlyResource {
+ /**
+ * metadata for the detector
+ */
metadata?: DetectorInfo;
+ /**
+ * Data Set
+ */
dataset?: DiagnosticData[];
}
/**
- * @class
- * Initializes a new instance of the DiagnosticAnalysis class.
- * @constructor
* Class representing a diagnostic analysis done on an application
- *
- * @member {date} [startTime] Start time of the period
- * @member {date} [endTime] End time of the period
- * @member {array} [abnormalTimePeriods] List of time periods.
- * @member {array} [payload] Data by each detector
- * @member {array} [nonCorrelatedDetectors] Data by each detector for detectors
- * that did not corelate
- */
+*/
export interface DiagnosticAnalysis extends ProxyOnlyResource {
+ /**
+ * Start time of the period
+ */
startTime?: Date;
+ /**
+ * End time of the period
+ */
endTime?: Date;
+ /**
+ * List of time periods.
+ */
abnormalTimePeriods?: AbnormalTimePeriod[];
+ /**
+ * Data by each detector
+ */
payload?: AnalysisData[];
+ /**
+ * Data by each detector for detectors that did not corelate
+ */
nonCorrelatedDetectors?: DetectorDefinition[];
}
/**
- * @class
- * Initializes a new instance of the DiagnosticCategory class.
- * @constructor
* Class representing detector definition
- *
- * @member {string} [description] Description of the diagnostic category
- */
+*/
export interface DiagnosticCategory extends ProxyOnlyResource {
+ /**
+ * Description of the diagnostic category
+ */
readonly description?: string;
}
/**
- * @class
- * Initializes a new instance of the DiagnosticDetectorResponse class.
- * @constructor
* Class representing Reponse from Diagnostic Detectors
- *
- * @member {date} [startTime] Start time of the period
- * @member {date} [endTime] End time of the period
- * @member {boolean} [issueDetected] Flag representing Issue was detected.
- * @member {object} [detectorDefinition] Detector's definition
- * @member {string} [detectorDefinition.displayName] Display name of the
- * detector
- * @member {string} [detectorDefinition.description] Description of the
- * detector
- * @member {number} [detectorDefinition.rank] Detector Rank
- * @member {boolean} [detectorDefinition.isEnabled] Flag representing whether
- * detector is enabled or not.
- * @member {array} [metrics] Metrics provided by the detector
- * @member {array} [abnormalTimePeriods] List of Correlated events found by the
- * detector
- * @member {array} [data] Additional Data that detector wants to send.
- * @member {object} [responseMetaData] Meta Data
- * @member {object} [responseMetaData.dataSource] Source of the Data
- * @member {array} [responseMetaData.dataSource.instructions] Instrunctions if
- * any for the data source
- * @member {array} [responseMetaData.dataSource.dataSourceUri] Datasource Uri
- * Links
- */
+*/
export interface DiagnosticDetectorResponse extends ProxyOnlyResource {
+ /**
+ * Start time of the period
+ */
startTime?: Date;
+ /**
+ * End time of the period
+ */
endTime?: Date;
+ /**
+ * Flag representing Issue was detected.
+ */
issueDetected?: boolean;
+ /**
+ * Detector's definition
+ */
detectorDefinition?: DetectorDefinition;
+ /**
+ * Metrics provided by the detector
+ */
metrics?: DiagnosticMetricSet[];
+ /**
+ * List of Correlated events found by the detector
+ */
abnormalTimePeriods?: DetectorAbnormalTimePeriod[];
+ /**
+ * Additional Data that detector wants to send.
+ */
data?: NameValuePair[][];
+ /**
+ * Meta Data
+ */
responseMetaData?: ResponseMetaData;
}
/**
- * @class
- * Initializes a new instance of the StackMinorVersion class.
- * @constructor
* Application stack minor version.
- *
- * @member {string} [displayVersion] Application stack minor version (display
- * only).
- * @member {string} [runtimeVersion] Application stack minor version (runtime
- * only).
- * @member {boolean} [isDefault] true if this is the default minor
- * version; otherwise, false.
- */
+*/
export interface StackMinorVersion {
+ /**
+ * Application stack minor version (display only).
+ */
displayVersion?: string;
+ /**
+ * Application stack minor version (runtime only).
+ */
runtimeVersion?: string;
+ /**
+ * true if this is the default minor version; otherwise, false.
+ */
isDefault?: boolean;
}
/**
- * @class
- * Initializes a new instance of the StackMajorVersion class.
- * @constructor
* Application stack major version.
- *
- * @member {string} [displayVersion] Application stack major version (display
- * only).
- * @member {string} [runtimeVersion] Application stack major version (runtime
- * only).
- * @member {boolean} [isDefault] true if this is the default major
- * version; otherwise, false.
- * @member {array} [minorVersions] Minor versions associated with the major
- * version.
- */
+*/
export interface StackMajorVersion {
+ /**
+ * Application stack major version (display only).
+ */
displayVersion?: string;
+ /**
+ * Application stack major version (runtime only).
+ */
runtimeVersion?: string;
+ /**
+ * true if this is the default major version; otherwise, false.
+ */
isDefault?: boolean;
+ /**
+ * Minor versions associated with the major version.
+ */
minorVersions?: StackMinorVersion[];
}
/**
- * @class
- * Initializes a new instance of the ApplicationStack class.
- * @constructor
* Application stack.
- *
- * @member {string} [name] Application stack name.
- * @member {string} [display] Application stack display name.
- * @member {string} [dependency] Application stack dependency.
- * @member {array} [majorVersions] List of major versions available.
- * @member {array} [frameworks] List of frameworks associated with application
- * stack.
- */
+*/
export interface ApplicationStack {
+ /**
+ * Application stack name.
+ */
name?: string;
+ /**
+ * Application stack display name.
+ */
display?: string;
+ /**
+ * Application stack dependency.
+ */
dependency?: string;
+ /**
+ * List of major versions available.
+ */
majorVersions?: StackMajorVersion[];
+ /**
+ * List of frameworks associated with application stack.
+ */
frameworks?: ApplicationStack[];
}
/**
- * @class
- * Initializes a new instance of the Recommendation class.
- * @constructor
* Represents a recommendation result generated by the recommendation engine.
- *
- * @member {date} [creationTime] Timestamp when this instance was created.
- * @member {uuid} [recommendationId] A GUID value that each recommendation
- * object is associated with.
- * @member {string} [resourceId] Full ARM resource ID string that this
- * recommendation object is associated with.
- * @member {string} [resourceScope] Name of a resource type this recommendation
- * applies, e.g. Subscription, ServerFarm, Site. Possible values include:
- * 'ServerFarm', 'Subscription', 'WebSite'
- * @member {string} [ruleName] Unique name of the rule.
- * @member {string} [displayName] UI friendly name of the rule (may not be
- * unique).
- * @member {string} [message] Recommendation text.
- * @member {string} [level] Level indicating how critical this recommendation
- * can impact. Possible values include: 'Critical', 'Warning', 'Information',
- * 'NonUrgentSuggestion'
- * @member {string} [channels] List of channels that this recommendation can
- * apply. Possible values include: 'Notification', 'Api', 'Email', 'Webhook',
- * 'All'
- * @member {array} [categoryTags] The list of category tags that this
- * recommendation belongs to.
- * @member {string} [actionName] Name of action recommended by this object.
- * @member {number} [enabled] True if this recommendation is still valid (i.e.
- * "actionable"). False if it is invalid.
- * @member {array} [states] The list of states of this recommendation. If it's
- * null then it shoud be considered "Active".
- * @member {date} [startTime] The beginning time in UTC of a range that the
- * recommendation refers to.
- * @member {date} [endTime] The end time in UTC of a range that the
- * recommendation refers to.
- * @member {date} [nextNotificationTime] When to notify this recommendation
- * next in UTC. Null means that this will never be notified anymore.
- * @member {date} [notificationExpirationTime] Date and time in UTC when this
- * notification expires.
- * @member {date} [notifiedTime] Last timestamp in UTC this instance was
- * actually notified. Null means that this recommendation hasn't been notified
- * yet.
- * @member {number} [score] A metric value measured by the rule.
- * @member {boolean} [isDynamic] True if this is associated with a dynamically
- * added rule
- * @member {string} [extensionName] Extension name of the portal if exists.
- * @member {string} [bladeName] Deep link to a blade on the portal.
- * @member {string} [forwardLink] Forward link to an external document
- * associated with the rule.
- */
+*/
export interface Recommendation extends ProxyOnlyResource {
+ /**
+ * Timestamp when this instance was created.
+ */
creationTime?: Date;
+ /**
+ * A GUID value that each recommendation object is associated with.
+ */
recommendationId?: string;
+ /**
+ * Full ARM resource ID string that this recommendation object is associated with.
+ */
resourceId?: string;
+ /**
+ * Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site.
+ * Possible values include: 'ServerFarm', 'Subscription', 'WebSite'
+ */
resourceScope?: string;
+ /**
+ * Unique name of the rule.
+ */
ruleName?: string;
+ /**
+ * UI friendly name of the rule (may not be unique).
+ */
displayName?: string;
+ /**
+ * Recommendation text.
+ */
message?: string;
+ /**
+ * Level indicating how critical this recommendation can impact. Possible values include:
+ * 'Critical', 'Warning', 'Information', 'NonUrgentSuggestion'
+ */
level?: string;
+ /**
+ * List of channels that this recommendation can apply. Possible values include: 'Notification',
+ * 'Api', 'Email', 'Webhook', 'All'
+ */
channels?: string;
+ /**
+ * The list of category tags that this recommendation belongs to.
+ */
readonly categoryTags?: string[];
+ /**
+ * Name of action recommended by this object.
+ */
actionName?: string;
+ /**
+ * True if this recommendation is still valid (i.e. "actionable"). False if it is invalid.
+ */
enabled?: number;
+ /**
+ * The list of states of this recommendation. If it's null then it shoud be considered "Active".
+ */
states?: string[];
+ /**
+ * The beginning time in UTC of a range that the recommendation refers to.
+ */
startTime?: Date;
+ /**
+ * The end time in UTC of a range that the recommendation refers to.
+ */
endTime?: Date;
+ /**
+ * When to notify this recommendation next in UTC. Null means that this will never be notified
+ * anymore.
+ */
nextNotificationTime?: Date;
+ /**
+ * Date and time in UTC when this notification expires.
+ */
notificationExpirationTime?: Date;
+ /**
+ * Last timestamp in UTC this instance was actually notified. Null means that this recommendation
+ * hasn't been notified yet.
+ */
notifiedTime?: Date;
+ /**
+ * A metric value measured by the rule.
+ */
score?: number;
+ /**
+ * True if this is associated with a dynamically added rule
+ */
isDynamic?: boolean;
+ /**
+ * Extension name of the portal if exists.
+ */
extensionName?: string;
+ /**
+ * Deep link to a blade on the portal.
+ */
bladeName?: string;
+ /**
+ * Forward link to an external document associated with the rule.
+ */
forwardLink?: string;
}
/**
- * @class
- * Initializes a new instance of the RecommendationRule class.
- * @constructor
* Represents a recommendation rule that the recommendation engine can perform.
- *
- * @member {string} [recommendationName] Unique name of the rule.
- * @member {string} [displayName] UI friendly name of the rule.
- * @member {string} [message] Localized name of the rule (Good for UI).
- * @member {uuid} [recommendationId] Recommendation ID of an associated
- * recommendation object tied to the rule, if exists.
- * If such an object doesn't exist, it is set to null.
- * @member {string} [description] Localized detailed description of the rule.
- * @member {string} [actionName] Name of action that is recommended by this
- * rule in string.
- * @member {string} [level] Level of impact indicating how critical this rule
- * is. Possible values include: 'Critical', 'Warning', 'Information',
- * 'NonUrgentSuggestion'
- * @member {string} [channels] List of available channels that this rule
- * applies. Possible values include: 'Notification', 'Api', 'Email', 'Webhook',
- * 'All'
- * @member {array} [categoryTags] The list of category tags that this
- * recommendation rule belongs to.
- * @member {boolean} [isDynamic] True if this is associated with a dynamically
- * added rule
- * @member {string} [extensionName] Extension name of the portal if exists.
- * Applicable to dynamic rule only.
- * @member {string} [bladeName] Deep link to a blade on the portal. Applicable
- * to dynamic rule only.
- * @member {string} [forwardLink] Forward link to an external document
- * associated with the rule. Applicable to dynamic rule only.
- */
+*/
export interface RecommendationRule extends ProxyOnlyResource {
+ /**
+ * Unique name of the rule.
+ */
recommendationName?: string;
+ /**
+ * UI friendly name of the rule.
+ */
displayName?: string;
+ /**
+ * Localized name of the rule (Good for UI).
+ */
message?: string;
+ /**
+ * Recommendation ID of an associated recommendation object tied to the rule, if exists.
+ * If such an object doesn't exist, it is set to null.
+ */
recommendationId?: string;
+ /**
+ * Localized detailed description of the rule.
+ */
description?: string;
+ /**
+ * Name of action that is recommended by this rule in string.
+ */
actionName?: string;
+ /**
+ * Level of impact indicating how critical this rule is. Possible values include: 'Critical',
+ * 'Warning', 'Information', 'NonUrgentSuggestion'
+ */
level?: string;
+ /**
+ * List of available channels that this rule applies. Possible values include: 'Notification',
+ * 'Api', 'Email', 'Webhook', 'All'
+ */
channels?: string;
+ /**
+ * The list of category tags that this recommendation rule belongs to.
+ */
readonly categoryTags?: string[];
+ /**
+ * True if this is associated with a dynamically added rule
+ */
isDynamic?: boolean;
+ /**
+ * Extension name of the portal if exists. Applicable to dynamic rule only.
+ */
extensionName?: string;
+ /**
+ * Deep link to a blade on the portal. Applicable to dynamic rule only.
+ */
bladeName?: string;
+ /**
+ * Forward link to an external document associated with the rule. Applicable to dynamic rule
+ * only.
+ */
forwardLink?: string;
}
/**
- * @class
- * Initializes a new instance of the BillingMeter class.
- * @constructor
- * App Service billing entity that contains information about meter which the
- * Azure billing system utilizes to charge users for services.
- *
- * @member {string} [meterId] Meter GUID onboarded in Commerce
- * @member {string} [billingLocation] Azure Location of billable resource
- * @member {string} [shortName] Short Name from App Service Azure pricing Page
- * @member {string} [friendlyName] Friendly name of the meter
- * @member {string} [resourceType] App Service ResourceType meter used for
- * @member {string} [osType] App Service OS type meter used for
- */
+ * App Service billing entity that contains information about meter which the Azure billing system
+ * utilizes to charge users for services.
+*/
export interface BillingMeter extends ProxyOnlyResource {
+ /**
+ * Meter GUID onboarded in Commerce
+ */
meterId?: string;
+ /**
+ * Azure Location of billable resource
+ */
billingLocation?: string;
+ /**
+ * Short Name from App Service Azure pricing Page
+ */
shortName?: string;
+ /**
+ * Friendly name of the meter
+ */
friendlyName?: string;
+ /**
+ * App Service ResourceType meter used for
+ */
resourceType?: string;
+ /**
+ * App Service OS type meter used for
+ */
osType?: string;
}
/**
- * @class
- * Initializes a new instance of the CsmMoveResourceEnvelope class.
- * @constructor
- * Object with a list of the resources that need to be moved and the resource
- * group they should be moved to.
- *
- * @member {string} [targetResourceGroup]
- * @member {array} [resources]
- */
+ * Object with a list of the resources that need to be moved and the resource group they should be
+ * moved to.
+*/
export interface CsmMoveResourceEnvelope {
targetResourceGroup?: string;
resources?: string[];
}
/**
- * @class
- * Initializes a new instance of the GeoRegion class.
- * @constructor
* Geographical region.
- *
- * @member {string} [description] Region description.
- * @member {string} [displayName] Display name for region.
- */
+*/
export interface GeoRegion extends ProxyOnlyResource {
+ /**
+ * Region description.
+ */
readonly description?: string;
+ /**
+ * Display name for region.
+ */
readonly displayName?: string;
}
/**
- * @class
- * Initializes a new instance of the HostingEnvironmentDeploymentInfo class.
- * @constructor
* Information needed to create resources on an App Service Environment.
- *
- * @member {string} [name] Name of the App Service Environment.
- * @member {string} [location] Location of the App Service Environment.
- */
+*/
export interface HostingEnvironmentDeploymentInfo {
+ /**
+ * Name of the App Service Environment.
+ */
name?: string;
+ /**
+ * Location of the App Service Environment.
+ */
location?: string;
}
/**
- * @class
- * Initializes a new instance of the DeploymentLocations class.
- * @constructor
* List of available locations (regions or App Service Environments) for
* deployment of App Service resources.
- *
- * @member {array} [locations] Available regions.
- * @member {array} [hostingEnvironments] Available App Service Environments
- * with full descriptions of the environments.
- * @member {array} [hostingEnvironmentDeploymentInfos] Available App Service
- * Environments with basic information.
- */
+*/
export interface DeploymentLocations {
+ /**
+ * Available regions.
+ */
locations?: GeoRegion[];
+ /**
+ * Available App Service Environments with full descriptions of the environments.
+ */
hostingEnvironments?: AppServiceEnvironment[];
+ /**
+ * Available App Service Environments with basic information.
+ */
hostingEnvironmentDeploymentInfos?: HostingEnvironmentDeploymentInfo[];
}
/**
- * @class
- * Initializes a new instance of the GlobalCsmSkuDescription class.
- * @constructor
* A Global SKU Description.
- *
- * @member {string} [name] Name of the resource SKU.
- * @member {string} [tier] Service Tier of the resource SKU.
- * @member {string} [size] Size specifier of the resource SKU.
- * @member {string} [family] Family code of the resource SKU.
- * @member {object} [capacity] Min, max, and default scale values of the SKU.
- * @member {number} [capacity.minimum] Minimum number of workers for this App
- * Service plan SKU.
- * @member {number} [capacity.maximum] Maximum number of workers for this App
- * Service plan SKU.
- * @member {number} [capacity.default] Default number of workers for this App
- * Service plan SKU.
- * @member {string} [capacity.scaleType] Available scale configurations for an
- * App Service plan.
- * @member {array} [locations] Locations of the SKU.
- * @member {array} [capabilities] Capabilities of the SKU, e.g., is traffic
- * manager enabled?
- */
+*/
export interface GlobalCsmSkuDescription {
+ /**
+ * Name of the resource SKU.
+ */
name?: string;
+ /**
+ * Service Tier of the resource SKU.
+ */
tier?: string;
+ /**
+ * Size specifier of the resource SKU.
+ */
size?: string;
+ /**
+ * Family code of the resource SKU.
+ */
family?: string;
+ /**
+ * Min, max, and default scale values of the SKU.
+ */
capacity?: SkuCapacity;
+ /**
+ * Locations of the SKU.
+ */
locations?: string[];
+ /**
+ * Capabilities of the SKU, e.g., is traffic manager enabled?
+ */
capabilities?: Capability[];
}
/**
- * @class
- * Initializes a new instance of the PremierAddOnOffer class.
- * @constructor
* Premier add-on offer.
- *
- * @member {string} [sku] Premier add on SKU.
- * @member {string} [product] Premier add on offer Product.
- * @member {string} [vendor] Premier add on offer Vendor.
- * @member {boolean} [promoCodeRequired] true if promotion code is
- * required; otherwise, false.
- * @member {number} [quota] Premier add on offer Quota.
- * @member {string} [webHostingPlanRestrictions] App Service plans this offer
- * is restricted to. Possible values include: 'None', 'Free', 'Shared',
- * 'Basic', 'Standard', 'Premium'
- * @member {string} [privacyPolicyUrl] Privacy policy URL.
- * @member {string} [legalTermsUrl] Legal terms URL.
- * @member {string} [marketplacePublisher] Marketplace publisher.
- * @member {string} [marketplaceOffer] Marketplace offer.
- */
+*/
export interface PremierAddOnOffer extends ProxyOnlyResource {
+ /**
+ * Premier add on SKU.
+ */
sku?: string;
+ /**
+ * Premier add on offer Product.
+ */
product?: string;
+ /**
+ * Premier add on offer Vendor.
+ */
vendor?: string;
+ /**
+ * true if promotion code is required; otherwise, false.
+ */
promoCodeRequired?: boolean;
+ /**
+ * Premier add on offer Quota.
+ */
quota?: number;
+ /**
+ * App Service plans this offer is restricted to. Possible values include: 'None', 'Free',
+ * 'Shared', 'Basic', 'Standard', 'Premium'
+ */
webHostingPlanRestrictions?: string;
+ /**
+ * Privacy policy URL.
+ */
privacyPolicyUrl?: string;
+ /**
+ * Legal terms URL.
+ */
legalTermsUrl?: string;
+ /**
+ * Marketplace publisher.
+ */
marketplacePublisher?: string;
+ /**
+ * Marketplace offer.
+ */
marketplaceOffer?: string;
}
/**
- * @class
- * Initializes a new instance of the ResourceNameAvailability class.
- * @constructor
* Information regarding availbility of a resource name.
- *
- * @member {boolean} [nameAvailable] true indicates name is valid
- * and available. false indicates the name is invalid,
- * unavailable, or both.
- * @member {string} [reason] Invalid indicates the name provided
- * does not match Azure App Service naming requirements.
- * AlreadyExists indicates that the name is already in use and is
- * therefore unavailable. Possible values include: 'Invalid', 'AlreadyExists'
- * @member {string} [message] If reason == invalid, provide the user with the
- * reason why the given name is invalid, and provide the resource naming
- * requirements so that the user can select a valid name. If reason ==
- * AlreadyExists, explain that resource name is already in use, and direct them
- * to select a different name.
- */
+*/
export interface ResourceNameAvailability {
+ /**
+ * true indicates name is valid and available. false indicates the name
+ * is invalid, unavailable, or both.
+ */
nameAvailable?: boolean;
+ /**
+ * Invalid indicates the name provided does not match Azure App Service naming
+ * requirements. AlreadyExists indicates that the name is already in use and is
+ * therefore unavailable. Possible values include: 'Invalid', 'AlreadyExists'
+ */
reason?: string;
+ /**
+ * If reason == invalid, provide the user with the reason why the given name is invalid, and
+ * provide the resource naming requirements so that the user can select a valid name. If reason
+ * == AlreadyExists, explain that resource name is already in use, and direct them to select a
+ * different name.
+ */
message?: string;
}
/**
- * @class
- * Initializes a new instance of the ResourceNameAvailabilityRequest class.
- * @constructor
* Resource name availability request content.
- *
- * @member {string} name Resource name to verify.
- * @member {string} type Resource type used for verification. Possible values
- * include: 'Site', 'Slot', 'HostingEnvironment', 'PublishingUser',
- * 'Microsoft.Web/sites', 'Microsoft.Web/sites/slots',
- * 'Microsoft.Web/hostingEnvironments', 'Microsoft.Web/publishingUsers'
- * @member {boolean} [isFqdn] Is fully qualified domain name.
- */
+*/
export interface ResourceNameAvailabilityRequest {
+ /**
+ * Resource name to verify.
+ */
name: string;
+ /**
+ * Resource type used for verification. Possible values include: 'Site', 'Slot',
+ * 'HostingEnvironment', 'PublishingUser', 'Microsoft.Web/sites', 'Microsoft.Web/sites/slots',
+ * 'Microsoft.Web/hostingEnvironments', 'Microsoft.Web/publishingUsers'
+ */
type: string;
+ /**
+ * Is fully qualified domain name.
+ */
isFqdn?: boolean;
}
/**
- * @class
- * Initializes a new instance of the SkuInfos class.
- * @constructor
* Collection of SKU information.
- *
- * @member {string} [resourceType] Resource type that this SKU applies to.
- * @member {array} [skus] List of SKUs the subscription is able to use.
- */
+*/
export interface SkuInfos {
+ /**
+ * Resource type that this SKU applies to.
+ */
resourceType?: string;
+ /**
+ * List of SKUs the subscription is able to use.
+ */
skus?: GlobalCsmSkuDescription[];
}
/**
- * @class
- * Initializes a new instance of the SourceControl class.
- * @constructor
* The source control OAuth token.
- *
- * @member {string} [token] OAuth access token.
- * @member {string} [tokenSecret] OAuth access token secret.
- * @member {string} [refreshToken] OAuth refresh token.
- * @member {date} [expirationTime] OAuth token expiration.
- */
+*/
export interface SourceControl extends ProxyOnlyResource {
+ /**
+ * OAuth access token.
+ */
token?: string;
+ /**
+ * OAuth access token secret.
+ */
tokenSecret?: string;
+ /**
+ * OAuth refresh token.
+ */
refreshToken?: string;
+ /**
+ * OAuth token expiration.
+ */
expirationTime?: Date;
}
/**
- * @class
- * Initializes a new instance of the ValidateRequest class.
- * @constructor
* Resource validation request content.
- *
- * @member {string} name Resource name to verify.
- * @member {string} type Resource type used for verification. Possible values
- * include: 'ServerFarm', 'Site'
- * @member {string} location Expected location of the resource.
- * @member {string} [serverFarmId] ARM resource ID of an App Service plan that
- * would host the app.
- * @member {string} [skuName] Name of the target SKU for the App Service plan.
- * @member {boolean} [needLinuxWorkers] true if App Service plan
- * is for Linux workers; otherwise, false.
- * @member {boolean} [isSpot] true if App Service plan is for Spot
- * instances; otherwise, false.
- * @member {number} [capacity] Target capacity of the App Service plan (number
- * of VM's).
- * @member {string} [hostingEnvironment] Name of App Service Environment where
- * app or App Service plan should be created.
- * @member {boolean} [isXenon] true if App Service plan is running
- * as a windows container
- */
+*/
export interface ValidateRequest {
+ /**
+ * Resource name to verify.
+ */
name: string;
+ /**
+ * Resource type used for verification. Possible values include: 'ServerFarm', 'Site'
+ */
type: string;
+ /**
+ * Expected location of the resource.
+ */
location: string;
+ /**
+ * ARM resource ID of an App Service plan that would host the app.
+ */
serverFarmId?: string;
+ /**
+ * Name of the target SKU for the App Service plan.
+ */
skuName?: string;
+ /**
+ * true if App Service plan is for Linux workers; otherwise, false.
+ */
needLinuxWorkers?: boolean;
+ /**
+ * true if App Service plan is for Spot instances; otherwise, false.
+ */
isSpot?: boolean;
+ /**
+ * Target capacity of the App Service plan (number of VM's).
+ */
capacity?: number;
+ /**
+ * Name of App Service Environment where app or App Service plan should be created.
+ */
hostingEnvironment?: string;
+ /**
+ * true if App Service plan is running as a windows container
+ */
isXenon?: boolean;
}
/**
- * @class
- * Initializes a new instance of the ValidateResponseError class.
- * @constructor
* Error details for when validation fails.
- *
- * @member {string} [code] Validation error code.
- * @member {string} [message] Validation error message.
- */
+*/
export interface ValidateResponseError {
+ /**
+ * Validation error code.
+ */
code?: string;
+ /**
+ * Validation error message.
+ */
message?: string;
}
/**
- * @class
- * Initializes a new instance of the ValidateResponse class.
- * @constructor
* Describes the result of resource validation.
- *
- * @member {string} [status] Result of validation.
- * @member {object} [error] Error details for the case when validation fails.
- * @member {string} [error.code] Validation error code.
- * @member {string} [error.message] Validation error message.
- */
+*/
export interface ValidateResponse {
+ /**
+ * Result of validation.
+ */
status?: string;
+ /**
+ * Error details for the case when validation fails.
+ */
error?: ValidateResponseError;
}
/**
- * @class
- * Initializes a new instance of the VnetParameters class.
- * @constructor
* The required set of inputs to validate a VNET
- *
- * @member {string} [vnetResourceGroup] The Resource Group of the VNET to be
- * validated
- * @member {string} [vnetName] The name of the VNET to be validated
- * @member {string} [vnetSubnetName] The subnet name to be validated
- */
+*/
export interface VnetParameters extends ProxyOnlyResource {
+ /**
+ * The Resource Group of the VNET to be validated
+ */
vnetResourceGroup?: string;
+ /**
+ * The name of the VNET to be validated
+ */
vnetName?: string;
+ /**
+ * The subnet name to be validated
+ */
vnetSubnetName?: string;
}
/**
- * @class
- * Initializes a new instance of the VnetValidationTestFailure class.
- * @constructor
* A class that describes a test that failed during NSG and UDR validation.
- *
- * @member {string} [testName] The name of the test that failed.
- * @member {string} [details] The details of what caused the failure, e.g. the
- * blocking rule name, etc.
- */
+*/
export interface VnetValidationTestFailure extends ProxyOnlyResource {
+ /**
+ * The name of the test that failed.
+ */
testName?: string;
+ /**
+ * The details of what caused the failure, e.g. the blocking rule name, etc.
+ */
details?: string;
}
/**
- * @class
- * Initializes a new instance of the VnetValidationFailureDetails class.
- * @constructor
* A class that describes the reason for a validation failure.
- *
- * @member {boolean} [failed] A flag describing whether or not validation
- * failed.
- * @member {array} [failedTests] A list of tests that failed in the validation.
- */
+*/
export interface VnetValidationFailureDetails extends ProxyOnlyResource {
+ /**
+ * A flag describing whether or not validation failed.
+ */
failed?: boolean;
+ /**
+ * A list of tests that failed in the validation.
+ */
failedTests?: VnetValidationTestFailure[];
}
/**
- * @class
- * Initializes a new instance of the FileSystemApplicationLogsConfig class.
- * @constructor
* Application logs to file system configuration.
- *
- * @member {string} [level] Log level. Possible values include: 'Off',
- * 'Verbose', 'Information', 'Warning', 'Error'. Default value: 'Off' .
- */
+*/
export interface FileSystemApplicationLogsConfig {
+ /**
+ * Log level. Possible values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'
+ */
level?: string;
}
/**
- * @class
- * Initializes a new instance of the AzureTableStorageApplicationLogsConfig class.
- * @constructor
* Application logs to Azure table storage configuration.
- *
- * @member {string} [level] Log level. Possible values include: 'Off',
- * 'Verbose', 'Information', 'Warning', 'Error'
- * @member {string} sasUrl SAS URL to an Azure table with add/query/delete
- * permissions.
- */
+*/
export interface AzureTableStorageApplicationLogsConfig {
+ /**
+ * Log level. Possible values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'
+ */
level?: string;
+ /**
+ * SAS URL to an Azure table with add/query/delete permissions.
+ */
sasUrl: string;
}
/**
- * @class
- * Initializes a new instance of the AzureBlobStorageApplicationLogsConfig class.
- * @constructor
* Application logs azure blob storage configuration.
- *
- * @member {string} [level] Log level. Possible values include: 'Off',
- * 'Verbose', 'Information', 'Warning', 'Error'
- * @member {string} [sasUrl] SAS url to a azure blob container with
- * read/write/list/delete permissions.
- * @member {number} [retentionInDays] Retention in days.
- * Remove blobs older than X days.
- * 0 or lower means no retention.
- */
+*/
export interface AzureBlobStorageApplicationLogsConfig {
+ /**
+ * Log level. Possible values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'
+ */
level?: string;
+ /**
+ * SAS url to a azure blob container with read/write/list/delete permissions.
+ */
sasUrl?: string;
+ /**
+ * Retention in days.
+ * Remove blobs older than X days.
+ * 0 or lower means no retention.
+ */
retentionInDays?: number;
}
/**
- * @class
- * Initializes a new instance of the ApplicationLogsConfig class.
- * @constructor
* Application logs configuration.
- *
- * @member {object} [fileSystem] Application logs to file system configuration.
- * @member {string} [fileSystem.level] Log level. Possible values include:
- * 'Off', 'Verbose', 'Information', 'Warning', 'Error'
- * @member {object} [azureTableStorage] Application logs to azure table storage
- * configuration.
- * @member {string} [azureTableStorage.level] Log level. Possible values
- * include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'
- * @member {string} [azureTableStorage.sasUrl] SAS URL to an Azure table with
- * add/query/delete permissions.
- * @member {object} [azureBlobStorage] Application logs to blob storage
- * configuration.
- * @member {string} [azureBlobStorage.level] Log level. Possible values
- * include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'
- * @member {string} [azureBlobStorage.sasUrl] SAS url to a azure blob container
- * with read/write/list/delete permissions.
- * @member {number} [azureBlobStorage.retentionInDays] Retention in days.
- * Remove blobs older than X days.
- * 0 or lower means no retention.
- */
+*/
export interface ApplicationLogsConfig {
+ /**
+ * Application logs to file system configuration.
+ */
fileSystem?: FileSystemApplicationLogsConfig;
+ /**
+ * Application logs to azure table storage configuration.
+ */
azureTableStorage?: AzureTableStorageApplicationLogsConfig;
+ /**
+ * Application logs to blob storage configuration.
+ */
azureBlobStorage?: AzureBlobStorageApplicationLogsConfig;
}
/**
- * @class
- * Initializes a new instance of the AzureBlobStorageHttpLogsConfig class.
- * @constructor
* Http logs to azure blob storage configuration.
- *
- * @member {string} [sasUrl] SAS url to a azure blob container with
- * read/write/list/delete permissions.
- * @member {number} [retentionInDays] Retention in days.
- * Remove blobs older than X days.
- * 0 or lower means no retention.
- * @member {boolean} [enabled] True if configuration is enabled, false if it is
- * disabled and null if configuration is not set.
- */
+*/
export interface AzureBlobStorageHttpLogsConfig {
+ /**
+ * SAS url to a azure blob container with read/write/list/delete permissions.
+ */
sasUrl?: string;
+ /**
+ * Retention in days.
+ * Remove blobs older than X days.
+ * 0 or lower means no retention.
+ */
retentionInDays?: number;
+ /**
+ * True if configuration is enabled, false if it is disabled and null if configuration is not
+ * set.
+ */
enabled?: boolean;
}
/**
- * @class
- * Initializes a new instance of the AzureStoragePropertyDictionaryResource class.
- * @constructor
* AzureStorageInfo dictionary resource.
- *
- * @member {object} [properties] Azure storage accounts.
- */
+*/
export interface AzureStoragePropertyDictionaryResource extends ProxyOnlyResource {
+ /**
+ * Azure storage accounts.
+ */
properties?: { [propertyName: string]: AzureStorageInfoValue };
}
/**
- * @class
- * Initializes a new instance of the DatabaseBackupSetting class.
- * @constructor
* Database backup settings.
- *
- * @member {string} databaseType Database type (e.g. SqlAzure / MySql).
- * Possible values include: 'SqlAzure', 'MySql', 'LocalMySql', 'PostgreSql'
- * @member {string} [name]
- * @member {string} [connectionStringName] Contains a connection string name
- * that is linked to the SiteConfig.ConnectionStrings.
- * This is used during restore with overwrite connection strings options.
- * @member {string} [connectionString] Contains a connection string to a
- * database which is being backed up or restored. If the restore should happen
- * to a new database, the database name inside is the new one.
- */
+*/
export interface DatabaseBackupSetting {
+ /**
+ * Database type (e.g. SqlAzure / MySql). Possible values include: 'SqlAzure', 'MySql',
+ * 'LocalMySql', 'PostgreSql'
+ */
databaseType: string;
name?: string;
+ /**
+ * Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.
+ * This is used during restore with overwrite connection strings options.
+ */
connectionStringName?: string;
+ /**
+ * Contains a connection string to a database which is being backed up or restored. If the
+ * restore should happen to a new database, the database name inside is the new one.
+ */
connectionString?: string;
}
/**
- * @class
- * Initializes a new instance of the BackupItem class.
- * @constructor
* Backup description.
- *
- * @member {number} [backupId] Id of the backup.
- * @member {string} [storageAccountUrl] SAS URL for the storage account
- * container which contains this backup.
- * @member {string} [blobName] Name of the blob which contains data for this
- * backup.
- * @member {string} [backupItemName] Name of this backup.
- * @member {string} [status] Backup status. Possible values include:
- * 'InProgress', 'Failed', 'Succeeded', 'TimedOut', 'Created', 'Skipped',
- * 'PartiallySucceeded', 'DeleteInProgress', 'DeleteFailed', 'Deleted'
- * @member {number} [sizeInBytes] Size of the backup in bytes.
- * @member {date} [created] Timestamp of the backup creation.
- * @member {string} [log] Details regarding this backup. Might contain an error
- * message.
- * @member {array} [databases] List of databases included in the backup.
- * @member {boolean} [scheduled] True if this backup has been created due to a
- * schedule being triggered.
- * @member {date} [lastRestoreTimeStamp] Timestamp of a last restore operation
- * which used this backup.
- * @member {date} [finishedTimeStamp] Timestamp when this backup finished.
- * @member {string} [correlationId] Unique correlation identifier. Please use
- * this along with the timestamp while communicating with Azure support.
- * @member {number} [websiteSizeInBytes] Size of the original web app which has
- * been backed up.
- */
+*/
export interface BackupItem extends ProxyOnlyResource {
+ /**
+ * Id of the backup.
+ */
readonly backupId?: number;
+ /**
+ * SAS URL for the storage account container which contains this backup.
+ */
readonly storageAccountUrl?: string;
+ /**
+ * Name of the blob which contains data for this backup.
+ */
readonly blobName?: string;
+ /**
+ * Name of this backup.
+ */
readonly backupItemName?: string;
+ /**
+ * Backup status. Possible values include: 'InProgress', 'Failed', 'Succeeded', 'TimedOut',
+ * 'Created', 'Skipped', 'PartiallySucceeded', 'DeleteInProgress', 'DeleteFailed', 'Deleted'
+ */
readonly status?: string;
+ /**
+ * Size of the backup in bytes.
+ */
readonly sizeInBytes?: number;
+ /**
+ * Timestamp of the backup creation.
+ */
readonly created?: Date;
+ /**
+ * Details regarding this backup. Might contain an error message.
+ */
readonly log?: string;
+ /**
+ * List of databases included in the backup.
+ */
readonly databases?: DatabaseBackupSetting[];
+ /**
+ * True if this backup has been created due to a schedule being triggered.
+ */
readonly scheduled?: boolean;
+ /**
+ * Timestamp of a last restore operation which used this backup.
+ */
readonly lastRestoreTimeStamp?: Date;
+ /**
+ * Timestamp when this backup finished.
+ */
readonly finishedTimeStamp?: Date;
+ /**
+ * Unique correlation identifier. Please use this along with the timestamp while communicating
+ * with Azure support.
+ */
readonly correlationId?: string;
+ /**
+ * Size of the original web app which has been backed up.
+ */
readonly websiteSizeInBytes?: number;
}
/**
- * @class
- * Initializes a new instance of the BackupSchedule class.
- * @constructor
- * Description of a backup schedule. Describes how often should be the backup
- * performed and what should be the retention policy.
- *
- * @member {number} frequencyInterval How often the backup should be executed
- * (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be
- * set to Day). Default value: 7 .
- * @member {string} frequencyUnit The unit of time for how often the backup
- * should be executed (e.g. for weekly backup, this should be set to Day and
- * FrequencyInterval should be set to 7). Possible values include: 'Day',
- * 'Hour'. Default value: 'Day' .
- * @member {boolean} keepAtLeastOneBackup True if the retention policy should
- * always keep at least one backup in the storage account, regardless how old
- * it is; false otherwise. Default value: true .
- * @member {number} retentionPeriodInDays After how many days backups should be
- * deleted. Default value: 30 .
- * @member {date} [startTime] When the schedule should start working.
- * @member {date} [lastExecutionTime] Last time when this schedule was
- * triggered.
- */
+ * Description of a backup schedule. Describes how often should be the backup performed and what
+ * should be the retention policy.
+*/
export interface BackupSchedule {
+ /**
+ * How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and
+ * FrequencyUnit should be set to Day)
+ */
frequencyInterval: number;
+ /**
+ * The unit of time for how often the backup should be executed (e.g. for weekly backup, this
+ * should be set to Day and FrequencyInterval should be set to 7). Possible values include:
+ * 'Day', 'Hour'
+ */
frequencyUnit: string;
+ /**
+ * True if the retention policy should always keep at least one backup in the storage account,
+ * regardless how old it is; false otherwise.
+ */
keepAtLeastOneBackup: boolean;
+ /**
+ * After how many days backups should be deleted.
+ */
retentionPeriodInDays: number;
+ /**
+ * When the schedule should start working.
+ */
startTime?: Date;
+ /**
+ * Last time when this schedule was triggered.
+ */
readonly lastExecutionTime?: Date;
}
/**
- * @class
- * Initializes a new instance of the BackupRequest class.
- * @constructor
* Description of a backup which will be performed.
- *
- * @member {string} [backupName] Name of the backup.
- * @member {boolean} [enabled] True if the backup schedule is enabled (must be
- * included in that case), false if the backup schedule should be disabled.
- * @member {string} storageAccountUrl SAS URL to the container.
- * @member {object} [backupSchedule] Schedule for the backup if it is executed
- * periodically.
- * @member {number} [backupSchedule.frequencyInterval] How often the backup
- * should be executed (e.g. for weekly backup, this should be set to 7 and
- * FrequencyUnit should be set to Day)
- * @member {string} [backupSchedule.frequencyUnit] The unit of time for how
- * often the backup should be executed (e.g. for weekly backup, this should be
- * set to Day and FrequencyInterval should be set to 7). Possible values
- * include: 'Day', 'Hour'
- * @member {boolean} [backupSchedule.keepAtLeastOneBackup] True if the
- * retention policy should always keep at least one backup in the storage
- * account, regardless how old it is; false otherwise.
- * @member {number} [backupSchedule.retentionPeriodInDays] After how many days
- * backups should be deleted.
- * @member {date} [backupSchedule.startTime] When the schedule should start
- * working.
- * @member {date} [backupSchedule.lastExecutionTime] Last time when this
- * schedule was triggered.
- * @member {array} [databases] Databases included in the backup.
- */
+*/
export interface BackupRequest extends ProxyOnlyResource {
+ /**
+ * Name of the backup.
+ */
backupName?: string;
+ /**
+ * True if the backup schedule is enabled (must be included in that case), false if the backup
+ * schedule should be disabled.
+ */
enabled?: boolean;
+ /**
+ * SAS URL to the container.
+ */
storageAccountUrl: string;
+ /**
+ * Schedule for the backup if it is executed periodically.
+ */
backupSchedule?: BackupSchedule;
+ /**
+ * Databases included in the backup.
+ */
databases?: DatabaseBackupSetting[];
}
/**
- * @class
- * Initializes a new instance of the ConnStringValueTypePair class.
- * @constructor
* Database connection string value to type pair.
- *
- * @member {string} value Value of pair.
- * @member {string} type Type of database. Possible values include: 'MySql',
- * 'SQLServer', 'SQLAzure', 'Custom', 'NotificationHub', 'ServiceBus',
- * 'EventHub', 'ApiHub', 'DocDb', 'RedisCache', 'PostgreSQL'
- */
+*/
export interface ConnStringValueTypePair {
+ /**
+ * Value of pair.
+ */
value: string;
+ /**
+ * Type of database. Possible values include: 'MySql', 'SQLServer', 'SQLAzure', 'Custom',
+ * 'NotificationHub', 'ServiceBus', 'EventHub', 'ApiHub', 'DocDb', 'RedisCache', 'PostgreSQL'
+ */
type: string;
}
/**
- * @class
- * Initializes a new instance of the ConnectionStringDictionary class.
- * @constructor
* String dictionary resource.
- *
- * @member {object} [properties] Connection strings.
- */
+*/
export interface ConnectionStringDictionary extends ProxyOnlyResource {
+ /**
+ * Connection strings.
+ */
properties?: { [propertyName: string]: ConnStringValueTypePair };
}
/**
- * @class
- * Initializes a new instance of the ContinuousWebJob class.
- * @constructor
* Continuous Web Job Information.
- *
- * @member {string} [status] Job status. Possible values include:
- * 'Initializing', 'Starting', 'Running', 'PendingRestart', 'Stopped'
- * @member {string} [detailedStatus] Detailed status.
- * @member {string} [logUrl] Log URL.
- * @member {string} [runCommand] Run command.
- * @member {string} [url] Job URL.
- * @member {string} [extraInfoUrl] Extra Info URL.
- * @member {string} [webJobType] Job type. Possible values include:
- * 'Continuous', 'Triggered'
- * @member {string} [error] Error information.
- * @member {boolean} [usingSdk] Using SDK?
- * @member {object} [settings] Job settings.
- */
+*/
export interface ContinuousWebJob extends ProxyOnlyResource {
+ /**
+ * Job status. Possible values include: 'Initializing', 'Starting', 'Running', 'PendingRestart',
+ * 'Stopped'
+ */
status?: string;
+ /**
+ * Detailed status.
+ */
detailedStatus?: string;
+ /**
+ * Log URL.
+ */
logUrl?: string;
+ /**
+ * Run command.
+ */
runCommand?: string;
+ /**
+ * Job URL.
+ */
url?: string;
+ /**
+ * Extra Info URL.
+ */
extraInfoUrl?: string;
+ /**
+ * Job type. Possible values include: 'Continuous', 'Triggered'
+ */
webJobType?: string;
+ /**
+ * Error information.
+ */
error?: string;
+ /**
+ * Using SDK?
+ */
usingSdk?: boolean;
+ /**
+ * Job settings.
+ */
settings?: { [propertyName: string]: any };
}
/**
- * @class
- * Initializes a new instance of the CsmPublishingProfileOptions class.
- * @constructor
* Publishing options for requested profile.
- *
- * @member {string} [format] Name of the format. Valid values are:
- * FileZilla3
- * WebDeploy -- default
- * Ftp. Possible values include: 'FileZilla3', 'WebDeploy', 'Ftp'
- * @member {boolean} [includeDisasterRecoveryEndpoints] Include the
- * DisasterRecover endpoint if true
- */
+*/
export interface CsmPublishingProfileOptions {
+ /**
+ * Name of the format. Valid values are:
+ * FileZilla3
+ * WebDeploy -- default
+ * Ftp. Possible values include: 'FileZilla3', 'WebDeploy', 'Ftp'
+ */
format?: string;
+ /**
+ * Include the DisasterRecover endpoint if true
+ */
includeDisasterRecoveryEndpoints?: boolean;
}
/**
- * @class
- * Initializes a new instance of the CsmSlotEntity class.
- * @constructor
* Deployment slot parameters.
- *
- * @member {string} targetSlot Destination deployment slot during swap
- * operation.
- * @member {boolean} preserveVnet true to preserve Virtual Network
- * to the slot during swap; otherwise, false.
- */
+*/
export interface CsmSlotEntity {
+ /**
+ * Destination deployment slot during swap operation.
+ */
targetSlot: string;
+ /**
+ * true to preserve Virtual Network to the slot during swap; otherwise,
+ * false.
+ */
preserveVnet: boolean;
}
/**
- * @class
- * Initializes a new instance of the CustomHostnameAnalysisResult class.
- * @constructor
* Custom domain analysis.
- *
- * @member {boolean} [isHostnameAlreadyVerified] true if hostname
- * is already verified; otherwise, false.
- * @member {string} [customDomainVerificationTest] DNS verification test
- * result. Possible values include: 'Passed', 'Failed', 'Skipped'
- * @member {object} [customDomainVerificationFailureInfo] Raw failure
- * information if DNS verification fails.
- * @member {string} [customDomainVerificationFailureInfo.extendedCode] Type of
- * error.
- * @member {string} [customDomainVerificationFailureInfo.messageTemplate]
- * Message template.
- * @member {array} [customDomainVerificationFailureInfo.parameters] Parameters
- * for the template.
- * @member {array} [customDomainVerificationFailureInfo.innerErrors] Inner
- * errors.
- * @member {string} [customDomainVerificationFailureInfo.code] Basic error
- * code.
- * @member {string} [customDomainVerificationFailureInfo.message] Any details
- * of the error.
- * @member {boolean} [hasConflictOnScaleUnit] true if there is a
- * conflict on a scale unit; otherwise, false.
- * @member {boolean} [hasConflictAcrossSubscription] true if htere
- * is a conflict across subscriptions; otherwise, false.
- * @member {string} [conflictingAppResourceId] Name of the conflicting app on
- * scale unit if it's within the same subscription.
- * @member {array} [cNameRecords] CName records controller can see for this
- * hostname.
- * @member {array} [txtRecords] TXT records controller can see for this
- * hostname.
- * @member {array} [aRecords] A records controller can see for this hostname.
- * @member {array} [alternateCNameRecords] Alternate CName records controller
- * can see for this hostname.
- * @member {array} [alternateTxtRecords] Alternate TXT records controller can
- * see for this hostname.
- */
+*/
export interface CustomHostnameAnalysisResult extends ProxyOnlyResource {
+ /**
+ * true if hostname is already verified; otherwise, false.
+ */
readonly isHostnameAlreadyVerified?: boolean;
+ /**
+ * DNS verification test result. Possible values include: 'Passed', 'Failed', 'Skipped'
+ */
readonly customDomainVerificationTest?: string;
+ /**
+ * Raw failure information if DNS verification fails.
+ */
readonly customDomainVerificationFailureInfo?: ErrorEntity;
+ /**
+ * true if there is a conflict on a scale unit; otherwise, false.
+ */
readonly hasConflictOnScaleUnit?: boolean;
+ /**
+ * true if htere is a conflict across subscriptions; otherwise, false.
+ */
readonly hasConflictAcrossSubscription?: boolean;
+ /**
+ * Name of the conflicting app on scale unit if it's within the same subscription.
+ */
readonly conflictingAppResourceId?: string;
+ /**
+ * CName records controller can see for this hostname.
+ */
cNameRecords?: string[];
+ /**
+ * TXT records controller can see for this hostname.
+ */
txtRecords?: string[];
+ /**
+ * A records controller can see for this hostname.
+ */
aRecords?: string[];
+ /**
+ * Alternate CName records controller can see for this hostname.
+ */
alternateCNameRecords?: string[];
+ /**
+ * Alternate TXT records controller can see for this hostname.
+ */
alternateTxtRecords?: string[];
}
/**
- * @class
- * Initializes a new instance of the DeletedAppRestoreRequest class.
- * @constructor
* Details about restoring a deleted app.
- *
- * @member {string} [deletedSiteId] ARM resource ID of the deleted app.
- * Example:
- * /subscriptions/{subId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}
- * @member {boolean} [recoverConfiguration] If true, deleted site
- * configuration, in addition to content, will be restored.
- * @member {string} [snapshotTime] Point in time to restore the deleted app
- * from, formatted as a DateTime string.
- * If unspecified, default value is the time that the app was deleted.
- * @member {boolean} [useDRSecondary] If true, the snapshot is retrieved from
- * DRSecondary endpoint.
- */
+*/
export interface DeletedAppRestoreRequest extends ProxyOnlyResource {
+ /**
+ * ARM resource ID of the deleted app. Example:
+ * /subscriptions/{subId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}
+ */
deletedSiteId?: string;
+ /**
+ * If true, deleted site configuration, in addition to content, will be restored.
+ */
recoverConfiguration?: boolean;
+ /**
+ * Point in time to restore the deleted app from, formatted as a DateTime string.
+ * If unspecified, default value is the time that the app was deleted.
+ */
snapshotTime?: string;
+ /**
+ * If true, the snapshot is retrieved from DRSecondary endpoint.
+ */
useDRSecondary?: boolean;
}
/**
- * @class
- * Initializes a new instance of the Deployment class.
- * @constructor
* User crendentials used for publishing activity.
- *
- * @member {number} [status] Deployment status.
- * @member {string} [message] Details about deployment status.
- * @member {string} [author] Who authored the deployment.
- * @member {string} [deployer] Who performed the deployment.
- * @member {string} [authorEmail] Author email.
- * @member {date} [startTime] Start time.
- * @member {date} [endTime] End time.
- * @member {boolean} [active] True if deployment is currently active, false if
- * completed and null if not started.
- * @member {string} [details] Details on deployment.
- */
+*/
export interface Deployment extends ProxyOnlyResource {
+ /**
+ * Deployment status.
+ */
status?: number;
+ /**
+ * Details about deployment status.
+ */
message?: string;
+ /**
+ * Who authored the deployment.
+ */
author?: string;
+ /**
+ * Who performed the deployment.
+ */
deployer?: string;
+ /**
+ * Author email.
+ */
authorEmail?: string;
+ /**
+ * Start time.
+ */
startTime?: Date;
+ /**
+ * End time.
+ */
endTime?: Date;
+ /**
+ * True if deployment is currently active, false if completed and null if not started.
+ */
active?: boolean;
+ /**
+ * Details on deployment.
+ */
details?: string;
}
/**
- * @class
- * Initializes a new instance of the EnabledConfig class.
- * @constructor
* Enabled configuration.
- *
- * @member {boolean} [enabled] True if configuration is enabled, false if it is
- * disabled and null if configuration is not set.
- */
+*/
export interface EnabledConfig {
+ /**
+ * True if configuration is enabled, false if it is disabled and null if configuration is not
+ * set.
+ */
enabled?: boolean;
}
/**
- * @class
- * Initializes a new instance of the FileSystemHttpLogsConfig class.
- * @constructor
* Http logs to file system configuration.
- *
- * @member {number} [retentionInMb] Maximum size in megabytes that http log
- * files can use.
- * When reached old log files will be removed to make space for new ones.
- * Value can range between 25 and 100.
- * @member {number} [retentionInDays] Retention in days.
- * Remove files older than X days.
- * 0 or lower means no retention.
- * @member {boolean} [enabled] True if configuration is enabled, false if it is
- * disabled and null if configuration is not set.
- */
+*/
export interface FileSystemHttpLogsConfig {
+ /**
+ * Maximum size in megabytes that http log files can use.
+ * When reached old log files will be removed to make space for new ones.
+ * Value can range between 25 and 100.
+ */
retentionInMb?: number;
+ /**
+ * Retention in days.
+ * Remove files older than X days.
+ * 0 or lower means no retention.
+ */
retentionInDays?: number;
+ /**
+ * True if configuration is enabled, false if it is disabled and null if configuration is not
+ * set.
+ */
enabled?: boolean;
}
/**
- * @class
- * Initializes a new instance of the FunctionEnvelope class.
- * @constructor
* Web Job Information.
- *
- * @member {string} [functionAppId] Function App ID.
- * @member {string} [scriptRootPathHref] Script root path URI.
- * @member {string} [scriptHref] Script URI.
- * @member {string} [configHref] Config URI.
- * @member {string} [secretsFileHref] Secrets file URI.
- * @member {string} [href] Function URI.
- * @member {object} [config] Config information.
- * @member {object} [files] File list.
- * @member {string} [testData] Test data used when testing via the Azure
- * Portal.
- */
+*/
export interface FunctionEnvelope extends ProxyOnlyResource {
+ /**
+ * Function App ID.
+ */
functionAppId?: string;
+ /**
+ * Script root path URI.
+ */
scriptRootPathHref?: string;
+ /**
+ * Script URI.
+ */
scriptHref?: string;
+ /**
+ * Config URI.
+ */
configHref?: string;
+ /**
+ * Secrets file URI.
+ */
secretsFileHref?: string;
+ /**
+ * Function URI.
+ */
href?: string;
+ /**
+ * Config information.
+ */
config?: any;
+ /**
+ * File list.
+ */
files?: { [propertyName: string]: string };
+ /**
+ * Test data used when testing via the Azure Portal.
+ */
testData?: string;
}
/**
- * @class
- * Initializes a new instance of the FunctionSecrets class.
- * @constructor
* Function secrets.
- *
- * @member {string} [key] Secret key.
- * @member {string} [triggerUrl] Trigger URL.
- */
+*/
export interface FunctionSecrets extends ProxyOnlyResource {
+ /**
+ * Secret key.
+ */
key?: string;
+ /**
+ * Trigger URL.
+ */
triggerUrl?: string;
}
/**
- * @class
- * Initializes a new instance of the HostNameBinding class.
- * @constructor
* A hostname binding object.
- *
- * @member {string} [siteName] App Service app name.
- * @member {string} [domainId] Fully qualified ARM domain resource URI.
- * @member {string} [azureResourceName] Azure resource name.
- * @member {string} [azureResourceType] Azure resource type. Possible values
- * include: 'Website', 'TrafficManager'
- * @member {string} [customHostNameDnsRecordType] Custom DNS record type.
- * Possible values include: 'CName', 'A'
- * @member {string} [hostNameType] Hostname type. Possible values include:
- * 'Verified', 'Managed'
- * @member {string} [sslState] SSL type. Possible values include: 'Disabled',
- * 'SniEnabled', 'IpBasedEnabled'
- * @member {string} [thumbprint] SSL certificate thumbprint
- * @member {string} [virtualIP] Virtual IP address assigned to the hostname if
- * IP based SSL is enabled.
- */
+*/
export interface HostNameBinding extends ProxyOnlyResource {
+ /**
+ * App Service app name.
+ */
siteName?: string;
+ /**
+ * Fully qualified ARM domain resource URI.
+ */
domainId?: string;
+ /**
+ * Azure resource name.
+ */
azureResourceName?: string;
+ /**
+ * Azure resource type. Possible values include: 'Website', 'TrafficManager'
+ */
azureResourceType?: string;
+ /**
+ * Custom DNS record type. Possible values include: 'CName', 'A'
+ */
customHostNameDnsRecordType?: string;
+ /**
+ * Hostname type. Possible values include: 'Verified', 'Managed'
+ */
hostNameType?: string;
+ /**
+ * SSL type. Possible values include: 'Disabled', 'SniEnabled', 'IpBasedEnabled'
+ */
sslState?: string;
+ /**
+ * SSL certificate thumbprint
+ */
thumbprint?: string;
+ /**
+ * Virtual IP address assigned to the hostname if IP based SSL is enabled.
+ */
readonly virtualIP?: string;
}
/**
- * @class
- * Initializes a new instance of the HttpLogsConfig class.
- * @constructor
* Http logs configuration.
- *
- * @member {object} [fileSystem] Http logs to file system configuration.
- * @member {number} [fileSystem.retentionInMb] Maximum size in megabytes that
- * http log files can use.
- * When reached old log files will be removed to make space for new ones.
- * Value can range between 25 and 100.
- * @member {number} [fileSystem.retentionInDays] Retention in days.
- * Remove files older than X days.
- * 0 or lower means no retention.
- * @member {boolean} [fileSystem.enabled] True if configuration is enabled,
- * false if it is disabled and null if configuration is not set.
- * @member {object} [azureBlobStorage] Http logs to azure blob storage
- * configuration.
- * @member {string} [azureBlobStorage.sasUrl] SAS url to a azure blob container
- * with read/write/list/delete permissions.
- * @member {number} [azureBlobStorage.retentionInDays] Retention in days.
- * Remove blobs older than X days.
- * 0 or lower means no retention.
- * @member {boolean} [azureBlobStorage.enabled] True if configuration is
- * enabled, false if it is disabled and null if configuration is not set.
- */
+*/
export interface HttpLogsConfig {
+ /**
+ * Http logs to file system configuration.
+ */
fileSystem?: FileSystemHttpLogsConfig;
+ /**
+ * Http logs to azure blob storage configuration.
+ */
azureBlobStorage?: AzureBlobStorageHttpLogsConfig;
}
/**
- * @class
- * Initializes a new instance of the MSDeploy class.
- * @constructor
* MSDeploy ARM PUT information
- *
- * @member {string} [packageUri] Package URI
- * @member {string} [connectionString] SQL Connection String
- * @member {string} [dbType] Database Type
- * @member {string} [setParametersXmlFileUri] URI of MSDeploy Parameters file.
- * Must not be set if SetParameters is used.
- * @member {object} [setParameters] MSDeploy Parameters. Must not be set if
- * SetParametersXmlFileUri is used.
- * @member {boolean} [skipAppData] Controls whether the MSDeploy operation
- * skips the App_Data directory.
- * If set to true, the existing App_Data directory on the
- * destination
- * will not be deleted, and any App_Data directory in the source will be
- * ignored.
- * Setting is false by default.
- * @member {boolean} [appOffline] Sets the AppOffline rule while the MSDeploy
- * operation executes.
- * Setting is false by default.
- */
+*/
export interface MSDeploy extends ProxyOnlyResource {
+ /**
+ * Package URI
+ */
packageUri?: string;
+ /**
+ * SQL Connection String
+ */
connectionString?: string;
+ /**
+ * Database Type
+ */
dbType?: string;
+ /**
+ * URI of MSDeploy Parameters file. Must not be set if SetParameters is used.
+ */
setParametersXmlFileUri?: string;
+ /**
+ * MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.
+ */
setParameters?: { [propertyName: string]: string };
+ /**
+ * Controls whether the MSDeploy operation skips the App_Data directory.
+ * If set to true, the existing App_Data directory on the destination
+ * will not be deleted, and any App_Data directory in the source will be ignored.
+ * Setting is false by default.
+ */
skipAppData?: boolean;
+ /**
+ * Sets the AppOffline rule while the MSDeploy operation executes.
+ * Setting is false by default.
+ */
appOffline?: boolean;
}
/**
- * @class
- * Initializes a new instance of the MSDeployLogEntry class.
- * @constructor
* MSDeploy log entry
- *
- * @member {date} [time] Timestamp of log entry
- * @member {string} [type] Log entry type. Possible values include: 'Message',
- * 'Warning', 'Error'
- * @member {string} [message] Log entry message
- */
+*/
export interface MSDeployLogEntry {
+ /**
+ * Timestamp of log entry
+ */
readonly time?: Date;
+ /**
+ * Log entry type. Possible values include: 'Message', 'Warning', 'Error'
+ */
readonly type?: string;
+ /**
+ * Log entry message
+ */
readonly message?: string;
}
/**
- * @class
- * Initializes a new instance of the MSDeployLog class.
- * @constructor
* MSDeploy log
- *
- * @member {array} [entries] List of log entry messages
- */
+*/
export interface MSDeployLog extends ProxyOnlyResource {
+ /**
+ * List of log entry messages
+ */
readonly entries?: MSDeployLogEntry[];
}
/**
- * @class
- * Initializes a new instance of the MSDeployStatus class.
- * @constructor
* MSDeploy ARM response
- *
- * @member {string} [deployer] Username of deployer
- * @member {string} [provisioningState] Provisioning state. Possible values
- * include: 'accepted', 'running', 'succeeded', 'failed', 'canceled'
- * @member {date} [startTime] Start time of deploy operation
- * @member {date} [endTime] End time of deploy operation
- * @member {boolean} [complete] Whether the deployment operation has completed
- */
+*/
export interface MSDeployStatus extends ProxyOnlyResource {
+ /**
+ * Username of deployer
+ */
readonly deployer?: string;
+ /**
+ * Provisioning state. Possible values include: 'accepted', 'running', 'succeeded', 'failed',
+ * 'canceled'
+ */
readonly provisioningState?: string;
+ /**
+ * Start time of deploy operation
+ */
readonly startTime?: Date;
+ /**
+ * End time of deploy operation
+ */
readonly endTime?: Date;
+ /**
+ * Whether the deployment operation has completed
+ */
readonly complete?: boolean;
}
/**
- * @class
- * Initializes a new instance of the MigrateMySqlRequest class.
- * @constructor
* MySQL migration request.
- *
- * @member {string} connectionString Connection string to the remote MySQL
- * database.
- * @member {string} migrationType The type of migration operation to be done.
- * Possible values include: 'LocalToRemote', 'RemoteToLocal'
- */
+*/
export interface MigrateMySqlRequest extends ProxyOnlyResource {
+ /**
+ * Connection string to the remote MySQL database.
+ */
connectionString: string;
+ /**
+ * The type of migration operation to be done. Possible values include: 'LocalToRemote',
+ * 'RemoteToLocal'
+ */
migrationType: string;
}
/**
- * @class
- * Initializes a new instance of the MigrateMySqlStatus class.
- * @constructor
* MySQL migration status.
- *
- * @member {string} [migrationOperationStatus] Status of the migration task.
- * Possible values include: 'InProgress', 'Failed', 'Succeeded', 'TimedOut',
- * 'Created'
- * @member {string} [operationId] Operation ID for the migration task.
- * @member {boolean} [localMySqlEnabled] True if the web app has in app MySql
- * enabled
- */
+*/
export interface MigrateMySqlStatus extends ProxyOnlyResource {
+ /**
+ * Status of the migration task. Possible values include: 'InProgress', 'Failed', 'Succeeded',
+ * 'TimedOut', 'Created'
+ */
readonly migrationOperationStatus?: string;
+ /**
+ * Operation ID for the migration task.
+ */
readonly operationId?: string;
+ /**
+ * True if the web app has in app MySql enabled
+ */
readonly localMySqlEnabled?: boolean;
}
/**
- * @class
- * Initializes a new instance of the RelayServiceConnectionEntity class.
- * @constructor
* Hybrid Connection for an App Service app.
- *
- * @member {string} [entityName]
- * @member {string} [entityConnectionString]
- * @member {string} [resourceType]
- * @member {string} [resourceConnectionString]
- * @member {string} [hostname]
- * @member {number} [port]
- * @member {string} [biztalkUri]
- */
+*/
export interface RelayServiceConnectionEntity extends ProxyOnlyResource {
entityName?: string;
entityConnectionString?: string;
@@ -4867,2768 +4853,2733 @@ export interface RelayServiceConnectionEntity extends ProxyOnlyResource {
}
/**
- * @class
- * Initializes a new instance of the NetworkFeatures class.
- * @constructor
- * Full view of network features for an app (presently VNET integration and
- * Hybrid Connections).
- *
- * @member {string} [virtualNetworkName] The Virtual Network name.
- * @member {object} [virtualNetworkConnection] The Virtual Network summary
- * view.
- * @member {string} [virtualNetworkConnection.vnetResourceId] The Virtual
- * Network's resource ID.
- * @member {string} [virtualNetworkConnection.certThumbprint] The client
- * certificate thumbprint.
- * @member {buffer} [virtualNetworkConnection.certBlob] A certificate file
- * (.cer) blob containing the public key of the private key used to
- * authenticate a
- * Point-To-Site VPN connection.
- * @member {array} [virtualNetworkConnection.routes] The routes that this
- * Virtual Network connection uses.
- * @member {boolean} [virtualNetworkConnection.resyncRequired]
- * true if a resync is required; otherwise, false.
- * @member {string} [virtualNetworkConnection.dnsServers] DNS servers to be
- * used by this Virtual Network. This should be a comma-separated list of IP
- * addresses.
- * @member {array} [hybridConnections] The Hybrid Connections summary view.
- * @member {array} [hybridConnectionsV2] The Hybrid Connection V2 (Service Bus)
- * view.
- */
+ * Full view of network features for an app (presently VNET integration and Hybrid Connections).
+*/
export interface NetworkFeatures extends ProxyOnlyResource {
+ /**
+ * The Virtual Network name.
+ */
readonly virtualNetworkName?: string;
+ /**
+ * The Virtual Network summary view.
+ */
readonly virtualNetworkConnection?: VnetInfo;
+ /**
+ * The Hybrid Connections summary view.
+ */
readonly hybridConnections?: RelayServiceConnectionEntity[];
+ /**
+ * The Hybrid Connection V2 (Service Bus) view.
+ */
readonly hybridConnectionsV2?: HybridConnection[];
}
/**
- * @class
- * Initializes a new instance of the NetworkTrace class.
- * @constructor
* Network trace
- *
- * @member {string} [path] Local file path for the captured network trace file.
- * @member {string} [status] Current status of the network trace operation,
- * same as Operation.Status (InProgress/Succeeded/Failed).
- * @member {string} [message] Detailed message of a network trace operation,
- * e.g. error message in case of failure.
- */
+*/
export interface NetworkTrace {
+ /**
+ * Local file path for the captured network trace file.
+ */
path?: string;
+ /**
+ * Current status of the network trace operation, same as Operation.Status
+ * (InProgress/Succeeded/Failed).
+ */
status?: string;
+ /**
+ * Detailed message of a network trace operation, e.g. error message in case of failure.
+ */
message?: string;
}
/**
- * @class
- * Initializes a new instance of the PerfMonSample class.
- * @constructor
* Performance monitor sample in a set.
- *
- * @member {date} [time] Point in time for which counter was measured.
- * @member {string} [instanceName] Name of the server on which the measurement
- * is made.
- * @member {number} [value] Value of counter at a certain time.
- */
+*/
export interface PerfMonSample {
+ /**
+ * Point in time for which counter was measured.
+ */
time?: Date;
+ /**
+ * Name of the server on which the measurement is made.
+ */
instanceName?: string;
+ /**
+ * Value of counter at a certain time.
+ */
value?: number;
}
/**
- * @class
- * Initializes a new instance of the PerfMonSet class.
- * @constructor
* Metric information.
- *
- * @member {string} [name] Unique key name of the counter.
- * @member {date} [startTime] Start time of the period.
- * @member {date} [endTime] End time of the period.
- * @member {string} [timeGrain] Presented time grain.
- * @member {array} [values] Collection of workers that are active during this
- * time.
- */
+*/
export interface PerfMonSet {
+ /**
+ * Unique key name of the counter.
+ */
name?: string;
+ /**
+ * Start time of the period.
+ */
startTime?: Date;
+ /**
+ * End time of the period.
+ */
endTime?: Date;
+ /**
+ * Presented time grain.
+ */
timeGrain?: string;
+ /**
+ * Collection of workers that are active during this time.
+ */
values?: PerfMonSample[];
}
/**
- * @class
- * Initializes a new instance of the PerfMonResponse class.
- * @constructor
* Performance monitor API response.
- *
- * @member {string} [code] The response code.
- * @member {string} [message] The message.
- * @member {object} [data] The performance monitor counters.
- * @member {string} [data.name] Unique key name of the counter.
- * @member {date} [data.startTime] Start time of the period.
- * @member {date} [data.endTime] End time of the period.
- * @member {string} [data.timeGrain] Presented time grain.
- * @member {array} [data.values] Collection of workers that are active during
- * this time.
- */
+*/
export interface PerfMonResponse {
+ /**
+ * The response code.
+ */
code?: string;
+ /**
+ * The message.
+ */
message?: string;
+ /**
+ * The performance monitor counters.
+ */
data?: PerfMonSet;
}
/**
- * @class
- * Initializes a new instance of the PremierAddOn class.
- * @constructor
* Premier add-on.
- *
- * @member {string} [sku] Premier add on SKU.
- * @member {string} [product] Premier add on Product.
- * @member {string} [vendor] Premier add on Vendor.
- * @member {string} [marketplacePublisher] Premier add on Marketplace
- * publisher.
- * @member {string} [marketplaceOffer] Premier add on Marketplace offer.
- */
+*/
export interface PremierAddOn extends Resource {
+ /**
+ * Premier add on SKU.
+ */
sku?: string;
+ /**
+ * Premier add on Product.
+ */
product?: string;
+ /**
+ * Premier add on Vendor.
+ */
vendor?: string;
+ /**
+ * Premier add on Marketplace publisher.
+ */
marketplacePublisher?: string;
+ /**
+ * Premier add on Marketplace offer.
+ */
marketplaceOffer?: string;
}
/**
- * @class
- * Initializes a new instance of the PremierAddOnPatchResource class.
- * @constructor
* ARM resource for a PremierAddOn.
- *
- * @member {string} [sku] Premier add on SKU.
- * @member {string} [product] Premier add on Product.
- * @member {string} [vendor] Premier add on Vendor.
- * @member {string} [marketplacePublisher] Premier add on Marketplace
- * publisher.
- * @member {string} [marketplaceOffer] Premier add on Marketplace offer.
- */
+*/
export interface PremierAddOnPatchResource extends ProxyOnlyResource {
+ /**
+ * Premier add on SKU.
+ */
sku?: string;
+ /**
+ * Premier add on Product.
+ */
product?: string;
+ /**
+ * Premier add on Vendor.
+ */
vendor?: string;
+ /**
+ * Premier add on Marketplace publisher.
+ */
marketplacePublisher?: string;
+ /**
+ * Premier add on Marketplace offer.
+ */
marketplaceOffer?: string;
}
/**
- * @class
- * Initializes a new instance of the PrivateAccessSubnet class.
- * @constructor
- * Description of a Virtual Network subnet that is useable for private site
- * access.
- *
- * @member {string} [name] The name of the subnet.
- * @member {number} [key] The key (ID) of the subnet.
- */
+ * Description of a Virtual Network subnet that is useable for private site access.
+*/
export interface PrivateAccessSubnet {
+ /**
+ * The name of the subnet.
+ */
name?: string;
+ /**
+ * The key (ID) of the subnet.
+ */
key?: number;
}
/**
- * @class
- * Initializes a new instance of the PrivateAccessVirtualNetwork class.
- * @constructor
* Description of a Virtual Network that is useable for private site access.
- *
- * @member {string} [name] The name of the Virtual Network.
- * @member {number} [key] The key (ID) of the Virtual Network.
- * @member {string} [resourceId] The ARM uri of the Virtual Network
- * @member {array} [subnets] A List of subnets that access is allowed to on
- * this Virtual Network. An empty array (but not null) is interpreted to mean
- * that all subnets are allowed within this Virtual Network.
- */
+*/
export interface PrivateAccessVirtualNetwork {
+ /**
+ * The name of the Virtual Network.
+ */
name?: string;
+ /**
+ * The key (ID) of the Virtual Network.
+ */
key?: number;
+ /**
+ * The ARM uri of the Virtual Network
+ */
resourceId?: string;
+ /**
+ * A List of subnets that access is allowed to on this Virtual Network. An empty array (but not
+ * null) is interpreted to mean that all subnets are allowed within this Virtual Network.
+ */
subnets?: PrivateAccessSubnet[];
}
/**
- * @class
- * Initializes a new instance of the PrivateAccess class.
- * @constructor
* Description of the parameters of Private Access for a Web Site.
- *
- * @member {boolean} [enabled] Whether private access is enabled or not.
- * @member {array} [virtualNetworks] The Virtual Networks (and subnets) allowed
- * to access the site privately.
- */
+*/
export interface PrivateAccess extends ProxyOnlyResource {
+ /**
+ * Whether private access is enabled or not.
+ */
enabled?: boolean;
+ /**
+ * The Virtual Networks (and subnets) allowed to access the site privately.
+ */
virtualNetworks?: PrivateAccessVirtualNetwork[];
}
/**
- * @class
- * Initializes a new instance of the ProcessThreadInfo class.
- * @constructor
* Process Thread Information.
- *
- * @member {number} [identifier] Site extension ID.
- * @member {string} [href] HRef URI.
- * @member {string} [process] Process URI.
- * @member {string} [startAddress] Start address.
- * @member {number} [currentPriority] Current thread priority.
- * @member {string} [priorityLevel] Thread priority level.
- * @member {number} [basePriority] Base priority.
- * @member {date} [startTime] Start time.
- * @member {string} [totalProcessorTime] Total processor time.
- * @member {string} [userProcessorTime] User processor time.
- * @member {string} [priviledgedProcessorTime] Priviledged processor time.
- * @member {string} [state] Thread state.
- * @member {string} [waitReason] Wait reason.
- */
+*/
export interface ProcessThreadInfo extends ProxyOnlyResource {
+ /**
+ * Site extension ID.
+ */
readonly identifier?: number;
+ /**
+ * HRef URI.
+ */
href?: string;
+ /**
+ * Process URI.
+ */
process?: string;
+ /**
+ * Start address.
+ */
startAddress?: string;
+ /**
+ * Current thread priority.
+ */
currentPriority?: number;
+ /**
+ * Thread priority level.
+ */
priorityLevel?: string;
+ /**
+ * Base priority.
+ */
basePriority?: number;
+ /**
+ * Start time.
+ */
startTime?: Date;
+ /**
+ * Total processor time.
+ */
totalProcessorTime?: string;
+ /**
+ * User processor time.
+ */
userProcessorTime?: string;
+ /**
+ * Priviledged processor time.
+ */
priviledgedProcessorTime?: string;
+ /**
+ * Thread state.
+ */
state?: string;
+ /**
+ * Wait reason.
+ */
waitReason?: string;
}
/**
- * @class
- * Initializes a new instance of the ProcessModuleInfo class.
- * @constructor
* Process Module Information.
- *
- * @member {string} [baseAddress] Base address. Used as module identifier in
- * ARM resource URI.
- * @member {string} [fileName] File name.
- * @member {string} [href] HRef URI.
- * @member {string} [filePath] File path.
- * @member {number} [moduleMemorySize] Module memory size.
- * @member {string} [fileVersion] File version.
- * @member {string} [fileDescription] File description.
- * @member {string} [product] Product name.
- * @member {string} [productVersion] Product version.
- * @member {boolean} [isDebug] Is debug?
- * @member {string} [language] Module language (locale).
- */
+*/
export interface ProcessModuleInfo extends ProxyOnlyResource {
+ /**
+ * Base address. Used as module identifier in ARM resource URI.
+ */
baseAddress?: string;
+ /**
+ * File name.
+ */
fileName?: string;
+ /**
+ * HRef URI.
+ */
href?: string;
+ /**
+ * File path.
+ */
filePath?: string;
+ /**
+ * Module memory size.
+ */
moduleMemorySize?: number;
+ /**
+ * File version.
+ */
fileVersion?: string;
+ /**
+ * File description.
+ */
fileDescription?: string;
+ /**
+ * Product name.
+ */
product?: string;
+ /**
+ * Product version.
+ */
productVersion?: string;
+ /**
+ * Is debug?
+ */
isDebug?: boolean;
+ /**
+ * Module language (locale).
+ */
language?: string;
}
/**
- * @class
- * Initializes a new instance of the ProcessInfo class.
- * @constructor
* Process Information.
- *
- * @member {number} [identifier] ARM Identifier for deployment.
- * @member {string} [deploymentName] Deployment name.
- * @member {string} [href] HRef URI.
- * @member {string} [minidump] Minidump URI.
- * @member {boolean} [isProfileRunning] Is profile running?
- * @member {boolean} [isIisProfileRunning] Is the IIS Profile running?
- * @member {number} [iisProfileTimeoutInSeconds] IIS Profile timeout (seconds).
- * @member {string} [parent] Parent process.
- * @member {array} [children] Child process list.
- * @member {array} [threads] Thread list.
- * @member {array} [openFileHandles] List of open files.
- * @member {array} [modules] List of modules.
- * @member {string} [fileName] File name of this process.
- * @member {string} [commandLine] Command line.
- * @member {string} [userName] User name.
- * @member {number} [handleCount] Handle count.
- * @member {number} [moduleCount] Module count.
- * @member {number} [threadCount] Thread count.
- * @member {date} [startTime] Start time.
- * @member {string} [totalCpuTime] Total CPU time.
- * @member {string} [userCpuTime] User CPU time.
- * @member {string} [privilegedCpuTime] Privileged CPU time.
- * @member {number} [workingSet] Working set.
- * @member {number} [peakWorkingSet] Peak working set.
- * @member {number} [privateMemory] Private memory size.
- * @member {number} [virtualMemory] Virtual memory size.
- * @member {number} [peakVirtualMemory] Peak virtual memory usage.
- * @member {number} [pagedSystemMemory] Paged system memory.
- * @member {number} [nonPagedSystemMemory] Non-paged system memory.
- * @member {number} [pagedMemory] Paged memory.
- * @member {number} [peakPagedMemory] Peak paged memory.
- * @member {date} [timeStamp] Time stamp.
- * @member {object} [environmentVariables] List of environment variables.
- * @member {boolean} [isScmSite] Is this the SCM site?
- * @member {boolean} [isWebjob] Is this a Web Job?
- * @member {string} [description] Description of process.
- */
+*/
export interface ProcessInfo extends ProxyOnlyResource {
+ /**
+ * ARM Identifier for deployment.
+ */
readonly identifier?: number;
+ /**
+ * Deployment name.
+ */
deploymentName?: string;
+ /**
+ * HRef URI.
+ */
href?: string;
+ /**
+ * Minidump URI.
+ */
minidump?: string;
+ /**
+ * Is profile running?
+ */
isProfileRunning?: boolean;
+ /**
+ * Is the IIS Profile running?
+ */
isIisProfileRunning?: boolean;
+ /**
+ * IIS Profile timeout (seconds).
+ */
iisProfileTimeoutInSeconds?: number;
+ /**
+ * Parent process.
+ */
parent?: string;
+ /**
+ * Child process list.
+ */
children?: string[];
+ /**
+ * Thread list.
+ */
threads?: ProcessThreadInfo[];
+ /**
+ * List of open files.
+ */
openFileHandles?: string[];
+ /**
+ * List of modules.
+ */
modules?: ProcessModuleInfo[];
+ /**
+ * File name of this process.
+ */
fileName?: string;
+ /**
+ * Command line.
+ */
commandLine?: string;
+ /**
+ * User name.
+ */
userName?: string;
+ /**
+ * Handle count.
+ */
handleCount?: number;
+ /**
+ * Module count.
+ */
moduleCount?: number;
+ /**
+ * Thread count.
+ */
threadCount?: number;
+ /**
+ * Start time.
+ */
startTime?: Date;
+ /**
+ * Total CPU time.
+ */
totalCpuTime?: string;
+ /**
+ * User CPU time.
+ */
userCpuTime?: string;
+ /**
+ * Privileged CPU time.
+ */
privilegedCpuTime?: string;
+ /**
+ * Working set.
+ */
workingSet?: number;
+ /**
+ * Peak working set.
+ */
peakWorkingSet?: number;
+ /**
+ * Private memory size.
+ */
privateMemory?: number;
+ /**
+ * Virtual memory size.
+ */
virtualMemory?: number;
+ /**
+ * Peak virtual memory usage.
+ */
peakVirtualMemory?: number;
+ /**
+ * Paged system memory.
+ */
pagedSystemMemory?: number;
+ /**
+ * Non-paged system memory.
+ */
nonPagedSystemMemory?: number;
+ /**
+ * Paged memory.
+ */
pagedMemory?: number;
+ /**
+ * Peak paged memory.
+ */
peakPagedMemory?: number;
+ /**
+ * Time stamp.
+ */
timeStamp?: Date;
+ /**
+ * List of environment variables.
+ */
environmentVariables?: { [propertyName: string]: string };
+ /**
+ * Is this the SCM site?
+ */
isScmSite?: boolean;
+ /**
+ * Is this a Web Job?
+ */
isWebjob?: boolean;
+ /**
+ * Description of process.
+ */
description?: string;
}
/**
- * @class
- * Initializes a new instance of the PublicCertificate class.
- * @constructor
* Public certificate object
- *
- * @member {buffer} [blob] Public Certificate byte array
- * @member {string} [publicCertificateLocation] Public Certificate Location.
- * Possible values include: 'CurrentUserMy', 'LocalMachineMy', 'Unknown'
- * @member {string} [thumbprint] Certificate Thumbprint
- */
+*/
export interface PublicCertificate extends ProxyOnlyResource {
+ /**
+ * Public Certificate byte array
+ */
blob?: Buffer;
+ /**
+ * Public Certificate Location. Possible values include: 'CurrentUserMy', 'LocalMachineMy',
+ * 'Unknown'
+ */
publicCertificateLocation?: string;
+ /**
+ * Certificate Thumbprint
+ */
readonly thumbprint?: string;
}
/**
- * @class
- * Initializes a new instance of the RestoreRequest class.
- * @constructor
* Description of a restore request.
- *
- * @member {string} storageAccountUrl SAS URL to the container.
- * @member {string} [blobName] Name of a blob which contains the backup.
- * @member {boolean} overwrite true if the restore operation can
- * overwrite target app; otherwise, false. true is
- * needed if trying to restore over an existing app.
- * @member {string} [siteName] Name of an app.
- * @member {array} [databases] Collection of databases which should be
- * restored. This list has to match the list of databases included in the
- * backup.
- * @member {boolean} [ignoreConflictingHostNames] Changes a logic when
- * restoring an app with custom domains. true to remove custom
- * domains automatically. If false, custom domains are added to
- * the app's object when it is being restored, but that might fail due to
- * conflicts during the operation. Default value: false .
- * @member {boolean} [ignoreDatabases] Ignore the databases and only restore
- * the site content. Default value: false .
- * @member {string} [appServicePlan] Specify app service plan that will own
- * restored site.
- * @member {string} [operationType] Operation type. Possible values include:
- * 'Default', 'Clone', 'Relocation', 'Snapshot', 'CloudFS'. Default value:
- * 'Default' .
- * @member {boolean} [adjustConnectionStrings] true if
- * SiteConfig.ConnectionStrings should be set in new app; otherwise,
- * false.
- * @member {string} [hostingEnvironment] App Service Environment name, if
- * needed (only when restoring an app to an App Service Environment).
- */
+*/
export interface RestoreRequest extends ProxyOnlyResource {
+ /**
+ * SAS URL to the container.
+ */
storageAccountUrl: string;
+ /**
+ * Name of a blob which contains the backup.
+ */
blobName?: string;
+ /**
+ * true if the restore operation can overwrite target app; otherwise,
+ * false. true is needed if trying to restore over an existing app.
+ */
overwrite: boolean;
+ /**
+ * Name of an app.
+ */
siteName?: string;
+ /**
+ * Collection of databases which should be restored. This list has to match the list of databases
+ * included in the backup.
+ */
databases?: DatabaseBackupSetting[];
+ /**
+ * Changes a logic when restoring an app with custom domains. true to remove custom
+ * domains automatically. If false, custom domains are added to
+ * the app's object when it is being restored, but that might fail due to conflicts during the
+ * operation.
+ */
ignoreConflictingHostNames?: boolean;
+ /**
+ * Ignore the databases and only restore the site content
+ */
ignoreDatabases?: boolean;
+ /**
+ * Specify app service plan that will own restored site.
+ */
appServicePlan?: string;
+ /**
+ * Operation type. Possible values include: 'Default', 'Clone', 'Relocation', 'Snapshot',
+ * 'CloudFS'
+ */
operationType?: string;
+ /**
+ * true if SiteConfig.ConnectionStrings should be set in new app; otherwise,
+ * false.
+ */
adjustConnectionStrings?: boolean;
+ /**
+ * App Service Environment name, if needed (only when restoring an app to an App Service
+ * Environment).
+ */
hostingEnvironment?: string;
}
/**
- * @class
- * Initializes a new instance of the SiteAuthSettings class.
- * @constructor
- * Configuration settings for the Azure App Service Authentication /
- * Authorization feature.
- *
- * @member {boolean} [enabled] true if the Authentication /
- * Authorization feature is enabled for the current app; otherwise,
- * false.
- * @member {string} [runtimeVersion] The RuntimeVersion of the Authentication /
- * Authorization feature in use for the current app.
- * The setting in this value can control the behavior of certain features in
- * the Authentication / Authorization module.
- * @member {string} [unauthenticatedClientAction] The action to take when an
- * unauthenticated client attempts to access the app. Possible values include:
- * 'RedirectToLoginPage', 'AllowAnonymous'
- * @member {boolean} [tokenStoreEnabled] true to durably store
- * platform-specific security tokens that are obtained during login flows;
- * otherwise, false.
- * The default is false.
- * @member {array} [allowedExternalRedirectUrls] External URLs that can be
- * redirected to as part of logging in or logging out of the app. Note that the
- * query string part of the URL is ignored.
- * This is an advanced setting typically only needed by Windows Store
- * application backends.
- * Note that URLs within the current domain are always implicitly allowed.
- * @member {string} [defaultProvider] The default authentication provider to
- * use when multiple providers are configured.
- * This setting is only needed if multiple providers are configured and the
- * unauthenticated client
- * action is set to "RedirectToLoginPage". Possible values include:
- * 'AzureActiveDirectory', 'Facebook', 'Google', 'MicrosoftAccount', 'Twitter'
- * @member {number} [tokenRefreshExtensionHours] The number of hours after
- * session token expiration that a session token can be used to
- * call the token refresh API. The default is 72 hours.
- * @member {string} [clientId] The Client ID of this relying party application,
- * known as the client_id.
- * This setting is required for enabling OpenID Connection authentication with
- * Azure Active Directory or
- * other 3rd party OpenID Connect providers.
- * More information on OpenID Connect:
- * http://openid.net/specs/openid-connect-core-1_0.html
- * @member {string} [clientSecret] The Client Secret of this relying party
- * application (in Azure Active Directory, this is also referred to as the
- * Key).
- * This setting is optional. If no client secret is configured, the OpenID
- * Connect implicit auth flow is used to authenticate end users.
- * Otherwise, the OpenID Connect Authorization Code Flow is used to
- * authenticate end users.
- * More information on OpenID Connect:
- * http://openid.net/specs/openid-connect-core-1_0.html
- * @member {string} [issuer] The OpenID Connect Issuer URI that represents the
- * entity which issues access tokens for this application.
- * When using Azure Active Directory, this value is the URI of the directory
- * tenant, e.g. https://sts.windows.net/{tenant-guid}/.
- * This URI is a case-sensitive identifier for the token issuer.
- * More information on OpenID Connect Discovery:
- * http://openid.net/specs/openid-connect-discovery-1_0.html
- * @member {boolean} [validateIssuer] Gets a value indicating whether the
- * issuer should be a valid HTTPS url and be validated as such.
- * @member {array} [allowedAudiences] Allowed audience values to consider when
- * validating JWTs issued by
- * Azure Active Directory. Note that the ClientID value is always
- * considered an
- * allowed audience, regardless of this setting.
- * @member {array} [additionalLoginParams] Login parameters to send to the
- * OpenID Connect authorization endpoint when
- * a user logs in. Each parameter must be in the form "key=value".
- * @member {string} [googleClientId] The OpenID Connect Client ID for the
- * Google web application.
- * This setting is required for enabling Google Sign-In.
- * Google Sign-In documentation:
- * https://developers.google.com/identity/sign-in/web/
- * @member {string} [googleClientSecret] The client secret associated with the
- * Google web application.
- * This setting is required for enabling Google Sign-In.
- * Google Sign-In documentation:
- * https://developers.google.com/identity/sign-in/web/
- * @member {array} [googleOAuthScopes] The OAuth 2.0 scopes that will be
- * requested as part of Google Sign-In authentication.
- * This setting is optional. If not specified, "openid", "profile", and "email"
- * are used as default scopes.
- * Google Sign-In documentation:
- * https://developers.google.com/identity/sign-in/web/
- * @member {string} [facebookAppId] The App ID of the Facebook app used for
- * login.
- * This setting is required for enabling Facebook Login.
- * Facebook Login documentation:
- * https://developers.facebook.com/docs/facebook-login
- * @member {string} [facebookAppSecret] The App Secret of the Facebook app used
- * for Facebook Login.
- * This setting is required for enabling Facebook Login.
- * Facebook Login documentation:
- * https://developers.facebook.com/docs/facebook-login
- * @member {array} [facebookOAuthScopes] The OAuth 2.0 scopes that will be
- * requested as part of Facebook Login authentication.
- * This setting is optional.
- * Facebook Login documentation:
- * https://developers.facebook.com/docs/facebook-login
- * @member {string} [twitterConsumerKey] The OAuth 1.0a consumer key of the
- * Twitter application used for sign-in.
- * This setting is required for enabling Twitter Sign-In.
- * Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
- * @member {string} [twitterConsumerSecret] The OAuth 1.0a consumer secret of
- * the Twitter application used for sign-in.
- * This setting is required for enabling Twitter Sign-In.
- * Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
- * @member {string} [microsoftAccountClientId] The OAuth 2.0 client ID that was
- * created for the app used for authentication.
- * This setting is required for enabling Microsoft Account authentication.
- * Microsoft Account OAuth documentation:
- * https://dev.onedrive.com/auth/msa_oauth.htm
- * @member {string} [microsoftAccountClientSecret] The OAuth 2.0 client secret
- * that was created for the app used for authentication.
- * This setting is required for enabling Microsoft Account authentication.
- * Microsoft Account OAuth documentation:
- * https://dev.onedrive.com/auth/msa_oauth.htm
- * @member {array} [microsoftAccountOAuthScopes] The OAuth 2.0 scopes that will
- * be requested as part of Microsoft Account authentication.
- * This setting is optional. If not specified, "wl.basic" is used as the
- * default scope.
- * Microsoft Account Scopes and permissions documentation:
- * https://msdn.microsoft.com/en-us/library/dn631845.aspx
- */
+ * Configuration settings for the Azure App Service Authentication / Authorization feature.
+*/
export interface SiteAuthSettings extends ProxyOnlyResource {
+ /**
+ * true if the Authentication / Authorization feature is enabled for the current
+ * app; otherwise, false.
+ */
enabled?: boolean;
+ /**
+ * The RuntimeVersion of the Authentication / Authorization feature in use for the current app.
+ * The setting in this value can control the behavior of certain features in the Authentication /
+ * Authorization module.
+ */
runtimeVersion?: string;
+ /**
+ * The action to take when an unauthenticated client attempts to access the app. Possible values
+ * include: 'RedirectToLoginPage', 'AllowAnonymous'
+ */
unauthenticatedClientAction?: string;
+ /**
+ * true to durably store platform-specific security tokens that are obtained during
+ * login flows; otherwise, false.
+ * The default is false.
+ */
tokenStoreEnabled?: boolean;
+ /**
+ * External URLs that can be redirected to as part of logging in or logging out of the app. Note
+ * that the query string part of the URL is ignored.
+ * This is an advanced setting typically only needed by Windows Store application backends.
+ * Note that URLs within the current domain are always implicitly allowed.
+ */
allowedExternalRedirectUrls?: string[];
+ /**
+ * The default authentication provider to use when multiple providers are configured.
+ * This setting is only needed if multiple providers are configured and the unauthenticated
+ * client
+ * action is set to "RedirectToLoginPage". Possible values include: 'AzureActiveDirectory',
+ * 'Facebook', 'Google', 'MicrosoftAccount', 'Twitter'
+ */
defaultProvider?: string;
+ /**
+ * The number of hours after session token expiration that a session token can be used to
+ * call the token refresh API. The default is 72 hours.
+ */
tokenRefreshExtensionHours?: number;
+ /**
+ * The Client ID of this relying party application, known as the client_id.
+ * This setting is required for enabling OpenID Connection authentication with Azure Active
+ * Directory or
+ * other 3rd party OpenID Connect providers.
+ * More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
+ */
clientId?: string;
+ /**
+ * The Client Secret of this relying party application (in Azure Active Directory, this is also
+ * referred to as the Key).
+ * This setting is optional. If no client secret is configured, the OpenID Connect implicit auth
+ * flow is used to authenticate end users.
+ * Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.
+ * More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
+ */
clientSecret?: string;
+ /**
+ * The OpenID Connect Issuer URI that represents the entity which issues access tokens for this
+ * application.
+ * When using Azure Active Directory, this value is the URI of the directory tenant, e.g.
+ * https://sts.windows.net/{tenant-guid}/.
+ * This URI is a case-sensitive identifier for the token issuer.
+ * More information on OpenID Connect Discovery:
+ * http://openid.net/specs/openid-connect-discovery-1_0.html
+ */
issuer?: string;
+ /**
+ * Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as
+ * such.
+ */
validateIssuer?: boolean;
+ /**
+ * Allowed audience values to consider when validating JWTs issued by
+ * Azure Active Directory. Note that the ClientID value is always considered an
+ * allowed audience, regardless of this setting.
+ */
allowedAudiences?: string[];
+ /**
+ * Login parameters to send to the OpenID Connect authorization endpoint when
+ * a user logs in. Each parameter must be in the form "key=value".
+ */
additionalLoginParams?: string[];
+ /**
+ * The OpenID Connect Client ID for the Google web application.
+ * This setting is required for enabling Google Sign-In.
+ * Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
+ */
googleClientId?: string;
+ /**
+ * The client secret associated with the Google web application.
+ * This setting is required for enabling Google Sign-In.
+ * Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
+ */
googleClientSecret?: string;
+ /**
+ * The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.
+ * This setting is optional. If not specified, "openid", "profile", and "email" are used as
+ * default scopes.
+ * Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
+ */
googleOAuthScopes?: string[];
+ /**
+ * The App ID of the Facebook app used for login.
+ * This setting is required for enabling Facebook Login.
+ * Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
+ */
facebookAppId?: string;
+ /**
+ * The App Secret of the Facebook app used for Facebook Login.
+ * This setting is required for enabling Facebook Login.
+ * Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
+ */
facebookAppSecret?: string;
+ /**
+ * The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.
+ * This setting is optional.
+ * Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
+ */
facebookOAuthScopes?: string[];
+ /**
+ * The OAuth 1.0a consumer key of the Twitter application used for sign-in.
+ * This setting is required for enabling Twitter Sign-In.
+ * Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
+ */
twitterConsumerKey?: string;
+ /**
+ * The OAuth 1.0a consumer secret of the Twitter application used for sign-in.
+ * This setting is required for enabling Twitter Sign-In.
+ * Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
+ */
twitterConsumerSecret?: string;
+ /**
+ * The OAuth 2.0 client ID that was created for the app used for authentication.
+ * This setting is required for enabling Microsoft Account authentication.
+ * Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
+ */
microsoftAccountClientId?: string;
+ /**
+ * The OAuth 2.0 client secret that was created for the app used for authentication.
+ * This setting is required for enabling Microsoft Account authentication.
+ * Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
+ */
microsoftAccountClientSecret?: string;
+ /**
+ * The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.
+ * This setting is optional. If not specified, "wl.basic" is used as the default scope.
+ * Microsoft Account Scopes and permissions documentation:
+ * https://msdn.microsoft.com/en-us/library/dn631845.aspx
+ */
microsoftAccountOAuthScopes?: string[];
}
/**
- * @class
- * Initializes a new instance of the SiteCloneabilityCriterion class.
- * @constructor
* An app cloneability criterion.
- *
- * @member {string} [name] Name of criterion.
- * @member {string} [description] Description of criterion.
- */
+*/
export interface SiteCloneabilityCriterion {
+ /**
+ * Name of criterion.
+ */
name?: string;
+ /**
+ * Description of criterion.
+ */
description?: string;
}
/**
- * @class
- * Initializes a new instance of the SiteCloneability class.
- * @constructor
* Represents whether or not an app is cloneable.
- *
- * @member {string} [result] Name of app. Possible values include: 'Cloneable',
- * 'PartiallyCloneable', 'NotCloneable'
- * @member {array} [blockingFeatures] List of features enabled on app that
- * prevent cloning.
- * @member {array} [unsupportedFeatures] List of features enabled on app that
- * are non-blocking but cannot be cloned. The app can still be cloned
- * but the features in this list will not be set up on cloned app.
- * @member {array} [blockingCharacteristics] List of blocking application
- * characteristics.
- */
+*/
export interface SiteCloneability {
+ /**
+ * Name of app. Possible values include: 'Cloneable', 'PartiallyCloneable', 'NotCloneable'
+ */
result?: string;
+ /**
+ * List of features enabled on app that prevent cloning.
+ */
blockingFeatures?: SiteCloneabilityCriterion[];
+ /**
+ * List of features enabled on app that are non-blocking but cannot be cloned. The app can still
+ * be cloned
+ * but the features in this list will not be set up on cloned app.
+ */
unsupportedFeatures?: SiteCloneabilityCriterion[];
+ /**
+ * List of blocking application characteristics.
+ */
blockingCharacteristics?: SiteCloneabilityCriterion[];
}
/**
- * @class
- * Initializes a new instance of the SiteConfigResource class.
- * @constructor
* Web app configuration ARM resource.
- *
- * @member {number} [numberOfWorkers] Number of workers.
- * @member {array} [defaultDocuments] Default documents.
- * @member {string} [netFrameworkVersion] .NET Framework version. Default
- * value: 'v4.6' .
- * @member {string} [phpVersion] Version of PHP.
- * @member {string} [pythonVersion] Version of Python.
- * @member {string} [nodeVersion] Version of Node.js.
- * @member {string} [linuxFxVersion] Linux App Framework and version
- * @member {string} [windowsFxVersion] Xenon App Framework and version
- * @member {boolean} [requestTracingEnabled] true if request
- * tracing is enabled; otherwise, false.
- * @member {date} [requestTracingExpirationTime] Request tracing expiration
- * time.
- * @member {boolean} [remoteDebuggingEnabled] true if remote
- * debugging is enabled; otherwise, false.
- * @member {string} [remoteDebuggingVersion] Remote debugging version.
- * @member {boolean} [httpLoggingEnabled] true if HTTP logging is
- * enabled; otherwise, false.
- * @member {number} [logsDirectorySizeLimit] HTTP logs directory size limit.
- * @member {boolean} [detailedErrorLoggingEnabled] true if
- * detailed error logging is enabled; otherwise, false.
- * @member {string} [publishingUsername] Publishing user name.
- * @member {array} [appSettings] Application settings.
- * @member {object} [azureStorageAccounts] User-provided Azure storage
- * accounts.
- * @member {array} [connectionStrings] Connection strings.
- * @member {object} [machineKey] Site MachineKey.
- * @member {string} [machineKey.validation] MachineKey validation.
- * @member {string} [machineKey.validationKey] Validation key.
- * @member {string} [machineKey.decryption] Algorithm used for decryption.
- * @member {string} [machineKey.decryptionKey] Decryption key.
- * @member {array} [handlerMappings] Handler mappings.
- * @member {string} [documentRoot] Document root.
- * @member {string} [scmType] SCM type. Possible values include: 'None',
- * 'Dropbox', 'Tfs', 'LocalGit', 'GitHub', 'CodePlexGit', 'CodePlexHg',
- * 'BitbucketGit', 'BitbucketHg', 'ExternalGit', 'ExternalHg', 'OneDrive',
- * 'VSO'
- * @member {boolean} [use32BitWorkerProcess] true to use 32-bit
- * worker process; otherwise, false.
- * @member {boolean} [webSocketsEnabled] true if WebSocket is
- * enabled; otherwise, false.
- * @member {boolean} [alwaysOn] true if Always On is enabled;
- * otherwise, false.
- * @member {string} [javaVersion] Java version.
- * @member {string} [javaContainer] Java container.
- * @member {string} [javaContainerVersion] Java container version.
- * @member {string} [appCommandLine] App command line to launch.
- * @member {string} [managedPipelineMode] Managed pipeline mode. Possible
- * values include: 'Integrated', 'Classic'
- * @member {array} [virtualApplications] Virtual applications.
- * @member {string} [loadBalancing] Site load balancing. Possible values
- * include: 'WeightedRoundRobin', 'LeastRequests', 'LeastResponseTime',
- * 'WeightedTotalTraffic', 'RequestHash'
- * @member {object} [experiments] This is work around for polymophic types.
- * @member {array} [experiments.rampUpRules] List of ramp-up rules.
- * @member {object} [limits] Site limits.
- * @member {number} [limits.maxPercentageCpu] Maximum allowed CPU usage
- * percentage.
- * @member {number} [limits.maxMemoryInMb] Maximum allowed memory usage in MB.
- * @member {number} [limits.maxDiskSizeInMb] Maximum allowed disk size usage in
- * MB.
- * @member {boolean} [autoHealEnabled] true if Auto Heal is
- * enabled; otherwise, false.
- * @member {object} [autoHealRules] Auto Heal rules.
- * @member {object} [autoHealRules.triggers] Conditions that describe when to
- * execute the auto-heal actions.
- * @member {object} [autoHealRules.triggers.requests] A rule based on total
- * requests.
- * @member {number} [autoHealRules.triggers.requests.count] Request Count.
- * @member {string} [autoHealRules.triggers.requests.timeInterval] Time
- * interval.
- * @member {number} [autoHealRules.triggers.privateBytesInKB] A rule based on
- * private bytes.
- * @member {array} [autoHealRules.triggers.statusCodes] A rule based on status
- * codes.
- * @member {object} [autoHealRules.triggers.slowRequests] A rule based on
- * request execution time.
- * @member {string} [autoHealRules.triggers.slowRequests.timeTaken] Time taken.
- * @member {number} [autoHealRules.triggers.slowRequests.count] Request Count.
- * @member {string} [autoHealRules.triggers.slowRequests.timeInterval] Time
- * interval.
- * @member {object} [autoHealRules.actions] Actions to be executed when a rule
- * is triggered.
- * @member {string} [autoHealRules.actions.actionType] Predefined action to be
- * taken. Possible values include: 'Recycle', 'LogEvent', 'CustomAction'
- * @member {object} [autoHealRules.actions.customAction] Custom action to be
- * taken.
- * @member {string} [autoHealRules.actions.customAction.exe] Executable to be
- * run.
- * @member {string} [autoHealRules.actions.customAction.parameters] Parameters
- * for the executable.
- * @member {string} [autoHealRules.actions.minProcessExecutionTime] Minimum
- * time the process must execute
- * before taking the action
- * @member {string} [tracingOptions] Tracing options.
- * @member {string} [vnetName] Virtual Network name.
- * @member {object} [cors] Cross-Origin Resource Sharing (CORS) settings.
- * @member {array} [cors.allowedOrigins] Gets or sets the list of origins that
- * should be allowed to make cross-origin
- * calls (for example: http://example.com:12345). Use "*" to allow all.
- * @member {object} [push] Push endpoint settings.
- * @member {boolean} [push.isPushEnabled] Gets or sets a flag indicating
- * whether the Push endpoint is enabled.
- * @member {string} [push.tagWhitelistJson] Gets or sets a JSON string
- * containing a list of tags that are whitelisted for use by the push
- * registration endpoint.
- * @member {string} [push.tagsRequiringAuth] Gets or sets a JSON string
- * containing a list of tags that require user authentication to be used in the
- * push registration endpoint.
- * Tags can consist of alphanumeric characters and the following:
- * '_', '@', '#', '.', ':', '-'.
- * Validation should be performed at the PushRequestHandler.
- * @member {string} [push.dynamicTagsJson] Gets or sets a JSON string
- * containing a list of dynamic tags that will be evaluated from user claims in
- * the push registration endpoint.
- * @member {object} [apiDefinition] Information about the formal API definition
- * for the app.
- * @member {string} [apiDefinition.url] The URL of the API definition.
- * @member {string} [autoSwapSlotName] Auto-swap slot name.
- * @member {boolean} [localMySqlEnabled] true to enable local
- * MySQL; otherwise, false. Default value: false .
- * @member {number} [managedServiceIdentityId] Managed Service Identity Id
- * @member {number} [xManagedServiceIdentityId] Explicit Managed Service
- * Identity Id
- * @member {array} [ipSecurityRestrictions] IP security restrictions.
- * @member {boolean} [http20Enabled] Http20Enabled: configures a web site to
- * allow clients to connect over http2.0. Default value: true .
- * @member {string} [minTlsVersion] MinTlsVersion: configures the minimum
- * version of TLS required for SSL requests. Possible values include: '1.0',
- * '1.1', '1.2'
- * @member {string} [ftpsState] State of FTP / FTPS service. Possible values
- * include: 'AllAllowed', 'FtpsOnly', 'Disabled'
- * @member {number} [reservedInstanceCount] Number of reserved instances.
- * This setting only applies to the Consumption Plan
- */
+*/
export interface SiteConfigResource extends ProxyOnlyResource {
+ /**
+ * Number of workers.
+ */
numberOfWorkers?: number;
+ /**
+ * Default documents.
+ */
defaultDocuments?: string[];
+ /**
+ * .NET Framework version.
+ */
netFrameworkVersion?: string;
+ /**
+ * Version of PHP.
+ */
phpVersion?: string;
+ /**
+ * Version of Python.
+ */
pythonVersion?: string;
+ /**
+ * Version of Node.js.
+ */
nodeVersion?: string;
+ /**
+ * Linux App Framework and version
+ */
linuxFxVersion?: string;
+ /**
+ * Xenon App Framework and version
+ */
windowsFxVersion?: string;
+ /**
+ * true if request tracing is enabled; otherwise, false.
+ */
requestTracingEnabled?: boolean;
+ /**
+ * Request tracing expiration time.
+ */
requestTracingExpirationTime?: Date;
+ /**
+ * true if remote debugging is enabled; otherwise, false.
+ */
remoteDebuggingEnabled?: boolean;
+ /**
+ * Remote debugging version.
+ */
remoteDebuggingVersion?: string;
+ /**
+ * true if HTTP logging is enabled; otherwise, false.
+ */
httpLoggingEnabled?: boolean;
+ /**
+ * HTTP logs directory size limit.
+ */
logsDirectorySizeLimit?: number;
+ /**
+ * true if detailed error logging is enabled; otherwise, false.
+ */
detailedErrorLoggingEnabled?: boolean;
+ /**
+ * Publishing user name.
+ */
publishingUsername?: string;
+ /**
+ * Application settings.
+ */
appSettings?: NameValuePair[];
+ /**
+ * User-provided Azure storage accounts.
+ */
azureStorageAccounts?: { [propertyName: string]: AzureStorageInfoValue };
+ /**
+ * Connection strings.
+ */
connectionStrings?: ConnStringInfo[];
+ /**
+ * Site MachineKey.
+ */
readonly machineKey?: SiteMachineKey;
+ /**
+ * Handler mappings.
+ */
handlerMappings?: HandlerMapping[];
+ /**
+ * Document root.
+ */
documentRoot?: string;
+ /**
+ * SCM type. Possible values include: 'None', 'Dropbox', 'Tfs', 'LocalGit', 'GitHub',
+ * 'CodePlexGit', 'CodePlexHg', 'BitbucketGit', 'BitbucketHg', 'ExternalGit', 'ExternalHg',
+ * 'OneDrive', 'VSO'
+ */
scmType?: string;
+ /**
+ * true to use 32-bit worker process; otherwise, false.
+ */
use32BitWorkerProcess?: boolean;
+ /**
+ * true if WebSocket is enabled; otherwise, false.
+ */
webSocketsEnabled?: boolean;
+ /**
+ * true if Always On is enabled; otherwise, false.
+ */
alwaysOn?: boolean;
+ /**
+ * Java version.
+ */
javaVersion?: string;
+ /**
+ * Java container.
+ */
javaContainer?: string;
+ /**
+ * Java container version.
+ */
javaContainerVersion?: string;
+ /**
+ * App command line to launch.
+ */
appCommandLine?: string;
+ /**
+ * Managed pipeline mode. Possible values include: 'Integrated', 'Classic'
+ */
managedPipelineMode?: string;
+ /**
+ * Virtual applications.
+ */
virtualApplications?: VirtualApplication[];
+ /**
+ * Site load balancing. Possible values include: 'WeightedRoundRobin', 'LeastRequests',
+ * 'LeastResponseTime', 'WeightedTotalTraffic', 'RequestHash'
+ */
loadBalancing?: string;
+ /**
+ * This is work around for polymophic types.
+ */
experiments?: Experiments;
+ /**
+ * Site limits.
+ */
limits?: SiteLimits;
+ /**
+ * true if Auto Heal is enabled; otherwise, false.
+ */
autoHealEnabled?: boolean;
+ /**
+ * Auto Heal rules.
+ */
autoHealRules?: AutoHealRules;
+ /**
+ * Tracing options.
+ */
tracingOptions?: string;
+ /**
+ * Virtual Network name.
+ */
vnetName?: string;
+ /**
+ * Cross-Origin Resource Sharing (CORS) settings.
+ */
cors?: CorsSettings;
+ /**
+ * Push endpoint settings.
+ */
push?: PushSettings;
+ /**
+ * Information about the formal API definition for the app.
+ */
apiDefinition?: ApiDefinitionInfo;
+ /**
+ * Auto-swap slot name.
+ */
autoSwapSlotName?: string;
+ /**
+ * true to enable local MySQL; otherwise, false.
+ */
localMySqlEnabled?: boolean;
+ /**
+ * Managed Service Identity Id
+ */
managedServiceIdentityId?: number;
+ /**
+ * Explicit Managed Service Identity Id
+ */
xManagedServiceIdentityId?: number;
+ /**
+ * IP security restrictions.
+ */
ipSecurityRestrictions?: IpSecurityRestriction[];
+ /**
+ * Http20Enabled: configures a web site to allow clients to connect over http2.0
+ */
http20Enabled?: boolean;
+ /**
+ * MinTlsVersion: configures the minimum version of TLS required for SSL requests. Possible
+ * values include: '1.0', '1.1', '1.2'
+ */
minTlsVersion?: string;
+ /**
+ * State of FTP / FTPS service. Possible values include: 'AllAllowed', 'FtpsOnly', 'Disabled'
+ */
ftpsState?: string;
+ /**
+ * Number of reserved instances.
+ * This setting only applies to the Consumption Plan
+ */
reservedInstanceCount?: number;
}
/**
- * @class
- * Initializes a new instance of the SiteConfigurationSnapshotInfo class.
- * @constructor
* A snapshot of a web app configuration.
- *
- * @member {date} [time] The time the snapshot was taken.
- * @member {number} [snapshotId] The id of the snapshot
- */
+*/
export interface SiteConfigurationSnapshotInfo extends ProxyOnlyResource {
+ /**
+ * The time the snapshot was taken.
+ */
readonly time?: Date;
+ /**
+ * The id of the snapshot
+ */
readonly snapshotId?: number;
}
/**
- * @class
- * Initializes a new instance of the SiteExtensionInfo class.
- * @constructor
* Site Extension Information.
- *
- * @member {string} [extensionId] Site extension ID.
- * @member {string} [title]
- * @member {string} [extensionType] Site extension type. Possible values
- * include: 'Gallery', 'WebRoot'
- * @member {string} [summary] Summary description.
- * @member {string} [description] Detailed description.
- * @member {string} [version] Version information.
- * @member {string} [extensionUrl] Extension URL.
- * @member {string} [projectUrl] Project URL.
- * @member {string} [iconUrl] Icon URL.
- * @member {string} [licenseUrl] License URL.
- * @member {string} [feedUrl] Feed URL.
- * @member {array} [authors] List of authors.
- * @member {string} [installerCommandLineParams] Installer command line
- * parameters.
- * @member {date} [publishedDateTime] Published timestamp.
- * @member {number} [downloadCount] Count of downloads.
- * @member {boolean} [localIsLatestVersion] true if the local
- * version is the latest version; false otherwise.
- * @member {string} [localPath] Local path.
- * @member {date} [installedDateTime] Installed timestamp.
- * @member {string} [provisioningState] Provisioning state.
- * @member {string} [comment] Site Extension comment.
- */
+*/
export interface SiteExtensionInfo extends ProxyOnlyResource {
+ /**
+ * Site extension ID.
+ */
extensionId?: string;
title?: string;
+ /**
+ * Site extension type. Possible values include: 'Gallery', 'WebRoot'
+ */
extensionType?: string;
+ /**
+ * Summary description.
+ */
summary?: string;
+ /**
+ * Detailed description.
+ */
description?: string;
+ /**
+ * Version information.
+ */
version?: string;
+ /**
+ * Extension URL.
+ */
extensionUrl?: string;
+ /**
+ * Project URL.
+ */
projectUrl?: string;
+ /**
+ * Icon URL.
+ */
iconUrl?: string;
+ /**
+ * License URL.
+ */
licenseUrl?: string;
+ /**
+ * Feed URL.
+ */
feedUrl?: string;
+ /**
+ * List of authors.
+ */
authors?: string[];
+ /**
+ * Installer command line parameters.
+ */
installerCommandLineParams?: string;
+ /**
+ * Published timestamp.
+ */
publishedDateTime?: Date;
+ /**
+ * Count of downloads.
+ */
downloadCount?: number;
+ /**
+ * true if the local version is the latest version; false otherwise.
+ */
localIsLatestVersion?: boolean;
+ /**
+ * Local path.
+ */
localPath?: string;
+ /**
+ * Installed timestamp.
+ */
installedDateTime?: Date;
+ /**
+ * Provisioning state.
+ */
provisioningState?: string;
+ /**
+ * Site Extension comment.
+ */
comment?: string;
}
/**
- * @class
- * Initializes a new instance of the SiteInstance class.
- * @constructor
* Instance of an app.
- *
- * @member {string} [siteInstanceName] Name of instance.
- */
+*/
export interface SiteInstance extends ProxyOnlyResource {
+ /**
+ * Name of instance.
+ */
readonly siteInstanceName?: string;
}
/**
- * @class
- * Initializes a new instance of the SiteLogsConfig class.
- * @constructor
* Configuration of App Service site logs.
- *
- * @member {object} [applicationLogs] Application logs configuration.
- * @member {object} [applicationLogs.fileSystem] Application logs to file
- * system configuration.
- * @member {string} [applicationLogs.fileSystem.level] Log level. Possible
- * values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'
- * @member {object} [applicationLogs.azureTableStorage] Application logs to
- * azure table storage configuration.
- * @member {string} [applicationLogs.azureTableStorage.level] Log level.
- * Possible values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'
- * @member {string} [applicationLogs.azureTableStorage.sasUrl] SAS URL to an
- * Azure table with add/query/delete permissions.
- * @member {object} [applicationLogs.azureBlobStorage] Application logs to blob
- * storage configuration.
- * @member {string} [applicationLogs.azureBlobStorage.level] Log level.
- * Possible values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'
- * @member {string} [applicationLogs.azureBlobStorage.sasUrl] SAS url to a
- * azure blob container with read/write/list/delete permissions.
- * @member {number} [applicationLogs.azureBlobStorage.retentionInDays]
- * Retention in days.
- * Remove blobs older than X days.
- * 0 or lower means no retention.
- * @member {object} [httpLogs] HTTP logs configuration.
- * @member {object} [httpLogs.fileSystem] Http logs to file system
- * configuration.
- * @member {number} [httpLogs.fileSystem.retentionInMb] Maximum size in
- * megabytes that http log files can use.
- * When reached old log files will be removed to make space for new ones.
- * Value can range between 25 and 100.
- * @member {number} [httpLogs.fileSystem.retentionInDays] Retention in days.
- * Remove files older than X days.
- * 0 or lower means no retention.
- * @member {boolean} [httpLogs.fileSystem.enabled] True if configuration is
- * enabled, false if it is disabled and null if configuration is not set.
- * @member {object} [httpLogs.azureBlobStorage] Http logs to azure blob storage
- * configuration.
- * @member {string} [httpLogs.azureBlobStorage.sasUrl] SAS url to a azure blob
- * container with read/write/list/delete permissions.
- * @member {number} [httpLogs.azureBlobStorage.retentionInDays] Retention in
- * days.
- * Remove blobs older than X days.
- * 0 or lower means no retention.
- * @member {boolean} [httpLogs.azureBlobStorage.enabled] True if configuration
- * is enabled, false if it is disabled and null if configuration is not set.
- * @member {object} [failedRequestsTracing] Failed requests tracing
- * configuration.
- * @member {boolean} [failedRequestsTracing.enabled] True if configuration is
- * enabled, false if it is disabled and null if configuration is not set.
- * @member {object} [detailedErrorMessages] Detailed error messages
- * configuration.
- * @member {boolean} [detailedErrorMessages.enabled] True if configuration is
- * enabled, false if it is disabled and null if configuration is not set.
- */
+*/
export interface SiteLogsConfig extends ProxyOnlyResource {
+ /**
+ * Application logs configuration.
+ */
applicationLogs?: ApplicationLogsConfig;
+ /**
+ * HTTP logs configuration.
+ */
httpLogs?: HttpLogsConfig;
+ /**
+ * Failed requests tracing configuration.
+ */
failedRequestsTracing?: EnabledConfig;
+ /**
+ * Detailed error messages configuration.
+ */
detailedErrorMessages?: EnabledConfig;
}
/**
- * @class
- * Initializes a new instance of the SitePatchResource class.
- * @constructor
* ARM resource for a site.
- *
- * @member {string} [state] Current state of the app.
- * @member {array} [hostNames] Hostnames associated with the app.
- * @member {string} [repositorySiteName] Name of the repository site.
- * @member {string} [usageState] State indicating whether the app has exceeded
- * its quota usage. Read-only. Possible values include: 'Normal', 'Exceeded'
- * @member {boolean} [enabled] true if the app is enabled;
- * otherwise, false. Setting this value to false disables the app
- * (takes the app offline).
- * @member {array} [enabledHostNames] Enabled hostnames for the app.Hostnames
- * need to be assigned (see HostNames) AND enabled. Otherwise,
- * the app is not served on those hostnames.
- * @member {string} [availabilityState] Management information availability
- * state for the app. Possible values include: 'Normal', 'Limited',
- * 'DisasterRecoveryMode'
- * @member {array} [hostNameSslStates] Hostname SSL states are used to manage
- * the SSL bindings for app's hostnames.
- * @member {string} [serverFarmId] Resource ID of the associated App Service
- * plan, formatted as:
- * "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
- * @member {boolean} [reserved] true if reserved; otherwise,
- * false. Default value: false .
- * @member {boolean} [isXenon] Obsolete: Hyper-V sandbox. Default value: false
- * .
- * @member {boolean} [hyperV] Hyper-V sandbox. Default value: false .
- * @member {date} [lastModifiedTimeUtc] Last time the app was modified, in UTC.
- * Read-only.
- * @member {object} [siteConfig] Configuration of the app.
- * @member {number} [siteConfig.numberOfWorkers] Number of workers.
- * @member {array} [siteConfig.defaultDocuments] Default documents.
- * @member {string} [siteConfig.netFrameworkVersion] .NET Framework version.
- * @member {string} [siteConfig.phpVersion] Version of PHP.
- * @member {string} [siteConfig.pythonVersion] Version of Python.
- * @member {string} [siteConfig.nodeVersion] Version of Node.js.
- * @member {string} [siteConfig.linuxFxVersion] Linux App Framework and version
- * @member {string} [siteConfig.windowsFxVersion] Xenon App Framework and
- * version
- * @member {boolean} [siteConfig.requestTracingEnabled] true if
- * request tracing is enabled; otherwise, false.
- * @member {date} [siteConfig.requestTracingExpirationTime] Request tracing
- * expiration time.
- * @member {boolean} [siteConfig.remoteDebuggingEnabled] true if
- * remote debugging is enabled; otherwise, false.
- * @member {string} [siteConfig.remoteDebuggingVersion] Remote debugging
- * version.
- * @member {boolean} [siteConfig.httpLoggingEnabled] true if HTTP
- * logging is enabled; otherwise, false.
- * @member {number} [siteConfig.logsDirectorySizeLimit] HTTP logs directory
- * size limit.
- * @member {boolean} [siteConfig.detailedErrorLoggingEnabled] true
- * if detailed error logging is enabled; otherwise, false.
- * @member {string} [siteConfig.publishingUsername] Publishing user name.
- * @member {array} [siteConfig.appSettings] Application settings.
- * @member {object} [siteConfig.azureStorageAccounts] User-provided Azure
- * storage accounts.
- * @member {array} [siteConfig.connectionStrings] Connection strings.
- * @member {object} [siteConfig.machineKey] Site MachineKey.
- * @member {string} [siteConfig.machineKey.validation] MachineKey validation.
- * @member {string} [siteConfig.machineKey.validationKey] Validation key.
- * @member {string} [siteConfig.machineKey.decryption] Algorithm used for
- * decryption.
- * @member {string} [siteConfig.machineKey.decryptionKey] Decryption key.
- * @member {array} [siteConfig.handlerMappings] Handler mappings.
- * @member {string} [siteConfig.documentRoot] Document root.
- * @member {string} [siteConfig.scmType] SCM type. Possible values include:
- * 'None', 'Dropbox', 'Tfs', 'LocalGit', 'GitHub', 'CodePlexGit', 'CodePlexHg',
- * 'BitbucketGit', 'BitbucketHg', 'ExternalGit', 'ExternalHg', 'OneDrive',
- * 'VSO'
- * @member {boolean} [siteConfig.use32BitWorkerProcess] true to
- * use 32-bit worker process; otherwise, false.
- * @member {boolean} [siteConfig.webSocketsEnabled] true if
- * WebSocket is enabled; otherwise, false.
- * @member {boolean} [siteConfig.alwaysOn] true if Always On is
- * enabled; otherwise, false.
- * @member {string} [siteConfig.javaVersion] Java version.
- * @member {string} [siteConfig.javaContainer] Java container.
- * @member {string} [siteConfig.javaContainerVersion] Java container version.
- * @member {string} [siteConfig.appCommandLine] App command line to launch.
- * @member {string} [siteConfig.managedPipelineMode] Managed pipeline mode.
- * Possible values include: 'Integrated', 'Classic'
- * @member {array} [siteConfig.virtualApplications] Virtual applications.
- * @member {string} [siteConfig.loadBalancing] Site load balancing. Possible
- * values include: 'WeightedRoundRobin', 'LeastRequests', 'LeastResponseTime',
- * 'WeightedTotalTraffic', 'RequestHash'
- * @member {object} [siteConfig.experiments] This is work around for polymophic
- * types.
- * @member {array} [siteConfig.experiments.rampUpRules] List of ramp-up rules.
- * @member {object} [siteConfig.limits] Site limits.
- * @member {number} [siteConfig.limits.maxPercentageCpu] Maximum allowed CPU
- * usage percentage.
- * @member {number} [siteConfig.limits.maxMemoryInMb] Maximum allowed memory
- * usage in MB.
- * @member {number} [siteConfig.limits.maxDiskSizeInMb] Maximum allowed disk
- * size usage in MB.
- * @member {boolean} [siteConfig.autoHealEnabled] true if Auto
- * Heal is enabled; otherwise, false.
- * @member {object} [siteConfig.autoHealRules] Auto Heal rules.
- * @member {object} [siteConfig.autoHealRules.triggers] Conditions that
- * describe when to execute the auto-heal actions.
- * @member {object} [siteConfig.autoHealRules.triggers.requests] A rule based
- * on total requests.
- * @member {number} [siteConfig.autoHealRules.triggers.requests.count] Request
- * Count.
- * @member {string} [siteConfig.autoHealRules.triggers.requests.timeInterval]
- * Time interval.
- * @member {number} [siteConfig.autoHealRules.triggers.privateBytesInKB] A rule
- * based on private bytes.
- * @member {array} [siteConfig.autoHealRules.triggers.statusCodes] A rule based
- * on status codes.
- * @member {object} [siteConfig.autoHealRules.triggers.slowRequests] A rule
- * based on request execution time.
- * @member {string} [siteConfig.autoHealRules.triggers.slowRequests.timeTaken]
- * Time taken.
- * @member {number} [siteConfig.autoHealRules.triggers.slowRequests.count]
- * Request Count.
- * @member {string}
- * [siteConfig.autoHealRules.triggers.slowRequests.timeInterval] Time interval.
- * @member {object} [siteConfig.autoHealRules.actions] Actions to be executed
- * when a rule is triggered.
- * @member {string} [siteConfig.autoHealRules.actions.actionType] Predefined
- * action to be taken. Possible values include: 'Recycle', 'LogEvent',
- * 'CustomAction'
- * @member {object} [siteConfig.autoHealRules.actions.customAction] Custom
- * action to be taken.
- * @member {string} [siteConfig.autoHealRules.actions.customAction.exe]
- * Executable to be run.
- * @member {string} [siteConfig.autoHealRules.actions.customAction.parameters]
- * Parameters for the executable.
- * @member {string} [siteConfig.autoHealRules.actions.minProcessExecutionTime]
- * Minimum time the process must execute
- * before taking the action
- * @member {string} [siteConfig.tracingOptions] Tracing options.
- * @member {string} [siteConfig.vnetName] Virtual Network name.
- * @member {object} [siteConfig.cors] Cross-Origin Resource Sharing (CORS)
- * settings.
- * @member {array} [siteConfig.cors.allowedOrigins] Gets or sets the list of
- * origins that should be allowed to make cross-origin
- * calls (for example: http://example.com:12345). Use "*" to allow all.
- * @member {object} [siteConfig.push] Push endpoint settings.
- * @member {boolean} [siteConfig.push.isPushEnabled] Gets or sets a flag
- * indicating whether the Push endpoint is enabled.
- * @member {string} [siteConfig.push.tagWhitelistJson] Gets or sets a JSON
- * string containing a list of tags that are whitelisted for use by the push
- * registration endpoint.
- * @member {string} [siteConfig.push.tagsRequiringAuth] Gets or sets a JSON
- * string containing a list of tags that require user authentication to be used
- * in the push registration endpoint.
- * Tags can consist of alphanumeric characters and the following:
- * '_', '@', '#', '.', ':', '-'.
- * Validation should be performed at the PushRequestHandler.
- * @member {string} [siteConfig.push.dynamicTagsJson] Gets or sets a JSON
- * string containing a list of dynamic tags that will be evaluated from user
- * claims in the push registration endpoint.
- * @member {object} [siteConfig.apiDefinition] Information about the formal API
- * definition for the app.
- * @member {string} [siteConfig.apiDefinition.url] The URL of the API
- * definition.
- * @member {string} [siteConfig.autoSwapSlotName] Auto-swap slot name.
- * @member {boolean} [siteConfig.localMySqlEnabled] true to enable
- * local MySQL; otherwise, false.
- * @member {number} [siteConfig.managedServiceIdentityId] Managed Service
- * Identity Id
- * @member {number} [siteConfig.xManagedServiceIdentityId] Explicit Managed
- * Service Identity Id
- * @member {array} [siteConfig.ipSecurityRestrictions] IP security
- * restrictions.
- * @member {boolean} [siteConfig.http20Enabled] Http20Enabled: configures a web
- * site to allow clients to connect over http2.0
- * @member {string} [siteConfig.minTlsVersion] MinTlsVersion: configures the
- * minimum version of TLS required for SSL requests. Possible values include:
- * '1.0', '1.1', '1.2'
- * @member {string} [siteConfig.ftpsState] State of FTP / FTPS service.
- * Possible values include: 'AllAllowed', 'FtpsOnly', 'Disabled'
- * @member {number} [siteConfig.reservedInstanceCount] Number of reserved
- * instances.
- * This setting only applies to the Consumption Plan
- * @member {array} [trafficManagerHostNames] Azure Traffic Manager hostnames
- * associated with the app. Read-only.
- * @member {boolean} [scmSiteAlsoStopped] true to stop SCM (KUDU)
- * site when the app is stopped; otherwise, false. The default is
- * false. Default value: false .
- * @member {string} [targetSwapSlot] Specifies which deployment slot this app
- * will swap into. Read-only.
- * @member {object} [hostingEnvironmentProfile] App Service Environment to use
- * for the app.
- * @member {string} [hostingEnvironmentProfile.id] Resource ID of the App
- * Service Environment.
- * @member {string} [hostingEnvironmentProfile.name] Name of the App Service
- * Environment.
- * @member {string} [hostingEnvironmentProfile.type] Resource type of the App
- * Service Environment.
- * @member {boolean} [clientAffinityEnabled] true to enable client
- * affinity; false to stop sending session affinity cookies, which
- * route client requests in the same session to the same instance. Default is
- * true.
- * @member {boolean} [clientCertEnabled] true to enable client
- * certificate authentication (TLS mutual authentication); otherwise,
- * false. Default is false.
- * @member {boolean} [hostNamesDisabled] true to disable the
- * public hostnames of the app; otherwise, false.
- * If true, the app is only accessible via API management process.
- * @member {string} [outboundIpAddresses] List of IP addresses that the app
- * uses for outbound connections (e.g. database access). Includes VIPs from
- * tenants that site can be hosted with current settings. Read-only.
- * @member {string} [possibleOutboundIpAddresses] List of IP addresses that the
- * app uses for outbound connections (e.g. database access). Includes VIPs from
- * all tenants. Read-only.
- * @member {number} [containerSize] Size of the function container.
- * @member {number} [dailyMemoryTimeQuota] Maximum allowed daily memory-time
- * quota (applicable on dynamic apps only).
- * @member {date} [suspendedTill] App suspended till in case memory-time quota
- * is exceeded.
- * @member {number} [maxNumberOfWorkers] Maximum number of workers.
- * This only applies to Functions container.
- * @member {object} [cloningInfo] If specified during app creation, the app is
- * cloned from a source app.
- * @member {uuid} [cloningInfo.correlationId] Correlation ID of cloning
- * operation. This ID ties multiple cloning operations
- * together to use the same snapshot.
- * @member {boolean} [cloningInfo.overwrite] true to overwrite
- * destination app; otherwise, false.
- * @member {boolean} [cloningInfo.cloneCustomHostNames] true to
- * clone custom hostnames from source app; otherwise, false.
- * @member {boolean} [cloningInfo.cloneSourceControl] true to
- * clone source control from source app; otherwise, false.
- * @member {string} [cloningInfo.sourceWebAppId] ARM resource ID of the source
- * app. App resource ID is of the form
- * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}
- * for production slots and
- * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName}
- * for other slots.
- * @member {string} [cloningInfo.hostingEnvironment] App Service Environment.
- * @member {object} [cloningInfo.appSettingsOverrides] Application setting
- * overrides for cloned app. If specified, these settings override the settings
- * cloned
- * from source app. Otherwise, application settings from source app are
- * retained.
- * @member {boolean} [cloningInfo.configureLoadBalancing] true to
- * configure load balancing for source and destination app.
- * @member {string} [cloningInfo.trafficManagerProfileId] ARM resource ID of
- * the Traffic Manager profile to use, if it exists. Traffic Manager resource
- * ID is of the form
- * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.
- * @member {string} [cloningInfo.trafficManagerProfileName] Name of Traffic
- * Manager profile to create. This is only needed if Traffic Manager profile
- * does not already exist.
- * @member {string} [resourceGroup] Name of the resource group the app belongs
- * to. Read-only.
- * @member {boolean} [isDefaultContainer] true if the app is a
- * default container; otherwise, false.
- * @member {string} [defaultHostName] Default hostname of the app. Read-only.
- * @member {object} [slotSwapStatus] Status of the last deployment slot swap
- * operation.
- * @member {date} [slotSwapStatus.timestampUtc] The time the last successful
- * slot swap completed.
- * @member {string} [slotSwapStatus.sourceSlotName] The source slot of the last
- * swap operation.
- * @member {string} [slotSwapStatus.destinationSlotName] The destination slot
- * of the last swap operation.
- * @member {boolean} [httpsOnly] HttpsOnly: configures a web site to accept
- * only https requests. Issues redirect for
- * http requests
- */
+*/
export interface SitePatchResource extends ProxyOnlyResource {
+ /**
+ * Current state of the app.
+ */
readonly state?: string;
+ /**
+ * Hostnames associated with the app.
+ */
readonly hostNames?: string[];
+ /**
+ * Name of the repository site.
+ */
readonly repositorySiteName?: string;
+ /**
+ * State indicating whether the app has exceeded its quota usage. Read-only. Possible values
+ * include: 'Normal', 'Exceeded'
+ */
readonly usageState?: string;
+ /**
+ * true if the app is enabled; otherwise, false. Setting this value to
+ * false disables the app (takes the app offline).
+ */
enabled?: boolean;
+ /**
+ * Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled.
+ * Otherwise,
+ * the app is not served on those hostnames.
+ */
readonly enabledHostNames?: string[];
+ /**
+ * Management information availability state for the app. Possible values include: 'Normal',
+ * 'Limited', 'DisasterRecoveryMode'
+ */
readonly availabilityState?: string;
+ /**
+ * Hostname SSL states are used to manage the SSL bindings for app's hostnames.
+ */
hostNameSslStates?: HostNameSslState[];
+ /**
+ * Resource ID of the associated App Service plan, formatted as:
+ * "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
+ */
serverFarmId?: string;
+ /**
+ * true if reserved; otherwise, false.
+ */
reserved?: boolean;
+ /**
+ * Obsolete: Hyper-V sandbox.
+ */
isXenon?: boolean;
+ /**
+ * Hyper-V sandbox.
+ */
hyperV?: boolean;
+ /**
+ * Last time the app was modified, in UTC. Read-only.
+ */
readonly lastModifiedTimeUtc?: Date;
+ /**
+ * Configuration of the app.
+ */
siteConfig?: SiteConfig;
+ /**
+ * Azure Traffic Manager hostnames associated with the app. Read-only.
+ */
readonly trafficManagerHostNames?: string[];
+ /**
+ * true to stop SCM (KUDU) site when the app is stopped; otherwise,
+ * false. The default is false.
+ */
scmSiteAlsoStopped?: boolean;
+ /**
+ * Specifies which deployment slot this app will swap into. Read-only.
+ */
readonly targetSwapSlot?: string;
+ /**
+ * App Service Environment to use for the app.
+ */
hostingEnvironmentProfile?: HostingEnvironmentProfile;
+ /**
+ * true to enable client affinity; false to stop sending session
+ * affinity cookies, which route client requests in the same session to the same instance.
+ * Default is true.
+ */
clientAffinityEnabled?: boolean;
+ /**
+ * true to enable client certificate authentication (TLS mutual authentication);
+ * otherwise, false. Default is false.
+ */
clientCertEnabled?: boolean;
+ /**
+ * true to disable the public hostnames of the app; otherwise, false.
+ * If true, the app is only accessible via API management process.
+ */
hostNamesDisabled?: boolean;
+ /**
+ * List of IP addresses that the app uses for outbound connections (e.g. database access).
+ * Includes VIPs from tenants that site can be hosted with current settings. Read-only.
+ */
readonly outboundIpAddresses?: string;
+ /**
+ * List of IP addresses that the app uses for outbound connections (e.g. database access).
+ * Includes VIPs from all tenants. Read-only.
+ */
readonly possibleOutboundIpAddresses?: string;
+ /**
+ * Size of the function container.
+ */
containerSize?: number;
+ /**
+ * Maximum allowed daily memory-time quota (applicable on dynamic apps only).
+ */
dailyMemoryTimeQuota?: number;
+ /**
+ * App suspended till in case memory-time quota is exceeded.
+ */
readonly suspendedTill?: Date;
+ /**
+ * Maximum number of workers.
+ * This only applies to Functions container.
+ */
readonly maxNumberOfWorkers?: number;
+ /**
+ * If specified during app creation, the app is cloned from a source app.
+ */
cloningInfo?: CloningInfo;
+ /**
+ * Name of the resource group the app belongs to. Read-only.
+ */
readonly resourceGroup?: string;
+ /**
+ * true if the app is a default container; otherwise, false.
+ */
readonly isDefaultContainer?: boolean;
+ /**
+ * Default hostname of the app. Read-only.
+ */
readonly defaultHostName?: string;
+ /**
+ * Status of the last deployment slot swap operation.
+ */
readonly slotSwapStatus?: SlotSwapStatus;
+ /**
+ * HttpsOnly: configures a web site to accept only https requests. Issues redirect for
+ * http requests
+ */
httpsOnly?: boolean;
}
/**
- * @class
- * Initializes a new instance of the SitePhpErrorLogFlag class.
- * @constructor
* Used for getting PHP error logging flag.
- *
- * @member {string} [localLogErrors] Local log_errors setting.
- * @member {string} [masterLogErrors] Master log_errors setting.
- * @member {string} [localLogErrorsMaxLength] Local log_errors_max_len setting.
- * @member {string} [masterLogErrorsMaxLength] Master log_errors_max_len
- * setting.
- */
+*/
export interface SitePhpErrorLogFlag extends ProxyOnlyResource {
+ /**
+ * Local log_errors setting.
+ */
localLogErrors?: string;
+ /**
+ * Master log_errors setting.
+ */
masterLogErrors?: string;
+ /**
+ * Local log_errors_max_len setting.
+ */
localLogErrorsMaxLength?: string;
+ /**
+ * Master log_errors_max_len setting.
+ */
masterLogErrorsMaxLength?: string;
}
/**
- * @class
- * Initializes a new instance of the SiteSourceControl class.
- * @constructor
* Source control configuration for an app.
- *
- * @member {string} [repoUrl] Repository or source control URL.
- * @member {string} [branch] Name of branch to use for deployment.
- * @member {boolean} [isManualIntegration] true to limit to manual
- * integration; false to enable continuous integration (which
- * configures webhooks into online repos like GitHub).
- * @member {boolean} [deploymentRollbackEnabled] true to enable
- * deployment rollback; otherwise, false.
- * @member {boolean} [isMercurial] true for a Mercurial
- * repository; false for a Git repository.
- */
+*/
export interface SiteSourceControl extends ProxyOnlyResource {
+ /**
+ * Repository or source control URL.
+ */
repoUrl?: string;
+ /**
+ * Name of branch to use for deployment.
+ */
branch?: string;
+ /**
+ * true to limit to manual integration; false to enable continuous
+ * integration (which configures webhooks into online repos like GitHub).
+ */
isManualIntegration?: boolean;
+ /**
+ * true to enable deployment rollback; otherwise, false.
+ */
deploymentRollbackEnabled?: boolean;
+ /**
+ * true for a Mercurial repository; false for a Git repository.
+ */
isMercurial?: boolean;
}
/**
- * @class
- * Initializes a new instance of the SlotConfigNamesResource class.
- * @constructor
* Slot Config names azure resource.
- *
- * @member {array} [connectionStringNames] List of connection string names.
- * @member {array} [appSettingNames] List of application settings names.
- * @member {array} [azureStorageConfigNames] List of external Azure storage
- * account identifiers.
- */
+*/
export interface SlotConfigNamesResource extends ProxyOnlyResource {
+ /**
+ * List of connection string names.
+ */
connectionStringNames?: string[];
+ /**
+ * List of application settings names.
+ */
appSettingNames?: string[];
+ /**
+ * List of external Azure storage account identifiers.
+ */
azureStorageConfigNames?: string[];
}
/**
- * @class
- * Initializes a new instance of the SlotDifference class.
- * @constructor
* A setting difference between two deployment slots of an app.
- *
- * @member {string} [level] Level of the difference: Information, Warning or
- * Error.
- * @member {string} [settingType] The type of the setting: General, AppSetting
- * or ConnectionString.
- * @member {string} [diffRule] Rule that describes how to process the setting
- * difference during a slot swap.
- * @member {string} [settingName] Name of the setting.
- * @member {string} [valueInCurrentSlot] Value of the setting in the current
- * slot.
- * @member {string} [valueInTargetSlot] Value of the setting in the target
- * slot.
- * @member {string} [description] Description of the setting difference.
- */
+*/
export interface SlotDifference extends ProxyOnlyResource {
+ /**
+ * Level of the difference: Information, Warning or Error.
+ */
readonly level?: string;
+ /**
+ * The type of the setting: General, AppSetting or ConnectionString.
+ */
readonly settingType?: string;
+ /**
+ * Rule that describes how to process the setting difference during a slot swap.
+ */
readonly diffRule?: string;
+ /**
+ * Name of the setting.
+ */
readonly settingName?: string;
+ /**
+ * Value of the setting in the current slot.
+ */
readonly valueInCurrentSlot?: string;
+ /**
+ * Value of the setting in the target slot.
+ */
readonly valueInTargetSlot?: string;
+ /**
+ * Description of the setting difference.
+ */
readonly description?: string;
}
/**
- * @class
- * Initializes a new instance of the SnapshotRecoverySource class.
- * @constructor
* Specifies the web app that snapshot contents will be retrieved from.
- *
- * @member {string} [location] Geographical location of the source web app,
- * e.g. SouthEastAsia, SouthCentralUS
- * @member {string} [id] ARM resource ID of the source app.
- * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}
- * for production slots and
- * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName}
- * for other slots.
- */
+*/
export interface SnapshotRecoverySource {
+ /**
+ * Geographical location of the source web app, e.g. SouthEastAsia, SouthCentralUS
+ */
location?: string;
+ /**
+ * ARM resource ID of the source app.
+ * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}
+ * for production slots and
+ * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName}
+ * for other slots.
+ */
id?: string;
}
/**
- * @class
- * Initializes a new instance of the SnapshotRestoreRequest class.
- * @constructor
* Details about app recovery operation.
- *
- * @member {string} [snapshotTime] Point in time in which the app restore
- * should be done, formatted as a DateTime string.
- * @member {object} [recoverySource] Optional. Specifies the web app that
- * snapshot contents will be retrieved from.
- * If empty, the targeted web app will be used as the source.
- * @member {string} [recoverySource.location] Geographical location of the
- * source web app, e.g. SouthEastAsia, SouthCentralUS
- * @member {string} [recoverySource.id] ARM resource ID of the source app.
- * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}
- * for production slots and
- * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName}
- * for other slots.
- * @member {boolean} overwrite If true the restore operation can
- * overwrite source app; otherwise, false.
- * @member {boolean} [recoverConfiguration] If true, site configuration, in
- * addition to content, will be reverted.
- * @member {boolean} [ignoreConflictingHostNames] If true, custom hostname
- * conflicts will be ignored when recovering to a target web app.
- * This setting is only necessary when RecoverConfiguration is enabled.
- * @member {boolean} [useDRSecondary] If true, the snapshot is retrieved from
- * DRSecondary endpoint.
- */
+*/
export interface SnapshotRestoreRequest extends ProxyOnlyResource {
+ /**
+ * Point in time in which the app restore should be done, formatted as a DateTime string.
+ */
snapshotTime?: string;
+ /**
+ * Optional. Specifies the web app that snapshot contents will be retrieved from.
+ * If empty, the targeted web app will be used as the source.
+ */
recoverySource?: SnapshotRecoverySource;
+ /**
+ * If true the restore operation can overwrite source app; otherwise,
+ * false.
+ */
overwrite: boolean;
+ /**
+ * If true, site configuration, in addition to content, will be reverted.
+ */
recoverConfiguration?: boolean;
+ /**
+ * If true, custom hostname conflicts will be ignored when recovering to a target web app.
+ * This setting is only necessary when RecoverConfiguration is enabled.
+ */
ignoreConflictingHostNames?: boolean;
+ /**
+ * If true, the snapshot is retrieved from DRSecondary endpoint.
+ */
useDRSecondary?: boolean;
}
/**
- * @class
- * Initializes a new instance of the StorageMigrationOptions class.
- * @constructor
* Options for app content migration.
- *
- * @member {string} azurefilesConnectionString AzureFiles connection string.
- * @member {string} azurefilesShare AzureFiles share.
- * @member {boolean} [switchSiteAfterMigration] trueif the app
- * should be switched over; otherwise, false. Default value: false
- * .
- * @member {boolean} [blockWriteAccessToSite] true if the app
- * should be read only during copy operation; otherwise, false.
- * Default value: false .
- */
+*/
export interface StorageMigrationOptions extends ProxyOnlyResource {
+ /**
+ * AzureFiles connection string.
+ */
azurefilesConnectionString: string;
+ /**
+ * AzureFiles share.
+ */
azurefilesShare: string;
+ /**
+ * trueif the app should be switched over; otherwise, false.
+ */
switchSiteAfterMigration?: boolean;
+ /**
+ * true if the app should be read only during copy operation; otherwise,
+ * false.
+ */
blockWriteAccessToSite?: boolean;
}
/**
- * @class
- * Initializes a new instance of the StorageMigrationResponse class.
- * @constructor
* Response for a migration of app content request.
- *
- * @member {string} [operationId] When server starts the migration process, it
- * will return an operation ID identifying that particular migration operation.
- */
+*/
export interface StorageMigrationResponse extends ProxyOnlyResource {
+ /**
+ * When server starts the migration process, it will return an operation ID identifying that
+ * particular migration operation.
+ */
readonly operationId?: string;
}
/**
- * @class
- * Initializes a new instance of the StringDictionary class.
- * @constructor
* String dictionary resource.
- *
- * @member {object} [properties] Settings.
- */
+*/
export interface StringDictionary extends ProxyOnlyResource {
+ /**
+ * Settings.
+ */
properties?: { [propertyName: string]: string };
}
/**
- * @class
- * Initializes a new instance of the SwiftVirtualNetwork class.
- * @constructor
- * Swift Virtual Network Contract. This is used to enable the new Swift way of
- * doing virtual network integration.
- *
- * @member {string} [subnetResourceId] The Virtual Network subnet's resource
- * ID. This is the subnet that this Web App will join. This subnet must have a
- * delegation to Microsoft.Web/serverFarms defined first.
- * @member {boolean} [swiftSupported] A flag that specifies if the scale unit
- * this Web App is on supports Swift integration.
- */
+ * Swift Virtual Network Contract. This is used to enable the new Swift way of doing virtual
+ * network integration.
+*/
export interface SwiftVirtualNetwork extends ProxyOnlyResource {
+ /**
+ * The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This
+ * subnet must have a delegation to Microsoft.Web/serverFarms defined first.
+ */
subnetResourceId?: string;
+ /**
+ * A flag that specifies if the scale unit this Web App is on supports Swift integration.
+ */
swiftSupported?: boolean;
}
/**
- * @class
- * Initializes a new instance of the TriggeredJobRun class.
- * @constructor
* Triggered Web Job Run Information.
- *
- * @member {string} [webJobId] Job ID.
- * @member {string} [webJobName] Job name.
- * @member {string} [status] Job status. Possible values include: 'Success',
- * 'Failed', 'Error'
- * @member {date} [startTime] Start time.
- * @member {date} [endTime] End time.
- * @member {string} [duration] Job duration.
- * @member {string} [outputUrl] Output URL.
- * @member {string} [errorUrl] Error URL.
- * @member {string} [url] Job URL.
- * @member {string} [jobName] Job name.
- * @member {string} [trigger] Job trigger.
- */
+*/
export interface TriggeredJobRun extends ProxyOnlyResource {
+ /**
+ * Job ID.
+ */
webJobId?: string;
+ /**
+ * Job name.
+ */
webJobName?: string;
+ /**
+ * Job status. Possible values include: 'Success', 'Failed', 'Error'
+ */
status?: string;
+ /**
+ * Start time.
+ */
startTime?: Date;
+ /**
+ * End time.
+ */
endTime?: Date;
+ /**
+ * Job duration.
+ */
duration?: string;
+ /**
+ * Output URL.
+ */
outputUrl?: string;
+ /**
+ * Error URL.
+ */
errorUrl?: string;
+ /**
+ * Job URL.
+ */
url?: string;
+ /**
+ * Job name.
+ */
jobName?: string;
+ /**
+ * Job trigger.
+ */
trigger?: string;
}
/**
- * @class
- * Initializes a new instance of the TriggeredJobHistory class.
- * @constructor
- * Triggered Web Job History. List of Triggered Web Job Run Information
- * elements.
- *
- * @member {array} [runs] List of triggered web job runs.
- */
+ * Triggered Web Job History. List of Triggered Web Job Run Information elements.
+*/
export interface TriggeredJobHistory extends ProxyOnlyResource {
+ /**
+ * List of triggered web job runs.
+ */
runs?: TriggeredJobRun[];
}
/**
- * @class
- * Initializes a new instance of the TriggeredWebJob class.
- * @constructor
* Triggered Web Job Information.
- *
- * @member {object} [latestRun] Latest job run information.
- * @member {string} [latestRun.webJobId] Job ID.
- * @member {string} [latestRun.webJobName] Job name.
- * @member {string} [latestRun.status] Job status. Possible values include:
- * 'Success', 'Failed', 'Error'
- * @member {date} [latestRun.startTime] Start time.
- * @member {date} [latestRun.endTime] End time.
- * @member {string} [latestRun.duration] Job duration.
- * @member {string} [latestRun.outputUrl] Output URL.
- * @member {string} [latestRun.errorUrl] Error URL.
- * @member {string} [latestRun.url] Job URL.
- * @member {string} [latestRun.jobName] Job name.
- * @member {string} [latestRun.trigger] Job trigger.
- * @member {string} [historyUrl] History URL.
- * @member {string} [schedulerLogsUrl] Scheduler Logs URL.
- * @member {string} [runCommand] Run command.
- * @member {string} [url] Job URL.
- * @member {string} [extraInfoUrl] Extra Info URL.
- * @member {string} [webJobType] Job type. Possible values include:
- * 'Continuous', 'Triggered'
- * @member {string} [error] Error information.
- * @member {boolean} [usingSdk] Using SDK?
- * @member {object} [settings] Job settings.
- */
+*/
export interface TriggeredWebJob extends ProxyOnlyResource {
+ /**
+ * Latest job run information.
+ */
latestRun?: TriggeredJobRun;
+ /**
+ * History URL.
+ */
historyUrl?: string;
+ /**
+ * Scheduler Logs URL.
+ */
schedulerLogsUrl?: string;
+ /**
+ * Run command.
+ */
runCommand?: string;
+ /**
+ * Job URL.
+ */
url?: string;
+ /**
+ * Extra Info URL.
+ */
extraInfoUrl?: string;
+ /**
+ * Job type. Possible values include: 'Continuous', 'Triggered'
+ */
webJobType?: string;
+ /**
+ * Error information.
+ */
error?: string;
+ /**
+ * Using SDK?
+ */
usingSdk?: boolean;
+ /**
+ * Job settings.
+ */
settings?: { [propertyName: string]: any };
}
/**
- * @class
- * Initializes a new instance of the WebJob class.
- * @constructor
* Web Job Information.
- *
- * @member {string} [runCommand] Run command.
- * @member {string} [url] Job URL.
- * @member {string} [extraInfoUrl] Extra Info URL.
- * @member {string} [webJobType] Job type. Possible values include:
- * 'Continuous', 'Triggered'
- * @member {string} [error] Error information.
- * @member {boolean} [usingSdk] Using SDK?
- * @member {object} [settings] Job settings.
- */
+*/
export interface WebJob extends ProxyOnlyResource {
+ /**
+ * Run command.
+ */
runCommand?: string;
+ /**
+ * Job URL.
+ */
url?: string;
+ /**
+ * Extra Info URL.
+ */
extraInfoUrl?: string;
+ /**
+ * Job type. Possible values include: 'Continuous', 'Triggered'
+ */
webJobType?: string;
+ /**
+ * Error information.
+ */
error?: string;
+ /**
+ * Using SDK?
+ */
usingSdk?: boolean;
+ /**
+ * Job settings.
+ */
settings?: { [propertyName: string]: any };
}
/**
- * @class
- * Initializes a new instance of the AddressResponse class.
- * @constructor
* Describes main public IP address and any extra virtual IPs.
- *
- * @member {string} [serviceIpAddress] Main public virtual IP.
- * @member {string} [internalIpAddress] Virtual Network internal IP address of
- * the App Service Environment if it is in internal load-balancing mode.
- * @member {array} [outboundIpAddresses] IP addresses appearing on outbound
- * connections.
- * @member {array} [vipMappings] Additional virtual IPs.
- */
+*/
export interface AddressResponse {
+ /**
+ * Main public virtual IP.
+ */
serviceIpAddress?: string;
+ /**
+ * Virtual Network internal IP address of the App Service Environment if it is in internal
+ * load-balancing mode.
+ */
internalIpAddress?: string;
+ /**
+ * IP addresses appearing on outbound connections.
+ */
outboundIpAddresses?: string[];
+ /**
+ * Additional virtual IPs.
+ */
vipMappings?: VirtualIPMapping[];
}
/**
- * @class
- * Initializes a new instance of the AppServiceEnvironmentResource class.
- * @constructor
* App Service Environment ARM resource.
- *
- * @member {string} appServiceEnvironmentResourceName Name of the App Service
- * Environment.
- * @member {string} appServiceEnvironmentResourceLocation Location of the App
- * Service Environment, e.g. "West US".
- * @member {string} [provisioningState] Provisioning state of the App Service
- * Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled',
- * 'InProgress', 'Deleting'
- * @member {string} [status] Current status of the App Service Environment.
- * Possible values include: 'Preparing', 'Ready', 'Scaling', 'Deleting'
- * @member {string} [vnetName] Name of the Virtual Network for the App Service
- * Environment.
- * @member {string} [vnetResourceGroupName] Resource group of the Virtual
- * Network.
- * @member {string} [vnetSubnetName] Subnet of the Virtual Network.
- * @member {object} virtualNetwork Description of the Virtual Network.
- * @member {string} [virtualNetwork.id] Resource id of the Virtual Network.
- * @member {string} [virtualNetwork.name] Name of the Virtual Network
- * (read-only).
- * @member {string} [virtualNetwork.type] Resource type of the Virtual Network
- * (read-only).
- * @member {string} [virtualNetwork.subnet] Subnet within the Virtual Network.
- * @member {string} [internalLoadBalancingMode] Specifies which endpoints to
- * serve internally in the Virtual Network for the App Service Environment.
- * Possible values include: 'None', 'Web', 'Publishing'
- * @member {string} [multiSize] Front-end VM size, e.g. "Medium", "Large".
- * @member {number} [multiRoleCount] Number of front-end instances.
- * @member {array} workerPools Description of worker pools with worker size
- * IDs, VM sizes, and number of workers in each pool.
- * @member {number} [ipsslAddressCount] Number of IP SSL addresses reserved for
- * the App Service Environment.
- * @member {string} [databaseEdition] Edition of the metadata database for the
- * App Service Environment, e.g. "Standard".
- * @member {string} [databaseServiceObjective] Service objective of the
- * metadata database for the App Service Environment, e.g. "S0".
- * @member {number} [upgradeDomains] Number of upgrade domains of the App
- * Service Environment.
- * @member {string} [subscriptionId] Subscription of the App Service
- * Environment.
- * @member {string} [dnsSuffix] DNS suffix of the App Service Environment.
- * @member {string} [lastAction] Last deployment action on the App Service
- * Environment.
- * @member {string} [lastActionResult] Result of the last deployment action on
- * the App Service Environment.
- * @member {string} [allowedMultiSizes] List of comma separated strings
- * describing which VM sizes are allowed for front-ends.
- * @member {string} [allowedWorkerSizes] List of comma separated strings
- * describing which VM sizes are allowed for workers.
- * @member {number} [maximumNumberOfMachines] Maximum number of VMs in the App
- * Service Environment.
- * @member {array} [vipMappings] Description of IP SSL mapping for the App
- * Service Environment.
- * @member {array} [environmentCapacities] Current total, used, and available
- * worker capacities.
- * @member {array} [networkAccessControlList] Access control list for
- * controlling traffic to the App Service Environment.
- * @member {boolean} [environmentIsHealthy] True/false indicating whether the
- * App Service Environment is healthy.
- * @member {string} [environmentStatus] Detailed message about with results of
- * the last check of the App Service Environment.
- * @member {string} [resourceGroup] Resource group of the App Service
- * Environment.
- * @member {number} [frontEndScaleFactor] Scale factor for front-ends.
- * @member {number} [defaultFrontEndScaleFactor] Default Scale Factor for
- * FrontEnds.
- * @member {string} [apiManagementAccountId] API Management Account associated
- * with the App Service Environment.
- * @member {boolean} [suspended] true if the App Service
- * Environment is suspended; otherwise, false. The environment can
- * be suspended, e.g. when the management endpoint is no longer available
- * (most likely because NSG blocked the incoming traffic).
- * @member {boolean} [dynamicCacheEnabled] True/false indicating whether the
- * App Service Environment is suspended. The environment can be suspended e.g.
- * when the management endpoint is no longer available
- * (most likely because NSG blocked the incoming traffic).
- * @member {array} [clusterSettings] Custom settings for changing the behavior
- * of the App Service Environment.
- * @member {array} [userWhitelistedIpRanges] User added ip ranges to whitelist
- * on ASE db
- * @member {boolean} [hasLinuxWorkers] Flag that displays whether an ASE has
- * linux workers or not
- * @member {string} [sslCertKeyVaultId] Key Vault ID for ILB App Service
- * Environment default SSL certificate
- * @member {string} [sslCertKeyVaultSecretName] Key Vault Secret Name for ILB
- * App Service Environment default SSL certificate
- */
+*/
export interface AppServiceEnvironmentResource extends Resource {
+ /**
+ * Name of the App Service Environment.
+ */
appServiceEnvironmentResourceName: string;
+ /**
+ * Location of the App Service Environment, e.g. "West US".
+ */
appServiceEnvironmentResourceLocation: string;
+ /**
+ * Provisioning state of the App Service Environment. Possible values include: 'Succeeded',
+ * 'Failed', 'Canceled', 'InProgress', 'Deleting'
+ */
readonly provisioningState?: string;
+ /**
+ * Current status of the App Service Environment. Possible values include: 'Preparing', 'Ready',
+ * 'Scaling', 'Deleting'
+ */
readonly status?: string;
+ /**
+ * Name of the Virtual Network for the App Service Environment.
+ */
vnetName?: string;
+ /**
+ * Resource group of the Virtual Network.
+ */
vnetResourceGroupName?: string;
+ /**
+ * Subnet of the Virtual Network.
+ */
vnetSubnetName?: string;
+ /**
+ * Description of the Virtual Network.
+ */
virtualNetwork: VirtualNetworkProfile;
+ /**
+ * Specifies which endpoints to serve internally in the Virtual Network for the App Service
+ * Environment. Possible values include: 'None', 'Web', 'Publishing'
+ */
internalLoadBalancingMode?: string;
+ /**
+ * Front-end VM size, e.g. "Medium", "Large".
+ */
multiSize?: string;
+ /**
+ * Number of front-end instances.
+ */
multiRoleCount?: number;
+ /**
+ * Description of worker pools with worker size IDs, VM sizes, and number of workers in each
+ * pool.
+ */
workerPools: WorkerPool[];
+ /**
+ * Number of IP SSL addresses reserved for the App Service Environment.
+ */
ipsslAddressCount?: number;
+ /**
+ * Edition of the metadata database for the App Service Environment, e.g. "Standard".
+ */
readonly databaseEdition?: string;
+ /**
+ * Service objective of the metadata database for the App Service Environment, e.g. "S0".
+ */
readonly databaseServiceObjective?: string;
+ /**
+ * Number of upgrade domains of the App Service Environment.
+ */
readonly upgradeDomains?: number;
+ /**
+ * Subscription of the App Service Environment.
+ */
readonly subscriptionId?: string;
+ /**
+ * DNS suffix of the App Service Environment.
+ */
dnsSuffix?: string;
+ /**
+ * Last deployment action on the App Service Environment.
+ */
readonly lastAction?: string;
+ /**
+ * Result of the last deployment action on the App Service Environment.
+ */
readonly lastActionResult?: string;
+ /**
+ * List of comma separated strings describing which VM sizes are allowed for front-ends.
+ */
readonly allowedMultiSizes?: string;
+ /**
+ * List of comma separated strings describing which VM sizes are allowed for workers.
+ */
readonly allowedWorkerSizes?: string;
+ /**
+ * Maximum number of VMs in the App Service Environment.
+ */
readonly maximumNumberOfMachines?: number;
+ /**
+ * Description of IP SSL mapping for the App Service Environment.
+ */
readonly vipMappings?: VirtualIPMapping[];
+ /**
+ * Current total, used, and available worker capacities.
+ */
readonly environmentCapacities?: StampCapacity[];
+ /**
+ * Access control list for controlling traffic to the App Service Environment.
+ */
networkAccessControlList?: NetworkAccessControlEntry[];
+ /**
+ * True/false indicating whether the App Service Environment is healthy.
+ */
readonly environmentIsHealthy?: boolean;
+ /**
+ * Detailed message about with results of the last check of the App Service Environment.
+ */
readonly environmentStatus?: string;
+ /**
+ * Resource group of the App Service Environment.
+ */
readonly resourceGroup?: string;
+ /**
+ * Scale factor for front-ends.
+ */
frontEndScaleFactor?: number;
+ /**
+ * Default Scale Factor for FrontEnds.
+ */
readonly defaultFrontEndScaleFactor?: number;
+ /**
+ * API Management Account associated with the App Service Environment.
+ */
apiManagementAccountId?: string;
+ /**
+ * true if the App Service Environment is suspended; otherwise, false.
+ * The environment can be suspended, e.g. when the management endpoint is no longer available
+ * (most likely because NSG blocked the incoming traffic).
+ */
suspended?: boolean;
+ /**
+ * True/false indicating whether the App Service Environment is suspended. The environment can be
+ * suspended e.g. when the management endpoint is no longer available
+ * (most likely because NSG blocked the incoming traffic).
+ */
dynamicCacheEnabled?: boolean;
+ /**
+ * Custom settings for changing the behavior of the App Service Environment.
+ */
clusterSettings?: NameValuePair[];
+ /**
+ * User added ip ranges to whitelist on ASE db
+ */
userWhitelistedIpRanges?: string[];
+ /**
+ * Flag that displays whether an ASE has linux workers or not
+ */
hasLinuxWorkers?: boolean;
+ /**
+ * Key Vault ID for ILB App Service Environment default SSL certificate
+ */
sslCertKeyVaultId?: string;
+ /**
+ * Key Vault Secret Name for ILB App Service Environment default SSL certificate
+ */
sslCertKeyVaultSecretName?: string;
}
/**
- * @class
- * Initializes a new instance of the AppServiceEnvironmentPatchResource class.
- * @constructor
- * ARM resource for a app service enviroment.
- *
- * @member {string} appServiceEnvironmentPatchResourceName Name of the App
- * Service Environment.
- * @member {string} location Location of the App Service Environment, e.g.
- * "West US".
- * @member {string} [provisioningState] Provisioning state of the App Service
- * Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled',
- * 'InProgress', 'Deleting'
- * @member {string} [status] Current status of the App Service Environment.
- * Possible values include: 'Preparing', 'Ready', 'Scaling', 'Deleting'
- * @member {string} [vnetName] Name of the Virtual Network for the App Service
- * Environment.
- * @member {string} [vnetResourceGroupName] Resource group of the Virtual
- * Network.
- * @member {string} [vnetSubnetName] Subnet of the Virtual Network.
- * @member {object} virtualNetwork Description of the Virtual Network.
- * @member {string} [virtualNetwork.id] Resource id of the Virtual Network.
- * @member {string} [virtualNetwork.name] Name of the Virtual Network
- * (read-only).
- * @member {string} [virtualNetwork.type] Resource type of the Virtual Network
- * (read-only).
- * @member {string} [virtualNetwork.subnet] Subnet within the Virtual Network.
- * @member {string} [internalLoadBalancingMode] Specifies which endpoints to
- * serve internally in the Virtual Network for the App Service Environment.
- * Possible values include: 'None', 'Web', 'Publishing'
- * @member {string} [multiSize] Front-end VM size, e.g. "Medium", "Large".
- * @member {number} [multiRoleCount] Number of front-end instances.
- * @member {array} workerPools Description of worker pools with worker size
- * IDs, VM sizes, and number of workers in each pool.
- * @member {number} [ipsslAddressCount] Number of IP SSL addresses reserved for
- * the App Service Environment.
- * @member {string} [databaseEdition] Edition of the metadata database for the
- * App Service Environment, e.g. "Standard".
- * @member {string} [databaseServiceObjective] Service objective of the
- * metadata database for the App Service Environment, e.g. "S0".
- * @member {number} [upgradeDomains] Number of upgrade domains of the App
- * Service Environment.
- * @member {string} [subscriptionId] Subscription of the App Service
- * Environment.
- * @member {string} [dnsSuffix] DNS suffix of the App Service Environment.
- * @member {string} [lastAction] Last deployment action on the App Service
- * Environment.
- * @member {string} [lastActionResult] Result of the last deployment action on
- * the App Service Environment.
- * @member {string} [allowedMultiSizes] List of comma separated strings
- * describing which VM sizes are allowed for front-ends.
- * @member {string} [allowedWorkerSizes] List of comma separated strings
- * describing which VM sizes are allowed for workers.
- * @member {number} [maximumNumberOfMachines] Maximum number of VMs in the App
- * Service Environment.
- * @member {array} [vipMappings] Description of IP SSL mapping for the App
- * Service Environment.
- * @member {array} [environmentCapacities] Current total, used, and available
- * worker capacities.
- * @member {array} [networkAccessControlList] Access control list for
- * controlling traffic to the App Service Environment.
- * @member {boolean} [environmentIsHealthy] True/false indicating whether the
- * App Service Environment is healthy.
- * @member {string} [environmentStatus] Detailed message about with results of
- * the last check of the App Service Environment.
- * @member {string} [resourceGroup] Resource group of the App Service
- * Environment.
- * @member {number} [frontEndScaleFactor] Scale factor for front-ends.
- * @member {number} [defaultFrontEndScaleFactor] Default Scale Factor for
- * FrontEnds.
- * @member {string} [apiManagementAccountId] API Management Account associated
- * with the App Service Environment.
- * @member {boolean} [suspended] true if the App Service
- * Environment is suspended; otherwise, false. The environment can
- * be suspended, e.g. when the management endpoint is no longer available
- * (most likely because NSG blocked the incoming traffic).
- * @member {boolean} [dynamicCacheEnabled] True/false indicating whether the
- * App Service Environment is suspended. The environment can be suspended e.g.
- * when the management endpoint is no longer available
- * (most likely because NSG blocked the incoming traffic).
- * @member {array} [clusterSettings] Custom settings for changing the behavior
- * of the App Service Environment.
- * @member {array} [userWhitelistedIpRanges] User added ip ranges to whitelist
- * on ASE db
- * @member {boolean} [hasLinuxWorkers] Flag that displays whether an ASE has
- * linux workers or not
- * @member {string} [sslCertKeyVaultId] Key Vault ID for ILB App Service
- * Environment default SSL certificate
- * @member {string} [sslCertKeyVaultSecretName] Key Vault Secret Name for ILB
- * App Service Environment default SSL certificate
- */
+ * ARM resource for a app service environment.
+*/
export interface AppServiceEnvironmentPatchResource extends ProxyOnlyResource {
+ /**
+ * Name of the App Service Environment.
+ */
appServiceEnvironmentPatchResourceName: string;
+ /**
+ * Location of the App Service Environment, e.g. "West US".
+ */
location: string;
+ /**
+ * Provisioning state of the App Service Environment. Possible values include: 'Succeeded',
+ * 'Failed', 'Canceled', 'InProgress', 'Deleting'
+ */
readonly provisioningState?: string;
+ /**
+ * Current status of the App Service Environment. Possible values include: 'Preparing', 'Ready',
+ * 'Scaling', 'Deleting'
+ */
readonly status?: string;
+ /**
+ * Name of the Virtual Network for the App Service Environment.
+ */
vnetName?: string;
+ /**
+ * Resource group of the Virtual Network.
+ */
vnetResourceGroupName?: string;
+ /**
+ * Subnet of the Virtual Network.
+ */
vnetSubnetName?: string;
+ /**
+ * Description of the Virtual Network.
+ */
virtualNetwork: VirtualNetworkProfile;
+ /**
+ * Specifies which endpoints to serve internally in the Virtual Network for the App Service
+ * Environment. Possible values include: 'None', 'Web', 'Publishing'
+ */
internalLoadBalancingMode?: string;
+ /**
+ * Front-end VM size, e.g. "Medium", "Large".
+ */
multiSize?: string;
+ /**
+ * Number of front-end instances.
+ */
multiRoleCount?: number;
+ /**
+ * Description of worker pools with worker size IDs, VM sizes, and number of workers in each
+ * pool.
+ */
workerPools: WorkerPool[];
+ /**
+ * Number of IP SSL addresses reserved for the App Service Environment.
+ */
ipsslAddressCount?: number;
+ /**
+ * Edition of the metadata database for the App Service Environment, e.g. "Standard".
+ */
readonly databaseEdition?: string;
+ /**
+ * Service objective of the metadata database for the App Service Environment, e.g. "S0".
+ */
readonly databaseServiceObjective?: string;
+ /**
+ * Number of upgrade domains of the App Service Environment.
+ */
readonly upgradeDomains?: number;
+ /**
+ * Subscription of the App Service Environment.
+ */
readonly subscriptionId?: string;
+ /**
+ * DNS suffix of the App Service Environment.
+ */
dnsSuffix?: string;
+ /**
+ * Last deployment action on the App Service Environment.
+ */
readonly lastAction?: string;
+ /**
+ * Result of the last deployment action on the App Service Environment.
+ */
readonly lastActionResult?: string;
+ /**
+ * List of comma separated strings describing which VM sizes are allowed for front-ends.
+ */
readonly allowedMultiSizes?: string;
+ /**
+ * List of comma separated strings describing which VM sizes are allowed for workers.
+ */
readonly allowedWorkerSizes?: string;
+ /**
+ * Maximum number of VMs in the App Service Environment.
+ */
readonly maximumNumberOfMachines?: number;
+ /**
+ * Description of IP SSL mapping for the App Service Environment.
+ */
readonly vipMappings?: VirtualIPMapping[];
+ /**
+ * Current total, used, and available worker capacities.
+ */
readonly environmentCapacities?: StampCapacity[];
+ /**
+ * Access control list for controlling traffic to the App Service Environment.
+ */
networkAccessControlList?: NetworkAccessControlEntry[];
+ /**
+ * True/false indicating whether the App Service Environment is healthy.
+ */
readonly environmentIsHealthy?: boolean;
+ /**
+ * Detailed message about with results of the last check of the App Service Environment.
+ */
readonly environmentStatus?: string;
+ /**
+ * Resource group of the App Service Environment.
+ */
readonly resourceGroup?: string;
+ /**
+ * Scale factor for front-ends.
+ */
frontEndScaleFactor?: number;
+ /**
+ * Default Scale Factor for FrontEnds.
+ */
readonly defaultFrontEndScaleFactor?: number;
+ /**
+ * API Management Account associated with the App Service Environment.
+ */
apiManagementAccountId?: string;
+ /**
+ * true if the App Service Environment is suspended; otherwise, false.
+ * The environment can be suspended, e.g. when the management endpoint is no longer available
+ * (most likely because NSG blocked the incoming traffic).
+ */
suspended?: boolean;
+ /**
+ * True/false indicating whether the App Service Environment is suspended. The environment can be
+ * suspended e.g. when the management endpoint is no longer available
+ * (most likely because NSG blocked the incoming traffic).
+ */
dynamicCacheEnabled?: boolean;
+ /**
+ * Custom settings for changing the behavior of the App Service Environment.
+ */
clusterSettings?: NameValuePair[];
+ /**
+ * User added ip ranges to whitelist on ASE db
+ */
userWhitelistedIpRanges?: string[];
+ /**
+ * Flag that displays whether an ASE has linux workers or not
+ */
hasLinuxWorkers?: boolean;
+ /**
+ * Key Vault ID for ILB App Service Environment default SSL certificate
+ */
sslCertKeyVaultId?: string;
+ /**
+ * Key Vault Secret Name for ILB App Service Environment default SSL certificate
+ */
sslCertKeyVaultSecretName?: string;
}
/**
- * @class
- * Initializes a new instance of the HostingEnvironmentDiagnostics class.
- * @constructor
* Diagnostics for an App Service Environment.
- *
- * @member {string} [name] Name/identifier of the diagnostics.
- * @member {string} [diagnosicsOutput] Diagnostics output.
- */
+*/
export interface HostingEnvironmentDiagnostics {
+ /**
+ * Name/identifier of the diagnostics.
+ */
name?: string;
+ /**
+ * Diagnostics output.
+ */
diagnosicsOutput?: string;
}
/**
- * @class
- * Initializes a new instance of the MetricAvailabilily class.
- * @constructor
* Metric availability and retention.
- *
- * @member {string} [timeGrain] Time grain.
- * @member {string} [retention] Retention period for the current time grain.
- */
+*/
export interface MetricAvailabilily {
+ /**
+ * Time grain.
+ */
timeGrain?: string;
+ /**
+ * Retention period for the current time grain.
+ */
retention?: string;
}
/**
- * @class
- * Initializes a new instance of the MetricDefinition class.
- * @constructor
* Metadata for a metric.
- *
- * @member {string} [unit] Unit of the metric.
- * @member {string} [primaryAggregationType] Primary aggregation type.
- * @member {array} [metricAvailabilities] List of time grains supported for the
- * metric together with retention period.
- * @member {string} [displayName] Friendly name shown in the UI.
- */
+*/
export interface MetricDefinition extends ProxyOnlyResource {
+ /**
+ * Unit of the metric.
+ */
readonly unit?: string;
+ /**
+ * Primary aggregation type.
+ */
readonly primaryAggregationType?: string;
+ /**
+ * List of time grains supported for the metric together with retention period.
+ */
readonly metricAvailabilities?: MetricAvailabilily[];
+ /**
+ * Friendly name shown in the UI.
+ */
readonly displayName?: string;
}
/**
- * @class
- * Initializes a new instance of the SkuInfo class.
- * @constructor
* SKU discovery information.
- *
- * @member {string} [resourceType] Resource type that this SKU applies to.
- * @member {object} [sku] Name and tier of the SKU.
- * @member {string} [sku.name] Name of the resource SKU.
- * @member {string} [sku.tier] Service tier of the resource SKU.
- * @member {string} [sku.size] Size specifier of the resource SKU.
- * @member {string} [sku.family] Family code of the resource SKU.
- * @member {number} [sku.capacity] Current number of instances assigned to the
- * resource.
- * @member {object} [sku.skuCapacity] Min, max, and default scale values of the
- * SKU.
- * @member {number} [sku.skuCapacity.minimum] Minimum number of workers for
- * this App Service plan SKU.
- * @member {number} [sku.skuCapacity.maximum] Maximum number of workers for
- * this App Service plan SKU.
- * @member {number} [sku.skuCapacity.default] Default number of workers for
- * this App Service plan SKU.
- * @member {string} [sku.skuCapacity.scaleType] Available scale configurations
- * for an App Service plan.
- * @member {array} [sku.locations] Locations of the SKU.
- * @member {array} [sku.capabilities] Capabilities of the SKU, e.g., is traffic
- * manager enabled?
- * @member {object} [capacity] Min, max, and default scale values of the SKU.
- * @member {number} [capacity.minimum] Minimum number of workers for this App
- * Service plan SKU.
- * @member {number} [capacity.maximum] Maximum number of workers for this App
- * Service plan SKU.
- * @member {number} [capacity.default] Default number of workers for this App
- * Service plan SKU.
- * @member {string} [capacity.scaleType] Available scale configurations for an
- * App Service plan.
- */
+*/
export interface SkuInfo {
+ /**
+ * Resource type that this SKU applies to.
+ */
resourceType?: string;
+ /**
+ * Name and tier of the SKU.
+ */
sku?: SkuDescription;
+ /**
+ * Min, max, and default scale values of the SKU.
+ */
capacity?: SkuCapacity;
}
/**
- * @class
- * Initializes a new instance of the Usage class.
- * @constructor
* Usage of the quota resource.
- *
- * @member {string} [displayName] Friendly name shown in the UI.
- * @member {string} [resourceName] Name of the quota resource.
- * @member {string} [unit] Units of measurement for the quota resource.
- * @member {number} [currentValue] The current value of the resource counter.
- * @member {number} [limit] The resource limit.
- * @member {date} [nextResetTime] Next reset time for the resource counter.
- * @member {string} [computeMode] Compute mode used for this usage. Possible
- * values include: 'Shared', 'Dedicated', 'Dynamic'
- * @member {string} [siteMode] Site mode used for this usage.
- */
+*/
export interface Usage extends ProxyOnlyResource {
+ /**
+ * Friendly name shown in the UI.
+ */
readonly displayName?: string;
+ /**
+ * Name of the quota resource.
+ */
readonly resourceName?: string;
+ /**
+ * Units of measurement for the quota resource.
+ */
readonly unit?: string;
+ /**
+ * The current value of the resource counter.
+ */
readonly currentValue?: number;
+ /**
+ * The resource limit.
+ */
readonly limit?: number;
+ /**
+ * Next reset time for the resource counter.
+ */
readonly nextResetTime?: Date;
+ /**
+ * Compute mode used for this usage. Possible values include: 'Shared', 'Dedicated', 'Dynamic'
+ */
readonly computeMode?: string;
+ /**
+ * Site mode used for this usage.
+ */
readonly siteMode?: string;
}
/**
- * @class
- * Initializes a new instance of the WorkerPoolResource class.
- * @constructor
* Worker pool of an App Service Environment ARM resource.
- *
- * @member {number} [workerSizeId] Worker size ID for referencing this worker
- * pool.
- * @member {string} [computeMode] Shared or dedicated app hosting. Possible
- * values include: 'Shared', 'Dedicated', 'Dynamic'
- * @member {string} [workerSize] VM size of the worker pool instances.
- * @member {number} [workerCount] Number of instances in the worker pool.
- * @member {array} [instanceNames] Names of all instances in the worker pool
- * (read only).
- * @member {object} [sku]
- * @member {string} [sku.name] Name of the resource SKU.
- * @member {string} [sku.tier] Service tier of the resource SKU.
- * @member {string} [sku.size] Size specifier of the resource SKU.
- * @member {string} [sku.family] Family code of the resource SKU.
- * @member {number} [sku.capacity] Current number of instances assigned to the
- * resource.
- * @member {object} [sku.skuCapacity] Min, max, and default scale values of the
- * SKU.
- * @member {number} [sku.skuCapacity.minimum] Minimum number of workers for
- * this App Service plan SKU.
- * @member {number} [sku.skuCapacity.maximum] Maximum number of workers for
- * this App Service plan SKU.
- * @member {number} [sku.skuCapacity.default] Default number of workers for
- * this App Service plan SKU.
- * @member {string} [sku.skuCapacity.scaleType] Available scale configurations
- * for an App Service plan.
- * @member {array} [sku.locations] Locations of the SKU.
- * @member {array} [sku.capabilities] Capabilities of the SKU, e.g., is traffic
- * manager enabled?
- */
+*/
export interface WorkerPoolResource extends ProxyOnlyResource {
+ /**
+ * Worker size ID for referencing this worker pool.
+ */
workerSizeId?: number;
+ /**
+ * Shared or dedicated app hosting. Possible values include: 'Shared', 'Dedicated', 'Dynamic'
+ */
computeMode?: string;
+ /**
+ * VM size of the worker pool instances.
+ */
workerSize?: string;
+ /**
+ * Number of instances in the worker pool.
+ */
workerCount?: number;
+ /**
+ * Names of all instances in the worker pool (read only).
+ */
readonly instanceNames?: string[];
sku?: SkuDescription;
}
/**
- * @class
- * Initializes a new instance of the AppServicePlanPatchResource class.
- * @constructor
* ARM resource for a app service plan.
- *
- * @member {string} [workerTierName] Target worker tier assigned to the App
- * Service plan.
- * @member {string} [status] App Service plan status. Possible values include:
- * 'Ready', 'Pending', 'Creating'
- * @member {string} [subscription] App Service plan subscription.
- * @member {string} [adminSiteName] App Service plan administration site.
- * @member {object} [hostingEnvironmentProfile] Specification for the App
- * Service Environment to use for the App Service plan.
- * @member {string} [hostingEnvironmentProfile.id] Resource ID of the App
- * Service Environment.
- * @member {string} [hostingEnvironmentProfile.name] Name of the App Service
- * Environment.
- * @member {string} [hostingEnvironmentProfile.type] Resource type of the App
- * Service Environment.
- * @member {number} [maximumNumberOfWorkers] Maximum number of instances that
- * can be assigned to this App Service plan.
- * @member {string} [geoRegion] Geographical location for the App Service plan.
- * @member {boolean} [perSiteScaling] If true, apps assigned to
- * this App Service plan can be scaled independently.
- * If false, apps assigned to this App Service plan will scale to
- * all instances of the plan. Default value: false .
- * @member {number} [maximumElasticWorkerCount] Maximum number of total workers
- * allowed for this ElasticScaleEnabled App Service Plan
- * @member {number} [numberOfSites] Number of apps assigned to this App Service
- * plan.
- * @member {boolean} [isSpot] If true, this App Service Plan owns
- * spot instances.
- * @member {date} [spotExpirationTime] The time when the server farm expires.
- * Valid only if it is a spot server farm.
- * @member {date} [freeOfferExpirationTime] The time when the server farm free
- * offer expires.
- * @member {string} [resourceGroup] Resource group of the App Service plan.
- * @member {boolean} [reserved] If Linux app service plan true,
- * false otherwise. Default value: false .
- * @member {boolean} [isXenon] Obsolete: If Hyper-V container app service plan
- * true, false otherwise. Default value: false .
- * @member {boolean} [hyperV] If Hyper-V container app service plan
- * true, false otherwise. Default value: false .
- * @member {number} [targetWorkerCount] Scaling worker count.
- * @member {number} [targetWorkerSizeId] Scaling worker size ID.
- * @member {string} [provisioningState] Provisioning state of the App Service
- * Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled',
- * 'InProgress', 'Deleting'
- */
+*/
export interface AppServicePlanPatchResource extends ProxyOnlyResource {
+ /**
+ * Target worker tier assigned to the App Service plan.
+ */
workerTierName?: string;
+ /**
+ * App Service plan status. Possible values include: 'Ready', 'Pending', 'Creating'
+ */
readonly status?: string;
+ /**
+ * App Service plan subscription.
+ */
readonly subscription?: string;
+ /**
+ * App Service plan administration site.
+ */
adminSiteName?: string;
+ /**
+ * Specification for the App Service Environment to use for the App Service plan.
+ */
hostingEnvironmentProfile?: HostingEnvironmentProfile;
+ /**
+ * Maximum number of instances that can be assigned to this App Service plan.
+ */
readonly maximumNumberOfWorkers?: number;
+ /**
+ * Geographical location for the App Service plan.
+ */
readonly geoRegion?: string;
+ /**
+ * If true, apps assigned to this App Service plan can be scaled independently.
+ * If false, apps assigned to this App Service plan will scale to all instances of
+ * the plan.
+ */
perSiteScaling?: boolean;
+ /**
+ * Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
+ */
maximumElasticWorkerCount?: number;
+ /**
+ * Number of apps assigned to this App Service plan.
+ */
readonly numberOfSites?: number;
+ /**
+ * If true, this App Service Plan owns spot instances.
+ */
isSpot?: boolean;
+ /**
+ * The time when the server farm expires. Valid only if it is a spot server farm.
+ */
spotExpirationTime?: Date;
+ /**
+ * The time when the server farm free offer expires.
+ */
freeOfferExpirationTime?: Date;
+ /**
+ * Resource group of the App Service plan.
+ */
readonly resourceGroup?: string;
+ /**
+ * If Linux app service plan true, false otherwise.
+ */
reserved?: boolean;
+ /**
+ * Obsolete: If Hyper-V container app service plan true, false
+ * otherwise.
+ */
isXenon?: boolean;
+ /**
+ * If Hyper-V container app service plan true, false otherwise.
+ */
hyperV?: boolean;
+ /**
+ * Scaling worker count.
+ */
targetWorkerCount?: number;
+ /**
+ * Scaling worker size ID.
+ */
targetWorkerSizeId?: number;
+ /**
+ * Provisioning state of the App Service Environment. Possible values include: 'Succeeded',
+ * 'Failed', 'Canceled', 'InProgress', 'Deleting'
+ */
readonly provisioningState?: string;
}
/**
- * @class
- * Initializes a new instance of the HybridConnectionLimits class.
- * @constructor
- * Hybrid Connection limits contract. This is used to return the plan limits of
- * Hybrid Connections.
- *
- * @member {number} [current] The current number of Hybrid Connections.
- * @member {number} [maximum] The maximum number of Hybrid Connections allowed.
- */
+ * Hybrid Connection limits contract. This is used to return the plan limits of Hybrid Connections.
+*/
export interface HybridConnectionLimits extends ProxyOnlyResource {
+ /**
+ * The current number of Hybrid Connections.
+ */
readonly current?: number;
+ /**
+ * The maximum number of Hybrid Connections allowed.
+ */
readonly maximum?: number;
}
/**
- * @class
- * Initializes a new instance of the ResourceHealthMetadata class.
- * @constructor
* Used for getting ResourceHealthCheck settings.
- *
- * @member {string} [category] The category that the resource matches in the
- * RHC Policy File
- * @member {boolean} [signalAvailability] Is there a health signal for the
- * resource
- */
+*/
export interface ResourceHealthMetadata extends ProxyOnlyResource {
+ /**
+ * The category that the resource matches in the RHC Policy File
+ */
category?: string;
+ /**
+ * Is there a health signal for the resource
+ */
signalAvailability?: boolean;
}
-
/**
- * @class
- * Initializes a new instance of the AppServiceCertificateOrderCollection class.
- * @constructor
- * Collection of certitificate orders.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+ * Collection of certificate orders.
+*/
export interface AppServiceCertificateOrderCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the AppServiceCertificateCollection class.
- * @constructor
* Collection of certitificateorder certificates.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface AppServiceCertificateCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the CsmOperationCollection class.
- * @constructor
* Collection of Azure resource manager operation metadata.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface CsmOperationCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the DomainCollection class.
- * @constructor
* Collection of domains.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface DomainCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the NameIdentifierCollection class.
- * @constructor
* Collection of domain name identifiers.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface NameIdentifierCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the DomainOwnershipIdentifierCollection class.
- * @constructor
* Collection of domain ownership identifiers.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface DomainOwnershipIdentifierCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the TopLevelDomainCollection class.
- * @constructor
* Collection of Top-level domains.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface TopLevelDomainCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the TldLegalAgreementCollection class.
- * @constructor
* Collection of top-level domain legal agreements.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface TldLegalAgreementCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the CertificateCollection class.
- * @constructor
* Collection of certificates.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface CertificateCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the DeletedWebAppCollection class.
- * @constructor
* Collection of deleted apps.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface DeletedWebAppCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the DetectorResponseCollection class.
- * @constructor
* Collection of detector responses
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface DetectorResponseCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the DiagnosticCategoryCollection class.
- * @constructor
* Collection of Diagnostic Categories
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface DiagnosticCategoryCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the DiagnosticAnalysisCollection class.
- * @constructor
* Collection of Diagnostic Analyses
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface DiagnosticAnalysisCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the DiagnosticDetectorCollection class.
- * @constructor
* Collection of Diagnostic Detectors
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface DiagnosticDetectorCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the ApplicationStackCollection class.
- * @constructor
* Collection of Application Stacks
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface ApplicationStackCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the RecommendationCollection class.
- * @constructor
* Collection of recommendations.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface RecommendationCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the SourceControlCollection class.
- * @constructor
* Collection of source controls.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface SourceControlCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the BillingMeterCollection class.
- * @constructor
* Collection of Billing Meters
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface BillingMeterCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the GeoRegionCollection class.
- * @constructor
* Collection of geographical regions.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface GeoRegionCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the IdentifierCollection class.
- * @constructor
* Collection of identifiers.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface IdentifierCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the PremierAddOnOfferCollection class.
- * @constructor
* Collection of premier add-on offers.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface PremierAddOnOfferCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the WebAppCollection class.
- * @constructor
* Collection of App Service apps.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface WebAppCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the BackupItemCollection class.
- * @constructor
* Collection of backup items.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface BackupItemCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the SiteConfigResourceCollection class.
- * @constructor
* Collection of site configurations.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface SiteConfigResourceCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the SiteConfigurationSnapshotInfoCollection class.
- * @constructor
- * Collection of metadata for the app configuration snapshots that can be
- * restored.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
-export interface SiteConfigurationSnapshotInfoCollection extends Array {
+ * Collection of metadata for the app configuration snapshots that can be restored.
+*/
+export interface SiteConfigurationSnapshotInfoCollection extends
+Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the ContinuousWebJobCollection class.
- * @constructor
* Collection of Kudu continuous web job information elements.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface ContinuousWebJobCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the DeploymentCollection class.
- * @constructor
* Collection of app deployments.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface DeploymentCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the FunctionEnvelopeCollection class.
- * @constructor
* Collection of Kudu function information elements.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface FunctionEnvelopeCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the HostNameBindingCollection class.
- * @constructor
* Collection of hostname bindings.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface HostNameBindingCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the WebAppInstanceCollection class.
- * @constructor
* Collection of app instances.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface WebAppInstanceCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the ProcessInfoCollection class.
- * @constructor
* Collection of Kudu process information elements.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface ProcessInfoCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the ProcessModuleInfoCollection class.
- * @constructor
* Collection of Kudu thread information elements.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface ProcessModuleInfoCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the ProcessThreadInfoCollection class.
- * @constructor
* Collection of Kudu thread information elements.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface ProcessThreadInfoCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the ResourceMetricDefinitionCollection class.
- * @constructor
* Collection of metric definitions.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface ResourceMetricDefinitionCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the ResourceMetricCollection class.
- * @constructor
* Collection of metric responses.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface ResourceMetricCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the PerfMonCounterCollection class.
- * @constructor
* Collection of performance monitor counters.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface PerfMonCounterCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the PublicCertificateCollection class.
- * @constructor
* Collection of public certificates
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface PublicCertificateCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the SiteExtensionInfoCollection class.
- * @constructor
* Collection of Kudu site extension information elements.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface SiteExtensionInfoCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the SlotDifferenceCollection class.
- * @constructor
* Collection of slot differences.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface SlotDifferenceCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the SnapshotCollection class.
- * @constructor
- * Collection of snapshots which can be used to revert an app to a previous
- * time.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+ * Collection of snapshots which can be used to revert an app to a previous time.
+*/
export interface SnapshotCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the TriggeredWebJobCollection class.
- * @constructor
* Collection of Kudu continuous web job information elements.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface TriggeredWebJobCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the TriggeredJobHistoryCollection class.
- * @constructor
* Collection of Kudu continuous web job information elements.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface TriggeredJobHistoryCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the CsmUsageQuotaCollection class.
- * @constructor
* Collection of CSM usage quotas.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface CsmUsageQuotaCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the WebJobCollection class.
- * @constructor
* Collection of Kudu web job information elements.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface WebJobCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the AppServiceEnvironmentCollection class.
- * @constructor
* Collection of App Service Environments.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface AppServiceEnvironmentCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the StampCapacityCollection class.
- * @constructor
* Collection of stamp capacities.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface StampCapacityCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the WorkerPoolCollection class.
- * @constructor
* Collection of worker pools.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface WorkerPoolCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the SkuInfoCollection class.
- * @constructor
* Collection of SKU information.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface SkuInfoCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the UsageCollection class.
- * @constructor
* Collection of usages.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface UsageCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the AppServicePlanCollection class.
- * @constructor
* Collection of App Service plans.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface AppServicePlanCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the ResourceCollection class.
- * @constructor
* Collection of resources.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface ResourceCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the HybridConnectionCollection class.
- * @constructor
* Collection of hostname bindings.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface HybridConnectionCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
/**
- * @class
- * Initializes a new instance of the ResourceHealthMetadataCollection class.
- * @constructor
* Collection of resource health metadata.
- *
- * @member {string} [nextLink] Link to next page of resources.
- */
+*/
export interface ResourceHealthMetadataCollection extends Array {
+ /**
+ * Link to next page of resources.
+ */
readonly nextLink?: string;
}
diff --git a/lib/services/websiteManagement2/lib/models/ipSecurityRestriction.js b/lib/services/websiteManagement2/lib/models/ipSecurityRestriction.js
index 7442dc0ebd..5341e3a43d 100644
--- a/lib/services/websiteManagement2/lib/models/ipSecurityRestriction.js
+++ b/lib/services/websiteManagement2/lib/models/ipSecurityRestriction.js
@@ -17,20 +17,20 @@
class IpSecurityRestriction {
/**
* Create a IpSecurityRestriction.
- * @member {string} ipAddress IP address the security restriction is valid
+ * @property {string} ipAddress IP address the security restriction is valid
* for.
* It can be in form of pure ipv4 address (required SubnetMask property) or
* CIDR notation such as ipv4/mask (leading bit match). For CIDR,
* SubnetMask property must not be specified.
- * @member {string} [subnetMask] Subnet mask for the range of IP addresses
+ * @property {string} [subnetMask] Subnet mask for the range of IP addresses
* the restriction is valid for.
- * @member {string} [action] Allow or Deny access for this IP range.
- * @member {string} [tag] Defines what this IP filter will be used for. This
- * is to support IP filtering on proxies. Possible values include: 'Default',
- * 'XffProxy'
- * @member {number} [priority] Priority of IP restriction rule.
- * @member {string} [name] IP restriction rule name.
- * @member {string} [description] IP restriction rule description.
+ * @property {string} [action] Allow or Deny access for this IP range.
+ * @property {string} [tag] Defines what this IP filter will be used for.
+ * This is to support IP filtering on proxies. Possible values include:
+ * 'Default', 'XffProxy'
+ * @property {number} [priority] Priority of IP restriction rule.
+ * @property {string} [name] IP restriction rule name.
+ * @property {string} [description] IP restriction rule description.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/localizableString.js b/lib/services/websiteManagement2/lib/models/localizableString.js
index 0f464c7fe5..c531b12b5e 100644
--- a/lib/services/websiteManagement2/lib/models/localizableString.js
+++ b/lib/services/websiteManagement2/lib/models/localizableString.js
@@ -17,8 +17,8 @@
class LocalizableString {
/**
* Create a LocalizableString.
- * @member {string} [value] Non-localized name.
- * @member {string} [localizedValue] Localized name.
+ * @property {string} [value] Non-localized name.
+ * @property {string} [localizedValue] Localized name.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/logSpecification.js b/lib/services/websiteManagement2/lib/models/logSpecification.js
index afeeeca8e1..104d78faaa 100644
--- a/lib/services/websiteManagement2/lib/models/logSpecification.js
+++ b/lib/services/websiteManagement2/lib/models/logSpecification.js
@@ -17,9 +17,9 @@
class LogSpecification {
/**
* Create a LogSpecification.
- * @member {string} [name]
- * @member {string} [displayName]
- * @member {string} [blobDuration]
+ * @property {string} [name]
+ * @property {string} [displayName]
+ * @property {string} [blobDuration]
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/mSDeploy.js b/lib/services/websiteManagement2/lib/models/mSDeploy.js
index 89bfbd351f..3e94eb4b25 100644
--- a/lib/services/websiteManagement2/lib/models/mSDeploy.js
+++ b/lib/services/websiteManagement2/lib/models/mSDeploy.js
@@ -20,22 +20,22 @@ const models = require('./index');
class MSDeploy extends models['ProxyOnlyResource'] {
/**
* Create a MSDeploy.
- * @member {string} [packageUri] Package URI
- * @member {string} [connectionString] SQL Connection String
- * @member {string} [dbType] Database Type
- * @member {string} [setParametersXmlFileUri] URI of MSDeploy Parameters
+ * @property {string} [packageUri] Package URI
+ * @property {string} [connectionString] SQL Connection String
+ * @property {string} [dbType] Database Type
+ * @property {string} [setParametersXmlFileUri] URI of MSDeploy Parameters
* file. Must not be set if SetParameters is used.
- * @member {object} [setParameters] MSDeploy Parameters. Must not be set if
+ * @property {object} [setParameters] MSDeploy Parameters. Must not be set if
* SetParametersXmlFileUri is used.
- * @member {boolean} [skipAppData] Controls whether the MSDeploy operation
+ * @property {boolean} [skipAppData] Controls whether the MSDeploy operation
* skips the App_Data directory.
* If set to true, the existing App_Data directory on the
* destination
* will not be deleted, and any App_Data directory in the source will be
* ignored.
* Setting is false by default.
- * @member {boolean} [appOffline] Sets the AppOffline rule while the MSDeploy
- * operation executes.
+ * @property {boolean} [appOffline] Sets the AppOffline rule while the
+ * MSDeploy operation executes.
* Setting is false by default.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/mSDeployLog.js b/lib/services/websiteManagement2/lib/models/mSDeployLog.js
index c4128e119d..7e0f8beb5c 100644
--- a/lib/services/websiteManagement2/lib/models/mSDeployLog.js
+++ b/lib/services/websiteManagement2/lib/models/mSDeployLog.js
@@ -20,7 +20,7 @@ const models = require('./index');
class MSDeployLog extends models['ProxyOnlyResource'] {
/**
* Create a MSDeployLog.
- * @member {array} [entries] List of log entry messages
+ * @property {array} [entries] List of log entry messages
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/mSDeployLogEntry.js b/lib/services/websiteManagement2/lib/models/mSDeployLogEntry.js
index dca0c93378..3d2c75265a 100644
--- a/lib/services/websiteManagement2/lib/models/mSDeployLogEntry.js
+++ b/lib/services/websiteManagement2/lib/models/mSDeployLogEntry.js
@@ -17,10 +17,10 @@
class MSDeployLogEntry {
/**
* Create a MSDeployLogEntry.
- * @member {date} [time] Timestamp of log entry
- * @member {string} [type] Log entry type. Possible values include:
+ * @property {date} [time] Timestamp of log entry
+ * @property {string} [type] Log entry type. Possible values include:
* 'Message', 'Warning', 'Error'
- * @member {string} [message] Log entry message
+ * @property {string} [message] Log entry message
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/mSDeployStatus.js b/lib/services/websiteManagement2/lib/models/mSDeployStatus.js
index 3fedbf49cf..7b683f4c2a 100644
--- a/lib/services/websiteManagement2/lib/models/mSDeployStatus.js
+++ b/lib/services/websiteManagement2/lib/models/mSDeployStatus.js
@@ -20,12 +20,12 @@ const models = require('./index');
class MSDeployStatus extends models['ProxyOnlyResource'] {
/**
* Create a MSDeployStatus.
- * @member {string} [deployer] Username of deployer
- * @member {string} [provisioningState] Provisioning state. Possible values
+ * @property {string} [deployer] Username of deployer
+ * @property {string} [provisioningState] Provisioning state. Possible values
* include: 'accepted', 'running', 'succeeded', 'failed', 'canceled'
- * @member {date} [startTime] Start time of deploy operation
- * @member {date} [endTime] End time of deploy operation
- * @member {boolean} [complete] Whether the deployment operation has
+ * @property {date} [startTime] Start time of deploy operation
+ * @property {date} [endTime] End time of deploy operation
+ * @property {boolean} [complete] Whether the deployment operation has
* completed
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/managedServiceIdentity.js b/lib/services/websiteManagement2/lib/models/managedServiceIdentity.js
index 1729031497..7d530a262b 100644
--- a/lib/services/websiteManagement2/lib/models/managedServiceIdentity.js
+++ b/lib/services/websiteManagement2/lib/models/managedServiceIdentity.js
@@ -17,11 +17,11 @@
class ManagedServiceIdentity {
/**
* Create a ManagedServiceIdentity.
- * @member {string} [type] Type of managed service identity. Possible values
- * include: 'SystemAssigned', 'UserAssigned'
- * @member {string} [tenantId] Tenant of managed service identity.
- * @member {string} [principalId] Principal Id of managed service identity.
- * @member {array} [identityIds] Array of UserAssigned managed service
+ * @property {string} [type] Type of managed service identity. Possible
+ * values include: 'SystemAssigned', 'UserAssigned'
+ * @property {string} [tenantId] Tenant of managed service identity.
+ * @property {string} [principalId] Principal Id of managed service identity.
+ * @property {array} [identityIds] Array of UserAssigned managed service
* identities.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/metricAvailabilily.js b/lib/services/websiteManagement2/lib/models/metricAvailabilily.js
index 7957ab3882..80f9789a00 100644
--- a/lib/services/websiteManagement2/lib/models/metricAvailabilily.js
+++ b/lib/services/websiteManagement2/lib/models/metricAvailabilily.js
@@ -17,8 +17,9 @@
class MetricAvailabilily {
/**
* Create a MetricAvailabilily.
- * @member {string} [timeGrain] Time grain.
- * @member {string} [retention] Retention period for the current time grain.
+ * @property {string} [timeGrain] Time grain.
+ * @property {string} [retention] Retention period for the current time
+ * grain.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/metricAvailability.js b/lib/services/websiteManagement2/lib/models/metricAvailability.js
index 84a9285bd4..9deea90836 100644
--- a/lib/services/websiteManagement2/lib/models/metricAvailability.js
+++ b/lib/services/websiteManagement2/lib/models/metricAvailability.js
@@ -17,8 +17,8 @@
class MetricAvailability {
/**
* Create a MetricAvailability.
- * @member {string} [timeGrain]
- * @member {string} [blobDuration]
+ * @property {string} [timeGrain]
+ * @property {string} [blobDuration]
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/metricDefinition.js b/lib/services/websiteManagement2/lib/models/metricDefinition.js
index e42fa83b2a..5a2e2e076e 100644
--- a/lib/services/websiteManagement2/lib/models/metricDefinition.js
+++ b/lib/services/websiteManagement2/lib/models/metricDefinition.js
@@ -20,11 +20,11 @@ const models = require('./index');
class MetricDefinition extends models['ProxyOnlyResource'] {
/**
* Create a MetricDefinition.
- * @member {string} [unit] Unit of the metric.
- * @member {string} [primaryAggregationType] Primary aggregation type.
- * @member {array} [metricAvailabilities] List of time grains supported for
+ * @property {string} [unit] Unit of the metric.
+ * @property {string} [primaryAggregationType] Primary aggregation type.
+ * @property {array} [metricAvailabilities] List of time grains supported for
* the metric together with retention period.
- * @member {string} [displayName] Friendly name shown in the UI.
+ * @property {string} [displayName] Friendly name shown in the UI.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/metricSpecification.js b/lib/services/websiteManagement2/lib/models/metricSpecification.js
index 354439107c..ab33e7617b 100644
--- a/lib/services/websiteManagement2/lib/models/metricSpecification.js
+++ b/lib/services/websiteManagement2/lib/models/metricSpecification.js
@@ -17,21 +17,21 @@
class MetricSpecification {
/**
* Create a MetricSpecification.
- * @member {string} [name]
- * @member {string} [displayName]
- * @member {string} [displayDescription]
- * @member {string} [unit]
- * @member {string} [aggregationType]
- * @member {boolean} [supportsInstanceLevelAggregation]
- * @member {boolean} [enableRegionalMdmAccount]
- * @member {string} [sourceMdmAccount]
- * @member {string} [sourceMdmNamespace]
- * @member {string} [metricFilterPattern]
- * @member {boolean} [fillGapWithZero]
- * @member {boolean} [isInternal]
- * @member {array} [dimensions]
- * @member {string} [category]
- * @member {array} [availabilities]
+ * @property {string} [name]
+ * @property {string} [displayName]
+ * @property {string} [displayDescription]
+ * @property {string} [unit]
+ * @property {string} [aggregationType]
+ * @property {boolean} [supportsInstanceLevelAggregation]
+ * @property {boolean} [enableRegionalMdmAccount]
+ * @property {string} [sourceMdmAccount]
+ * @property {string} [sourceMdmNamespace]
+ * @property {string} [metricFilterPattern]
+ * @property {boolean} [fillGapWithZero]
+ * @property {boolean} [isInternal]
+ * @property {array} [dimensions]
+ * @property {string} [category]
+ * @property {array} [availabilities]
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/migrateMySqlRequest.js b/lib/services/websiteManagement2/lib/models/migrateMySqlRequest.js
index 3f5a50472d..a33d853ad5 100644
--- a/lib/services/websiteManagement2/lib/models/migrateMySqlRequest.js
+++ b/lib/services/websiteManagement2/lib/models/migrateMySqlRequest.js
@@ -20,10 +20,10 @@ const models = require('./index');
class MigrateMySqlRequest extends models['ProxyOnlyResource'] {
/**
* Create a MigrateMySqlRequest.
- * @member {string} connectionString Connection string to the remote MySQL
+ * @property {string} connectionString Connection string to the remote MySQL
* database.
- * @member {string} migrationType The type of migration operation to be done.
- * Possible values include: 'LocalToRemote', 'RemoteToLocal'
+ * @property {string} migrationType The type of migration operation to be
+ * done. Possible values include: 'LocalToRemote', 'RemoteToLocal'
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/migrateMySqlStatus.js b/lib/services/websiteManagement2/lib/models/migrateMySqlStatus.js
index 614da5a007..a3ea1ef1ed 100644
--- a/lib/services/websiteManagement2/lib/models/migrateMySqlStatus.js
+++ b/lib/services/websiteManagement2/lib/models/migrateMySqlStatus.js
@@ -20,12 +20,12 @@ const models = require('./index');
class MigrateMySqlStatus extends models['ProxyOnlyResource'] {
/**
* Create a MigrateMySqlStatus.
- * @member {string} [migrationOperationStatus] Status of the migration task.
- * Possible values include: 'InProgress', 'Failed', 'Succeeded', 'TimedOut',
- * 'Created'
- * @member {string} [operationId] Operation ID for the migration task.
- * @member {boolean} [localMySqlEnabled] True if the web app has in app MySql
- * enabled
+ * @property {string} [migrationOperationStatus] Status of the migration
+ * task. Possible values include: 'InProgress', 'Failed', 'Succeeded',
+ * 'TimedOut', 'Created'
+ * @property {string} [operationId] Operation ID for the migration task.
+ * @property {boolean} [localMySqlEnabled] True if the web app has in app
+ * MySql enabled
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/nameIdentifier.js b/lib/services/websiteManagement2/lib/models/nameIdentifier.js
index 2147dc71dc..e8757e35d7 100644
--- a/lib/services/websiteManagement2/lib/models/nameIdentifier.js
+++ b/lib/services/websiteManagement2/lib/models/nameIdentifier.js
@@ -17,7 +17,7 @@
class NameIdentifier {
/**
* Create a NameIdentifier.
- * @member {string} [name] Name of the object.
+ * @property {string} [name] Name of the object.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/nameIdentifierCollection.js b/lib/services/websiteManagement2/lib/models/nameIdentifierCollection.js
index ea628630e0..d1a7ceffe8 100644
--- a/lib/services/websiteManagement2/lib/models/nameIdentifierCollection.js
+++ b/lib/services/websiteManagement2/lib/models/nameIdentifierCollection.js
@@ -16,7 +16,7 @@
class NameIdentifierCollection extends Array {
/**
* Create a NameIdentifierCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/nameValuePair.js b/lib/services/websiteManagement2/lib/models/nameValuePair.js
index 5e3cdf77c2..59345099bd 100644
--- a/lib/services/websiteManagement2/lib/models/nameValuePair.js
+++ b/lib/services/websiteManagement2/lib/models/nameValuePair.js
@@ -17,8 +17,8 @@
class NameValuePair {
/**
* Create a NameValuePair.
- * @member {string} [name] Pair name.
- * @member {string} [value] Pair value.
+ * @property {string} [name] Pair name.
+ * @property {string} [value] Pair value.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/networkAccessControlEntry.js b/lib/services/websiteManagement2/lib/models/networkAccessControlEntry.js
index 841e6205dd..59a0aa0966 100644
--- a/lib/services/websiteManagement2/lib/models/networkAccessControlEntry.js
+++ b/lib/services/websiteManagement2/lib/models/networkAccessControlEntry.js
@@ -17,12 +17,12 @@
class NetworkAccessControlEntry {
/**
* Create a NetworkAccessControlEntry.
- * @member {string} [action] Action object. Possible values include:
+ * @property {string} [action] Action object. Possible values include:
* 'Permit', 'Deny'
- * @member {string} [description] Description of network access control
+ * @property {string} [description] Description of network access control
* entry.
- * @member {number} [order] Order of precedence.
- * @member {string} [remoteSubnet] Remote subnet.
+ * @property {number} [order] Order of precedence.
+ * @property {string} [remoteSubnet] Remote subnet.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/networkFeatures.js b/lib/services/websiteManagement2/lib/models/networkFeatures.js
index 8d3d2959a8..d45dbeeeb2 100644
--- a/lib/services/websiteManagement2/lib/models/networkFeatures.js
+++ b/lib/services/websiteManagement2/lib/models/networkFeatures.js
@@ -21,26 +21,26 @@ const models = require('./index');
class NetworkFeatures extends models['ProxyOnlyResource'] {
/**
* Create a NetworkFeatures.
- * @member {string} [virtualNetworkName] The Virtual Network name.
- * @member {object} [virtualNetworkConnection] The Virtual Network summary
+ * @property {string} [virtualNetworkName] The Virtual Network name.
+ * @property {object} [virtualNetworkConnection] The Virtual Network summary
* view.
- * @member {string} [virtualNetworkConnection.vnetResourceId] The Virtual
+ * @property {string} [virtualNetworkConnection.vnetResourceId] The Virtual
* Network's resource ID.
- * @member {string} [virtualNetworkConnection.certThumbprint] The client
+ * @property {string} [virtualNetworkConnection.certThumbprint] The client
* certificate thumbprint.
- * @member {buffer} [virtualNetworkConnection.certBlob] A certificate file
+ * @property {buffer} [virtualNetworkConnection.certBlob] A certificate file
* (.cer) blob containing the public key of the private key used to
* authenticate a
* Point-To-Site VPN connection.
- * @member {array} [virtualNetworkConnection.routes] The routes that this
+ * @property {array} [virtualNetworkConnection.routes] The routes that this
* Virtual Network connection uses.
- * @member {boolean} [virtualNetworkConnection.resyncRequired]
+ * @property {boolean} [virtualNetworkConnection.resyncRequired]
* true if a resync is required; otherwise, false.
- * @member {string} [virtualNetworkConnection.dnsServers] DNS servers to be
+ * @property {string} [virtualNetworkConnection.dnsServers] DNS servers to be
* used by this Virtual Network. This should be a comma-separated list of IP
* addresses.
- * @member {array} [hybridConnections] The Hybrid Connections summary view.
- * @member {array} [hybridConnectionsV2] The Hybrid Connection V2 (Service
+ * @property {array} [hybridConnections] The Hybrid Connections summary view.
+ * @property {array} [hybridConnectionsV2] The Hybrid Connection V2 (Service
* Bus) view.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/networkTrace.js b/lib/services/websiteManagement2/lib/models/networkTrace.js
index ffd8d53400..3cd12ae69f 100644
--- a/lib/services/websiteManagement2/lib/models/networkTrace.js
+++ b/lib/services/websiteManagement2/lib/models/networkTrace.js
@@ -17,12 +17,12 @@
class NetworkTrace {
/**
* Create a NetworkTrace.
- * @member {string} [path] Local file path for the captured network trace
+ * @property {string} [path] Local file path for the captured network trace
* file.
- * @member {string} [status] Current status of the network trace operation,
+ * @property {string} [status] Current status of the network trace operation,
* same as Operation.Status (InProgress/Succeeded/Failed).
- * @member {string} [message] Detailed message of a network trace operation,
- * e.g. error message in case of failure.
+ * @property {string} [message] Detailed message of a network trace
+ * operation, e.g. error message in case of failure.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/operation.js b/lib/services/websiteManagement2/lib/models/operation.js
index a48c392107..39694a3b0a 100644
--- a/lib/services/websiteManagement2/lib/models/operation.js
+++ b/lib/services/websiteManagement2/lib/models/operation.js
@@ -17,16 +17,16 @@
class Operation {
/**
* Create a Operation.
- * @member {string} [id] Operation ID.
- * @member {string} [name] Operation name.
- * @member {string} [status] The current status of the operation. Possible
+ * @property {string} [id] Operation ID.
+ * @property {string} [name] Operation name.
+ * @property {string} [status] The current status of the operation. Possible
* values include: 'InProgress', 'Failed', 'Succeeded', 'TimedOut', 'Created'
- * @member {array} [errors] Any errors associate with the operation.
- * @member {date} [createdTime] Time when operation has started.
- * @member {date} [modifiedTime] Time when operation has been updated.
- * @member {date} [expirationTime] Time when operation will expire.
- * @member {uuid} [geoMasterOperationId] Applicable only for stamp operation
- * ids.
+ * @property {array} [errors] Any errors associate with the operation.
+ * @property {date} [createdTime] Time when operation has started.
+ * @property {date} [modifiedTime] Time when operation has been updated.
+ * @property {date} [expirationTime] Time when operation will expire.
+ * @property {uuid} [geoMasterOperationId] Applicable only for stamp
+ * operation ids.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/perfMonCounterCollection.js b/lib/services/websiteManagement2/lib/models/perfMonCounterCollection.js
index f14a13dbff..1ab0fb94bd 100644
--- a/lib/services/websiteManagement2/lib/models/perfMonCounterCollection.js
+++ b/lib/services/websiteManagement2/lib/models/perfMonCounterCollection.js
@@ -16,7 +16,7 @@
class PerfMonCounterCollection extends Array {
/**
* Create a PerfMonCounterCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/perfMonResponse.js b/lib/services/websiteManagement2/lib/models/perfMonResponse.js
index 6eb5b04ffa..b92c53c540 100644
--- a/lib/services/websiteManagement2/lib/models/perfMonResponse.js
+++ b/lib/services/websiteManagement2/lib/models/perfMonResponse.js
@@ -17,15 +17,15 @@
class PerfMonResponse {
/**
* Create a PerfMonResponse.
- * @member {string} [code] The response code.
- * @member {string} [message] The message.
- * @member {object} [data] The performance monitor counters.
- * @member {string} [data.name] Unique key name of the counter.
- * @member {date} [data.startTime] Start time of the period.
- * @member {date} [data.endTime] End time of the period.
- * @member {string} [data.timeGrain] Presented time grain.
- * @member {array} [data.values] Collection of workers that are active during
- * this time.
+ * @property {string} [code] The response code.
+ * @property {string} [message] The message.
+ * @property {object} [data] The performance monitor counters.
+ * @property {string} [data.name] Unique key name of the counter.
+ * @property {date} [data.startTime] Start time of the period.
+ * @property {date} [data.endTime] End time of the period.
+ * @property {string} [data.timeGrain] Presented time grain.
+ * @property {array} [data.values] Collection of workers that are active
+ * during this time.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/perfMonSample.js b/lib/services/websiteManagement2/lib/models/perfMonSample.js
index e88148d9b9..97a30bd278 100644
--- a/lib/services/websiteManagement2/lib/models/perfMonSample.js
+++ b/lib/services/websiteManagement2/lib/models/perfMonSample.js
@@ -17,10 +17,10 @@
class PerfMonSample {
/**
* Create a PerfMonSample.
- * @member {date} [time] Point in time for which counter was measured.
- * @member {string} [instanceName] Name of the server on which the
+ * @property {date} [time] Point in time for which counter was measured.
+ * @property {string} [instanceName] Name of the server on which the
* measurement is made.
- * @member {number} [value] Value of counter at a certain time.
+ * @property {number} [value] Value of counter at a certain time.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/perfMonSet.js b/lib/services/websiteManagement2/lib/models/perfMonSet.js
index 28beb00fd0..cd89ea9a52 100644
--- a/lib/services/websiteManagement2/lib/models/perfMonSet.js
+++ b/lib/services/websiteManagement2/lib/models/perfMonSet.js
@@ -17,12 +17,12 @@
class PerfMonSet {
/**
* Create a PerfMonSet.
- * @member {string} [name] Unique key name of the counter.
- * @member {date} [startTime] Start time of the period.
- * @member {date} [endTime] End time of the period.
- * @member {string} [timeGrain] Presented time grain.
- * @member {array} [values] Collection of workers that are active during this
- * time.
+ * @property {string} [name] Unique key name of the counter.
+ * @property {date} [startTime] Start time of the period.
+ * @property {date} [endTime] End time of the period.
+ * @property {string} [timeGrain] Presented time grain.
+ * @property {array} [values] Collection of workers that are active during
+ * this time.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/premierAddOn.js b/lib/services/websiteManagement2/lib/models/premierAddOn.js
index c0db87d43b..9714d9b46f 100644
--- a/lib/services/websiteManagement2/lib/models/premierAddOn.js
+++ b/lib/services/websiteManagement2/lib/models/premierAddOn.js
@@ -20,12 +20,12 @@ const models = require('./index');
class PremierAddOn extends models['Resource'] {
/**
* Create a PremierAddOn.
- * @member {string} [sku] Premier add on SKU.
- * @member {string} [product] Premier add on Product.
- * @member {string} [vendor] Premier add on Vendor.
- * @member {string} [marketplacePublisher] Premier add on Marketplace
+ * @property {string} [sku] Premier add on SKU.
+ * @property {string} [product] Premier add on Product.
+ * @property {string} [vendor] Premier add on Vendor.
+ * @property {string} [marketplacePublisher] Premier add on Marketplace
* publisher.
- * @member {string} [marketplaceOffer] Premier add on Marketplace offer.
+ * @property {string} [marketplaceOffer] Premier add on Marketplace offer.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/premierAddOnOffer.js b/lib/services/websiteManagement2/lib/models/premierAddOnOffer.js
index 919328a6d8..c7aaf7c1dc 100644
--- a/lib/services/websiteManagement2/lib/models/premierAddOnOffer.js
+++ b/lib/services/websiteManagement2/lib/models/premierAddOnOffer.js
@@ -20,19 +20,19 @@ const models = require('./index');
class PremierAddOnOffer extends models['ProxyOnlyResource'] {
/**
* Create a PremierAddOnOffer.
- * @member {string} [sku] Premier add on SKU.
- * @member {string} [product] Premier add on offer Product.
- * @member {string} [vendor] Premier add on offer Vendor.
- * @member {boolean} [promoCodeRequired] true if promotion code
- * is required; otherwise, false.
- * @member {number} [quota] Premier add on offer Quota.
- * @member {string} [webHostingPlanRestrictions] App Service plans this offer
- * is restricted to. Possible values include: 'None', 'Free', 'Shared',
+ * @property {string} [sku] Premier add on SKU.
+ * @property {string} [product] Premier add on offer Product.
+ * @property {string} [vendor] Premier add on offer Vendor.
+ * @property {boolean} [promoCodeRequired] true if promotion
+ * code is required; otherwise, false.
+ * @property {number} [quota] Premier add on offer Quota.
+ * @property {string} [webHostingPlanRestrictions] App Service plans this
+ * offer is restricted to. Possible values include: 'None', 'Free', 'Shared',
* 'Basic', 'Standard', 'Premium'
- * @member {string} [privacyPolicyUrl] Privacy policy URL.
- * @member {string} [legalTermsUrl] Legal terms URL.
- * @member {string} [marketplacePublisher] Marketplace publisher.
- * @member {string} [marketplaceOffer] Marketplace offer.
+ * @property {string} [privacyPolicyUrl] Privacy policy URL.
+ * @property {string} [legalTermsUrl] Legal terms URL.
+ * @property {string} [marketplacePublisher] Marketplace publisher.
+ * @property {string} [marketplaceOffer] Marketplace offer.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/premierAddOnOfferCollection.js b/lib/services/websiteManagement2/lib/models/premierAddOnOfferCollection.js
index ceecaa63c2..2e803c2204 100644
--- a/lib/services/websiteManagement2/lib/models/premierAddOnOfferCollection.js
+++ b/lib/services/websiteManagement2/lib/models/premierAddOnOfferCollection.js
@@ -16,7 +16,7 @@
class PremierAddOnOfferCollection extends Array {
/**
* Create a PremierAddOnOfferCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/premierAddOnPatchResource.js b/lib/services/websiteManagement2/lib/models/premierAddOnPatchResource.js
index 9c9e00fe7f..02bbeb4fc3 100644
--- a/lib/services/websiteManagement2/lib/models/premierAddOnPatchResource.js
+++ b/lib/services/websiteManagement2/lib/models/premierAddOnPatchResource.js
@@ -20,12 +20,12 @@ const models = require('./index');
class PremierAddOnPatchResource extends models['ProxyOnlyResource'] {
/**
* Create a PremierAddOnPatchResource.
- * @member {string} [sku] Premier add on SKU.
- * @member {string} [product] Premier add on Product.
- * @member {string} [vendor] Premier add on Vendor.
- * @member {string} [marketplacePublisher] Premier add on Marketplace
+ * @property {string} [sku] Premier add on SKU.
+ * @property {string} [product] Premier add on Product.
+ * @property {string} [vendor] Premier add on Vendor.
+ * @property {string} [marketplacePublisher] Premier add on Marketplace
* publisher.
- * @member {string} [marketplaceOffer] Premier add on Marketplace offer.
+ * @property {string} [marketplaceOffer] Premier add on Marketplace offer.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/privateAccess.js b/lib/services/websiteManagement2/lib/models/privateAccess.js
index b85b137319..334242846b 100644
--- a/lib/services/websiteManagement2/lib/models/privateAccess.js
+++ b/lib/services/websiteManagement2/lib/models/privateAccess.js
@@ -20,8 +20,8 @@ const models = require('./index');
class PrivateAccess extends models['ProxyOnlyResource'] {
/**
* Create a PrivateAccess.
- * @member {boolean} [enabled] Whether private access is enabled or not.
- * @member {array} [virtualNetworks] The Virtual Networks (and subnets)
+ * @property {boolean} [enabled] Whether private access is enabled or not.
+ * @property {array} [virtualNetworks] The Virtual Networks (and subnets)
* allowed to access the site privately.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/privateAccessSubnet.js b/lib/services/websiteManagement2/lib/models/privateAccessSubnet.js
index 8390dc0093..cd556babaf 100644
--- a/lib/services/websiteManagement2/lib/models/privateAccessSubnet.js
+++ b/lib/services/websiteManagement2/lib/models/privateAccessSubnet.js
@@ -18,8 +18,8 @@
class PrivateAccessSubnet {
/**
* Create a PrivateAccessSubnet.
- * @member {string} [name] The name of the subnet.
- * @member {number} [key] The key (ID) of the subnet.
+ * @property {string} [name] The name of the subnet.
+ * @property {number} [key] The key (ID) of the subnet.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/privateAccessVirtualNetwork.js b/lib/services/websiteManagement2/lib/models/privateAccessVirtualNetwork.js
index d3b7f3161f..9a60a62996 100644
--- a/lib/services/websiteManagement2/lib/models/privateAccessVirtualNetwork.js
+++ b/lib/services/websiteManagement2/lib/models/privateAccessVirtualNetwork.js
@@ -17,10 +17,10 @@
class PrivateAccessVirtualNetwork {
/**
* Create a PrivateAccessVirtualNetwork.
- * @member {string} [name] The name of the Virtual Network.
- * @member {number} [key] The key (ID) of the Virtual Network.
- * @member {string} [resourceId] The ARM uri of the Virtual Network
- * @member {array} [subnets] A List of subnets that access is allowed to on
+ * @property {string} [name] The name of the Virtual Network.
+ * @property {number} [key] The key (ID) of the Virtual Network.
+ * @property {string} [resourceId] The ARM uri of the Virtual Network
+ * @property {array} [subnets] A List of subnets that access is allowed to on
* this Virtual Network. An empty array (but not null) is interpreted to mean
* that all subnets are allowed within this Virtual Network.
*/
diff --git a/lib/services/websiteManagement2/lib/models/processInfo.js b/lib/services/websiteManagement2/lib/models/processInfo.js
index 1fc4d90c98..3e2fb5623f 100644
--- a/lib/services/websiteManagement2/lib/models/processInfo.js
+++ b/lib/services/websiteManagement2/lib/models/processInfo.js
@@ -20,43 +20,43 @@ const models = require('./index');
class ProcessInfo extends models['ProxyOnlyResource'] {
/**
* Create a ProcessInfo.
- * @member {number} [identifier] ARM Identifier for deployment.
- * @member {string} [deploymentName] Deployment name.
- * @member {string} [href] HRef URI.
- * @member {string} [minidump] Minidump URI.
- * @member {boolean} [isProfileRunning] Is profile running?
- * @member {boolean} [isIisProfileRunning] Is the IIS Profile running?
- * @member {number} [iisProfileTimeoutInSeconds] IIS Profile timeout
+ * @property {number} [identifier] ARM Identifier for deployment.
+ * @property {string} [deploymentName] Deployment name.
+ * @property {string} [href] HRef URI.
+ * @property {string} [minidump] Minidump URI.
+ * @property {boolean} [isProfileRunning] Is profile running?
+ * @property {boolean} [isIisProfileRunning] Is the IIS Profile running?
+ * @property {number} [iisProfileTimeoutInSeconds] IIS Profile timeout
* (seconds).
- * @member {string} [parent] Parent process.
- * @member {array} [children] Child process list.
- * @member {array} [threads] Thread list.
- * @member {array} [openFileHandles] List of open files.
- * @member {array} [modules] List of modules.
- * @member {string} [fileName] File name of this process.
- * @member {string} [commandLine] Command line.
- * @member {string} [userName] User name.
- * @member {number} [handleCount] Handle count.
- * @member {number} [moduleCount] Module count.
- * @member {number} [threadCount] Thread count.
- * @member {date} [startTime] Start time.
- * @member {string} [totalCpuTime] Total CPU time.
- * @member {string} [userCpuTime] User CPU time.
- * @member {string} [privilegedCpuTime] Privileged CPU time.
- * @member {number} [workingSet] Working set.
- * @member {number} [peakWorkingSet] Peak working set.
- * @member {number} [privateMemory] Private memory size.
- * @member {number} [virtualMemory] Virtual memory size.
- * @member {number} [peakVirtualMemory] Peak virtual memory usage.
- * @member {number} [pagedSystemMemory] Paged system memory.
- * @member {number} [nonPagedSystemMemory] Non-paged system memory.
- * @member {number} [pagedMemory] Paged memory.
- * @member {number} [peakPagedMemory] Peak paged memory.
- * @member {date} [timeStamp] Time stamp.
- * @member {object} [environmentVariables] List of environment variables.
- * @member {boolean} [isScmSite] Is this the SCM site?
- * @member {boolean} [isWebjob] Is this a Web Job?
- * @member {string} [description] Description of process.
+ * @property {string} [parent] Parent process.
+ * @property {array} [children] Child process list.
+ * @property {array} [threads] Thread list.
+ * @property {array} [openFileHandles] List of open files.
+ * @property {array} [modules] List of modules.
+ * @property {string} [fileName] File name of this process.
+ * @property {string} [commandLine] Command line.
+ * @property {string} [userName] User name.
+ * @property {number} [handleCount] Handle count.
+ * @property {number} [moduleCount] Module count.
+ * @property {number} [threadCount] Thread count.
+ * @property {date} [startTime] Start time.
+ * @property {string} [totalCpuTime] Total CPU time.
+ * @property {string} [userCpuTime] User CPU time.
+ * @property {string} [privilegedCpuTime] Privileged CPU time.
+ * @property {number} [workingSet] Working set.
+ * @property {number} [peakWorkingSet] Peak working set.
+ * @property {number} [privateMemory] Private memory size.
+ * @property {number} [virtualMemory] Virtual memory size.
+ * @property {number} [peakVirtualMemory] Peak virtual memory usage.
+ * @property {number} [pagedSystemMemory] Paged system memory.
+ * @property {number} [nonPagedSystemMemory] Non-paged system memory.
+ * @property {number} [pagedMemory] Paged memory.
+ * @property {number} [peakPagedMemory] Peak paged memory.
+ * @property {date} [timeStamp] Time stamp.
+ * @property {object} [environmentVariables] List of environment variables.
+ * @property {boolean} [isScmSite] Is this the SCM site?
+ * @property {boolean} [isWebjob] Is this a Web Job?
+ * @property {string} [description] Description of process.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/processInfoCollection.js b/lib/services/websiteManagement2/lib/models/processInfoCollection.js
index 7ebd35ee09..c1f4fe387f 100644
--- a/lib/services/websiteManagement2/lib/models/processInfoCollection.js
+++ b/lib/services/websiteManagement2/lib/models/processInfoCollection.js
@@ -16,7 +16,7 @@
class ProcessInfoCollection extends Array {
/**
* Create a ProcessInfoCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/processModuleInfo.js b/lib/services/websiteManagement2/lib/models/processModuleInfo.js
index 610d4bf843..c72a105d22 100644
--- a/lib/services/websiteManagement2/lib/models/processModuleInfo.js
+++ b/lib/services/websiteManagement2/lib/models/processModuleInfo.js
@@ -20,18 +20,18 @@ const models = require('./index');
class ProcessModuleInfo extends models['ProxyOnlyResource'] {
/**
* Create a ProcessModuleInfo.
- * @member {string} [baseAddress] Base address. Used as module identifier in
- * ARM resource URI.
- * @member {string} [fileName] File name.
- * @member {string} [href] HRef URI.
- * @member {string} [filePath] File path.
- * @member {number} [moduleMemorySize] Module memory size.
- * @member {string} [fileVersion] File version.
- * @member {string} [fileDescription] File description.
- * @member {string} [product] Product name.
- * @member {string} [productVersion] Product version.
- * @member {boolean} [isDebug] Is debug?
- * @member {string} [language] Module language (locale).
+ * @property {string} [baseAddress] Base address. Used as module identifier
+ * in ARM resource URI.
+ * @property {string} [fileName] File name.
+ * @property {string} [href] HRef URI.
+ * @property {string} [filePath] File path.
+ * @property {number} [moduleMemorySize] Module memory size.
+ * @property {string} [fileVersion] File version.
+ * @property {string} [fileDescription] File description.
+ * @property {string} [product] Product name.
+ * @property {string} [productVersion] Product version.
+ * @property {boolean} [isDebug] Is debug?
+ * @property {string} [language] Module language (locale).
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/processModuleInfoCollection.js b/lib/services/websiteManagement2/lib/models/processModuleInfoCollection.js
index 3ce4dec596..bf8d0b4b0f 100644
--- a/lib/services/websiteManagement2/lib/models/processModuleInfoCollection.js
+++ b/lib/services/websiteManagement2/lib/models/processModuleInfoCollection.js
@@ -16,7 +16,7 @@
class ProcessModuleInfoCollection extends Array {
/**
* Create a ProcessModuleInfoCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/processThreadInfo.js b/lib/services/websiteManagement2/lib/models/processThreadInfo.js
index 3594604e66..e3be66b219 100644
--- a/lib/services/websiteManagement2/lib/models/processThreadInfo.js
+++ b/lib/services/websiteManagement2/lib/models/processThreadInfo.js
@@ -20,19 +20,19 @@ const models = require('./index');
class ProcessThreadInfo extends models['ProxyOnlyResource'] {
/**
* Create a ProcessThreadInfo.
- * @member {number} [identifier] Site extension ID.
- * @member {string} [href] HRef URI.
- * @member {string} [process] Process URI.
- * @member {string} [startAddress] Start address.
- * @member {number} [currentPriority] Current thread priority.
- * @member {string} [priorityLevel] Thread priority level.
- * @member {number} [basePriority] Base priority.
- * @member {date} [startTime] Start time.
- * @member {string} [totalProcessorTime] Total processor time.
- * @member {string} [userProcessorTime] User processor time.
- * @member {string} [priviledgedProcessorTime] Priviledged processor time.
- * @member {string} [state] Thread state.
- * @member {string} [waitReason] Wait reason.
+ * @property {number} [identifier] Site extension ID.
+ * @property {string} [href] HRef URI.
+ * @property {string} [process] Process URI.
+ * @property {string} [startAddress] Start address.
+ * @property {number} [currentPriority] Current thread priority.
+ * @property {string} [priorityLevel] Thread priority level.
+ * @property {number} [basePriority] Base priority.
+ * @property {date} [startTime] Start time.
+ * @property {string} [totalProcessorTime] Total processor time.
+ * @property {string} [userProcessorTime] User processor time.
+ * @property {string} [priviledgedProcessorTime] Priviledged processor time.
+ * @property {string} [state] Thread state.
+ * @property {string} [waitReason] Wait reason.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/processThreadInfoCollection.js b/lib/services/websiteManagement2/lib/models/processThreadInfoCollection.js
index 5b6c63e1c9..b2ad0ff5ad 100644
--- a/lib/services/websiteManagement2/lib/models/processThreadInfoCollection.js
+++ b/lib/services/websiteManagement2/lib/models/processThreadInfoCollection.js
@@ -16,7 +16,7 @@
class ProcessThreadInfoCollection extends Array {
/**
* Create a ProcessThreadInfoCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/proxyOnlyResource.js b/lib/services/websiteManagement2/lib/models/proxyOnlyResource.js
index ce25dbcdd7..7542712dbd 100644
--- a/lib/services/websiteManagement2/lib/models/proxyOnlyResource.js
+++ b/lib/services/websiteManagement2/lib/models/proxyOnlyResource.js
@@ -21,10 +21,10 @@ const models = require('./index');
class ProxyOnlyResource extends models['BaseResource'] {
/**
* Create a ProxyOnlyResource.
- * @member {string} [id] Resource Id.
- * @member {string} [name] Resource Name.
- * @member {string} [kind] Kind of resource.
- * @member {string} [type] Resource type.
+ * @property {string} [id] Resource Id.
+ * @property {string} [name] Resource Name.
+ * @property {string} [kind] Kind of resource.
+ * @property {string} [type] Resource type.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/publicCertificate.js b/lib/services/websiteManagement2/lib/models/publicCertificate.js
index 7d26d5e11a..8818ae45ad 100644
--- a/lib/services/websiteManagement2/lib/models/publicCertificate.js
+++ b/lib/services/websiteManagement2/lib/models/publicCertificate.js
@@ -20,10 +20,11 @@ const models = require('./index');
class PublicCertificate extends models['ProxyOnlyResource'] {
/**
* Create a PublicCertificate.
- * @member {buffer} [blob] Public Certificate byte array
- * @member {string} [publicCertificateLocation] Public Certificate Location.
- * Possible values include: 'CurrentUserMy', 'LocalMachineMy', 'Unknown'
- * @member {string} [thumbprint] Certificate Thumbprint
+ * @property {buffer} [blob] Public Certificate byte array
+ * @property {string} [publicCertificateLocation] Public Certificate
+ * Location. Possible values include: 'CurrentUserMy', 'LocalMachineMy',
+ * 'Unknown'
+ * @property {string} [thumbprint] Certificate Thumbprint
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/publicCertificateCollection.js b/lib/services/websiteManagement2/lib/models/publicCertificateCollection.js
index 39be88acc4..517fbb983c 100644
--- a/lib/services/websiteManagement2/lib/models/publicCertificateCollection.js
+++ b/lib/services/websiteManagement2/lib/models/publicCertificateCollection.js
@@ -16,7 +16,7 @@
class PublicCertificateCollection extends Array {
/**
* Create a PublicCertificateCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/pushSettings.js b/lib/services/websiteManagement2/lib/models/pushSettings.js
index 9c8bb1ec4e..f52cfa9f97 100644
--- a/lib/services/websiteManagement2/lib/models/pushSettings.js
+++ b/lib/services/websiteManagement2/lib/models/pushSettings.js
@@ -20,19 +20,19 @@ const models = require('./index');
class PushSettings extends models['ProxyOnlyResource'] {
/**
* Create a PushSettings.
- * @member {boolean} isPushEnabled Gets or sets a flag indicating whether the
- * Push endpoint is enabled.
- * @member {string} [tagWhitelistJson] Gets or sets a JSON string containing
- * a list of tags that are whitelisted for use by the push registration
- * endpoint.
- * @member {string} [tagsRequiringAuth] Gets or sets a JSON string containing
- * a list of tags that require user authentication to be used in the push
+ * @property {boolean} isPushEnabled Gets or sets a flag indicating whether
+ * the Push endpoint is enabled.
+ * @property {string} [tagWhitelistJson] Gets or sets a JSON string
+ * containing a list of tags that are whitelisted for use by the push
* registration endpoint.
+ * @property {string} [tagsRequiringAuth] Gets or sets a JSON string
+ * containing a list of tags that require user authentication to be used in
+ * the push registration endpoint.
* Tags can consist of alphanumeric characters and the following:
* '_', '@', '#', '.', ':', '-'.
* Validation should be performed at the PushRequestHandler.
- * @member {string} [dynamicTagsJson] Gets or sets a JSON string containing a
- * list of dynamic tags that will be evaluated from user claims in the push
+ * @property {string} [dynamicTagsJson] Gets or sets a JSON string containing
+ * a list of dynamic tags that will be evaluated from user claims in the push
* registration endpoint.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/rampUpRule.js b/lib/services/websiteManagement2/lib/models/rampUpRule.js
index 97701d5a8a..01eccffde3 100644
--- a/lib/services/websiteManagement2/lib/models/rampUpRule.js
+++ b/lib/services/websiteManagement2/lib/models/rampUpRule.js
@@ -18,28 +18,29 @@
class RampUpRule {
/**
* Create a RampUpRule.
- * @member {string} [actionHostName] Hostname of a slot to which the traffic
- * will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.
- * @member {number} [reroutePercentage] Percentage of the traffic which will
- * be redirected to ActionHostName.
- * @member {number} [changeStep] In auto ramp up scenario this is the step to
+ * @property {string} [actionHostName] Hostname of a slot to which the
+ * traffic will be redirected if decided to. E.g.
+ * myapp-stage.azurewebsites.net.
+ * @property {number} [reroutePercentage] Percentage of the traffic which
+ * will be redirected to ActionHostName.
+ * @property {number} [changeStep] In auto ramp up scenario this is the step
* to add/remove from ReroutePercentage until it reaches
* MinReroutePercentage or MaxReroutePercentage.
- * Site metrics are checked every N minutes specificed in
+ * Site metrics are checked every N minutes specified in
* ChangeIntervalInMinutes.
* Custom decision algorithm can be provided in TiPCallback site extension
* which URL can be specified in ChangeDecisionCallbackUrl.
- * @member {number} [changeIntervalInMinutes] Specifies interval in mimuntes
+ * @property {number} [changeIntervalInMinutes] Specifies interval in minutes
* to reevaluate ReroutePercentage.
- * @member {number} [minReroutePercentage] Specifies lower boundary above
+ * @property {number} [minReroutePercentage] Specifies lower boundary above
* which ReroutePercentage will stay.
- * @member {number} [maxReroutePercentage] Specifies upper boundary below
+ * @property {number} [maxReroutePercentage] Specifies upper boundary below
* which ReroutePercentage will stay.
- * @member {string} [changeDecisionCallbackUrl] Custom decision algorithm can
- * be provided in TiPCallback site extension which URL can be specified. See
- * TiPCallback site extension for the scaffold and contracts.
+ * @property {string} [changeDecisionCallbackUrl] Custom decision algorithm
+ * can be provided in TiPCallback site extension which URL can be specified.
+ * See TiPCallback site extension for the scaffold and contracts.
* https://www.siteextensions.net/packages/TiPCallback/
- * @member {string} [name] Name of the routing rule. The recommended name
+ * @property {string} [name] Name of the routing rule. The recommended name
* would be to point to the slot which will receive the traffic in the
* experiment.
*/
diff --git a/lib/services/websiteManagement2/lib/models/recommendation.js b/lib/services/websiteManagement2/lib/models/recommendation.js
index 8f61433673..991abd780c 100644
--- a/lib/services/websiteManagement2/lib/models/recommendation.js
+++ b/lib/services/websiteManagement2/lib/models/recommendation.js
@@ -20,48 +20,48 @@ const models = require('./index');
class Recommendation extends models['ProxyOnlyResource'] {
/**
* Create a Recommendation.
- * @member {date} [creationTime] Timestamp when this instance was created.
- * @member {uuid} [recommendationId] A GUID value that each recommendation
+ * @property {date} [creationTime] Timestamp when this instance was created.
+ * @property {uuid} [recommendationId] A GUID value that each recommendation
* object is associated with.
- * @member {string} [resourceId] Full ARM resource ID string that this
+ * @property {string} [resourceId] Full ARM resource ID string that this
* recommendation object is associated with.
- * @member {string} [resourceScope] Name of a resource type this
+ * @property {string} [resourceScope] Name of a resource type this
* recommendation applies, e.g. Subscription, ServerFarm, Site. Possible
* values include: 'ServerFarm', 'Subscription', 'WebSite'
- * @member {string} [ruleName] Unique name of the rule.
- * @member {string} [displayName] UI friendly name of the rule (may not be
+ * @property {string} [ruleName] Unique name of the rule.
+ * @property {string} [displayName] UI friendly name of the rule (may not be
* unique).
- * @member {string} [message] Recommendation text.
- * @member {string} [level] Level indicating how critical this recommendation
- * can impact. Possible values include: 'Critical', 'Warning', 'Information',
- * 'NonUrgentSuggestion'
- * @member {string} [channels] List of channels that this recommendation can
- * apply. Possible values include: 'Notification', 'Api', 'Email', 'Webhook',
- * 'All'
- * @member {array} [categoryTags] The list of category tags that this
+ * @property {string} [message] Recommendation text.
+ * @property {string} [level] Level indicating how critical this
+ * recommendation can impact. Possible values include: 'Critical', 'Warning',
+ * 'Information', 'NonUrgentSuggestion'
+ * @property {string} [channels] List of channels that this recommendation
+ * can apply. Possible values include: 'Notification', 'Api', 'Email',
+ * 'Webhook', 'All'
+ * @property {array} [categoryTags] The list of category tags that this
* recommendation belongs to.
- * @member {string} [actionName] Name of action recommended by this object.
- * @member {number} [enabled] True if this recommendation is still valid
+ * @property {string} [actionName] Name of action recommended by this object.
+ * @property {number} [enabled] True if this recommendation is still valid
* (i.e. "actionable"). False if it is invalid.
- * @member {array} [states] The list of states of this recommendation. If
+ * @property {array} [states] The list of states of this recommendation. If
* it's null then it shoud be considered "Active".
- * @member {date} [startTime] The beginning time in UTC of a range that the
+ * @property {date} [startTime] The beginning time in UTC of a range that the
* recommendation refers to.
- * @member {date} [endTime] The end time in UTC of a range that the
+ * @property {date} [endTime] The end time in UTC of a range that the
* recommendation refers to.
- * @member {date} [nextNotificationTime] When to notify this recommendation
+ * @property {date} [nextNotificationTime] When to notify this recommendation
* next in UTC. Null means that this will never be notified anymore.
- * @member {date} [notificationExpirationTime] Date and time in UTC when this
- * notification expires.
- * @member {date} [notifiedTime] Last timestamp in UTC this instance was
+ * @property {date} [notificationExpirationTime] Date and time in UTC when
+ * this notification expires.
+ * @property {date} [notifiedTime] Last timestamp in UTC this instance was
* actually notified. Null means that this recommendation hasn't been
* notified yet.
- * @member {number} [score] A metric value measured by the rule.
- * @member {boolean} [isDynamic] True if this is associated with a
+ * @property {number} [score] A metric value measured by the rule.
+ * @property {boolean} [isDynamic] True if this is associated with a
* dynamically added rule
- * @member {string} [extensionName] Extension name of the portal if exists.
- * @member {string} [bladeName] Deep link to a blade on the portal.
- * @member {string} [forwardLink] Forward link to an external document
+ * @property {string} [extensionName] Extension name of the portal if exists.
+ * @property {string} [bladeName] Deep link to a blade on the portal.
+ * @property {string} [forwardLink] Forward link to an external document
* associated with the rule.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/recommendationCollection.js b/lib/services/websiteManagement2/lib/models/recommendationCollection.js
index e85014b66e..5d8947e520 100644
--- a/lib/services/websiteManagement2/lib/models/recommendationCollection.js
+++ b/lib/services/websiteManagement2/lib/models/recommendationCollection.js
@@ -16,7 +16,7 @@
class RecommendationCollection extends Array {
/**
* Create a RecommendationCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/recommendationRule.js b/lib/services/websiteManagement2/lib/models/recommendationRule.js
index 98fedcaa74..6eac9a7475 100644
--- a/lib/services/websiteManagement2/lib/models/recommendationRule.js
+++ b/lib/services/websiteManagement2/lib/models/recommendationRule.js
@@ -20,30 +20,31 @@ const models = require('./index');
class RecommendationRule extends models['ProxyOnlyResource'] {
/**
* Create a RecommendationRule.
- * @member {string} [recommendationName] Unique name of the rule.
- * @member {string} [displayName] UI friendly name of the rule.
- * @member {string} [message] Localized name of the rule (Good for UI).
- * @member {uuid} [recommendationId] Recommendation ID of an associated
+ * @property {string} [recommendationName] Unique name of the rule.
+ * @property {string} [displayName] UI friendly name of the rule.
+ * @property {string} [message] Localized name of the rule (Good for UI).
+ * @property {uuid} [recommendationId] Recommendation ID of an associated
* recommendation object tied to the rule, if exists.
* If such an object doesn't exist, it is set to null.
- * @member {string} [description] Localized detailed description of the rule.
- * @member {string} [actionName] Name of action that is recommended by this
+ * @property {string} [description] Localized detailed description of the
+ * rule.
+ * @property {string} [actionName] Name of action that is recommended by this
* rule in string.
- * @member {string} [level] Level of impact indicating how critical this rule
- * is. Possible values include: 'Critical', 'Warning', 'Information',
+ * @property {string} [level] Level of impact indicating how critical this
+ * rule is. Possible values include: 'Critical', 'Warning', 'Information',
* 'NonUrgentSuggestion'
- * @member {string} [channels] List of available channels that this rule
+ * @property {string} [channels] List of available channels that this rule
* applies. Possible values include: 'Notification', 'Api', 'Email',
* 'Webhook', 'All'
- * @member {array} [categoryTags] The list of category tags that this
+ * @property {array} [categoryTags] The list of category tags that this
* recommendation rule belongs to.
- * @member {boolean} [isDynamic] True if this is associated with a
+ * @property {boolean} [isDynamic] True if this is associated with a
* dynamically added rule
- * @member {string} [extensionName] Extension name of the portal if exists.
+ * @property {string} [extensionName] Extension name of the portal if exists.
* Applicable to dynamic rule only.
- * @member {string} [bladeName] Deep link to a blade on the portal.
+ * @property {string} [bladeName] Deep link to a blade on the portal.
* Applicable to dynamic rule only.
- * @member {string} [forwardLink] Forward link to an external document
+ * @property {string} [forwardLink] Forward link to an external document
* associated with the rule. Applicable to dynamic rule only.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/reissueCertificateOrderRequest.js b/lib/services/websiteManagement2/lib/models/reissueCertificateOrderRequest.js
index b7a796250c..a737eb3142 100644
--- a/lib/services/websiteManagement2/lib/models/reissueCertificateOrderRequest.js
+++ b/lib/services/websiteManagement2/lib/models/reissueCertificateOrderRequest.js
@@ -20,11 +20,11 @@ const models = require('./index');
class ReissueCertificateOrderRequest extends models['ProxyOnlyResource'] {
/**
* Create a ReissueCertificateOrderRequest.
- * @member {number} [keySize] Certificate Key Size.
- * @member {number} [delayExistingRevokeInHours] Delay in hours to revoke
+ * @property {number} [keySize] Certificate Key Size.
+ * @property {number} [delayExistingRevokeInHours] Delay in hours to revoke
* existing certificate after the new certificate is issued.
- * @member {string} [csr] Csr to be used for re-key operation.
- * @member {boolean} [isPrivateKeyExternal] Should we change the ASC type
+ * @property {string} [csr] Csr to be used for re-key operation.
+ * @property {boolean} [isPrivateKeyExternal] Should we change the ASC type
* (from managed private key to external private key and vice versa).
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/relayServiceConnectionEntity.js b/lib/services/websiteManagement2/lib/models/relayServiceConnectionEntity.js
index c54c71585a..ab5ef5d08d 100644
--- a/lib/services/websiteManagement2/lib/models/relayServiceConnectionEntity.js
+++ b/lib/services/websiteManagement2/lib/models/relayServiceConnectionEntity.js
@@ -20,13 +20,13 @@ const models = require('./index');
class RelayServiceConnectionEntity extends models['ProxyOnlyResource'] {
/**
* Create a RelayServiceConnectionEntity.
- * @member {string} [entityName]
- * @member {string} [entityConnectionString]
- * @member {string} [resourceType]
- * @member {string} [resourceConnectionString]
- * @member {string} [hostname]
- * @member {number} [port]
- * @member {string} [biztalkUri]
+ * @property {string} [entityName]
+ * @property {string} [entityConnectionString]
+ * @property {string} [resourceType]
+ * @property {string} [resourceConnectionString]
+ * @property {string} [hostname]
+ * @property {number} [port]
+ * @property {string} [biztalkUri]
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/rendering.js b/lib/services/websiteManagement2/lib/models/rendering.js
index a2dd117840..314b80322c 100644
--- a/lib/services/websiteManagement2/lib/models/rendering.js
+++ b/lib/services/websiteManagement2/lib/models/rendering.js
@@ -17,10 +17,10 @@
class Rendering {
/**
* Create a Rendering.
- * @member {string} [type] Rendering Type. Possible values include:
+ * @property {string} [type] Rendering Type. Possible values include:
* 'NoGraph', 'Table', 'TimeSeries', 'TimeSeriesPerInstance'
- * @member {string} [title] Title of data
- * @member {string} [description] Description of the data that will help it
+ * @property {string} [title] Title of data
+ * @property {string} [description] Description of the data that will help it
* be interpreted
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/renewCertificateOrderRequest.js b/lib/services/websiteManagement2/lib/models/renewCertificateOrderRequest.js
index b72c6763f4..37961314be 100644
--- a/lib/services/websiteManagement2/lib/models/renewCertificateOrderRequest.js
+++ b/lib/services/websiteManagement2/lib/models/renewCertificateOrderRequest.js
@@ -20,9 +20,9 @@ const models = require('./index');
class RenewCertificateOrderRequest extends models['ProxyOnlyResource'] {
/**
* Create a RenewCertificateOrderRequest.
- * @member {number} [keySize] Certificate Key Size.
- * @member {string} [csr] Csr to be used for re-key operation.
- * @member {boolean} [isPrivateKeyExternal] Should we change the ASC type
+ * @property {number} [keySize] Certificate Key Size.
+ * @property {string} [csr] Csr to be used for re-key operation.
+ * @property {boolean} [isPrivateKeyExternal] Should we change the ASC type
* (from managed private key to external private key and vice versa).
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/requestsBasedTrigger.js b/lib/services/websiteManagement2/lib/models/requestsBasedTrigger.js
index 60c548d329..ccf177842a 100644
--- a/lib/services/websiteManagement2/lib/models/requestsBasedTrigger.js
+++ b/lib/services/websiteManagement2/lib/models/requestsBasedTrigger.js
@@ -17,8 +17,8 @@
class RequestsBasedTrigger {
/**
* Create a RequestsBasedTrigger.
- * @member {number} [count] Request Count.
- * @member {string} [timeInterval] Time interval.
+ * @property {number} [count] Request Count.
+ * @property {string} [timeInterval] Time interval.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/resource.js b/lib/services/websiteManagement2/lib/models/resource.js
index ee72e3156a..d40e917b51 100644
--- a/lib/services/websiteManagement2/lib/models/resource.js
+++ b/lib/services/websiteManagement2/lib/models/resource.js
@@ -20,12 +20,12 @@ const models = require('./index');
class Resource extends models['BaseResource'] {
/**
* Create a Resource.
- * @member {string} [id] Resource Id.
- * @member {string} [name] Resource Name.
- * @member {string} [kind] Kind of resource.
- * @member {string} location Resource Location.
- * @member {string} [type] Resource type.
- * @member {object} [tags] Resource tags.
+ * @property {string} [id] Resource Id.
+ * @property {string} [name] Resource Name.
+ * @property {string} [kind] Kind of resource.
+ * @property {string} location Resource Location.
+ * @property {string} [type] Resource type.
+ * @property {object} [tags] Resource tags.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/resourceCollection.js b/lib/services/websiteManagement2/lib/models/resourceCollection.js
index d49a0d8fec..af0269eac9 100644
--- a/lib/services/websiteManagement2/lib/models/resourceCollection.js
+++ b/lib/services/websiteManagement2/lib/models/resourceCollection.js
@@ -16,7 +16,7 @@
class ResourceCollection extends Array {
/**
* Create a ResourceCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/resourceHealthMetadata.js b/lib/services/websiteManagement2/lib/models/resourceHealthMetadata.js
index 7c8d1c457d..ac59490dac 100644
--- a/lib/services/websiteManagement2/lib/models/resourceHealthMetadata.js
+++ b/lib/services/websiteManagement2/lib/models/resourceHealthMetadata.js
@@ -20,9 +20,9 @@ const models = require('./index');
class ResourceHealthMetadata extends models['ProxyOnlyResource'] {
/**
* Create a ResourceHealthMetadata.
- * @member {string} [category] The category that the resource matches in the
- * RHC Policy File
- * @member {boolean} [signalAvailability] Is there a health signal for the
+ * @property {string} [category] The category that the resource matches in
+ * the RHC Policy File
+ * @property {boolean} [signalAvailability] Is there a health signal for the
* resource
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/resourceHealthMetadataCollection.js b/lib/services/websiteManagement2/lib/models/resourceHealthMetadataCollection.js
index b4be12e889..0bcd24034c 100644
--- a/lib/services/websiteManagement2/lib/models/resourceHealthMetadataCollection.js
+++ b/lib/services/websiteManagement2/lib/models/resourceHealthMetadataCollection.js
@@ -16,7 +16,7 @@
class ResourceHealthMetadataCollection extends Array {
/**
* Create a ResourceHealthMetadataCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/resourceMetric.js b/lib/services/websiteManagement2/lib/models/resourceMetric.js
index 5ae05578bc..5215a4c4e2 100644
--- a/lib/services/websiteManagement2/lib/models/resourceMetric.js
+++ b/lib/services/websiteManagement2/lib/models/resourceMetric.js
@@ -17,17 +17,17 @@
class ResourceMetric {
/**
* Create a ResourceMetric.
- * @member {object} [name] Name of metric.
- * @member {string} [name.value] metric name value.
- * @member {string} [name.localizedValue] Localized metric name value.
- * @member {string} [unit] Metric unit.
- * @member {string} [timeGrain] Metric granularity. E.g PT1H, PT5M, P1D
- * @member {date} [startTime] Metric start time.
- * @member {date} [endTime] Metric end time.
- * @member {string} [resourceId] Metric resource Id.
- * @member {string} [id] Resource Id.
- * @member {array} [metricValues] Metric values.
- * @member {array} [properties] Resource metric properties collection.
+ * @property {object} [name] Name of metric.
+ * @property {string} [name.value] metric name value.
+ * @property {string} [name.localizedValue] Localized metric name value.
+ * @property {string} [unit] Metric unit.
+ * @property {string} [timeGrain] Metric granularity. E.g PT1H, PT5M, P1D
+ * @property {date} [startTime] Metric start time.
+ * @property {date} [endTime] Metric end time.
+ * @property {string} [resourceId] Metric resource Id.
+ * @property {string} [id] Resource Id.
+ * @property {array} [metricValues] Metric values.
+ * @property {array} [properties] Resource metric properties collection.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/resourceMetricAvailability.js b/lib/services/websiteManagement2/lib/models/resourceMetricAvailability.js
index 477e5bb26c..3d599310e5 100644
--- a/lib/services/websiteManagement2/lib/models/resourceMetricAvailability.js
+++ b/lib/services/websiteManagement2/lib/models/resourceMetricAvailability.js
@@ -17,8 +17,9 @@
class ResourceMetricAvailability {
/**
* Create a ResourceMetricAvailability.
- * @member {string} [timeGrain] Time grain .
- * @member {string} [retention] Retention period for the current time grain.
+ * @property {string} [timeGrain] Time grain .
+ * @property {string} [retention] Retention period for the current time
+ * grain.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/resourceMetricCollection.js b/lib/services/websiteManagement2/lib/models/resourceMetricCollection.js
index 579749b9a4..a3a415bc60 100644
--- a/lib/services/websiteManagement2/lib/models/resourceMetricCollection.js
+++ b/lib/services/websiteManagement2/lib/models/resourceMetricCollection.js
@@ -16,7 +16,7 @@
class ResourceMetricCollection extends Array {
/**
* Create a ResourceMetricCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/resourceMetricDefinition.js b/lib/services/websiteManagement2/lib/models/resourceMetricDefinition.js
index 8dbe89e1bf..609ccba5bf 100644
--- a/lib/services/websiteManagement2/lib/models/resourceMetricDefinition.js
+++ b/lib/services/websiteManagement2/lib/models/resourceMetricDefinition.js
@@ -20,12 +20,12 @@ const models = require('./index');
class ResourceMetricDefinition extends models['ProxyOnlyResource'] {
/**
* Create a ResourceMetricDefinition.
- * @member {string} [unit] Unit of the metric.
- * @member {string} [primaryAggregationType] Primary aggregation type.
- * @member {array} [metricAvailabilities] List of time grains supported for
+ * @property {string} [unit] Unit of the metric.
+ * @property {string} [primaryAggregationType] Primary aggregation type.
+ * @property {array} [metricAvailabilities] List of time grains supported for
* the metric together with retention period.
- * @member {string} [resourceUri] Resource URI.
- * @member {object} [properties] Resource metric definition properties.
+ * @property {string} [resourceUri] Resource URI.
+ * @property {object} [properties] Resource metric definition properties.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/resourceMetricDefinitionCollection.js b/lib/services/websiteManagement2/lib/models/resourceMetricDefinitionCollection.js
index 5de7ff20bf..29bac36d4f 100644
--- a/lib/services/websiteManagement2/lib/models/resourceMetricDefinitionCollection.js
+++ b/lib/services/websiteManagement2/lib/models/resourceMetricDefinitionCollection.js
@@ -16,7 +16,7 @@
class ResourceMetricDefinitionCollection extends Array {
/**
* Create a ResourceMetricDefinitionCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/resourceMetricName.js b/lib/services/websiteManagement2/lib/models/resourceMetricName.js
index 8aea96ba4a..ef188975cc 100644
--- a/lib/services/websiteManagement2/lib/models/resourceMetricName.js
+++ b/lib/services/websiteManagement2/lib/models/resourceMetricName.js
@@ -17,8 +17,8 @@
class ResourceMetricName {
/**
* Create a ResourceMetricName.
- * @member {string} [value] metric name value.
- * @member {string} [localizedValue] Localized metric name value.
+ * @property {string} [value] metric name value.
+ * @property {string} [localizedValue] Localized metric name value.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/resourceMetricProperty.js b/lib/services/websiteManagement2/lib/models/resourceMetricProperty.js
index e1c189544b..a489fe7125 100644
--- a/lib/services/websiteManagement2/lib/models/resourceMetricProperty.js
+++ b/lib/services/websiteManagement2/lib/models/resourceMetricProperty.js
@@ -17,8 +17,8 @@
class ResourceMetricProperty {
/**
* Create a ResourceMetricProperty.
- * @member {string} [key] Key for resource metric property.
- * @member {string} [value] Value of pair.
+ * @property {string} [key] Key for resource metric property.
+ * @property {string} [value] Value of pair.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/resourceMetricValue.js b/lib/services/websiteManagement2/lib/models/resourceMetricValue.js
index 83e20dd398..2ab72a4a8e 100644
--- a/lib/services/websiteManagement2/lib/models/resourceMetricValue.js
+++ b/lib/services/websiteManagement2/lib/models/resourceMetricValue.js
@@ -17,13 +17,13 @@
class ResourceMetricValue {
/**
* Create a ResourceMetricValue.
- * @member {string} [timestamp] Value timestamp.
- * @member {number} [average] Value average.
- * @member {number} [minimum] Value minimum.
- * @member {number} [maximum] Value maximum.
- * @member {number} [total] Value total.
- * @member {number} [count] Value count.
- * @member {array} [properties] Resource metric properties collection.
+ * @property {string} [timestamp] Value timestamp.
+ * @property {number} [average] Value average.
+ * @property {number} [minimum] Value minimum.
+ * @property {number} [maximum] Value maximum.
+ * @property {number} [total] Value total.
+ * @property {number} [count] Value count.
+ * @property {array} [properties] Resource metric properties collection.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/resourceNameAvailability.js b/lib/services/websiteManagement2/lib/models/resourceNameAvailability.js
index a733bc7a1e..b03147f9a2 100644
--- a/lib/services/websiteManagement2/lib/models/resourceNameAvailability.js
+++ b/lib/services/websiteManagement2/lib/models/resourceNameAvailability.js
@@ -17,16 +17,16 @@
class ResourceNameAvailability {
/**
* Create a ResourceNameAvailability.
- * @member {boolean} [nameAvailable] true indicates name is
+ * @property {boolean} [nameAvailable] true indicates name is
* valid and available. false indicates the name is invalid,
* unavailable, or both.
- * @member {string} [reason] Invalid indicates the name provided
- * does not match Azure App Service naming requirements.
+ * @property {string} [reason] Invalid indicates the name
+ * provided does not match Azure App Service naming requirements.
* AlreadyExists indicates that the name is already in use and
* is therefore unavailable. Possible values include: 'Invalid',
* 'AlreadyExists'
- * @member {string} [message] If reason == invalid, provide the user with the
- * reason why the given name is invalid, and provide the resource naming
+ * @property {string} [message] If reason == invalid, provide the user with
+ * the reason why the given name is invalid, and provide the resource naming
* requirements so that the user can select a valid name. If reason ==
* AlreadyExists, explain that resource name is already in use, and direct
* them to select a different name.
diff --git a/lib/services/websiteManagement2/lib/models/resourceNameAvailabilityRequest.js b/lib/services/websiteManagement2/lib/models/resourceNameAvailabilityRequest.js
index fceb2c2a08..b9c1c11586 100644
--- a/lib/services/websiteManagement2/lib/models/resourceNameAvailabilityRequest.js
+++ b/lib/services/websiteManagement2/lib/models/resourceNameAvailabilityRequest.js
@@ -17,12 +17,12 @@
class ResourceNameAvailabilityRequest {
/**
* Create a ResourceNameAvailabilityRequest.
- * @member {string} name Resource name to verify.
- * @member {string} type Resource type used for verification. Possible values
- * include: 'Site', 'Slot', 'HostingEnvironment', 'PublishingUser',
+ * @property {string} name Resource name to verify.
+ * @property {string} type Resource type used for verification. Possible
+ * values include: 'Site', 'Slot', 'HostingEnvironment', 'PublishingUser',
* 'Microsoft.Web/sites', 'Microsoft.Web/sites/slots',
* 'Microsoft.Web/hostingEnvironments', 'Microsoft.Web/publishingUsers'
- * @member {boolean} [isFqdn] Is fully qualified domain name.
+ * @property {boolean} [isFqdn] Is fully qualified domain name.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/responseMetaData.js b/lib/services/websiteManagement2/lib/models/responseMetaData.js
index 9215d9bd53..bdfe259636 100644
--- a/lib/services/websiteManagement2/lib/models/responseMetaData.js
+++ b/lib/services/websiteManagement2/lib/models/responseMetaData.js
@@ -16,10 +16,10 @@
class ResponseMetaData {
/**
* Create a ResponseMetaData.
- * @member {object} [dataSource] Source of the Data
- * @member {array} [dataSource.instructions] Instrunctions if any for the
+ * @property {object} [dataSource] Source of the Data
+ * @property {array} [dataSource.instructions] Instrunctions if any for the
* data source
- * @member {array} [dataSource.dataSourceUri] Datasource Uri Links
+ * @property {array} [dataSource.dataSourceUri] Datasource Uri Links
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/restoreRequest.js b/lib/services/websiteManagement2/lib/models/restoreRequest.js
index 7ae8aa728c..06da86542c 100644
--- a/lib/services/websiteManagement2/lib/models/restoreRequest.js
+++ b/lib/services/websiteManagement2/lib/models/restoreRequest.js
@@ -20,31 +20,31 @@ const models = require('./index');
class RestoreRequest extends models['ProxyOnlyResource'] {
/**
* Create a RestoreRequest.
- * @member {string} storageAccountUrl SAS URL to the container.
- * @member {string} [blobName] Name of a blob which contains the backup.
- * @member {boolean} overwrite true if the restore operation can
- * overwrite target app; otherwise, false. true is
- * needed if trying to restore over an existing app.
- * @member {string} [siteName] Name of an app.
- * @member {array} [databases] Collection of databases which should be
+ * @property {string} storageAccountUrl SAS URL to the container.
+ * @property {string} [blobName] Name of a blob which contains the backup.
+ * @property {boolean} overwrite true if the restore operation
+ * can overwrite target app; otherwise, false. true
+ * is needed if trying to restore over an existing app.
+ * @property {string} [siteName] Name of an app.
+ * @property {array} [databases] Collection of databases which should be
* restored. This list has to match the list of databases included in the
* backup.
- * @member {boolean} [ignoreConflictingHostNames] Changes a logic when
+ * @property {boolean} [ignoreConflictingHostNames] Changes a logic when
* restoring an app with custom domains. true to remove custom
* domains automatically. If false, custom domains are added to
* the app's object when it is being restored, but that might fail due to
* conflicts during the operation. Default value: false .
- * @member {boolean} [ignoreDatabases] Ignore the databases and only restore
- * the site content. Default value: false .
- * @member {string} [appServicePlan] Specify app service plan that will own
+ * @property {boolean} [ignoreDatabases] Ignore the databases and only
+ * restore the site content. Default value: false .
+ * @property {string} [appServicePlan] Specify app service plan that will own
* restored site.
- * @member {string} [operationType] Operation type. Possible values include:
- * 'Default', 'Clone', 'Relocation', 'Snapshot', 'CloudFS'. Default value:
- * 'Default' .
- * @member {boolean} [adjustConnectionStrings] true if
+ * @property {string} [operationType] Operation type. Possible values
+ * include: 'Default', 'Clone', 'Relocation', 'Snapshot', 'CloudFS'. Default
+ * value: 'Default' .
+ * @property {boolean} [adjustConnectionStrings] true if
* SiteConfig.ConnectionStrings should be set in new app; otherwise,
* false.
- * @member {string} [hostingEnvironment] App Service Environment name, if
+ * @property {string} [hostingEnvironment] App Service Environment name, if
* needed (only when restoring an app to an App Service Environment).
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/serviceSpecification.js b/lib/services/websiteManagement2/lib/models/serviceSpecification.js
index 8473a1eaa6..c917940f2c 100644
--- a/lib/services/websiteManagement2/lib/models/serviceSpecification.js
+++ b/lib/services/websiteManagement2/lib/models/serviceSpecification.js
@@ -17,8 +17,8 @@
class ServiceSpecification {
/**
* Create a ServiceSpecification.
- * @member {array} [metricSpecifications]
- * @member {array} [logSpecifications]
+ * @property {array} [metricSpecifications]
+ * @property {array} [logSpecifications]
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/site.js b/lib/services/websiteManagement2/lib/models/site.js
index 10ef4cbd6d..5b15458642 100644
--- a/lib/services/websiteManagement2/lib/models/site.js
+++ b/lib/services/websiteManagement2/lib/models/site.js
@@ -20,282 +20,287 @@ const models = require('./index');
class Site extends models['Resource'] {
/**
* Create a Site.
- * @member {string} [state] Current state of the app.
- * @member {array} [hostNames] Hostnames associated with the app.
- * @member {string} [repositorySiteName] Name of the repository site.
- * @member {string} [usageState] State indicating whether the app has
+ * @property {string} [state] Current state of the app.
+ * @property {array} [hostNames] Hostnames associated with the app.
+ * @property {string} [repositorySiteName] Name of the repository site.
+ * @property {string} [usageState] State indicating whether the app has
* exceeded its quota usage. Read-only. Possible values include: 'Normal',
* 'Exceeded'
- * @member {boolean} [enabled] true if the app is enabled;
+ * @property {boolean} [enabled] true if the app is enabled;
* otherwise, false. Setting this value to false disables the
* app (takes the app offline).
- * @member {array} [enabledHostNames] Enabled hostnames for the app.Hostnames
- * need to be assigned (see HostNames) AND enabled. Otherwise,
+ * @property {array} [enabledHostNames] Enabled hostnames for the
+ * app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,
* the app is not served on those hostnames.
- * @member {string} [availabilityState] Management information availability
+ * @property {string} [availabilityState] Management information availability
* state for the app. Possible values include: 'Normal', 'Limited',
* 'DisasterRecoveryMode'
- * @member {array} [hostNameSslStates] Hostname SSL states are used to manage
- * the SSL bindings for app's hostnames.
- * @member {string} [serverFarmId] Resource ID of the associated App Service
- * plan, formatted as:
+ * @property {array} [hostNameSslStates] Hostname SSL states are used to
+ * manage the SSL bindings for app's hostnames.
+ * @property {string} [serverFarmId] Resource ID of the associated App
+ * Service plan, formatted as:
* "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
- * @member {boolean} [reserved] true if reserved; otherwise,
+ * @property {boolean} [reserved] true if reserved; otherwise,
* false. Default value: false .
- * @member {boolean} [isXenon] Obsolete: Hyper-V sandbox. Default value:
+ * @property {boolean} [isXenon] Obsolete: Hyper-V sandbox. Default value:
* false .
- * @member {boolean} [hyperV] Hyper-V sandbox. Default value: false .
- * @member {date} [lastModifiedTimeUtc] Last time the app was modified, in
+ * @property {boolean} [hyperV] Hyper-V sandbox. Default value: false .
+ * @property {date} [lastModifiedTimeUtc] Last time the app was modified, in
* UTC. Read-only.
- * @member {object} [siteConfig] Configuration of the app.
- * @member {number} [siteConfig.numberOfWorkers] Number of workers.
- * @member {array} [siteConfig.defaultDocuments] Default documents.
- * @member {string} [siteConfig.netFrameworkVersion] .NET Framework version.
- * @member {string} [siteConfig.phpVersion] Version of PHP.
- * @member {string} [siteConfig.pythonVersion] Version of Python.
- * @member {string} [siteConfig.nodeVersion] Version of Node.js.
- * @member {string} [siteConfig.linuxFxVersion] Linux App Framework and
+ * @property {object} [siteConfig] Configuration of the app.
+ * @property {number} [siteConfig.numberOfWorkers] Number of workers.
+ * @property {array} [siteConfig.defaultDocuments] Default documents.
+ * @property {string} [siteConfig.netFrameworkVersion] .NET Framework
+ * version.
+ * @property {string} [siteConfig.phpVersion] Version of PHP.
+ * @property {string} [siteConfig.pythonVersion] Version of Python.
+ * @property {string} [siteConfig.nodeVersion] Version of Node.js.
+ * @property {string} [siteConfig.linuxFxVersion] Linux App Framework and
* version
- * @member {string} [siteConfig.windowsFxVersion] Xenon App Framework and
+ * @property {string} [siteConfig.windowsFxVersion] Xenon App Framework and
* version
- * @member {boolean} [siteConfig.requestTracingEnabled] true if
- * request tracing is enabled; otherwise, false.
- * @member {date} [siteConfig.requestTracingExpirationTime] Request tracing
+ * @property {boolean} [siteConfig.requestTracingEnabled] true
+ * if request tracing is enabled; otherwise, false.
+ * @property {date} [siteConfig.requestTracingExpirationTime] Request tracing
* expiration time.
- * @member {boolean} [siteConfig.remoteDebuggingEnabled] true if
- * remote debugging is enabled; otherwise, false.
- * @member {string} [siteConfig.remoteDebuggingVersion] Remote debugging
+ * @property {boolean} [siteConfig.remoteDebuggingEnabled] true
+ * if remote debugging is enabled; otherwise, false.
+ * @property {string} [siteConfig.remoteDebuggingVersion] Remote debugging
* version.
- * @member {boolean} [siteConfig.httpLoggingEnabled] true if
+ * @property {boolean} [siteConfig.httpLoggingEnabled] true if
* HTTP logging is enabled; otherwise, false.
- * @member {number} [siteConfig.logsDirectorySizeLimit] HTTP logs directory
+ * @property {number} [siteConfig.logsDirectorySizeLimit] HTTP logs directory
* size limit.
- * @member {boolean} [siteConfig.detailedErrorLoggingEnabled]
+ * @property {boolean} [siteConfig.detailedErrorLoggingEnabled]
* true if detailed error logging is enabled; otherwise,
* false.
- * @member {string} [siteConfig.publishingUsername] Publishing user name.
- * @member {array} [siteConfig.appSettings] Application settings.
- * @member {object} [siteConfig.azureStorageAccounts] User-provided Azure
+ * @property {string} [siteConfig.publishingUsername] Publishing user name.
+ * @property {array} [siteConfig.appSettings] Application settings.
+ * @property {object} [siteConfig.azureStorageAccounts] User-provided Azure
* storage accounts.
- * @member {array} [siteConfig.connectionStrings] Connection strings.
- * @member {object} [siteConfig.machineKey] Site MachineKey.
- * @member {string} [siteConfig.machineKey.validation] MachineKey validation.
- * @member {string} [siteConfig.machineKey.validationKey] Validation key.
- * @member {string} [siteConfig.machineKey.decryption] Algorithm used for
+ * @property {array} [siteConfig.connectionStrings] Connection strings.
+ * @property {object} [siteConfig.machineKey] Site MachineKey.
+ * @property {string} [siteConfig.machineKey.validation] MachineKey
+ * validation.
+ * @property {string} [siteConfig.machineKey.validationKey] Validation key.
+ * @property {string} [siteConfig.machineKey.decryption] Algorithm used for
* decryption.
- * @member {string} [siteConfig.machineKey.decryptionKey] Decryption key.
- * @member {array} [siteConfig.handlerMappings] Handler mappings.
- * @member {string} [siteConfig.documentRoot] Document root.
- * @member {string} [siteConfig.scmType] SCM type. Possible values include:
+ * @property {string} [siteConfig.machineKey.decryptionKey] Decryption key.
+ * @property {array} [siteConfig.handlerMappings] Handler mappings.
+ * @property {string} [siteConfig.documentRoot] Document root.
+ * @property {string} [siteConfig.scmType] SCM type. Possible values include:
* 'None', 'Dropbox', 'Tfs', 'LocalGit', 'GitHub', 'CodePlexGit',
* 'CodePlexHg', 'BitbucketGit', 'BitbucketHg', 'ExternalGit', 'ExternalHg',
* 'OneDrive', 'VSO'
- * @member {boolean} [siteConfig.use32BitWorkerProcess] true to
- * use 32-bit worker process; otherwise, false.
- * @member {boolean} [siteConfig.webSocketsEnabled] true if
+ * @property {boolean} [siteConfig.use32BitWorkerProcess] true
+ * to use 32-bit worker process; otherwise, false.
+ * @property {boolean} [siteConfig.webSocketsEnabled] true if
* WebSocket is enabled; otherwise, false.
- * @member {boolean} [siteConfig.alwaysOn] true if Always On is
- * enabled; otherwise, false.
- * @member {string} [siteConfig.javaVersion] Java version.
- * @member {string} [siteConfig.javaContainer] Java container.
- * @member {string} [siteConfig.javaContainerVersion] Java container version.
- * @member {string} [siteConfig.appCommandLine] App command line to launch.
- * @member {string} [siteConfig.managedPipelineMode] Managed pipeline mode.
+ * @property {boolean} [siteConfig.alwaysOn] true if Always On
+ * is enabled; otherwise, false.
+ * @property {string} [siteConfig.javaVersion] Java version.
+ * @property {string} [siteConfig.javaContainer] Java container.
+ * @property {string} [siteConfig.javaContainerVersion] Java container
+ * version.
+ * @property {string} [siteConfig.appCommandLine] App command line to launch.
+ * @property {string} [siteConfig.managedPipelineMode] Managed pipeline mode.
* Possible values include: 'Integrated', 'Classic'
- * @member {array} [siteConfig.virtualApplications] Virtual applications.
- * @member {string} [siteConfig.loadBalancing] Site load balancing. Possible
- * values include: 'WeightedRoundRobin', 'LeastRequests',
+ * @property {array} [siteConfig.virtualApplications] Virtual applications.
+ * @property {string} [siteConfig.loadBalancing] Site load balancing.
+ * Possible values include: 'WeightedRoundRobin', 'LeastRequests',
* 'LeastResponseTime', 'WeightedTotalTraffic', 'RequestHash'
- * @member {object} [siteConfig.experiments] This is work around for
+ * @property {object} [siteConfig.experiments] This is work around for
* polymophic types.
- * @member {array} [siteConfig.experiments.rampUpRules] List of ramp-up
+ * @property {array} [siteConfig.experiments.rampUpRules] List of ramp-up
* rules.
- * @member {object} [siteConfig.limits] Site limits.
- * @member {number} [siteConfig.limits.maxPercentageCpu] Maximum allowed CPU
- * usage percentage.
- * @member {number} [siteConfig.limits.maxMemoryInMb] Maximum allowed memory
- * usage in MB.
- * @member {number} [siteConfig.limits.maxDiskSizeInMb] Maximum allowed disk
- * size usage in MB.
- * @member {boolean} [siteConfig.autoHealEnabled] true if Auto
+ * @property {object} [siteConfig.limits] Site limits.
+ * @property {number} [siteConfig.limits.maxPercentageCpu] Maximum allowed
+ * CPU usage percentage.
+ * @property {number} [siteConfig.limits.maxMemoryInMb] Maximum allowed
+ * memory usage in MB.
+ * @property {number} [siteConfig.limits.maxDiskSizeInMb] Maximum allowed
+ * disk size usage in MB.
+ * @property {boolean} [siteConfig.autoHealEnabled] true if Auto
* Heal is enabled; otherwise, false.
- * @member {object} [siteConfig.autoHealRules] Auto Heal rules.
- * @member {object} [siteConfig.autoHealRules.triggers] Conditions that
+ * @property {object} [siteConfig.autoHealRules] Auto Heal rules.
+ * @property {object} [siteConfig.autoHealRules.triggers] Conditions that
* describe when to execute the auto-heal actions.
- * @member {object} [siteConfig.autoHealRules.triggers.requests] A rule based
- * on total requests.
- * @member {number} [siteConfig.autoHealRules.triggers.requests.count]
+ * @property {object} [siteConfig.autoHealRules.triggers.requests] A rule
+ * based on total requests.
+ * @property {number} [siteConfig.autoHealRules.triggers.requests.count]
* Request Count.
- * @member {string} [siteConfig.autoHealRules.triggers.requests.timeInterval]
- * Time interval.
- * @member {number} [siteConfig.autoHealRules.triggers.privateBytesInKB] A
+ * @property {string}
+ * [siteConfig.autoHealRules.triggers.requests.timeInterval] Time interval.
+ * @property {number} [siteConfig.autoHealRules.triggers.privateBytesInKB] A
* rule based on private bytes.
- * @member {array} [siteConfig.autoHealRules.triggers.statusCodes] A rule
+ * @property {array} [siteConfig.autoHealRules.triggers.statusCodes] A rule
* based on status codes.
- * @member {object} [siteConfig.autoHealRules.triggers.slowRequests] A rule
+ * @property {object} [siteConfig.autoHealRules.triggers.slowRequests] A rule
* based on request execution time.
- * @member {string}
+ * @property {string}
* [siteConfig.autoHealRules.triggers.slowRequests.timeTaken] Time taken.
- * @member {number} [siteConfig.autoHealRules.triggers.slowRequests.count]
+ * @property {number} [siteConfig.autoHealRules.triggers.slowRequests.count]
* Request Count.
- * @member {string}
+ * @property {string}
* [siteConfig.autoHealRules.triggers.slowRequests.timeInterval] Time
* interval.
- * @member {object} [siteConfig.autoHealRules.actions] Actions to be executed
- * when a rule is triggered.
- * @member {string} [siteConfig.autoHealRules.actions.actionType] Predefined
- * action to be taken. Possible values include: 'Recycle', 'LogEvent',
- * 'CustomAction'
- * @member {object} [siteConfig.autoHealRules.actions.customAction] Custom
+ * @property {object} [siteConfig.autoHealRules.actions] Actions to be
+ * executed when a rule is triggered.
+ * @property {string} [siteConfig.autoHealRules.actions.actionType]
+ * Predefined action to be taken. Possible values include: 'Recycle',
+ * 'LogEvent', 'CustomAction'
+ * @property {object} [siteConfig.autoHealRules.actions.customAction] Custom
* action to be taken.
- * @member {string} [siteConfig.autoHealRules.actions.customAction.exe]
+ * @property {string} [siteConfig.autoHealRules.actions.customAction.exe]
* Executable to be run.
- * @member {string}
+ * @property {string}
* [siteConfig.autoHealRules.actions.customAction.parameters] Parameters for
* the executable.
- * @member {string}
+ * @property {string}
* [siteConfig.autoHealRules.actions.minProcessExecutionTime] Minimum time
* the process must execute
* before taking the action
- * @member {string} [siteConfig.tracingOptions] Tracing options.
- * @member {string} [siteConfig.vnetName] Virtual Network name.
- * @member {object} [siteConfig.cors] Cross-Origin Resource Sharing (CORS)
+ * @property {string} [siteConfig.tracingOptions] Tracing options.
+ * @property {string} [siteConfig.vnetName] Virtual Network name.
+ * @property {object} [siteConfig.cors] Cross-Origin Resource Sharing (CORS)
* settings.
- * @member {array} [siteConfig.cors.allowedOrigins] Gets or sets the list of
- * origins that should be allowed to make cross-origin
+ * @property {array} [siteConfig.cors.allowedOrigins] Gets or sets the list
+ * of origins that should be allowed to make cross-origin
* calls (for example: http://example.com:12345). Use "*" to allow all.
- * @member {object} [siteConfig.push] Push endpoint settings.
- * @member {boolean} [siteConfig.push.isPushEnabled] Gets or sets a flag
+ * @property {object} [siteConfig.push] Push endpoint settings.
+ * @property {boolean} [siteConfig.push.isPushEnabled] Gets or sets a flag
* indicating whether the Push endpoint is enabled.
- * @member {string} [siteConfig.push.tagWhitelistJson] Gets or sets a JSON
+ * @property {string} [siteConfig.push.tagWhitelistJson] Gets or sets a JSON
* string containing a list of tags that are whitelisted for use by the push
* registration endpoint.
- * @member {string} [siteConfig.push.tagsRequiringAuth] Gets or sets a JSON
+ * @property {string} [siteConfig.push.tagsRequiringAuth] Gets or sets a JSON
* string containing a list of tags that require user authentication to be
* used in the push registration endpoint.
* Tags can consist of alphanumeric characters and the following:
* '_', '@', '#', '.', ':', '-'.
* Validation should be performed at the PushRequestHandler.
- * @member {string} [siteConfig.push.dynamicTagsJson] Gets or sets a JSON
+ * @property {string} [siteConfig.push.dynamicTagsJson] Gets or sets a JSON
* string containing a list of dynamic tags that will be evaluated from user
* claims in the push registration endpoint.
- * @member {object} [siteConfig.apiDefinition] Information about the formal
+ * @property {object} [siteConfig.apiDefinition] Information about the formal
* API definition for the app.
- * @member {string} [siteConfig.apiDefinition.url] The URL of the API
+ * @property {string} [siteConfig.apiDefinition.url] The URL of the API
* definition.
- * @member {string} [siteConfig.autoSwapSlotName] Auto-swap slot name.
- * @member {boolean} [siteConfig.localMySqlEnabled] true to
+ * @property {string} [siteConfig.autoSwapSlotName] Auto-swap slot name.
+ * @property {boolean} [siteConfig.localMySqlEnabled] true to
* enable local MySQL; otherwise, false.
- * @member {number} [siteConfig.managedServiceIdentityId] Managed Service
+ * @property {number} [siteConfig.managedServiceIdentityId] Managed Service
* Identity Id
- * @member {number} [siteConfig.xManagedServiceIdentityId] Explicit Managed
+ * @property {number} [siteConfig.xManagedServiceIdentityId] Explicit Managed
* Service Identity Id
- * @member {array} [siteConfig.ipSecurityRestrictions] IP security
+ * @property {array} [siteConfig.ipSecurityRestrictions] IP security
* restrictions.
- * @member {boolean} [siteConfig.http20Enabled] Http20Enabled: configures a
+ * @property {boolean} [siteConfig.http20Enabled] Http20Enabled: configures a
* web site to allow clients to connect over http2.0
- * @member {string} [siteConfig.minTlsVersion] MinTlsVersion: configures the
- * minimum version of TLS required for SSL requests. Possible values include:
- * '1.0', '1.1', '1.2'
- * @member {string} [siteConfig.ftpsState] State of FTP / FTPS service.
+ * @property {string} [siteConfig.minTlsVersion] MinTlsVersion: configures
+ * the minimum version of TLS required for SSL requests. Possible values
+ * include: '1.0', '1.1', '1.2'
+ * @property {string} [siteConfig.ftpsState] State of FTP / FTPS service.
* Possible values include: 'AllAllowed', 'FtpsOnly', 'Disabled'
- * @member {number} [siteConfig.reservedInstanceCount] Number of reserved
+ * @property {number} [siteConfig.reservedInstanceCount] Number of reserved
* instances.
* This setting only applies to the Consumption Plan
- * @member {array} [trafficManagerHostNames] Azure Traffic Manager hostnames
- * associated with the app. Read-only.
- * @member {boolean} [scmSiteAlsoStopped] true to stop SCM
+ * @property {array} [trafficManagerHostNames] Azure Traffic Manager
+ * hostnames associated with the app. Read-only.
+ * @property {boolean} [scmSiteAlsoStopped] true to stop SCM
* (KUDU) site when the app is stopped; otherwise, false. The
* default is false. Default value: false .
- * @member {string} [targetSwapSlot] Specifies which deployment slot this app
- * will swap into. Read-only.
- * @member {object} [hostingEnvironmentProfile] App Service Environment to
+ * @property {string} [targetSwapSlot] Specifies which deployment slot this
+ * app will swap into. Read-only.
+ * @property {object} [hostingEnvironmentProfile] App Service Environment to
* use for the app.
- * @member {string} [hostingEnvironmentProfile.id] Resource ID of the App
+ * @property {string} [hostingEnvironmentProfile.id] Resource ID of the App
* Service Environment.
- * @member {string} [hostingEnvironmentProfile.name] Name of the App Service
- * Environment.
- * @member {string} [hostingEnvironmentProfile.type] Resource type of the App
+ * @property {string} [hostingEnvironmentProfile.name] Name of the App
* Service Environment.
- * @member {boolean} [clientAffinityEnabled] true to enable
+ * @property {string} [hostingEnvironmentProfile.type] Resource type of the
+ * App Service Environment.
+ * @property {boolean} [clientAffinityEnabled] true to enable
* client affinity; false to stop sending session affinity
* cookies, which route client requests in the same session to the same
* instance. Default is true.
- * @member {boolean} [clientCertEnabled] true to enable client
+ * @property {boolean} [clientCertEnabled] true to enable client
* certificate authentication (TLS mutual authentication); otherwise,
* false. Default is false.
- * @member {boolean} [hostNamesDisabled] true to disable the
+ * @property {boolean} [hostNamesDisabled] true to disable the
* public hostnames of the app; otherwise, false.
* If true, the app is only accessible via API management
* process.
- * @member {string} [outboundIpAddresses] List of IP addresses that the app
+ * @property {string} [outboundIpAddresses] List of IP addresses that the app
* uses for outbound connections (e.g. database access). Includes VIPs from
* tenants that site can be hosted with current settings. Read-only.
- * @member {string} [possibleOutboundIpAddresses] List of IP addresses that
+ * @property {string} [possibleOutboundIpAddresses] List of IP addresses that
* the app uses for outbound connections (e.g. database access). Includes
* VIPs from all tenants. Read-only.
- * @member {number} [containerSize] Size of the function container.
- * @member {number} [dailyMemoryTimeQuota] Maximum allowed daily memory-time
- * quota (applicable on dynamic apps only).
- * @member {date} [suspendedTill] App suspended till in case memory-time
+ * @property {number} [containerSize] Size of the function container.
+ * @property {number} [dailyMemoryTimeQuota] Maximum allowed daily
+ * memory-time quota (applicable on dynamic apps only).
+ * @property {date} [suspendedTill] App suspended till in case memory-time
* quota is exceeded.
- * @member {number} [maxNumberOfWorkers] Maximum number of workers.
+ * @property {number} [maxNumberOfWorkers] Maximum number of workers.
* This only applies to Functions container.
- * @member {object} [cloningInfo] If specified during app creation, the app
+ * @property {object} [cloningInfo] If specified during app creation, the app
* is cloned from a source app.
- * @member {uuid} [cloningInfo.correlationId] Correlation ID of cloning
+ * @property {uuid} [cloningInfo.correlationId] Correlation ID of cloning
* operation. This ID ties multiple cloning operations
* together to use the same snapshot.
- * @member {boolean} [cloningInfo.overwrite] true to overwrite
+ * @property {boolean} [cloningInfo.overwrite] true to overwrite
* destination app; otherwise, false.
- * @member {boolean} [cloningInfo.cloneCustomHostNames] true to
- * clone custom hostnames from source app; otherwise, false.
- * @member {boolean} [cloningInfo.cloneSourceControl] true to
+ * @property {boolean} [cloningInfo.cloneCustomHostNames] true
+ * to clone custom hostnames from source app; otherwise, false.
+ * @property {boolean} [cloningInfo.cloneSourceControl] true to
* clone source control from source app; otherwise, false.
- * @member {string} [cloningInfo.sourceWebAppId] ARM resource ID of the
+ * @property {string} [cloningInfo.sourceWebAppId] ARM resource ID of the
* source app. App resource ID is of the form
* /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}
* for production slots and
* /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName}
* for other slots.
- * @member {string} [cloningInfo.hostingEnvironment] App Service Environment.
- * @member {object} [cloningInfo.appSettingsOverrides] Application setting
+ * @property {string} [cloningInfo.hostingEnvironment] App Service
+ * Environment.
+ * @property {object} [cloningInfo.appSettingsOverrides] Application setting
* overrides for cloned app. If specified, these settings override the
* settings cloned
* from source app. Otherwise, application settings from source app are
* retained.
- * @member {boolean} [cloningInfo.configureLoadBalancing] true
+ * @property {boolean} [cloningInfo.configureLoadBalancing] true
* to configure load balancing for source and destination app.
- * @member {string} [cloningInfo.trafficManagerProfileId] ARM resource ID of
- * the Traffic Manager profile to use, if it exists. Traffic Manager resource
- * ID is of the form
+ * @property {string} [cloningInfo.trafficManagerProfileId] ARM resource ID
+ * of the Traffic Manager profile to use, if it exists. Traffic Manager
+ * resource ID is of the form
* /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.
- * @member {string} [cloningInfo.trafficManagerProfileName] Name of Traffic
+ * @property {string} [cloningInfo.trafficManagerProfileName] Name of Traffic
* Manager profile to create. This is only needed if Traffic Manager profile
* does not already exist.
- * @member {string} [resourceGroup] Name of the resource group the app
+ * @property {string} [resourceGroup] Name of the resource group the app
* belongs to. Read-only.
- * @member {boolean} [isDefaultContainer] true if the app is a
+ * @property {boolean} [isDefaultContainer] true if the app is a
* default container; otherwise, false.
- * @member {string} [defaultHostName] Default hostname of the app. Read-only.
- * @member {object} [slotSwapStatus] Status of the last deployment slot swap
- * operation.
- * @member {date} [slotSwapStatus.timestampUtc] The time the last successful
- * slot swap completed.
- * @member {string} [slotSwapStatus.sourceSlotName] The source slot of the
+ * @property {string} [defaultHostName] Default hostname of the app.
+ * Read-only.
+ * @property {object} [slotSwapStatus] Status of the last deployment slot
+ * swap operation.
+ * @property {date} [slotSwapStatus.timestampUtc] The time the last
+ * successful slot swap completed.
+ * @property {string} [slotSwapStatus.sourceSlotName] The source slot of the
* last swap operation.
- * @member {string} [slotSwapStatus.destinationSlotName] The destination slot
- * of the last swap operation.
- * @member {boolean} [httpsOnly] HttpsOnly: configures a web site to accept
+ * @property {string} [slotSwapStatus.destinationSlotName] The destination
+ * slot of the last swap operation.
+ * @property {boolean} [httpsOnly] HttpsOnly: configures a web site to accept
* only https requests. Issues redirect for
* http requests
- * @member {object} [identity]
- * @member {string} [identity.type] Type of managed service identity.
+ * @property {object} [identity]
+ * @property {string} [identity.type] Type of managed service identity.
* Possible values include: 'SystemAssigned', 'UserAssigned'
- * @member {string} [identity.tenantId] Tenant of managed service identity.
- * @member {string} [identity.principalId] Principal Id of managed service
+ * @property {string} [identity.tenantId] Tenant of managed service identity.
+ * @property {string} [identity.principalId] Principal Id of managed service
* identity.
- * @member {array} [identity.identityIds] Array of UserAssigned managed
+ * @property {array} [identity.identityIds] Array of UserAssigned managed
* service identities.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/siteAuthSettings.js b/lib/services/websiteManagement2/lib/models/siteAuthSettings.js
index f35b25393d..40c3303dad 100644
--- a/lib/services/websiteManagement2/lib/models/siteAuthSettings.js
+++ b/lib/services/websiteManagement2/lib/models/siteAuthSettings.js
@@ -21,44 +21,44 @@ const models = require('./index');
class SiteAuthSettings extends models['ProxyOnlyResource'] {
/**
* Create a SiteAuthSettings.
- * @member {boolean} [enabled] true if the Authentication /
+ * @property {boolean} [enabled] true if the Authentication /
* Authorization feature is enabled for the current app; otherwise,
* false.
- * @member {string} [runtimeVersion] The RuntimeVersion of the Authentication
- * / Authorization feature in use for the current app.
+ * @property {string} [runtimeVersion] The RuntimeVersion of the
+ * Authentication / Authorization feature in use for the current app.
* The setting in this value can control the behavior of certain features in
* the Authentication / Authorization module.
- * @member {string} [unauthenticatedClientAction] The action to take when an
- * unauthenticated client attempts to access the app. Possible values
+ * @property {string} [unauthenticatedClientAction] The action to take when
+ * an unauthenticated client attempts to access the app. Possible values
* include: 'RedirectToLoginPage', 'AllowAnonymous'
- * @member {boolean} [tokenStoreEnabled] true to durably store
+ * @property {boolean} [tokenStoreEnabled] true to durably store
* platform-specific security tokens that are obtained during login flows;
* otherwise, false.
* The default is false.
- * @member {array} [allowedExternalRedirectUrls] External URLs that can be
+ * @property {array} [allowedExternalRedirectUrls] External URLs that can be
* redirected to as part of logging in or logging out of the app. Note that
* the query string part of the URL is ignored.
* This is an advanced setting typically only needed by Windows Store
* application backends.
* Note that URLs within the current domain are always implicitly allowed.
- * @member {string} [defaultProvider] The default authentication provider to
- * use when multiple providers are configured.
+ * @property {string} [defaultProvider] The default authentication provider
+ * to use when multiple providers are configured.
* This setting is only needed if multiple providers are configured and the
* unauthenticated client
* action is set to "RedirectToLoginPage". Possible values include:
* 'AzureActiveDirectory', 'Facebook', 'Google', 'MicrosoftAccount',
* 'Twitter'
- * @member {number} [tokenRefreshExtensionHours] The number of hours after
+ * @property {number} [tokenRefreshExtensionHours] The number of hours after
* session token expiration that a session token can be used to
* call the token refresh API. The default is 72 hours.
- * @member {string} [clientId] The Client ID of this relying party
+ * @property {string} [clientId] The Client ID of this relying party
* application, known as the client_id.
* This setting is required for enabling OpenID Connection authentication
* with Azure Active Directory or
* other 3rd party OpenID Connect providers.
* More information on OpenID Connect:
* http://openid.net/specs/openid-connect-core-1_0.html
- * @member {string} [clientSecret] The Client Secret of this relying party
+ * @property {string} [clientSecret] The Client Secret of this relying party
* application (in Azure Active Directory, this is also referred to as the
* Key).
* This setting is optional. If no client secret is configured, the OpenID
@@ -67,73 +67,73 @@ class SiteAuthSettings extends models['ProxyOnlyResource'] {
* authenticate end users.
* More information on OpenID Connect:
* http://openid.net/specs/openid-connect-core-1_0.html
- * @member {string} [issuer] The OpenID Connect Issuer URI that represents
+ * @property {string} [issuer] The OpenID Connect Issuer URI that represents
* the entity which issues access tokens for this application.
* When using Azure Active Directory, this value is the URI of the directory
* tenant, e.g. https://sts.windows.net/{tenant-guid}/.
* This URI is a case-sensitive identifier for the token issuer.
* More information on OpenID Connect Discovery:
* http://openid.net/specs/openid-connect-discovery-1_0.html
- * @member {boolean} [validateIssuer] Gets a value indicating whether the
+ * @property {boolean} [validateIssuer] Gets a value indicating whether the
* issuer should be a valid HTTPS url and be validated as such.
- * @member {array} [allowedAudiences] Allowed audience values to consider
+ * @property {array} [allowedAudiences] Allowed audience values to consider
* when validating JWTs issued by
* Azure Active Directory. Note that the ClientID value is
* always considered an
* allowed audience, regardless of this setting.
- * @member {array} [additionalLoginParams] Login parameters to send to the
+ * @property {array} [additionalLoginParams] Login parameters to send to the
* OpenID Connect authorization endpoint when
* a user logs in. Each parameter must be in the form "key=value".
- * @member {string} [googleClientId] The OpenID Connect Client ID for the
+ * @property {string} [googleClientId] The OpenID Connect Client ID for the
* Google web application.
* This setting is required for enabling Google Sign-In.
* Google Sign-In documentation:
* https://developers.google.com/identity/sign-in/web/
- * @member {string} [googleClientSecret] The client secret associated with
+ * @property {string} [googleClientSecret] The client secret associated with
* the Google web application.
* This setting is required for enabling Google Sign-In.
* Google Sign-In documentation:
* https://developers.google.com/identity/sign-in/web/
- * @member {array} [googleOAuthScopes] The OAuth 2.0 scopes that will be
+ * @property {array} [googleOAuthScopes] The OAuth 2.0 scopes that will be
* requested as part of Google Sign-In authentication.
* This setting is optional. If not specified, "openid", "profile", and
* "email" are used as default scopes.
* Google Sign-In documentation:
* https://developers.google.com/identity/sign-in/web/
- * @member {string} [facebookAppId] The App ID of the Facebook app used for
+ * @property {string} [facebookAppId] The App ID of the Facebook app used for
* login.
* This setting is required for enabling Facebook Login.
* Facebook Login documentation:
* https://developers.facebook.com/docs/facebook-login
- * @member {string} [facebookAppSecret] The App Secret of the Facebook app
+ * @property {string} [facebookAppSecret] The App Secret of the Facebook app
* used for Facebook Login.
* This setting is required for enabling Facebook Login.
* Facebook Login documentation:
* https://developers.facebook.com/docs/facebook-login
- * @member {array} [facebookOAuthScopes] The OAuth 2.0 scopes that will be
+ * @property {array} [facebookOAuthScopes] The OAuth 2.0 scopes that will be
* requested as part of Facebook Login authentication.
* This setting is optional.
* Facebook Login documentation:
* https://developers.facebook.com/docs/facebook-login
- * @member {string} [twitterConsumerKey] The OAuth 1.0a consumer key of the
+ * @property {string} [twitterConsumerKey] The OAuth 1.0a consumer key of the
* Twitter application used for sign-in.
* This setting is required for enabling Twitter Sign-In.
* Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
- * @member {string} [twitterConsumerSecret] The OAuth 1.0a consumer secret of
- * the Twitter application used for sign-in.
+ * @property {string} [twitterConsumerSecret] The OAuth 1.0a consumer secret
+ * of the Twitter application used for sign-in.
* This setting is required for enabling Twitter Sign-In.
* Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
- * @member {string} [microsoftAccountClientId] The OAuth 2.0 client ID that
+ * @property {string} [microsoftAccountClientId] The OAuth 2.0 client ID that
* was created for the app used for authentication.
* This setting is required for enabling Microsoft Account authentication.
* Microsoft Account OAuth documentation:
* https://dev.onedrive.com/auth/msa_oauth.htm
- * @member {string} [microsoftAccountClientSecret] The OAuth 2.0 client
+ * @property {string} [microsoftAccountClientSecret] The OAuth 2.0 client
* secret that was created for the app used for authentication.
* This setting is required for enabling Microsoft Account authentication.
* Microsoft Account OAuth documentation:
* https://dev.onedrive.com/auth/msa_oauth.htm
- * @member {array} [microsoftAccountOAuthScopes] The OAuth 2.0 scopes that
+ * @property {array} [microsoftAccountOAuthScopes] The OAuth 2.0 scopes that
* will be requested as part of Microsoft Account authentication.
* This setting is optional. If not specified, "wl.basic" is used as the
* default scope.
diff --git a/lib/services/websiteManagement2/lib/models/siteCloneability.js b/lib/services/websiteManagement2/lib/models/siteCloneability.js
index e006a4d2b2..d14060610c 100644
--- a/lib/services/websiteManagement2/lib/models/siteCloneability.js
+++ b/lib/services/websiteManagement2/lib/models/siteCloneability.js
@@ -17,14 +17,14 @@
class SiteCloneability {
/**
* Create a SiteCloneability.
- * @member {string} [result] Name of app. Possible values include:
+ * @property {string} [result] Name of app. Possible values include:
* 'Cloneable', 'PartiallyCloneable', 'NotCloneable'
- * @member {array} [blockingFeatures] List of features enabled on app that
+ * @property {array} [blockingFeatures] List of features enabled on app that
* prevent cloning.
- * @member {array} [unsupportedFeatures] List of features enabled on app that
- * are non-blocking but cannot be cloned. The app can still be cloned
+ * @property {array} [unsupportedFeatures] List of features enabled on app
+ * that are non-blocking but cannot be cloned. The app can still be cloned
* but the features in this list will not be set up on cloned app.
- * @member {array} [blockingCharacteristics] List of blocking application
+ * @property {array} [blockingCharacteristics] List of blocking application
* characteristics.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/siteCloneabilityCriterion.js b/lib/services/websiteManagement2/lib/models/siteCloneabilityCriterion.js
index 7d5d208e54..16851c8297 100644
--- a/lib/services/websiteManagement2/lib/models/siteCloneabilityCriterion.js
+++ b/lib/services/websiteManagement2/lib/models/siteCloneabilityCriterion.js
@@ -17,8 +17,8 @@
class SiteCloneabilityCriterion {
/**
* Create a SiteCloneabilityCriterion.
- * @member {string} [name] Name of criterion.
- * @member {string} [description] Description of criterion.
+ * @property {string} [name] Name of criterion.
+ * @property {string} [description] Description of criterion.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/siteConfig.js b/lib/services/websiteManagement2/lib/models/siteConfig.js
index 5715d374ae..4f6e3cdd69 100644
--- a/lib/services/websiteManagement2/lib/models/siteConfig.js
+++ b/lib/services/websiteManagement2/lib/models/siteConfig.js
@@ -17,142 +17,143 @@
class SiteConfig {
/**
* Create a SiteConfig.
- * @member {number} [numberOfWorkers] Number of workers.
- * @member {array} [defaultDocuments] Default documents.
- * @member {string} [netFrameworkVersion] .NET Framework version. Default
+ * @property {number} [numberOfWorkers] Number of workers.
+ * @property {array} [defaultDocuments] Default documents.
+ * @property {string} [netFrameworkVersion] .NET Framework version. Default
* value: 'v4.6' .
- * @member {string} [phpVersion] Version of PHP.
- * @member {string} [pythonVersion] Version of Python.
- * @member {string} [nodeVersion] Version of Node.js.
- * @member {string} [linuxFxVersion] Linux App Framework and version
- * @member {string} [windowsFxVersion] Xenon App Framework and version
- * @member {boolean} [requestTracingEnabled] true if request
+ * @property {string} [phpVersion] Version of PHP.
+ * @property {string} [pythonVersion] Version of Python.
+ * @property {string} [nodeVersion] Version of Node.js.
+ * @property {string} [linuxFxVersion] Linux App Framework and version
+ * @property {string} [windowsFxVersion] Xenon App Framework and version
+ * @property {boolean} [requestTracingEnabled] true if request
* tracing is enabled; otherwise, false.
- * @member {date} [requestTracingExpirationTime] Request tracing expiration
+ * @property {date} [requestTracingExpirationTime] Request tracing expiration
* time.
- * @member {boolean} [remoteDebuggingEnabled] true if remote
+ * @property {boolean} [remoteDebuggingEnabled] true if remote
* debugging is enabled; otherwise, false.
- * @member {string} [remoteDebuggingVersion] Remote debugging version.
- * @member {boolean} [httpLoggingEnabled] true if HTTP logging
+ * @property {string} [remoteDebuggingVersion] Remote debugging version.
+ * @property {boolean} [httpLoggingEnabled] true if HTTP logging
* is enabled; otherwise, false.
- * @member {number} [logsDirectorySizeLimit] HTTP logs directory size limit.
- * @member {boolean} [detailedErrorLoggingEnabled] true if
+ * @property {number} [logsDirectorySizeLimit] HTTP logs directory size
+ * limit.
+ * @property {boolean} [detailedErrorLoggingEnabled] true if
* detailed error logging is enabled; otherwise, false.
- * @member {string} [publishingUsername] Publishing user name.
- * @member {array} [appSettings] Application settings.
- * @member {object} [azureStorageAccounts] User-provided Azure storage
+ * @property {string} [publishingUsername] Publishing user name.
+ * @property {array} [appSettings] Application settings.
+ * @property {object} [azureStorageAccounts] User-provided Azure storage
* accounts.
- * @member {array} [connectionStrings] Connection strings.
- * @member {object} [machineKey] Site MachineKey.
- * @member {string} [machineKey.validation] MachineKey validation.
- * @member {string} [machineKey.validationKey] Validation key.
- * @member {string} [machineKey.decryption] Algorithm used for decryption.
- * @member {string} [machineKey.decryptionKey] Decryption key.
- * @member {array} [handlerMappings] Handler mappings.
- * @member {string} [documentRoot] Document root.
- * @member {string} [scmType] SCM type. Possible values include: 'None',
+ * @property {array} [connectionStrings] Connection strings.
+ * @property {object} [machineKey] Site MachineKey.
+ * @property {string} [machineKey.validation] MachineKey validation.
+ * @property {string} [machineKey.validationKey] Validation key.
+ * @property {string} [machineKey.decryption] Algorithm used for decryption.
+ * @property {string} [machineKey.decryptionKey] Decryption key.
+ * @property {array} [handlerMappings] Handler mappings.
+ * @property {string} [documentRoot] Document root.
+ * @property {string} [scmType] SCM type. Possible values include: 'None',
* 'Dropbox', 'Tfs', 'LocalGit', 'GitHub', 'CodePlexGit', 'CodePlexHg',
* 'BitbucketGit', 'BitbucketHg', 'ExternalGit', 'ExternalHg', 'OneDrive',
* 'VSO'
- * @member {boolean} [use32BitWorkerProcess] true to use 32-bit
- * worker process; otherwise, false.
- * @member {boolean} [webSocketsEnabled] true if WebSocket is
+ * @property {boolean} [use32BitWorkerProcess] true to use
+ * 32-bit worker process; otherwise, false.
+ * @property {boolean} [webSocketsEnabled] true if WebSocket is
* enabled; otherwise, false.
- * @member {boolean} [alwaysOn] true if Always On is enabled;
+ * @property {boolean} [alwaysOn] true if Always On is enabled;
* otherwise, false.
- * @member {string} [javaVersion] Java version.
- * @member {string} [javaContainer] Java container.
- * @member {string} [javaContainerVersion] Java container version.
- * @member {string} [appCommandLine] App command line to launch.
- * @member {string} [managedPipelineMode] Managed pipeline mode. Possible
+ * @property {string} [javaVersion] Java version.
+ * @property {string} [javaContainer] Java container.
+ * @property {string} [javaContainerVersion] Java container version.
+ * @property {string} [appCommandLine] App command line to launch.
+ * @property {string} [managedPipelineMode] Managed pipeline mode. Possible
* values include: 'Integrated', 'Classic'
- * @member {array} [virtualApplications] Virtual applications.
- * @member {string} [loadBalancing] Site load balancing. Possible values
+ * @property {array} [virtualApplications] Virtual applications.
+ * @property {string} [loadBalancing] Site load balancing. Possible values
* include: 'WeightedRoundRobin', 'LeastRequests', 'LeastResponseTime',
* 'WeightedTotalTraffic', 'RequestHash'
- * @member {object} [experiments] This is work around for polymophic types.
- * @member {array} [experiments.rampUpRules] List of ramp-up rules.
- * @member {object} [limits] Site limits.
- * @member {number} [limits.maxPercentageCpu] Maximum allowed CPU usage
+ * @property {object} [experiments] This is work around for polymophic types.
+ * @property {array} [experiments.rampUpRules] List of ramp-up rules.
+ * @property {object} [limits] Site limits.
+ * @property {number} [limits.maxPercentageCpu] Maximum allowed CPU usage
* percentage.
- * @member {number} [limits.maxMemoryInMb] Maximum allowed memory usage in
+ * @property {number} [limits.maxMemoryInMb] Maximum allowed memory usage in
* MB.
- * @member {number} [limits.maxDiskSizeInMb] Maximum allowed disk size usage
- * in MB.
- * @member {boolean} [autoHealEnabled] true if Auto Heal is
+ * @property {number} [limits.maxDiskSizeInMb] Maximum allowed disk size
+ * usage in MB.
+ * @property {boolean} [autoHealEnabled] true if Auto Heal is
* enabled; otherwise, false.
- * @member {object} [autoHealRules] Auto Heal rules.
- * @member {object} [autoHealRules.triggers] Conditions that describe when to
- * execute the auto-heal actions.
- * @member {object} [autoHealRules.triggers.requests] A rule based on total
+ * @property {object} [autoHealRules] Auto Heal rules.
+ * @property {object} [autoHealRules.triggers] Conditions that describe when
+ * to execute the auto-heal actions.
+ * @property {object} [autoHealRules.triggers.requests] A rule based on total
* requests.
- * @member {number} [autoHealRules.triggers.requests.count] Request Count.
- * @member {string} [autoHealRules.triggers.requests.timeInterval] Time
+ * @property {number} [autoHealRules.triggers.requests.count] Request Count.
+ * @property {string} [autoHealRules.triggers.requests.timeInterval] Time
* interval.
- * @member {number} [autoHealRules.triggers.privateBytesInKB] A rule based on
- * private bytes.
- * @member {array} [autoHealRules.triggers.statusCodes] A rule based on
+ * @property {number} [autoHealRules.triggers.privateBytesInKB] A rule based
+ * on private bytes.
+ * @property {array} [autoHealRules.triggers.statusCodes] A rule based on
* status codes.
- * @member {object} [autoHealRules.triggers.slowRequests] A rule based on
+ * @property {object} [autoHealRules.triggers.slowRequests] A rule based on
* request execution time.
- * @member {string} [autoHealRules.triggers.slowRequests.timeTaken] Time
+ * @property {string} [autoHealRules.triggers.slowRequests.timeTaken] Time
* taken.
- * @member {number} [autoHealRules.triggers.slowRequests.count] Request
+ * @property {number} [autoHealRules.triggers.slowRequests.count] Request
* Count.
- * @member {string} [autoHealRules.triggers.slowRequests.timeInterval] Time
+ * @property {string} [autoHealRules.triggers.slowRequests.timeInterval] Time
* interval.
- * @member {object} [autoHealRules.actions] Actions to be executed when a
+ * @property {object} [autoHealRules.actions] Actions to be executed when a
* rule is triggered.
- * @member {string} [autoHealRules.actions.actionType] Predefined action to
+ * @property {string} [autoHealRules.actions.actionType] Predefined action to
* be taken. Possible values include: 'Recycle', 'LogEvent', 'CustomAction'
- * @member {object} [autoHealRules.actions.customAction] Custom action to be
- * taken.
- * @member {string} [autoHealRules.actions.customAction.exe] Executable to be
- * run.
- * @member {string} [autoHealRules.actions.customAction.parameters]
+ * @property {object} [autoHealRules.actions.customAction] Custom action to
+ * be taken.
+ * @property {string} [autoHealRules.actions.customAction.exe] Executable to
+ * be run.
+ * @property {string} [autoHealRules.actions.customAction.parameters]
* Parameters for the executable.
- * @member {string} [autoHealRules.actions.minProcessExecutionTime] Minimum
+ * @property {string} [autoHealRules.actions.minProcessExecutionTime] Minimum
* time the process must execute
* before taking the action
- * @member {string} [tracingOptions] Tracing options.
- * @member {string} [vnetName] Virtual Network name.
- * @member {object} [cors] Cross-Origin Resource Sharing (CORS) settings.
- * @member {array} [cors.allowedOrigins] Gets or sets the list of origins
+ * @property {string} [tracingOptions] Tracing options.
+ * @property {string} [vnetName] Virtual Network name.
+ * @property {object} [cors] Cross-Origin Resource Sharing (CORS) settings.
+ * @property {array} [cors.allowedOrigins] Gets or sets the list of origins
* that should be allowed to make cross-origin
* calls (for example: http://example.com:12345). Use "*" to allow all.
- * @member {object} [push] Push endpoint settings.
- * @member {boolean} [push.isPushEnabled] Gets or sets a flag indicating
+ * @property {object} [push] Push endpoint settings.
+ * @property {boolean} [push.isPushEnabled] Gets or sets a flag indicating
* whether the Push endpoint is enabled.
- * @member {string} [push.tagWhitelistJson] Gets or sets a JSON string
+ * @property {string} [push.tagWhitelistJson] Gets or sets a JSON string
* containing a list of tags that are whitelisted for use by the push
* registration endpoint.
- * @member {string} [push.tagsRequiringAuth] Gets or sets a JSON string
+ * @property {string} [push.tagsRequiringAuth] Gets or sets a JSON string
* containing a list of tags that require user authentication to be used in
* the push registration endpoint.
* Tags can consist of alphanumeric characters and the following:
* '_', '@', '#', '.', ':', '-'.
* Validation should be performed at the PushRequestHandler.
- * @member {string} [push.dynamicTagsJson] Gets or sets a JSON string
+ * @property {string} [push.dynamicTagsJson] Gets or sets a JSON string
* containing a list of dynamic tags that will be evaluated from user claims
* in the push registration endpoint.
- * @member {object} [apiDefinition] Information about the formal API
+ * @property {object} [apiDefinition] Information about the formal API
* definition for the app.
- * @member {string} [apiDefinition.url] The URL of the API definition.
- * @member {string} [autoSwapSlotName] Auto-swap slot name.
- * @member {boolean} [localMySqlEnabled] true to enable local
+ * @property {string} [apiDefinition.url] The URL of the API definition.
+ * @property {string} [autoSwapSlotName] Auto-swap slot name.
+ * @property {boolean} [localMySqlEnabled] true to enable local
* MySQL; otherwise, false. Default value: false .
- * @member {number} [managedServiceIdentityId] Managed Service Identity Id
- * @member {number} [xManagedServiceIdentityId] Explicit Managed Service
+ * @property {number} [managedServiceIdentityId] Managed Service Identity Id
+ * @property {number} [xManagedServiceIdentityId] Explicit Managed Service
* Identity Id
- * @member {array} [ipSecurityRestrictions] IP security restrictions.
- * @member {boolean} [http20Enabled] Http20Enabled: configures a web site to
- * allow clients to connect over http2.0. Default value: true .
- * @member {string} [minTlsVersion] MinTlsVersion: configures the minimum
+ * @property {array} [ipSecurityRestrictions] IP security restrictions.
+ * @property {boolean} [http20Enabled] Http20Enabled: configures a web site
+ * to allow clients to connect over http2.0. Default value: true .
+ * @property {string} [minTlsVersion] MinTlsVersion: configures the minimum
* version of TLS required for SSL requests. Possible values include: '1.0',
* '1.1', '1.2'
- * @member {string} [ftpsState] State of FTP / FTPS service. Possible values
- * include: 'AllAllowed', 'FtpsOnly', 'Disabled'
- * @member {number} [reservedInstanceCount] Number of reserved instances.
+ * @property {string} [ftpsState] State of FTP / FTPS service. Possible
+ * values include: 'AllAllowed', 'FtpsOnly', 'Disabled'
+ * @property {number} [reservedInstanceCount] Number of reserved instances.
* This setting only applies to the Consumption Plan
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/siteConfigResource.js b/lib/services/websiteManagement2/lib/models/siteConfigResource.js
index bbfa3cc80c..d42238f154 100644
--- a/lib/services/websiteManagement2/lib/models/siteConfigResource.js
+++ b/lib/services/websiteManagement2/lib/models/siteConfigResource.js
@@ -20,142 +20,143 @@ const models = require('./index');
class SiteConfigResource extends models['ProxyOnlyResource'] {
/**
* Create a SiteConfigResource.
- * @member {number} [numberOfWorkers] Number of workers.
- * @member {array} [defaultDocuments] Default documents.
- * @member {string} [netFrameworkVersion] .NET Framework version. Default
+ * @property {number} [numberOfWorkers] Number of workers.
+ * @property {array} [defaultDocuments] Default documents.
+ * @property {string} [netFrameworkVersion] .NET Framework version. Default
* value: 'v4.6' .
- * @member {string} [phpVersion] Version of PHP.
- * @member {string} [pythonVersion] Version of Python.
- * @member {string} [nodeVersion] Version of Node.js.
- * @member {string} [linuxFxVersion] Linux App Framework and version
- * @member {string} [windowsFxVersion] Xenon App Framework and version
- * @member {boolean} [requestTracingEnabled] true if request
+ * @property {string} [phpVersion] Version of PHP.
+ * @property {string} [pythonVersion] Version of Python.
+ * @property {string} [nodeVersion] Version of Node.js.
+ * @property {string} [linuxFxVersion] Linux App Framework and version
+ * @property {string} [windowsFxVersion] Xenon App Framework and version
+ * @property {boolean} [requestTracingEnabled] true if request
* tracing is enabled; otherwise, false.
- * @member {date} [requestTracingExpirationTime] Request tracing expiration
+ * @property {date} [requestTracingExpirationTime] Request tracing expiration
* time.
- * @member {boolean} [remoteDebuggingEnabled] true if remote
+ * @property {boolean} [remoteDebuggingEnabled] true if remote
* debugging is enabled; otherwise, false.
- * @member {string} [remoteDebuggingVersion] Remote debugging version.
- * @member {boolean} [httpLoggingEnabled] true if HTTP logging
+ * @property {string} [remoteDebuggingVersion] Remote debugging version.
+ * @property {boolean} [httpLoggingEnabled] true if HTTP logging
* is enabled; otherwise, false.
- * @member {number} [logsDirectorySizeLimit] HTTP logs directory size limit.
- * @member {boolean} [detailedErrorLoggingEnabled] true if
+ * @property {number} [logsDirectorySizeLimit] HTTP logs directory size
+ * limit.
+ * @property {boolean} [detailedErrorLoggingEnabled] true if
* detailed error logging is enabled; otherwise, false.
- * @member {string} [publishingUsername] Publishing user name.
- * @member {array} [appSettings] Application settings.
- * @member {object} [azureStorageAccounts] User-provided Azure storage
+ * @property {string} [publishingUsername] Publishing user name.
+ * @property {array} [appSettings] Application settings.
+ * @property {object} [azureStorageAccounts] User-provided Azure storage
* accounts.
- * @member {array} [connectionStrings] Connection strings.
- * @member {object} [machineKey] Site MachineKey.
- * @member {string} [machineKey.validation] MachineKey validation.
- * @member {string} [machineKey.validationKey] Validation key.
- * @member {string} [machineKey.decryption] Algorithm used for decryption.
- * @member {string} [machineKey.decryptionKey] Decryption key.
- * @member {array} [handlerMappings] Handler mappings.
- * @member {string} [documentRoot] Document root.
- * @member {string} [scmType] SCM type. Possible values include: 'None',
+ * @property {array} [connectionStrings] Connection strings.
+ * @property {object} [machineKey] Site MachineKey.
+ * @property {string} [machineKey.validation] MachineKey validation.
+ * @property {string} [machineKey.validationKey] Validation key.
+ * @property {string} [machineKey.decryption] Algorithm used for decryption.
+ * @property {string} [machineKey.decryptionKey] Decryption key.
+ * @property {array} [handlerMappings] Handler mappings.
+ * @property {string} [documentRoot] Document root.
+ * @property {string} [scmType] SCM type. Possible values include: 'None',
* 'Dropbox', 'Tfs', 'LocalGit', 'GitHub', 'CodePlexGit', 'CodePlexHg',
* 'BitbucketGit', 'BitbucketHg', 'ExternalGit', 'ExternalHg', 'OneDrive',
* 'VSO'
- * @member {boolean} [use32BitWorkerProcess] true to use 32-bit
- * worker process; otherwise, false.
- * @member {boolean} [webSocketsEnabled] true if WebSocket is
+ * @property {boolean} [use32BitWorkerProcess] true to use
+ * 32-bit worker process; otherwise, false.
+ * @property {boolean} [webSocketsEnabled] true if WebSocket is
* enabled; otherwise, false.
- * @member {boolean} [alwaysOn] true if Always On is enabled;
+ * @property {boolean} [alwaysOn] true if Always On is enabled;
* otherwise, false.
- * @member {string} [javaVersion] Java version.
- * @member {string} [javaContainer] Java container.
- * @member {string} [javaContainerVersion] Java container version.
- * @member {string} [appCommandLine] App command line to launch.
- * @member {string} [managedPipelineMode] Managed pipeline mode. Possible
+ * @property {string} [javaVersion] Java version.
+ * @property {string} [javaContainer] Java container.
+ * @property {string} [javaContainerVersion] Java container version.
+ * @property {string} [appCommandLine] App command line to launch.
+ * @property {string} [managedPipelineMode] Managed pipeline mode. Possible
* values include: 'Integrated', 'Classic'
- * @member {array} [virtualApplications] Virtual applications.
- * @member {string} [loadBalancing] Site load balancing. Possible values
+ * @property {array} [virtualApplications] Virtual applications.
+ * @property {string} [loadBalancing] Site load balancing. Possible values
* include: 'WeightedRoundRobin', 'LeastRequests', 'LeastResponseTime',
* 'WeightedTotalTraffic', 'RequestHash'
- * @member {object} [experiments] This is work around for polymophic types.
- * @member {array} [experiments.rampUpRules] List of ramp-up rules.
- * @member {object} [limits] Site limits.
- * @member {number} [limits.maxPercentageCpu] Maximum allowed CPU usage
+ * @property {object} [experiments] This is work around for polymophic types.
+ * @property {array} [experiments.rampUpRules] List of ramp-up rules.
+ * @property {object} [limits] Site limits.
+ * @property {number} [limits.maxPercentageCpu] Maximum allowed CPU usage
* percentage.
- * @member {number} [limits.maxMemoryInMb] Maximum allowed memory usage in
+ * @property {number} [limits.maxMemoryInMb] Maximum allowed memory usage in
* MB.
- * @member {number} [limits.maxDiskSizeInMb] Maximum allowed disk size usage
- * in MB.
- * @member {boolean} [autoHealEnabled] true if Auto Heal is
+ * @property {number} [limits.maxDiskSizeInMb] Maximum allowed disk size
+ * usage in MB.
+ * @property {boolean} [autoHealEnabled] true if Auto Heal is
* enabled; otherwise, false.
- * @member {object} [autoHealRules] Auto Heal rules.
- * @member {object} [autoHealRules.triggers] Conditions that describe when to
- * execute the auto-heal actions.
- * @member {object} [autoHealRules.triggers.requests] A rule based on total
+ * @property {object} [autoHealRules] Auto Heal rules.
+ * @property {object} [autoHealRules.triggers] Conditions that describe when
+ * to execute the auto-heal actions.
+ * @property {object} [autoHealRules.triggers.requests] A rule based on total
* requests.
- * @member {number} [autoHealRules.triggers.requests.count] Request Count.
- * @member {string} [autoHealRules.triggers.requests.timeInterval] Time
+ * @property {number} [autoHealRules.triggers.requests.count] Request Count.
+ * @property {string} [autoHealRules.triggers.requests.timeInterval] Time
* interval.
- * @member {number} [autoHealRules.triggers.privateBytesInKB] A rule based on
- * private bytes.
- * @member {array} [autoHealRules.triggers.statusCodes] A rule based on
+ * @property {number} [autoHealRules.triggers.privateBytesInKB] A rule based
+ * on private bytes.
+ * @property {array} [autoHealRules.triggers.statusCodes] A rule based on
* status codes.
- * @member {object} [autoHealRules.triggers.slowRequests] A rule based on
+ * @property {object} [autoHealRules.triggers.slowRequests] A rule based on
* request execution time.
- * @member {string} [autoHealRules.triggers.slowRequests.timeTaken] Time
+ * @property {string} [autoHealRules.triggers.slowRequests.timeTaken] Time
* taken.
- * @member {number} [autoHealRules.triggers.slowRequests.count] Request
+ * @property {number} [autoHealRules.triggers.slowRequests.count] Request
* Count.
- * @member {string} [autoHealRules.triggers.slowRequests.timeInterval] Time
+ * @property {string} [autoHealRules.triggers.slowRequests.timeInterval] Time
* interval.
- * @member {object} [autoHealRules.actions] Actions to be executed when a
+ * @property {object} [autoHealRules.actions] Actions to be executed when a
* rule is triggered.
- * @member {string} [autoHealRules.actions.actionType] Predefined action to
+ * @property {string} [autoHealRules.actions.actionType] Predefined action to
* be taken. Possible values include: 'Recycle', 'LogEvent', 'CustomAction'
- * @member {object} [autoHealRules.actions.customAction] Custom action to be
- * taken.
- * @member {string} [autoHealRules.actions.customAction.exe] Executable to be
- * run.
- * @member {string} [autoHealRules.actions.customAction.parameters]
+ * @property {object} [autoHealRules.actions.customAction] Custom action to
+ * be taken.
+ * @property {string} [autoHealRules.actions.customAction.exe] Executable to
+ * be run.
+ * @property {string} [autoHealRules.actions.customAction.parameters]
* Parameters for the executable.
- * @member {string} [autoHealRules.actions.minProcessExecutionTime] Minimum
+ * @property {string} [autoHealRules.actions.minProcessExecutionTime] Minimum
* time the process must execute
* before taking the action
- * @member {string} [tracingOptions] Tracing options.
- * @member {string} [vnetName] Virtual Network name.
- * @member {object} [cors] Cross-Origin Resource Sharing (CORS) settings.
- * @member {array} [cors.allowedOrigins] Gets or sets the list of origins
+ * @property {string} [tracingOptions] Tracing options.
+ * @property {string} [vnetName] Virtual Network name.
+ * @property {object} [cors] Cross-Origin Resource Sharing (CORS) settings.
+ * @property {array} [cors.allowedOrigins] Gets or sets the list of origins
* that should be allowed to make cross-origin
* calls (for example: http://example.com:12345). Use "*" to allow all.
- * @member {object} [push] Push endpoint settings.
- * @member {boolean} [push.isPushEnabled] Gets or sets a flag indicating
+ * @property {object} [push] Push endpoint settings.
+ * @property {boolean} [push.isPushEnabled] Gets or sets a flag indicating
* whether the Push endpoint is enabled.
- * @member {string} [push.tagWhitelistJson] Gets or sets a JSON string
+ * @property {string} [push.tagWhitelistJson] Gets or sets a JSON string
* containing a list of tags that are whitelisted for use by the push
* registration endpoint.
- * @member {string} [push.tagsRequiringAuth] Gets or sets a JSON string
+ * @property {string} [push.tagsRequiringAuth] Gets or sets a JSON string
* containing a list of tags that require user authentication to be used in
* the push registration endpoint.
* Tags can consist of alphanumeric characters and the following:
* '_', '@', '#', '.', ':', '-'.
* Validation should be performed at the PushRequestHandler.
- * @member {string} [push.dynamicTagsJson] Gets or sets a JSON string
+ * @property {string} [push.dynamicTagsJson] Gets or sets a JSON string
* containing a list of dynamic tags that will be evaluated from user claims
* in the push registration endpoint.
- * @member {object} [apiDefinition] Information about the formal API
+ * @property {object} [apiDefinition] Information about the formal API
* definition for the app.
- * @member {string} [apiDefinition.url] The URL of the API definition.
- * @member {string} [autoSwapSlotName] Auto-swap slot name.
- * @member {boolean} [localMySqlEnabled] true to enable local
+ * @property {string} [apiDefinition.url] The URL of the API definition.
+ * @property {string} [autoSwapSlotName] Auto-swap slot name.
+ * @property {boolean} [localMySqlEnabled] true to enable local
* MySQL; otherwise, false. Default value: false .
- * @member {number} [managedServiceIdentityId] Managed Service Identity Id
- * @member {number} [xManagedServiceIdentityId] Explicit Managed Service
+ * @property {number} [managedServiceIdentityId] Managed Service Identity Id
+ * @property {number} [xManagedServiceIdentityId] Explicit Managed Service
* Identity Id
- * @member {array} [ipSecurityRestrictions] IP security restrictions.
- * @member {boolean} [http20Enabled] Http20Enabled: configures a web site to
- * allow clients to connect over http2.0. Default value: true .
- * @member {string} [minTlsVersion] MinTlsVersion: configures the minimum
+ * @property {array} [ipSecurityRestrictions] IP security restrictions.
+ * @property {boolean} [http20Enabled] Http20Enabled: configures a web site
+ * to allow clients to connect over http2.0. Default value: true .
+ * @property {string} [minTlsVersion] MinTlsVersion: configures the minimum
* version of TLS required for SSL requests. Possible values include: '1.0',
* '1.1', '1.2'
- * @member {string} [ftpsState] State of FTP / FTPS service. Possible values
- * include: 'AllAllowed', 'FtpsOnly', 'Disabled'
- * @member {number} [reservedInstanceCount] Number of reserved instances.
+ * @property {string} [ftpsState] State of FTP / FTPS service. Possible
+ * values include: 'AllAllowed', 'FtpsOnly', 'Disabled'
+ * @property {number} [reservedInstanceCount] Number of reserved instances.
* This setting only applies to the Consumption Plan
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/siteConfigResourceCollection.js b/lib/services/websiteManagement2/lib/models/siteConfigResourceCollection.js
index e1668edee7..caade922ab 100644
--- a/lib/services/websiteManagement2/lib/models/siteConfigResourceCollection.js
+++ b/lib/services/websiteManagement2/lib/models/siteConfigResourceCollection.js
@@ -16,7 +16,7 @@
class SiteConfigResourceCollection extends Array {
/**
* Create a SiteConfigResourceCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/siteConfigurationSnapshotInfo.js b/lib/services/websiteManagement2/lib/models/siteConfigurationSnapshotInfo.js
index 1317cb4e81..5c0b4e53ab 100644
--- a/lib/services/websiteManagement2/lib/models/siteConfigurationSnapshotInfo.js
+++ b/lib/services/websiteManagement2/lib/models/siteConfigurationSnapshotInfo.js
@@ -20,8 +20,8 @@ const models = require('./index');
class SiteConfigurationSnapshotInfo extends models['ProxyOnlyResource'] {
/**
* Create a SiteConfigurationSnapshotInfo.
- * @member {date} [time] The time the snapshot was taken.
- * @member {number} [snapshotId] The id of the snapshot
+ * @property {date} [time] The time the snapshot was taken.
+ * @property {number} [snapshotId] The id of the snapshot
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/siteConfigurationSnapshotInfoCollection.js b/lib/services/websiteManagement2/lib/models/siteConfigurationSnapshotInfoCollection.js
index 6bdb27ef62..04fb05260a 100644
--- a/lib/services/websiteManagement2/lib/models/siteConfigurationSnapshotInfoCollection.js
+++ b/lib/services/websiteManagement2/lib/models/siteConfigurationSnapshotInfoCollection.js
@@ -17,7 +17,7 @@
class SiteConfigurationSnapshotInfoCollection extends Array {
/**
* Create a SiteConfigurationSnapshotInfoCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/siteExtensionInfo.js b/lib/services/websiteManagement2/lib/models/siteExtensionInfo.js
index a0293ee225..ee0c5f6d16 100644
--- a/lib/services/websiteManagement2/lib/models/siteExtensionInfo.js
+++ b/lib/services/websiteManagement2/lib/models/siteExtensionInfo.js
@@ -20,29 +20,29 @@ const models = require('./index');
class SiteExtensionInfo extends models['ProxyOnlyResource'] {
/**
* Create a SiteExtensionInfo.
- * @member {string} [extensionId] Site extension ID.
- * @member {string} [title]
- * @member {string} [extensionType] Site extension type. Possible values
+ * @property {string} [extensionId] Site extension ID.
+ * @property {string} [title]
+ * @property {string} [extensionType] Site extension type. Possible values
* include: 'Gallery', 'WebRoot'
- * @member {string} [summary] Summary description.
- * @member {string} [description] Detailed description.
- * @member {string} [version] Version information.
- * @member {string} [extensionUrl] Extension URL.
- * @member {string} [projectUrl] Project URL.
- * @member {string} [iconUrl] Icon URL.
- * @member {string} [licenseUrl] License URL.
- * @member {string} [feedUrl] Feed URL.
- * @member {array} [authors] List of authors.
- * @member {string} [installerCommandLineParams] Installer command line
+ * @property {string} [summary] Summary description.
+ * @property {string} [description] Detailed description.
+ * @property {string} [version] Version information.
+ * @property {string} [extensionUrl] Extension URL.
+ * @property {string} [projectUrl] Project URL.
+ * @property {string} [iconUrl] Icon URL.
+ * @property {string} [licenseUrl] License URL.
+ * @property {string} [feedUrl] Feed URL.
+ * @property {array} [authors] List of authors.
+ * @property {string} [installerCommandLineParams] Installer command line
* parameters.
- * @member {date} [publishedDateTime] Published timestamp.
- * @member {number} [downloadCount] Count of downloads.
- * @member {boolean} [localIsLatestVersion] true if the local
+ * @property {date} [publishedDateTime] Published timestamp.
+ * @property {number} [downloadCount] Count of downloads.
+ * @property {boolean} [localIsLatestVersion] true if the local
* version is the latest version; false otherwise.
- * @member {string} [localPath] Local path.
- * @member {date} [installedDateTime] Installed timestamp.
- * @member {string} [provisioningState] Provisioning state.
- * @member {string} [comment] Site Extension comment.
+ * @property {string} [localPath] Local path.
+ * @property {date} [installedDateTime] Installed timestamp.
+ * @property {string} [provisioningState] Provisioning state.
+ * @property {string} [comment] Site Extension comment.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/siteExtensionInfoCollection.js b/lib/services/websiteManagement2/lib/models/siteExtensionInfoCollection.js
index be20a01f06..262e2e8358 100644
--- a/lib/services/websiteManagement2/lib/models/siteExtensionInfoCollection.js
+++ b/lib/services/websiteManagement2/lib/models/siteExtensionInfoCollection.js
@@ -16,7 +16,7 @@
class SiteExtensionInfoCollection extends Array {
/**
* Create a SiteExtensionInfoCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/siteInstance.js b/lib/services/websiteManagement2/lib/models/siteInstance.js
index 72635c8844..c1948b69cc 100644
--- a/lib/services/websiteManagement2/lib/models/siteInstance.js
+++ b/lib/services/websiteManagement2/lib/models/siteInstance.js
@@ -20,7 +20,7 @@ const models = require('./index');
class SiteInstance extends models['ProxyOnlyResource'] {
/**
* Create a SiteInstance.
- * @member {string} [siteInstanceName] Name of instance.
+ * @property {string} [siteInstanceName] Name of instance.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/siteLimits.js b/lib/services/websiteManagement2/lib/models/siteLimits.js
index 48f8562cea..cec4c4ba8a 100644
--- a/lib/services/websiteManagement2/lib/models/siteLimits.js
+++ b/lib/services/websiteManagement2/lib/models/siteLimits.js
@@ -17,9 +17,11 @@
class SiteLimits {
/**
* Create a SiteLimits.
- * @member {number} [maxPercentageCpu] Maximum allowed CPU usage percentage.
- * @member {number} [maxMemoryInMb] Maximum allowed memory usage in MB.
- * @member {number} [maxDiskSizeInMb] Maximum allowed disk size usage in MB.
+ * @property {number} [maxPercentageCpu] Maximum allowed CPU usage
+ * percentage.
+ * @property {number} [maxMemoryInMb] Maximum allowed memory usage in MB.
+ * @property {number} [maxDiskSizeInMb] Maximum allowed disk size usage in
+ * MB.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/siteLogsConfig.js b/lib/services/websiteManagement2/lib/models/siteLogsConfig.js
index 04f1df34a8..36c8ec4057 100644
--- a/lib/services/websiteManagement2/lib/models/siteLogsConfig.js
+++ b/lib/services/websiteManagement2/lib/models/siteLogsConfig.js
@@ -20,60 +20,61 @@ const models = require('./index');
class SiteLogsConfig extends models['ProxyOnlyResource'] {
/**
* Create a SiteLogsConfig.
- * @member {object} [applicationLogs] Application logs configuration.
- * @member {object} [applicationLogs.fileSystem] Application logs to file
+ * @property {object} [applicationLogs] Application logs configuration.
+ * @property {object} [applicationLogs.fileSystem] Application logs to file
* system configuration.
- * @member {string} [applicationLogs.fileSystem.level] Log level. Possible
+ * @property {string} [applicationLogs.fileSystem.level] Log level. Possible
* values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'
- * @member {object} [applicationLogs.azureTableStorage] Application logs to
+ * @property {object} [applicationLogs.azureTableStorage] Application logs to
* azure table storage configuration.
- * @member {string} [applicationLogs.azureTableStorage.level] Log level.
+ * @property {string} [applicationLogs.azureTableStorage.level] Log level.
* Possible values include: 'Off', 'Verbose', 'Information', 'Warning',
* 'Error'
- * @member {string} [applicationLogs.azureTableStorage.sasUrl] SAS URL to an
- * Azure table with add/query/delete permissions.
- * @member {object} [applicationLogs.azureBlobStorage] Application logs to
+ * @property {string} [applicationLogs.azureTableStorage.sasUrl] SAS URL to
+ * an Azure table with add/query/delete permissions.
+ * @property {object} [applicationLogs.azureBlobStorage] Application logs to
* blob storage configuration.
- * @member {string} [applicationLogs.azureBlobStorage.level] Log level.
+ * @property {string} [applicationLogs.azureBlobStorage.level] Log level.
* Possible values include: 'Off', 'Verbose', 'Information', 'Warning',
* 'Error'
- * @member {string} [applicationLogs.azureBlobStorage.sasUrl] SAS url to a
+ * @property {string} [applicationLogs.azureBlobStorage.sasUrl] SAS url to a
* azure blob container with read/write/list/delete permissions.
- * @member {number} [applicationLogs.azureBlobStorage.retentionInDays]
+ * @property {number} [applicationLogs.azureBlobStorage.retentionInDays]
* Retention in days.
* Remove blobs older than X days.
* 0 or lower means no retention.
- * @member {object} [httpLogs] HTTP logs configuration.
- * @member {object} [httpLogs.fileSystem] Http logs to file system
+ * @property {object} [httpLogs] HTTP logs configuration.
+ * @property {object} [httpLogs.fileSystem] Http logs to file system
* configuration.
- * @member {number} [httpLogs.fileSystem.retentionInMb] Maximum size in
+ * @property {number} [httpLogs.fileSystem.retentionInMb] Maximum size in
* megabytes that http log files can use.
* When reached old log files will be removed to make space for new ones.
* Value can range between 25 and 100.
- * @member {number} [httpLogs.fileSystem.retentionInDays] Retention in days.
+ * @property {number} [httpLogs.fileSystem.retentionInDays] Retention in
+ * days.
* Remove files older than X days.
* 0 or lower means no retention.
- * @member {boolean} [httpLogs.fileSystem.enabled] True if configuration is
+ * @property {boolean} [httpLogs.fileSystem.enabled] True if configuration is
* enabled, false if it is disabled and null if configuration is not set.
- * @member {object} [httpLogs.azureBlobStorage] Http logs to azure blob
+ * @property {object} [httpLogs.azureBlobStorage] Http logs to azure blob
* storage configuration.
- * @member {string} [httpLogs.azureBlobStorage.sasUrl] SAS url to a azure
+ * @property {string} [httpLogs.azureBlobStorage.sasUrl] SAS url to a azure
* blob container with read/write/list/delete permissions.
- * @member {number} [httpLogs.azureBlobStorage.retentionInDays] Retention in
- * days.
+ * @property {number} [httpLogs.azureBlobStorage.retentionInDays] Retention
+ * in days.
* Remove blobs older than X days.
* 0 or lower means no retention.
- * @member {boolean} [httpLogs.azureBlobStorage.enabled] True if
+ * @property {boolean} [httpLogs.azureBlobStorage.enabled] True if
* configuration is enabled, false if it is disabled and null if
* configuration is not set.
- * @member {object} [failedRequestsTracing] Failed requests tracing
+ * @property {object} [failedRequestsTracing] Failed requests tracing
* configuration.
- * @member {boolean} [failedRequestsTracing.enabled] True if configuration is
- * enabled, false if it is disabled and null if configuration is not set.
- * @member {object} [detailedErrorMessages] Detailed error messages
+ * @property {boolean} [failedRequestsTracing.enabled] True if configuration
+ * is enabled, false if it is disabled and null if configuration is not set.
+ * @property {object} [detailedErrorMessages] Detailed error messages
* configuration.
- * @member {boolean} [detailedErrorMessages.enabled] True if configuration is
- * enabled, false if it is disabled and null if configuration is not set.
+ * @property {boolean} [detailedErrorMessages.enabled] True if configuration
+ * is enabled, false if it is disabled and null if configuration is not set.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/siteMachineKey.js b/lib/services/websiteManagement2/lib/models/siteMachineKey.js
index e60a1445f6..cb5ce0bfce 100644
--- a/lib/services/websiteManagement2/lib/models/siteMachineKey.js
+++ b/lib/services/websiteManagement2/lib/models/siteMachineKey.js
@@ -17,10 +17,10 @@
class SiteMachineKey {
/**
* Create a SiteMachineKey.
- * @member {string} [validation] MachineKey validation.
- * @member {string} [validationKey] Validation key.
- * @member {string} [decryption] Algorithm used for decryption.
- * @member {string} [decryptionKey] Decryption key.
+ * @property {string} [validation] MachineKey validation.
+ * @property {string} [validationKey] Validation key.
+ * @property {string} [decryption] Algorithm used for decryption.
+ * @property {string} [decryptionKey] Decryption key.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/sitePatchResource.js b/lib/services/websiteManagement2/lib/models/sitePatchResource.js
index 39de10c15e..015b7f54bb 100644
--- a/lib/services/websiteManagement2/lib/models/sitePatchResource.js
+++ b/lib/services/websiteManagement2/lib/models/sitePatchResource.js
@@ -20,273 +20,278 @@ const models = require('./index');
class SitePatchResource extends models['ProxyOnlyResource'] {
/**
* Create a SitePatchResource.
- * @member {string} [state] Current state of the app.
- * @member {array} [hostNames] Hostnames associated with the app.
- * @member {string} [repositorySiteName] Name of the repository site.
- * @member {string} [usageState] State indicating whether the app has
+ * @property {string} [state] Current state of the app.
+ * @property {array} [hostNames] Hostnames associated with the app.
+ * @property {string} [repositorySiteName] Name of the repository site.
+ * @property {string} [usageState] State indicating whether the app has
* exceeded its quota usage. Read-only. Possible values include: 'Normal',
* 'Exceeded'
- * @member {boolean} [enabled] true if the app is enabled;
+ * @property {boolean} [enabled] true if the app is enabled;
* otherwise, false. Setting this value to false disables the
* app (takes the app offline).
- * @member {array} [enabledHostNames] Enabled hostnames for the app.Hostnames
- * need to be assigned (see HostNames) AND enabled. Otherwise,
+ * @property {array} [enabledHostNames] Enabled hostnames for the
+ * app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,
* the app is not served on those hostnames.
- * @member {string} [availabilityState] Management information availability
+ * @property {string} [availabilityState] Management information availability
* state for the app. Possible values include: 'Normal', 'Limited',
* 'DisasterRecoveryMode'
- * @member {array} [hostNameSslStates] Hostname SSL states are used to manage
- * the SSL bindings for app's hostnames.
- * @member {string} [serverFarmId] Resource ID of the associated App Service
- * plan, formatted as:
+ * @property {array} [hostNameSslStates] Hostname SSL states are used to
+ * manage the SSL bindings for app's hostnames.
+ * @property {string} [serverFarmId] Resource ID of the associated App
+ * Service plan, formatted as:
* "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
- * @member {boolean} [reserved] true if reserved; otherwise,
+ * @property {boolean} [reserved] true if reserved; otherwise,
* false. Default value: false .
- * @member {boolean} [isXenon] Obsolete: Hyper-V sandbox. Default value:
+ * @property {boolean} [isXenon] Obsolete: Hyper-V sandbox. Default value:
* false .
- * @member {boolean} [hyperV] Hyper-V sandbox. Default value: false .
- * @member {date} [lastModifiedTimeUtc] Last time the app was modified, in
+ * @property {boolean} [hyperV] Hyper-V sandbox. Default value: false .
+ * @property {date} [lastModifiedTimeUtc] Last time the app was modified, in
* UTC. Read-only.
- * @member {object} [siteConfig] Configuration of the app.
- * @member {number} [siteConfig.numberOfWorkers] Number of workers.
- * @member {array} [siteConfig.defaultDocuments] Default documents.
- * @member {string} [siteConfig.netFrameworkVersion] .NET Framework version.
- * @member {string} [siteConfig.phpVersion] Version of PHP.
- * @member {string} [siteConfig.pythonVersion] Version of Python.
- * @member {string} [siteConfig.nodeVersion] Version of Node.js.
- * @member {string} [siteConfig.linuxFxVersion] Linux App Framework and
+ * @property {object} [siteConfig] Configuration of the app.
+ * @property {number} [siteConfig.numberOfWorkers] Number of workers.
+ * @property {array} [siteConfig.defaultDocuments] Default documents.
+ * @property {string} [siteConfig.netFrameworkVersion] .NET Framework
+ * version.
+ * @property {string} [siteConfig.phpVersion] Version of PHP.
+ * @property {string} [siteConfig.pythonVersion] Version of Python.
+ * @property {string} [siteConfig.nodeVersion] Version of Node.js.
+ * @property {string} [siteConfig.linuxFxVersion] Linux App Framework and
* version
- * @member {string} [siteConfig.windowsFxVersion] Xenon App Framework and
+ * @property {string} [siteConfig.windowsFxVersion] Xenon App Framework and
* version
- * @member {boolean} [siteConfig.requestTracingEnabled] true if
- * request tracing is enabled; otherwise, false.
- * @member {date} [siteConfig.requestTracingExpirationTime] Request tracing
+ * @property {boolean} [siteConfig.requestTracingEnabled] true
+ * if request tracing is enabled; otherwise, false.
+ * @property {date} [siteConfig.requestTracingExpirationTime] Request tracing
* expiration time.
- * @member {boolean} [siteConfig.remoteDebuggingEnabled] true if
- * remote debugging is enabled; otherwise, false.
- * @member {string} [siteConfig.remoteDebuggingVersion] Remote debugging
+ * @property {boolean} [siteConfig.remoteDebuggingEnabled] true
+ * if remote debugging is enabled; otherwise, false.
+ * @property {string} [siteConfig.remoteDebuggingVersion] Remote debugging
* version.
- * @member {boolean} [siteConfig.httpLoggingEnabled] true if
+ * @property {boolean} [siteConfig.httpLoggingEnabled] true if
* HTTP logging is enabled; otherwise, false.
- * @member {number} [siteConfig.logsDirectorySizeLimit] HTTP logs directory
+ * @property {number} [siteConfig.logsDirectorySizeLimit] HTTP logs directory
* size limit.
- * @member {boolean} [siteConfig.detailedErrorLoggingEnabled]
+ * @property {boolean} [siteConfig.detailedErrorLoggingEnabled]
* true if detailed error logging is enabled; otherwise,
* false.
- * @member {string} [siteConfig.publishingUsername] Publishing user name.
- * @member {array} [siteConfig.appSettings] Application settings.
- * @member {object} [siteConfig.azureStorageAccounts] User-provided Azure
+ * @property {string} [siteConfig.publishingUsername] Publishing user name.
+ * @property {array} [siteConfig.appSettings] Application settings.
+ * @property {object} [siteConfig.azureStorageAccounts] User-provided Azure
* storage accounts.
- * @member {array} [siteConfig.connectionStrings] Connection strings.
- * @member {object} [siteConfig.machineKey] Site MachineKey.
- * @member {string} [siteConfig.machineKey.validation] MachineKey validation.
- * @member {string} [siteConfig.machineKey.validationKey] Validation key.
- * @member {string} [siteConfig.machineKey.decryption] Algorithm used for
+ * @property {array} [siteConfig.connectionStrings] Connection strings.
+ * @property {object} [siteConfig.machineKey] Site MachineKey.
+ * @property {string} [siteConfig.machineKey.validation] MachineKey
+ * validation.
+ * @property {string} [siteConfig.machineKey.validationKey] Validation key.
+ * @property {string} [siteConfig.machineKey.decryption] Algorithm used for
* decryption.
- * @member {string} [siteConfig.machineKey.decryptionKey] Decryption key.
- * @member {array} [siteConfig.handlerMappings] Handler mappings.
- * @member {string} [siteConfig.documentRoot] Document root.
- * @member {string} [siteConfig.scmType] SCM type. Possible values include:
+ * @property {string} [siteConfig.machineKey.decryptionKey] Decryption key.
+ * @property {array} [siteConfig.handlerMappings] Handler mappings.
+ * @property {string} [siteConfig.documentRoot] Document root.
+ * @property {string} [siteConfig.scmType] SCM type. Possible values include:
* 'None', 'Dropbox', 'Tfs', 'LocalGit', 'GitHub', 'CodePlexGit',
* 'CodePlexHg', 'BitbucketGit', 'BitbucketHg', 'ExternalGit', 'ExternalHg',
* 'OneDrive', 'VSO'
- * @member {boolean} [siteConfig.use32BitWorkerProcess] true to
- * use 32-bit worker process; otherwise, false.
- * @member {boolean} [siteConfig.webSocketsEnabled] true if
+ * @property {boolean} [siteConfig.use32BitWorkerProcess] true
+ * to use 32-bit worker process; otherwise, false.
+ * @property {boolean} [siteConfig.webSocketsEnabled] true if
* WebSocket is enabled; otherwise, false.
- * @member {boolean} [siteConfig.alwaysOn] true if Always On is
- * enabled; otherwise, false.
- * @member {string} [siteConfig.javaVersion] Java version.
- * @member {string} [siteConfig.javaContainer] Java container.
- * @member {string} [siteConfig.javaContainerVersion] Java container version.
- * @member {string} [siteConfig.appCommandLine] App command line to launch.
- * @member {string} [siteConfig.managedPipelineMode] Managed pipeline mode.
+ * @property {boolean} [siteConfig.alwaysOn] true if Always On
+ * is enabled; otherwise, false.
+ * @property {string} [siteConfig.javaVersion] Java version.
+ * @property {string} [siteConfig.javaContainer] Java container.
+ * @property {string} [siteConfig.javaContainerVersion] Java container
+ * version.
+ * @property {string} [siteConfig.appCommandLine] App command line to launch.
+ * @property {string} [siteConfig.managedPipelineMode] Managed pipeline mode.
* Possible values include: 'Integrated', 'Classic'
- * @member {array} [siteConfig.virtualApplications] Virtual applications.
- * @member {string} [siteConfig.loadBalancing] Site load balancing. Possible
- * values include: 'WeightedRoundRobin', 'LeastRequests',
+ * @property {array} [siteConfig.virtualApplications] Virtual applications.
+ * @property {string} [siteConfig.loadBalancing] Site load balancing.
+ * Possible values include: 'WeightedRoundRobin', 'LeastRequests',
* 'LeastResponseTime', 'WeightedTotalTraffic', 'RequestHash'
- * @member {object} [siteConfig.experiments] This is work around for
+ * @property {object} [siteConfig.experiments] This is work around for
* polymophic types.
- * @member {array} [siteConfig.experiments.rampUpRules] List of ramp-up
+ * @property {array} [siteConfig.experiments.rampUpRules] List of ramp-up
* rules.
- * @member {object} [siteConfig.limits] Site limits.
- * @member {number} [siteConfig.limits.maxPercentageCpu] Maximum allowed CPU
- * usage percentage.
- * @member {number} [siteConfig.limits.maxMemoryInMb] Maximum allowed memory
- * usage in MB.
- * @member {number} [siteConfig.limits.maxDiskSizeInMb] Maximum allowed disk
- * size usage in MB.
- * @member {boolean} [siteConfig.autoHealEnabled] true if Auto
+ * @property {object} [siteConfig.limits] Site limits.
+ * @property {number} [siteConfig.limits.maxPercentageCpu] Maximum allowed
+ * CPU usage percentage.
+ * @property {number} [siteConfig.limits.maxMemoryInMb] Maximum allowed
+ * memory usage in MB.
+ * @property {number} [siteConfig.limits.maxDiskSizeInMb] Maximum allowed
+ * disk size usage in MB.
+ * @property {boolean} [siteConfig.autoHealEnabled] true if Auto
* Heal is enabled; otherwise, false.
- * @member {object} [siteConfig.autoHealRules] Auto Heal rules.
- * @member {object} [siteConfig.autoHealRules.triggers] Conditions that
+ * @property {object} [siteConfig.autoHealRules] Auto Heal rules.
+ * @property {object} [siteConfig.autoHealRules.triggers] Conditions that
* describe when to execute the auto-heal actions.
- * @member {object} [siteConfig.autoHealRules.triggers.requests] A rule based
- * on total requests.
- * @member {number} [siteConfig.autoHealRules.triggers.requests.count]
+ * @property {object} [siteConfig.autoHealRules.triggers.requests] A rule
+ * based on total requests.
+ * @property {number} [siteConfig.autoHealRules.triggers.requests.count]
* Request Count.
- * @member {string} [siteConfig.autoHealRules.triggers.requests.timeInterval]
- * Time interval.
- * @member {number} [siteConfig.autoHealRules.triggers.privateBytesInKB] A
+ * @property {string}
+ * [siteConfig.autoHealRules.triggers.requests.timeInterval] Time interval.
+ * @property {number} [siteConfig.autoHealRules.triggers.privateBytesInKB] A
* rule based on private bytes.
- * @member {array} [siteConfig.autoHealRules.triggers.statusCodes] A rule
+ * @property {array} [siteConfig.autoHealRules.triggers.statusCodes] A rule
* based on status codes.
- * @member {object} [siteConfig.autoHealRules.triggers.slowRequests] A rule
+ * @property {object} [siteConfig.autoHealRules.triggers.slowRequests] A rule
* based on request execution time.
- * @member {string}
+ * @property {string}
* [siteConfig.autoHealRules.triggers.slowRequests.timeTaken] Time taken.
- * @member {number} [siteConfig.autoHealRules.triggers.slowRequests.count]
+ * @property {number} [siteConfig.autoHealRules.triggers.slowRequests.count]
* Request Count.
- * @member {string}
+ * @property {string}
* [siteConfig.autoHealRules.triggers.slowRequests.timeInterval] Time
* interval.
- * @member {object} [siteConfig.autoHealRules.actions] Actions to be executed
- * when a rule is triggered.
- * @member {string} [siteConfig.autoHealRules.actions.actionType] Predefined
- * action to be taken. Possible values include: 'Recycle', 'LogEvent',
- * 'CustomAction'
- * @member {object} [siteConfig.autoHealRules.actions.customAction] Custom
+ * @property {object} [siteConfig.autoHealRules.actions] Actions to be
+ * executed when a rule is triggered.
+ * @property {string} [siteConfig.autoHealRules.actions.actionType]
+ * Predefined action to be taken. Possible values include: 'Recycle',
+ * 'LogEvent', 'CustomAction'
+ * @property {object} [siteConfig.autoHealRules.actions.customAction] Custom
* action to be taken.
- * @member {string} [siteConfig.autoHealRules.actions.customAction.exe]
+ * @property {string} [siteConfig.autoHealRules.actions.customAction.exe]
* Executable to be run.
- * @member {string}
+ * @property {string}
* [siteConfig.autoHealRules.actions.customAction.parameters] Parameters for
* the executable.
- * @member {string}
+ * @property {string}
* [siteConfig.autoHealRules.actions.minProcessExecutionTime] Minimum time
* the process must execute
* before taking the action
- * @member {string} [siteConfig.tracingOptions] Tracing options.
- * @member {string} [siteConfig.vnetName] Virtual Network name.
- * @member {object} [siteConfig.cors] Cross-Origin Resource Sharing (CORS)
+ * @property {string} [siteConfig.tracingOptions] Tracing options.
+ * @property {string} [siteConfig.vnetName] Virtual Network name.
+ * @property {object} [siteConfig.cors] Cross-Origin Resource Sharing (CORS)
* settings.
- * @member {array} [siteConfig.cors.allowedOrigins] Gets or sets the list of
- * origins that should be allowed to make cross-origin
+ * @property {array} [siteConfig.cors.allowedOrigins] Gets or sets the list
+ * of origins that should be allowed to make cross-origin
* calls (for example: http://example.com:12345). Use "*" to allow all.
- * @member {object} [siteConfig.push] Push endpoint settings.
- * @member {boolean} [siteConfig.push.isPushEnabled] Gets or sets a flag
+ * @property {object} [siteConfig.push] Push endpoint settings.
+ * @property {boolean} [siteConfig.push.isPushEnabled] Gets or sets a flag
* indicating whether the Push endpoint is enabled.
- * @member {string} [siteConfig.push.tagWhitelistJson] Gets or sets a JSON
+ * @property {string} [siteConfig.push.tagWhitelistJson] Gets or sets a JSON
* string containing a list of tags that are whitelisted for use by the push
* registration endpoint.
- * @member {string} [siteConfig.push.tagsRequiringAuth] Gets or sets a JSON
+ * @property {string} [siteConfig.push.tagsRequiringAuth] Gets or sets a JSON
* string containing a list of tags that require user authentication to be
* used in the push registration endpoint.
* Tags can consist of alphanumeric characters and the following:
* '_', '@', '#', '.', ':', '-'.
* Validation should be performed at the PushRequestHandler.
- * @member {string} [siteConfig.push.dynamicTagsJson] Gets or sets a JSON
+ * @property {string} [siteConfig.push.dynamicTagsJson] Gets or sets a JSON
* string containing a list of dynamic tags that will be evaluated from user
* claims in the push registration endpoint.
- * @member {object} [siteConfig.apiDefinition] Information about the formal
+ * @property {object} [siteConfig.apiDefinition] Information about the formal
* API definition for the app.
- * @member {string} [siteConfig.apiDefinition.url] The URL of the API
+ * @property {string} [siteConfig.apiDefinition.url] The URL of the API
* definition.
- * @member {string} [siteConfig.autoSwapSlotName] Auto-swap slot name.
- * @member {boolean} [siteConfig.localMySqlEnabled] true to
+ * @property {string} [siteConfig.autoSwapSlotName] Auto-swap slot name.
+ * @property {boolean} [siteConfig.localMySqlEnabled] true to
* enable local MySQL; otherwise, false.
- * @member {number} [siteConfig.managedServiceIdentityId] Managed Service
+ * @property {number} [siteConfig.managedServiceIdentityId] Managed Service
* Identity Id
- * @member {number} [siteConfig.xManagedServiceIdentityId] Explicit Managed
+ * @property {number} [siteConfig.xManagedServiceIdentityId] Explicit Managed
* Service Identity Id
- * @member {array} [siteConfig.ipSecurityRestrictions] IP security
+ * @property {array} [siteConfig.ipSecurityRestrictions] IP security
* restrictions.
- * @member {boolean} [siteConfig.http20Enabled] Http20Enabled: configures a
+ * @property {boolean} [siteConfig.http20Enabled] Http20Enabled: configures a
* web site to allow clients to connect over http2.0
- * @member {string} [siteConfig.minTlsVersion] MinTlsVersion: configures the
- * minimum version of TLS required for SSL requests. Possible values include:
- * '1.0', '1.1', '1.2'
- * @member {string} [siteConfig.ftpsState] State of FTP / FTPS service.
+ * @property {string} [siteConfig.minTlsVersion] MinTlsVersion: configures
+ * the minimum version of TLS required for SSL requests. Possible values
+ * include: '1.0', '1.1', '1.2'
+ * @property {string} [siteConfig.ftpsState] State of FTP / FTPS service.
* Possible values include: 'AllAllowed', 'FtpsOnly', 'Disabled'
- * @member {number} [siteConfig.reservedInstanceCount] Number of reserved
+ * @property {number} [siteConfig.reservedInstanceCount] Number of reserved
* instances.
* This setting only applies to the Consumption Plan
- * @member {array} [trafficManagerHostNames] Azure Traffic Manager hostnames
- * associated with the app. Read-only.
- * @member {boolean} [scmSiteAlsoStopped] true to stop SCM
+ * @property {array} [trafficManagerHostNames] Azure Traffic Manager
+ * hostnames associated with the app. Read-only.
+ * @property {boolean} [scmSiteAlsoStopped] true to stop SCM
* (KUDU) site when the app is stopped; otherwise, false. The
* default is false. Default value: false .
- * @member {string} [targetSwapSlot] Specifies which deployment slot this app
- * will swap into. Read-only.
- * @member {object} [hostingEnvironmentProfile] App Service Environment to
+ * @property {string} [targetSwapSlot] Specifies which deployment slot this
+ * app will swap into. Read-only.
+ * @property {object} [hostingEnvironmentProfile] App Service Environment to
* use for the app.
- * @member {string} [hostingEnvironmentProfile.id] Resource ID of the App
+ * @property {string} [hostingEnvironmentProfile.id] Resource ID of the App
* Service Environment.
- * @member {string} [hostingEnvironmentProfile.name] Name of the App Service
- * Environment.
- * @member {string} [hostingEnvironmentProfile.type] Resource type of the App
+ * @property {string} [hostingEnvironmentProfile.name] Name of the App
* Service Environment.
- * @member {boolean} [clientAffinityEnabled] true to enable
+ * @property {string} [hostingEnvironmentProfile.type] Resource type of the
+ * App Service Environment.
+ * @property {boolean} [clientAffinityEnabled] true to enable
* client affinity; false to stop sending session affinity
* cookies, which route client requests in the same session to the same
* instance. Default is true.
- * @member {boolean} [clientCertEnabled] true to enable client
+ * @property {boolean} [clientCertEnabled] true to enable client
* certificate authentication (TLS mutual authentication); otherwise,
* false. Default is false.
- * @member {boolean} [hostNamesDisabled] true to disable the
+ * @property {boolean} [hostNamesDisabled] true to disable the
* public hostnames of the app; otherwise, false.
* If true, the app is only accessible via API management
* process.
- * @member {string} [outboundIpAddresses] List of IP addresses that the app
+ * @property {string} [outboundIpAddresses] List of IP addresses that the app
* uses for outbound connections (e.g. database access). Includes VIPs from
* tenants that site can be hosted with current settings. Read-only.
- * @member {string} [possibleOutboundIpAddresses] List of IP addresses that
+ * @property {string} [possibleOutboundIpAddresses] List of IP addresses that
* the app uses for outbound connections (e.g. database access). Includes
* VIPs from all tenants. Read-only.
- * @member {number} [containerSize] Size of the function container.
- * @member {number} [dailyMemoryTimeQuota] Maximum allowed daily memory-time
- * quota (applicable on dynamic apps only).
- * @member {date} [suspendedTill] App suspended till in case memory-time
+ * @property {number} [containerSize] Size of the function container.
+ * @property {number} [dailyMemoryTimeQuota] Maximum allowed daily
+ * memory-time quota (applicable on dynamic apps only).
+ * @property {date} [suspendedTill] App suspended till in case memory-time
* quota is exceeded.
- * @member {number} [maxNumberOfWorkers] Maximum number of workers.
+ * @property {number} [maxNumberOfWorkers] Maximum number of workers.
* This only applies to Functions container.
- * @member {object} [cloningInfo] If specified during app creation, the app
+ * @property {object} [cloningInfo] If specified during app creation, the app
* is cloned from a source app.
- * @member {uuid} [cloningInfo.correlationId] Correlation ID of cloning
+ * @property {uuid} [cloningInfo.correlationId] Correlation ID of cloning
* operation. This ID ties multiple cloning operations
* together to use the same snapshot.
- * @member {boolean} [cloningInfo.overwrite] true to overwrite
+ * @property {boolean} [cloningInfo.overwrite] true to overwrite
* destination app; otherwise, false.
- * @member {boolean} [cloningInfo.cloneCustomHostNames] true to
- * clone custom hostnames from source app; otherwise, false.
- * @member {boolean} [cloningInfo.cloneSourceControl] true to
+ * @property {boolean} [cloningInfo.cloneCustomHostNames] true
+ * to clone custom hostnames from source app; otherwise, false.
+ * @property {boolean} [cloningInfo.cloneSourceControl] true to
* clone source control from source app; otherwise, false.
- * @member {string} [cloningInfo.sourceWebAppId] ARM resource ID of the
+ * @property {string} [cloningInfo.sourceWebAppId] ARM resource ID of the
* source app. App resource ID is of the form
* /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}
* for production slots and
* /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName}
* for other slots.
- * @member {string} [cloningInfo.hostingEnvironment] App Service Environment.
- * @member {object} [cloningInfo.appSettingsOverrides] Application setting
+ * @property {string} [cloningInfo.hostingEnvironment] App Service
+ * Environment.
+ * @property {object} [cloningInfo.appSettingsOverrides] Application setting
* overrides for cloned app. If specified, these settings override the
* settings cloned
* from source app. Otherwise, application settings from source app are
* retained.
- * @member {boolean} [cloningInfo.configureLoadBalancing] true
+ * @property {boolean} [cloningInfo.configureLoadBalancing] true
* to configure load balancing for source and destination app.
- * @member {string} [cloningInfo.trafficManagerProfileId] ARM resource ID of
- * the Traffic Manager profile to use, if it exists. Traffic Manager resource
- * ID is of the form
+ * @property {string} [cloningInfo.trafficManagerProfileId] ARM resource ID
+ * of the Traffic Manager profile to use, if it exists. Traffic Manager
+ * resource ID is of the form
* /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.
- * @member {string} [cloningInfo.trafficManagerProfileName] Name of Traffic
+ * @property {string} [cloningInfo.trafficManagerProfileName] Name of Traffic
* Manager profile to create. This is only needed if Traffic Manager profile
* does not already exist.
- * @member {string} [resourceGroup] Name of the resource group the app
+ * @property {string} [resourceGroup] Name of the resource group the app
* belongs to. Read-only.
- * @member {boolean} [isDefaultContainer] true if the app is a
+ * @property {boolean} [isDefaultContainer] true if the app is a
* default container; otherwise, false.
- * @member {string} [defaultHostName] Default hostname of the app. Read-only.
- * @member {object} [slotSwapStatus] Status of the last deployment slot swap
- * operation.
- * @member {date} [slotSwapStatus.timestampUtc] The time the last successful
- * slot swap completed.
- * @member {string} [slotSwapStatus.sourceSlotName] The source slot of the
+ * @property {string} [defaultHostName] Default hostname of the app.
+ * Read-only.
+ * @property {object} [slotSwapStatus] Status of the last deployment slot
+ * swap operation.
+ * @property {date} [slotSwapStatus.timestampUtc] The time the last
+ * successful slot swap completed.
+ * @property {string} [slotSwapStatus.sourceSlotName] The source slot of the
* last swap operation.
- * @member {string} [slotSwapStatus.destinationSlotName] The destination slot
- * of the last swap operation.
- * @member {boolean} [httpsOnly] HttpsOnly: configures a web site to accept
+ * @property {string} [slotSwapStatus.destinationSlotName] The destination
+ * slot of the last swap operation.
+ * @property {boolean} [httpsOnly] HttpsOnly: configures a web site to accept
* only https requests. Issues redirect for
* http requests
*/
diff --git a/lib/services/websiteManagement2/lib/models/sitePhpErrorLogFlag.js b/lib/services/websiteManagement2/lib/models/sitePhpErrorLogFlag.js
index bdd71e4e43..219471e27d 100644
--- a/lib/services/websiteManagement2/lib/models/sitePhpErrorLogFlag.js
+++ b/lib/services/websiteManagement2/lib/models/sitePhpErrorLogFlag.js
@@ -20,11 +20,11 @@ const models = require('./index');
class SitePhpErrorLogFlag extends models['ProxyOnlyResource'] {
/**
* Create a SitePhpErrorLogFlag.
- * @member {string} [localLogErrors] Local log_errors setting.
- * @member {string} [masterLogErrors] Master log_errors setting.
- * @member {string} [localLogErrorsMaxLength] Local log_errors_max_len
+ * @property {string} [localLogErrors] Local log_errors setting.
+ * @property {string} [masterLogErrors] Master log_errors setting.
+ * @property {string} [localLogErrorsMaxLength] Local log_errors_max_len
* setting.
- * @member {string} [masterLogErrorsMaxLength] Master log_errors_max_len
+ * @property {string} [masterLogErrorsMaxLength] Master log_errors_max_len
* setting.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/siteSeal.js b/lib/services/websiteManagement2/lib/models/siteSeal.js
index 42e247d6c4..755d4bcc90 100644
--- a/lib/services/websiteManagement2/lib/models/siteSeal.js
+++ b/lib/services/websiteManagement2/lib/models/siteSeal.js
@@ -17,7 +17,7 @@
class SiteSeal {
/**
* Create a SiteSeal.
- * @member {string} html HTML snippet
+ * @property {string} html HTML snippet
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/siteSealRequest.js b/lib/services/websiteManagement2/lib/models/siteSealRequest.js
index 1745db2223..b649efc73f 100644
--- a/lib/services/websiteManagement2/lib/models/siteSealRequest.js
+++ b/lib/services/websiteManagement2/lib/models/siteSealRequest.js
@@ -17,9 +17,9 @@
class SiteSealRequest {
/**
* Create a SiteSealRequest.
- * @member {boolean} [lightTheme] If true use the light color
+ * @property {boolean} [lightTheme] If true use the light color
* theme for site seal; otherwise, use the default color theme.
- * @member {string} [locale] Locale of site seal.
+ * @property {string} [locale] Locale of site seal.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/siteSourceControl.js b/lib/services/websiteManagement2/lib/models/siteSourceControl.js
index 492efb717f..2fe567e183 100644
--- a/lib/services/websiteManagement2/lib/models/siteSourceControl.js
+++ b/lib/services/websiteManagement2/lib/models/siteSourceControl.js
@@ -20,14 +20,14 @@ const models = require('./index');
class SiteSourceControl extends models['ProxyOnlyResource'] {
/**
* Create a SiteSourceControl.
- * @member {string} [repoUrl] Repository or source control URL.
- * @member {string} [branch] Name of branch to use for deployment.
- * @member {boolean} [isManualIntegration] true to limit to
+ * @property {string} [repoUrl] Repository or source control URL.
+ * @property {string} [branch] Name of branch to use for deployment.
+ * @property {boolean} [isManualIntegration] true to limit to
* manual integration; false to enable continuous integration
* (which configures webhooks into online repos like GitHub).
- * @member {boolean} [deploymentRollbackEnabled] true to enable
- * deployment rollback; otherwise, false.
- * @member {boolean} [isMercurial] true for a Mercurial
+ * @property {boolean} [deploymentRollbackEnabled] true to
+ * enable deployment rollback; otherwise, false.
+ * @property {boolean} [isMercurial] true for a Mercurial
* repository; false for a Git repository.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/skuCapacity.js b/lib/services/websiteManagement2/lib/models/skuCapacity.js
index 975b91bfd9..50f3151021 100644
--- a/lib/services/websiteManagement2/lib/models/skuCapacity.js
+++ b/lib/services/websiteManagement2/lib/models/skuCapacity.js
@@ -17,13 +17,13 @@
class SkuCapacity {
/**
* Create a SkuCapacity.
- * @member {number} [minimum] Minimum number of workers for this App Service
- * plan SKU.
- * @member {number} [maximum] Maximum number of workers for this App Service
- * plan SKU.
- * @member {number} [default] Default number of workers for this App Service
- * plan SKU.
- * @member {string} [scaleType] Available scale configurations for an App
+ * @property {number} [minimum] Minimum number of workers for this App
+ * Service plan SKU.
+ * @property {number} [maximum] Maximum number of workers for this App
+ * Service plan SKU.
+ * @property {number} [default] Default number of workers for this App
+ * Service plan SKU.
+ * @property {string} [scaleType] Available scale configurations for an App
* Service plan.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/skuDescription.js b/lib/services/websiteManagement2/lib/models/skuDescription.js
index ae5f70eaaf..1dae1316d5 100644
--- a/lib/services/websiteManagement2/lib/models/skuDescription.js
+++ b/lib/services/websiteManagement2/lib/models/skuDescription.js
@@ -17,24 +17,24 @@
class SkuDescription {
/**
* Create a SkuDescription.
- * @member {string} [name] Name of the resource SKU.
- * @member {string} [tier] Service tier of the resource SKU.
- * @member {string} [size] Size specifier of the resource SKU.
- * @member {string} [family] Family code of the resource SKU.
- * @member {number} [capacity] Current number of instances assigned to the
+ * @property {string} [name] Name of the resource SKU.
+ * @property {string} [tier] Service tier of the resource SKU.
+ * @property {string} [size] Size specifier of the resource SKU.
+ * @property {string} [family] Family code of the resource SKU.
+ * @property {number} [capacity] Current number of instances assigned to the
* resource.
- * @member {object} [skuCapacity] Min, max, and default scale values of the
+ * @property {object} [skuCapacity] Min, max, and default scale values of the
* SKU.
- * @member {number} [skuCapacity.minimum] Minimum number of workers for this
- * App Service plan SKU.
- * @member {number} [skuCapacity.maximum] Maximum number of workers for this
- * App Service plan SKU.
- * @member {number} [skuCapacity.default] Default number of workers for this
- * App Service plan SKU.
- * @member {string} [skuCapacity.scaleType] Available scale configurations
+ * @property {number} [skuCapacity.minimum] Minimum number of workers for
+ * this App Service plan SKU.
+ * @property {number} [skuCapacity.maximum] Maximum number of workers for
+ * this App Service plan SKU.
+ * @property {number} [skuCapacity.default] Default number of workers for
+ * this App Service plan SKU.
+ * @property {string} [skuCapacity.scaleType] Available scale configurations
* for an App Service plan.
- * @member {array} [locations] Locations of the SKU.
- * @member {array} [capabilities] Capabilities of the SKU, e.g., is traffic
+ * @property {array} [locations] Locations of the SKU.
+ * @property {array} [capabilities] Capabilities of the SKU, e.g., is traffic
* manager enabled?
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/skuInfo.js b/lib/services/websiteManagement2/lib/models/skuInfo.js
index 1af7a35617..2fec9487ce 100644
--- a/lib/services/websiteManagement2/lib/models/skuInfo.js
+++ b/lib/services/websiteManagement2/lib/models/skuInfo.js
@@ -17,35 +17,36 @@
class SkuInfo {
/**
* Create a SkuInfo.
- * @member {string} [resourceType] Resource type that this SKU applies to.
- * @member {object} [sku] Name and tier of the SKU.
- * @member {string} [sku.name] Name of the resource SKU.
- * @member {string} [sku.tier] Service tier of the resource SKU.
- * @member {string} [sku.size] Size specifier of the resource SKU.
- * @member {string} [sku.family] Family code of the resource SKU.
- * @member {number} [sku.capacity] Current number of instances assigned to
+ * @property {string} [resourceType] Resource type that this SKU applies to.
+ * @property {object} [sku] Name and tier of the SKU.
+ * @property {string} [sku.name] Name of the resource SKU.
+ * @property {string} [sku.tier] Service tier of the resource SKU.
+ * @property {string} [sku.size] Size specifier of the resource SKU.
+ * @property {string} [sku.family] Family code of the resource SKU.
+ * @property {number} [sku.capacity] Current number of instances assigned to
* the resource.
- * @member {object} [sku.skuCapacity] Min, max, and default scale values of
+ * @property {object} [sku.skuCapacity] Min, max, and default scale values of
* the SKU.
- * @member {number} [sku.skuCapacity.minimum] Minimum number of workers for
+ * @property {number} [sku.skuCapacity.minimum] Minimum number of workers for
* this App Service plan SKU.
- * @member {number} [sku.skuCapacity.maximum] Maximum number of workers for
+ * @property {number} [sku.skuCapacity.maximum] Maximum number of workers for
* this App Service plan SKU.
- * @member {number} [sku.skuCapacity.default] Default number of workers for
+ * @property {number} [sku.skuCapacity.default] Default number of workers for
* this App Service plan SKU.
- * @member {string} [sku.skuCapacity.scaleType] Available scale
+ * @property {string} [sku.skuCapacity.scaleType] Available scale
* configurations for an App Service plan.
- * @member {array} [sku.locations] Locations of the SKU.
- * @member {array} [sku.capabilities] Capabilities of the SKU, e.g., is
+ * @property {array} [sku.locations] Locations of the SKU.
+ * @property {array} [sku.capabilities] Capabilities of the SKU, e.g., is
* traffic manager enabled?
- * @member {object} [capacity] Min, max, and default scale values of the SKU.
- * @member {number} [capacity.minimum] Minimum number of workers for this App
- * Service plan SKU.
- * @member {number} [capacity.maximum] Maximum number of workers for this App
- * Service plan SKU.
- * @member {number} [capacity.default] Default number of workers for this App
- * Service plan SKU.
- * @member {string} [capacity.scaleType] Available scale configurations for
+ * @property {object} [capacity] Min, max, and default scale values of the
+ * SKU.
+ * @property {number} [capacity.minimum] Minimum number of workers for this
+ * App Service plan SKU.
+ * @property {number} [capacity.maximum] Maximum number of workers for this
+ * App Service plan SKU.
+ * @property {number} [capacity.default] Default number of workers for this
+ * App Service plan SKU.
+ * @property {string} [capacity.scaleType] Available scale configurations for
* an App Service plan.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/skuInfoCollection.js b/lib/services/websiteManagement2/lib/models/skuInfoCollection.js
index d82ba762bd..9c022a8c7c 100644
--- a/lib/services/websiteManagement2/lib/models/skuInfoCollection.js
+++ b/lib/services/websiteManagement2/lib/models/skuInfoCollection.js
@@ -16,7 +16,7 @@
class SkuInfoCollection extends Array {
/**
* Create a SkuInfoCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/skuInfos.js b/lib/services/websiteManagement2/lib/models/skuInfos.js
index 30d2ba0b63..7a76d20840 100644
--- a/lib/services/websiteManagement2/lib/models/skuInfos.js
+++ b/lib/services/websiteManagement2/lib/models/skuInfos.js
@@ -17,8 +17,8 @@
class SkuInfos {
/**
* Create a SkuInfos.
- * @member {string} [resourceType] Resource type that this SKU applies to.
- * @member {array} [skus] List of SKUs the subscription is able to use.
+ * @property {string} [resourceType] Resource type that this SKU applies to.
+ * @property {array} [skus] List of SKUs the subscription is able to use.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/slotConfigNamesResource.js b/lib/services/websiteManagement2/lib/models/slotConfigNamesResource.js
index 7bdcaa83e2..db39471931 100644
--- a/lib/services/websiteManagement2/lib/models/slotConfigNamesResource.js
+++ b/lib/services/websiteManagement2/lib/models/slotConfigNamesResource.js
@@ -20,9 +20,9 @@ const models = require('./index');
class SlotConfigNamesResource extends models['ProxyOnlyResource'] {
/**
* Create a SlotConfigNamesResource.
- * @member {array} [connectionStringNames] List of connection string names.
- * @member {array} [appSettingNames] List of application settings names.
- * @member {array} [azureStorageConfigNames] List of external Azure storage
+ * @property {array} [connectionStringNames] List of connection string names.
+ * @property {array} [appSettingNames] List of application settings names.
+ * @property {array} [azureStorageConfigNames] List of external Azure storage
* account identifiers.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/slotDifference.js b/lib/services/websiteManagement2/lib/models/slotDifference.js
index 49d154fc4c..ab833ad21a 100644
--- a/lib/services/websiteManagement2/lib/models/slotDifference.js
+++ b/lib/services/websiteManagement2/lib/models/slotDifference.js
@@ -20,18 +20,18 @@ const models = require('./index');
class SlotDifference extends models['ProxyOnlyResource'] {
/**
* Create a SlotDifference.
- * @member {string} [level] Level of the difference: Information, Warning or
- * Error.
- * @member {string} [settingType] The type of the setting: General,
+ * @property {string} [level] Level of the difference: Information, Warning
+ * or Error.
+ * @property {string} [settingType] The type of the setting: General,
* AppSetting or ConnectionString.
- * @member {string} [diffRule] Rule that describes how to process the setting
- * difference during a slot swap.
- * @member {string} [settingName] Name of the setting.
- * @member {string} [valueInCurrentSlot] Value of the setting in the current
+ * @property {string} [diffRule] Rule that describes how to process the
+ * setting difference during a slot swap.
+ * @property {string} [settingName] Name of the setting.
+ * @property {string} [valueInCurrentSlot] Value of the setting in the
+ * current slot.
+ * @property {string} [valueInTargetSlot] Value of the setting in the target
* slot.
- * @member {string} [valueInTargetSlot] Value of the setting in the target
- * slot.
- * @member {string} [description] Description of the setting difference.
+ * @property {string} [description] Description of the setting difference.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/slotDifferenceCollection.js b/lib/services/websiteManagement2/lib/models/slotDifferenceCollection.js
index ff836aff95..9857881c20 100644
--- a/lib/services/websiteManagement2/lib/models/slotDifferenceCollection.js
+++ b/lib/services/websiteManagement2/lib/models/slotDifferenceCollection.js
@@ -16,7 +16,7 @@
class SlotDifferenceCollection extends Array {
/**
* Create a SlotDifferenceCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/slotSwapStatus.js b/lib/services/websiteManagement2/lib/models/slotSwapStatus.js
index 6d399a5285..0dc30ea564 100644
--- a/lib/services/websiteManagement2/lib/models/slotSwapStatus.js
+++ b/lib/services/websiteManagement2/lib/models/slotSwapStatus.js
@@ -11,17 +11,17 @@
'use strict';
/**
- * The status of the last successfull slot swap operation.
+ * The status of the last successful slot swap operation.
*
*/
class SlotSwapStatus {
/**
* Create a SlotSwapStatus.
- * @member {date} [timestampUtc] The time the last successful slot swap
+ * @property {date} [timestampUtc] The time the last successful slot swap
* completed.
- * @member {string} [sourceSlotName] The source slot of the last swap
+ * @property {string} [sourceSlotName] The source slot of the last swap
* operation.
- * @member {string} [destinationSlotName] The destination slot of the last
+ * @property {string} [destinationSlotName] The destination slot of the last
* swap operation.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/slowRequestsBasedTrigger.js b/lib/services/websiteManagement2/lib/models/slowRequestsBasedTrigger.js
index 30602cb26d..bda19096d3 100644
--- a/lib/services/websiteManagement2/lib/models/slowRequestsBasedTrigger.js
+++ b/lib/services/websiteManagement2/lib/models/slowRequestsBasedTrigger.js
@@ -17,9 +17,9 @@
class SlowRequestsBasedTrigger {
/**
* Create a SlowRequestsBasedTrigger.
- * @member {string} [timeTaken] Time taken.
- * @member {number} [count] Request Count.
- * @member {string} [timeInterval] Time interval.
+ * @property {string} [timeTaken] Time taken.
+ * @property {number} [count] Request Count.
+ * @property {string} [timeInterval] Time interval.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/snapshot.js b/lib/services/websiteManagement2/lib/models/snapshot.js
index 9420d3e70c..fec8a7b315 100644
--- a/lib/services/websiteManagement2/lib/models/snapshot.js
+++ b/lib/services/websiteManagement2/lib/models/snapshot.js
@@ -20,7 +20,7 @@ const models = require('./index');
class Snapshot extends models['ProxyOnlyResource'] {
/**
* Create a Snapshot.
- * @member {string} [time] The time the snapshot was taken.
+ * @property {string} [time] The time the snapshot was taken.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/snapshotCollection.js b/lib/services/websiteManagement2/lib/models/snapshotCollection.js
index b6729f556f..4799c5ce1a 100644
--- a/lib/services/websiteManagement2/lib/models/snapshotCollection.js
+++ b/lib/services/websiteManagement2/lib/models/snapshotCollection.js
@@ -17,7 +17,7 @@
class SnapshotCollection extends Array {
/**
* Create a SnapshotCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/snapshotRecoverySource.js b/lib/services/websiteManagement2/lib/models/snapshotRecoverySource.js
index e545007e99..5eabc3f31f 100644
--- a/lib/services/websiteManagement2/lib/models/snapshotRecoverySource.js
+++ b/lib/services/websiteManagement2/lib/models/snapshotRecoverySource.js
@@ -17,9 +17,9 @@
class SnapshotRecoverySource {
/**
* Create a SnapshotRecoverySource.
- * @member {string} [location] Geographical location of the source web app,
+ * @property {string} [location] Geographical location of the source web app,
* e.g. SouthEastAsia, SouthCentralUS
- * @member {string} [id] ARM resource ID of the source app.
+ * @property {string} [id] ARM resource ID of the source app.
* /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}
* for production slots and
* /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName}
diff --git a/lib/services/websiteManagement2/lib/models/snapshotRestoreRequest.js b/lib/services/websiteManagement2/lib/models/snapshotRestoreRequest.js
index 657a34f217..abd941a826 100644
--- a/lib/services/websiteManagement2/lib/models/snapshotRestoreRequest.js
+++ b/lib/services/websiteManagement2/lib/models/snapshotRestoreRequest.js
@@ -20,27 +20,27 @@ const models = require('./index');
class SnapshotRestoreRequest extends models['ProxyOnlyResource'] {
/**
* Create a SnapshotRestoreRequest.
- * @member {string} [snapshotTime] Point in time in which the app restore
+ * @property {string} [snapshotTime] Point in time in which the app restore
* should be done, formatted as a DateTime string.
- * @member {object} [recoverySource] Optional. Specifies the web app that
+ * @property {object} [recoverySource] Optional. Specifies the web app that
* snapshot contents will be retrieved from.
* If empty, the targeted web app will be used as the source.
- * @member {string} [recoverySource.location] Geographical location of the
+ * @property {string} [recoverySource.location] Geographical location of the
* source web app, e.g. SouthEastAsia, SouthCentralUS
- * @member {string} [recoverySource.id] ARM resource ID of the source app.
+ * @property {string} [recoverySource.id] ARM resource ID of the source app.
* /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}
* for production slots and
* /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName}
* for other slots.
- * @member {boolean} overwrite If true the restore operation can
- * overwrite source app; otherwise, false.
- * @member {boolean} [recoverConfiguration] If true, site configuration, in
+ * @property {boolean} overwrite If true the restore operation
+ * can overwrite source app; otherwise, false.
+ * @property {boolean} [recoverConfiguration] If true, site configuration, in
* addition to content, will be reverted.
- * @member {boolean} [ignoreConflictingHostNames] If true, custom hostname
+ * @property {boolean} [ignoreConflictingHostNames] If true, custom hostname
* conflicts will be ignored when recovering to a target web app.
* This setting is only necessary when RecoverConfiguration is enabled.
- * @member {boolean} [useDRSecondary] If true, the snapshot is retrieved from
- * DRSecondary endpoint.
+ * @property {boolean} [useDRSecondary] If true, the snapshot is retrieved
+ * from DRSecondary endpoint.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/solution.js b/lib/services/websiteManagement2/lib/models/solution.js
index 31d4126612..dbe628e9a1 100644
--- a/lib/services/websiteManagement2/lib/models/solution.js
+++ b/lib/services/websiteManagement2/lib/models/solution.js
@@ -17,14 +17,14 @@
class Solution {
/**
* Create a Solution.
- * @member {number} [id] Solution Id.
- * @member {string} [displayName] Display Name of the solution
- * @member {number} [order] Order of the solution.
- * @member {string} [description] Description of the solution
- * @member {string} [type] Type of Solution. Possible values include:
+ * @property {number} [id] Solution Id.
+ * @property {string} [displayName] Display Name of the solution
+ * @property {number} [order] Order of the solution.
+ * @property {string} [description] Description of the solution
+ * @property {string} [type] Type of Solution. Possible values include:
* 'QuickSolution', 'DeepInvestigation', 'BestPractices'
- * @member {array} [data] Solution Data.
- * @member {array} [metadata] Solution Metadata.
+ * @property {array} [data] Solution Data.
+ * @property {array} [metadata] Solution Metadata.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/sourceControl.js b/lib/services/websiteManagement2/lib/models/sourceControl.js
index 3e7a294e88..7ff2ee5f57 100644
--- a/lib/services/websiteManagement2/lib/models/sourceControl.js
+++ b/lib/services/websiteManagement2/lib/models/sourceControl.js
@@ -20,10 +20,10 @@ const models = require('./index');
class SourceControl extends models['ProxyOnlyResource'] {
/**
* Create a SourceControl.
- * @member {string} [token] OAuth access token.
- * @member {string} [tokenSecret] OAuth access token secret.
- * @member {string} [refreshToken] OAuth refresh token.
- * @member {date} [expirationTime] OAuth token expiration.
+ * @property {string} [token] OAuth access token.
+ * @property {string} [tokenSecret] OAuth access token secret.
+ * @property {string} [refreshToken] OAuth refresh token.
+ * @property {date} [expirationTime] OAuth token expiration.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/sourceControlCollection.js b/lib/services/websiteManagement2/lib/models/sourceControlCollection.js
index 9fd89247ed..764d14ce05 100644
--- a/lib/services/websiteManagement2/lib/models/sourceControlCollection.js
+++ b/lib/services/websiteManagement2/lib/models/sourceControlCollection.js
@@ -16,7 +16,7 @@
class SourceControlCollection extends Array {
/**
* Create a SourceControlCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/stackMajorVersion.js b/lib/services/websiteManagement2/lib/models/stackMajorVersion.js
index 6e76522dfb..5fec37fa10 100644
--- a/lib/services/websiteManagement2/lib/models/stackMajorVersion.js
+++ b/lib/services/websiteManagement2/lib/models/stackMajorVersion.js
@@ -17,13 +17,13 @@
class StackMajorVersion {
/**
* Create a StackMajorVersion.
- * @member {string} [displayVersion] Application stack major version (display
- * only).
- * @member {string} [runtimeVersion] Application stack major version (runtime
- * only).
- * @member {boolean} [isDefault] true if this is the default
+ * @property {string} [displayVersion] Application stack major version
+ * (display only).
+ * @property {string} [runtimeVersion] Application stack major version
+ * (runtime only).
+ * @property {boolean} [isDefault] true if this is the default
* major version; otherwise, false.
- * @member {array} [minorVersions] Minor versions associated with the major
+ * @property {array} [minorVersions] Minor versions associated with the major
* version.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/stackMinorVersion.js b/lib/services/websiteManagement2/lib/models/stackMinorVersion.js
index 2154f681e0..25de74a5a9 100644
--- a/lib/services/websiteManagement2/lib/models/stackMinorVersion.js
+++ b/lib/services/websiteManagement2/lib/models/stackMinorVersion.js
@@ -17,11 +17,11 @@
class StackMinorVersion {
/**
* Create a StackMinorVersion.
- * @member {string} [displayVersion] Application stack minor version (display
- * only).
- * @member {string} [runtimeVersion] Application stack minor version (runtime
- * only).
- * @member {boolean} [isDefault] true if this is the default
+ * @property {string} [displayVersion] Application stack minor version
+ * (display only).
+ * @property {string} [runtimeVersion] Application stack minor version
+ * (runtime only).
+ * @property {boolean} [isDefault] true if this is the default
* minor version; otherwise, false.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/stampCapacity.js b/lib/services/websiteManagement2/lib/models/stampCapacity.js
index 9227735918..40b8cfa230 100644
--- a/lib/services/websiteManagement2/lib/models/stampCapacity.js
+++ b/lib/services/websiteManagement2/lib/models/stampCapacity.js
@@ -17,27 +17,27 @@
class StampCapacity {
/**
* Create a StampCapacity.
- * @member {string} [name] Name of the stamp.
- * @member {number} [availableCapacity] Available capacity (# of machines,
+ * @property {string} [name] Name of the stamp.
+ * @property {number} [availableCapacity] Available capacity (# of machines,
* bytes of storage etc...).
- * @member {number} [totalCapacity] Total capacity (# of machines, bytes of
+ * @property {number} [totalCapacity] Total capacity (# of machines, bytes of
* storage etc...).
- * @member {string} [unit] Name of the unit.
- * @member {string} [computeMode] Shared/dedicated workers. Possible values
+ * @property {string} [unit] Name of the unit.
+ * @property {string} [computeMode] Shared/dedicated workers. Possible values
* include: 'Shared', 'Dedicated', 'Dynamic'
- * @member {string} [workerSize] Size of the machines. Possible values
+ * @property {string} [workerSize] Size of the machines. Possible values
* include: 'Small', 'Medium', 'Large', 'D1', 'D2', 'D3', 'Default'
- * @member {number} [workerSizeId] Size ID of machines:
+ * @property {number} [workerSizeId] Size ID of machines:
* 0 - Small
* 1 - Medium
* 2 - Large
- * @member {boolean} [excludeFromCapacityAllocation] If true, it
- * includes basic apps.
+ * @property {boolean} [excludeFromCapacityAllocation] If true,
+ * it includes basic apps.
* Basic apps are not used for capacity allocation.
- * @member {boolean} [isApplicableForAllComputeModes] true if
+ * @property {boolean} [isApplicableForAllComputeModes] true if
* capacity is applicable for all apps; otherwise, false.
- * @member {string} [siteMode] Shared or Dedicated.
- * @member {boolean} [isLinux] Is this a linux stamp capacity
+ * @property {string} [siteMode] Shared or Dedicated.
+ * @property {boolean} [isLinux] Is this a linux stamp capacity
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/stampCapacityCollection.js b/lib/services/websiteManagement2/lib/models/stampCapacityCollection.js
index 0d06935381..8a0a0fc255 100644
--- a/lib/services/websiteManagement2/lib/models/stampCapacityCollection.js
+++ b/lib/services/websiteManagement2/lib/models/stampCapacityCollection.js
@@ -16,7 +16,7 @@
class StampCapacityCollection extends Array {
/**
* Create a StampCapacityCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/statusCodesBasedTrigger.js b/lib/services/websiteManagement2/lib/models/statusCodesBasedTrigger.js
index dbbf1ac65e..88792053c2 100644
--- a/lib/services/websiteManagement2/lib/models/statusCodesBasedTrigger.js
+++ b/lib/services/websiteManagement2/lib/models/statusCodesBasedTrigger.js
@@ -17,11 +17,11 @@
class StatusCodesBasedTrigger {
/**
* Create a StatusCodesBasedTrigger.
- * @member {number} [status] HTTP status code.
- * @member {number} [subStatus] Request Sub Status.
- * @member {number} [win32Status] Win32 error code.
- * @member {number} [count] Request Count.
- * @member {string} [timeInterval] Time interval.
+ * @property {number} [status] HTTP status code.
+ * @property {number} [subStatus] Request Sub Status.
+ * @property {number} [win32Status] Win32 error code.
+ * @property {number} [count] Request Count.
+ * @property {string} [timeInterval] Time interval.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/storageMigrationOptions.js b/lib/services/websiteManagement2/lib/models/storageMigrationOptions.js
index de8a5cd59a..d4e586b179 100644
--- a/lib/services/websiteManagement2/lib/models/storageMigrationOptions.js
+++ b/lib/services/websiteManagement2/lib/models/storageMigrationOptions.js
@@ -20,12 +20,13 @@ const models = require('./index');
class StorageMigrationOptions extends models['ProxyOnlyResource'] {
/**
* Create a StorageMigrationOptions.
- * @member {string} azurefilesConnectionString AzureFiles connection string.
- * @member {string} azurefilesShare AzureFiles share.
- * @member {boolean} [switchSiteAfterMigration] trueif the app
+ * @property {string} azurefilesConnectionString AzureFiles connection
+ * string.
+ * @property {string} azurefilesShare AzureFiles share.
+ * @property {boolean} [switchSiteAfterMigration] trueif the app
* should be switched over; otherwise, false. Default value:
* false .
- * @member {boolean} [blockWriteAccessToSite] true if the app
+ * @property {boolean} [blockWriteAccessToSite] true if the app
* should be read only during copy operation; otherwise, false.
* Default value: false .
*/
diff --git a/lib/services/websiteManagement2/lib/models/storageMigrationResponse.js b/lib/services/websiteManagement2/lib/models/storageMigrationResponse.js
index 06af20fad8..8d33794822 100644
--- a/lib/services/websiteManagement2/lib/models/storageMigrationResponse.js
+++ b/lib/services/websiteManagement2/lib/models/storageMigrationResponse.js
@@ -20,7 +20,7 @@ const models = require('./index');
class StorageMigrationResponse extends models['ProxyOnlyResource'] {
/**
* Create a StorageMigrationResponse.
- * @member {string} [operationId] When server starts the migration process,
+ * @property {string} [operationId] When server starts the migration process,
* it will return an operation ID identifying that particular migration
* operation.
*/
diff --git a/lib/services/websiteManagement2/lib/models/stringDictionary.js b/lib/services/websiteManagement2/lib/models/stringDictionary.js
index 38f97b7edb..a7fe5bb65b 100644
--- a/lib/services/websiteManagement2/lib/models/stringDictionary.js
+++ b/lib/services/websiteManagement2/lib/models/stringDictionary.js
@@ -20,7 +20,7 @@ const models = require('./index');
class StringDictionary extends models['ProxyOnlyResource'] {
/**
* Create a StringDictionary.
- * @member {object} [properties] Settings.
+ * @property {object} [properties] Settings.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/swiftVirtualNetwork.js b/lib/services/websiteManagement2/lib/models/swiftVirtualNetwork.js
index 7001e790fd..fc68971657 100644
--- a/lib/services/websiteManagement2/lib/models/swiftVirtualNetwork.js
+++ b/lib/services/websiteManagement2/lib/models/swiftVirtualNetwork.js
@@ -21,11 +21,11 @@ const models = require('./index');
class SwiftVirtualNetwork extends models['ProxyOnlyResource'] {
/**
* Create a SwiftVirtualNetwork.
- * @member {string} [subnetResourceId] The Virtual Network subnet's resource
- * ID. This is the subnet that this Web App will join. This subnet must have
- * a delegation to Microsoft.Web/serverFarms defined first.
- * @member {boolean} [swiftSupported] A flag that specifies if the scale unit
- * this Web App is on supports Swift integration.
+ * @property {string} [subnetResourceId] The Virtual Network subnet's
+ * resource ID. This is the subnet that this Web App will join. This subnet
+ * must have a delegation to Microsoft.Web/serverFarms defined first.
+ * @property {boolean} [swiftSupported] A flag that specifies if the scale
+ * unit this Web App is on supports Swift integration.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/tldLegalAgreement.js b/lib/services/websiteManagement2/lib/models/tldLegalAgreement.js
index 55671d5cb5..3f8ca960b7 100644
--- a/lib/services/websiteManagement2/lib/models/tldLegalAgreement.js
+++ b/lib/services/websiteManagement2/lib/models/tldLegalAgreement.js
@@ -17,10 +17,10 @@
class TldLegalAgreement {
/**
* Create a TldLegalAgreement.
- * @member {string} agreementKey Unique identifier for the agreement.
- * @member {string} title Agreement title.
- * @member {string} content Agreement details.
- * @member {string} [url] URL where a copy of the agreement details is
+ * @property {string} agreementKey Unique identifier for the agreement.
+ * @property {string} title Agreement title.
+ * @property {string} content Agreement details.
+ * @property {string} [url] URL where a copy of the agreement details is
* hosted.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/tldLegalAgreementCollection.js b/lib/services/websiteManagement2/lib/models/tldLegalAgreementCollection.js
index 78ce4ed7f2..86e9d06d24 100644
--- a/lib/services/websiteManagement2/lib/models/tldLegalAgreementCollection.js
+++ b/lib/services/websiteManagement2/lib/models/tldLegalAgreementCollection.js
@@ -16,7 +16,7 @@
class TldLegalAgreementCollection extends Array {
/**
* Create a TldLegalAgreementCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/topLevelDomain.js b/lib/services/websiteManagement2/lib/models/topLevelDomain.js
index d5e0a3c95c..d189a11a1c 100644
--- a/lib/services/websiteManagement2/lib/models/topLevelDomain.js
+++ b/lib/services/websiteManagement2/lib/models/topLevelDomain.js
@@ -20,7 +20,7 @@ const models = require('./index');
class TopLevelDomain extends models['ProxyOnlyResource'] {
/**
* Create a TopLevelDomain.
- * @member {boolean} [privacy] If true, then the top level
+ * @property {boolean} [privacy] If true, then the top level
* domain supports domain privacy; otherwise, false.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/topLevelDomainAgreementOption.js b/lib/services/websiteManagement2/lib/models/topLevelDomainAgreementOption.js
index f444781f37..00e640c3ad 100644
--- a/lib/services/websiteManagement2/lib/models/topLevelDomainAgreementOption.js
+++ b/lib/services/websiteManagement2/lib/models/topLevelDomainAgreementOption.js
@@ -17,10 +17,10 @@
class TopLevelDomainAgreementOption {
/**
* Create a TopLevelDomainAgreementOption.
- * @member {boolean} [includePrivacy] If true, then the list of
- * agreements will include agreements for domain privacy as well; otherwise,
- * false.
- * @member {boolean} [forTransfer] If true, then the list of
+ * @property {boolean} [includePrivacy] If true, then the list
+ * of agreements will include agreements for domain privacy as well;
+ * otherwise, false.
+ * @property {boolean} [forTransfer] If true, then the list of
* agreements will include agreements for domain transfer as well; otherwise,
* false.
*/
diff --git a/lib/services/websiteManagement2/lib/models/topLevelDomainCollection.js b/lib/services/websiteManagement2/lib/models/topLevelDomainCollection.js
index aa7c32fbb3..c3b9da4bf8 100644
--- a/lib/services/websiteManagement2/lib/models/topLevelDomainCollection.js
+++ b/lib/services/websiteManagement2/lib/models/topLevelDomainCollection.js
@@ -16,7 +16,7 @@
class TopLevelDomainCollection extends Array {
/**
* Create a TopLevelDomainCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/triggeredJobHistory.js b/lib/services/websiteManagement2/lib/models/triggeredJobHistory.js
index 7623db0417..402854d4e5 100644
--- a/lib/services/websiteManagement2/lib/models/triggeredJobHistory.js
+++ b/lib/services/websiteManagement2/lib/models/triggeredJobHistory.js
@@ -21,7 +21,7 @@ const models = require('./index');
class TriggeredJobHistory extends models['ProxyOnlyResource'] {
/**
* Create a TriggeredJobHistory.
- * @member {array} [runs] List of triggered web job runs.
+ * @property {array} [runs] List of triggered web job runs.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/triggeredJobHistoryCollection.js b/lib/services/websiteManagement2/lib/models/triggeredJobHistoryCollection.js
index 37516f3fba..5e975a0ee8 100644
--- a/lib/services/websiteManagement2/lib/models/triggeredJobHistoryCollection.js
+++ b/lib/services/websiteManagement2/lib/models/triggeredJobHistoryCollection.js
@@ -16,7 +16,7 @@
class TriggeredJobHistoryCollection extends Array {
/**
* Create a TriggeredJobHistoryCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/triggeredJobRun.js b/lib/services/websiteManagement2/lib/models/triggeredJobRun.js
index ef4774b6e4..fdae1ac700 100644
--- a/lib/services/websiteManagement2/lib/models/triggeredJobRun.js
+++ b/lib/services/websiteManagement2/lib/models/triggeredJobRun.js
@@ -20,18 +20,18 @@ const models = require('./index');
class TriggeredJobRun extends models['ProxyOnlyResource'] {
/**
* Create a TriggeredJobRun.
- * @member {string} [webJobId] Job ID.
- * @member {string} [webJobName] Job name.
- * @member {string} [status] Job status. Possible values include: 'Success',
- * 'Failed', 'Error'
- * @member {date} [startTime] Start time.
- * @member {date} [endTime] End time.
- * @member {string} [duration] Job duration.
- * @member {string} [outputUrl] Output URL.
- * @member {string} [errorUrl] Error URL.
- * @member {string} [url] Job URL.
- * @member {string} [jobName] Job name.
- * @member {string} [trigger] Job trigger.
+ * @property {string} [webJobId] Job ID.
+ * @property {string} [webJobName] Job name.
+ * @property {string} [status] Job status. Possible values include:
+ * 'Success', 'Failed', 'Error'
+ * @property {date} [startTime] Start time.
+ * @property {date} [endTime] End time.
+ * @property {string} [duration] Job duration.
+ * @property {string} [outputUrl] Output URL.
+ * @property {string} [errorUrl] Error URL.
+ * @property {string} [url] Job URL.
+ * @property {string} [jobName] Job name.
+ * @property {string} [trigger] Job trigger.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/triggeredWebJob.js b/lib/services/websiteManagement2/lib/models/triggeredWebJob.js
index b062eb3eb4..a4cb9c2c26 100644
--- a/lib/services/websiteManagement2/lib/models/triggeredWebJob.js
+++ b/lib/services/websiteManagement2/lib/models/triggeredWebJob.js
@@ -20,29 +20,29 @@ const models = require('./index');
class TriggeredWebJob extends models['ProxyOnlyResource'] {
/**
* Create a TriggeredWebJob.
- * @member {object} [latestRun] Latest job run information.
- * @member {string} [latestRun.webJobId] Job ID.
- * @member {string} [latestRun.webJobName] Job name.
- * @member {string} [latestRun.status] Job status. Possible values include:
+ * @property {object} [latestRun] Latest job run information.
+ * @property {string} [latestRun.webJobId] Job ID.
+ * @property {string} [latestRun.webJobName] Job name.
+ * @property {string} [latestRun.status] Job status. Possible values include:
* 'Success', 'Failed', 'Error'
- * @member {date} [latestRun.startTime] Start time.
- * @member {date} [latestRun.endTime] End time.
- * @member {string} [latestRun.duration] Job duration.
- * @member {string} [latestRun.outputUrl] Output URL.
- * @member {string} [latestRun.errorUrl] Error URL.
- * @member {string} [latestRun.url] Job URL.
- * @member {string} [latestRun.jobName] Job name.
- * @member {string} [latestRun.trigger] Job trigger.
- * @member {string} [historyUrl] History URL.
- * @member {string} [schedulerLogsUrl] Scheduler Logs URL.
- * @member {string} [runCommand] Run command.
- * @member {string} [url] Job URL.
- * @member {string} [extraInfoUrl] Extra Info URL.
- * @member {string} [webJobType] Job type. Possible values include:
+ * @property {date} [latestRun.startTime] Start time.
+ * @property {date} [latestRun.endTime] End time.
+ * @property {string} [latestRun.duration] Job duration.
+ * @property {string} [latestRun.outputUrl] Output URL.
+ * @property {string} [latestRun.errorUrl] Error URL.
+ * @property {string} [latestRun.url] Job URL.
+ * @property {string} [latestRun.jobName] Job name.
+ * @property {string} [latestRun.trigger] Job trigger.
+ * @property {string} [historyUrl] History URL.
+ * @property {string} [schedulerLogsUrl] Scheduler Logs URL.
+ * @property {string} [runCommand] Run command.
+ * @property {string} [url] Job URL.
+ * @property {string} [extraInfoUrl] Extra Info URL.
+ * @property {string} [webJobType] Job type. Possible values include:
* 'Continuous', 'Triggered'
- * @member {string} [error] Error information.
- * @member {boolean} [usingSdk] Using SDK?
- * @member {object} [settings] Job settings.
+ * @property {string} [error] Error information.
+ * @property {boolean} [usingSdk] Using SDK?
+ * @property {object} [settings] Job settings.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/triggeredWebJobCollection.js b/lib/services/websiteManagement2/lib/models/triggeredWebJobCollection.js
index 4affcd2633..46ae21e03f 100644
--- a/lib/services/websiteManagement2/lib/models/triggeredWebJobCollection.js
+++ b/lib/services/websiteManagement2/lib/models/triggeredWebJobCollection.js
@@ -16,7 +16,7 @@
class TriggeredWebJobCollection extends Array {
/**
* Create a TriggeredWebJobCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/usage.js b/lib/services/websiteManagement2/lib/models/usage.js
index b030fdbfde..5e1f8d51b8 100644
--- a/lib/services/websiteManagement2/lib/models/usage.js
+++ b/lib/services/websiteManagement2/lib/models/usage.js
@@ -20,15 +20,16 @@ const models = require('./index');
class Usage extends models['ProxyOnlyResource'] {
/**
* Create a Usage.
- * @member {string} [displayName] Friendly name shown in the UI.
- * @member {string} [resourceName] Name of the quota resource.
- * @member {string} [unit] Units of measurement for the quota resource.
- * @member {number} [currentValue] The current value of the resource counter.
- * @member {number} [limit] The resource limit.
- * @member {date} [nextResetTime] Next reset time for the resource counter.
- * @member {string} [computeMode] Compute mode used for this usage. Possible
- * values include: 'Shared', 'Dedicated', 'Dynamic'
- * @member {string} [siteMode] Site mode used for this usage.
+ * @property {string} [displayName] Friendly name shown in the UI.
+ * @property {string} [resourceName] Name of the quota resource.
+ * @property {string} [unit] Units of measurement for the quota resource.
+ * @property {number} [currentValue] The current value of the resource
+ * counter.
+ * @property {number} [limit] The resource limit.
+ * @property {date} [nextResetTime] Next reset time for the resource counter.
+ * @property {string} [computeMode] Compute mode used for this usage.
+ * Possible values include: 'Shared', 'Dedicated', 'Dynamic'
+ * @property {string} [siteMode] Site mode used for this usage.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/usageCollection.js b/lib/services/websiteManagement2/lib/models/usageCollection.js
index 566e79b52b..0bda30b4fa 100644
--- a/lib/services/websiteManagement2/lib/models/usageCollection.js
+++ b/lib/services/websiteManagement2/lib/models/usageCollection.js
@@ -16,7 +16,7 @@
class UsageCollection extends Array {
/**
* Create a UsageCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/user.js b/lib/services/websiteManagement2/lib/models/user.js
index ec8071fce3..7a0f2e0fc8 100644
--- a/lib/services/websiteManagement2/lib/models/user.js
+++ b/lib/services/websiteManagement2/lib/models/user.js
@@ -13,20 +13,20 @@
const models = require('./index');
/**
- * User crendentials used for publishing activity.
+ * User credentials used for publishing activity.
*
* @extends models['ProxyOnlyResource']
*/
class User extends models['ProxyOnlyResource'] {
/**
* Create a User.
- * @member {string} publishingUserName Username used for publishing.
- * @member {string} [publishingPassword] Password used for publishing.
- * @member {string} [publishingPasswordHash] Password hash used for
+ * @property {string} publishingUserName Username used for publishing.
+ * @property {string} [publishingPassword] Password used for publishing.
+ * @property {string} [publishingPasswordHash] Password hash used for
* publishing.
- * @member {string} [publishingPasswordHashSalt] Password hash salt used for
- * publishing.
- * @member {string} [scmUri] Url of SCM site.
+ * @property {string} [publishingPasswordHashSalt] Password hash salt used
+ * for publishing.
+ * @property {string} [scmUri] Url of SCM site.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/validateRequest.js b/lib/services/websiteManagement2/lib/models/validateRequest.js
index 3ca18ee528..2f9b114830 100644
--- a/lib/services/websiteManagement2/lib/models/validateRequest.js
+++ b/lib/services/websiteManagement2/lib/models/validateRequest.js
@@ -17,23 +17,23 @@
class ValidateRequest {
/**
* Create a ValidateRequest.
- * @member {string} name Resource name to verify.
- * @member {string} type Resource type used for verification. Possible values
- * include: 'ServerFarm', 'Site'
- * @member {string} location Expected location of the resource.
- * @member {string} [serverFarmId] ARM resource ID of an App Service plan
+ * @property {string} name Resource name to verify.
+ * @property {string} type Resource type used for verification. Possible
+ * values include: 'ServerFarm', 'Site'
+ * @property {string} location Expected location of the resource.
+ * @property {string} [serverFarmId] ARM resource ID of an App Service plan
* that would host the app.
- * @member {string} [skuName] Name of the target SKU for the App Service
+ * @property {string} [skuName] Name of the target SKU for the App Service
* plan.
- * @member {boolean} [needLinuxWorkers] true if App Service plan
- * is for Linux workers; otherwise, false.
- * @member {boolean} [isSpot] true if App Service plan is for
+ * @property {boolean} [needLinuxWorkers] true if App Service
+ * plan is for Linux workers; otherwise, false.
+ * @property {boolean} [isSpot] true if App Service plan is for
* Spot instances; otherwise, false.
- * @member {number} [capacity] Target capacity of the App Service plan
+ * @property {number} [capacity] Target capacity of the App Service plan
* (number of VM's).
- * @member {string} [hostingEnvironment] Name of App Service Environment
+ * @property {string} [hostingEnvironment] Name of App Service Environment
* where app or App Service plan should be created.
- * @member {boolean} [isXenon] true if App Service plan is
+ * @property {boolean} [isXenon] true if App Service plan is
* running as a windows container
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/validateResponse.js b/lib/services/websiteManagement2/lib/models/validateResponse.js
index f5bc588415..2a4e3ac013 100644
--- a/lib/services/websiteManagement2/lib/models/validateResponse.js
+++ b/lib/services/websiteManagement2/lib/models/validateResponse.js
@@ -17,10 +17,11 @@
class ValidateResponse {
/**
* Create a ValidateResponse.
- * @member {string} [status] Result of validation.
- * @member {object} [error] Error details for the case when validation fails.
- * @member {string} [error.code] Validation error code.
- * @member {string} [error.message] Validation error message.
+ * @property {string} [status] Result of validation.
+ * @property {object} [error] Error details for the case when validation
+ * fails.
+ * @property {string} [error.code] Validation error code.
+ * @property {string} [error.message] Validation error message.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/validateResponseError.js b/lib/services/websiteManagement2/lib/models/validateResponseError.js
index 3fecb30d68..3ae786ba16 100644
--- a/lib/services/websiteManagement2/lib/models/validateResponseError.js
+++ b/lib/services/websiteManagement2/lib/models/validateResponseError.js
@@ -17,8 +17,8 @@
class ValidateResponseError {
/**
* Create a ValidateResponseError.
- * @member {string} [code] Validation error code.
- * @member {string} [message] Validation error message.
+ * @property {string} [code] Validation error code.
+ * @property {string} [message] Validation error message.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/virtualApplication.js b/lib/services/websiteManagement2/lib/models/virtualApplication.js
index 0f5a6a66e4..4def491c6b 100644
--- a/lib/services/websiteManagement2/lib/models/virtualApplication.js
+++ b/lib/services/websiteManagement2/lib/models/virtualApplication.js
@@ -17,11 +17,11 @@
class VirtualApplication {
/**
* Create a VirtualApplication.
- * @member {string} [virtualPath] Virtual path.
- * @member {string} [physicalPath] Physical path.
- * @member {boolean} [preloadEnabled] true if preloading is
+ * @property {string} [virtualPath] Virtual path.
+ * @property {string} [physicalPath] Physical path.
+ * @property {boolean} [preloadEnabled] true if preloading is
* enabled; otherwise, false.
- * @member {array} [virtualDirectories] Virtual directories for virtual
+ * @property {array} [virtualDirectories] Virtual directories for virtual
* application.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/virtualDirectory.js b/lib/services/websiteManagement2/lib/models/virtualDirectory.js
index 6950d3d013..1b6ea581b7 100644
--- a/lib/services/websiteManagement2/lib/models/virtualDirectory.js
+++ b/lib/services/websiteManagement2/lib/models/virtualDirectory.js
@@ -17,8 +17,8 @@
class VirtualDirectory {
/**
* Create a VirtualDirectory.
- * @member {string} [virtualPath] Path to virtual application.
- * @member {string} [physicalPath] Physical path.
+ * @property {string} [virtualPath] Path to virtual application.
+ * @property {string} [physicalPath] Physical path.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/virtualIPMapping.js b/lib/services/websiteManagement2/lib/models/virtualIPMapping.js
index 34ac5296e9..d83ab225c5 100644
--- a/lib/services/websiteManagement2/lib/models/virtualIPMapping.js
+++ b/lib/services/websiteManagement2/lib/models/virtualIPMapping.js
@@ -17,10 +17,10 @@
class VirtualIPMapping {
/**
* Create a VirtualIPMapping.
- * @member {string} [virtualIP] Virtual IP address.
- * @member {number} [internalHttpPort] Internal HTTP port.
- * @member {number} [internalHttpsPort] Internal HTTPS port.
- * @member {boolean} [inUse] Is virtual IP mapping in use.
+ * @property {string} [virtualIP] Virtual IP address.
+ * @property {number} [internalHttpPort] Internal HTTP port.
+ * @property {number} [internalHttpsPort] Internal HTTPS port.
+ * @property {boolean} [inUse] Is virtual IP mapping in use.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/virtualNetworkProfile.js b/lib/services/websiteManagement2/lib/models/virtualNetworkProfile.js
index c1f1b1b162..e1e53b4433 100644
--- a/lib/services/websiteManagement2/lib/models/virtualNetworkProfile.js
+++ b/lib/services/websiteManagement2/lib/models/virtualNetworkProfile.js
@@ -17,10 +17,11 @@
class VirtualNetworkProfile {
/**
* Create a VirtualNetworkProfile.
- * @member {string} [id] Resource id of the Virtual Network.
- * @member {string} [name] Name of the Virtual Network (read-only).
- * @member {string} [type] Resource type of the Virtual Network (read-only).
- * @member {string} [subnet] Subnet within the Virtual Network.
+ * @property {string} [id] Resource id of the Virtual Network.
+ * @property {string} [name] Name of the Virtual Network (read-only).
+ * @property {string} [type] Resource type of the Virtual Network
+ * (read-only).
+ * @property {string} [subnet] Subnet within the Virtual Network.
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/vnetGateway.js b/lib/services/websiteManagement2/lib/models/vnetGateway.js
index 1019567d6e..86a52fdb65 100644
--- a/lib/services/websiteManagement2/lib/models/vnetGateway.js
+++ b/lib/services/websiteManagement2/lib/models/vnetGateway.js
@@ -21,8 +21,8 @@ const models = require('./index');
class VnetGateway extends models['ProxyOnlyResource'] {
/**
* Create a VnetGateway.
- * @member {string} [vnetName] The Virtual Network name.
- * @member {string} vpnPackageUri The URI where the VPN package can be
+ * @property {string} [vnetName] The Virtual Network name.
+ * @property {string} vpnPackageUri The URI where the VPN package can be
* downloaded.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/vnetInfo.js b/lib/services/websiteManagement2/lib/models/vnetInfo.js
index 6340d209a5..43bc07acda 100644
--- a/lib/services/websiteManagement2/lib/models/vnetInfo.js
+++ b/lib/services/websiteManagement2/lib/models/vnetInfo.js
@@ -20,16 +20,16 @@ const models = require('./index');
class VnetInfo extends models['ProxyOnlyResource'] {
/**
* Create a VnetInfo.
- * @member {string} [vnetResourceId] The Virtual Network's resource ID.
- * @member {string} [certThumbprint] The client certificate thumbprint.
- * @member {buffer} [certBlob] A certificate file (.cer) blob containing the
- * public key of the private key used to authenticate a
+ * @property {string} [vnetResourceId] The Virtual Network's resource ID.
+ * @property {string} [certThumbprint] The client certificate thumbprint.
+ * @property {buffer} [certBlob] A certificate file (.cer) blob containing
+ * the public key of the private key used to authenticate a
* Point-To-Site VPN connection.
- * @member {array} [routes] The routes that this Virtual Network connection
+ * @property {array} [routes] The routes that this Virtual Network connection
* uses.
- * @member {boolean} [resyncRequired] true if a resync is
+ * @property {boolean} [resyncRequired] true if a resync is
* required; otherwise, false.
- * @member {string} [dnsServers] DNS servers to be used by this Virtual
+ * @property {string} [dnsServers] DNS servers to be used by this Virtual
* Network. This should be a comma-separated list of IP addresses.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/vnetParameters.js b/lib/services/websiteManagement2/lib/models/vnetParameters.js
index a3a8a850f0..ed3939499c 100644
--- a/lib/services/websiteManagement2/lib/models/vnetParameters.js
+++ b/lib/services/websiteManagement2/lib/models/vnetParameters.js
@@ -20,10 +20,10 @@ const models = require('./index');
class VnetParameters extends models['ProxyOnlyResource'] {
/**
* Create a VnetParameters.
- * @member {string} [vnetResourceGroup] The Resource Group of the VNET to be
- * validated
- * @member {string} [vnetName] The name of the VNET to be validated
- * @member {string} [vnetSubnetName] The subnet name to be validated
+ * @property {string} [vnetResourceGroup] The Resource Group of the VNET to
+ * be validated
+ * @property {string} [vnetName] The name of the VNET to be validated
+ * @property {string} [vnetSubnetName] The subnet name to be validated
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/vnetRoute.js b/lib/services/websiteManagement2/lib/models/vnetRoute.js
index 5dfe8a762e..e3448c6929 100644
--- a/lib/services/websiteManagement2/lib/models/vnetRoute.js
+++ b/lib/services/websiteManagement2/lib/models/vnetRoute.js
@@ -21,12 +21,12 @@ const models = require('./index');
class VnetRoute extends models['ProxyOnlyResource'] {
/**
* Create a VnetRoute.
- * @member {string} [startAddress] The starting address for this route. This
- * may also include a CIDR notation, in which case the end address must not
- * be specified.
- * @member {string} [endAddress] The ending address for this route. If the
+ * @property {string} [startAddress] The starting address for this route.
+ * This may also include a CIDR notation, in which case the end address must
+ * not be specified.
+ * @property {string} [endAddress] The ending address for this route. If the
* start address is specified in CIDR notation, this must be omitted.
- * @member {string} [routeType] The type of route this is:
+ * @property {string} [routeType] The type of route this is:
* DEFAULT - By default, every app has routes to the local address ranges
* specified by RFC1918
* INHERITED - Routes inherited from the real Virtual Network routes
diff --git a/lib/services/websiteManagement2/lib/models/vnetValidationFailureDetails.js b/lib/services/websiteManagement2/lib/models/vnetValidationFailureDetails.js
index f8b35f16b6..069d22160f 100644
--- a/lib/services/websiteManagement2/lib/models/vnetValidationFailureDetails.js
+++ b/lib/services/websiteManagement2/lib/models/vnetValidationFailureDetails.js
@@ -20,9 +20,9 @@ const models = require('./index');
class VnetValidationFailureDetails extends models['ProxyOnlyResource'] {
/**
* Create a VnetValidationFailureDetails.
- * @member {boolean} [failed] A flag describing whether or not validation
+ * @property {boolean} [failed] A flag describing whether or not validation
* failed.
- * @member {array} [failedTests] A list of tests that failed in the
+ * @property {array} [failedTests] A list of tests that failed in the
* validation.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/vnetValidationTestFailure.js b/lib/services/websiteManagement2/lib/models/vnetValidationTestFailure.js
index bc2219df3a..51e2d42d8f 100644
--- a/lib/services/websiteManagement2/lib/models/vnetValidationTestFailure.js
+++ b/lib/services/websiteManagement2/lib/models/vnetValidationTestFailure.js
@@ -20,8 +20,8 @@ const models = require('./index');
class VnetValidationTestFailure extends models['ProxyOnlyResource'] {
/**
* Create a VnetValidationTestFailure.
- * @member {string} [testName] The name of the test that failed.
- * @member {string} [details] The details of what caused the failure, e.g.
+ * @property {string} [testName] The name of the test that failed.
+ * @property {string} [details] The details of what caused the failure, e.g.
* the blocking rule name, etc.
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/models/webAppCollection.js b/lib/services/websiteManagement2/lib/models/webAppCollection.js
index 48876fe2b2..ff3c81ebda 100644
--- a/lib/services/websiteManagement2/lib/models/webAppCollection.js
+++ b/lib/services/websiteManagement2/lib/models/webAppCollection.js
@@ -16,7 +16,7 @@
class WebAppCollection extends Array {
/**
* Create a WebAppCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/webAppInstanceCollection.js b/lib/services/websiteManagement2/lib/models/webAppInstanceCollection.js
index 326dc57d43..44a8cedfa5 100644
--- a/lib/services/websiteManagement2/lib/models/webAppInstanceCollection.js
+++ b/lib/services/websiteManagement2/lib/models/webAppInstanceCollection.js
@@ -16,7 +16,7 @@
class WebAppInstanceCollection extends Array {
/**
* Create a WebAppInstanceCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/webJob.js b/lib/services/websiteManagement2/lib/models/webJob.js
index 071625ad9b..d9e10ff543 100644
--- a/lib/services/websiteManagement2/lib/models/webJob.js
+++ b/lib/services/websiteManagement2/lib/models/webJob.js
@@ -20,14 +20,14 @@ const models = require('./index');
class WebJob extends models['ProxyOnlyResource'] {
/**
* Create a WebJob.
- * @member {string} [runCommand] Run command.
- * @member {string} [url] Job URL.
- * @member {string} [extraInfoUrl] Extra Info URL.
- * @member {string} [webJobType] Job type. Possible values include:
+ * @property {string} [runCommand] Run command.
+ * @property {string} [url] Job URL.
+ * @property {string} [extraInfoUrl] Extra Info URL.
+ * @property {string} [webJobType] Job type. Possible values include:
* 'Continuous', 'Triggered'
- * @member {string} [error] Error information.
- * @member {boolean} [usingSdk] Using SDK?
- * @member {object} [settings] Job settings.
+ * @property {string} [error] Error information.
+ * @property {boolean} [usingSdk] Using SDK?
+ * @property {object} [settings] Job settings.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/webJobCollection.js b/lib/services/websiteManagement2/lib/models/webJobCollection.js
index 6e3f47cb45..9f2bf15773 100644
--- a/lib/services/websiteManagement2/lib/models/webJobCollection.js
+++ b/lib/services/websiteManagement2/lib/models/webJobCollection.js
@@ -16,7 +16,7 @@
class WebJobCollection extends Array {
/**
* Create a WebJobCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/workerPool.js b/lib/services/websiteManagement2/lib/models/workerPool.js
index b7896d3594..aaad9e5763 100644
--- a/lib/services/websiteManagement2/lib/models/workerPool.js
+++ b/lib/services/websiteManagement2/lib/models/workerPool.js
@@ -17,14 +17,14 @@
class WorkerPool {
/**
* Create a WorkerPool.
- * @member {number} [workerSizeId] Worker size ID for referencing this worker
- * pool.
- * @member {string} [computeMode] Shared or dedicated app hosting. Possible
+ * @property {number} [workerSizeId] Worker size ID for referencing this
+ * worker pool.
+ * @property {string} [computeMode] Shared or dedicated app hosting. Possible
* values include: 'Shared', 'Dedicated', 'Dynamic'
- * @member {string} [workerSize] VM size of the worker pool instances.
- * @member {number} [workerCount] Number of instances in the worker pool.
- * @member {array} [instanceNames] Names of all instances in the worker pool
- * (read only).
+ * @property {string} [workerSize] VM size of the worker pool instances.
+ * @property {number} [workerCount] Number of instances in the worker pool.
+ * @property {array} [instanceNames] Names of all instances in the worker
+ * pool (read only).
*/
constructor() {
}
diff --git a/lib/services/websiteManagement2/lib/models/workerPoolCollection.js b/lib/services/websiteManagement2/lib/models/workerPoolCollection.js
index a2595a2197..cee71d8d28 100644
--- a/lib/services/websiteManagement2/lib/models/workerPoolCollection.js
+++ b/lib/services/websiteManagement2/lib/models/workerPoolCollection.js
@@ -16,7 +16,7 @@
class WorkerPoolCollection extends Array {
/**
* Create a WorkerPoolCollection.
- * @member {string} [nextLink] Link to next page of resources.
+ * @property {string} [nextLink] Link to next page of resources.
*/
constructor() {
super();
diff --git a/lib/services/websiteManagement2/lib/models/workerPoolResource.js b/lib/services/websiteManagement2/lib/models/workerPoolResource.js
index b8da1fe66f..376c403323 100644
--- a/lib/services/websiteManagement2/lib/models/workerPoolResource.js
+++ b/lib/services/websiteManagement2/lib/models/workerPoolResource.js
@@ -20,33 +20,33 @@ const models = require('./index');
class WorkerPoolResource extends models['ProxyOnlyResource'] {
/**
* Create a WorkerPoolResource.
- * @member {number} [workerSizeId] Worker size ID for referencing this worker
- * pool.
- * @member {string} [computeMode] Shared or dedicated app hosting. Possible
+ * @property {number} [workerSizeId] Worker size ID for referencing this
+ * worker pool.
+ * @property {string} [computeMode] Shared or dedicated app hosting. Possible
* values include: 'Shared', 'Dedicated', 'Dynamic'
- * @member {string} [workerSize] VM size of the worker pool instances.
- * @member {number} [workerCount] Number of instances in the worker pool.
- * @member {array} [instanceNames] Names of all instances in the worker pool
- * (read only).
- * @member {object} [sku]
- * @member {string} [sku.name] Name of the resource SKU.
- * @member {string} [sku.tier] Service tier of the resource SKU.
- * @member {string} [sku.size] Size specifier of the resource SKU.
- * @member {string} [sku.family] Family code of the resource SKU.
- * @member {number} [sku.capacity] Current number of instances assigned to
+ * @property {string} [workerSize] VM size of the worker pool instances.
+ * @property {number} [workerCount] Number of instances in the worker pool.
+ * @property {array} [instanceNames] Names of all instances in the worker
+ * pool (read only).
+ * @property {object} [sku]
+ * @property {string} [sku.name] Name of the resource SKU.
+ * @property {string} [sku.tier] Service tier of the resource SKU.
+ * @property {string} [sku.size] Size specifier of the resource SKU.
+ * @property {string} [sku.family] Family code of the resource SKU.
+ * @property {number} [sku.capacity] Current number of instances assigned to
* the resource.
- * @member {object} [sku.skuCapacity] Min, max, and default scale values of
+ * @property {object} [sku.skuCapacity] Min, max, and default scale values of
* the SKU.
- * @member {number} [sku.skuCapacity.minimum] Minimum number of workers for
+ * @property {number} [sku.skuCapacity.minimum] Minimum number of workers for
* this App Service plan SKU.
- * @member {number} [sku.skuCapacity.maximum] Maximum number of workers for
+ * @property {number} [sku.skuCapacity.maximum] Maximum number of workers for
* this App Service plan SKU.
- * @member {number} [sku.skuCapacity.default] Default number of workers for
+ * @property {number} [sku.skuCapacity.default] Default number of workers for
* this App Service plan SKU.
- * @member {string} [sku.skuCapacity.scaleType] Available scale
+ * @property {string} [sku.skuCapacity.scaleType] Available scale
* configurations for an App Service plan.
- * @member {array} [sku.locations] Locations of the SKU.
- * @member {array} [sku.capabilities] Capabilities of the SKU, e.g., is
+ * @property {array} [sku.locations] Locations of the SKU.
+ * @property {array} [sku.capabilities] Capabilities of the SKU, e.g., is
* traffic manager enabled?
*/
constructor() {
diff --git a/lib/services/websiteManagement2/lib/operations/appServiceCertificateOrders.js b/lib/services/websiteManagement2/lib/operations/appServiceCertificateOrders.js
index c61d1b4c3d..600afc0d2d 100644
--- a/lib/services/websiteManagement2/lib/operations/appServiceCertificateOrders.js
+++ b/lib/services/websiteManagement2/lib/operations/appServiceCertificateOrders.js
@@ -649,8 +649,8 @@ function _get(resourceGroupName, certificateOrderName, options, callback) {
*
* @param {string} certificateOrderName Name of the certificate order.
*
- * @param {object} certificateDistinguishedName Distinguished name to to use
- * for the certificate order.
+ * @param {object} certificateDistinguishedName Distinguished name to use for
+ * the certificate order.
*
* @param {object} [certificateDistinguishedName.certificates] State of the Key
* Vault secret.
@@ -905,8 +905,8 @@ function _deleteMethod(resourceGroupName, certificateOrderName, options, callbac
*
* @param {string} certificateOrderName Name of the certificate order.
*
- * @param {object} certificateDistinguishedName Distinguished name to to use
- * for the certificate order.
+ * @param {object} certificateDistinguishedName Distinguished name to use for
+ * the certificate order.
*
* @param {object} [certificateDistinguishedName.certificates] State of the Key
* Vault secret.
@@ -3275,8 +3275,8 @@ function _retrieveCertificateEmailHistory(resourceGroupName, name, options, call
*
* @param {string} certificateOrderName Name of the certificate order.
*
- * @param {object} certificateDistinguishedName Distinguished name to to use
- * for the certificate order.
+ * @param {object} certificateDistinguishedName Distinguished name to use for
+ * the certificate order.
*
* @param {object} [certificateDistinguishedName.certificates] State of the Key
* Vault secret.
@@ -4558,8 +4558,8 @@ class AppServiceCertificateOrders {
*
* @param {string} certificateOrderName Name of the certificate order.
*
- * @param {object} certificateDistinguishedName Distinguished name to to use
- * for the certificate order.
+ * @param {object} certificateDistinguishedName Distinguished name to use for
+ * the certificate order.
*
* @param {object} [certificateDistinguishedName.certificates] State of the Key
* Vault secret.
@@ -4624,8 +4624,8 @@ class AppServiceCertificateOrders {
*
* @param {string} certificateOrderName Name of the certificate order.
*
- * @param {object} certificateDistinguishedName Distinguished name to to use
- * for the certificate order.
+ * @param {object} certificateDistinguishedName Distinguished name to use for
+ * the certificate order.
*
* @param {object} [certificateDistinguishedName.certificates] State of the Key
* Vault secret.
@@ -4804,8 +4804,8 @@ class AppServiceCertificateOrders {
*
* @param {string} certificateOrderName Name of the certificate order.
*
- * @param {object} certificateDistinguishedName Distinguished name to to use
- * for the certificate order.
+ * @param {object} certificateDistinguishedName Distinguished name to use for
+ * the certificate order.
*
* @param {object} [certificateDistinguishedName.certificates] State of the Key
* Vault secret.
@@ -4866,8 +4866,8 @@ class AppServiceCertificateOrders {
*
* @param {string} certificateOrderName Name of the certificate order.
*
- * @param {object} certificateDistinguishedName Distinguished name to to use
- * for the certificate order.
+ * @param {object} certificateDistinguishedName Distinguished name to use for
+ * the certificate order.
*
* @param {object} [certificateDistinguishedName.certificates] State of the Key
* Vault secret.
@@ -6287,8 +6287,8 @@ class AppServiceCertificateOrders {
*
* @param {string} certificateOrderName Name of the certificate order.
*
- * @param {object} certificateDistinguishedName Distinguished name to to use
- * for the certificate order.
+ * @param {object} certificateDistinguishedName Distinguished name to use for
+ * the certificate order.
*
* @param {object} [certificateDistinguishedName.certificates] State of the Key
* Vault secret.
@@ -6353,8 +6353,8 @@ class AppServiceCertificateOrders {
*
* @param {string} certificateOrderName Name of the certificate order.
*
- * @param {object} certificateDistinguishedName Distinguished name to to use
- * for the certificate order.
+ * @param {object} certificateDistinguishedName Distinguished name to use for
+ * the certificate order.
*
* @param {object} [certificateDistinguishedName.certificates] State of the Key
* Vault secret.
diff --git a/lib/services/websiteManagement2/lib/operations/index.d.ts b/lib/services/websiteManagement2/lib/operations/index.d.ts
index 40aab24fbe..7e3bbb010f 100644
--- a/lib/services/websiteManagement2/lib/operations/index.d.ts
+++ b/lib/services/websiteManagement2/lib/operations/index.d.ts
@@ -332,8 +332,8 @@ export interface AppServiceCertificateOrders {
*
* @param {string} certificateOrderName Name of the certificate order.
*
- * @param {object} certificateDistinguishedName Distinguished name to to use
- * for the certificate order.
+ * @param {object} certificateDistinguishedName Distinguished name to use for
+ * the certificate order.
*
* @param {object} [certificateDistinguishedName.certificates] State of the Key
* Vault secret.
@@ -386,8 +386,8 @@ export interface AppServiceCertificateOrders {
*
* @param {string} certificateOrderName Name of the certificate order.
*
- * @param {object} certificateDistinguishedName Distinguished name to to use
- * for the certificate order.
+ * @param {object} certificateDistinguishedName Distinguished name to use for
+ * the certificate order.
*
* @param {object} [certificateDistinguishedName.certificates] State of the Key
* Vault secret.
@@ -524,8 +524,8 @@ export interface AppServiceCertificateOrders {
*
* @param {string} certificateOrderName Name of the certificate order.
*
- * @param {object} certificateDistinguishedName Distinguished name to to use
- * for the certificate order.
+ * @param {object} certificateDistinguishedName Distinguished name to use for
+ * the certificate order.
*
* @param {object} [certificateDistinguishedName.certificates] State of the Key
* Vault secret.
@@ -574,8 +574,8 @@ export interface AppServiceCertificateOrders {
*
* @param {string} certificateOrderName Name of the certificate order.
*
- * @param {object} certificateDistinguishedName Distinguished name to to use
- * for the certificate order.
+ * @param {object} certificateDistinguishedName Distinguished name to use for
+ * the certificate order.
*
* @param {object} [certificateDistinguishedName.certificates] State of the Key
* Vault secret.
@@ -1629,8 +1629,8 @@ export interface AppServiceCertificateOrders {
*
* @param {string} certificateOrderName Name of the certificate order.
*
- * @param {object} certificateDistinguishedName Distinguished name to to use
- * for the certificate order.
+ * @param {object} certificateDistinguishedName Distinguished name to use for
+ * the certificate order.
*
* @param {object} [certificateDistinguishedName.certificates] State of the Key
* Vault secret.
@@ -1683,8 +1683,8 @@ export interface AppServiceCertificateOrders {
*
* @param {string} certificateOrderName Name of the certificate order.
*
- * @param {object} certificateDistinguishedName Distinguished name to to use
- * for the certificate order.
+ * @param {object} certificateDistinguishedName Distinguished name to use for
+ * the certificate order.
*
* @param {object} [certificateDistinguishedName.certificates] State of the Key
* Vault secret.