@azure/arm-cdn package

Classes

CdnManagementClient
CdnManagementClientContext
CustomDomains

Class representing a CustomDomains.

EdgeNodes

Class representing a EdgeNodes.

Endpoints

Class representing a Endpoints.

ManagedRuleSets

Class representing a ManagedRuleSets.

Operations

Class representing a Operations.

OriginGroups

Class representing a OriginGroups.

Origins

Class representing a Origins.

Policies

Class representing a Policies.

Profiles

Class representing a Profiles.

ResourceUsageOperations

Class representing a ResourceUsageOperations.

Interfaces

CacheExpirationActionParameters

Defines the parameters for the cache expiration action.

CacheKeyQueryStringActionParameters

Defines the parameters for the cache-key query string action.

CdnCertificateSourceParameters

Defines the parameters for using CDN managed certificate for securing custom domain.

CdnEndpoint

Defines the ARM Resource ID for the linked endpoints

CdnManagedHttpsParameters

Defines the certificate source parameters using CDN managed certificate for enabling SSL.

CdnManagementClientOptions

An interface representing CdnManagementClientOptions.

CdnWebApplicationFirewallPolicy

Defines web application firewall policy for Azure CDN.

CdnWebApplicationFirewallPolicyList
CdnWebApplicationFirewallPolicyPatchParameters

Properties required to update a CdnWebApplicationFirewallPolicy.

CheckNameAvailabilityInput

Input of CheckNameAvailability API.

CheckNameAvailabilityOutput

Output of check name availability API.

CidrIpAddress

CIDR Ip address

CookiesMatchConditionParameters

Defines the parameters for Cookies match conditions

CustomDomain

Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.

CustomDomainHttpsParameters

The JSON object that contains the properties to secure a custom domain.

CustomDomainListResult
CustomDomainParameters

The customDomain JSON object required for custom domain creation or update.

CustomDomainsEnableCustomHttpsOptionalParams

Optional Parameters.

CustomRule

Defines the common attributes for a custom rule that can be included in a waf policy

CustomRuleList

Defines contents of custom rules

DeepCreatedOrigin

The main origin of CDN content which is added when creating a CDN endpoint.

DeepCreatedOriginGroup

The origin group for CDN content which is added when creating a CDN endpoint. Traffic is sent to the origins within the origin group based on origin health.

DeliveryRule

A rule that specifies a set of actions and conditions

DeliveryRuleAction

An action for the delivery rule.

DeliveryRuleCacheExpirationAction

Defines the cache expiration action for the delivery rule.

DeliveryRuleCacheKeyQueryStringAction

Defines the cache-key query string action for the delivery rule.

DeliveryRuleCondition

A condition for the delivery rule.

DeliveryRuleCookiesCondition

Defines the Cookies condition for the delivery rule.

DeliveryRuleHttpVersionCondition

Defines the HttpVersion condition for the delivery rule.

DeliveryRuleIsDeviceCondition

Defines the IsDevice condition for the delivery rule.

DeliveryRulePostArgsCondition

Defines the PostArgs condition for the delivery rule.

DeliveryRuleQueryStringCondition

Defines the QueryString condition for the delivery rule.

DeliveryRuleRemoteAddressCondition

Defines the RemoteAddress condition for the delivery rule.

DeliveryRuleRequestBodyCondition

Defines the RequestBody condition for the delivery rule.

DeliveryRuleRequestHeaderAction

Defines the request header action for the delivery rule.

DeliveryRuleRequestHeaderCondition

Defines the RequestHeader condition for the delivery rule.

DeliveryRuleRequestMethodCondition

Defines the RequestMethod condition for the delivery rule.

DeliveryRuleRequestSchemeCondition

Defines the RequestScheme condition for the delivery rule.

DeliveryRuleRequestUriCondition

Defines the RequestUri condition for the delivery rule.

DeliveryRuleResponseHeaderAction

