Azure.Provisioning.Cdn Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
| Name | Description |
|---|---|
| AzureFirstPartyManagedCertificateProperties |
Azure FirstParty Managed Certificate provided by other first party resource providers to enable HTTPS. |
| CacheConfiguration |
Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object. |
| CacheExpirationActionProperties |
Defines the parameters for the cache expiration action. |
| CacheKeyQueryStringActionProperties |
Defines the parameters for the cache-key query string action. |
| CdnCertificateSource |
Defines the parameters for using CDN managed certificate for securing custom domain. |
| CdnCustomDomain |
Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. |
| CdnCustomDomain.ResourceVersions | |
| CdnEndpoint |
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 <endpointname>.azureedge.net. |
| CdnEndpoint.ResourceVersions | |
| CdnManagedHttpsContent |
Defines the certificate source parameters using CDN managed certificate for enabling SSL. |
| CdnOrigin |
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. |
| CdnOrigin.ResourceVersions | |
| CdnOriginGroup |
Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN. |
| CdnOriginGroup.ResourceVersions | |
| CdnProfile |
Renames the generated |
| CdnProfile.ResourceVersions | |
| CdnWebApplicationFirewallPolicy |
Defines web application firewall policy for Azure CDN. |
| CdnWebApplicationFirewallPolicy.ResourceVersions | |
| CertificateSourceProperties |
Defines the parameters for certificate source Please note this is the abstract base class. The derived classes available for instantiation are: CdnCertificateSource and KeyVaultCertificateSource. |
| ClientPortMatchCondition |
Defines the parameters for ClientPort match conditions. |
| CookiesMatchCondition |
Defines the parameters for Cookies match conditions. |
| CustomDomainHttpsContent |
The JSON object that contains the properties to secure a custom domain. Please note this is the abstract base class. The derived classes available for instantiation are: CdnManagedHttpsContent and UserManagedHttpsContent. |
| CustomerCertificateProperties |
Customer Certificate used for https. |
| CustomRule |
Defines the common attributes for a custom rule that can be included in a waf policy. |
| CustomRuleMatchCondition |
Define match conditions. |
| DeepCreatedCustomDomain |
Custom domains created on the CDN endpoint. |
| 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. Please note this is the abstract base class. The derived classes available for instantiation are: UriRedirectAction, UriSigningAction, OriginGroupOverrideAction, UriRewriteAction, DeliveryRuleRequestHeaderAction, DeliveryRuleResponseHeaderAction, DeliveryRuleCacheExpirationAction, DeliveryRuleCacheKeyQueryStringAction, and DeliveryRuleRouteConfigurationOverrideAction. |
| DeliveryRuleActionProperties |
Defines the parameters for delivery rule actions Please note this is the abstract base class. The derived classes available for instantiation are: UriRedirectActionProperties, UriSigningActionProperties, OriginGroupOverrideActionProperties, UriRewriteActionProperties, HeaderActionProperties, CacheExpirationActionProperties, CacheKeyQueryStringActionProperties, and RouteConfigurationOverrideActionProperties. |
| DeliveryRuleCacheExpirationAction |
Defines the cache expiration action for the delivery rule. |
| DeliveryRuleCacheKeyQueryStringAction |
Defines the cache-key query string action for the delivery rule. |
| DeliveryRuleClientPortCondition |
Defines the ClientPort condition for the delivery rule. |
| DeliveryRuleCondition |
A condition for the delivery rule. Please note this is the abstract base class. The derived classes available for instantiation are: DeliveryRuleRemoteAddressCondition, DeliveryRuleRequestMethodCondition, DeliveryRuleQueryStringCondition, DeliveryRulePostArgsCondition, DeliveryRuleRequestUriCondition, DeliveryRuleRequestHeaderCondition, DeliveryRuleRequestBodyCondition, DeliveryRuleRequestSchemeCondition, DeliveryRuleUriPathCondition, DeliveryRuleUriFileExtensionCondition, DeliveryRuleUriFileNameCondition, DeliveryRuleHttpVersionCondition, DeliveryRuleCookiesCondition, DeliveryRuleIsDeviceCondition, DeliveryRuleSocketAddressCondition, DeliveryRuleClientPortCondition, DeliveryRuleServerPortCondition, DeliveryRuleHostNameCondition, and DeliveryRuleSslProtocolCondition. |
| DeliveryRuleConditionProperties |
Defines the parameters for delivery rule match conditions Please note this is the abstract base class. The derived classes available for instantiation are: RemoteAddressMatchCondition, RequestMethodMatchCondition, QueryStringMatchCondition, PostArgsMatchCondition, RequestUriMatchCondition, RequestHeaderMatchCondition, RequestBodyMatchCondition, RequestSchemeMatchCondition, UriPathMatchCondition, UriFileExtensionMatchCondition, UriFileNameMatchCondition, HttpVersionMatchCondition, CookiesMatchCondition, IsDeviceMatchCondition, SocketAddressMatchCondition, ClientPortMatchCondition, ServerPortMatchCondition, HostNameMatchCondition, and DeliveryRuleSslProtocolMatchCondition. |
| DeliveryRuleCookiesCondition |
Defines the Cookies condition for the delivery rule. |
| DeliveryRuleHostNameCondition |
Defines the HostName 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. |
| DeliveryRuleRouteConfigurationOverrideAction |
Defines the route configuration override action for the delivery rule. Only applicable to Frontdoor Standard/Premium Profiles. |
| DeliveryRuleServerPortCondition |
Defines the ServerPort condition for the delivery rule. |
| DeliveryRuleSocketAddressCondition |
Defines the SocketAddress condition for the delivery rule. |
| DeliveryRuleSslProtocolCondition |
Defines the SslProtocol condition for the delivery rule. |
| DeliveryRuleSslProtocolMatchCondition |
Defines the parameters for SslProtocol match conditions. |
| DeliveryRuleUriFileExtensionCondition |
Defines the UrlFileExtension condition for the delivery rule. |
| DeliveryRuleUriFileNameCondition |
Defines the UrlFileName condition for the delivery rule. |
| DeliveryRuleUriPathCondition |
Defines the UrlPath condition for the delivery rule. |
| DomainValidationProperties |
The JSON object that contains the properties to validate a domain. |
| EndpointDeliveryPolicy |
A policy that specifies the delivery rules to be used for an endpoint. |
| FrontDoorActivatedResourceInfo |
Reference to another resource along with its state. |
| FrontDoorCustomDomain |
Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. |
| FrontDoorCustomDomain.ResourceVersions | |
| FrontDoorCustomDomainHttpsContent |
The JSON object that contains the properties to secure a domain. |
| FrontDoorCustomDomainHttpsCustomizedCipherSuiteSet |
Customized cipher suite set object that will be used for Https when cipherSuiteSetType is Customized. |
| FrontDoorEndpoint |
Azure Front Door endpoint is the entity within a Azure Front Door profile containing configuration information such as origin, protocol, content caching and delivery behavior. The AzureFrontDoor endpoint uses the URL format <endpointname>.azureedge.net. |
| FrontDoorEndpoint.ResourceVersions | |
| FrontDoorOrigin |
Azure Front Door origin is the source of the content being delivered via Azure Front Door. 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. |
| FrontDoorOrigin.ResourceVersions | |
| FrontDoorOriginGroup |
AFDOrigin group comprising of origins is used for load balancing to origins when the content cannot be served from Azure Front Door. |
| FrontDoorOriginGroup.ResourceVersions | |
| FrontDoorRoute |
Friendly Routes name mapping to the any Routes or secret related information. |
| FrontDoorRoute.ResourceVersions | |
| FrontDoorRouteCacheConfiguration |
Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object. |
| FrontDoorRule |
Friendly Rules name mapping to the any Rules or secret related information. |
| FrontDoorRule.ResourceVersions | |
| FrontDoorRuleSet |
Friendly RuleSet name mapping to the any RuleSet or secret related information. |
| FrontDoorRuleSet.ResourceVersions | |
| FrontDoorSecret |
Friendly Secret name mapping to the any Secret or secret related information. |
| FrontDoorSecret.ResourceVersions | |
| FrontDoorSecretProperties |
The json object containing secret parameters Please note this is the abstract base class. The derived classes available for instantiation are: UriSigningKeyProperties, ManagedCertificateProperties, CustomerCertificateProperties, and AzureFirstPartyManagedCertificateProperties. |
| FrontDoorSecurityPolicy |
SecurityPolicy association for AzureFrontDoor profile. |
| FrontDoorSecurityPolicy.ResourceVersions | |
| GeoFilter |
Rules defining user's geo access within a CDN endpoint. |
| HeaderActionProperties |
Defines the parameters for the request header action. |
| HealthProbeSettings |
The JSON object that contains the properties to send health probes to origin. |
| HostNameMatchCondition |
Defines the parameters for HostName match conditions. |
| HttpErrorRange |
The JSON object that represents the range for http status codes. |
| HttpVersionMatchCondition |
Defines the parameters for HttpVersion match conditions. |
| IsDeviceMatchCondition |
Defines the parameters for IsDevice match conditions. |
| KeyVaultCertificateSource |
Describes the parameters for using a user's KeyVault certificate for securing custom domain. |
| KeyVaultSigningKey |
Describes the parameters for using a user's KeyVault for URL Signing Key. |
| LoadBalancingSettings |
Round-Robin load balancing settings for a backend pool. |
| ManagedCertificateProperties |
Managed Certificate used for https. |
| ManagedRuleGroupOverrideSetting |
Defines a managed rule group override setting. |
| ManagedRuleOverrideSetting |
Defines a managed rule group override setting. |
| OriginAuthenticationProperties |
The JSON object that contains the properties of the origin authentication settings. |
| OriginGroupOverride |
Defines the parameters for the origin group override configuration. |
| OriginGroupOverrideAction |
Defines the origin group override action for the delivery rule. |
| OriginGroupOverrideActionProperties |
Defines the parameters for the origin group override action. |
| PostArgsMatchCondition |
Defines the parameters for PostArgs match conditions. |
| ProfileLogScrubbing |
Defines rules that scrub sensitive fields in the Azure Front Door profile logs. |
| ProfileScrubbingRules |
Defines the contents of the log scrubbing rules. |
| QueryStringMatchCondition |
Defines the parameters for QueryString match conditions. |
| RateLimitRule |
Defines a rate limiting rule that can be included in a waf policy. |
| RemoteAddressMatchCondition |
Defines the parameters for RemoteAddress match conditions. |
| RequestBodyMatchCondition |
Defines the parameters for RequestBody match conditions. |
| RequestHeaderMatchCondition |
Defines the parameters for RequestHeader match conditions. |
| RequestMethodMatchCondition |
Defines the parameters for RequestMethod match conditions. |
| RequestSchemeMatchCondition |
Defines the parameters for RequestScheme match conditions. |
| RequestUriMatchCondition |
Defines the parameters for RequestUri match conditions. |
| ResponseBasedOriginErrorDetectionSettings |
The JSON object that contains the properties to determine origin health using real requests/responses. |
| RouteCacheCompressionSettings |
settings for compression. |
| RouteConfigurationOverrideActionProperties |
Defines the parameters for the route configuration override action. |
| SecurityPolicyProperties |
The json object containing security policy parameters Please note this is the abstract base class. The derived classes available for instantiation are: SecurityPolicyWebApplicationFirewall. |
| SecurityPolicyWebApplicationFirewall |
The json object containing security policy waf parameters. |
| SecurityPolicyWebApplicationFirewallAssociation |
settings for security policy patterns to match. |
| ServerPortMatchCondition |
Defines the parameters for ServerPort match conditions. |
| SharedPrivateLinkResourceProperties |
Describes the properties of an existing Shared Private Link Resource to use when connecting to a private origin. |
| SocketAddressMatchCondition |
Defines the parameters for SocketAddress match conditions. |
| UriFileExtensionMatchCondition |
Defines the parameters for UrlFileExtension match conditions. |
| UriFileNameMatchCondition |
Defines the parameters for UrlFilename match conditions. |
| UriPathMatchCondition |
Defines the parameters for UrlPath match conditions. |
| UriRedirectAction |
Defines the url redirect action for the delivery rule. |
| UriRedirectActionProperties |
Defines the parameters for the url redirect action. |
| UriRewriteAction |
Defines the url rewrite action for the delivery rule. |
| UriRewriteActionProperties |
Defines the parameters for the url rewrite action. |
| UriSigningAction |
Defines the url signing action for the delivery rule. |
| UriSigningActionProperties |
Defines the parameters for the Url Signing action. |
| UriSigningKey |
Url signing key. |
| UriSigningKeyProperties |
Url signing key parameters. |
| UriSigningParamIdentifier |
Defines how to identify a parameter for a specific purpose e.g. expires. |
| UserManagedHttpsContent |
Defines the certificate source parameters using user's keyvault certificate for enabling SSL. |
| WafPolicyManagedRuleSet |
Defines a managed rule set. |
| WafPolicySettings |
Defines contents of a web application firewall global configuration. |
Enums
| Name | Description |
|---|---|
| AfdCipherSuiteSetType |
cipher suite set type that will be used for Https. |
| AfdCustomizedCipherSuiteForTls12 | |
| AfdCustomizedCipherSuiteForTls13 | |
| CacheBehaviorSetting |
Caching behavior for the requests. |
| CdnCacheLevel |
The level at which the content needs to be cached. |
| CdnEndpointProvisioningState |
Provisioning status of the endpoint. |
| CdnManagedCertificateType |
Type of certificate used. |
| CdnMinimumTlsVersion |
TLS protocol version that will be used for Https. |
| CdnSkuName |
Name of the pricing tier. |
| CertificateDeleteAction |
Describes the action that shall be taken when the certificate is removed from Key Vault. |
| CertificateUpdateAction |
Describes the action that shall be taken when the certificate is updated in Key Vault. |
| ClientPortOperator |
Describes operator to be matched. |
| CookiesOperator |
Describes operator to be matched. |
| CustomDomainResourceState |
Resource status of the custom domain. |
| CustomHttpsAvailabilityState |
Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. |
| CustomHttpsProvisioningState |
Provisioning status of the custom domain. |
| CustomRuleEnabledState |
Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. |
| DeliveryRuleSslProtocol |
The protocol of an established TLS connection. |
| DestinationProtocol |
Protocol to use for the redirect. The default value is MatchRequest. |
| DomainNameLabelScope |
Indicates the endpoint name reuse scope. The default value is TenantReuse. |
| DomainValidationState |
Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. |
| EnabledState |
Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. |
| EndpointResourceState |
Resource status of the endpoint. |
| ForwardingProtocol |
Protocol this rule will use when forwarding traffic to backends. |
| FrontDoorCertificateType |
Defines the source of the SSL certificate. |
| FrontDoorDeploymentStatus | |
| FrontDoorEndpointProtocol |
Supported protocols for the customer's endpoint. |
| FrontDoorMinimumTlsVersion |
TLS protocol version that will be used for Https when cipherSuiteSetType is Customized. |
| FrontDoorProvisioningState |
Provisioning status. |
| FrontDoorQueryStringCachingBehavior |
Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. |
| GeoFilterAction |
Action of the geo filter, i.e. allow or block access. |
| HeaderAction |
Action to perform. |
| HealthProbeProtocol |
Protocol to use for health probe. |
| HealthProbeRequestType |
The type of health probe request that is made. |
| HostNameOperator |
Describes operator to be matched. |
| HttpsRedirect |
Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. |
| HttpVersionOperator |
Describes operator to be matched. |
| IsDeviceMatchConditionMatchValue | |
| IsDeviceOperator |
Describes operator to be matched. |
| KeyVaultSigningKeyType | |
| LinkToDefaultDomain |
whether this route will be linked to the default endpoint domain. |
| ManagedRuleSetupState |
Describes if the managed rule is in enabled or disabled state. |
| MatchOperator |
Describes operator to be matched. |
| MatchProcessingBehavior |
If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. |
| OptimizationType |
Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. |
| OriginAuthenticationType |
The type of the authentication for the origin. |
| OriginGroupProvisioningState |
Provisioning status of the origin group. |
| OriginGroupResourceState |
Resource status of the origin group. |
| OriginProvisioningState |
Provisioning status of the origin. |
| OriginResourceState |
Resource status of the origin. |
| OverrideActionType |
Defines the action to take on rule match. |
| ParamIndicator |
Indicates the purpose of the parameter. |
| PolicyEnabledState |
Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. |
| PolicyMode |
Describes if it is in detection mode or prevention mode at policy level. |
| PolicyResourceState |
Resource status of the policy. |
| PolicySettingsDefaultCustomBlockResponseStatusCode |
If the action type is block, this field defines the default customer overridable http response status code. |
| PostArgsOperator |
Describes operator to be matched. |
| PreTransformCategory |
Describes what transforms are applied before matching. |
| PrivateEndpointStatus |
The approval status for the connection to the Private Link. |
| ProfileProvisioningState |
Provisioning status of the profile. |
| ProfileResourceState |
Resource status of the profile. |
| ProfileScrubbingState |
State of the log scrubbing config. Default value is Enabled. |
| QueryStringBehavior |
Caching behavior for the requests. |
| 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. |
| QueryStringOperator |
Describes operator to be matched. |
| RedirectType |
The redirect type the rule will use when redirecting traffic. |
| RemoteAddressOperator |
Describes operator to be matched. |
| RequestBodyOperator |
Describes operator to be matched. |
| RequestHeaderOperator |
Describes operator to be matched. |
| RequestMethodMatchConditionMatchValue | |
| RequestMethodOperator |
Describes operator to be matched. |
| RequestSchemeMatchConditionMatchValue | |
| RequestSchemeOperator |
Describes operator to be matched. |
| RequestUriOperator |
Describes operator to be matched. |
| ResponseBasedDetectedErrorType |
Type of response errors for real user requests for which origin will be deemed unhealthy. |
| RuleCacheBehavior |
Caching behavior for the requests. |
| RuleIsCompressionEnabled |
Indicates whether content compression is enabled. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. |
| RuleQueryStringCachingBehavior |
Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. |
| ScrubbingRuleEntryMatchOperator |
When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. |
| ScrubbingRuleEntryMatchVariable |
The variable to be scrubbed from the logs. |
| ScrubbingRuleEntryState |
Defines the state of a log scrubbing rule. Default value is enabled. |
| SecureDeliveryProtocolType |
Defines the TLS extension protocol that is used for secure delivery. |
| ServerPortOperator |
Describes operator to be matched. |
| SharedPrivateLinkResourceStatus |
Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. |
| SocketAddressOperator |
Describes operator to be matched. |
| SslProtocolOperator |
Describes operator to be matched. |
| TransformType |
Describes what transforms were applied before matching. |
| UriFileExtensionOperator |
Describes operator to be matched. |
| UriFileNameOperator |
Describes operator to be matched. |
| UriPathOperator |
Describes operator to be matched. |
| UriSigningAlgorithm |
Algorithm to use for URL signing. |
| WafMatchVariable |
Match variable to compare against. |
| WebApplicationFirewallPolicyProvisioningState |
Provisioning state of the WebApplicationFirewallPolicy. |