Skip to content
This repository was archived by the owner on May 5, 2023. It is now read-only.
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@
class CacheExpirationActionParameters {
/**
* Create a CacheExpirationActionParameters.
* @member {string} cacheBehavior Caching behavior for the requests that
* @property {string} cacheBehavior Caching behavior for the requests that
* include query strings. Possible values include: 'BypassCache', 'Override',
* 'SetIfMissing'
* @member {string} [cacheDuration] The duration for which the the content
* @property {string} [cacheDuration] The duration for which the content
* needs to be cached. Allowed format is [d.]hh:mm:ss
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
class CheckNameAvailabilityInput {
/**
* Create a CheckNameAvailabilityInput.
* @member {string} name The resource name to validate.
* @property {string} name The resource name to validate.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@
class CheckNameAvailabilityOutput {
/**
* Create a CheckNameAvailabilityOutput.
* @member {boolean} [nameAvailable] Indicates whether the name is available.
* @member {string} [reason] The reason why the name is not available.
* @member {string} [message] The detailed error message describing why the
* @property {boolean} [nameAvailable] Indicates whether the name is
* available.
* @property {string} [reason] The reason why the name is not available.
* @property {string} [message] The detailed error message describing why the
* name is not available.
*/
constructor() {
Expand Down
4 changes: 2 additions & 2 deletions lib/services/cdnManagement/lib/models/cidrIpAddress.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
class CidrIpAddress {
/**
* Create a CidrIpAddress.
* @member {string} [baseIpAddress] Ip adress itself.
* @member {number} [prefixLength] The length of the prefix of the ip
* @property {string} [baseIpAddress] Ip address itself.
* @property {number} [prefixLength] The length of the prefix of the ip
* address.
*/
constructor() {
Expand Down
14 changes: 7 additions & 7 deletions lib/services/cdnManagement/lib/models/customDomain.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,21 @@ const models = require('./index');

/**
* Friendly domain name mapping to the endpoint hostname that the customer
* provides for branding purposes, e.g. www.consoto.com.
* provides for branding purposes, e.g. www.contoso.com.
*
* @extends models['ProxyResource']
*/
class CustomDomain extends models['ProxyResource'] {
/**
* Create a CustomDomain.
* @member {string} hostName The host name of the custom domain. Must be a
* @property {string} hostName The host name of the custom domain. Must be a
* domain name.
* @member {string} [resourceState] Resource status of the custom domain.
* @property {string} [resourceState] Resource status of the custom domain.
* Possible values include: 'Creating', 'Active', 'Deleting'
* @member {string} [customHttpsProvisioningState] Provisioning status of
* @property {string} [customHttpsProvisioningState] Provisioning status of
* Custom Https of the custom domain. Possible values include: 'Enabling',
* 'Enabled', 'Disabling', 'Disabled', 'Failed'
* @member {string} [customHttpsProvisioningSubstate] Provisioning substate
* @property {string} [customHttpsProvisioningSubstate] Provisioning substate
* shows the progress of custom HTTPS enabling/disabling process step by
* step. Possible values include: 'SubmittingDomainControlValidationRequest',
* 'PendingDomainControlValidationREquestApproval',
Expand All @@ -37,11 +37,11 @@ class CustomDomain extends models['ProxyResource'] {
* 'DomainControlValidationRequestTimedOut', 'IssuingCertificate',
* 'DeployingCertificate', 'CertificateDeployed', 'DeletingCertificate',
* 'CertificateDeleted'
* @member {string} [validationData] Special validation or data may be
* @property {string} [validationData] Special validation or data may be
* required when delivering CDN to some regions due to local compliance
* reasons. E.g. ICP license number of a custom domain is required to deliver
* content in China.
* @member {string} [provisioningState] Provisioning status of the custom
* @property {string} [provisioningState] Provisioning status of the custom
* domain.
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
class CustomDomainListResult extends Array {
/**
* Create a CustomDomainListResult.
* @member {string} [nextLink] URL to get the next set of custom domain
* @property {string} [nextLink] URL to get the next set of custom domain
* objects if there are any.
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
class CustomDomainParameters {
/**
* Create a CustomDomainParameters.
* @member {string} hostName The host name of the custom domain. Must be a
* @property {string} hostName The host name of the custom domain. Must be a
* domain name.
*/
constructor() {
Expand Down
10 changes: 5 additions & 5 deletions lib/services/cdnManagement/lib/models/deepCreatedOrigin.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ const models = require('./index');
class DeepCreatedOrigin extends models['BaseResource'] {
/**
* Create a DeepCreatedOrigin.
* @member {string} name Origin name
* @member {string} hostName The address of the origin. It can be a domain
* @property {string} name Origin name
* @property {string} hostName The address of the origin. It can be a domain
* name, IPv4 address, or IPv6 address.
* @member {number} [httpPort] The value of the HTTP port. Must be between 1
* and 65535
* @member {number} [httpsPort] The value of the HTTPS port. Must be between
* @property {number} [httpPort] The value of the HTTP port. Must be between
* 1 and 65535
* @property {number} [httpsPort] The value of the HTTPS port. Must be
* between 1 and 65535
*/
constructor() {
super();
Expand Down
8 changes: 4 additions & 4 deletions lib/services/cdnManagement/lib/models/deliveryRule.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@
class DeliveryRule {
/**
* Create a DeliveryRule.
* @member {number} order The order in which the rules are applied for the
* @property {number} order The order in which the rules are applied for the
* endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will
* be applied before a rule with a greater order. Rule with order 0 is a
* special rule. It does not require any condition and actions listed in it
* will always be applied.
* @member {array} actions A list of actions that are executed when all the
* @property {array} actions A list of actions that are executed when all the
* conditions of a rule are satisfied.
* @member {array} [conditions] A list of conditions that must be matched for
* the actions to be executed
* @property {array} [conditions] A list of conditions that must be matched
* for the actions to be executed
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
class DeliveryRuleAction {
/**
* Create a DeliveryRuleAction.
* @member {string} name Polymorphic Discriminator
* @property {string} name Polymorphic Discriminator
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ const models = require('./index');
class DeliveryRuleCacheExpirationAction extends models['DeliveryRuleAction'] {
/**
* Create a DeliveryRuleCacheExpirationAction.
* @member {object} parameters Defines the parameters for the action.
* @member {string} [parameters.cacheBehavior] Caching behavior for the
* @property {object} parameters Defines the parameters for the action.
* @property {string} [parameters.cacheBehavior] Caching behavior for the
* requests that include query strings. Possible values include:
* 'BypassCache', 'Override', 'SetIfMissing'
* @member {string} [parameters.cacheDuration] The duration for which the the
* @property {string} [parameters.cacheDuration] The duration for which the
* content needs to be cached. Allowed format is [d.]hh:mm:ss
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
class DeliveryRuleCondition {
/**
* Create a DeliveryRuleCondition.
* @member {string} name Polymorphic Discriminator
* @property {string} name Polymorphic Discriminator
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ const models = require('./index');
class DeliveryRuleUrlFileExtensionCondition extends models['DeliveryRuleCondition'] {
/**
* Create a DeliveryRuleUrlFileExtensionCondition.
* @member {object} parameters Defines the parameters for the condition.
* @member {array} [parameters.extensions] A list of extensions for the
* @property {object} parameters Defines the parameters for the condition.
* @property {array} [parameters.extensions] A list of extensions for the
* condition of the delivery rule.
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ const models = require('./index');
class DeliveryRuleUrlPathCondition extends models['DeliveryRuleCondition'] {
/**
* Create a DeliveryRuleUrlPathCondition.
* @member {object} parameters Defines the parameters for the condition.
* @member {string} [parameters.path] A URL path for the condition of the
* @property {object} parameters Defines the parameters for the condition.
* @property {string} [parameters.path] A URL path for the condition of the
* delivery rule
* @member {string} [parameters.matchType] The match type for the condition
* @property {string} [parameters.matchType] The match type for the condition
* of the delivery rule. Possible values include: 'Literal', 'Wildcard'
*/
constructor() {
Expand Down
2 changes: 1 addition & 1 deletion lib/services/cdnManagement/lib/models/edgeNode.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const models = require('./index');
class EdgeNode extends models['ProxyResource'] {
/**
* Create a EdgeNode.
* @member {array} ipAddressGroups List of ip address groups.
* @property {array} ipAddressGroups List of ip address groups.
*/
constructor() {
super();
Expand Down
2 changes: 1 addition & 1 deletion lib/services/cdnManagement/lib/models/edgenodeResult.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
class EdgenodeResult extends Array {
/**
* Create a EdgenodeResult.
* @member {string} [nextLink] URL to get the next set of edgenode list
* @property {string} [nextLink] URL to get the next set of edgenode list
* results if there are any.
*/
constructor() {
Expand Down
48 changes: 25 additions & 23 deletions lib/services/cdnManagement/lib/models/endpoint.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,56 +22,58 @@ const models = require('./index');
class Endpoint extends models['TrackedResource'] {
/**
* Create a Endpoint.
* @member {string} [originHostHeader] The host header value sent to the
* @property {string} [originHostHeader] The host header value sent to the
* origin with each request. If you leave this blank, the request hostname
* determines this value. Azure CDN origins, such as Web Apps, Blob Storage,
* and Cloud Services require this host header value to match the origin
* hostname by default.
* @member {string} [originPath] A directory path on the origin that CDN can
* use to retreive content from, e.g. contoso.cloudapp.net/originpath.
* @member {array} [contentTypesToCompress] List of content types on which
* @property {string} [originPath] A directory path on the origin that CDN
* can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
* @property {array} [contentTypesToCompress] List of content types on which
* compression applies. The value should be a valid MIME type.
* @member {boolean} [isCompressionEnabled] Indicates whether content
* @property {boolean} [isCompressionEnabled] Indicates whether content
* compression is enabled on CDN. Default value is false. If compression is
* enabled, content will be served as compressed if user requests for a
* compressed version. Content won't be compressed on CDN when requested
* content is smaller than 1 byte or larger than 1 MB.
* @member {boolean} [isHttpAllowed] Indicates whether HTTP traffic is
* @property {boolean} [isHttpAllowed] Indicates whether HTTP traffic is
* allowed on the endpoint. Default value is true. At least one protocol
* (HTTP or HTTPS) must be allowed.
* @member {boolean} [isHttpsAllowed] Indicates whether HTTPS traffic is
* @property {boolean} [isHttpsAllowed] Indicates whether HTTPS traffic is
* allowed on the endpoint. Default value is true. At least one protocol
* (HTTP or HTTPS) must be allowed.
* @member {string} [queryStringCachingBehavior] Defines how CDN caches
* @property {string} [queryStringCachingBehavior] Defines how CDN caches
* requests that include query strings. You can ignore any query strings when
* caching, bypass caching to prevent requests that contain query strings
* from being cached, or cache every request with a unique URL. Possible
* values include: 'IgnoreQueryString', 'BypassCaching', 'UseQueryString',
* 'NotSet'
* @member {string} [optimizationType] Specifies what scenario the customer
* @property {string} [optimizationType] Specifies what scenario the customer
* wants this CDN endpoint to optimize for, e.g. Download, Media services.
* With this information, CDN can apply scenario driven optimization.
* Possible values include: 'GeneralWebDelivery', 'GeneralMediaStreaming',
* 'VideoOnDemandMediaStreaming', 'LargeFileDownload',
* 'DynamicSiteAcceleration'
* @member {string} [probePath] Path to a file hosted on the origin which
* @property {string} [probePath] Path to a file hosted on the origin which
* helps accelerate delivery of the dynamic content and calculate the most
* optimal routes for the CDN. This is relative to the origin path.
* @member {array} [geoFilters] List of rules defining the user's geo access
* within a CDN endpoint. Each geo filter defines an acess rule to a
* @property {array} [geoFilters] List of rules defining the user's geo
* access within a CDN endpoint. Each geo filter defines an access rule to a
* specified path or content, e.g. block APAC for path /pictures/
* @member {object} [deliveryPolicy] A policy that specifies the delivery
* @property {object} [deliveryPolicy] A policy that specifies the delivery
* rules to be used for an endpoint.
* @member {string} [deliveryPolicy.description] User-friendly description of
* the policy.
* @member {array} [deliveryPolicy.rules] A list of the delivery rules.
* @member {string} [hostName] The host name of the endpoint structured as
* {endpointName}.{DNSZone}, e.g. consoto.azureedge.net
* @member {array} origins The source of the content being delivered via CDN.
* @member {string} [resourceState] Resource status of the endpoint. Possible
* values include: 'Creating', 'Deleting', 'Running', 'Starting', 'Stopped',
* 'Stopping'
* @member {string} [provisioningState] Provisioning status of the endpoint.
* @property {string} [deliveryPolicy.description] User-friendly description
* of the policy.
* @property {array} [deliveryPolicy.rules] A list of the delivery rules.
* @property {string} [hostName] The host name of the endpoint structured as
* {endpointName}.{DNSZone}, e.g. contoso.azureedge.net
* @property {array} origins The source of the content being delivered via
* CDN.
* @property {string} [resourceState] Resource status of the endpoint.
* Possible values include: 'Creating', 'Deleting', 'Running', 'Starting',
* 'Stopped', 'Stopping'
* @property {string} [provisioningState] Provisioning status of the
* endpoint.
*/
constructor() {
super();
Expand Down
6 changes: 3 additions & 3 deletions lib/services/cdnManagement/lib/models/endpointListResult.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@

/**
* Result of the request to list endpoints. It contains a list of endpoint
* objects and a URL link to get the the next set of results.
* objects and a URL link to get the next set of results.
*/
class EndpointListResult extends Array {
/**
* Create a EndpointListResult.
* @member {string} [nextLink] URL to get the next set of endpoint objects if
* there is any.
* @property {string} [nextLink] URL to get the next set of endpoint objects
* if there is any.
*/
constructor() {
super();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
class EndpointPropertiesUpdateParametersDeliveryPolicy {
/**
* Create a EndpointPropertiesUpdateParametersDeliveryPolicy.
* @member {string} [description] User-friendly description of the policy.
* @member {array} rules A list of the delivery rules.
* @property {string} [description] User-friendly description of the policy.
* @property {array} rules A list of the delivery rules.
*/
constructor() {
}
Expand Down
Loading