Defines the response header action for the delivery rule.

DeliveryRuleUrlFileExtensionCondition

Defines the UrlFileExtension condition for the delivery rule.

DeliveryRuleUrlFileNameCondition

Defines the UrlFileName condition for the delivery rule.

DeliveryRuleUrlPathCondition

Defines the UrlPath condition for the delivery rule.

EdgeNode

Edgenode is a global Point of Presence (POP) location used to deliver CDN content to end users.

EdgenodeResult
Endpoint

CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior. The CDN endpoint uses the URL format .azureedge.net.

EndpointListResult
EndpointPropertiesUpdateParametersDeliveryPolicy

A policy that specifies the delivery rules to be used for an endpoint.

EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink

Defines the Web Application Firewall policy for the endpoint (if applicable)

EndpointUpdateParameters

Properties required to create or update an endpoint.

ErrorResponse

Error response indicates CDN service is not able to process the incoming request. The reason is provided in the error message.

GeoFilter

Rules defining user's geo access within a CDN endpoint.

HeaderActionParameters

Defines the parameters for the request header action.

HealthProbeParameters

The JSON object that contains the properties to send health probes to origin.

HttpErrorRangeParameters

The JSON object that represents the range for http status codes

HttpVersionMatchConditionParameters

Defines the parameters for HttpVersion match conditions

IpAddressGroup

CDN Ip address group

IsDeviceMatchConditionParameters

Defines the parameters for IsDevice match conditions

KeyVaultCertificateSourceParameters

Describes the parameters for using a user's KeyVault certificate for securing custom domain.

KeyVaultSigningKeyParameters

Describes the parameters for using a user's KeyVault for URL Signing Key.

LoadParameters

Parameters required for content load.

ManagedRuleDefinition

Describes a managed rule definition.

ManagedRuleGroupDefinition

Describes a managed rule group.

ManagedRuleGroupOverride

Defines a managed rule group override setting.

ManagedRuleOverride

Defines a managed rule group override setting.

ManagedRuleSet

Defines a managed rule set.

ManagedRuleSetDefinition

Describes a managed rule set definition.

ManagedRuleSetDefinitionList
ManagedRuleSetList

Defines the list of managed rule sets for the policy.

MatchCondition

Define match conditions

Operation

CDN REST API operation

OperationDisplay

The object that represents the operation.

OperationsListResult
Origin

CDN origin is the source of the content being delivered via CDN. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.

OriginGroup

Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN.

OriginGroupListResult
OriginGroupUpdateParameters

Origin group properties needed for origin group creation or update.

OriginListResult
OriginUpdateParameters

Origin properties needed for origin update.

PoliciesBeginUpdateOptionalParams

Optional Parameters.

PoliciesUpdateOptionalParams

Optional Parameters.

PolicySettings

Defines contents of a web application firewall global configuration

PostArgsMatchConditionParameters

Defines the parameters for PostArgs match conditions

Profile

CDN profile is a logical grouping of endpoints that share the same settings, such as CDN provider and pricing tier.

ProfileListResult
ProfileUpdateParameters

Properties required to update a profile.

ProfilesBeginUpdateOptionalParams

Optional Parameters.

ProfilesUpdateOptionalParams

Optional Parameters.

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags

PurgeParameters

Parameters required for content purge.

QueryStringMatchConditionParameters

Defines the parameters for QueryString match conditions

RateLimitRule

Defines a rate limiting rule that can be included in a waf policy

RateLimitRuleList

Defines contents of rate limit rules

RemoteAddressMatchConditionParameters

Defines the parameters for RemoteAddress match conditions

RequestBodyMatchConditionParameters

Defines the parameters for RequestBody match conditions

RequestHeaderMatchConditionParameters

Defines the parameters for RequestHeader match conditions

RequestMethodMatchConditionParameters

Defines the parameters for RequestMethod match conditions

RequestSchemeMatchConditionParameters

Defines the parameters for RequestScheme match conditions

RequestUriMatchConditionParameters

Defines the parameters for RequestUri match conditions

Resource

The core properties of ARM resources

ResourceReference

Reference to another resource.

ResourceUsage

Output of check resource usage API.

ResourceUsageListResult
ResponseBasedOriginErrorDetectionParameters

The JSON object that contains the properties to determine origin health using real requests/responses.

Sku

The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile.

SsoUri

The URI required to login to the supplemental portal from the Azure portal.

SupportedOptimizationTypesListResult

The result of the GetSupportedOptimizationTypes API

TrackedResource

The resource model definition for a ARM tracked top level resource.

UrlFileExtensionMatchConditionParameters

Defines the parameters for UrlFileExtension match conditions

UrlFileNameMatchConditionParameters

Defines the parameters for UrlFilename match conditions

UrlPathMatchConditionParameters

Defines the parameters for UrlPath match conditions

UrlRedirectAction

Defines the url redirect action for the delivery rule.

UrlRedirectActionParameters

Defines the parameters for the url redirect action.

UrlRewriteAction

Defines the url rewrite action for the delivery rule.

UrlRewriteActionParameters

Defines the parameters for the url rewrite action.

UrlSigningAction

Defines the url signing action for the delivery rule.

UrlSigningActionParameters

Defines the parameters for the Url Signing action.

UrlSigningKey

Url signing key

UrlSigningParamIdentifier

Defines how to identify a parameter for a specific purpose e.g. expires

UserManagedHttpsParameters

Defines the certificate source parameters using user's keyvault certificate for enabling SSL.

ValidateCustomDomainInput

Input of the custom domain to be validated for DNS mapping.

ValidateCustomDomainOutput

Output of custom domain validation.

ValidateProbeInput

Input of the validate probe API.

ValidateProbeOutput

Output of the validate probe API.

Type Aliases

ActionType

Defines values for ActionType. Possible values include: 'Allow', 'Block', 'Log', 'Redirect'

Algorithm

Defines values for Algorithm. Possible values include: 'SHA256'

CacheBehavior

Defines values for CacheBehavior. Possible values include: 'BypassCache', 'Override', 'SetIfMissing'

CertificateType

Defines values for CertificateType. Possible values include: 'Shared', 'Dedicated'

CheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

CheckNameAvailabilityWithSubscriptionResponse

Contains response data for the checkNameAvailabilityWithSubscription operation.

CookiesOperator

Defines values for CookiesOperator. Possible values include: 'Any', 'Equal', 'Contains', 'BeginsWith', 'EndsWith', 'LessThan', 'LessThanOrEqual', 'GreaterThan', 'GreaterThanOrEqual'

CustomDomainHttpsParametersUnion

Contains the possible cases for CustomDomainHttpsParameters.

CustomDomainResourceState

Defines values for CustomDomainResourceState. Possible values include: 'Creating', 'Active', 'Deleting'

CustomDomainsBeginCreateResponse

Contains response data for the beginCreate operation.

CustomDomainsBeginDeleteMethodResponse

Contains response data for the beginDeleteMethod operation.

CustomDomainsCreateResponse

Contains response data for the create operation.

CustomDomainsDeleteMethodResponse

Contains response data for the deleteMethod operation.

CustomDomainsDisableCustomHttpsResponse

Contains response data for the disableCustomHttps operation.

CustomDomainsEnableCustomHttpsResponse

Contains response data for the enableCustomHttps operation.

CustomDomainsGetResponse

Contains response data for the get operation.

CustomDomainsListByEndpointNextResponse

Contains response data for the listByEndpointNext operation.

CustomDomainsListByEndpointResponse

Contains response data for the listByEndpoint operation.

CustomHttpsProvisioningState

Defines values for CustomHttpsProvisioningState. Possible values include: 'Enabling', 'Enabled', 'Disabling', 'Disabled', 'Failed'

CustomHttpsProvisioningSubstate

Defines values for CustomHttpsProvisioningSubstate. Possible values include: 'SubmittingDomainControlValidationRequest', 'PendingDomainControlValidationREquestApproval', 'DomainControlValidationRequestApproved', 'DomainControlValidationRequestRejected', 'DomainControlValidationRequestTimedOut', 'IssuingCertificate', 'DeployingCertificate', 'CertificateDeployed', 'DeletingCertificate', 'CertificateDeleted'

CustomRuleEnabledState

Defines values for CustomRuleEnabledState. Possible values include: 'Disabled', 'Enabled'

DeliveryRuleActionUnion

Contains the possible cases for DeliveryRuleAction.

DeliveryRuleConditionUnion

Contains the possible cases for DeliveryRuleCondition.

DestinationProtocol

Defines values for DestinationProtocol. Possible values include: 'MatchRequest', 'Http', 'Https'

EdgeNodesListNextResponse

Contains response data for the listNext operation.

EdgeNodesListResponse

Contains response data for the list operation.

EndpointResourceState

Defines values for EndpointResourceState. Possible values include: 'Creating', 'Deleting', 'Running', 'Starting', 'Stopped', 'Stopping'

EndpointsBeginCreateResponse

Contains response data for the beginCreate operation.

EndpointsBeginStartResponse

Contains response data for the beginStart operation.

EndpointsBeginStopResponse

Contains response data for the beginStop operation.

EndpointsBeginUpdateResponse

Contains response data for the beginUpdate operation.

EndpointsCreateResponse

Contains response data for the create operation.

EndpointsGetResponse

Contains response data for the get operation.

EndpointsListByProfileNextResponse

Contains response data for the listByProfileNext operation.

EndpointsListByProfileResponse

Contains response data for the listByProfile operation.

EndpointsListResourceUsageNextResponse

Contains response data for the listResourceUsageNext operation.

EndpointsListResourceUsageResponse

Contains response data for the listResourceUsage operation.

EndpointsStartResponse

Contains response data for the start operation.

EndpointsStopResponse

Contains response data for the stop operation.

EndpointsUpdateResponse

Contains response data for the update operation.

EndpointsValidateCustomDomainResponse

Contains response data for the validateCustomDomain operation.

GeoFilterActions

Defines values for GeoFilterActions. Possible values include: 'Block', 'Allow'

HeaderAction

Defines values for HeaderAction. Possible values include: 'Append', 'Overwrite', 'Delete'

HealthProbeRequestType

Defines values for HealthProbeRequestType. Possible values include: 'NotSet', 'GET', 'HEAD'

ManagedRuleEnabledState

Defines values for ManagedRuleEnabledState. Possible values include: 'Disabled', 'Enabled'

ManagedRuleSetsListNextResponse

Contains response data for the listNext operation.

ManagedRuleSetsListResponse

Contains response data for the list operation.

MatchVariable

Defines values for MatchVariable. Possible values include: 'RemoteAddr', 'SocketAddr', 'RequestMethod', 'RequestHeader', 'RequestUri', 'QueryString', 'RequestBody', 'Cookies', 'PostArgs'

MinimumTlsVersion

Defines values for MinimumTlsVersion. Possible values include: 'None', 'TLS10', 'TLS12'

Odatatype

Defines values for Odatatype. Possible values include: '#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlSigningActionParameters'

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

Operator

Defines values for Operator. Possible values include: 'Any', 'IPMatch', 'GeoMatch', 'Equal', 'Contains', 'LessThan', 'GreaterThan', 'LessThanOrEqual', 'GreaterThanOrEqual', 'BeginsWith', 'EndsWith', 'RegEx'

OptimizationType

Defines values for OptimizationType. Possible values include: 'GeneralWebDelivery', 'GeneralMediaStreaming', 'VideoOnDemandMediaStreaming', 'LargeFileDownload', 'DynamicSiteAcceleration'

OriginGroupResourceState

Defines values for OriginGroupResourceState. Possible values include: 'Creating', 'Active', 'Deleting'

OriginGroupsBeginCreateResponse

Contains response data for the beginCreate operation.

OriginGroupsBeginUpdateResponse

Contains response data for the beginUpdate operation.

OriginGroupsCreateResponse

Contains response data for the create operation.

OriginGroupsGetResponse

Contains response data for the get operation.

OriginGroupsListByEndpointNextResponse

Contains response data for the listByEndpointNext operation.

OriginGroupsListByEndpointResponse

Contains response data for the listByEndpoint operation.

OriginGroupsUpdateResponse

Contains response data for the update operation.

OriginResourceState

Defines values for OriginResourceState. Possible values include: 'Creating', 'Active', 'Deleting'

OriginsBeginCreateResponse

Contains response data for the beginCreate operation.

OriginsBeginUpdateResponse

Contains response data for the beginUpdate operation.

OriginsCreateResponse

Contains response data for the create operation.

OriginsGetResponse

Contains response data for the get operation.

OriginsListByEndpointNextResponse

Contains response data for the listByEndpointNext operation.

OriginsListByEndpointResponse

Contains response data for the listByEndpoint operation.

OriginsUpdateResponse

Contains response data for the update operation.

ParamIndicator

Defines values for ParamIndicator. Possible values include: 'Expires', 'KeyId', 'Signature'

PoliciesBeginCreateOrUpdateResponse

Contains response data for the beginCreateOrUpdate operation.

PoliciesBeginUpdateResponse

Contains response data for the beginUpdate operation.

PoliciesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

PoliciesGetResponse

Contains response data for the get operation.

PoliciesListNextResponse

Contains response data for the listNext operation.

PoliciesListResponse

Contains response data for the list operation.

PoliciesUpdateResponse

Contains response data for the update operation.

PolicyEnabledState

Defines values for PolicyEnabledState. Possible values include: 'Disabled', 'Enabled'

PolicyMode

Defines values for PolicyMode. Possible values include: 'Prevention', 'Detection'

PolicyResourceState

Defines values for PolicyResourceState. Possible values include: 'Creating', 'Enabling', 'Enabled', 'Disabling', 'Disabled', 'Deleting'

PostArgsOperator

Defines values for PostArgsOperator. Possible values include: 'Any', 'Equal', 'Contains', 'BeginsWith', 'EndsWith', 'LessThan', 'LessThanOrEqual', 'GreaterThan', 'GreaterThanOrEqual'

PrivateEndpointStatus

Defines values for PrivateEndpointStatus. Possible values include: 'Pending', 'Approved', 'Rejected', 'Disconnected', 'Timeout'

ProbeProtocol

Defines values for ProbeProtocol. Possible values include: 'NotSet', 'Http', 'Https'

ProfileResourceState

Defines values for ProfileResourceState. Possible values include: 'Creating', 'Active', 'Deleting', 'Disabled'

ProfilesBeginCreateResponse

Contains response data for the beginCreate operation.

ProfilesBeginUpdateResponse

Contains response data for the beginUpdate operation.

ProfilesCreateResponse

Contains response data for the create operation.

ProfilesGenerateSsoUriResponse

Contains response data for the generateSsoUri operation.

ProfilesGetResponse

Contains response data for the get operation.

ProfilesListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

ProfilesListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

ProfilesListNextResponse

Contains response data for the listNext operation.

ProfilesListResourceUsageNextResponse

Contains response data for the listResourceUsageNext operation.

ProfilesListResourceUsageResponse

Contains response data for the listResourceUsage operation.

ProfilesListResponse

Contains response data for the list operation.

ProfilesListSupportedOptimizationTypesResponse

Contains response data for the listSupportedOptimizationTypes operation.

ProfilesUpdateResponse

Contains response data for the update operation.

ProtocolType

Defines values for ProtocolType. Possible values include: 'ServerNameIndication', 'IPBased'

ProvisioningState

Defines values for ProvisioningState. Possible values include: 'Creating', 'Succeeded', 'Failed'

QueryStringBehavior

Defines values for QueryStringBehavior. Possible values include: 'Include', 'IncludeAll', 'Exclude', 'ExcludeAll'

QueryStringCachingBehavior

Defines values for QueryStringCachingBehavior. Possible values include: 'IgnoreQueryString', 'BypassCaching', 'UseQueryString', 'NotSet'

QueryStringOperator

Defines values for QueryStringOperator. Possible values include: 'Any', 'Equal', 'Contains', 'BeginsWith', 'EndsWith', 'LessThan', 'LessThanOrEqual', 'GreaterThan', 'GreaterThanOrEqual'

RedirectType

Defines values for RedirectType. Possible values include: 'Moved', 'Found', 'TemporaryRedirect', 'PermanentRedirect'

RemoteAddressOperator

Defines values for RemoteAddressOperator. Possible values include: 'Any', 'IPMatch', 'GeoMatch'

RequestBodyOperator

Defines values for RequestBodyOperator. Possible values include: 'Any', 'Equal', 'Contains', 'BeginsWith', 'EndsWith', 'LessThan', 'LessThanOrEqual', 'GreaterThan', 'GreaterThanOrEqual'

RequestHeaderOperator

Defines values for RequestHeaderOperator. Possible values include: 'Any', 'Equal', 'Contains', 'BeginsWith', 'EndsWith', 'LessThan', 'LessThanOrEqual', 'GreaterThan', 'GreaterThanOrEqual'

RequestUriOperator

Defines values for RequestUriOperator. Possible values include: 'Any', 'Equal', 'Contains', 'BeginsWith', 'EndsWith', 'LessThan', 'LessThanOrEqual', 'GreaterThan', 'GreaterThanOrEqual'

ResourceType

Defines values for ResourceType. Possible values include: 'Microsoft.Cdn/Profiles/Endpoints'

ResourceUsageListNextResponse

Contains response data for the listNext operation.

ResourceUsageListResponse

Contains response data for the list operation.

ResponseBasedDetectedErrorTypes

Defines values for ResponseBasedDetectedErrorTypes. Possible values include: 'None', 'TcpErrorsOnly', 'TcpAndHttpErrors'

SkuName

Defines values for SkuName. Possible values include: 'Standard_Verizon', 'Premium_Verizon', 'Custom_Verizon', 'Standard_Akamai', 'Standard_ChinaCdn', 'Standard_Microsoft', 'Premium_ChinaCdn'

Transform

Defines values for Transform. Possible values include: 'Lowercase', 'Uppercase'

TransformType

Defines values for TransformType. Possible values include: 'Lowercase', 'Uppercase', 'Trim', 'UrlDecode', 'UrlEncode', 'RemoveNulls'

UrlFileExtensionOperator

Defines values for UrlFileExtensionOperator. Possible values include: 'Any', 'Equal', 'Contains', 'BeginsWith', 'EndsWith', 'LessThan', 'LessThanOrEqual', 'GreaterThan', 'GreaterThanOrEqual'

UrlFileNameOperator

Defines values for UrlFileNameOperator. Possible values include: 'Any', 'Equal', 'Contains', 'BeginsWith', 'EndsWith', 'LessThan', 'LessThanOrEqual', 'GreaterThan', 'GreaterThanOrEqual'

UrlPathOperator

Defines values for UrlPathOperator. Possible values include: 'Any', 'Equal', 'Contains', 'BeginsWith', 'EndsWith', 'LessThan', 'LessThanOrEqual', 'GreaterThan', 'GreaterThanOrEqual', 'Wildcard'

ValidateProbeResponse

Contains response data for the validateProbe operation.